The structure of Actuator module.

Public Attributes#

uint32_t

Step/rate counted in milliseconds - how often app refresh its state when transitions from current to target value.

uint32_t

Adjusted refreshRate if needed, greater than defaultRefreshRate.

uint8_t

Minimum value that object can have.

uint8_t

Maximum value that object can have.

Timer used while transitioning from one state to another.

uint16_t

Current value of object.

uint16_t

End value.

Pointer to function called when CC needs to take an action.

uint16_t

Internal value used to increase/decrease valueCurrent during timed changes.

bool

Internal value, determines should valueCurrent be increasing or decreasing.

uint8_t

Last ON value before setting to OFF (when applicable)

uint8_t

Factory default duration, used in timed changes, when no other duration was given.

Public Attribute Documentation#

defaultRefreshRate#

uint32_t actuator::defaultRefreshRate

Step/rate counted in milliseconds - how often app refresh its state when transitions from current to target value.

Used as timeout in timer


Definition at line 42 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

refreshRate#

uint32_t actuator::refreshRate

Adjusted refreshRate if needed, greater than defaultRefreshRate.


Definition at line 44 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

min#

uint8_t actuator::min

Minimum value that object can have.


Definition at line 45 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

max#

uint8_t actuator::max

Maximum value that object can have.


Definition at line 46 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

timer#

SSwTimer actuator::timer

Timer used while transitioning from one state to another.


Definition at line 47 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

valueCurrent#

uint16_t actuator::valueCurrent

Current value of object.

Internally stored as 10 times higher to get more accurate change. Warnings


Definition at line 48 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

valueTarget#

uint16_t actuator::valueTarget

End value.

Internally stored as 10 times higher to match current value format Warnings


Definition at line 51 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

cc_cb#

zaf_actuator_callback_t actuator::cc_cb

Pointer to function called when CC needs to take an action.


Definition at line 53 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

singleStepValue#

uint16_t actuator::singleStepValue

Internal value used to increase/decrease valueCurrent during timed changes.


Definition at line 54 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

directionUp#

bool actuator::directionUp

Internal value, determines should valueCurrent be increasing or decreasing.


Definition at line 55 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

lastOnValue#

uint8_t actuator::lastOnValue

Last ON value before setting to OFF (when applicable)


Definition at line 56 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

durationDefault#

uint8_t actuator::durationDefault

Factory default duration, used in timed changes, when no other duration was given.


Definition at line 57 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h