#include <ZAF_Actuator.h>

Collaboration diagram for actuator:

Data Fields
uint32_t	defaultRefreshRate

uint32_t	refreshRate
	Adjusted refreshRate if needed, greater than defaultRefreshRate.

uint8_t	min
	Minimum value that object can have.

uint8_t	max
	Maximum value that object can have.

SSwTimer	timer
	Timer used while transitioning from one state to another.

uint16_t	valueCurrent

uint16_t	valueTarget

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

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

bool	directionUp
	Internal value, determines should valueCurrent be increasing or decreasing.

uint8_t	lastOnValue
	Last ON value before setting to OFF (when applicable)

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

Detailed Description

The structure of Actuator module

Field Documentation

◆ cc_cb

zaf_actuator_callback_t actuator::cc_cb

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

◆ 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

◆ directionUp

bool actuator::directionUp

Internal value, determines should valueCurrent be increasing or decreasing.

◆ durationDefault

uint8_t actuator::durationDefault

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

◆ lastOnValue

uint8_t actuator::lastOnValue

Last ON value before setting to OFF (when applicable)

◆ max

uint8_t actuator::max

Maximum value that object can have.

◆ min

uint8_t actuator::min

Minimum value that object can have.

◆ refreshRate

uint32_t actuator::refreshRate

Adjusted refreshRate if needed, greater than defaultRefreshRate.

◆ singleStepValue

uint16_t actuator::singleStepValue

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

◆ 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.

Warning: Always use ZAF_Actuator_GetCurrentValue() to get current value

◆ valueTarget

uint16_t actuator::valueTarget

End value. Internally stored as 10 times higher to match current value format

Warning: Always use ZAF_Actuator_GetTargetValue() to get target value

The documentation for this struct was generated from the following file:

/sdk/z-wave/z-wave-stack/ZAF/ApplicationUtilities/Actuator/ZAF_Actuator.h

Trident IoT Z-Wave SDK

Data Fields