![]() |
HAN-FUN API
1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
|
This structure represents the parameters required for the BREATHE_CMD
effect.
More...
#include <simple_visual_effects.h>
Public Member Functions | |
uint16_t | size () const |
Number bytes needed to serialize the message. More... | |
uint16_t | pack (Common::ByteArray &array, uint16_t offset=0) const |
Write the object on to a ByteArray so it can be sent over the network. More... | |
uint16_t | unpack (const Common::ByteArray &array, uint16_t offset=0) |
Read a message from a ByteArray. More... | |
Data Fields | |
uint8_t | start |
Start brightness in percentage. More... | |
uint16_t | start_hold |
Number of miliseconds to hold start brightness. More... | |
uint16_t | ste_duration |
Number of miliseconds to go from start to end brightness. More... | |
uint8_t | end |
End brightness in percentage. More... | |
uint16_t | end_hold |
Number of miliseconds to hold end brightness. More... | |
uint16_t | ets_duration |
Number of miliseconds to go from end to start brightness. More... | |
uint16_t | number_of_cycles |
Number of times to repeat the Start-End-Start cycle. More... | |
Static Public Attributes | |
static constexpr uint16_t | min_size = 2 * sizeof(uint8_t) + 5 * sizeof(uint16_t) |
Minimum pack/unpack required data size. | |
static constexpr uint16_t | min_number_of_cycles = 1 |
Minimum value for number_of_cycles parameter. | |
This structure represents the parameters required for the BREATHE_CMD
effect.
Definition at line 237 of file simple_visual_effects.h.
|
inline |
Write the object on to a ByteArray so it can be sent over the network.
The buffer passed in MUST have enough size to hold the serialized object, e.g.,
[in,out] | array | ByteArray reference to write the object to. |
[in] | offset | offset to start writing to. |
Definition at line 270 of file simple_visual_effects.h.
References end, end_hold, ets_duration, HF_ASSERT, HF_SERIALIZABLE_CHECK, min_number_of_cycles, min_size, number_of_cycles, start, start_hold, ste_duration, and HF::Common::ByteArray::write().
|
inline |
Number bytes needed to serialize the message.
Definition at line 264 of file simple_visual_effects.h.
References min_size.
|
inline |
Read a message from a ByteArray.
[in] | array | ByteArray reference to read the message from. |
[in] | offset | offset to start reading from. |
Definition at line 291 of file simple_visual_effects.h.
References end, end_hold, ets_duration, HF_ASSERT, HF_SERIALIZABLE_CHECK, min_number_of_cycles, min_size, number_of_cycles, HF::Common::ByteArray::read(), start, start_hold, and ste_duration.
uint8_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::end |
End brightness in percentage.
Definition at line 243 of file simple_visual_effects.h.
uint16_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::end_hold |
Number of miliseconds to hold end
brightness.
Definition at line 244 of file simple_visual_effects.h.
uint16_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::ets_duration |
Number of miliseconds to go from end
to start
brightness.
Definition at line 245 of file simple_visual_effects.h.
uint16_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::number_of_cycles |
Number of times to repeat the Start-End-Start cycle.
Definition at line 247 of file simple_visual_effects.h.
uint8_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::start |
Start brightness in percentage.
Definition at line 239 of file simple_visual_effects.h.
uint16_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::start_hold |
Number of miliseconds to hold start
brightness.
Definition at line 240 of file simple_visual_effects.h.
uint16_t HF::Interfaces::SimpleVisualEffects::BreatheEffect::ste_duration |
Number of miliseconds to go from start
to end
brightness.
Definition at line 241 of file simple_visual_effects.h.