mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
Add Home Assistant Lights support (#1763)
* New HomeAssistant LEDDevice * Fix typos * Ping Qt for Windows to 6.7 until aqtinstaller is fixed * Fix HA default port handling * HA - Update default latchtime and range * Add HA Wizard and light selection * Naming consistency * Fix "Selected Hyperion instance is not running" * CodeQL findings * HA - allow to overwrite brightness by HA yes or no * HA - Support switch off on black * HA - Add transition time
This commit is contained in:
LordGrey
GitHub
@@ -735,7 +735,7 @@ void JsonAPI::handleConfigSetCommand(const QJsonObject &message, const JsonApiCo
|
||||
}
|
||||
else
|
||||
{
|
||||
sendErrorReply("Saving configuration while Hyperion is disabled isn't possible", cmd);
|
||||
sendErrorReply("It is not possible saving a configuration while Hyperion is disabled", cmd);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
<file alias="schema-dmx">schemas/schema-dmx.json</file>
|
||||
<file alias="schema-fadecandy">schemas/schema-fadecandy.json</file>
|
||||
<file alias="schema-file">schemas/schema-file.json</file>
|
||||
<file alias="schema-homeassistant">schemas/schema-homeassistant.json</file>
|
||||
<file alias="schema-hyperionusbasp">schemas/schema-hyperionusbasp.json</file>
|
||||
<file alias="schema-lightpack">schemas/schema-lightpack.json</file>
|
||||
<file alias="schema-lpd6803">schemas/schema-lpd6803.json</file>
|
||||
|
||||
446
libsrc/leddevice/dev_net/LedDeviceHomeAssistant.cpp
Normal file
446
libsrc/leddevice/dev_net/LedDeviceHomeAssistant.cpp
Normal file
@@ -0,0 +1,446 @@
|
||||
// Local-Hyperion includes
|
||||
#include "LedDeviceHomeAssistant.h"
|
||||
|
||||
#include <ssdp/SSDPDiscover.h>
|
||||
// mDNS discover
|
||||
#ifdef ENABLE_MDNS
|
||||
#include <mdns/MdnsBrowser.h>
|
||||
#include <mdns/MdnsServiceRegister.h>
|
||||
#endif
|
||||
#include <utils/NetUtils.h>
|
||||
#include <utils/ColorRgb.h>
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
// Constants
|
||||
namespace {
|
||||
const bool verbose = false;
|
||||
|
||||
// Configuration settings
|
||||
const char CONFIG_HOST[] = "host";
|
||||
const char CONFIG_PORT[] = "port";
|
||||
const char CONFIG_AUTH_TOKEN[] = "token";
|
||||
const char CONFIG_ENITYIDS[] = "entityIds";
|
||||
const char CONFIG_BRIGHTNESS[] = "brightness";
|
||||
const char CONFIG_BRIGHTNESS_OVERWRITE[] = "overwriteBrightness";
|
||||
const char CONFIG_FULL_BRIGHTNESS_AT_START[] = "fullBrightnessAtStart";
|
||||
const char CONFIG_ON_OFF_BLACK[] = "switchOffOnBlack";
|
||||
const char CONFIG_TRANSITIONTIME[] = "transitionTime";
|
||||
|
||||
const bool DEFAULT_IS_BRIGHTNESS_OVERWRITE = true;
|
||||
const bool DEFAULT_IS_FULL_BRIGHTNESS_AT_START = true;
|
||||
const int BRI_MAX = 255;
|
||||
const bool DEFAULT_IS_SWITCH_OFF_ON_BLACK = false;
|
||||
|
||||
// Home Assistant API
|
||||
const int API_DEFAULT_PORT = 8123;
|
||||
const char API_BASE_PATH[] = "/api/";
|
||||
const char API_STATES[] = "states";
|
||||
const char API_LIGHT_TURN_ON[] = "services/light/turn_on";
|
||||
const char API_LIGHT_TURN_OFF[] = "services/light/turn_off";
|
||||
|
||||
const char ENTITY_ID[] = "entity_id";
|
||||
const char RGB_COLOR[] = "rgb_color";
|
||||
const char BRIGHTNESS[] = "brightness";
|
||||
const char TRANSITION[] = "transition";
|
||||
const char FLASH[] = "flash";
|
||||
|
||||
// // Home Assistant ssdp services
|
||||
const char SSDP_ID[] = "ssdp:all";
|
||||
const char SSDP_FILTER_HEADER[] = "ST";
|
||||
const char SSDP_FILTER[] = "(.*)home-assistant.io(.*)";
|
||||
|
||||
} //End of constants
|
||||
|
||||
LedDeviceHomeAssistant::LedDeviceHomeAssistant(const QJsonObject& deviceConfig)
|
||||
: LedDevice(deviceConfig)
|
||||
, _restApi(nullptr)
|
||||
, _apiPort(API_DEFAULT_PORT)
|
||||
, _isBrightnessOverwrite(DEFAULT_IS_BRIGHTNESS_OVERWRITE)
|
||||
, _isFullBrightnessAtStart(DEFAULT_IS_FULL_BRIGHTNESS_AT_START)
|
||||
, _brightness (BRI_MAX)
|
||||
{
|
||||
#ifdef ENABLE_MDNS
|
||||
QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType",
|
||||
Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType(_activeDeviceType)));
|
||||
#endif
|
||||
}
|
||||
|
||||
LedDevice* LedDeviceHomeAssistant::construct(const QJsonObject& deviceConfig)
|
||||
{
|
||||
return new LedDeviceHomeAssistant(deviceConfig);
|
||||
}
|
||||
|
||||
LedDeviceHomeAssistant::~LedDeviceHomeAssistant()
|
||||
{
|
||||
delete _restApi;
|
||||
_restApi = nullptr;
|
||||
}
|
||||
|
||||
bool LedDeviceHomeAssistant::init(const QJsonObject& deviceConfig)
|
||||
{
|
||||
bool isInitOK{ false };
|
||||
|
||||
if ( LedDevice::init(deviceConfig) )
|
||||
{
|
||||
// Overwrite non supported/required features
|
||||
if (deviceConfig["rewriteTime"].toInt(0) > 0)
|
||||
{
|
||||
Info(_log, "Home Assistant lights do not require rewrites. Refresh time is ignored.");
|
||||
setRewriteTime(0);
|
||||
}
|
||||
DebugIf(verbose, _log, "deviceConfig: [%s]", QString(QJsonDocument(_devConfig).toJson(QJsonDocument::Compact)).toUtf8().constData());
|
||||
|
||||
//Set hostname as per configuration and default port
|
||||
_hostName = deviceConfig[CONFIG_HOST].toString();
|
||||
_apiPort = deviceConfig[CONFIG_PORT].toInt(API_DEFAULT_PORT);
|
||||
_bearerToken = deviceConfig[CONFIG_AUTH_TOKEN].toString();
|
||||
|
||||
_isBrightnessOverwrite = _devConfig[CONFIG_BRIGHTNESS_OVERWRITE].toBool(DEFAULT_IS_BRIGHTNESS_OVERWRITE);
|
||||
_isFullBrightnessAtStart = _devConfig[CONFIG_FULL_BRIGHTNESS_AT_START].toBool(DEFAULT_IS_FULL_BRIGHTNESS_AT_START);
|
||||
_brightness = _devConfig[CONFIG_BRIGHTNESS].toInt(BRI_MAX);
|
||||
_switchOffOnBlack = _devConfig[CONFIG_ON_OFF_BLACK].toBool(DEFAULT_IS_SWITCH_OFF_ON_BLACK);
|
||||
int transitionTimeMs = _devConfig[CONFIG_TRANSITIONTIME].toInt(0);
|
||||
_transitionTime = transitionTimeMs / 1000.0;
|
||||
|
||||
Debug(_log, "Hostname/IP : %s", QSTRING_CSTR(_hostName));
|
||||
Debug(_log, "Port : %d", _apiPort );
|
||||
|
||||
Debug(_log, "Overwrite Brightn.: %s", _isBrightnessOverwrite ? "Yes" : "No" );
|
||||
Debug(_log, "Set Brightness to : %d", _brightness);
|
||||
Debug(_log, "Full Bri. at start: %s", _isFullBrightnessAtStart ? "Yes" : "No" );
|
||||
Debug(_log, "Off on Black : %s", _switchOffOnBlack ? "Yes" : "No" );
|
||||
Debug(_log, "Transition Time : %d ms", transitionTimeMs );
|
||||
|
||||
_lightEntityIds = _devConfig[ CONFIG_ENITYIDS ].toVariant().toStringList();
|
||||
int configuredLightsCount = _lightEntityIds.size();
|
||||
|
||||
if ( configuredLightsCount == 0 )
|
||||
{
|
||||
this->setInError( "No light entity-ids configured" );
|
||||
isInitOK = false;
|
||||
}
|
||||
else
|
||||
{
|
||||
Debug(_log, "Lights configured : %d", configuredLightsCount );
|
||||
isInitOK = true;
|
||||
}
|
||||
}
|
||||
|
||||
return isInitOK;
|
||||
}
|
||||
|
||||
bool LedDeviceHomeAssistant::initLedsConfiguration()
|
||||
{
|
||||
bool isInitOK = false;
|
||||
|
||||
//Currently on one light is supported
|
||||
QString lightEntityId = _lightEntityIds[0];
|
||||
|
||||
//Get properties for configured light entitiy to check availability
|
||||
_restApi->setPath({ API_STATES, lightEntityId});
|
||||
httpResponse response = _restApi->get();
|
||||
if (response.error())
|
||||
{
|
||||
QString errorReason = QString("%1 get properties failed with error: '%2'").arg(_activeDeviceType,response.getErrorReason());
|
||||
this->setInError(errorReason);
|
||||
}
|
||||
else
|
||||
{
|
||||
QJsonObject propertiesDetails = response.getBody().object();
|
||||
if (propertiesDetails.isEmpty())
|
||||
{
|
||||
QString errorReason = QString("Light [%1] does not exist").arg(lightEntityId);
|
||||
this->setInError(errorReason);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (propertiesDetails.value("state").toString().compare("unavailable") == 0)
|
||||
{
|
||||
Warning(_log, "Light [%s] is currently unavailable", QSTRING_CSTR(lightEntityId));
|
||||
}
|
||||
isInitOK = true;
|
||||
}
|
||||
}
|
||||
return isInitOK;
|
||||
}
|
||||
|
||||
bool LedDeviceHomeAssistant::openRestAPI()
|
||||
{
|
||||
bool isInitOK{ true };
|
||||
|
||||
if (_restApi == nullptr)
|
||||
{
|
||||
if (_apiPort == 0)
|
||||
{
|
||||
_apiPort = API_DEFAULT_PORT;
|
||||
}
|
||||
|
||||
_restApi = new ProviderRestApi(_address.toString(), _apiPort);
|
||||
_restApi->setLogger(_log);
|
||||
|
||||
_restApi->setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
|
||||
_restApi->setHeader("Authorization", QByteArrayLiteral("Bearer ") + _bearerToken.toUtf8());
|
||||
|
||||
//Base-path is api-path
|
||||
_restApi->setBasePath(API_BASE_PATH);
|
||||
}
|
||||
return isInitOK;
|
||||
}
|
||||
|
||||
int LedDeviceHomeAssistant::open()
|
||||
{
|
||||
int retval = -1;
|
||||
_isDeviceReady = false;
|
||||
|
||||
if (NetUtils::resolveHostToAddress(_log, _hostName, _address, _apiPort))
|
||||
{
|
||||
if (openRestAPI())
|
||||
{
|
||||
// Read LedDevice configuration and validate against device configuration
|
||||
if (initLedsConfiguration())
|
||||
{
|
||||
// Everything is OK, device is ready
|
||||
_isDeviceReady = true;
|
||||
retval = 0;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
_restApi->setHost(_address.toString());
|
||||
_restApi->setPort(_apiPort);
|
||||
}
|
||||
}
|
||||
return retval;
|
||||
}
|
||||
|
||||
QJsonArray LedDeviceHomeAssistant::discoverSsdp() const
|
||||
{
|
||||
QJsonArray deviceList;
|
||||
SSDPDiscover ssdpDiscover;
|
||||
ssdpDiscover.skipDuplicateKeys(true);
|
||||
ssdpDiscover.setSearchFilter(SSDP_FILTER, SSDP_FILTER_HEADER);
|
||||
QString searchTarget = SSDP_ID;
|
||||
|
||||
if (ssdpDiscover.discoverServices(searchTarget) > 0)
|
||||
{
|
||||
deviceList = ssdpDiscover.getServicesDiscoveredJson();
|
||||
}
|
||||
return deviceList;
|
||||
}
|
||||
|
||||
QJsonObject LedDeviceHomeAssistant::discover(const QJsonObject& /*params*/)
|
||||
{
|
||||
QJsonObject devicesDiscovered;
|
||||
devicesDiscovered.insert("ledDeviceType", _activeDeviceType);
|
||||
|
||||
QJsonArray deviceList;
|
||||
|
||||
#ifdef ENABLE_MDNS
|
||||
QString discoveryMethod("mDNS");
|
||||
deviceList = MdnsBrowser::getInstance().data()->getServicesDiscoveredJson(
|
||||
MdnsServiceRegister::getServiceType(_activeDeviceType),
|
||||
MdnsServiceRegister::getServiceNameFilter(_activeDeviceType),
|
||||
DEFAULT_DISCOVER_TIMEOUT
|
||||
);
|
||||
#else
|
||||
QString discoveryMethod("ssdp");
|
||||
deviceList = discoverSsdp();
|
||||
#endif
|
||||
|
||||
devicesDiscovered.insert("discoveryMethod", discoveryMethod);
|
||||
devicesDiscovered.insert("devices", deviceList);
|
||||
|
||||
DebugIf(verbose, _log, "devicesDiscovered: [%s]", QString(QJsonDocument(devicesDiscovered).toJson(QJsonDocument::Compact)).toUtf8().constData());
|
||||
|
||||
return devicesDiscovered;
|
||||
}
|
||||
|
||||
QJsonObject LedDeviceHomeAssistant::getProperties(const QJsonObject& params)
|
||||
{
|
||||
DebugIf(verbose, _log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData());
|
||||
QJsonObject properties;
|
||||
|
||||
_hostName = params[CONFIG_HOST].toString("");
|
||||
_apiPort = API_DEFAULT_PORT;
|
||||
_bearerToken = params[CONFIG_AUTH_TOKEN].toString("");
|
||||
|
||||
Info(_log, "Get properties for %s, hostname (%s)", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(_hostName));
|
||||
|
||||
if (NetUtils::resolveHostToAddress(_log, _hostName, _address, _apiPort))
|
||||
{
|
||||
if (openRestAPI())
|
||||
{
|
||||
QString filter = params["filter"].toString("");
|
||||
_restApi->setPath(filter);
|
||||
|
||||
// Perform request
|
||||
httpResponse response = _restApi->get();
|
||||
if (response.error())
|
||||
{
|
||||
Warning(_log, "%s get properties failed with error: '%s'", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(response.getErrorReason()));
|
||||
}
|
||||
|
||||
QJsonObject propertiesDetails;
|
||||
const QJsonDocument jsonDoc = response.getBody();
|
||||
if (jsonDoc.isArray()) {
|
||||
const QJsonArray jsonArray = jsonDoc.array();
|
||||
QVector<QJsonValue> filteredVector;
|
||||
|
||||
// Iterate over the array and filter objects with entity_id starting with "light."
|
||||
for (const QJsonValue &value : jsonArray)
|
||||
{
|
||||
QJsonObject obj = value.toObject();
|
||||
QString entityId = obj[ENTITY_ID].toString();
|
||||
|
||||
if (entityId.startsWith("light."))
|
||||
{
|
||||
filteredVector.append(obj);
|
||||
}
|
||||
}
|
||||
|
||||
// Sort the filtered vector by "friendly_name" in ascending order
|
||||
std::sort(filteredVector.begin(), filteredVector.end(), [](const QJsonValue &a, const QJsonValue &b) {
|
||||
QString nameA = a.toObject()["attributes"].toObject()["friendly_name"].toString();
|
||||
QString nameB = b.toObject()["attributes"].toObject()["friendly_name"].toString();
|
||||
return nameA < nameB; // Ascending order
|
||||
});
|
||||
// Convert the sorted vector back to a QJsonArray
|
||||
QJsonArray sortedArray;
|
||||
for (const QJsonValue &value : filteredVector) {
|
||||
sortedArray.append(value);
|
||||
}
|
||||
|
||||
propertiesDetails.insert("lightEntities", sortedArray);
|
||||
|
||||
}
|
||||
|
||||
if (!propertiesDetails.isEmpty())
|
||||
{
|
||||
propertiesDetails.insert("ledCount", 1);
|
||||
}
|
||||
properties.insert("properties", propertiesDetails);
|
||||
}
|
||||
|
||||
DebugIf(verbose, _log, "properties: [%s]", QString(QJsonDocument(properties).toJson(QJsonDocument::Compact)).toUtf8().constData());
|
||||
}
|
||||
return properties;
|
||||
}
|
||||
|
||||
void LedDeviceHomeAssistant::identify(const QJsonObject& params)
|
||||
{
|
||||
DebugIf(verbose, _log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData());
|
||||
|
||||
_hostName = params[CONFIG_HOST].toString("");
|
||||
_apiPort = API_DEFAULT_PORT;
|
||||
_bearerToken = params[CONFIG_AUTH_TOKEN].toString("");
|
||||
|
||||
Info(_log, "Identify %s, hostname (%s)", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(_hostName));
|
||||
|
||||
if (NetUtils::resolveHostToAddress(_log, _hostName, _address, _apiPort))
|
||||
{
|
||||
if (openRestAPI())
|
||||
{
|
||||
QJsonArray lightEntityIds = params[ ENTITY_ID ].toArray();
|
||||
|
||||
_restApi->setPath(API_LIGHT_TURN_ON);
|
||||
QJsonObject serviceAttributes{{ENTITY_ID, lightEntityIds}};
|
||||
serviceAttributes.insert(FLASH, "short");
|
||||
|
||||
httpResponse response = _restApi->post(serviceAttributes);
|
||||
if (response.error())
|
||||
{
|
||||
Warning(_log, "%s identification failed with error: '%s'", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(response.getErrorReason()));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool LedDeviceHomeAssistant::powerOn()
|
||||
{
|
||||
bool isOn = false;
|
||||
if (_isDeviceReady)
|
||||
{
|
||||
_restApi->setPath(API_LIGHT_TURN_ON);
|
||||
QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}};
|
||||
|
||||
if (_isFullBrightnessAtStart)
|
||||
{
|
||||
serviceAttributes.insert(BRIGHTNESS, BRI_MAX);
|
||||
}
|
||||
|
||||
httpResponse response = _restApi->post(serviceAttributes);
|
||||
if (response.error())
|
||||
{
|
||||
QString errorReason = QString("Power-on request failed with error: '%1'").arg(response.getErrorReason());
|
||||
this->setInError(errorReason);
|
||||
isOn = false;
|
||||
}
|
||||
else {
|
||||
isOn = true;
|
||||
}
|
||||
}
|
||||
return isOn;
|
||||
}
|
||||
|
||||
bool LedDeviceHomeAssistant::powerOff()
|
||||
{
|
||||
bool isOff = true;
|
||||
if (_isDeviceReady)
|
||||
{
|
||||
_restApi->setPath(API_LIGHT_TURN_OFF);
|
||||
QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}};
|
||||
httpResponse response = _restApi->post(serviceAttributes);
|
||||
if (response.error())
|
||||
{
|
||||
QString errorReason = QString("Power-off request failed with error: '%1'").arg(response.getErrorReason());
|
||||
this->setInError(errorReason);
|
||||
isOff = false;
|
||||
}
|
||||
}
|
||||
return isOff;
|
||||
}
|
||||
|
||||
int LedDeviceHomeAssistant::write(const std::vector<ColorRgb>& ledValues)
|
||||
{
|
||||
int retVal = 0;
|
||||
|
||||
QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}};
|
||||
ColorRgb ledValue = ledValues.at(0);
|
||||
|
||||
if (_switchOffOnBlack && ledValue == ColorRgb::BLACK)
|
||||
{
|
||||
_restApi->setPath(API_LIGHT_TURN_OFF);
|
||||
}
|
||||
else
|
||||
{
|
||||
// http://hostname:port/api/services/light/turn_on
|
||||
// {
|
||||
// "entity_id": [ entity-IDs ],
|
||||
// "rgb_color": [R,G,B]
|
||||
// }
|
||||
|
||||
_restApi->setPath(API_LIGHT_TURN_ON);
|
||||
QJsonArray rgbColor {ledValue.red, ledValue.green, ledValue.blue};
|
||||
serviceAttributes.insert(RGB_COLOR, rgbColor);
|
||||
|
||||
if (_isBrightnessOverwrite)
|
||||
{
|
||||
serviceAttributes.insert(BRIGHTNESS, _brightness);
|
||||
}
|
||||
if (_transitionTime > 0)
|
||||
{
|
||||
// Transition time in seconds
|
||||
serviceAttributes.insert(TRANSITION, _transitionTime);
|
||||
}
|
||||
}
|
||||
|
||||
httpResponse response = _restApi->post(serviceAttributes);
|
||||
if (response.error())
|
||||
{
|
||||
Warning(_log,"Updating lights failed with error: '%s'", QSTRING_CSTR(response.getErrorReason()) );
|
||||
retVal = -1;
|
||||
}
|
||||
|
||||
return retVal;
|
||||
}
|
||||
181
libsrc/leddevice/dev_net/LedDeviceHomeAssistant.h
Normal file
181
libsrc/leddevice/dev_net/LedDeviceHomeAssistant.h
Normal file
@@ -0,0 +1,181 @@
|
||||
#ifndef LEDEVICEHOMEASSISTANT_H
|
||||
#define LEDEVICEHOMEASSISTANT_H
|
||||
|
||||
// LedDevice includes
|
||||
#include <leddevice/LedDevice.h>
|
||||
#include "ProviderRestApi.h"
|
||||
|
||||
// Qt includes
|
||||
#include <QString>
|
||||
#include <QHostAddress>
|
||||
#include <QNetworkAccessManager>
|
||||
|
||||
///
|
||||
/// Implementation of the LedDevice interface for sending to
|
||||
/// lights made available via the Home Assistant platform.
|
||||
///
|
||||
class LedDeviceHomeAssistant : LedDevice
|
||||
{
|
||||
public:
|
||||
///
|
||||
/// @brief Constructs LED-device for Home Assistant Lights
|
||||
///
|
||||
/// following code shows all configuration options
|
||||
/// @code
|
||||
/// "device" :
|
||||
/// {
|
||||
/// "type" : "homeassistant"
|
||||
/// "host" : "hostname or IP",
|
||||
/// "port" : port
|
||||
/// "token": "bearer token",
|
||||
/// },
|
||||
///@endcode
|
||||
///
|
||||
/// @param deviceConfig Device's configuration as JSON-Object
|
||||
///
|
||||
explicit LedDeviceHomeAssistant(const QJsonObject& deviceConfig);
|
||||
|
||||
///
|
||||
/// @brief Destructor of the LED-device
|
||||
///
|
||||
~LedDeviceHomeAssistant() override;
|
||||
|
||||
///
|
||||
/// @brief Constructs the LED-device
|
||||
///
|
||||
/// @param[in] deviceConfig Device's configuration as JSON-Object
|
||||
/// @return LedDevice constructed
|
||||
static LedDevice* construct(const QJsonObject& deviceConfig);
|
||||
|
||||
///
|
||||
/// @brief Discover Home Assistant lights available (for configuration).
|
||||
///
|
||||
/// @param[in] params Parameters used to overwrite discovery default behaviour
|
||||
///
|
||||
/// @return A JSON structure holding a list of devices found
|
||||
///
|
||||
QJsonObject discover(const QJsonObject& params) override;
|
||||
|
||||
///
|
||||
/// @brief Get the Home Assistant light's resource properties
|
||||
///
|
||||
/// Following parameters are required
|
||||
/// @code
|
||||
/// {
|
||||
/// "host" : "hostname or IP",
|
||||
/// "port" : port
|
||||
/// "token" : "bearer token",
|
||||
/// "filter": "resource to query", root "/" is used, if empty
|
||||
/// }
|
||||
///@endcode
|
||||
///
|
||||
/// @param[in] params Parameters to query device
|
||||
/// @return A JSON structure holding the device's properties
|
||||
///
|
||||
QJsonObject getProperties(const QJsonObject& params) override;
|
||||
|
||||
///
|
||||
/// @brief Send an update to the Nanoleaf device to identify it.
|
||||
///
|
||||
/// Following parameters are required
|
||||
/// @code
|
||||
/// {
|
||||
/// "host" : "hostname or IP",
|
||||
/// "port" : port
|
||||
/// "token" : "bearer token",
|
||||
/// "entity_id": array of lightIds
|
||||
/// }
|
||||
///@endcode
|
||||
///
|
||||
/// @param[in] params Parameters to address device
|
||||
///
|
||||
void identify(const QJsonObject& params) override;
|
||||
|
||||
protected:
|
||||
|
||||
///
|
||||
/// @brief Initialise the Home Assistant light's configuration and network address details
|
||||
///
|
||||
/// @param[in] deviceConfig the JSON device configuration
|
||||
/// @return True, if success
|
||||
///
|
||||
bool init(const QJsonObject& deviceConfig) override;
|
||||
|
||||
///
|
||||
/// @brief Opens the output device.
|
||||
///
|
||||
/// @return Zero on success (i.e. device is ready), else negative
|
||||
///
|
||||
int open() override;
|
||||
|
||||
///
|
||||
/// @brief Writes the RGB-Color values to the Home Assistant light.
|
||||
///
|
||||
/// @param[in] ledValues The RGB-color
|
||||
/// @return Zero on success, else negative
|
||||
//////
|
||||
int write(const std::vector<ColorRgb>& ledValues) override;
|
||||
|
||||
///
|
||||
/// @brief Power-/turn on the Home Assistant light.
|
||||
///
|
||||
/// @brief Store the device's original state.
|
||||
///
|
||||
bool powerOn() override;
|
||||
|
||||
///
|
||||
/// @brief Power-/turn off the Home Assistant light.
|
||||
///
|
||||
/// @return True if success
|
||||
///
|
||||
bool powerOff() override;
|
||||
|
||||
private:
|
||||
|
||||
///
|
||||
/// @brief Initialise the access to the REST-API wrapper
|
||||
///
|
||||
/// @return True, if success
|
||||
///
|
||||
bool openRestAPI();
|
||||
|
||||
///
|
||||
/// @brief Get Nanoleaf device details and configuration
|
||||
///
|
||||
/// @return True, if Nanoleaf device capabilities fit configuration
|
||||
///
|
||||
bool initLedsConfiguration();
|
||||
|
||||
///
|
||||
/// @brief Discover Home Assistant lights available (for configuration).
|
||||
///
|
||||
/// @return A JSON structure holding a list of devices found
|
||||
///
|
||||
QJsonArray discoverSsdp() const;
|
||||
|
||||
// ///
|
||||
// /// @brief Get number of panels that can be used as LEds.
|
||||
// ///
|
||||
// /// @return Number of usable LED panels
|
||||
// ///
|
||||
// int getHwLedCount(const QJsonObject& jsonLayout) const;
|
||||
|
||||
QString _hostName;
|
||||
QHostAddress _address;
|
||||
ProviderRestApi* _restApi;
|
||||
int _apiPort;
|
||||
QString _bearerToken;
|
||||
|
||||
/// List of the HA light entity_ids.
|
||||
QStringList _lightEntityIds;
|
||||
|
||||
bool _isBrightnessOverwrite;
|
||||
bool _isFullBrightnessAtStart;
|
||||
int _brightness;
|
||||
bool _switchOffOnBlack;
|
||||
/// Transition time in seconds
|
||||
double _transitionTime;
|
||||
|
||||
};
|
||||
|
||||
#endif // LEDEVICEHOMEASSISTANT_H
|
||||
@@ -31,7 +31,7 @@ const char CONFIG_TRANSITIONTIME[] = "transitiontime";
|
||||
const char CONFIG_BLACK_LIGHTS_TIMEOUT[] = "blackLightsTimeout";
|
||||
const char CONFIG_ON_OFF_BLACK[] = "switchOffOnBlack";
|
||||
const char CONFIG_RESTORE_STATE[] = "restoreOriginalState";
|
||||
const char CONFIG_lightIdS[] = "lightIds";
|
||||
const char CONFIG_LIGHTIDS[] = "lightIds";
|
||||
const char CONFIG_USE_HUE_API_V2[] = "useAPIv2";
|
||||
const char CONFIG_USE_HUE_ENTERTAINMENT_API[] = "useEntertainmentAPI";
|
||||
const char CONFIG_groupId[] = "groupId";
|
||||
@@ -1849,7 +1849,7 @@ bool LedDevicePhilipsHue::setLights()
|
||||
_useEntertainmentAPI = false;
|
||||
Error(_log, "Group-ID [%s] is not usable - Entertainment API usage was disabled!", QSTRING_CSTR(_groupId) );
|
||||
}
|
||||
lights = _devConfig[ CONFIG_lightIdS ].toVariant().toStringList();
|
||||
lights = _devConfig[ CONFIG_LIGHTIDS ].toVariant().toStringList();
|
||||
}
|
||||
|
||||
_lightIds = lights;
|
||||
|
||||
@@ -23,7 +23,7 @@ namespace {
|
||||
const char CONFIG_RAZER_DEVICE_TYPE[] = "subType";
|
||||
const char CONFIG_SINGLE_COLOR[] = "singleColor";
|
||||
|
||||
// WLED JSON-API elements
|
||||
// API elements
|
||||
const char API_DEFAULT_HOST[] = "localhost";
|
||||
const int API_DEFAULT_PORT = 54235;
|
||||
|
||||
|
||||
135
libsrc/leddevice/schemas/schema-homeassistant.json
Normal file
135
libsrc/leddevice/schemas/schema-homeassistant.json
Normal file
@@ -0,0 +1,135 @@
|
||||
{
|
||||
"type": "object",
|
||||
"required": true,
|
||||
"properties": {
|
||||
"hostList": {
|
||||
"type": "string",
|
||||
"title": "edt_dev_spec_devices_discovered_title",
|
||||
"enum": [ "NONE" ],
|
||||
"options": {
|
||||
"enum_titles": [ "edt_dev_spec_devices_discovery_inprogress" ],
|
||||
"infoText": "edt_dev_spec_devices_discovered_title_info"
|
||||
},
|
||||
"required": true,
|
||||
"propertyOrder": 1
|
||||
},
|
||||
"host": {
|
||||
"type": "string",
|
||||
"format": "hostname_or_ip",
|
||||
"title": "edt_dev_spec_targetIpHost_title",
|
||||
"options": {
|
||||
"infoText": "edt_dev_spec_targetIpHost_title_info"
|
||||
},
|
||||
"required": true,
|
||||
"propertyOrder": 2
|
||||
},
|
||||
"port": {
|
||||
"type": "integer",
|
||||
"title": "edt_dev_spec_port_title",
|
||||
"default": 8123,
|
||||
"minimum": 0,
|
||||
"maximum": 65535,
|
||||
"access": "expert",
|
||||
"propertyOrder": 3
|
||||
},
|
||||
"token": {
|
||||
"type": "string",
|
||||
"title": "edt_dev_auth_key_title",
|
||||
"options": {
|
||||
"infoText": "edt_dev_auth_key_title_info"
|
||||
},
|
||||
"propertyOrder": 4
|
||||
},
|
||||
"restoreOriginalState": {
|
||||
"type": "boolean",
|
||||
"format": "checkbox",
|
||||
"title": "edt_dev_spec_restoreOriginalState_title",
|
||||
"default": true,
|
||||
"required": true,
|
||||
"options": {
|
||||
"hidden": true,
|
||||
"infoText": "edt_dev_spec_restoreOriginalState_title_info"
|
||||
},
|
||||
"propertyOrder": 5
|
||||
},
|
||||
"overwriteBrightness": {
|
||||
"type": "boolean",
|
||||
"format": "checkbox",
|
||||
"title": "edt_dev_spec_brightnessOverwrite_title",
|
||||
"default": true,
|
||||
"required": true,
|
||||
"access": "advanced",
|
||||
"propertyOrder": 5
|
||||
},
|
||||
"brightness": {
|
||||
"type": "integer",
|
||||
"title": "edt_dev_spec_brightness_title",
|
||||
"default": 255,
|
||||
"minimum": 1,
|
||||
"maximum": 255,
|
||||
"options": {
|
||||
"dependencies": {
|
||||
"overwriteBrightness": true
|
||||
}
|
||||
},
|
||||
"access": "advanced",
|
||||
"propertyOrder": 6
|
||||
},
|
||||
"fullBrightnessAtStart": {
|
||||
"type": "boolean",
|
||||
"format": "checkbox",
|
||||
"title": "edt_dev_spec_fullBrightnessAtStart_title",
|
||||
"default": true,
|
||||
"required": true,
|
||||
"access": "advanced",
|
||||
"propertyOrder": 7
|
||||
},
|
||||
"switchOffOnBlack": {
|
||||
"type": "boolean",
|
||||
"format": "checkbox",
|
||||
"title": "edt_dev_spec_switchOffOnBlack_title",
|
||||
"default": false,
|
||||
"access": "advanced",
|
||||
"propertyOrder": 8
|
||||
},
|
||||
"transitionTime": {
|
||||
"type": "integer",
|
||||
"title": "edt_dev_spec_transistionTime_title",
|
||||
"default": 0,
|
||||
"append": "ms",
|
||||
"minimum": 0,
|
||||
"maximum": 2000,
|
||||
"required": false,
|
||||
"access": "advanced",
|
||||
"propertyOrder": 9
|
||||
},
|
||||
"entityIds": {
|
||||
"title": "edt_dev_spec_lightid_title",
|
||||
"type": "array",
|
||||
"required": true,
|
||||
"format": "select",
|
||||
"options": {
|
||||
"hidden": true
|
||||
},
|
||||
"items": {
|
||||
"type": "string",
|
||||
"title": "edt_dev_spec_lights_itemtitle"
|
||||
},
|
||||
"propertyOrder": 10
|
||||
},
|
||||
"latchTime": {
|
||||
"type": "integer",
|
||||
"title": "edt_dev_spec_latchtime_title",
|
||||
"default": 250,
|
||||
"append": "edt_append_ms",
|
||||
"minimum": 100,
|
||||
"maximum": 2000,
|
||||
"access": "expert",
|
||||
"options": {
|
||||
"infoText": "edt_dev_spec_latchtime_title_info"
|
||||
},
|
||||
"propertyOrder": 11
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
Reference in New Issue
Block a user