Add ability to exclude / include by manufacturer

Add conversion from m/s to kts

Author: tomer-w

custom_components/nmea2000/config_flow.py

@@ -2,42 +2,83 @@
 import voluptuous as vol
 from homeassistant import config_entries
 from homeassistant.core import callback
-from homeassistant.helpers.selector import SelectSelector, SelectSelectorConfig
+from homeassistant.helpers.selector import SelectSelector, SelectSelectorConfig, SelectSelectorMode
 from homeassistant.const import CONF_NAME
-# from homeassistant.exceptions import HomeAssistantError
-
-from .const import CONF_DEVICE_TYPE, CONF_EXPERIMENTAL, DOMAIN, CONF_PGN_INCLUDE, CONF_PGN_EXCLUDE, CONF_PORT, CONF_IP, CONF_BAUDRATE, CONF_MODE, CONF_SERIAL_PORT, CONF_MODE_TCP, CONF_MODE_USB, CONF_MS_BETWEEN_UPDATES, CONF_EXCLUDE_AIS
 import logging
+import homeassistant.helpers.config_validation as cv
+
+from .const import (
+    CONF_DEVICE_TYPE,
+    CONF_EXPERIMENTAL,
+    CONF_MANUFACTURER_CODES_EXCLUDE,
+    CONF_MANUFACTURER_CODES_INCLUDE,
+    DOMAIN,
+    CONF_PGN_INCLUDE,
+    CONF_PGN_EXCLUDE,
+    CONF_PORT,
+    CONF_IP,
+    CONF_BAUDRATE,
+    CONF_MODE,
+    CONF_SERIAL_PORT,
+    CONF_MODE_TCP,
+    CONF_MODE_USB,
+    CONF_MS_BETWEEN_UPDATES,
+    CONF_EXCLUDE_AIS,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
-class NetwrorkDeviceType(Enum):
+MANUFACTURER_CODES = [
+    {"value": "b_and_g", "label": "B & G"},
+    {"value": "garmin", "label": "Garmin"},
+    {"value": "mastervolt", "label": "Mastervolt"},
+    {"value": "victron", "label": "Victron Energy"}
+]
+
+class NetworkDeviceType(Enum):
     """Enum for device types."""
     EBYTE = "EBYTE"
     ACTISENSE = "Actisense"
     YACHT_DEVICES = "Yacht Devices"
-    
+
+def get_manufacturer_selector(name: str) -> SelectSelector:
+    """Create a manufacturer selector."""
+    return SelectSelector(
+        SelectSelectorConfig(
+            options=MANUFACTURER_CODES,
+            mode=SelectSelectorMode.DROPDOWN,
+            multiple=True,
+            translation_key=name,
+        )
+    )
 
 USB_DATA_SCHEMA = vol.Schema(
     {
         vol.Required(CONF_SERIAL_PORT, default="/dev/ttyUSB0"): str,
         vol.Required(CONF_BAUDRATE, default=2000000): int,
         vol.Optional(CONF_PGN_INCLUDE): str,
         vol.Optional(CONF_PGN_EXCLUDE): str,
-        vol.Optional(CONF_EXCLUDE_AIS, default=True): bool,
         vol.Optional(CONF_MS_BETWEEN_UPDATES, default=5000): int,
+        vol.Optional(CONF_EXCLUDE_AIS, default=True): bool,
+        vol.Optional(CONF_MANUFACTURER_CODES_INCLUDE): get_manufacturer_selector(CONF_MANUFACTURER_CODES_INCLUDE),
+        vol.Optional(CONF_MANUFACTURER_CODES_EXCLUDE): get_manufacturer_selector(CONF_MANUFACTURER_CODES_EXCLUDE),
         vol.Optional(CONF_EXPERIMENTAL): bool,
     }
 )
+
 TCP_DATA_SCHEMA = vol.Schema(
     {
-        vol.Required(CONF_DEVICE_TYPE, default=NetwrorkDeviceType.EBYTE): vol.In([e.value for e in NetwrorkDeviceType]),
+        vol.Required(CONF_DEVICE_TYPE, default=NetworkDeviceType.EBYTE.value): vol.In(
+            [e.value for e in NetworkDeviceType]
+        ),
         vol.Required(CONF_IP, default="192.168.0.46"): str,
         vol.Required(CONF_PORT, default=8881): int,
         vol.Optional(CONF_PGN_INCLUDE): str,
         vol.Optional(CONF_PGN_EXCLUDE): str,
-        vol.Optional(CONF_EXCLUDE_AIS, default=True): bool,
         vol.Optional(CONF_MS_BETWEEN_UPDATES, default=5000): int,
+        vol.Optional(CONF_EXCLUDE_AIS, default=True): bool,
+        vol.Optional(CONF_MANUFACTURER_CODES_INCLUDE): get_manufacturer_selector(CONF_MANUFACTURER_CODES_INCLUDE),
+        vol.Optional(CONF_MANUFACTURER_CODES_EXCLUDE): get_manufacturer_selector(CONF_MANUFACTURER_CODES_EXCLUDE),
         vol.Optional(CONF_EXPERIMENTAL): bool,
     }
 )
@@ -127,6 +168,9 @@ async def async_step_options(self, user_input=None):
             if CONF_PGN_INCLUDE in user_input and CONF_PGN_EXCLUDE in user_input:
                 errors[CONF_PGN_EXCLUDE] = "include_exclude_only_one"
 
+            if len(user_input[CONF_MANUFACTURER_CODES_INCLUDE]) != 0 and len(user_input[CONF_MANUFACTURER_CODES_EXCLUDE]) != 0:
+                errors[CONF_MANUFACTURER_CODES_EXCLUDE] = "include_exclude_only_one"
+
             if len(errors) == 0:
                 new_data = self.data | user_input
                 _LOGGER.debug("No errors. Storing data: %s", new_data)
@@ -178,6 +222,9 @@ async def async_step_init(self, user_input=None):
             if CONF_PGN_INCLUDE in user_input and CONF_PGN_EXCLUDE in user_input:
                 errors[CONF_PGN_EXCLUDE] = "include_exclude_only_one"
 
+            if len(user_input[CONF_MANUFACTURER_CODES_INCLUDE]) != 0 and len(user_input[CONF_MANUFACTURER_CODES_EXCLUDE]) != 0:
+                errors[CONF_MANUFACTURER_CODES_EXCLUDE] = "include_exclude_only_one"
+
             if len(errors) == 0:
                 new_data = user_input
                 # merge back the name and mode which are missing from this page

custom_components/nmea2000/const.py

@@ -12,4 +12,6 @@
 CONF_MS_BETWEEN_UPDATES = "ms_between_updates"
 CONF_EXCLUDE_AIS = "exclude_AIS"
 CONF_DEVICE_TYPE = "device_type"
-CONF_EXPERIMENTAL = "experimental"
+CONF_EXPERIMENTAL = "experimental"
+CONF_MANUFACTURER_CODES_INCLUDE = "manufacturer_codes_include"
+CONF_MANUFACTURER_CODES_EXCLUDE = "manufacturer_codes_exclude"

custom_components/nmea2000/hub.py

@@ -19,6 +19,8 @@
     CONF_DEVICE_TYPE,
     CONF_EXCLUDE_AIS,
     CONF_EXPERIMENTAL,
+    CONF_MANUFACTURER_CODES_EXCLUDE,
+    CONF_MANUFACTURER_CODES_INCLUDE,
     CONF_MODE,
     CONF_PGN_INCLUDE,
     CONF_PGN_EXCLUDE,
@@ -29,7 +31,7 @@
     CONF_PORT,
     CONF_MS_BETWEEN_UPDATES,
 )
-from .config_flow import NetwrorkDeviceType, parse_and_validate_comma_separated_integers
+from .config_flow import NetworkDeviceType, parse_and_validate_comma_separated_integers
 from .NMEA2000Sensor import NMEA2000Sensor
 
 # Home Assistant imports
@@ -122,18 +124,22 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
         # remove duplicates
         pgn_include = list(set(pgn_include))
         pgn_exclude = list(set(pgn_exclude))
+        include_manufacturer_code = entry.data.get(CONF_MANUFACTURER_CODES_INCLUDE, [])
+        exclude_manufacturer_code = entry.data.get(CONF_MANUFACTURER_CODES_EXCLUDE, [])
 
-        preferred_units = {PhysicalQuantities.TEMPERATURE:"C", PhysicalQuantities.ANGLE:"deg"}
+        preferred_units = {PhysicalQuantities.TEMPERATURE:"C", PhysicalQuantities.ANGLE:"deg", PhysicalQuantities.SPEED:"kts"}
 
         _LOGGER.info(
-            "Configuring sensor with name: %s, mode: %s, PGN Include: %s, PGN Exclude: %s, preferred_units: %s, dump_to_file: %s, dump_pgns: %s",
+            "Configuring sensor with name: %s, mode: %s, PGN Include: %s, PGN Exclude: %s, preferred_units: %s, dump_to_file: %s, dump_pgns: %s, include_manufacturer_code: %s, exclude_manufacturer_code: %s",
             self.name,
             mode,
             pgn_include,
             pgn_exclude,
             preferred_units,
             dump_to_file,
-            dump_pgns
+            dump_pgns,
+            include_manufacturer_code,
+            exclude_manufacturer_code,
         )
 
         # Create system sensors
@@ -177,19 +183,21 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
                 dump_to_file=dump_to_file,
                 dump_pgns=dump_pgns,
                 build_network_map = build_network_map,
+                include_manufacturer_code = include_manufacturer_code,
+                exclude_manufacturer_code = exclude_manufacturer_code,
             )
         elif mode == "TCP":
             ip = entry.data[CONF_IP]
             port = entry.data[CONF_PORT]
-            device_type = NetwrorkDeviceType(entry.data[CONF_DEVICE_TYPE])
+            device_type = NetworkDeviceType(entry.data[CONF_DEVICE_TYPE])
             _LOGGER.info(
                 "TCP sensor with name: %s, IP: %s, port: %s, device_type: %s", 
                 self.name, 
                 ip, 
                 port,
                 device_type
             )
-            if device_type == NetwrorkDeviceType.EBYTE:
+            if device_type == NetworkDeviceType.EBYTE:
                 self.gateway = EByteNmea2000Gateway(
                     host=ip, 
                     port=port, 
@@ -199,8 +207,10 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
                     dump_to_file=dump_to_file,
                     dump_pgns=dump_pgns,
                     build_network_map = build_network_map,
+                    include_manufacturer_code = include_manufacturer_code,
+                    exclude_manufacturer_code = exclude_manufacturer_code,
                 )
-            elif device_type == NetwrorkDeviceType.ACTISENSE:
+            elif device_type == NetworkDeviceType.ACTISENSE:
                 self.gateway = ActisenseNmea2000Gateway(
                     host=ip, 
                     port=port, 
@@ -210,8 +220,10 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
                     dump_to_file=dump_to_file,
                     dump_pgns=dump_pgns,
                     build_network_map = build_network_map,
+                    include_manufacturer_code = include_manufacturer_code,
+                    exclude_manufacturer_code = exclude_manufacturer_code,
             )
-            elif device_type == NetwrorkDeviceType.YACHT_DEVICES:
+            elif device_type == NetworkDeviceType.YACHT_DEVICES:
                 self.gateway = YachtDevicesNmea2000Gateway(
                     host=ip, 
                     port=port, 
@@ -221,6 +233,8 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
                     dump_to_file=dump_to_file,
                     dump_pgns=dump_pgns,
                     build_network_map = build_network_map,
+                    include_manufacturer_code = include_manufacturer_code,
+                    exclude_manufacturer_code = exclude_manufacturer_code,
                 )
             else:
                 raise Exception(f"device_type {device_type} not supported")

custom_components/nmea2000/manifest.json

@@ -11,7 +11,7 @@
   "iot_class": "local_push",
   "issue_tracker": "https://github.com/tomer-w/ha-nmea2000/issues",
   "requirements": [
-    "nmea2000==2025.5.18"
+    "nmea2000==2025.6.3"
   ],
-  "version": "2025.6.1"
+  "version": "2025.6.2"
 }