Merge pull request #43 from harp-tech/array-register-labels

Use index suffix for array register column labels

Author: glopesdev

harp/reader.py

@@ -256,8 +256,13 @@ def payload_parser(df: DataFrame):
         parser = _compose_parser(payload_parser, parser, params)
         return RegisterReader(register, reader, parser)
 
-    reader = partial(reader, columns=[name])
-    parser = partial(parser, columns=[name])
+    columns = (
+        [name]
+        if register.length is None or register.length == 1
+        else [f"{name}_{i}" for i in range(register.length)]
+    )
+    reader = partial(reader, columns=columns)
+    parser = partial(parser, columns=columns)
     return RegisterReader(register, reader, parser)
 
 

tests/data/device.yml

@@ -18,6 +18,12 @@ registers:
     type: U8
     maskType: DigitalInputs
     description: Reports the state of the digital input lines.
+  AnalogData:
+    address: 44
+    type: S16
+    length: 3
+    access: Event
+    description: Reports the current values of the analog input lines.
 bitMasks:
   DigitalInputs:
     description: Specifies the state of the digital input lines.

tests/data/device_44.bin

@@ -1,4 +1,4 @@
-import numpy as np
+import pandas as pd
 from pytest import mark
 
 from harp.io import REFERENCE_EPOCH, MessageType
@@ -9,12 +9,12 @@
     DeviceSchemaParam(
         path="data",
         expected_whoAmI=0,
-        expected_registers=["DigitalInputMode"],
+        expected_registers=["AnalogData"],
     ),
     DeviceSchemaParam(
         path="data/device.yml",
         expected_whoAmI=0,
-        expected_registers=["DigitalInputMode"],
+        expected_registers=["AnalogData"],
     ),
 ]
 
@@ -26,8 +26,13 @@ def test_create_reader(schemaFile: DeviceSchemaParam):
 
     whoAmI = reader.WhoAmI.read()
     assert reader.device.whoAmI == whoAmI.iloc[0, 0]
-    assert whoAmI.index.dtype.type == np.datetime64
+    assert isinstance(whoAmI.index, pd.DatetimeIndex)
 
     whoAmI = reader.WhoAmI.read(epoch=None, keep_type=True)
-    assert whoAmI.index.dtype.type == np.float64
+    assert isinstance(whoAmI.index, pd.Index)
     assert whoAmI.iloc[0, -1] == MessageType.READ.name
+
+    if schemaFile.expected_registers:
+        for register_name in schemaFile.expected_registers:
+            data = reader.registers[register_name].read()
+            assert isinstance(data.index, pd.DatetimeIndex)