feat: convert BACnet units to unit symbols (use SI where possible)

helper_scripts/check_bacnet_units.py

@@ -0,0 +1,48 @@
+# metricq-source-bacnet
+# Copyright (C) 2022 ZIH, Technische Universitaet Dresden, Federal Republic of Germany
+#
+# All rights reserved.
+#
+# This file is part of metricq-source-bacnet.
+#
+# metricq-source-bacnet is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# metricq-source-bacnet is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with metricq-source-bacnet.  If not, see <http://www.gnu.org/licenses/>.
+import click
+
+from bacpypes.basetypes import EngineeringUnits
+from metricq_source_bacnet.bacnet.constants import BACNET_TO_SI_UNITS
+
+@click.command()
+@click.option("--as-code/--no-as-code", default=False)
+@click.option("--all/--no-all", default=False)
+def main(all, as_code):
+    if not as_code:
+        print(f"{'#': <4} | {'BACnet': <32} | {'source-bacnet': <15}")
+        print(f"{'-'*4}-+-{'-'*32}-+-{'-'*15}")
+
+    for unit, int_value in EngineeringUnits.enumerations.items():
+        if int_value not in BACNET_TO_SI_UNITS:
+            if as_code:
+                print(f"{int_value}: \"{unit}\",")
+            else:
+                print(f"{int_value: <4} | {unit: <32} | {'-': <15}")
+        elif all:
+            if as_code:
+                print(f"{int_value}: \"{unit}\",  # {BACNET_TO_SI_UNITS[int_value]}")
+            else:
+                print(f"{int_value: <4} | {unit: <32} | {BACNET_TO_SI_UNITS[int_value]: <15}")
+
+
+
+if __name__ == "__main__":
+    main()

metricq_source_bacnet/bacnet/constants.py

@@ -0,0 +1,189 @@
+# metricq-source-bacnet
+# Copyright (C) 2022 ZIH, Technische Universitaet Dresden, Federal Republic of Germany
+#
+# All rights reserved.
+#
+# This file is part of metricq-source-bacnet.
+#
+# metricq-source-bacnet is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# metricq-source-bacnet is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with metricq-source-bacnet.  If not, see <http://www.gnu.org/licenses/>.
+
+BACNET_TO_SI_UNITS = {
+    166: "m/s²",
+    0: "m²",
+    116: "cm²",
+    2: "mA",
+    3: "A",
+    167: "A/m",
+    168: "A/m²",
+    169: "A m²",
+    199: "dB",
+    200: "dBmV",
+    201: "dBV",
+    170: "F",
+    171: "H",
+    4: "Ω",
+    172: "Ω m",
+    237: "Ω m m⁻²",
+    145: "mΩ",
+    122: "kΩ",
+    123: "MΩ",
+    190: "µS",
+    202: "mS",
+    173: "S",
+    174: "S/m",
+    175: "T",
+    5: "V",
+    124: "mV",
+    6: "kV",
+    7: "MV",
+    8: "V A",
+    9: "kV A",
+    10: "MV A",
+    238: "A s",
+    246: "A h²",
+    239: "V A h",
+    240: "kV A h",
+    241: "MV A h",
+    11: "var",
+    12: "kvar",
+    13: "Mvar",
+    176: "V/K",
+    177: "V/m",
+    245: "V h²",
+    178: "Wb",
+    16: "J",
+    17: "kJ",
+    125: "kJ/kg",
+    126: "MJ",
+    247: "J/h",
+    18: "W h",
+    19: "kW h",
+    146: "MW h",
+    127: "J/K",
+    151: "kJ/K",
+    152: "MJ/K",
+    128: "J kg⁻¹ K⁻¹",
+    153: "N",
+    27: "Hz",
+    129: "kHz",
+    130: "MHz",
+    131: "h⁻¹",
+    194: "µm",
+    30: "mm",
+    118: "cm",
+    193: "km",
+    31: "m",
+    179: "cd",
+    180: "cd/m²",
+    35: "W/m²",
+    36: "lm",
+    37: "lx",
+    196: "mg",
+    195: "g",
+    39: "kg",
+    41: "t",
+    154: "g/s",
+    155: "g/min",
+    42: "kg/s",
+    43: "kg/min",
+    44: "kg/h",
+    156: "t/h",
+    132: "mW",
+    47: "W",
+    48: "kW",
+    49: "MW",
+    53: "Pa",
+    133: "hPa",
+    54: "kPa",
+    253: "Pa s",
+    134: "mbar",
+    55: "bar",
+    62: "°C",
+    63: "K",
+    181: "K/h",
+    182: "K/min",
+    70: "d",
+    71: "h",
+    72: "min",
+    73: "s",
+    158: "cs",
+    159: "ms",
+    160: "N m",
+    161: "mm/s",
+    162: "mm/min",
+    74: "m/s",
+    163: "m/min",
+    164: "m/h",
+    75: "km/h",
+    80: "m³",
+    249: "m³/d",
+    197: "ml",
+    82: "l",
+    85: "m³/s",
+    165: "m³/min",
+    135: "m³/h",
+    198: "ml/s",
+    87: "l/s",
+    88: "l/min",
+    136: "l/h",
+    91: "°C/h",
+    92: "°C/min",
+    183: "J s",
+    186: "kg/m³",
+    137: "kW h m⁻²",
+    139: "MJ/m²",
+    187: "N s",
+    188: "N/m",
+    96: "ppm",
+    97: "ppb",
+    98: "%",
+    99: "%/s",
+    100: "min⁻¹",
+    101: "s⁻¹",
+    103: "rad",
+    184: "rad/s",
+    185: "m²/N",
+    189: "W m⁻¹ K⁻¹",
+    141: "W m⁻² K⁻¹",
+    207: "‰",
+    208: "g/g",
+    209: "kg/kg",
+    210: "g/kg",
+    211: "mg/g",
+    212: "mg/kg",
+    213: "g/ml",
+    214: "g/l",
+    215: "mg/l",
+    216: "µg/l",
+    217: "g /m³",
+    218: "mg/m³",
+    219: "µg/m³",
+    220: "ng/m³",
+    221: "g/cm³",
+    250: "W h/m³",
+    251: "J/m³",
+    222: "Bq",
+    223: "kBq",
+    224: "MBq",
+    225: "Gy",
+    226: "mGy",
+    227: "µGy",
+    228: "Sv",
+    229: "mSv",
+    230: "µSv",
+    231: "µSv/h",
+    234: "pH",
+    235: "g/m²",
+    236: "min/K",
+}

metricq_source_bacnet/source.py

@@ -28,9 +28,11 @@
 from typing import Dict, List, Optional, Tuple, Union, Set
 
 from bacpypes.pdu import Address
+from bacpypes.basetypes import EngineeringUnits
 from metricq import Source, Timedelta, Timestamp, get_logger, rpc_handler
 from metricq_source_bacnet.bacnet.application import BACnetMetricQReader
 from metricq_source_bacnet.bacnet.object_types import register_extended_object_types
+from metricq_source_bacnet.bacnet.constants import BACNET_TO_SI_UNITS
 
 logger = get_logger(__name__)
 
@@ -457,7 +459,13 @@ async def _worker_task(self, object_group, worker_task_stop_future):
                     description, self._object_description_vendor_specific_substitutions
                 )
             if "units" in object_info:
-                metadata["unit"] = object_info["units"]
+                # convert BACnet unit to SI
+                unit = object_info["units"]
+                if unit_int := EngineeringUnits.enumerations.get(unit):
+                    if unit_int in BACNET_TO_SI_UNITS:
+                        unit = BACNET_TO_SI_UNITS.get(unit_int)
+
+                metadata["unit"] = unit
 
             metrics[metric_id] = metadata
 

setup.py

@@ -4,7 +4,7 @@
     name="metricq_source_bacnet",
     version="0.1",
     author="TU Dresden",
-    python_requires=">=3.6",
+    python_requires=">=3.8",
     packages=find_packages(),
     scripts=[],
     entry_points="""