The structure of Actuator module.
Public Attributes#
Step/rate counted in milliseconds - how often app refresh its state when transitions from current to target value.
Adjusted refreshRate if needed, greater than defaultRefreshRate.
Minimum value that object can have.
Maximum value that object can have.
Current value of object.
End value.
Pointer to function called when CC needs to take an action.
Internal value used to increase/decrease valueCurrent during timed changes.
Internal value, determines should valueCurrent be increasing or decreasing.
Last ON value before setting to OFF (when applicable)
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
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.
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.
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.
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.
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
Always use ZAF_Actuator_GetCurrentValue() to get current value
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
Always use ZAF_Actuator_GetTargetValue() to get target value
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.
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.
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.
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)
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.
57
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h