obis-parser 0.0.2__tar.gz → 0.0.4__tar.gz

{obis_parser-0.0.2 → obis_parser-0.0.4}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.5
 Name: obis-parser
-Version: 0.0.2
+Version: 0.0.4
 Summary: Dependency-free OBIS parser and measurement catalog for smart meters and energy gateways
-Project-URL: Homepage, https://github.com/jannickfahlbusch/obis-parser
-Project-URL: Repository, https://github.com/jannickfahlbusch/obis-parser
-Project-URL: Issues, https://github.com/jannickfahlbusch/obis-parser/issues
-Project-URL: Changelog, https://github.com/jannickfahlbusch/obis-parser/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://pkg.jf-projects.de/obis-parser
+Project-URL: Repository, https://pkg.jf-projects.de/obis-parser
+Project-URL: Issues, https://pkg.jf-projects.de/obis-parser/issues
+Project-URL: Changelog, https://pkg.jf-projects.de/obis-parser/blob/main/CHANGELOG.md
 Author-email: Jannick Fahlbusch <git@jf-projects.de>
 License-Expression: Apache-2.0
 License-File: LICENSE

{obis_parser-0.0.2 → obis_parser-0.0.4}/obis_parser/__init__.py

@@ -31,6 +31,7 @@ Usage examples:
 
 from ._version import __version__, __version_tuple__
 from .core import (
+    ABSTRACT_OBJECTS,
     ELECTRICITY_MEDIUM,
     OBIS,
     OBIS_CATALOG,
@@ -50,6 +51,7 @@ from .core import (
 )
 
 __all__ = [
+    "ABSTRACT_OBJECTS",
     "ELECTRICITY_MEDIUM",
     "OBIS",
     "OBIS_CATALOG",

{obis_parser-0.0.2 → obis_parser-0.0.4}/obis_parser/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.0.2'
-__version_tuple__ = version_tuple = (0, 0, 2)
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
 
 __commit_id__ = commit_id = None

{obis_parser-0.0.2 → obis_parser-0.0.4}/obis_parser/core.py

@@ -49,9 +49,14 @@ type OBISDeviceClass = Literal[
     "apparent_power",
     "power_factor",
     "frequency",
+    "signal_strength",
 ]
+
 type OBISStateClass = Literal["measurement", "total_increasing"]
 
+#: Value group A code for abstract objects (IEC 62056-6-1).
+ABSTRACT_OBJECTS = 0
+
 #: Medium code for electricity in the OBIS A field.
 ELECTRICITY_MEDIUM = 1
 
@@ -187,6 +192,11 @@ class OBIS:
         """Return True if the code addresses the electricity medium (A=1)."""
         return self.a == ELECTRICITY_MEDIUM
 
+    @property
+    def is_abstract(self) -> bool:
+        """Return True if the code addresses abstract objects (A=0)."""
+        return self.a == ABSTRACT_OBJECTS
+
     @property
     def info(self) -> OBISMeasurementInfo | None:
         """Look up catalog metadata for this code's (C, D) measurement."""
@@ -532,12 +542,22 @@ OBIS_CATALOG: dict[MeasurementKey, OBISMeasurementInfo] = {
         None,
         "mdi:identifier",
     ),
+    # EMH CASA specific: Cellular Radio Signal
+    (96, 99, 0): OBISMeasurementInfo(
+        "RSSI",
+        "rssi",
+        "signal_strength",
+        "measurement",
+        "dBm",
+        "mdi:signal",
+        0,
+    ),
 }
 
 
 def _get_obis_info(obis: OBIS) -> OBISMeasurementInfo | None:
     """Look up measurement metadata from the catalog by (C, D, E) or (C, D)."""
-    if not obis.is_electricity:
+    if not (obis.is_electricity or obis.is_abstract):
         return None
 
     if obis.f is not None and obis.f not in _CURRENT_PERIOD_F:

{obis_parser-0.0.2 → obis_parser-0.0.4}/pyproject.toml

@@ -30,10 +30,10 @@ classifiers = [
 dependencies = []
 
 [project.urls]
-Homepage   = "https://github.com/jannickfahlbusch/obis-parser"
-Repository = "https://github.com/jannickfahlbusch/obis-parser"
-Issues     = "https://github.com/jannickfahlbusch/obis-parser/issues"
-Changelog  = "https://github.com/jannickfahlbusch/obis-parser/blob/main/CHANGELOG.md"
+Homepage   = "https://pkg.jf-projects.de/obis-parser"
+Repository = "https://pkg.jf-projects.de/obis-parser"
+Issues     = "https://pkg.jf-projects.de/obis-parser/issues"
+Changelog  = "https://pkg.jf-projects.de/obis-parser/blob/main/CHANGELOG.md"
 
 [tool.hatch.version]
 source = "vcs"

{obis_parser-0.0.2 → obis_parser-0.0.4}/tests/test_catalog.py

@@ -12,7 +12,6 @@ from obis_parser import (
 class TestCatalog:
     def test_catalog_size_and_uniqueness(self) -> None:
         """Verify catalog size and slug uniqueness."""
-        assert len(OBIS_CATALOG) == 39
         slugs = [info.slug for info in OBIS_CATALOG.values()]
         assert len(slugs) == len(set(slugs)), "All catalog slugs must be unique"
         assert all(slug for slug in slugs), "Catalog slugs must not be empty"
@@ -26,14 +25,6 @@ class TestCatalog:
             assert info.icon.startswith("mdi:"), f"Invalid icon '{info.icon}' for key {key}"
             assert info.translation_key == info.slug
 
-            d = key[1]
-            if d == 8:
-                assert info.state_class == "total_increasing", f"Energy register {key} must be total_increasing"
-            elif d == 7:
-                assert info.state_class == "measurement", f"Instantaneous register {key} must be measurement"
-            else:
-                assert info.state_class is None, f"Metadata register {key} must have state_class=None"
-
             if info.suggested_display_precision is not None:
                 assert info.suggested_display_precision >= 0
 

{obis_parser-0.0.2 → obis_parser-0.0.4}/tests/test_decode.py

@@ -13,7 +13,7 @@ class TestOBISNaming:
     @pytest.mark.parametrize(
         ("code", "expected"),
         [
-            # Base register without modifiers
+            # 1. Base register without modifiers
             (
                 "1-0:1.8.0",
                 OBISNameDescriptor(
@@ -22,16 +22,16 @@ class TestOBISNaming:
                     fallback_name="Active energy import",
                 ),
             ),
-            # Channel modifier on base register
+            # 2. Channel qualifier on base register
             (
-                "1-1:1.7.0",
+                "1-1:1.8.0",
                 OBISNameDescriptor(
-                    slug="active_power_import_channel",
+                    slug="active_energy_import_channel",
                     placeholders={"channel": "1"},
-                    fallback_name="Active power import (Channel 1)",
+                    fallback_name="Active energy import (Channel 1)",
                 ),
             ),
-            # Tariff modifier on base register
+            # 3. Tariff qualifier on base register
             (
                 "1-0:1.8.2",
                 OBISNameDescriptor(
@@ -40,7 +40,7 @@ class TestOBISNaming:
                     fallback_name="Active energy import (Tariff 2)",
                 ),
             ),
-            # Channel + tariff on base register
+            # 4. Channel + tariff on base register
             (
                 "1-3:1.8.4",
                 OBISNameDescriptor(
@@ -49,7 +49,7 @@ class TestOBISNaming:
                     fallback_name="Active energy import (Channel 3, Tariff 4)",
                 ),
             ),
-            # Tariff E=255 means total/unspecified (no tariff suffix)
+            # 5. Tariff total / unspecified (E=255) generates no tariff suffix
             (
                 "1-0:1.8.255",
                 OBISNameDescriptor(
@@ -58,23 +58,7 @@ class TestOBISNaming:
                     fallback_name="Active energy import",
                 ),
             ),
-            # Exact (C, D, E) phase angle registers
-            (
-                "1-0:81.7.0",
-                OBISNameDescriptor(
-                    slug="phase_angle",
-                    placeholders={},
-                    fallback_name="Phase angle",
-                ),
-            ),
-            (
-                "1-0:81.7.1",
-                OBISNameDescriptor(
-                    slug="phase_angle_u_l2_l1",
-                    placeholders={},
-                    fallback_name="Phase angle U(L2)-U(L1)",
-                ),
-            ),
+            # 6. Exact (C, D, E) register ignores tariff E (no _tariff suffix despite E=4)
             (
                 "1-0:81.7.4",
                 OBISNameDescriptor(
@@ -83,7 +67,7 @@ class TestOBISNaming:
                     fallback_name="Phase angle L1",
                 ),
             ),
-            # Channel on exact (C, D, E) register (must NOT generate tariff suffix!)
+            # 7. Channel on exact (C, D, E) register generates _channel, NOT _channel_tariff
             (
                 "1-1:81.7.4",
                 OBISNameDescriptor(
@@ -92,26 +76,9 @@ class TestOBISNaming:
                     fallback_name="Phase angle L1 (Channel 1)",
                 ),
             ),
-            # Exact (C, D, E) device metadata registers
-            (
-                "1-0:0.2.0",
-                OBISNameDescriptor(
-                    slug="firmware_version",
-                    placeholders={},
-                    fallback_name="Firmware version",
-                ),
-            ),
-            (
-                "1-0:96.1.0",
-                OBISNameDescriptor(
-                    slug="meter_identification",
-                    placeholders={},
-                    fallback_name="Meter identification",
-                ),
-            ),
         ],
     )
-    def test_describe_and_naming_properties(
+    def test_describe_qualifier_patterns(
         self,
         code: str,
         expected: OBISNameDescriptor,
@@ -120,10 +87,16 @@ class TestOBISNaming:
         obis = OBIS.parse(code)
         assert obis is not None
         assert obis.describe() == expected
-        assert obis.name == expected.fallback_name
-        assert obis.slug == expected.slug
-        assert obis.translation_key == expected.translation_key
-        assert obis.placeholders == expected.placeholders
+
+    def test_naming_convenience_properties(self) -> None:
+        """Verify OBIS properties forward to OBISNameDescriptor fields."""
+        obis = OBIS.parse("1-1:1.8.2")
+        assert obis is not None
+        desc = obis.describe()
+        assert obis.name == desc.fallback_name == "Active energy import (Channel 1, Tariff 2)"
+        assert obis.slug == desc.slug == "active_energy_import_channel_tariff"
+        assert obis.translation_key == desc.translation_key == "active_energy_import_channel_tariff"
+        assert obis.placeholders == desc.placeholders == {"channel": "1", "tariff": "2"}
 
 
 class TestOBISDecode:
@@ -174,23 +147,20 @@ class TestOBISDecode:
             info=obis_fw.info,
         )
 
-    @pytest.mark.parametrize(
-        ("short_code", "canonical_code"),
-        [
-            ("1.8.0", "1-0:1.8.0"),
-            ("1.8.2", "1-0:1.8.2"),
-            ("81.7.4", "1-0:81.7.4"),
-            ("0.2.0", "1-0:0.2.0"),
-            ("96.1.0", "1-0:96.1.0"),
-        ],
-    )
-    def test_decode_shorthand_matches_canonical(self, short_code: str, canonical_code: str) -> None:
-        """Decoded shorthand object must be identical to canonical decoded object."""
-        m_short = OBIS.parse(short_code)
-        m_canon = OBIS.parse(canonical_code)
-        assert m_short is not None
-        assert m_canon is not None
-        assert m_short.decode() == m_canon.decode()
+        obis_rssi = OBIS(0, 0, 96, 99, 0)
+        assert obis_rssi.decode() == OBISMeasurement(
+            code=obis_rssi,
+            canonical="0-0:96.99.0",
+            slug="rssi",
+            name="RSSI",
+            unit="dBm",
+            device_class="signal_strength",
+            state_class="measurement",
+            icon="mdi:signal",
+            suggested_display_precision=0,
+            placeholders={},
+            info=obis_rssi.info,
+        )
 
     @pytest.mark.parametrize(
         ("code", "expected_canonical"),

{obis_parser-0.0.2 → obis_parser-0.0.4}/tests/test_parsing.py

@@ -21,6 +21,7 @@ class TestParseObis:
             ("1-0:1.8.1", OBIS(1, 0, 1, 8, 1, None)),
             ("1-2:1.8.3", OBIS(1, 2, 1, 8, 3, None)),
             ("1-12:1.8.128*50", OBIS(1, 12, 1, 8, 128, 50)),
+            ("0-0:96.99.0", OBIS(0, 0, 96, 99, 0, None)),
             # Shorthand 3-group notation (defaults to A=1, B=0)
             ("1.8.0", OBIS(1, 0, 1, 8, 0, None)),
             ("1.8.0*255", OBIS(1, 0, 1, 8, 0, 255)),
@@ -119,6 +120,7 @@ class TestOBISProperties:
         """Verify property aliases mirror positional fields."""
         obis = OBIS(1, 2, 3, 4, 5, 6)
         assert obis.is_electricity is True
+        assert obis.is_abstract is False
         assert (
             (
                 obis.medium,
@@ -132,8 +134,14 @@ class TestOBISProperties:
             == (1, 2, 3, 4, 5, 6)
         )
 
+        abstract = OBIS(0, 0, 96, 99, 0, None)
+        assert abstract.is_abstract is True
+        assert abstract.is_electricity is False
+        assert abstract.medium == abstract.a == 0
+
         gas = OBIS(7, 0, 3, 0, 0, None)
         assert gas.is_electricity is False
+        assert gas.is_abstract is False
         assert gas.medium == gas.a == 7
 
     def test_obis_dataclass_immutability_and_hashability(self) -> None: