Skip to content

Commit

Permalink
Merge pull request #578 from jansunil/add-support-to-ad7134
Browse files Browse the repository at this point in the history
adi:ad7134: Add support for ad7134
  • Loading branch information
tfcollins authored Jun 24, 2024
2 parents 3824cc2 + 4352b32 commit 3e77082
Show file tree
Hide file tree
Showing 9 changed files with 180 additions and 1 deletion.
1 change: 1 addition & 0 deletions adi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from adi.ad5940 import ad5940
from adi.ad6676 import ad6676
from adi.ad7124 import ad7124
from adi.ad7134 import ad7134
from adi.ad7291 import ad7291
from adi.ad7606 import ad7606
from adi.ad7689 import ad7689
Expand Down
99 changes: 99 additions & 0 deletions adi/ad7134.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Copyright (C) 2024 Analog Devices, Inc.
#
# SPDX short identifier: ADIBSD

from decimal import Decimal

import numpy as np
from adi.attribute import attribute
from adi.context_manager import context_manager
from adi.rx_tx import rx


class ad7134(rx, context_manager):

""" AD7134 ADC """

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

def __init__(self, uri="", device_name=""):
"""Constructor for AD7134 class."""
context_manager.__init__(self, uri, self._device_name)

compatible_parts = ["ad7134", "ad4134"]

self._ctrl = None

if not device_name:
device_name = compatible_parts[0]
else:
if device_name not in compatible_parts:
raise Exception(f"Not a compatible device: {device_name}")

# Select the device matching device_name as working device
self._ctrl = self._ctx.find_device(device_name)
self._rxadc = self._ctx.find_device(device_name)

if not self._ctrl:
raise Exception(f"Cannot find IIO device {device_name}")

if not self._rxadc:
raise Exception(f"Cannot find IIO device {device_name}")

self.channels = []
for ch in self._ctrl.channels:
name = ch._id
self._rx_channel_names.append(name)
self.channel.append(self._channel(self._ctrl, name))

rx.__init__(self)

class _channel(attribute):

""" AD7134 channel """

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

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

@property
def scale(self):
"""AD7134 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 offset(self):
"""AD7134 channel offset"""
return float(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))

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

ret = None

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

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

if ret is None:
raise Exception("Error in converting to actual voltage")

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

.. automodule:: adi.ad7134
: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.ad5940
adi.ad6676
adi.ad7124
adi.ad7134
adi.ad717x
adi.ad719x
adi.ad7291
Expand Down
47 changes: 47 additions & 0 deletions examples/ad7134_example.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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 adi
import numpy as np

ad7134_dev = adi.ad7134("ip:analog")

chn = 0
ad7134_dev._rx_data_type = np.int32
ad7134_dev.rx_output_type = "SI"
ad7134_dev.rx_enabled_channels = [chn]
ad7134_dev.rx_buffer_size = 100

data = ad7134_dev.rx()

print(data)
2 changes: 2 additions & 0 deletions supported_parts.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
- AD4114
- AD4115
- AD4116
- AD4134
- AD4630
- AD4696
- AD4697
Expand Down Expand Up @@ -70,6 +71,7 @@
- AD5940
- AD6676
- AD7124
- AD7134
- AD7172-2
- AD7172-4
- AD7173-8
Expand Down
1 change: 1 addition & 0 deletions test/emu/devices/ad7134.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="serial" description="no-OS/projects/NO_OS_PROJECT NO_OS_VERSION" ><context-attribute name="hw_carrier" value="NUCLEO_H563ZI" /><context-attribute name="hw_mezzanine" value="EVAL-CN0561-ARDZ" /><context-attribute name="hw_name" value="EVAL-CN0561-ARDZ" /><context-attribute name="uri" value="serial:/dev/ttyS0,230400,8n1n" /><context-attribute name="serial,port" value="/dev/ttyS0" /><context-attribute name="serial,description" value="ttyS0" /><device id="iio:device0" name="ad4134" ><channel id="voltage0" name="voltage0" type="input" ><scan-element index="0" format="le:U16/16&gt;&gt;0" /><attribute name="raw" filename="in_voltage0_raw" value="61820" /><attribute name="scale" filename="in_voltage0_scale" value="ERROR" /><attribute name="offset" filename="in_voltage0_offset" value="-65535" /></channel><channel id="voltage1" name="voltage1" type="input" ><scan-element index="1" format="le:U16/16&gt;&gt;0" /><attribute name="raw" filename="in_voltage1_raw" value="24343" /><attribute name="scale" filename="in_voltage1_scale" value="ERROR" /><attribute name="offset" filename="in_voltage1_offset" value="0" /></channel><channel id="voltage2" name="voltage2" type="input" ><scan-element index="2" format="le:U16/16&gt;&gt;0" /><attribute name="raw" filename="in_voltage2_raw" value="50673" /><attribute name="scale" filename="in_voltage2_scale" value="ERROR" /><attribute name="offset" filename="in_voltage2_offset" value="-65535" /></channel><channel id="voltage3" name="voltage3" type="input" ><scan-element index="3" format="le:U16/16&gt;&gt;0" /><attribute name="raw" filename="in_voltage3_raw" value="15439" /><attribute name="scale" filename="in_voltage3_scale" value="ERROR" /><attribute name="offset" filename="in_voltage3_offset" value="0" /></channel><attribute name="sampling_frequency" value="500000" /><debug-attribute name="direct_reg_access" value="24" /></device><device id="trigger0" name="ad4134_iio_trigger" ></device></context>
11 changes: 10 additions & 1 deletion test/emu/hardware_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -591,4 +591,13 @@ ad405x:
- emulate:
- filename: ad405x.xml
- data_devices:
- iio:device0
- iio:device0

ad7134:
- ad4134
- emulate:
- filename: ad7134.xml
- data_devices:
- iio:device0
- pyadi_iio_class_support:
- ad7134
12 changes: 12 additions & 0 deletions test/test_ad7134.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import pytest

hardware = "ad7134"
classname = "adi.ad7134"


#########################################
@pytest.mark.iio_hardware(hardware, True)
@pytest.mark.parametrize("classname", [(classname)])
@pytest.mark.parametrize("channel", [0])
def test_ad7134_rx_data(test_dma_rx, iio_uri, classname, channel):
test_dma_rx(iio_uri, classname, channel)

0 comments on commit 3e77082

Please sign in to comment.