Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: analogdevicesinc/PrecisionToolbox
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 58f8c2996929450395eb61ec8ef3a9ad4d93cc3f
Choose a base ref
..
head repository: analogdevicesinc/PrecisionToolbox
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: f98c34c573d01ed823cce659a1e60e6c700e12f6
Choose a head ref
1 change: 0 additions & 1 deletion CI/gen_doc/docs/_pages/index.md
Original file line number Diff line number Diff line change
@@ -49,6 +49,5 @@ The following have device-specific implementations in MATLAB and Simulink. If a
| AD4020 | Zedboard | Yes | No | ADI (2021b) |
| AD4021 | Zedboard | Yes | No | ADI (2021b) |
| AD4022 | Zedboard | Yes | No | ADI (2021b) |
| AD4170 | Zedboard | Yes | No | ADI (2021b) |
| AD7124-4 | Zedboard | Yes | No | ADI (2021b) |
| AD7124-8 | Zedboard | Yes | No | ADI (2021b) |
1 change: 0 additions & 1 deletion CI/gen_doc/docs/gen_sysobj_doc.m
Original file line number Diff line number Diff line change
@@ -29,7 +29,6 @@
, {'AD4020', {'Rx'}}...
, {'AD4021', {'Rx'}}...
, {'AD4022', {'Rx'}}...
, {'AD4170', {'Rx'}}...
, {'AD5760', {'Tx'}}...
, {'AD5780', {'Tx'}}...
, {'AD5781', {'Tx'}}...
35 changes: 35 additions & 0 deletions docs/source/reference_api/AD4170_Rx.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
adi.AD4170.Rx
-------------

**AD4170 Precision ADC Class**

adi.AD4170.Rx Receives data from the AD4170 ADC
The adi.AD4170.Rx System object is a signal source that can receive
data from the AD4170.

`rx = adi.AD4170.Rx;`
`rx = adi.AD4170.Rx('serial:COM18,230400');`

`AD4170 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4170.pdf>`_

Class Properties
================

**AdcMode ADC Mode**
ADC Mode for data capture, represented as a string. It supports the following: 'Continuous_Conversion', 'Continuous_Conversion_FIR', 'Continuous_Conversion_IIR', 'Standby', 'Power_Down', 'Idle'

**EnabledChannels Enabled Channels**
Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant

**Fs Fs**
Fs for configuring the sampling rate of the device. It supports a numeric value. Please refer to the DS for more details on configuring FS

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4170.Rx/uri is inherited from superclass matlabshared.libiio.base

1 change: 1 addition & 0 deletions docs/source/reference_api/gen_sysobj_doc.m
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@
, {'AD4020', {'Rx'}}...
, {'AD4021', {'Rx'}}...
, {'AD4022', {'Rx'}}...
, {'AD4170', {'Rx'}}...
, {'AD5760', {'Tx'}}...
, {'AD5780', {'Tx'}}...
, {'AD5781', {'Tx'}}...
1 change: 1 addition & 0 deletions docs/source/reference_api/index.rst
Original file line number Diff line number Diff line change
@@ -27,6 +27,7 @@ Reference APIs
AD4020_Rx.rst
AD4021_Rx.rst
AD4022_Rx.rst
AD4170_Rx.rst
AD5760_Tx.rst
AD5780_Tx.rst
AD5781_Tx.rst