Fawkes API  Fawkes Development Version
fawkes::SwitchInterface::SwitchInterface_data_t Struct Reference

Internal data storage, do NOT modify! More...

List of all members.

Public Attributes

int64_t timestamp_sec
 Interface Unix timestamp, seconds.
int64_t timestamp_usec
 Interface Unix timestamp, micro-seconds.
bool enabled
 True if the switch is currently enabled.
float value
 If switches support multiple states these can be indicated with this value.
float history
 This value records the number of seconds a switch has been enabled continuously -- or not.
uint32_t short_activations
 Number of consecutive short clicks (turned on).
uint32_t long_activations
 Number of consecutive short clicks (turned on).
uint32_t activation_count
 Number that is to be incremented whenever a short or long activation happened.

Detailed Description

Internal data storage, do NOT modify!


Member Data Documentation

Number that is to be incremented whenever a short or long activation happened.

Can be used to decide if a change in status happened.

Definition at line 71 of file SwitchInterface.h.

This value records the number of seconds a switch has been enabled continuously -- or not.

The time is recorded in seconds. A positive value indicates time the switch was turned on, a negative value indicates the time (when converted to the absolute value) the button has not been pressed. Zero means "just initialized".

Definition at line 55 of file SwitchInterface.h.

Number of consecutive short clicks (turned on).

Can be used to recognize patterns of clicks. This is an optional field.

Definition at line 67 of file SwitchInterface.h.

Number of consecutive short clicks (turned on).

Can be used to recognize patterns of clicks. This is an optional field.

Definition at line 63 of file SwitchInterface.h.

Interface Unix timestamp, seconds.

Definition at line 45 of file SwitchInterface.h.

Interface Unix timestamp, micro-seconds.

Definition at line 46 of file SwitchInterface.h.

If switches support multiple states these can be indicated with this value.

For example for a switch that notes the intensity it could be a value in the valid range.

Definition at line 50 of file SwitchInterface.h.

Referenced by fawkes::SwitchInterface::SetMessage::value(), fawkes::SwitchInterface::SetMessage::set_value(), fawkes::SwitchInterface::EnableDurationMessage::value(), and fawkes::SwitchInterface::EnableDurationMessage::set_value().


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