ZigBee sensor reporting button presses.
More...
#include <hueplusplus/ZLLSensors.h>
|
| BaseDevice (int id, const std::shared_ptr< APICache > &baseCache) |
| Protected ctor that is used by subclasses, construct with shared cache. More...
|
|
| BaseDevice (int id, const HueCommandAPI &commands, const std::string &path, std::chrono::steady_clock::duration refreshDuration, const nlohmann::json ¤tState) |
| Protected ctor that is used by subclasses. More...
|
|
virtual nlohmann::json | sendPutRequest (const std::string &subPath, const nlohmann::json &request, FileInfo fileInfo) |
| Utility function to send a put request to the device. More...
|
|
int | id |
| holds the id of the device More...
|
|
APICache | state |
| holds the current state of the device More...
|
|
ZigBee sensor reporting button presses.
◆ ZLLSwitch()
hueplusplus::sensors::ZLLSwitch::ZLLSwitch |
( |
Sensor |
sensor | ) |
|
|
inlineexplicit |
Construct from generic sensor.
◆ getBatteryState()
int hueplusplus::sensors::ZLLSwitch::getBatteryState |
( |
| ) |
const |
Get battery state.
- Returns
- Battery state in percent
◆ getButtonEvent()
int hueplusplus::sensors::ZLLSwitch::getButtonEvent |
( |
| ) |
const |
Get the code of the last switch event.
Possible values are c_ON_INITIAL_PRESS etc., or any other value.
◆ getLastAlert()
Alert hueplusplus::sensors::ZLLSwitch::getLastAlert |
( |
| ) |
const |
Get last sent alert.
- Note
- This is not cleared when the alert ends.
◆ getLastUpdated()
Get time of last status update.
- Returns
- The last update time, or a time with a zero duration from epoch if the last update time is not set.
◆ hasBatteryState()
bool hueplusplus::sensors::ZLLSwitch::hasBatteryState |
( |
| ) |
const |
Check whether the sensor has a battery state.
◆ isOn()
bool hueplusplus::sensors::ZLLSwitch::isOn |
( |
| ) |
const |
Check if sensor is on.
Sensors which are off do not change their status
◆ isReachable()
bool hueplusplus::sensors::ZLLSwitch::isReachable |
( |
| ) |
const |
Check whether the sensor is reachable.
◆ sendAlert()
void hueplusplus::sensors::ZLLSwitch::sendAlert |
( |
Alert |
type | ) |
|
Send alert.
- Exceptions
-
std::system_error | when system or socket operations fail |
HueException | when response contained no body |
HueAPIResponseException | when response contains an error |
nlohmann::json::parse_error | when response could not be parsed |
◆ setOn()
void hueplusplus::sensors::ZLLSwitch::setOn |
( |
bool |
on | ) |
|
Enable or disable sensor.
- Exceptions
-
std::system_error | when system or socket operations fail |
HueException | when response contained no body |
HueAPIResponseException | when response contains an error |
nlohmann::json::parse_error | when response could not be parsed |
◆ c_DOWN_HOLD
constexpr int hueplusplus::sensors::ZLLSwitch::c_DOWN_HOLD = 3001 |
|
static |
Button 3 (DIM DOWN) held.
◆ c_DOWN_INITIAL_PRESS
constexpr int hueplusplus::sensors::ZLLSwitch::c_DOWN_INITIAL_PRESS = 3000 |
|
static |
Button 3 (DIM DOWN) pressed.
◆ c_DOWN_LONG_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_DOWN_LONG_RELEASED = 3003 |
|
static |
Button 3 (DIM DOWN) released long press.
◆ c_DOWN_SHORT_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_DOWN_SHORT_RELEASED = 3002 |
|
static |
Button 3 (DIM DOWN) released short press.
◆ c_OFF_HOLD
constexpr int hueplusplus::sensors::ZLLSwitch::c_OFF_HOLD = 4001 |
|
static |
◆ c_OFF_INITIAL_PRESS
constexpr int hueplusplus::sensors::ZLLSwitch::c_OFF_INITIAL_PRESS = 4000 |
|
static |
◆ c_OFF_LONG_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_OFF_LONG_RELEASED = 4003 |
|
static |
Button 4 (OFF) released long press.
◆ c_OFF_SHORT_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_OFF_SHORT_RELEASED = 4002 |
|
static |
Button 4 (OFF) released short press.
◆ c_ON_HOLD
constexpr int hueplusplus::sensors::ZLLSwitch::c_ON_HOLD = 1001 |
|
static |
◆ c_ON_INITIAL_PRESS
constexpr int hueplusplus::sensors::ZLLSwitch::c_ON_INITIAL_PRESS = 1000 |
|
static |
◆ c_ON_LONG_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_ON_LONG_RELEASED = 1003 |
|
static |
Button 1 (ON) released long press.
◆ c_ON_SHORT_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_ON_SHORT_RELEASED = 1002 |
|
static |
Button 1 (ON) released short press.
◆ c_UP_HOLD
constexpr int hueplusplus::sensors::ZLLSwitch::c_UP_HOLD = 2001 |
|
static |
◆ c_UP_INITIAL_PRESS
constexpr int hueplusplus::sensors::ZLLSwitch::c_UP_INITIAL_PRESS = 2000 |
|
static |
Button 2 (DIM UP) pressed.
◆ c_UP_LONG_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_UP_LONG_RELEASED = 2003 |
|
static |
Button 2 (DIM UP) released long press.
◆ c_UP_SHORT_RELEASED
constexpr int hueplusplus::sensors::ZLLSwitch::c_UP_SHORT_RELEASED = 2002 |
|
static |
Button 2 (DIM UP) released short press.
◆ typeStr
constexpr const char * hueplusplus::sensors::ZLLSwitch::typeStr = "ZLLSwitch" |
|
static |
The documentation for this class was generated from the following files: