CLIP sensor for a generic 3rd party status. More...
#include <hueplusplus/CLIPSensors.h>
Inheritance diagram for hueplusplus::sensors::CLIPGenericStatus:
Collaboration diagram for hueplusplus::sensors::CLIPGenericStatus:
Public Member Functions | |
| CLIPGenericStatus (Sensor sensor) | |
| Construct from generic sensor. More... | |
| int | getStatus () const |
| Get sensor status. More... | |
| void | setStatus (int status) |
| Set sensor status. More... | |
| Public Member Functions inherited from hueplusplus::sensors::BaseCLIP | |
| bool | isOn () const |
| Check if sensor is on. More... | |
| void | setOn (bool on) |
| Enable or disable sensor. More... | |
| bool | hasBatteryState () const |
| Check whether the sensor has a battery state. More... | |
| int | getBatteryState () const |
| Get battery state. More... | |
| void | setBatteryState (int percent) |
| Set battery state. More... | |
| bool | isReachable () const |
| Check whether the sensor is reachable. More... | |
| bool | hasURL () const |
| Check whether the sensor has a URL. More... | |
| std::string | getURL () const |
| Get sensor URL. More... | |
| void | setURL (const std::string &url) |
| Set sensor URL. More... | |
| time::AbsoluteTime | getLastUpdated () const |
| Get time of last status update. More... | |
| Public Member Functions inherited from hueplusplus::BaseDevice | |
| virtual | ~BaseDevice ()=default |
| Virtual destructor. More... | |
| virtual int | getId () const |
| Const function that returns the id of this device. More... | |
| virtual std::string | getType () const |
| Const function that returns the device type. More... | |
| virtual std::string | getName () |
| Function that returns the name of the device. More... | |
| virtual std::string | getName () const |
| Const function that returns the name of the device. More... | |
| virtual std::string | getModelId () const |
| Const function that returns the modelid of the device. More... | |
| virtual std::string | getUId () const |
| Const function that returns the uniqueid of the device. More... | |
| virtual std::string | getManufacturername () const |
| Const function that returns the manufacturername of the device. More... | |
| virtual std::string | getProductname () const |
| Const function that returns the productname of the device. More... | |
| virtual std::string | getSwVersion () |
| Function that returns the software version of the device. More... | |
| virtual std::string | getSwVersion () const |
| Const function that returns the software version of the device. More... | |
| virtual bool | setName (const std::string &name) |
| Function that sets the name of the device. More... | |
| virtual void | refresh (bool force=false) |
| Refreshes internal cached state. More... | |
| virtual void | setRefreshDuration (std::chrono::steady_clock::duration refreshDuration) |
| Sets custom refresh interval for this device. More... | |
Static Public Attributes | |
| static constexpr const char * | typeStr = "CLIPGenericStatus" |
| CLIPGenericStatus sensor type name. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from hueplusplus::sensors::BaseCLIP | |
| BaseCLIP (Sensor sensor) | |
| Protected constructor to be used by subclasses. More... | |
| Protected Member Functions inherited from hueplusplus::BaseDevice | |
| 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... | |
| Protected Attributes inherited from hueplusplus::BaseDevice | |
| int | id |
| holds the id of the device More... | |
| APICache | state |
| holds the current state of the device More... | |
Detailed Description
CLIP sensor for a generic 3rd party status.
Can be created by POST.
Constructor & Destructor Documentation
◆ CLIPGenericStatus()
|
inlineexplicit |
Construct from generic sensor.
Member Function Documentation
◆ getStatus()
| int hueplusplus::sensors::CLIPGenericStatus::getStatus | ( | ) | const |
Get sensor status.
◆ setStatus()
| void hueplusplus::sensors::CLIPGenericStatus::setStatus | ( | int | status | ) |
Set sensor status.
- 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
Member Data Documentation
◆ typeStr
|
static |
CLIPGenericStatus sensor type name.
The documentation for this class was generated from the following files:
- include/hueplusplus/CLIPSensors.h
- src/CLIPSensors.cpp
