Skip to content

Commit

Permalink
docs/source/reference_api: update
Browse files Browse the repository at this point in the history
Run gen_sysobj_doc.m and commit the changes.

Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
  • Loading branch information
threexc committed Feb 5, 2025
1 parent 46d2f4a commit 15055e3
Show file tree
Hide file tree
Showing 24 changed files with 162 additions and 201 deletions.
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4000_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4000.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4000.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4000.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4000.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4000.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4000.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4001_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4001.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4001.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4001.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4001.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4001.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4001.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4002_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4002.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4002.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4002.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4002.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4002.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4002.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4003_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4003.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4003.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4003.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4003.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4003.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4003.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4004_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4004.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4004.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4004.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4004.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4004.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4004.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4005_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4005.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4005.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4005.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4005.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4005.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4005.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4006_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4006.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4006.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4006.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4006.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4006.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4006.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4007_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4007.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4007.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4007.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4007.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4007.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4007.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4008_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4008.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4008.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4008.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4008.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4008.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4008.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4010_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4010.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4010.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4010.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4010.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4010.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4010.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4011_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4011.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4011.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4011.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4011.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4011.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4011.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4020_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4020.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4020.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4020.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4020.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4020.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4020.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4021_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4021.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4021.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4021.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4021.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4021.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4021.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
15 changes: 6 additions & 9 deletions docs/source/reference_api/AD4022_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,14 @@ Class Properties
**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

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4022.Rx/SampleRate is inherited from superclass adi.AD400x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4022.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

**SamplesPerFrame Samples Per Frame**
Number of samples per frame, specified as an even positive integer.Help for adi.AD4022.Rx/SamplesPerFrame is inherited from superclass adi.AD400x.Base
**VoltageOffset - Voltage Offset**
ADC Voltage offset.

**VoltageOffset Voltage Offset**
ADC Voltage offset.Help for adi.AD4022.Rx/VoltageOffset is inherited from superclass adi.AD400x.Base

**VoltageScale Voltage Scale**
ADC Voltage scale.Help for adi.AD4022.Rx/VoltageScale is inherited from superclass adi.AD400x.Base
**VoltageScale - Voltage Scale**
ADC Voltage scale.

**URI - remote host URI**
Hostname or IP address of remote libIIO deviceHelp for adi.AD4022.Rx/uri is inherited from superclass matlabshared.libiio.base
Expand Down
10 changes: 5 additions & 5 deletions docs/source/reference_api/AD4030_Rx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ Class Properties
Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant

**SampleAveragingLength**
Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential modeHelp for adi.AD4030.Rx/SampleAveragingLength is inherited from superclass adi.AD463x.Base
Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential mode

**SampleRate Sample Rate**
Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4030.Rx/SampleRate is inherited from superclass adi.AD463x.Base
**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.Help for adi.AD4030.Rx/SamplesPerFrame is inherited from superclass adi.AD463x.Base
**Frame size**
Size of the frame in samplesHelp for adi.AD4030.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base

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

0 comments on commit 15055e3

Please sign in to comment.