hueplusplus::sensors::ZLLPresence Class Reference

Sensor detecting presence in the vicinity. More...

#include <hueplusplus/ZLLSensors.h>

Inheritance diagram for hueplusplus::sensors::ZLLPresence:

Collaboration diagram for hueplusplus::sensors::ZLLPresence:

Public Member Functions
	ZLLPresence (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...
Alert	getLastAlert () const
	Get last sent alert. More...
void	sendAlert (Alert type)
	Send alert. More...
bool	isReachable () const
	Check whether the sensor is reachable. More...
int	getSensitivity () const
	Get sensor sensitivity. More...
int	getMaxSensitivity () const
	Get maximum sensitivity. More...
void	setSensitivity (int sensitivity)
	Set sensor sensitivity. More...
bool	getPresence () const
	Get presence status. 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 = "ZLLPresence"
	ZLLPresence 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

Sensor detecting presence in the vicinity.

Constructor & Destructor Documentation

ZLLPresence()

hueplusplus::sensors::ZLLPresence::ZLLPresence ( Sensor  sensor )

inlineexplicit

Construct from generic sensor.

Member Function Documentation

getBatteryState()

int hueplusplus::sensors::ZLLPresence::getBatteryState

(

)

const

Get battery state.

Returns

Battery state in percent

getLastAlert()

Alert hueplusplus::sensors::ZLLPresence::getLastAlert

(

)

const

Get last sent alert.

Note

This is not cleared when the alert ends.

getLastUpdated()

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

getMaxSensitivity()

int hueplusplus::sensors::ZLLPresence::getMaxSensitivity

(

)

const

Get maximum sensitivity.

getPresence()

bool hueplusplus::sensors::ZLLPresence::getPresence

(

)

const

Get presence status.

getSensitivity()

int hueplusplus::sensors::ZLLPresence::getSensitivity

(

)

const

Get sensor sensitivity.

hasBatteryState()

bool hueplusplus::sensors::ZLLPresence::hasBatteryState

(

)

const

Check whether the sensor has a battery state.

isOn()

bool hueplusplus::sensors::ZLLPresence::isOn

(

)

const

Check if sensor is on.

Sensors which are off do not change their status

isReachable()

bool hueplusplus::sensors::ZLLPresence::isReachable

(

)

const

Check whether the sensor is reachable.

sendAlert()

void hueplusplus::sensors::ZLLPresence::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::ZLLPresence::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

setSensitivity()

void hueplusplus::sensors::ZLLPresence::setSensitivity

(

int

sensitivity

)

Set sensor sensitivity.

Parameters

sensitivity

Sensitivity from 0 to max sensitivity (inclusive)

Member Data Documentation

typeStr

constexpr const char * hueplusplus::sensors::ZLLPresence::typeStr = "ZLLPresence"

static

ZLLPresence sensor type name.

---

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

• include/hueplusplus/ZLLSensors.h
• src/ZLLSensors.cpp