Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for AD7091R-2, AD7091R-4 and AD7091R-8 #595

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions adi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from adi.ad5754r import ad5754r
from adi.ad5940 import ad5940
from adi.ad6676 import ad6676
from adi.ad7091rx import ad7091rx
from adi.ad7124 import ad7124
from adi.ad7134 import ad7134
from adi.ad7291 import ad7291
Expand Down
113 changes: 113 additions & 0 deletions adi/ad7091rx.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Copyright (C) 2024 Analog Devices, Inc.
#
# SPDX short identifier: ADIBSD
# Copyright (C) 2024 Analog Devices, Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
# - Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# - Neither the name of Analog Devices, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
# - The use of this software may or may not infringe the patent rights
# of one or more patent holders. This license does not release you
# from the requirement that you obtain separate licenses from these
# patent holders to use this software.
# - Use of the software either in source or binary form, must be run
# on or directly connected to an Analog Devices Inc. component.
#
# THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED.
#
# IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY
# RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# 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 numpy as np
from adi.attribute import attribute
from adi.context_manager import context_manager
from adi.rx_tx import rx


class ad7091rx(rx, context_manager):
"""AD7091R-2/AD7091R-4/AD7091R-8 SPI interface,
2-/4-/8-channel, 12-bit SAR ADC"""

_complex_data = False
channel = [] # type: ignore
_device_name = ""

def __init__(self, uri="", device_name=""):

context_manager.__init__(self, uri, self._device_name)

compatible_parts = [
"ad7091r-2",
"ad7091r-4",
"ad7091r-8",
]

self._ctrl = None

if not device_name:
device_name = compatible_parts[2]
else:
if device_name not in compatible_parts:
raise Exception("Not a compatible device: " + device_name)

# Selecting the device matching device_name AD7091RX family as working device.
for device in self._ctx.devices:
if device.name == device_name:
self._ctrl = device
self._rxadc = device
break

for ch in self._ctrl.channels:
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)

class _channel(attribute):
"""AD7091R-8/-4/-2 Input Voltage Channels"""

def __init__(self, ctrl, channel_name):
self.name = channel_name
self._ctrl = ctrl

@property
def raw(self):
"""AD7091r channel raw value"""
return self._get_iio_attr(self.name, "raw", False)

@property
def scale(self):
"""AD7091r channel scale"""
return float(self._get_iio_attr_str(self.name, "scale", False))

def to_mvolts(self, index, val):
"""Converts raw value to mV"""
_scale = self.channel[index].scale

ret = None

if isinstance(val, np.uint16):
ret = val * _scale

if isinstance(val, np.ndarray):
ret = [x * _scale for x in val]

return ret
7 changes: 7 additions & 0 deletions doc/source/devices/adi.ad7091rx.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ad7091rx
=================

.. automodule:: adi.ad7091rx
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions doc/source/devices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Supported Devices
adi.ad5754r
adi.ad5940
adi.ad6676
adi.ad7091rx
adi.ad7124
adi.ad7134
adi.ad717x
Expand Down
80 changes: 80 additions & 0 deletions examples/ad7091rx_example.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Copyright (C) 2024 Analog Devices, Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
# - Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# - Neither the name of Analog Devices, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
# - The use of this software may or may not infringe the patent rights
# of one or more patent holders. This license does not release you
# from the requirement that you obtain separate licenses from these
# patent holders to use this software.
# - Use of the software either in source or binary form, must be run
# on or directly connected to an Analog Devices Inc. component.
#
# THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED.
#
# IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY
# RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# 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.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}")

# 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

data = ad7091r_dev.rx()

print(data)
Comment on lines +67 to +76
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. It works with no-OS support but not with Linux because the driver developer (me) was silly enough to implement buffer support in no-OS but not in Linux 😅 . It would be nice if we somehow find a way to check whether the driver supports buffered reading and only do the buffer thing if it does. That way the example will not fail with linux. Though I think it is also fine to have it like it is now. Maybe I take the time to implement buffered read in linux someday.



if __name__ == "__main__":
main()
1 change: 1 addition & 0 deletions supported_parts.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
- AD5754R
- AD5940
- AD6676
- AD7091RX (AD7091R-2, AD7091R-4, AD7091R-8)
- AD7124
- AD7134
- AD7172-2
Expand Down
1 change: 1 addition & 0 deletions test/emu/devices/ad7091rx.xml
Original file line number Diff line number Diff line change
@@ -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>
9 changes: 9 additions & 0 deletions test/emu/hardware_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,15 @@ ad6676:
- data_devices:
- iio:device1

ad7091r8:
- ad7091r8
- pyadi_iio_class_support:
- ad7091rx
- emulate:
- filename: ad7091rx.xml
- data_devices:
- iio:device0

ad7768:
- ad7768
- pyadi_iio_class_support:
Expand Down
26 changes: 26 additions & 0 deletions test/test_ad7091rx.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import pytest

hardware = "ad7091r8"
classname = "adi.ad7091rx"

#########################################
@pytest.mark.iio_hardware(hardware)
@pytest.mark.parametrize("classname", [(classname)])
@pytest.mark.parametrize("attr", ["raw"])
@pytest.mark.parametrize(
"channel",
[
"voltage0",
"voltage1",
"voltage2",
"voltage3",
"voltage4",
"voltage5",
"voltage6",
"voltage7",
],
)
def test_ad7091rx_channel_attr_raw(
test_attribute_single_value_channel_readonly, iio_uri, classname, channel, attr
):
test_attribute_single_value_channel_readonly(iio_uri, classname, channel, attr)
Loading