Appendix
Supplementary section
Appendix 1 – About Alerts
All events are logged to the System Watchdog log files. Each event has a unique code. Logs can be viewed by selecting “System Watchdogs Logs” from the start menu to browse the logs folder.
Major events, ones selected in the Triggers menu and ones set in Site Manager are classed as Alerts and these are shown in the “Recent Alerts” panel.
Alerts can be rated from Very Low to Critical using Site Manager.
All alerts are reported back to the Plus! Network but Low-Medium ones are sent at the next update and High-Critical ones are sent as they occur.
Appendix 2 – Plugins SDK
You can develop your own Plugins to extend the functionality of System Watchdog, e.g. to control/monitor specific hardware.
A plugin is just a Windows executable but with a “.plg” extension rather than the normal “.exe”.
Plugins must reside in the System Watchdog folder.
Your plugin can communicate with System Watchdog by use of the kmwatchdog.dll. This will also be in the System Watchdog folder.
API
The kmwatchdog.dll exports the following functions:
-
bool Watchdog_IsRunning();
-
Returns TRUE if System Watchdog software is currently running.
-
-
bool Watchdog_HardwareReset();
-
Resets the PC in 2 seconds.bool Watchdog_OutOfOrder(); Signal kiosk out of order.
-
-
bool Watchdog_ShowWatchdog();
-
Display the System Watchdog control panel.
-
-
bool Watchdog_SendFilesNow();
-
Causes System Watchdog to talk upload to the Plus! Network immediately.
-
-
int Watchdog_GetWatchdogDir(char* WDDir, int BufferLength);
-
Gets the System Watchdog Directory.
-
If the function succeeds, the return value is the length, in characters, of the string copied to WDDir, not including the terminating null character.
-
If the return value is greater than BufferLength, the return value is the size of the buffer required to hold the path. If the function fails the return value is -1
-
The returned string will ALWAYS have the trailing back-slash
-
-
int Watchdog_GetLogDir(char* LogDir, int BufferLength);
-
Gets the System Watchdog log Directory.
-
If the function succeeds, the return value is the length, in characters, of the string copied to LogDir, not including the terminating null character.
-
If the return value is greater than BufferLength, the return value is the size of the buffer required to hold the path. If the function fails the return value is -1
-
The returned string will ALWAYS have the trailing back-slash
-
-
bool Watchdog_GetListening Ports(word* DesktopConnector, word* FileTransfer);
-
Receives the port numbers that System Watchdog is listening on.
-
-
bool Watchdog_LogMessage(word Code, char* Msg);
-
Pass a log code and a null-terminated message string to System Watchdog, which will log it and report Alerts to the Plus! Network.
-
Tip: You can use any Standard Error Code but User Codes (550-599) have been reserved for user usage and are guaranteed not to be changed.
-
bool Watchdog_KioskInUse(bool Mode);
-
Broadcasts that the kiosk is in use, or not. Prevents remote viewing while busy etc.
-