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


refreshRate#

uint32_t actuator::refreshRate

Adjusted refreshRate if needed, greater than defaultRefreshRate.


min#

uint8_t actuator::min

Minimum value that object can have.


max#

uint8_t actuator::max

Maximum value that object can have.


timer#

SSwTimer actuator::timer

Timer used while transitioning from one state to another.


valueCurrent#

uint16_t actuator::valueCurrent

Current value of object.

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


valueTarget#

uint16_t actuator::valueTarget

End value.

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


cc_cb#

zaf_actuator_callback_t actuator::cc_cb

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


singleStepValue#

uint16_t actuator::singleStepValue

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


directionUp#

bool actuator::directionUp

Internal value, determines should valueCurrent be increasing or decreasing.


lastOnValue#

uint8_t actuator::lastOnValue

Last ON value before setting to OFF (when applicable)


durationDefault#

uint8_t actuator::durationDefault

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