`SetOperatingState` topic¶

This instruction requests the node to update the operating state of a device. For example, this can be used to turn a device on or off.

SetOperatingState exampleSetOperatingState example (compact)

{
    "nodeId": 123,
    "topic": "SetOperatingState",
    "parameters": [
        {"name": "/inverter/1", "value": "Shutdown"}
    ]
}

{
    "nodeId": 123,
    "topic": "SetOperatingState",
    "params": {
        "/inverter/1": "Shutdown"
    }
}

Parameters¶

The following instruction parameters are available:

Parameter	Description
`{controlId}`	The control ID of the device whose state should be updated, with the associated parameter value holding the desired operating state to set the device state to.
`executionDate`	A future execution date. See deferred instructions for more details.

A Completed state indicates the operating state was successfully updated on the device.