hueplusplus  1.0.0
Public Member Functions | Protected Member Functions | List of all members
hueplusplus::sensors::BaseCLIP Class Reference

Common methods for CLIP sensors. More...

#include <hueplusplus/CLIPSensors.h>

+ Inheritance diagram for hueplusplus::sensors::BaseCLIP:
+ Collaboration diagram for hueplusplus::sensors::BaseCLIP:

Public Member Functions

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

Protected Member Functions

 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 &currentState)
 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...
 

Additional Inherited Members

- 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

Common methods for CLIP sensors.

Constructor & Destructor Documentation

◆ BaseCLIP()

hueplusplus::sensors::BaseCLIP::BaseCLIP ( Sensor  sensor)
inlineexplicitprotected

Protected constructor to be used by subclasses.

Member Function Documentation

◆ getBatteryState()

int hueplusplus::sensors::BaseCLIP::getBatteryState ( ) const

Get battery state.

Returns
Battery state in percent
Exceptions
nlohmann::json::out_of_rangewhen sensor has no battery state.

◆ getLastUpdated()

time::AbsoluteTime hueplusplus::sensors::BaseCLIP::getLastUpdated ( ) const

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.

◆ getURL()

std::string hueplusplus::sensors::BaseCLIP::getURL ( ) const

Get sensor URL.

◆ hasBatteryState()

bool hueplusplus::sensors::BaseCLIP::hasBatteryState ( ) const

Check whether the sensor has a battery state.

◆ hasURL()

bool hueplusplus::sensors::BaseCLIP::hasURL ( ) const

Check whether the sensor has a URL.

◆ isOn()

bool hueplusplus::sensors::BaseCLIP::isOn ( ) const

Check if sensor is on.

Sensors which are off do not change their status

◆ isReachable()

bool hueplusplus::sensors::BaseCLIP::isReachable ( ) const

Check whether the sensor is reachable.

Note
Reachable verification is not implemented for CLIP sensors yet

◆ setBatteryState()

void hueplusplus::sensors::BaseCLIP::setBatteryState ( int  percent)

Set battery state.

Exceptions
std::system_errorwhen system or socket operations fail
HueExceptionwhen response contained no body
HueAPIResponseExceptionwhen response contains an error
nlohmann::json::parse_errorwhen response could not be parsed

◆ setOn()

void hueplusplus::sensors::BaseCLIP::setOn ( bool  on)

Enable or disable sensor.

Exceptions
std::system_errorwhen system or socket operations fail
HueExceptionwhen response contained no body
HueAPIResponseExceptionwhen response contains an error
nlohmann::json::parse_errorwhen response could not be parsed

◆ setURL()

void hueplusplus::sensors::BaseCLIP::setURL ( const std::string &  url)

Set sensor URL.

Exceptions
std::system_errorwhen system or socket operations fail
HueExceptionwhen response contained no body
HueAPIResponseExceptionwhen response contains an error
nlohmann::json::parse_errorwhen response could not be parsed

The documentation for this class was generated from the following files: