frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2025-03-01 10:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Handle Brightness & Black

Browse Source
This commit is contained in:
Lord-Grey 2024-12-27 12:28:25 +01:00
parent 3e7bc78449
commit 8710b049d9
3 changed files with 81 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
libsrc/leddevice/dev_net/LedDeviceHomeAssistant.cpp
View File

@ -14,41 +14,39 @@
// Constants // Constants
namespace { namespace {
const bool verbose = false; const bool verbose = false;
// Configuration settings // Configuration settings
const char CONFIG_HOST[] = "host"; const char CONFIG_HOST[] = "host";
const char CONFIG_PORT[] = "port"; const char CONFIG_PORT[] = "port";
const char CONFIG_AUTH_TOKEN[] = "token"; const char CONFIG_AUTH_TOKEN[] = "token";
const char CONFIG_ENITYIDS[] = "entityIds"; const char CONFIG_ENITYIDS[] = "entityIds";
const char CONFIG_BRIGHTNESS[] = "brightness"; const char CONFIG_BRIGHTNESS[] = "brightness";
const char CONFIG_BRIGHTNESS_OVERWRITE[] = "overwriteBrightness"; const char CONFIG_BRIGHTNESS_OVERWRITE[] = "overwriteBrightness";
const char CONFIG_FULL_BRIGHTNESS_AT_START[] = "fullBrightnessAtStart"; const char CONFIG_FULL_BRIGHTNESS_AT_START[] = "fullBrightnessAtStart";
const char CONFIG_ON_OFF_BLACK[] = "switchOffOnBlack"; const char CONFIG_TRANSITIONTIME[] = "transitionTime";
const char CONFIG_TRANSITIONTIME[] = "transitionTime";
const bool DEFAULT_IS_BRIGHTNESS_OVERWRITE = true; const bool DEFAULT_IS_BRIGHTNESS_OVERWRITE = true;
const bool DEFAULT_IS_FULL_BRIGHTNESS_AT_START = true; const bool DEFAULT_IS_FULL_BRIGHTNESS_AT_START = true;
const int BRI_MAX = 255; const int BRI_MAX = 255;
const bool DEFAULT_IS_SWITCH_OFF_ON_BLACK = false;
// Home Assistant API // Home Assistant API
const int API_DEFAULT_PORT = 8123; const int API_DEFAULT_PORT = 8123;
const char API_BASE_PATH[] = "/api/"; const char API_BASE_PATH[] = "/api/";
const char API_STATES[] = "states"; const char API_STATES[] = "states";
const char API_LIGHT_TURN_ON[] = "services/light/turn_on"; const char API_LIGHT_TURN_ON[] = "services/light/turn_on";
const char API_LIGHT_TURN_OFF[] = "services/light/turn_off"; const char API_LIGHT_TURN_OFF[] = "services/light/turn_off";
const char ENTITY_ID[] = "entity_id"; const char ENTITY_ID[] = "entity_id";
const char RGB_COLOR[] = "rgb_color"; const char RGB_COLOR[] = "rgb_color";
const char BRIGHTNESS[] = "brightness"; const char BRIGHTNESS[] = "brightness";
const char TRANSITION[] = "transition"; const char TRANSITION[] = "transition";
const char FLASH[] = "flash"; const char FLASH[] = "flash";
// // Home Assistant ssdp services // // Home Assistant ssdp services
const char SSDP_ID[] = "ssdp:all"; const char SSDP_ID[] = "ssdp:all";
const char SSDP_FILTER_HEADER[] = "ST"; const char SSDP_FILTER_HEADER[] = "ST";
const char SSDP_FILTER[] = "(.*)home-assistant.io(.*)"; const char SSDP_FILTER[] = "(.*)home-assistant.io(.*)";
} //End of constants } //End of constants
@ -58,11 +56,12 @@ LedDeviceHomeAssistant::LedDeviceHomeAssistant(const QJsonObject& deviceConfig)
, _apiPort(API_DEFAULT_PORT) , _apiPort(API_DEFAULT_PORT)
, _isBrightnessOverwrite(DEFAULT_IS_BRIGHTNESS_OVERWRITE) , _isBrightnessOverwrite(DEFAULT_IS_BRIGHTNESS_OVERWRITE)
, _isFullBrightnessAtStart(DEFAULT_IS_FULL_BRIGHTNESS_AT_START) , _isFullBrightnessAtStart(DEFAULT_IS_FULL_BRIGHTNESS_AT_START)
, _brightness (BRI_MAX) , _brightness(BRI_MAX)
, _transitionTime(0)
{ {
#ifdef ENABLE_MDNS #ifdef ENABLE_MDNS
QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType", QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType",
Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType(_activeDeviceType))); Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType(_activeDeviceType)));
#endif #endif
} }
@ -81,7 +80,7 @@ bool LedDeviceHomeAssistant::init(const QJsonObject& deviceConfig)
{ {
bool isInitOK{ false }; bool isInitOK{ false };
if ( LedDevice::init(deviceConfig) ) if (LedDevice::init(deviceConfig))
{ {
// Overwrite non supported/required features // Overwrite non supported/required features
if (deviceConfig["rewriteTime"].toInt(0) > 0) if (deviceConfig["rewriteTime"].toInt(0) > 0)
@ -99,30 +98,28 @@ bool LedDeviceHomeAssistant::init(const QJsonObject& deviceConfig)
_isBrightnessOverwrite = _devConfig[CONFIG_BRIGHTNESS_OVERWRITE].toBool(DEFAULT_IS_BRIGHTNESS_OVERWRITE); _isBrightnessOverwrite = _devConfig[CONFIG_BRIGHTNESS_OVERWRITE].toBool(DEFAULT_IS_BRIGHTNESS_OVERWRITE);
_isFullBrightnessAtStart = _devConfig[CONFIG_FULL_BRIGHTNESS_AT_START].toBool(DEFAULT_IS_FULL_BRIGHTNESS_AT_START); _isFullBrightnessAtStart = _devConfig[CONFIG_FULL_BRIGHTNESS_AT_START].toBool(DEFAULT_IS_FULL_BRIGHTNESS_AT_START);
_brightness = _devConfig[CONFIG_BRIGHTNESS].toInt(BRI_MAX); _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); int transitionTimeMs = _devConfig[CONFIG_TRANSITIONTIME].toInt(0);
_transitionTime = transitionTimeMs / 1000.0; _transitionTime = transitionTimeMs / 1000.0;
Debug(_log, "Hostname/IP : %s", QSTRING_CSTR(_hostName)); Debug(_log, "Hostname/IP : %s", QSTRING_CSTR(_hostName));
Debug(_log, "Port : %d", _apiPort ); Debug(_log, "Port : %d", _apiPort);
Debug(_log, "Overwrite Brightn.: %s", _isBrightnessOverwrite ? "Yes" : "No" ); Debug(_log, "Overwrite Brightn.: %s", _isBrightnessOverwrite ? "Yes" : "No");
Debug(_log, "Set Brightness to : %d", _brightness); Debug(_log, "Set Brightness to : %d", _brightness);
Debug(_log, "Full Bri. at start: %s", _isFullBrightnessAtStart ? "Yes" : "No" ); 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);
Debug(_log, "Transition Time : %d ms", transitionTimeMs );
_lightEntityIds = _devConfig[ CONFIG_ENITYIDS ].toVariant().toStringList(); _lightEntityIds = _devConfig[CONFIG_ENITYIDS].toVariant().toStringList();
int configuredLightsCount = _lightEntityIds.size(); int configuredLightsCount = _lightEntityIds.size();
if ( configuredLightsCount == 0 ) if (configuredLightsCount == 0)
{ {
this->setInError( "No light entity-ids configured" ); this->setInError("No light entity-ids configured");
isInitOK = false; isInitOK = false;
} }
else else
{ {
Debug(_log, "Lights configured : %d", configuredLightsCount ); Debug(_log, "Lights configured : %d", configuredLightsCount);
isInitOK = true; isInitOK = true;
} }
} }
@ -138,11 +135,11 @@ bool LedDeviceHomeAssistant::initLedsConfiguration()
QString lightEntityId = _lightEntityIds[0]; QString lightEntityId = _lightEntityIds[0];
//Get properties for configured light entitiy to check availability //Get properties for configured light entitiy to check availability
_restApi->setPath({ API_STATES, lightEntityId}); _restApi->setPath({ API_STATES, lightEntityId });
httpResponse response = _restApi->get(); httpResponse response = _restApi->get();
if (response.error()) if (response.error())
{ {
QString errorReason = QString("%1 get properties failed with error: '%2'").arg(_activeDeviceType,response.getErrorReason()); QString errorReason = QString("%1 get properties failed with error: '%2'").arg(_activeDeviceType, response.getErrorReason());
this->setInError(errorReason); this->setInError(errorReason);
} }
else else
@ -239,10 +236,10 @@ QJsonObject LedDeviceHomeAssistant::discover(const QJsonObject& /*params*/)
#ifdef ENABLE_MDNS #ifdef ENABLE_MDNS
QString discoveryMethod("mDNS"); QString discoveryMethod("mDNS");
deviceList = MdnsBrowser::getInstance().data()->getServicesDiscoveredJson( deviceList = MdnsBrowser::getInstance().data()->getServicesDiscoveredJson(
MdnsServiceRegister::getServiceType(_activeDeviceType), MdnsServiceRegister::getServiceType(_activeDeviceType),
MdnsServiceRegister::getServiceNameFilter(_activeDeviceType), MdnsServiceRegister::getServiceNameFilter(_activeDeviceType),
DEFAULT_DISCOVER_TIMEOUT DEFAULT_DISCOVER_TIMEOUT
); );
#else #else
QString discoveryMethod("ssdp"); QString discoveryMethod("ssdp");
deviceList = discoverSsdp(); deviceList = discoverSsdp();
@ -288,7 +285,7 @@ QJsonObject LedDeviceHomeAssistant::getProperties(const QJsonObject& params)
QVector<QJsonValue> filteredVector; QVector<QJsonValue> filteredVector;
// Iterate over the array and filter objects with entity_id starting with "light." // Iterate over the array and filter objects with entity_id starting with "light."
for (const QJsonValue &value : jsonArray) for (const QJsonValue& value : jsonArray)
{ {
QJsonObject obj = value.toObject(); QJsonObject obj = value.toObject();
QString entityId = obj[ENTITY_ID].toString(); QString entityId = obj[ENTITY_ID].toString();
@ -300,14 +297,14 @@ QJsonObject LedDeviceHomeAssistant::getProperties(const QJsonObject& params)
} }
// Sort the filtered vector by "friendly_name" in ascending order // Sort the filtered vector by "friendly_name" in ascending order
std::sort(filteredVector.begin(), filteredVector.end(), [](const QJsonValue &a, const QJsonValue &b) { std::sort(filteredVector.begin(), filteredVector.end(), [](const QJsonValue& a, const QJsonValue& b) {
QString nameA = a.toObject()["attributes"].toObject()["friendly_name"].toString(); QString nameA = a.toObject()["attributes"].toObject()["friendly_name"].toString();
QString nameB = b.toObject()["attributes"].toObject()["friendly_name"].toString(); QString nameB = b.toObject()["attributes"].toObject()["friendly_name"].toString();
return nameA < nameB; // Ascending order return nameA < nameB; // Ascending order
}); });
// Convert the sorted vector back to a QJsonArray // Convert the sorted vector back to a QJsonArray
QJsonArray sortedArray; QJsonArray sortedArray;
for (const QJsonValue &value : filteredVector) { for (const QJsonValue& value : filteredVector) {
sortedArray.append(value); sortedArray.append(value);
} }
@ -341,10 +338,10 @@ void LedDeviceHomeAssistant::identify(const QJsonObject& params)
{ {
if (openRestAPI()) if (openRestAPI())
{ {
QJsonArray lightEntityIds = params[ ENTITY_ID ].toArray(); QJsonArray lightEntityIds = params[ENTITY_ID].toArray();
_restApi->setPath(API_LIGHT_TURN_ON); _restApi->setPath(API_LIGHT_TURN_ON);
QJsonObject serviceAttributes{{ENTITY_ID, lightEntityIds}}; QJsonObject serviceAttributes{ {ENTITY_ID, lightEntityIds} };
serviceAttributes.insert(FLASH, "short"); serviceAttributes.insert(FLASH, "short");
httpResponse response = _restApi->post(serviceAttributes); httpResponse response = _restApi->post(serviceAttributes);
@ -362,7 +359,7 @@ bool LedDeviceHomeAssistant::powerOn()
if (_isDeviceReady) if (_isDeviceReady)
{ {
_restApi->setPath(API_LIGHT_TURN_ON); _restApi->setPath(API_LIGHT_TURN_ON);
QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}}; QJsonObject serviceAttributes{ {ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)} };
if (_isFullBrightnessAtStart) if (_isFullBrightnessAtStart)
{ {
@ -389,7 +386,7 @@ bool LedDeviceHomeAssistant::powerOff()
if (_isDeviceReady) if (_isDeviceReady)
{ {
_restApi->setPath(API_LIGHT_TURN_OFF); _restApi->setPath(API_LIGHT_TURN_OFF);
QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}}; QJsonObject serviceAttributes{ {ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)} };
httpResponse response = _restApi->post(serviceAttributes); httpResponse response = _restApi->post(serviceAttributes);
if (response.error()) if (response.error())
{ {
@ -405,40 +402,41 @@ int LedDeviceHomeAssistant::write(const std::vector<ColorRgb>& ledValues)
{ {
int retVal = 0; int retVal = 0;
QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}}; QJsonObject serviceAttributes{ {ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)} };
ColorRgb ledValue = ledValues.at(0); ColorRgb ledValue = ledValues.at(0);
if (_switchOffOnBlack && ledValue == ColorRgb::BLACK) // http://hostname:port/api/services/light/turn_on
// {
// "entity_id": [ entity-IDs ],
// "rgb_color": [R,G,B]
// }
_restApi->setPath(API_LIGHT_TURN_ON);
serviceAttributes.insert(RGB_COLOR, QJsonArray{ ledValue.red, ledValue.green, ledValue.blue });
int brightness = _brightness;
// Some devices cannot deal with a black color and brightness > 0
if (ledValue == ColorRgb::BLACK)
{ {
_restApi->setPath(API_LIGHT_TURN_OFF); brightness = 0;
} }
else
// Add brightness attribute if applicable
if (brightness == 0 || _isBrightnessOverwrite)
{ {
// http://hostname:port/api/services/light/turn_on serviceAttributes.insert(BRIGHTNESS, brightness);
// { }
// "entity_id": [ entity-IDs ],
// "rgb_color": [R,G,B]
// }
_restApi->setPath(API_LIGHT_TURN_ON); if (_transitionTime > 0)
QJsonArray rgbColor {ledValue.red, ledValue.green, ledValue.blue}; {
serviceAttributes.insert(RGB_COLOR, rgbColor); serviceAttributes.insert(TRANSITION, _transitionTime);
if (_isBrightnessOverwrite)
{
serviceAttributes.insert(BRIGHTNESS, _brightness);
}
if (_transitionTime > 0)
{
// Transition time in seconds
serviceAttributes.insert(TRANSITION, _transitionTime);
}
} }
httpResponse response = _restApi->post(serviceAttributes); httpResponse response = _restApi->post(serviceAttributes);
if (response.error()) if (response.error())
{ {
Warning(_log,"Updating lights failed with error: '%s'", QSTRING_CSTR(response.getErrorReason()) ); Warning(_log, "Updating lights failed with error: '%s'", QSTRING_CSTR(response.getErrorReason()));
retVal = -1; retVal = -1;
} }

1
libsrc/leddevice/dev_net/LedDeviceHomeAssistant.h
View File

@ -172,7 +172,6 @@ private:
bool _isBrightnessOverwrite; bool _isBrightnessOverwrite;
bool _isFullBrightnessAtStart; bool _isFullBrightnessAtStart;
int _brightness; int _brightness;
bool _switchOffOnBlack;
/// Transition time in seconds /// Transition time in seconds
double _transitionTime; double _transitionTime;

26
libsrc/leddevice/schemas/schema-homeassistant.json
View File

@ -40,18 +40,6 @@
}, },
"propertyOrder": 4 "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": { "overwriteBrightness": {
"type": "boolean", "type": "boolean",
"format": "checkbox", "format": "checkbox",
@ -84,14 +72,6 @@
"access": "advanced", "access": "advanced",
"propertyOrder": 7 "propertyOrder": 7
}, },
"switchOffOnBlack": {
"type": "boolean",
"format": "checkbox",
"title": "edt_dev_spec_switchOffOnBlack_title",
"default": false,
"access": "advanced",
"propertyOrder": 8
},
"transitionTime": { "transitionTime": {
"type": "integer", "type": "integer",
"title": "edt_dev_spec_transistionTime_title", "title": "edt_dev_spec_transistionTime_title",
@ -101,7 +81,7 @@
"maximum": 2000, "maximum": 2000,
"required": false, "required": false,
"access": "advanced", "access": "advanced",
"propertyOrder": 9 "propertyOrder": 8
}, },
"entityIds": { "entityIds": {
"title": "edt_dev_spec_lightid_title", "title": "edt_dev_spec_lightid_title",
@ -115,7 +95,7 @@
"type": "string", "type": "string",
"title": "edt_dev_spec_lights_itemtitle" "title": "edt_dev_spec_lights_itemtitle"
}, },
"propertyOrder": 10 "propertyOrder": 9
}, },
"latchTime": { "latchTime": {
"type": "integer", "type": "integer",
@ -128,7 +108,7 @@
"options": { "options": {
"infoText": "edt_dev_spec_latchtime_title_info" "infoText": "edt_dev_spec_latchtime_title_info"
}, },
"propertyOrder": 11 "propertyOrder": 10
} }
}, },
"additionalProperties": true "additionalProperties": true