Address review comments

Update tests
Remove offset attribute property from driver
Update scale as read-only attribute
Rename V to mV
Use argparse and update example script
Rename all occurances of ad7091r to ad7091rx

Signed-off-by: SGudla <[email protected]>

adi/__init__.py

@@ -23,7 +23,7 @@
 from adi.ad5754r import ad5754r
 from adi.ad5940 import ad5940
 from adi.ad6676 import ad6676
-from adi.ad7091r import ad7091rx
+from adi.ad7091rx import ad7091rx
 from adi.ad7124 import ad7124
 from adi.ad7134 import ad7134
 from adi.ad7291 import ad7291

adi/ad7091r.py → adi/ad7091rx.py

@@ -79,6 +79,7 @@ def __init__(self, uri="", device_name=""):
             name = ch._id
             self._rx_channel_names.append(name)
             self.channel.append(self._channel(self._ctrl, name))
+            setattr(self, name, self._channel(self._ctrl, name))
 
         rx.__init__(self)
 
@@ -94,24 +95,11 @@ def raw(self):
             """AD7091r channel raw value"""
             return self._get_iio_attr(self.name, "raw", False)
 
-        @property
-        def offset(self):
-            """AD7091r channel offset value"""
-            return self._get_iio_attr_str(self.name, "offset", False)
-
-        @offset.setter
-        def offset(self, value):
-            self._set_iio_attr(self.name, "offset", False, str(Decimal(value).real))
-
         @property
         def scale(self):
             """AD7091r channel scale"""
             return float(self._get_iio_attr_str(self.name, "scale", False))
 
-        @scale.setter
-        def scale(self, value):
-            self._set_iio_attr(self.name, "scale", False, str(Decimal(value).real))
-
         @property
         def thresh_falling_value(self):
             """Get channel threshold falling value"""
@@ -148,8 +136,8 @@ def thresh_either_hysteresis(self, value):
                 self.name, "thresh_either_hysteresis", False, str(Decimal(value))
             )
 
-    def to_volts(self, index, val):
-        """Converts raw value to SI"""
+    def to_mvolts(self, index, val):
+        """Converts raw value to mV"""
         _scale = self.channel[index].scale
 
         ret = None

doc/source/devices/adi.ad7091r.rst → doc/source/devices/adi.ad7091rx.rst

@@ -1,7 +1,7 @@
-ad7091r
+ad7091rx
 =================
 
-.. automodule:: adi.ad7091r
+.. automodule:: adi.ad7091rx
    :members:
    :undoc-members:
    :show-inheritance:

doc/source/devices/index.rst

@@ -23,7 +23,7 @@ Supported Devices
    adi.ad5754r
    adi.ad5940
    adi.ad6676
-   adi.ad7091r
+   adi.ad7091rx
    adi.ad7124
    adi.ad7134
    adi.ad717x

examples/ad7091r_example.py → examples/ad7091rx_example.py

@@ -31,34 +31,61 @@
 # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 # THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+import argparse
+
 import numpy as np
-from adi.ad7091r import ad7091rx
+from adi.ad7091rx import ad7091rx
+
+
+def main():
+    # Set up argument parser
+    parser = argparse.ArgumentParser(description="AD7091R Example Script")
+    parser.add_argument(
+        "--uri",
+        type=str,
+        help="The URI for the AD7091R device",
+        default="serial:COM7,230400,8n1",
+    )
+    parser.add_argument(
+        "--device_name",
+        type=str,
+        choices=["ad7091r-2", "ad7091r-4", "ad7091r-8"],
+        help="The device name (Supported devices are ad7091r-2, ad7091r-4, ad7091r-8)",
+        default="ad7091r-8",
+    )
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    # Set up AD7091R device
+    ad7091r_dev = ad7091rx(uri=args.uri, device_name=args.device_name)
+
+    # Get ADC channel 0 raw value and print it
+    raw = ad7091r_dev.channel[0].raw
+    print(f"Raw value read from channel0 is {raw}")
 
-# Set up AD7091r8
-ad7091r8_dev = ad7091rx(uri="serial:COM46,230400,8n1", device_name="ad7091r-8")
+    # Set threshold falling and rising values for channel 0
+    ad7091r_dev.channel[0].thresh_rising_value = 0x10F
+    print(
+        f"Channel 0 threshold rising value set to {ad7091r_dev.channel[0].thresh_rising_value}"
+    )
 
-# Get ADC channel 0 raw value and print it
-raw = ad7091r8_dev.channel[0].raw
-print(f"Raw value read from channel0 is {raw}")
+    ad7091r_dev.channel[0].thresh_falling_value = 0x0F
+    print(
+        f"Channel 0 threshold falling value set to {ad7091r_dev.channel[0].thresh_falling_value}"
+    )
 
-# Set threshold falling and rising values for channel 0
-ad7091r8_dev.channel[0].thresh_rising_value = 0x10F
-print(
-    f"Channel 0 threshold rising value set to {ad7091r8_dev.channel[0].thresh_rising_value}"
-)
+    # Capture a buffer of 100 samples from channel 0 and display them
+    chn = 0
+    ad7091r_dev._rx_data_type = np.int32
+    ad7091r_dev.rx_output_type = "raw"
+    ad7091r_dev.rx_enabled_channels = [chn]
+    ad7091r_dev.rx_buffer_size = 100
 
-ad7091r8_dev.channel[0].thresh_falling_value = 0x0F
-print(
-    f"Channel 0 threshold falling value set to {ad7091r8_dev.channel[0].thresh_falling_value}"
-)
+    data = ad7091r_dev.rx()
 
-# Capture a buffer of 100 samples from channel 0 and display them
-chn = 0
-ad7091r8_dev._rx_data_type = np.int32
-ad7091r8_dev.rx_output_type = "raw"
-ad7091r8_dev.rx_enabled_channels = [chn]
-ad7091r8_dev.rx_buffer_size = 100
+    print(data)
 
-data = ad7091r8_dev.rx()
 
-print(data)
+if __name__ == "__main__":
+    main()

test/emu/devices/ad7091rx.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><!DOCTYPE context [<!ELEMENT context (device | context-attribute)*><!ELEMENT context-attribute EMPTY><!ELEMENT device (channel | attribute | debug-attribute | buffer-attribute)*><!ELEMENT channel (scan-element?, attribute*)><!ELEMENT attribute EMPTY><!ELEMENT scan-element EMPTY><!ELEMENT debug-attribute EMPTY><!ELEMENT buffer-attribute EMPTY><!ATTLIST context name CDATA #REQUIRED description CDATA #IMPLIED><!ATTLIST context-attribute name CDATA #REQUIRED value CDATA #REQUIRED><!ATTLIST device id CDATA #REQUIRED name CDATA #IMPLIED><!ATTLIST channel id CDATA #REQUIRED type (input|output) #REQUIRED name CDATA #IMPLIED><!ATTLIST scan-element index CDATA #REQUIRED format CDATA #REQUIRED scale CDATA #IMPLIED><!ATTLIST attribute name CDATA #REQUIRED filename CDATA #IMPLIED value CDATA #IMPLIED><!ATTLIST debug-attribute name CDATA #REQUIRED value CDATA #IMPLIED><!ATTLIST buffer-attribute name CDATA #REQUIRED value CDATA #IMPLIED>]><context name="network" description="192.168.1.3 Linux raspberrypi 6.8.0-rc4-v8+ #4 SMP PREEMPT Thu Feb 15 10:45:25 -03 2024 aarch64" ><context-attribute name="local,kernel" value="6.8.0-rc4-v8+" /><context-attribute name="uri" value="ip:192.168.1.3" /><context-attribute name="ip,ip-addr" value="192.168.1.3" /><device id="iio:device0" name="ad7091r-8" ><channel id="voltage1" type="input" ><attribute name="raw" filename="in_voltage1_raw" value="2603" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage5" type="input" ><attribute name="raw" filename="in_voltage5_raw" value="0" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage2" type="input" ><attribute name="raw" filename="in_voltage2_raw" value="533" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage6" type="input" ><attribute name="raw" filename="in_voltage6_raw" value="1076" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage3" type="input" ><attribute name="raw" filename="in_voltage3_raw" value="1922" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage7" type="input" ><attribute name="raw" filename="in_voltage7_raw" value="1747" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage0" type="input" ><attribute name="raw" filename="in_voltage0_raw" value="2229" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><channel id="voltage4" type="input" ><attribute name="raw" filename="in_voltage4_raw" value="2376" /><attribute name="scale" filename="in_voltage_scale" value="0.610351562" /></channel><attribute name="waiting_for_supplier" value="0" /></device></context>

test/emu/hardware_map.yml

@@ -454,12 +454,12 @@ ad6676:
       - data_devices:
           - iio:device1
 
-ad7091r:
-  - ad7091r
+ad7091r8:
+  - ad7091r8
   - pyadi_iio_class_support:
-      - ad7091r
+      - ad7091rx
   - emulate:
-      - filename: ad7091r.xml
+      - filename: ad7091rx.xml
       - data_devices:
           - iio:device0
 

test/test_ad7091rx.py

@@ -0,0 +1,43 @@
+import pytest
+
+hardware = "ad7091r8"
+classname = "adi.ad7091rx"
+
+#########################################
+@pytest.mark.iio_hardware(hardware)
+@pytest.mark.parametrize("classname", [(classname)])
+@pytest.mark.parametrize(
+    "channel, attr", [("voltage0", "raw"), ("voltage1", "raw"),],
+)
+def test_ad7091rx_attr_single_value(
+    test_attribute_single_value_channel_readonly, iio_uri, classname, channel, attr
+):
+    test_attribute_single_value_channel_readonly(iio_uri, classname, channel, attr)
+
+
+#########################################
+@pytest.mark.iio_hardware(hardware)
+@pytest.mark.parametrize("classname", [(classname)])
+@pytest.mark.parametrize(
+    "attr, start, stop, step, tol, repeats, sub_channel",
+    [
+        ("raw", 0, 4000, 1000, 1, 3, "voltage0"),
+        ("raw", 0, 4000, 1000, 1, 3, "voltage1"),
+        ("raw", 0, 4000, 1000, 1, 3, "voltage2"),
+    ],
+)
+def test_ad7091rx_raw_attr(
+    test_attribute_single_value,
+    iio_uri,
+    classname,
+    attr,
+    start,
+    stop,
+    step,
+    tol,
+    repeats,
+    sub_channel,
+):
+    test_attribute_single_value(
+        iio_uri, classname, attr, start, stop, step, tol, repeats, sub_channel
+    )