Skip to content

EnableOperationalModes topic

This instruction asks a node to activate one or more operational modes. See the DisableOperationalModes topic to deactivate modes.

{
    "nodeId": 123,
    "topic": "EnableOperationalModes",
    "parameters": [
        {"name": "OpMode", "value": "inverters-off"}
    ]
}
{
    "nodeId": 123,
    "topic": "EnableOperationalModes",
    "params": {
        "OpMode": "inverters-off"
    }
}
{
    "nodeId": 123,
    "topic": "EnableOperationalModes",
    "parameters": [
        {"name": "OpMode", "value": "inverters-off"},
        {"name": "Expiration", "value": "1564617600000"}
    ]
}

Parameters

The following instruction parameters are available:

Parameter Description
executionDate A future execution date. See deferred instructions for more details.
Expiration An optional date at which the modes should automatically be disabled, as milliseconds since the Unix epoch. If not provided the modes will remain active until deactivated via a DisableOperationalModes instruction. If an operational mode is already active, this value will replace any existing expiration date for that mode.
OpMode The mode to activate. Multiple OpMode parameters can be provided (in the non-compact form) to activate multiple modes.

Result

A Completed state indicates the operational mode(s) were deactivated.