Health
Request health status for the controller and connected modules.
Type: Health
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Health&SubType=<SubType>SubTypes
|
SubType |
Description |
|---|---|
|
List |
List of health status messages |
|
Values |
Returns the controller health status values |
|
CellModem |
Returns the status of the cellular modem. |
Success Response (List)
Successful response contains the ampersand separated list of health statuses.
For the List subtype the keys are in the format Health<Health Status Message ID>.
Health1=Keypad is offline.&Health2=Controller requires a module update.Success Response (Values)
For the Values subtype the response contains the health status value parameters outlined below.
NetworkVoltage=13870&SerialNumber=C25399CA&IPAddress=192.168.1.2&MainAppVersion=0208&MainAppBuild=795&DllVersion=400&DllBuild=183&WXVersion=4.00 312 H179 &MemTotal=70877184&MemUsed=15253504&MemSystem=12706925&MemEvents=2000000&MemUsers=500&MemAccessLevels=668&MemProgramFunctions=63488&MemOther=481923&HardwareType=17&3G=0The parameters are:
|
Parameter |
Example |
Description |
Notes |
|---|---|---|---|
|
NetworkVoltage |
13870 |
Controller voltage |
|
|
SerialNumber |
C2123456 |
Controller serial number |
|
|
IPAddress |
192.168.1.2 |
Controller IP address |
|
|
MainAppVersion |
0208 |
Version number of the main app |
|
|
MainAppBuild |
795 |
Build number of the main app |
|
|
DllVersion |
400 |
Version number of the DLL |
|
|
DllBuild |
183 |
Build number of the DLL |
|
|
WXVersion |
4.00 312 H179 |
Protege WX firmware version number |
|
|
MemTotal |
70877184 |
Total memory |
|
|
MemUsed |
15253504 |
Total memory used |
|
|
MemSystem |
12706925 |
Total memory used by the system |
|
|
MemEvents |
2000000 |
Total memory used by events |
|
|
MemUsers |
500 |
Total memory used by users |
|
|
MemAccessLevels |
668 |
Total memory used by access levels |
|
|
MemProgramFunctions |
63488 |
Total memory used by programmable functions |
|
|
MemOther |
481923 |
Total memory used by other programming |
|
|
HardwareType |
17 |
Controller hardware type |
|
|
3G |
0 |
Set to 1 if the controller supports 3G connectivity, otherwise 0. |
|
|
OSVersion |
131097 |
A 32 bit number made up of:
The OS should be displayed as major.minor.build e.g. a returned value of 0x00020019 would show as 2.0.25. |
Firmware Version > 4.00.375 OSVersion >= 2.0.25 |
|
ProductType |
16 |
Product type is Protege GX (0x00) or Protege WX (0x10). |
Firmware Version > 4.00.375 |
|
OEMType |
0 |
Original equipment manufacturer type. Example: ICT (0x00). |
Firmware Version > 4.00.375 |
Success Response (CellModem Subtype)
For the CellModem subtype, the response contains the cellular modem health status value parameters outlined below.
CellModemDetected=true&CellSIMDetected=true&CellSIMProvider=vodafone NZ&CellRSSI=-99&CellNetReg=Registered (home)&CellNetProvider=One NZ&CellTechnology=Cat M1&CellInternet=true&CellIP=49.224.49.540&CellCloud=falseThe parameters are:
|
Parameter |
Example |
Description |
|---|---|---|
|
CellModemDetected |
true |
Shows whether a cellular modem is detected |
|
CellSIMDetected |
true |
Shows whether a SIM card is detected |
|
CellSIMProvider |
vodafone NZ |
SIM provider |
|
CellRSSI |
-99 |
Cellular signal strength |
|
CellNetReg |
Registered (home) |
Network registration status |
|
CellNetProvider |
One NZ |
Current network provider |
|
CellTechnology |
Cat M1 |
Current network technology |
|
CellInternet |
true |
Internet connection status |
|
CellIP |
49.224.49.540 |
Cellular IP address |
|
CellCloud |
false |
This option is reserved for future development. |
Errors
Request Failed (2) Did not get a response from the main app.Request Failed (128) Health Request type not recognised.