hueplusplus  1.0.0
Public Member Functions | Static Public Attributes | List of all members
hueplusplus::sensors::ZLLLightLevel Class Reference

ZigBee sensor detecting ambient light level. More...

#include <hueplusplus/ZLLSensors.h>

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

Public Member Functions

 ZLLLightLevel (Sensor sensor)
 Construct from generic sensor. More...
 
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...
 
bool isReachable () const
 Check whether the sensor is reachable. More...
 
int getDarkThreshold () const
 Get threshold to detect darkness. More...
 
void setDarkThreshold (int threshold)
 Set threshold to detect darkness. More...
 
int getThresholdOffset () const
 Get offset over dark threshold to detect daylight. More...
 
void setThresholdOffset (int offset)
 Set offset to detect daylight. More...
 
int getLightLevel () const
 Get measured light level. More...
 
bool isDark () const
 Check whether light level is below dark threshold. More...
 
bool isDaylight () const
 Check whether light level is above light threshold. 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 = "ZLLLightLevel"
 ZLLLightLevel sensor type name. More...
 

Additional Inherited Members

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

ZigBee sensor detecting ambient light level.

Constructor & Destructor Documentation

◆ ZLLLightLevel()

hueplusplus::sensors::ZLLLightLevel::ZLLLightLevel ( Sensor  sensor)
inlineexplicit

Construct from generic sensor.

Member Function Documentation

◆ getBatteryState()

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

Get battery state.

Returns
Battery state in percent

◆ getDarkThreshold()

int hueplusplus::sensors::ZLLLightLevel::getDarkThreshold ( ) const

Get threshold to detect darkness.

◆ getLastUpdated()

time::AbsoluteTime hueplusplus::sensors::ZLLLightLevel::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.

◆ getLightLevel()

int hueplusplus::sensors::ZLLLightLevel::getLightLevel ( ) const

Get measured light level.

Returns
Light level in 10000*log10(lux)+1 (logarithmic scale)

◆ getThresholdOffset()

int hueplusplus::sensors::ZLLLightLevel::getThresholdOffset ( ) const

Get offset over dark threshold to detect daylight.

◆ hasBatteryState()

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

Check whether the sensor has a battery state.

◆ isDark()

bool hueplusplus::sensors::ZLLLightLevel::isDark ( ) const

Check whether light level is below dark threshold.

◆ isDaylight()

bool hueplusplus::sensors::ZLLLightLevel::isDaylight ( ) const

Check whether light level is above light threshold.

Light threshold is dark threshold + offset

◆ isOn()

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

Check if sensor is on.

Sensors which are off do not change their status

◆ isReachable()

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

Check whether the sensor is reachable.

◆ setDarkThreshold()

void hueplusplus::sensors::ZLLLightLevel::setDarkThreshold ( int  threshold)

Set threshold to detect darkness.

Parameters
thresholdLight level as reported by getLightLevel
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::ZLLLightLevel::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

◆ setThresholdOffset()

void hueplusplus::sensors::ZLLLightLevel::setThresholdOffset ( int  offset)

Set offset to detect daylight.

Parameters
offsetOffset to dark threshold to detect daylight. Must be greater than 1.
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

Member Data Documentation

◆ typeStr

constexpr const char * hueplusplus::sensors::ZLLLightLevel::typeStr = "ZLLLightLevel"
static

ZLLLightLevel sensor type name.


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