Slugify entity ID's (fixes #112)

Author: Breina

custom_components/dmx/entity/light/light_entity.py

@@ -6,6 +6,7 @@
 from homeassistant.core import callback
 from homeassistant.helpers.entity import DeviceInfo
 from homeassistant.helpers.restore_state import RestoreEntity
+from homeassistant.util import slugify
 
 from custom_components.dmx.const import DOMAIN
 from custom_components.dmx.entity.light import ChannelMapping, ChannelType
@@ -35,7 +36,9 @@ def __init__(
         self._matrix_key = matrix_key
         self._attr_name = f"{fixture_name} Light {matrix_key}" if matrix_key else f"{fixture_name} Light"
         if entity_id_prefix:
-            base_id = entity_id_prefix if not matrix_key else f"{entity_id_prefix}_{matrix_key}"
+            slug_prefix = slugify(entity_id_prefix)
+            slug_matrix = slugify(matrix_key) if matrix_key else None
+            base_id = slug_prefix if not slug_matrix else f"{slug_prefix}_{slug_matrix}"
             self._attr_unique_id = f"{base_id}_{fixture_fingerprint}"
             self.entity_id = f"light.{self._attr_unique_id}"
         else:

custom_components/dmx/entity/number.py

@@ -3,6 +3,7 @@
 from homeassistant.components.number import NumberExtraStoredData, NumberMode, RestoreNumber
 from homeassistant.core import State, callback
 from homeassistant.helpers.entity import DeviceInfo
+from homeassistant.util import slugify
 
 from custom_components.dmx.const import DOMAIN
 from custom_components.dmx.fixture.capability import Capability, DynamicEntity
@@ -32,7 +33,9 @@ def __init__(
         self._attr_device_info = device
 
         if entity_id_prefix:
-            self._attr_unique_id = f"{entity_id_prefix}_{channel_name.lower()}_{fixture_fingerprint}"
+            slug_prefix = slugify(entity_id_prefix)
+            slug_channel = slugify(channel_name)
+            self._attr_unique_id = f"{slug_prefix}_{slug_channel}_{fixture_fingerprint}"
             self.entity_id = f"number.{self._attr_unique_id}"
         else:
             self._attr_unique_id = (

custom_components/dmx/entity/select.py

@@ -2,6 +2,7 @@
 
 from homeassistant.components.select import SelectEntity
 from homeassistant.helpers.entity import DeviceInfo
+from homeassistant.util import slugify
 
 from custom_components.dmx.const import DOMAIN
 from custom_components.dmx.entity.icon_helper import determine_icon
@@ -32,7 +33,9 @@ def __init__(
         self._attr_name = f"{fixture_name} {channel_name}"
         self._attr_device_info = device
         if entity_id_prefix:
-            self._attr_unique_id = f"{entity_id_prefix}_{channel_name.lower()}_{fixture_fingerprint}"
+            slug_prefix = slugify(entity_id_prefix)
+            slug_channel = slugify(channel_name)
+            self._attr_unique_id = f"{slug_prefix}_{slug_channel}_{fixture_fingerprint}"
             self.entity_id = f"select.{self._attr_unique_id}"
         else:
             self._attr_unique_id = (

docs/migration.md

@@ -6,7 +6,7 @@ All your current fixtures are now still supported! Here's the process to get you
 
 Our integration name changed from `artnet_led` to `dmx`. HACS doesn't allow this, so we are unable to upgrade this in-place. Therefore a manual release is needed for the beta.
 
-Under [the release](https://github.com/Breina/ha-artnet-led/releases/tag/v1.0.0-BETA.8) download the [source code](https://github.com/Breina/ha-artnet-led/archive/refs/tags/v1.0.0-BETA.8.zip).
+Under [the release](https://github.com/Breina/ha-artnet-led/releases/tag/v1.0.0-BETA.9) download the [source code](https://github.com/Breina/ha-artnet-led/archive/refs/tags/v1.0.0-BETA.9.zip).
 
 In this ZIP, navigate to `custom_components/dmx` and copy this `dmx` folder into your Home Assistant's `custom_components` folder.