feat: Custom presets

Author: Hypfer

custom_components/scene_presets/file_utils.py

@@ -1,17 +1,36 @@
 import json
 import os
+import logging
 
-BASE_PATH = os.path.dirname(os.path.realpath(__file__))
+_LOGGER = logging.getLogger(__name__)
 
+BASE_PATH = os.path.dirname(os.path.realpath(__file__))
 MANIFEST = json.load(
     open(os.path.join(BASE_PATH, 'manifest.json'))
 )
 VERSION = MANIFEST['version']
 
+
+
+os.makedirs(os.path.join(BASE_PATH, 'userdata/custom/assets'), exist_ok=True)
+
 PRESET_DATA = json.load(
     open(os.path.join(BASE_PATH, 'presets.json'))
 )
 
+custom_presets_path = os.path.join(BASE_PATH, 'userdata/custom/presets.json')
+CUSTOM_PRESETS = None
+if os.path.exists(custom_presets_path):
+    try:
+        with open(custom_presets_path, 'r') as file:
+            CUSTOM_PRESETS = json.load(file)
 
+        print("Custom presets loaded successfully.")
+    except json.JSONDecodeError as e:
+        _LOGGER.error(f"Error loading custom presets: {e}")
+else:
+    _LOGGER.info(f"No custom presets file found at {custom_presets_path}")
 
-
+if CUSTOM_PRESETS is not None:
+    PRESET_DATA.get("presets", []).extend([{**d, 'custom': True} for d in CUSTOM_PRESETS.get("presets", [])])
+    PRESET_DATA.get("categories", []).extend([{**d, 'custom': True} for d in CUSTOM_PRESETS.get("categories", [])])

custom_components/scene_presets/frontend/scene_presets_panel.js

@@ -5,11 +5,11 @@
         "@hypfer"
     ],
     "config_flow": true,
-    "dependencies": [],
+    "after_dependencies": ["http"],
     "documentation": "https://github.com/Hypfer/hass-scene_presets",
     "integration_type": "service",
     "iot_class": "calculated",
     "issue_tracker": "https://github.com/Hypfer/hass-scene_presets/issues",
     "requirements": [],
-    "version": "1.0.0"
+    "version": "1.1.0"
 }

custom_components/scene_presets/manifest.json

@@ -58,7 +58,7 @@
     },
     {
       "id": "6e102277-814f-47c7-a054-f4a31cae30bf",
-      "name": "Custom palettes"
+      "name": "Misc Additions"
     }
   ],
   "presets": [

custom_components/scene_presets/presets.json

@@ -1,17 +1,24 @@
 from .const import NAME, DOMAIN, PANEL_URL
 from .file_utils import VERSION, PRESET_DATA, BASE_PATH
+from homeassistant.components.http import HomeAssistantView
 
+class ScenePresetDataView(HomeAssistantView):
+    url = f'/assets/{DOMAIN}/scene_presets.json'
+    name = f'assets:{DOMAIN}:preset_data'
+    requires_auth = False
+
+    async def get(self, request):
+        return self.json(
+            result=PRESET_DATA,
+        )
 
 async def async_setup_view(hass):
     hass.http.register_static_path(
         PANEL_URL,
         hass.config.path(f'{BASE_PATH}/frontend/scene_presets_panel.js'),
     )
-    
-    hass.http.register_static_path(
-        f'/assets/{DOMAIN}/scene_presets.json',
-        hass.config.path(f"{BASE_PATH}/presets.json"),
-    )
+
+    hass.http.register_view(ScenePresetDataView)
 
     await bind_preset_images(hass)
 
@@ -34,9 +41,14 @@ async def async_setup_view(hass):
 async def bind_preset_images(hass):
     for preset in PRESET_DATA.get("presets", []):
         img_filename = preset.get("img")
+        is_custom = preset.get("custom")
 
         if img_filename is not None:
+            path = f"{BASE_PATH}/assets/{img_filename}"
+            if is_custom is not None and is_custom:
+                path = f"{BASE_PATH}/userdata/custom/assets/{img_filename}"
+
             hass.http.register_static_path(
                 f'/assets/{DOMAIN}/{img_filename}',
-                hass.config.path(f"{BASE_PATH}/assets/{img_filename}"),
+                hass.config.path(path),
             )

custom_components/scene_presets/view.py

@@ -0,0 +1,120 @@
+# Custom presets
+
+Starting with v1.1.0, this integration also allows you to have your own custom presets.
+
+Be advised though that this feature will not hold your hand. It is intended to be used by developers.
+
+## How
+
+On startup, the custom_component will create folder named `userdata/custom` inside `custom_components/scene_presets`
+of your home assistant instance. By default, this folder will be empty apart from another folder named `assets`.
+
+To add custom presets, you create a `presets.json` in that folder and add your custom images to that `assets` folder.
+This essentially mirrors the structure of the included scenes. The JSON Schema is the same.
+Everything in the custom presets will simply be added at the end of the lists of categories and presets.
+
+Please note that there is no validation in place that would prevent you from creating ID conflicts nor is there any
+validation ensuring that the schema of the custom data is correct. Just don't provide any incorrect data.
+
+If I understood the HACS documentation correctly, this folder should survive component updates.<br/>
+For now though, I'd recommend making backups just to be sure.
+
+## Example
+
+The best way to explain this feature is to give an example.
+
+First the directory structure:
+
+```
+user@foo:/homeassistant/custom_components/scene_presets# tree userdata/
+userdata/
+└── custom
+    ├── assets
+    │ └── 1d2ef59e-8f29-4d58-a437-c0b03d90ce8a.jpeg
+    └── presets.json
+
+3 directories, 2 files
+```
+
+And here's the content of the `presets.json`:
+
+```
+{
+  "categories": [
+    {
+      "name": "Color Temperatures",
+      "id": "e0c17262-f84b-4943-bdd5-fcd24c574f24"
+    }
+  ],
+  "presets": [
+    {
+      "id": "1d2ef59e-8f29-4d58-a437-c0b03d90ce8a",
+      "categoryId": "e0c17262-f84b-4943-bdd5-fcd24c574f24",
+      "name": "1800 Kelvin",
+      "bri": 76,
+      "lights": [
+        {
+          "x": 0.6264,
+          "y": 0.3632
+        }
+      ]
+    }
+  ]
+}
+```
+
+In there you can see a few things:
+
+- We've added a new category named "Color Temperatures"
+- We've added a single preset with the "Color Temperatures" categoryId 
+
+  => every preset needs to be part of a category <br/>
+  => custom presets can be part of stock categories <br/>
+- The new "1800 Kelvin" preset has a single light
+
+  => There is no limit to how many lights a preset can have <br/>
+  => If you apply a preset to a group with more lights, some options will be repeated <br/>
+  => Colors have to be specified as X/Y
+
+After adding that example JSON and restarting Home Assistant, it looks like this:
+
+![ex1.png](img/ex1.png)
+
+And as you can see, we forgot to install Counter-Strike: Source.
+
+To fix that, we need to change the preset to include an `img` key like this:
+
+```
+    {
+      "id": "1d2ef59e-8f29-4d58-a437-c0b03d90ce8a",
+      "categoryId": "e0c17262-f84b-4943-bdd5-fcd24c574f24",
+      "name": "1800 Kelvin",
+      "img": "1d2ef59e-8f29-4d58-a437-c0b03d90ce8a.jpeg"
+      "bri": 76,
+      "lights": [
+        {
+          "x": 0.6264,
+          "y": 0.3632
+        }
+      ]
+    }
+```
+
+This will now point to `userdata/custom/assets/1d2ef59e-8f29-4d58-a437-c0b03d90ce8a.jpeg`.<br/>
+Make sure to place the desired image there.
+
+And that's it. When in doubt, take a look at the `presets.json` and `assets` included with the component.<br/>
+As said, they are the same format and structure.
+
+## Misc
+
+To convert RGB colors to X/Y, you can use this js snippet using the `cie-rgb-color-converter` npm library:
+```
+const colorConverter = require("cie-rgb-color-converter");
+
+const xyValue = colorConverter.rgbToXy(255, 126, 0);
+xyValue.x = parseFloat(xyValue.x.toFixed(4));
+xyValue.y = parseFloat(xyValue.y.toFixed(4));
+
+console.log(JSON.stringify(xyValue, null, 2))
+```

docs/Custom Presets.md

@@ -0,0 +1,40 @@
+# What is Smart Shuffle?
+
+With hue (and probably other vendors as well), when you apply a random color with a transition (especially long ones), it can happen that the light turns to white and brightly illuminates the otherwise rather dark and moody room.
+
+This happens, because the transition feature basically just moves from one coordinate in the CIE1931 color space to another. So if you for example do a transition from turquoise to red, that transition would move right through the area where white is and thus unexpectedly illuminate the whole room.
+
+![space1.jpeg](img/space1.jpeg)
+
+Smart shuffle solves that issue by taking the current color of each light and then filtering the set of colors in the preset to only leave those that would result in a transition that doesn't move through white.
+
+It works by:
+1. taking the coordinates of a point in the middle of the white area
+2. drawing a line from the current color coordinates
+3. drawing a line from the possible next color coordinates
+4. looking at the angle between those two lines
+   a. If the angle is > 150°, the transition will be considered as moving through white
+   b. If the angle is < 2°, the possible next color will be considered the same color
+5. If any of those two criteria matches, the color will not be selected as the next random color for that light.
+6. In the end, it selects a random option out of that filtered set
+7. If the filtered set is empty, it just picks a random color from the whole preset
+
+![space2.jpeg](img/space2.jpeg)
+
+The exact angles (150, 2) are subject to change. I just picked them mostly at random.
+
+Anyway, while this does work great with the right set of colors, you can create a set where you accidentally partition your lights, causing them to just cycle through the same subset of colors of the whole preset all the time.
+
+I've noticed that happening with the CGA preset I've added recently.
+Because of that, it's now a toggle that can be disabled if the algorithm doesn't work well with the preset.
+
+While adding that, I've also made the regular shuffle a bit better for this feature then before. Instead of just pulling n colors (with n being the count of lights) out of the set of the preset colors at random (and thus giving no guarantees that they will be evenly distributed on a single apply) the code now
+1. Takes the set of all colors in the preset
+2. Creates enough shuffled duplicates of that set so that the length of those combined is longer than n
+3. Picks the color for each light based on its index in that new set
+
+This ensures that if you have 6 lights and apply a preset with 5 colors, you will get all 5 colors on 5 lamps + 1 repeated one for the 6th lamp.
+Previously, you could by random chance get 6 lights in the same color.
+Unlikely but possible.
+
+At least that's how it works at the time of writing (2023-12-09). It might change in the future if I come up with different ideas or notice other issues