Sensor.h

Go to the documentation of this file.

#ifndef INCLUDE_HUEPLUSPLUS_HUE_SENSOR_H
#define INCLUDE_HUEPLUSPLUS_HUE_SENSOR_H

#include <memory>

#include "BaseDevice.h"
#include "Condition.h"
#include "HueCommandAPI.h"
#include "TimePattern.h"

#include "json/json.hpp"

namespace hueplusplus
{
enum class Alert
{
    none, 
    select, 
    lselect 
};

std::string alertToString(Alert alert);

Alert alertFromString(const std::string& s);

class Sensor : public BaseDevice
{
public:
    Sensor(int id, const std::shared_ptr<APICache>& baseCache);

    Sensor(int id, const HueCommandAPI& commands, std::chrono::steady_clock::duration refreshDuration, const nlohmann::json& currentState);


    bool hasOn() const;
    bool isOn() const;
    void setOn(bool on);

    bool hasBatteryState() const;
    int getBatteryState() const;
    void setBatteryState(int percent);

    bool hasAlert() const;
    Alert getLastAlert() const;
    void sendAlert(Alert type);

    bool hasReachable() const;
    bool isReachable() const;

    bool hasUserTest() const;
    void setUserTest(bool enabled);

    bool hasURL() const;
    std::string getURL() const;
    void setURL(const std::string& url);

    std::vector<std::string> getPendingConfig() const;

    bool hasLEDIndication() const;
    bool getLEDIndication() const;
    void setLEDIndication(bool on);

    nlohmann::json getConfig() const;
    void setConfigAttribute(const std::string& key, const nlohmann::json& value);


    time::AbsoluteTime getLastUpdated() const;

    nlohmann::json getState() const;
    void setStateAttribute(const std::string& key, const nlohmann::json& value);

    std::string getStateAddress(const std::string& key) const;

    bool isCertified() const;
    bool isPrimary() const;

    template <typename T>
    T asSensorType() const&
    {
        if (getType() != T::typeStr)
        {
            throw HueException(FileInfo {__FILE__, __LINE__, __func__}, "Sensor type does not match: " + getType());
        }
        return T(*this);
    }
    template <typename T>
    T asSensorType() &&
    {
        if (getType() != T::typeStr)
        {
            throw HueException(FileInfo {__FILE__, __LINE__, __func__}, "Sensor type does not match: " + getType());
        }
        return T(std::move(*this));
    }
};

class CreateSensor
{
public:
    CreateSensor(const std::string& name, const std::string& modelid, const std::string& swversion,
        const std::string& type, const std::string& uniqueid, const std::string& manufacturername);

    CreateSensor& setState(const nlohmann::json& state);
    CreateSensor& setConfig(const nlohmann::json& config);
    CreateSensor& setRecycle(bool recycle);

    nlohmann::json getRequest() const;

protected:
    nlohmann::json request;
};

namespace sensors
{
class DaylightSensor : public BaseDevice
{
public:
    explicit DaylightSensor(Sensor sensor) : BaseDevice(std::move(sensor)) { }

    bool isOn() const;

    void setOn(bool on);

    bool hasBatteryState() const;
    int getBatteryState() const;
    void setBatteryState(int percent);

    void setCoordinates(const std::string& latitude, const std::string& longitude);
    bool isConfigured() const;

    int getSunriseOffset() const;
    void setSunriseOffset(int minutes);

    int getSunsetOffset() const;
    void setSunsetOffset(int minutes);

    bool isDaylight() const;

    time::AbsoluteTime getLastUpdated() const;

    static constexpr const char* typeStr = "Daylight";
};

detail::ConditionHelper<bool> makeCondition(const DaylightSensor& sensor);

template <typename SensorT, detail::void_t<decltype(std::declval<const SensorT>().getLastUpdated())>* = nullptr>
detail::ConditionHelper<time::AbsoluteTime> makeConditionLastUpdate(const SensorT& sensor)
{
    return detail::ConditionHelper<time::AbsoluteTime>(
        "/sensors/" + std::to_string(sensor.getId()) + "/state/lastupdated");
}

template <typename ButtonSensor, detail::void_t<decltype(std::declval<const ButtonSensor>().getButtonEvent())>* = nullptr>
detail::ConditionHelper<int> makeCondition(const ButtonSensor& sensor)
{
    return detail::ConditionHelper<int>(
        "/sensors/" + std::to_string(sensor.getId()) + "/state/buttonevent");
}

template <typename PresenceSensor, detail::void_t<decltype(std::declval<const PresenceSensor>().getPresence())>* = nullptr>
detail::ConditionHelper<bool> makeCondition(const PresenceSensor& sensor)
{
    return detail::ConditionHelper<bool>(
        "/sensors/" + std::to_string(sensor.getId()) + "/state/presence");
}

template <typename TemperatureSensor, detail::void_t<decltype(std::declval<const TemperatureSensor>().getPresence())>* = nullptr>
detail::ConditionHelper<int> makeCondition(const TemperatureSensor& sensor)
{
    return detail::ConditionHelper<int>(
        "/sensors/" + std::to_string(sensor.getId()) + "/state/temperature");
}

} // namespace sensors

} // namespace hueplusplus

#endif