Fix entity ID validation for hyphenated device names (#8)

- Sanitize hyphens to underscores in NMEA2000Sensor unique_id generation
- Remove redundant hub.id property; use hub.name directly
- Fix callers to use renamed sensor_id constructor parameter
- Add pytest job to CI workflow
- Add copilot-instructions.md for development guidelines
- Add tests for hyphen sanitization
- Bump version to 2026.3.3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: tomer-w

.github/copilot-instructions.md

@@ -0,0 +1,53 @@
+# Copilot Instructions for ha-nmea2000
+
+## Project Overview
+
+This is a Home Assistant custom integration for NMEA 2000 marine data. It connects to NMEA 2000 gateways (CAN, USB, TCP/EBYTE) and exposes PGN data as HA sensors.
+
+## Project Structure
+
+- `custom_components/nmea2000/` — Integration source code
+  - `__init__.py` — Integration setup and entry points
+  - `hub.py` — Gateway orchestration, sensor creation, PGN processing
+  - `NMEA2000Sensor.py` — Sensor entity class
+  - `config_flow.py` — Configuration UI flow
+  - `const.py` — Constants and configuration keys
+- `tests/` — Pytest test suite
+- `.devcontainer/` — Dev container configuration for Linux-based development
+
+## Key Dependencies
+
+- `nmea2000` Python library (listed in `requirements.txt`)
+- `pytest-homeassistant-custom-component` for testing (listed in `requirements_test.txt`)
+
+## Testing
+
+### Important: Tests require Linux
+
+Tests depend on `pytest-homeassistant-custom-component` which requires Linux. They **cannot** run natively on Windows.
+
+### Running tests
+
+Always run tests in Docker using the devcontainer image:
+
+```bash
+cd C:\ttt\ha-nmea2000
+docker run --rm -v "${PWD}:/workspace" -w /workspace mcr.microsoft.com/devcontainers/python:3.13 bash -c "pip install --quiet -r requirements.txt -r requirements_test.txt 2>&1 | tail -3 && pytest tests/ -v 2>&1"
+```
+
+### When to run tests
+
+- **Always** run tests after making any code changes, before considering the task complete.
+- Run tests before committing.
+
+## CI/CD
+
+- `.github/workflows/validate.yaml` — Runs HACS validation, hassfest, and pytest on push/PR.
+- Tests in CI install both `requirements.txt` and `requirements_test.txt`.
+
+## Code Conventions
+
+- Entity ID sanitization (spaces, hyphens → underscores) happens in `NMEA2000Sensor.__init__`, not in the hub.
+- `hub.py` passes raw names as `sensor_id` to `NMEA2000Sensor`; the sensor class handles all ID normalization.
+- The `NMEA2000Sensor` constructor parameter is named `sensor_id` (not `id`).
+- Use `pyproject.toml` for all project metadata (PEP 621). No `setup.py`.

.github/workflows/validate.yaml

@@ -20,3 +20,14 @@ jobs:
     steps:
         - uses: "actions/checkout@v6"
         - uses: "home-assistant/actions/hassfest@master"
+  tests:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v6"
+      - uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: pip install -r requirements_test.txt
+      - name: Run tests
+        run: pytest tests/ -v

custom_components/nmea2000/NMEA2000Sensor.py

@@ -31,7 +31,7 @@ def __init__(
         need_state_class = isinstance(initial_state, (int, float))
         _LOGGER.info("Initializing NMEA2000Sensor: sensor_id=%s, friendly_name=%s, initial_state: %s (%s), unit_of_measurement=%s, device_name=%s, via_device=%s, update_frequncy=%s, ttl=%s, need_state_class=%s",
                       sensor_id, friendly_name, initial_state, type(initial_state), unit_of_measurement, device_name, via_device, update_frequncy, ttl, need_state_class)
-        self._attr_unique_id = sensor_id.lower().replace(" ", "_")
+        self._attr_unique_id = sensor_id.lower().replace(" ", "_").replace("-", "_")
         self._attr_name = friendly_name
         self._device_name = device_name
         self._attr_native_value = initial_state

custom_components/nmea2000/hub.py

@@ -94,7 +94,6 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
 
         # Retrieve configuration from entry
         self.name = entry.data[CONF_NAME]
-        self.id = self.name.lower().replace(" ", "_")
         self.time_between_updates = timedelta(milliseconds=entry.data.get(CONF_MS_BETWEEN_UPDATES, 5000))
         mode = entry.data[CONF_MODE]
         self.device_name = f"NMEA 2000 {mode} Gateway"
@@ -152,21 +151,21 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
 
         # Create system sensors
         self.state_sensor = NMEA2000Sensor(
-            id=self.id+"_state", 
+            sensor_id=self.name+"_state", 
             friendly_name="State", 
             initial_state=self.state, 
             device_name=self.device_name, 
         )
         self.total_messages_sensor = NMEA2000Sensor(
-            id=self.id+"_total_messages", 
+            sensor_id=self.name+"_total_messages", 
             friendly_name="Total message count", 
             initial_state=0, 
             unit_of_measurement="messages", 
             device_name=self.device_name,
             update_frequncy=self.time_between_updates,
         )
         self.msg_per_minute_sensor = NMEA2000Sensor(
-            id=self.id+"_messages_per_minute", 
+            sensor_id=self.name+"_messages_per_minute", 
             friendly_name="Messages per minute", 
             initial_state=0, 
             unit_of_measurement="msg/min", 
@@ -382,7 +381,7 @@ async def receive_callback(self, message: NMEA2000Message) -> None:
         if pgn_sensor is None:
             _LOGGER.info("Creating new sensor for PGN %d", message.PGN)
             sensor = NMEA2000Sensor(
-                id=self.id + "_" + message.id,
+                sensor_id=self.name + "_" + message.id,
                 friendly_name=f"PGN {message.PGN} message count",
                 initial_state=1,
                 unit_of_measurement="count",
@@ -401,7 +400,7 @@ async def receive_callback(self, message: NMEA2000Message) -> None:
             )
             pgn_sensor.set_state(new_value, ignore_tracing = True)
 
-        sensor_name_prefix = f"{self.id}_{message.PGN}_{message.id}_{message.hash}_"
+        sensor_name_prefix = f"{self.name}_{message.PGN}_{message.id}_{message.hash}_"
 
         # Process individual fields in the message
         for field in message.fields:
@@ -436,7 +435,7 @@ async def receive_callback(self, message: NMEA2000Message) -> None:
             if sensor is None:
                 # Create new sensor
                 sensor = NMEA2000Sensor(
-                    id=sensor_id,
+                    sensor_id=sensor_id,
                     friendly_name=field.name,
                     initial_state=field.value,
                     unit_of_measurement=field.unit_of_measurement,

custom_components/nmea2000/manifest.json

@@ -13,5 +13,5 @@
   "requirements": [
     "nmea2000==2026.3.3"
   ],
-  "version": "2026.3.2"
+  "version": "2026.3.3"
 }

tests/test_hub.py

@@ -172,3 +172,24 @@ async def test_hub_status_callback_disconnected(mock_can_cls, hass):
     await hub.status_callback(State.DISCONNECTED)
     assert hub.state == "Disconnected"
 
+
+@patch("custom_components.nmea2000.hub.PythonCanAsyncIOClient")
+async def test_hub_hyphenated_name_creates_valid_sensors(mock_can_cls, hass):
+    """Test Hub with hyphenated name creates sensors with sanitized unique IDs."""
+    mock_can_cls.return_value = MagicMock()
+    mock_can_cls.return_value.set_receive_callback = MagicMock()
+    mock_can_cls.return_value.set_status_callback = MagicMock()
+
+    entry = _make_entry(hass, CONF_MODE_CAN, {
+        "name": "YDEN-02",
+        CONF_CAN_INTERFACE: "socketcan",
+        CONF_CAN_CHANNEL: "can0",
+        CONF_CAN_BITRATE: 250000,
+    })
+    hub = Hub(hass, entry)
+
+    assert hub.name == "YDEN-02"
+    assert "-" not in hub.state_sensor._attr_unique_id
+    assert "-" not in hub.total_messages_sensor._attr_unique_id
+    assert "-" not in hub.msg_per_minute_sensor._attr_unique_id
+

tests/test_sensor.py

@@ -8,7 +8,7 @@
 async def test_sensor_init_numeric(hass):
     """Test sensor initialization with numeric state."""
     sensor = NMEA2000Sensor(
-        id="test_sensor",
+        sensor_id="test_sensor",
         friendly_name="Temperature",
         initial_state=25.5,
         unit_of_measurement="°C",
@@ -23,7 +23,7 @@ async def test_sensor_init_numeric(hass):
 async def test_sensor_init_string(hass):
     """Test sensor initialization with string state."""
     sensor = NMEA2000Sensor(
-        id="test_state",
+        sensor_id="test_state",
         friendly_name="Status",
         initial_state="Running",
         device_name="Test Device",
@@ -35,7 +35,7 @@ async def test_sensor_init_string(hass):
 async def test_sensor_init_none_unavailable(hass):
     """Test sensor with None initial state is unavailable."""
     sensor = NMEA2000Sensor(
-        id="test_null",
+        sensor_id="test_null",
         friendly_name="Empty",
         initial_state=None,
         device_name="Test Device",
@@ -46,7 +46,7 @@ async def test_sensor_init_none_unavailable(hass):
 async def test_sensor_str_repr(hass):
     """Test sensor string representation."""
     sensor = NMEA2000Sensor(
-        id="test_repr",
+        sensor_id="test_repr",
         friendly_name="Wind Speed",
         initial_state=12.3,
         unit_of_measurement="kts",
@@ -60,7 +60,7 @@ async def test_sensor_str_repr(hass):
 async def test_sensor_set_state_not_ready(hass):
     """Test set_state does nothing when sensor is not ready."""
     sensor = NMEA2000Sensor(
-        id="test_not_ready",
+        sensor_id="test_not_ready",
         friendly_name="Test",
         initial_state=0,
         device_name="Device",
@@ -73,7 +73,7 @@ async def test_sensor_set_state_not_ready(hass):
 async def test_sensor_set_state_ready(hass):
     """Test set_state updates value when sensor is ready."""
     sensor = NMEA2000Sensor(
-        id="test_ready",
+        sensor_id="test_ready",
         friendly_name="Test",
         initial_state=0,
         device_name="Device",
@@ -87,7 +87,7 @@ async def test_sensor_set_state_ready(hass):
 async def test_sensor_update_availability_not_ready(hass):
     """Test update_availability does nothing when not ready."""
     sensor = NMEA2000Sensor(
-        id="test_avail",
+        sensor_id="test_avail",
         friendly_name="Test",
         initial_state=0,
         device_name="Device",
@@ -99,7 +99,7 @@ async def test_sensor_update_availability_not_ready(hass):
 async def test_sensor_via_device(hass):
     """Test sensor with via_device creates proper device info."""
     sensor = NMEA2000Sensor(
-        id="test_via",
+        sensor_id="test_via",
         friendly_name="Test",
         initial_state=0,
         device_name="SubDevice",
@@ -112,7 +112,7 @@ async def test_sensor_custom_update_frequency(hass):
     """Test sensor with custom update frequency."""
     freq = timedelta(seconds=10)
     sensor = NMEA2000Sensor(
-        id="test_freq",
+        sensor_id="test_freq",
         friendly_name="Test",
         initial_state=0,
         device_name="Device",
@@ -125,11 +125,36 @@ async def test_sensor_custom_ttl(hass):
     """Test sensor with custom TTL."""
     ttl = timedelta(seconds=30)
     sensor = NMEA2000Sensor(
-        id="test_ttl",
+        sensor_id="test_ttl",
         friendly_name="Test",
         initial_state=0,
         device_name="Device",
         ttl=ttl,
     )
     # TTL is multiplied by UNAVAILABLE_FACTOR (10)
     assert sensor.ttl == ttl * 10
+
+
+async def test_sensor_hyphenated_id_sanitized(hass):
+    """Test that hyphens in sensor_id are replaced with underscores in unique_id."""
+    sensor = NMEA2000Sensor(
+        sensor_id="yden-02_126993_heartbeat",
+        friendly_name="Heartbeat",
+        initial_state=0,
+        device_name="Test Device",
+    )
+    assert "-" not in sensor._attr_unique_id
+    assert sensor._attr_unique_id == "yden_02_126993_heartbeat"
+
+
+async def test_sensor_multiple_special_chars_sanitized(hass):
+    """Test that both spaces and hyphens are sanitized in unique_id."""
+    sensor = NMEA2000Sensor(
+        sensor_id="MY-DEVICE name-test",
+        friendly_name="Test",
+        initial_state=0,
+        device_name="Test Device",
+    )
+    assert "-" not in sensor._attr_unique_id
+    assert " " not in sensor._attr_unique_id
+    assert sensor._attr_unique_id == "my_device_name_test"