Represents the status of a controller.
This is where the status of the controller is maintained.
DeviceStatusItem -> ControllerStatusItem
| Field | Type | Inherited from | Description |
|---|---|---|---|
| ConcurrencyVersion | Nullable<Int64> | DeviceStatusItem | Concurrency version for optimistic concurrency control. |
| DisplayLevel | String | DeviceStatusItem | Gets or sets the display level for this item, typically used to indicate visual priority, severity, or categorization in the user interface (e.g., Info, Warning, Critical). |
| DisplayStatus | String | DeviceStatusItem | Gets or sets the display-friendly status text for the device. This is typically used for UI representation and may differ from internal status codes. [BsonIgnoreIfDefault] to avoid reading the value. |
| Key | String | DeviceStatusItem | Device ID of the device hosting the status. This is provided to link the status to the device. |
| LastUpdated | Nullable<DateTime> | DeviceStatusItem | Last update time in UTC. If null, the current time will be used. |
| LogId | Nullable<Int64> | DeviceStatusItem | The log ID is provided by the smart controller (AUP devices) with every log event. So if the device status is being updated as part of processing a log event, the log ID can be used to correlate the status update with the original log event and gives the order of events. (Don’t override the status with an older logId.) |
| BatteryLowMessage | String | ControllerStatusItem | Gets or sets a value indicating the Battery status.Possible Values (null, 0V = ok floating input = fault, null) |
| BoardTemperature | String | ControllerStatusItem | Gets or sets the board temperature in celcius.Possible Values (null, value in celsius, null) |
| CoinCellBattery | String | ControllerStatusItem | Gets or sets a value indicating the Coin cell battery voltage.Possible Values (null, float/integer value, null) |
| FireInputMessage | String | ControllerStatusItem | Gets or sets a value indicating the Fire monitor input status.Possible Values (null, 0V = ok floating input = fault, null) |
| ILock1Message | String | ControllerStatusItem | Gets or sets a value indicating the status of VLock1 heads.Possible Values (null, value less than 9.5 fault value greater than 10.5 V OK, null) |
| ILock2Message | String | ControllerStatusItem | Gets or sets a value indicating the status of VLock2 heads.Possible Values (null, value less than 9.5 fault value greater than 10.5 V OK, null) |
| IReaderMessage | String | ControllerStatusItem | Gets or sets a value indicating the status of VReader heads PSU.Possible Values (null, value less than 9.5 fault value greater than 10.5 V OK, null) |
| IsBatteryLow | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance is battery low.Possible Values (null, true, false) |
| IsEngineerOnSite | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance has an engineer on site.Possible Values (null, true, false) |
| IsFaulted | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance is faulted.Possible Values (null, true, false) |
| IsFire | Nullable<Boolean> | ControllerStatusItem | Gets or sets the fire status. |
| IsInvalid | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance has invalid credentials.Possible Values (null, true, false) |
| IsLimitedMode | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance is operating in limited mode.Possible Values (null, true, false) |
| IsOnline | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance is online.Possible Values (null, true, false) |
| IsPACSDisconnected | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this controller is connected to a PACS.Possible Values (null, true, false) |
| IsTampered | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance is tampered.Possible Values (null, true, false) |
| IsUpdating | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating whether this instance is updating.Possible Values (null, true, false) |
| MainsPowerInputMessage | String | ControllerStatusItem | This is for power supply monitoring. It is a signal from a monitored PSU to indicate that mains has failed and are now running from the battery backup.Possible Values (null, 0V = ok ,floating input = fault, null) |
| NeedsDbPush | Nullable<Boolean> | ControllerStatusItem | Gets or sets a value indicating that the controller needs a new database push, most likely due to being added to an active access level |
| SoCTemperature | String | ControllerStatusItem | Gets or sets SoC temperature in celcius.Possible Values (null, value in celsius, null) |
| TamperMessage | String | ControllerStatusItem | Gets or sets a value indicating the tamper input status.Possible Values (null, 0V = ok floating input = fault, null) |
| VoltageInputMessage | String | ControllerStatusItem | Gets or sets a value indicating the status of the input voltage.Possible Values (null, float/integer value, null) |
| VoltagePowerInputMessage | String | ControllerStatusItem | Gets or sets a value indicating the status of the voltage supply input status.Possible Values (null, value less than 9.5 fault value greater than 10.5 V OK, null) |
| VRS485Message | String | ControllerStatusItem | Gets or sets a value indicating the status of Supply current state of VRS485.Possible Values (null, value less than 9.5 fault value greater than 10.5 V OK, null) |
{
"ConcurrencyVersion" : "Nullable\<Int64\>",
"DisplayLevel" : "String",
"DisplayStatus" : "String",
"Key" : "String",
"LastUpdated" : "Nullable\<DateTime\>",
"LogId" : "Nullable\<Int64\>",
"BatteryLowMessage" : "String",
"BoardTemperature" : "String",
"CoinCellBattery" : "String",
"FireInputMessage" : "String",
"ILock1Message" : "String",
"ILock2Message" : "String",
"IReaderMessage" : "String",
"IsBatteryLow" : "Nullable\<Boolean\>",
"IsEngineerOnSite" : "Nullable\<Boolean\>",
"IsFaulted" : "Nullable\<Boolean\>",
"IsFire" : "Nullable\<Boolean\>",
"IsInvalid" : "Nullable\<Boolean\>",
"IsLimitedMode" : "Nullable\<Boolean\>",
"IsOnline" : "Nullable\<Boolean\>",
"IsPACSDisconnected" : "Nullable\<Boolean\>",
"IsTampered" : "Nullable\<Boolean\>",
"IsUpdating" : "Nullable\<Boolean\>",
"MainsPowerInputMessage" : "String",
"NeedsDbPush" : "Nullable\<Boolean\>",
"SoCTemperature" : "String",
"TamperMessage" : "String",
"VoltageInputMessage" : "String",
"VoltagePowerInputMessage" : "String",
"VRS485Message" : "String"
}
Example in C#
// Returns: nothing
await client.UpdateControllerStatusAsync(ControllerInfo controller, ControllerStatusItem status);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/status \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.ControllerStatusItem, Feenics.Keep.WebApi.Model",
"IsTampered":true,
"IsFaulted":true,
"IsBatteryLow":true,
"IsOnline":true,
"IsUpdating":true
}'