StateAction Object

A sensor action defines an action to take when a SensorState is triggered.

Properties

Name Type Read Only Required Description
type String yes no Values: activateRelay, adjustTemp, doNothing, shutdownAC, shutdownAuxHeat, shutdownSystem, shutdownCompression, switchToOccupied, switchToUnoccupied, turnOffDehumidifer, turnOffHumidifier, turnOnCool, turnOnDehumidifier, turnOnFan, turnOnHeat, turnOnHumidifier.
sendAlert Boolean yes no Flag to enable an alert to be generated when the state is triggered
sendUpdate Boolean yes no Whether to send an update message.
activationDelay Integer yes no Delay in seconds before the action is triggered by the state change.
deactivationDelay Integer yes no The amount of time to wait before deactivating this state after the state has been cleared.
minActionDuration Integer yes no The minimum length of time to maintain action after sensor has been deactivated.
heatAdjustTemp Integer yes no The amount to increase/decrease current setpoint if the type = adjustTemp.
coolAdjustTemp Integer yes no The amount to increase/decrease current setpoint if the type = adjustTemp.
activateRelay String yes no The user defined relay to be activated, only used for type == activateRelay.
activateRelayOpen Boolean yes no Select if relay is to be open or closed when activated, only used for type == activateRelay.

Back To Top