HA - Support switch off on black

Lord-Grey · Aug 23, 2024 · 2b600e1 · 2b600e1
1 parent efaa0ce
commit 2b600e1
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 16 deletions.
diff --git a/libsrc/leddevice/dev_net/LedDeviceHomeAssistant.cpp b/libsrc/leddevice/dev_net/LedDeviceHomeAssistant.cpp
@@ -8,6 +8,7 @@
 #include <mdns/MdnsServiceRegister.h>
 #endif
 #include <utils/NetUtils.h>
+#include <utils/ColorRgb.h>
 
 #include <algorithm>
 
@@ -23,10 +24,12 @@ 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 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;
@@ -94,13 +97,15 @@ bool LedDeviceHomeAssistant::init(const QJsonObject& deviceConfig)
 		_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);
 
 		Debug(_log, "Hostname/IP       : %s", QSTRING_CSTR(_hostName));
 		Debug(_log, "Port              : %d", _apiPort );
 
-		Debug(_log, "Overwrite Brightn.: %d", _isBrightnessOverwrite);
+		Debug(_log, "Overwrite Brightn.: %s", _isBrightnessOverwrite ? "Yes" : "No" );
 		Debug(_log, "Set Brightness to : %d", _brightness);
-		Debug(_log, "Full Bri. at start: %d", _isFullBrightnessAtStart);
+		Debug(_log, "Full Bri. at start: %s", _isFullBrightnessAtStart  ? "Yes" : "No" );
+		Debug(_log, "Off on Black      : %s", _switchOffOnBlack ? "Yes" : "No" );
 
 		_lightEntityIds = _devConfig[ CONFIG_ENITYIDS ].toVariant().toStringList();
 		int configuredLightsCount = _lightEntityIds.size();
@@ -395,22 +400,29 @@ int LedDeviceHomeAssistant::write(const std::vector<ColorRgb>& ledValues)
 {
 	int retVal = 0;
 
-	//    http://hostname:port/api/services/light/turn_on
-	//    {
-	//      "entity_id": [ entity-IDs ],
-	//      "rgb_color": [R,G,B]
-	//    }
-
-	_restApi->setPath(API_LIGHT_TURN_ON);
 	QJsonObject serviceAttributes {{ENTITY_ID, QJsonArray::fromStringList(_lightEntityIds)}};
-
 	ColorRgb ledValue = ledValues.at(0);
-	QJsonArray rgbColor {ledValue.red, ledValue.green, ledValue.blue};
-	serviceAttributes.insert(RGB_COLOR, rgbColor);
 
-	if (_isBrightnessOverwrite)
+	if (_switchOffOnBlack && ledValue == ColorRgb::BLACK)
+	{
+		_restApi->setPath(API_LIGHT_TURN_OFF);
+	}
+	else
 	{
-		serviceAttributes.insert(BRIGHTNESS, _brightness);
+		//    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);
+		}
 	}
 
 	httpResponse response = _restApi->post(serviceAttributes);

diff --git a/libsrc/leddevice/dev_net/LedDeviceHomeAssistant.h b/libsrc/leddevice/dev_net/LedDeviceHomeAssistant.h
@@ -172,6 +172,8 @@ class LedDeviceHomeAssistant : LedDevice
 	bool _isBrightnessOverwrite;
 	bool _isFullBrightnessAtStart;
 	int _brightness;
+	bool _switchOffOnBlack;
+
 };
 
 #endif // LEDEVICEHOMEASSISTANT_H
diff --git a/libsrc/leddevice/schemas/schema-homeassistant.json b/libsrc/leddevice/schemas/schema-homeassistant.json
@@ -84,6 +84,14 @@
       "access": "advanced",
       "propertyOrder": 7
     },
+    "switchOffOnBlack": {
+      "type": "boolean",
+      "format": "checkbox",
+      "title": "edt_dev_spec_switchOffOnBlack_title",
+      "default": false,
+      "access": "advanced",
+      "propertyOrder": 8
+    },
     "entityIds": {
       "title": "edt_dev_spec_lightid_title",
       "type": "array",
@@ -96,7 +104,7 @@
         "type": "string",
         "title": "edt_dev_spec_lights_itemtitle"
       },
-      "propertyOrder": 8
+      "propertyOrder": 9
     },
     "latchTime": {
       "type": "integer",
@@ -109,7 +117,7 @@
       "options": {
         "infoText": "edt_dev_spec_latchtime_title_info"
       },
-      "propertyOrder": 9
+      "propertyOrder": 10
     }
   },
   "additionalProperties": true