ControllerStatusItem

Represents the status of a controller.

This is where the status of the controller is maintained.

ControllerStatusItem Properties

ControllerStatusItem

Field Type Inherited from Description
IsBatteryLow Nullable<Boolean> ControllerStatusItem Gets or sets a value indicating whether this instance is battery low.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)
IsOnline Nullable<Boolean> ControllerStatusItem Gets or sets a value indicating whether this instance is online.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)

JSON Structure of ControllerStatusItem

{
   "IsBatteryLow"	:	"Nullable\<Boolean\>",
   "IsFaulted"	:	"Nullable\<Boolean\>",
   "IsOnline"	:	"Nullable\<Boolean\>",
   "IsTampered"	:	"Nullable\<Boolean\>",
   "IsUpdating"	:	"Nullable\<Boolean\>"
}

Update Controller Status Async

Example in C#

// Returns: nothing
await client.UpdateControllerStatusAsync(MercuryControllerInfo controller, ControllerStatusItem status)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/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
                   }'