obis-parser 0.0.1__py3-none-any.whl

obis_parser/__init__.py

@@ -0,0 +1,71 @@
+"""Dependency-free OBIS parser and measurement catalog for smart meters and energy gateways.
+
+Usage examples:
+    >>> from obis_parser import OBIS
+    >>>
+    >>> # 1. Parse and access properties
+    >>> obis = OBIS.parse("0100010800ff")
+    >>> obis.canonical
+    '1-0:1.8.0'
+    >>> obis.name
+    'Active energy import'
+    >>> obis.slug
+    'active_energy_import'
+    >>>
+    >>> # 2. Multi-meter channels and dynamic tariffs
+    >>> obis = OBIS.parse("1-1:1.8.2")
+    >>> obis.name
+    'Active energy import (Channel 1, Tariff 2)'
+    >>> obis.slug
+    'active_energy_import_channel_tariff'
+    >>> obis.placeholders
+    {'channel': '1', 'tariff': '2'}
+    >>>
+    >>> # 3. Full metadata decode
+    >>> m = obis.decode()
+    >>> m.unit
+    'kWh'
+    >>> m.device_class
+    'energy'
+"""
+
+from ._version import __version__, __version_tuple__
+from .core import (
+    ELECTRICITY_MEDIUM,
+    OBIS,
+    OBIS_CATALOG,
+    MeasurementKey,
+    OBISBillingPeriod,
+    OBISChannel,
+    OBISDeviceClass,
+    OBISMeasurement,
+    OBISMeasurementInfo,
+    OBISMeasurementType,
+    OBISMedium,
+    OBISNameDescriptor,
+    OBISPhysicalQuantity,
+    OBISStateClass,
+    OBISTariff,
+    ParsedOBIS,
+)
+
+__all__ = [
+    "ELECTRICITY_MEDIUM",
+    "OBIS",
+    "OBIS_CATALOG",
+    "MeasurementKey",
+    "OBISBillingPeriod",
+    "OBISChannel",
+    "OBISDeviceClass",
+    "OBISMeasurement",
+    "OBISMeasurementInfo",
+    "OBISMeasurementType",
+    "OBISMedium",
+    "OBISNameDescriptor",
+    "OBISPhysicalQuantity",
+    "OBISStateClass",
+    "OBISTariff",
+    "ParsedOBIS",
+    "__version__",
+    "__version_tuple__",
+]

obis_parser/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None

obis_parser/core.py

@@ -0,0 +1,579 @@
+"""OBIS code parsing and measurement catalog for smart meters and energy gateways.
+
+This module is dependency-free (standard library only) and provides:
+- Object-oriented `OBIS` domain class with `OBIS.parse()`, canonicalization, and metadata.
+- Full catalog of 31 German smart meter electricity registers (IEC 62056-6-1 / DIN 43863-3).
+- Resolved measurement metadata via `obis.decode()` with 4-variant localization slugs.
+"""
+
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
+from string import hexdigits
+from typing import Literal
+
+_HEXDIGITS = set(hexdigits)
+_OBIS_STRING_RE = re.compile(r"^(\d+)\s*-\s*(\d+)\s*:\s*(\d+)\s*\.\s*(\d+)\s*\.\s*(\d+)(?:\s*\*\s*(\d+))?$")
+_OBIS_DOT_HEX_RE = re.compile(
+    r"^([0-9a-fA-F]{2})\.([0-9a-fA-F]{2})\.([0-9a-fA-F]{2})\."
+    r"([0-9a-fA-F]{2})\.([0-9a-fA-F]{2})\.([0-9a-fA-F]{2})$"
+)
+
+#: Group A: Abstract medium (1 = Electricity, 7 = Gas, 4 = Heat, etc.)
+type OBISMedium = int
+
+#: Group B: Channel / sub-device index (0 = No channel / default)
+type OBISChannel = int
+
+#: Group C: Physical quantity (1 = Active power import, 2 = Active power export, etc.)
+type OBISPhysicalQuantity = int
+
+#: Group D: Measurement algorithm (8 = Energy register, 7 = Instantaneous power, etc.)
+type OBISMeasurementType = int
+
+#: Group E: Tariff rate register (0 = Total / unspecified, 1 = Tariff 1, etc.)
+type OBISTariff = int
+
+#: Group F: Billing period history (255 or 0 = Current period, 1..254 = Historic cycles)
+type OBISBillingPeriod = int
+
+type OBISDeviceClass = Literal[
+    "current",
+    "energy",
+    "power",
+    "voltage",
+    "reactive_energy",
+    "reactive_power",
+    "apparent_power",
+    "power_factor",
+    "frequency",
+]
+type OBISStateClass = Literal["measurement", "total_increasing"]
+
+#: Medium code for electricity in the OBIS A field.
+ELECTRICITY_MEDIUM = 1
+
+#: F (billing period) values meaning "current period": absent, 0, or 255.
+_CURRENT_PERIOD_F = (0, 255)
+
+#: A measurement's identity: the (C, D) OBIS value groups — C is the physical
+#: quantity, D the measurement/processing type (IEC 62056-6-1). The channel (B)
+#: and tariff (E) fields are qualifiers and are NOT part of this key.
+type MeasurementKey = tuple[OBISPhysicalQuantity, OBISMeasurementType]
+
+
+@dataclass(frozen=True)
+class OBIS:
+    """A structured representation of an OBIS code (A-B:C.D.E*F)."""
+
+    a: OBISMedium
+    b: OBISChannel
+    c: OBISPhysicalQuantity
+    d: OBISMeasurementType
+    e: OBISTariff
+    f: OBISBillingPeriod | None = None
+
+    @classmethod
+    def parse(cls, code: str) -> OBIS | None:
+        """Parse an OBIS code from string, COSEM hex, dot-separated hex, or logical name."""
+        code = code.strip()
+        if not code:
+            return None
+
+        # Handle COSEM logical names with meter suffixes (e.g. '0100010800ff.1test000000001.sm')
+        if "." in code and len(code.split(".", 1)[0]) == 12:
+            prefix = code.split(".", 1)[0]
+            if all(char in _HEXDIGITS for char in prefix):
+                code = prefix
+
+        if match := _OBIS_STRING_RE.match(code):
+            return cls(
+                a=int(match.group(1)),
+                b=int(match.group(2)),
+                c=int(match.group(3)),
+                d=int(match.group(4)),
+                e=int(match.group(5)),
+                f=int(match.group(6)) if match.group(6) is not None else None,
+            )
+
+        if match := _OBIS_DOT_HEX_RE.match(code):
+            return cls(
+                a=int(match.group(1), 16),
+                b=int(match.group(2), 16),
+                c=int(match.group(3), 16),
+                d=int(match.group(4), 16),
+                e=int(match.group(5), 16),
+                f=int(match.group(6), 16),
+            )
+
+        if len(code) == 12 and all(char in _HEXDIGITS for char in code):
+            return cls(
+                a=int(code[0:2], 16),
+                b=int(code[2:4], 16),
+                c=int(code[4:6], 16),
+                d=int(code[6:8], 16),
+                e=int(code[8:10], 16),
+                f=int(code[10:12], 16),
+            )
+
+        return None
+
+    @classmethod
+    def from_string(cls, code: str) -> OBIS | None:
+        """Alias for `OBIS.parse()`."""
+        return cls.parse(code)
+
+    def __str__(self) -> str:
+        """Return the canonical OBIS string."""
+        return self.to_obis_string()
+
+    def to_obis_string(self) -> str:
+        """Return the canonical OBIS string used for entity keys."""
+        base = f"{self.a}-{self.b}:{self.c}.{self.d}.{self.e}"
+        if self.f is not None and self.f not in _CURRENT_PERIOD_F:
+            base += f"*{self.f}"
+        return base
+
+    @property
+    def canonical(self) -> str:
+        """Canonical OBIS string representation."""
+        return self.to_obis_string()
+
+    @property
+    def medium(self) -> OBISMedium:
+        """Abstract medium code (Group A)."""
+        return self.a
+
+    @property
+    def channel(self) -> OBISChannel:
+        """Channel / sub-device index (Group B)."""
+        return self.b
+
+    @property
+    def physical_quantity(self) -> OBISPhysicalQuantity:
+        """Physical quantity identifier (Group C)."""
+        return self.c
+
+    @property
+    def measurement_type(self) -> OBISMeasurementType:
+        """Measurement algorithm / processing type (Group D)."""
+        return self.d
+
+    @property
+    def tariff(self) -> OBISTariff:
+        """Tariff rate register (Group E)."""
+        return self.e
+
+    @property
+    def billing_period(self) -> OBISBillingPeriod | None:
+        """Billing period history index (Group F)."""
+        return self.f
+
+    @property
+    def is_electricity(self) -> bool:
+        """Return True if the code addresses the electricity medium (A=1)."""
+        return self.a == ELECTRICITY_MEDIUM
+
+    @property
+    def info(self) -> OBISMeasurementInfo | None:
+        """Look up catalog metadata for this code's (C, D) measurement."""
+        return _get_obis_info(self)
+
+    @property
+    def name(self) -> str:
+        """English display name with channel/tariff qualifiers."""
+        return self.describe().fallback_name
+
+    @property
+    def slug(self) -> str:
+        """Localization slug with channel/tariff variant suffix."""
+        return self.describe().slug
+
+    @property
+    def translation_key(self) -> str:
+        """Alias for slug (Home Assistant translation compatibility)."""
+        return self.slug
+
+    @property
+    def placeholders(self) -> dict[str, str]:
+        """Channel and tariff placeholder mapping."""
+        return self.describe().placeholders
+
+    def describe(self) -> OBISNameDescriptor:
+        """Resolve slug variant, placeholders, and English fallback name."""
+        return _describe_obis(self, self.info)
+
+    def decode(self) -> OBISMeasurement:
+        """Decode into a fully-resolved OBISMeasurement object."""
+        return _build_measurement(self, self.info)
+
+
+#: Backwards-compatibility alias for OBIS.
+ParsedOBIS = OBIS
+
+
+@dataclass(frozen=True)
+class OBISMeasurementInfo:
+    """Catalog metadata for a base (C, D) measurement."""
+
+    name: str
+    slug: str
+    device_class: OBISDeviceClass | None
+    state_class: OBISStateClass | None
+    unit: str | None
+    icon: str
+    suggested_display_precision: int | None = None
+
+    @property
+    def translation_key(self) -> str:
+        """Alias for slug (Home Assistant translation compatibility)."""
+        return self.slug
+
+
+@dataclass(frozen=True)
+class OBISNameDescriptor:
+    """Resolved naming descriptors for an OBIS code."""
+
+    slug: str
+    placeholders: dict[str, str] = field(default_factory=dict)
+    fallback_name: str = ""
+
+    @property
+    def translation_key(self) -> str:
+        """Alias for slug (Home Assistant translation compatibility)."""
+        return self.slug
+
+
+@dataclass(frozen=True)
+class OBISMeasurement:
+    """A fully-resolved OBIS measurement with values, units, and localized metadata."""
+
+    code: OBIS
+    canonical: str
+    slug: str
+    name: str
+    unit: str | None
+    device_class: OBISDeviceClass | None
+    state_class: OBISStateClass | None
+    icon: str
+    suggested_display_precision: int | None
+    placeholders: dict[str, str] = field(default_factory=dict)
+    info: OBISMeasurementInfo | None = None
+
+    @property
+    def translation_key(self) -> str:
+        """Alias for slug (Home Assistant translation compatibility)."""
+        return self.slug
+
+
+OBIS_CATALOG: dict[MeasurementKey, OBISMeasurementInfo] = {
+    # Active energy (time-integral, D=8)
+    (1, 8): OBISMeasurementInfo(
+        "Active energy import",
+        "active_energy_import",
+        "energy",
+        "total_increasing",
+        "kWh",
+        "mdi:home-import-outline",
+        5,
+    ),
+    (2, 8): OBISMeasurementInfo(
+        "Active energy export",
+        "active_energy_export",
+        "energy",
+        "total_increasing",
+        "kWh",
+        "mdi:home-export-outline",
+        5,
+    ),
+    # Reactive energy
+    (3, 8): OBISMeasurementInfo(
+        "Reactive energy import",
+        "reactive_energy_import",
+        "reactive_energy",
+        "total_increasing",
+        "kvarh",
+        "mdi:home-import-outline",
+        5,
+    ),
+    (4, 8): OBISMeasurementInfo(
+        "Reactive energy export",
+        "reactive_energy_export",
+        "reactive_energy",
+        "total_increasing",
+        "kvarh",
+        "mdi:home-export-outline",
+        5,
+    ),
+    # Apparent energy (no standard HA device class / unit constant exists)
+    (9, 8): OBISMeasurementInfo(
+        "Apparent energy",
+        "apparent_energy",
+        None,
+        "total_increasing",
+        "kVAh",
+        "mdi:flash",
+        5,
+    ),
+    # Active power (instantaneous, D=7)
+    (1, 7): OBISMeasurementInfo(
+        "Active power import",
+        "active_power_import",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    (2, 7): OBISMeasurementInfo(
+        "Active power export",
+        "active_power_export",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash-outline",
+        1,
+    ),
+    # Reactive power
+    (3, 7): OBISMeasurementInfo(
+        "Reactive power import",
+        "reactive_power_import",
+        "reactive_power",
+        "measurement",
+        "var",
+        "mdi:flash",
+        1,
+    ),
+    (4, 7): OBISMeasurementInfo(
+        "Reactive power export",
+        "reactive_power_export",
+        "reactive_power",
+        "measurement",
+        "var",
+        "mdi:flash-outline",
+        1,
+    ),
+    # Apparent power
+    (9, 7): OBISMeasurementInfo(
+        "Apparent power",
+        "apparent_power",
+        "apparent_power",
+        "measurement",
+        "VA",
+        "mdi:flash",
+        1,
+    ),
+    # Active power total + absolute
+    (16, 7): OBISMeasurementInfo(
+        "Active power total",
+        "active_power_total",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    (15, 7): OBISMeasurementInfo(
+        "Absolute active power",
+        "absolute_active_power",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    # Active power per phase (signed vector sum)
+    (36, 7): OBISMeasurementInfo(
+        "Active power L1",
+        "active_power_l1",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    (56, 7): OBISMeasurementInfo(
+        "Active power L2",
+        "active_power_l2",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    (76, 7): OBISMeasurementInfo(
+        "Active power L3",
+        "active_power_l3",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    # Active power per phase, import (+P)
+    (21, 7): OBISMeasurementInfo(
+        "Active power import L1",
+        "active_power_import_l1",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    (41, 7): OBISMeasurementInfo(
+        "Active power import L2",
+        "active_power_import_l2",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    (61, 7): OBISMeasurementInfo(
+        "Active power import L3",
+        "active_power_import_l3",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash",
+        1,
+    ),
+    # Active power per phase, export (-P)
+    (22, 7): OBISMeasurementInfo(
+        "Active power export L1",
+        "active_power_export_l1",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash-outline",
+        1,
+    ),
+    (42, 7): OBISMeasurementInfo(
+        "Active power export L2",
+        "active_power_export_l2",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash-outline",
+        1,
+    ),
+    (62, 7): OBISMeasurementInfo(
+        "Active power export L3",
+        "active_power_export_l3",
+        "power",
+        "measurement",
+        "W",
+        "mdi:flash-outline",
+        1,
+    ),
+    # Voltage per phase + total
+    (32, 7): OBISMeasurementInfo("Voltage L1", "voltage_l1", "voltage", "measurement", "V", "mdi:sine-wave", 1),
+    (52, 7): OBISMeasurementInfo("Voltage L2", "voltage_l2", "voltage", "measurement", "V", "mdi:sine-wave", 1),
+    (72, 7): OBISMeasurementInfo("Voltage L3", "voltage_l3", "voltage", "measurement", "V", "mdi:sine-wave", 1),
+    (12, 7): OBISMeasurementInfo("Voltage", "voltage", "voltage", "measurement", "V", "mdi:sine-wave", 1),
+    # Current per phase + total
+    (31, 7): OBISMeasurementInfo("Current L1", "current_l1", "current", "measurement", "A", "mdi:current-ac", 2),
+    (51, 7): OBISMeasurementInfo("Current L2", "current_l2", "current", "measurement", "A", "mdi:current-ac", 2),
+    (71, 7): OBISMeasurementInfo("Current L3", "current_l3", "current", "measurement", "A", "mdi:current-ac", 2),
+    (11, 7): OBISMeasurementInfo("Current", "current", "current", "measurement", "A", "mdi:current-ac", 2),
+    # Power factor + frequency
+    (13, 7): OBISMeasurementInfo(
+        "Power factor",
+        "power_factor",
+        "power_factor",
+        "measurement",
+        None,
+        "mdi:angle-acute",
+        2,
+    ),
+    (14, 7): OBISMeasurementInfo("Frequency", "frequency", "frequency", "measurement", "Hz", "mdi:sine-wave", 2),
+}
+
+
+def _get_obis_info(obis: OBIS) -> OBISMeasurementInfo | None:
+    """Look up measurement metadata from the catalog by (C, D)."""
+    if not obis.is_electricity:
+        return None
+
+    if obis.f is not None and obis.f not in _CURRENT_PERIOD_F:
+        return None
+
+    return OBIS_CATALOG.get((obis.c, obis.d))
+
+
+def _has_tariff(e: int) -> bool:
+    """A tariff register is any E in 1..254; 0 and 255 mean total/unspecified."""
+    return 1 <= e < 255
+
+
+def _describe_obis(obis: OBIS, info: OBISMeasurementInfo | None) -> OBISNameDescriptor:
+    """Resolve slug variant, placeholders, and fallback name for an OBIS code."""
+    if info is None:
+        canonical = obis.to_obis_string()
+        return OBISNameDescriptor(
+            slug="unknown_code",
+            placeholders={"code": canonical},
+            fallback_name=f"OBIS {canonical}",
+        )
+
+    has_channel = obis.b != 0
+    has_tariff = _has_tariff(obis.e)
+
+    placeholders: dict[str, str] = {}
+    fallback = info.name
+    if has_channel and has_tariff:
+        suffix = "_channel_tariff"
+        placeholders = {"channel": str(obis.b), "tariff": str(obis.e)}
+        fallback = f"{info.name} (Channel {obis.b}, Tariff {obis.e})"
+    elif has_channel:
+        suffix = "_channel"
+        placeholders = {"channel": str(obis.b)}
+        fallback = f"{info.name} (Channel {obis.b})"
+    elif has_tariff:
+        suffix = "_tariff"
+        placeholders = {"tariff": str(obis.e)}
+        fallback = f"{info.name} (Tariff {obis.e})"
+    else:
+        suffix = ""
+
+    return OBISNameDescriptor(
+        slug=f"{info.slug}{suffix}",
+        placeholders=placeholders,
+        fallback_name=fallback,
+    )
+
+
+def _build_measurement(obis: OBIS, info: OBISMeasurementInfo | None) -> OBISMeasurement:
+    """Assemble a complete OBISMeasurement object from parsed code and catalog info."""
+    descriptor = _describe_obis(obis, info)
+    canonical = obis.to_obis_string()
+
+    if info is None:
+        return OBISMeasurement(
+            code=obis,
+            canonical=canonical,
+            slug=descriptor.slug,
+            name=descriptor.fallback_name,
+            unit=None,
+            device_class=None,
+            state_class=None,
+            icon="mdi:gauge",
+            suggested_display_precision=None,
+            placeholders=descriptor.placeholders,
+            info=None,
+        )
+
+    return OBISMeasurement(
+        code=obis,
+        canonical=canonical,
+        slug=descriptor.slug,
+        name=descriptor.fallback_name,
+        unit=info.unit,
+        device_class=info.device_class,
+        state_class=info.state_class,
+        icon=info.icon,
+        suggested_display_precision=info.suggested_display_precision,
+        placeholders=descriptor.placeholders,
+        info=info,
+    )

obis_parser/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561.

obis_parser-0.0.1.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.5
+Name: obis-parser
+Version: 0.0.1
+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
+Author-email: Jannick Fahlbusch <git@jf-projects.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cosem,din-43863-3,energy,iec-62056-6-1,metering,obis,smart-meter,smgw,sml
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# obis-parser
+
+[![PyPI version](https://img.shields.io/pypi/v/obis-parser.svg)](https://pypi.org/project/obis-parser/)
+[![Python versions](https://img.shields.io/pypi/pyversions/obis-parser.svg)](https://pypi.org/project/obis-parser/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**Dependency-free OBIS parser and measurement catalog for smart meters and energy gateways**.
+
+Extracts, parses, and normalizes OBIS (*Object Identification System*) codes (`A-B:C.D.E*F`) across smart meters (eHZ / mME), optical IR readouts (SML / IEC 62056-21), P1/DSMR meters, and Smart Meter Gateways (SMGW).
+
+---
+
+## Features
+
+* **Zero External Dependencies:** Built entirely with standard library Python (`dataclasses`, `re`, `string`, `typing`).
+* **Universal Ingestion:** Auto-detects and parses:
+  * Canonical strings: `1-0:1.8.0`, `1-0:1.8.0*255`, `1-1:1.7.0`
+  * Bare COSEM 12-hex: `0100010800ff`, `0100100700ff`, `010001080000` (F=0)
+  * COSEM logical names with meter suffixes: `0100010800ff.1lgz0067285558.sm`
+  * Dot-separated hex: `01.00.01.08.00.FF`
+* **Single Domain Model (`OBIS`):** Everything is accessed directly on the `OBIS` instance (`.canonical`, `.name`, `.slug`, `.placeholders`, `.decode()`).
+* **Channel & Tariff Qualifiers:** Treats Channel ($B \neq 0$) and Tariff ($1 \le E < 255$) as name qualifiers on $(C, D)$ base measurements.
+* **4-Variant Localization Slugs:** Generates variant slugs (`base`, `_channel`, `_tariff`, `_channel_tariff`) with placeholder maps, ready for Home Assistant, Prometheus, or UI localization.
+* **Curated Catalog:** 31 standard German electricity registers (DIN EN 62056-6-1 / DIN 43863-3) with units, device classes, state classes, and icons.
+
+---
+
+## Installation
+
+```bash
+pip install obis-parser
+```
+
+or with [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv add obis-parser
+```
+
+---
+
+## Quick Start
+
+### 1. Basic Parsing & Properties
+
+```python
+from obis_parser import OBIS
+
+# Parses strings, bare-hex, dot-hex, or COSEM logical names
+obis = OBIS.parse("0100010800ff")
+if obis:
+    print(obis.canonical)      # "1-0:1.8.0" (or str(obis))
+    print(obis.name)           # "Active energy import"
+    print(obis.slug)           # "active_energy_import"
+    print(obis.is_electricity) # True
+    print(obis.channel)        # 0
+    print(obis.tariff)         # 0
+```
+
+### 2. Multi-Meter Channels & Tariffs
+
+```python
+# Multi-meter behind one gateway (Channel 1, Tariff 2)
+obis = OBIS.parse("1-1:1.8.2")
+if obis:
+    print(obis.canonical)    # "1-1:1.8.2"
+    print(obis.name)         # "Active energy import (Channel 1, Tariff 2)"
+    print(obis.slug)         # "active_energy_import_channel_tariff"
+    print(obis.placeholders) # {"channel": "1", "tariff": "2"}
+```
+
+### 3. Full Metadata Decode (`obis.decode()`)
+
+```python
+obis = OBIS.parse("0100200700ff")  # Voltage L1 (32.7.0)
+if obis:
+    m = obis.decode()
+    print(m.name)         # "Voltage L1"
+    print(m.unit)         # "V"
+    print(m.device_class) # "voltage"
+    print(m.state_class)  # "measurement"
+    print(m.icon)         # "mdi:sine-wave"
+```
+
+---
+
+## Supported Registers (Catalog Overview)
+
+| (C, D) | Measurement | Slug | Unit | Device Class | State Class |
+|---|---|---|---|---|---|
+| **(1, 8)** | Active energy import | `active_energy_import` | `kWh` | `energy` | `total_increasing` |
+| **(2, 8)** | Active energy export | `active_energy_export` | `kWh` | `energy` | `total_increasing` |
+| **(3, 8)** | Reactive energy import | `reactive_energy_import` | `kvarh` | `reactive_energy` | `total_increasing` |
+| **(4, 8)** | Reactive energy export | `reactive_energy_export` | `kvarh` | `reactive_energy` | `total_increasing` |
+| **(9, 8)** | Apparent energy | `apparent_energy` | `kVAh` | `None` | `total_increasing` |
+| **(1, 7)** | Active power import | `active_power_import` | `W` | `power` | `measurement` |
+| **(2, 7)** | Active power export | `active_power_export` | `W` | `power` | `measurement` |
+| **(3, 7)** | Reactive power import | `reactive_power_import` | `var` | `reactive_power` | `measurement` |
+| **(4, 7)** | Reactive power export | `reactive_power_export` | `var` | `reactive_power` | `measurement` |
+| **(9, 7)** | Apparent power | `apparent_power` | `VA` | `apparent_power` | `measurement` |
+| **(16, 7)** | Active power total (net sum) | `active_power_total` | `W` | `power` | `measurement` |
+| **(15, 7)** | Absolute active power (\|P\|) | `absolute_active_power` | `W` | `power` | `measurement` |
+| **(36/56/76, 7)** | Active power L1/L2/L3 (signed) | `active_power_l1..3` | `W` | `power` | `measurement` |
+| **(21/41/61, 7)** | Active power import L1/L2/L3 (+P) | `active_power_import_l1..3` | `W` | `power` | `measurement` |
+| **(22/42/62, 7)** | Active power export L1/L2/L3 (-P) | `active_power_export_l1..3` | `W` | `power` | `measurement` |
+| **(32/52/72, 7)** | Voltage L1/L2/L3 | `voltage_l1..3` | `V` | `voltage` | `measurement` |
+| **(12, 7)** | Voltage (total/RMS) | `voltage` | `V` | `voltage` | `measurement` |
+| **(31/51/71, 7)** | Current L1/L2/L3 | `current_l1..3` | `A` | `current` | `measurement` |
+| **(11, 7)** | Current (neutral/total) | `current` | `A` | `current` | `measurement` |
+| **(13, 7)** | Power factor ($\cos \varphi$) | `power_factor` | `None` | `power_factor` | `measurement` |
+| **(14, 7)** | Frequency | `frequency` | `Hz` | `frequency` | `measurement` |
+
+---
+
+## License
+
+Apache 2.0. Copyright 2026 Jannick Fahlbusch.

obis_parser-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+obis_parser/__init__.py,sha256=gKsQX_DpS4pHIj3zzBGElr3ee52-7FzBmRBHBqxX_KU,1601
+obis_parser/_version.py,sha256=8OsTLsIVB9D0HdPTmt5rVwyVUBe9xTVGkRslXicxzkM,520
+obis_parser/core.py,sha256=bJqa2IsHK1MyPfQNO9S4BdpRY2L9_8vt5a8_FqSDgtk,17070
+obis_parser/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+obis_parser-0.0.1.dist-info/METADATA,sha256=R61TzpafQSVi2Pg5qEKUCkKIWZsmYjAA3XwU_TXU5ec,6706
+obis_parser-0.0.1.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+obis_parser-0.0.1.dist-info/licenses/LICENSE,sha256=yjH7q_JxA9WnJMGfY1Pnwi0lLVLd19MRIfltsyl-gFc,10270
+obis_parser-0.0.1.dist-info/RECORD,,

obis_parser-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

obis_parser-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright 2026 Jannick Fahlbusch
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.