From 239c4ee5a428b3322b4c6f77455cdfc8a61d99a6 Mon Sep 17 00:00:00 2001 From: RibhuDP Date: Wed, 3 Apr 2024 02:03:31 +0530 Subject: [PATCH] Remove matlab stuff and add complete index Signed-off-by: RibhuDP --- .github/workflows/doc.yml | 12 +---- docs/source/reference_api/AD2S1210_Rx.rst | 38 ++++++++++++++++ docs/source/reference_api/AD4000_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4001_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4002_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4003_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4004_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4005_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4006_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4007_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4008_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4010_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4011_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4020_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4021_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4022_Rx.rst | 35 ++++++++++++++ docs/source/reference_api/AD4030_Rx.rst | 32 +++++++++++++ docs/source/reference_api/AD4630_16_Rx.rst | 32 +++++++++++++ docs/source/reference_api/AD4630_24_Rx.rst | 32 +++++++++++++ docs/source/reference_api/AD4858_Rx.rst | 29 ++++++++++++ docs/source/reference_api/AD5760_Tx.rst | 53 ++++++++++++++++++++++ docs/source/reference_api/AD5780_Tx.rst | 53 ++++++++++++++++++++++ docs/source/reference_api/AD5781_Tx.rst | 53 ++++++++++++++++++++++ docs/source/reference_api/AD5790_Tx.rst | 53 ++++++++++++++++++++++ docs/source/reference_api/AD5791_Tx.rst | 53 ++++++++++++++++++++++ docs/source/reference_api/AD7124_4_Rx.rst | 38 ++++++++++++++++ docs/source/reference_api/AD7124_8_Rx.rst | 38 ++++++++++++++++ docs/source/reference_api/AD7380_Rx.rst | 29 ++++++++++++ docs/source/reference_api/AD7768_1_Rx.rst | 32 +++++++++++++ docs/source/reference_api/AD7768_Rx.rst | 29 ++++++++++++ docs/source/reference_api/gen_sysobj_doc.m | 9 +--- docs/source/reference_api/index.rst | 31 ++++++++++++- 32 files changed, 1116 insertions(+), 20 deletions(-) create mode 100644 docs/source/reference_api/AD2S1210_Rx.rst create mode 100644 docs/source/reference_api/AD4000_Rx.rst create mode 100644 docs/source/reference_api/AD4001_Rx.rst create mode 100644 docs/source/reference_api/AD4002_Rx.rst create mode 100644 docs/source/reference_api/AD4003_Rx.rst create mode 100644 docs/source/reference_api/AD4004_Rx.rst create mode 100644 docs/source/reference_api/AD4005_Rx.rst create mode 100644 docs/source/reference_api/AD4006_Rx.rst create mode 100644 docs/source/reference_api/AD4007_Rx.rst create mode 100644 docs/source/reference_api/AD4008_Rx.rst create mode 100644 docs/source/reference_api/AD4010_Rx.rst create mode 100644 docs/source/reference_api/AD4011_Rx.rst create mode 100644 docs/source/reference_api/AD4020_Rx.rst create mode 100644 docs/source/reference_api/AD4021_Rx.rst create mode 100644 docs/source/reference_api/AD4022_Rx.rst create mode 100644 docs/source/reference_api/AD4030_Rx.rst create mode 100644 docs/source/reference_api/AD4630_16_Rx.rst create mode 100644 docs/source/reference_api/AD4630_24_Rx.rst create mode 100644 docs/source/reference_api/AD4858_Rx.rst create mode 100644 docs/source/reference_api/AD5760_Tx.rst create mode 100644 docs/source/reference_api/AD5780_Tx.rst create mode 100644 docs/source/reference_api/AD5781_Tx.rst create mode 100644 docs/source/reference_api/AD5790_Tx.rst create mode 100644 docs/source/reference_api/AD5791_Tx.rst create mode 100644 docs/source/reference_api/AD7124_4_Rx.rst create mode 100644 docs/source/reference_api/AD7124_8_Rx.rst create mode 100644 docs/source/reference_api/AD7380_Rx.rst create mode 100644 docs/source/reference_api/AD7768_1_Rx.rst create mode 100644 docs/source/reference_api/AD7768_Rx.rst diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 2acb20e..7ba257b 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -22,17 +22,7 @@ jobs: python -m pip install sphinx-toolbox pip install sphinx myst_parser sudo apt-get install doxygen graphviz -y - - - name: Set up MATLAB - uses: matlab-actions/setup-matlab@v2 - with: - release: R2021b - - - name: Run script - uses: matlab-actions/run-command@v2 - with: - command: addpath(genpath(pwd)), cd docs/source/reference_api, gen_sysobj_doc - + - name: Check doc build run: | cd docs diff --git a/docs/source/reference_api/AD2S1210_Rx.rst b/docs/source/reference_api/AD2S1210_Rx.rst new file mode 100644 index 0000000..0e9ef16 --- /dev/null +++ b/docs/source/reference_api/AD2S1210_Rx.rst @@ -0,0 +1,38 @@ +adi.AD2S1210.Rx +--------------- + +**AD2S1210 Resolver-to-Digital Converter Class** + +adi.AD2S1210.Rx Receives data from the AD2S1210 Resolver +The adi.AD2S1210.Rx System object is a signal source that can receive +data from the AD2S1210. + +`rx = adi.AD2S1210.Rx;` +`rx = adi.AD2S1210.Rx('uri','192.168.2.1');` + +`AD2S1210 Datasheet `_ + +Class Properties +================ + +**Angle** + Resolver angle in Degrees. + +**AngleScale Angular Scale** + Resolver angle scale. + +**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 + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer. + +**Velocity Angular Velocity** + Resolver velocity in revolutions per second. + +**VelocityScale Velocity Angular Scale** + Resolver velocityscale. + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD2S1210.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4000_Rx.rst b/docs/source/reference_api/AD4000_Rx.rst new file mode 100644 index 0000000..19f1a80 --- /dev/null +++ b/docs/source/reference_api/AD4000_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4000.Rx +------------- + +**AD4000 Precision ADC Class** + +adi.AD4000.Rx Receives data from the AD4000 ADC +The adi.AD4000.Rx System object is a signal source that can receive +data from the AD4000. + +`rx = adi.AD4000.Rx;` +`rx = adi.AD4000.Rx('uri','192.168.2.1');` + +`AD4000 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4000.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4001_Rx.rst b/docs/source/reference_api/AD4001_Rx.rst new file mode 100644 index 0000000..174680f --- /dev/null +++ b/docs/source/reference_api/AD4001_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4001.Rx +------------- + +**AD4001 Precision ADC Class** + +adi.AD4001.Rx Receives data from the AD4001 ADC +The adi.AD4001.Rx System object is a signal source that can receive +data from the AD4001. + +`rx = adi.AD4001.Rx;` +`rx = adi.AD4001.Rx('uri','192.168.2.1');` + +`AD4001 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4001.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4002_Rx.rst b/docs/source/reference_api/AD4002_Rx.rst new file mode 100644 index 0000000..fcb989e --- /dev/null +++ b/docs/source/reference_api/AD4002_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4002.Rx +------------- + +**AD4002 Precision ADC Class** + +adi.AD4002.Rx Receives data from the AD4002 ADC +The adi.AD4002.Rx System object is a signal source that can receive +data from the AD4002. + +`rx = adi.AD4002.Rx;` +`rx = adi.AD4002.Rx('uri','192.168.2.1');` + +`AD4002 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4002.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4003_Rx.rst b/docs/source/reference_api/AD4003_Rx.rst new file mode 100644 index 0000000..042d01f --- /dev/null +++ b/docs/source/reference_api/AD4003_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4003.Rx +------------- + +**AD4003 Precision ADC Class** + +adi.AD4003.Rx Receives data from the AD4003 ADC +The adi.AD4003.Rx System object is a signal source that can receive +data from the AD4003. + +`rx = adi.AD4003.Rx;` +`rx = adi.AD4003.Rx('uri','192.168.2.1');` + +`AD4003 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4003.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4004_Rx.rst b/docs/source/reference_api/AD4004_Rx.rst new file mode 100644 index 0000000..1269916 --- /dev/null +++ b/docs/source/reference_api/AD4004_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4004.Rx +------------- + +**AD4004 Precision ADC Class** + +adi.AD4004.Rx Receives data from the AD4004 ADC +The adi.AD4004.Rx System object is a signal source that can receive +data from the AD4004. + +`rx = adi.AD4004.Rx;` +`rx = adi.AD4004.Rx('uri','192.168.2.1');` + +`AD4004 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4004.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4005_Rx.rst b/docs/source/reference_api/AD4005_Rx.rst new file mode 100644 index 0000000..f41fc76 --- /dev/null +++ b/docs/source/reference_api/AD4005_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4005.Rx +------------- + +**AD4005 Precision ADC Class** + +adi.AD4005.Rx Receives data from the AD4005 ADC +The adi.AD4005.Rx System object is a signal source that can receive +data from the AD4005. + +`rx = adi.AD4005.Rx;` +`rx = adi.AD4005.Rx('uri','192.168.2.1');` + +`AD4005 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4005.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4006_Rx.rst b/docs/source/reference_api/AD4006_Rx.rst new file mode 100644 index 0000000..9a60832 --- /dev/null +++ b/docs/source/reference_api/AD4006_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4006.Rx +------------- + +**AD4006 Precision ADC Class** + +adi.AD4006.Rx Receives data from the AD4006 ADC +The adi.AD4006.Rx System object is a signal source that can receive +data from the AD4006. + +`rx = adi.AD4006.Rx;` +`rx = adi.AD4006.Rx('uri','192.168.2.1');` + +`AD4006 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4006.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4007_Rx.rst b/docs/source/reference_api/AD4007_Rx.rst new file mode 100644 index 0000000..7e8ff95 --- /dev/null +++ b/docs/source/reference_api/AD4007_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4007.Rx +------------- + +**AD4007 Precision ADC Class** + +adi.AD4007.Rx Receives data from the AD4007 ADC +The adi.AD4007.Rx System object is a signal source that can receive +data from the AD4007. + +`rx = adi.AD4007.Rx;` +`rx = adi.AD4007.Rx('uri','192.168.2.1');` + +`AD4007 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4007.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4008_Rx.rst b/docs/source/reference_api/AD4008_Rx.rst new file mode 100644 index 0000000..63acf70 --- /dev/null +++ b/docs/source/reference_api/AD4008_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4008.Rx +------------- + +**AD4008 Precision ADC Class** + +adi.AD4008.Rx Receives data from the AD4008 ADC +The adi.AD4008.Rx System object is a signal source that can receive +data from the AD4008. + +`rx = adi.AD4008.Rx;` +`rx = adi.AD4008.Rx('uri','192.168.2.1');` + +`AD4008 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4008.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4010_Rx.rst b/docs/source/reference_api/AD4010_Rx.rst new file mode 100644 index 0000000..8dc97a8 --- /dev/null +++ b/docs/source/reference_api/AD4010_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4010.Rx +------------- + +**AD4010 Precision ADC Class** + +adi.AD4010.Rx Receives data from the AD4010 ADC +The adi.AD4010.Rx System object is a signal source that can receive +data from the AD4010. + +`rx = adi.AD4010.Rx;` +`rx = adi.AD4010.Rx('uri','192.168.2.1');` + +`AD4010 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4010.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4011_Rx.rst b/docs/source/reference_api/AD4011_Rx.rst new file mode 100644 index 0000000..5888bb4 --- /dev/null +++ b/docs/source/reference_api/AD4011_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4011.Rx +------------- + +**AD4011 Precision ADC Class** + +adi.AD4011.Rx Receives data from the AD4011 ADC +The adi.AD4011.Rx System object is a signal source that can receive +data from the AD4011. + +`rx = adi.AD4011.Rx;` +`rx = adi.AD4011.Rx('uri','192.168.2.1');` + +`AD4011 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4011.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4020_Rx.rst b/docs/source/reference_api/AD4020_Rx.rst new file mode 100644 index 0000000..079dd6b --- /dev/null +++ b/docs/source/reference_api/AD4020_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4020.Rx +------------- + +**AD4020 Precision ADC Class** + +adi.AD4020.Rx Receives data from the AD4020 ADC +The adi.AD4020.Rx System object is a signal source that can receive +data from the AD4020. + +rx = adi.AD4020.Rx; +rx = adi.AD4020.Rx('uri','192.168.2.1'); + +`AD4020 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4020.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4021_Rx.rst b/docs/source/reference_api/AD4021_Rx.rst new file mode 100644 index 0000000..e80171d --- /dev/null +++ b/docs/source/reference_api/AD4021_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4021.Rx +------------- + +**AD4021 Precision ADC Class** + +adi.AD4021.Rx Receives data from the AD4021 ADC +The adi.AD4021.Rx System object is a signal source that can receive +data from the AD4021. + +`rx = adi.AD4021.Rx;` +`rx = adi.AD4021.Rx('uri','192.168.2.1');` + +`AD4021 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4021.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4022_Rx.rst b/docs/source/reference_api/AD4022_Rx.rst new file mode 100644 index 0000000..3fcb07b --- /dev/null +++ b/docs/source/reference_api/AD4022_Rx.rst @@ -0,0 +1,35 @@ +adi.AD4022.Rx +------------- + +**AD4022 Precision ADC Class** + +adi.AD4022.Rx Receives data from the AD4022 ADC +The adi.AD4022.Rx System object is a signal source that can receive +data from the AD4022. + +`rx = adi.AD4022.Rx;` +`rx = adi.AD4022.Rx('uri','192.168.2.1');` + +`AD4022 Datasheet `_ + +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 + +**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.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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4022.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4030_Rx.rst b/docs/source/reference_api/AD4030_Rx.rst new file mode 100644 index 0000000..f02abbd --- /dev/null +++ b/docs/source/reference_api/AD4030_Rx.rst @@ -0,0 +1,32 @@ +adi.AD4030.Rx +------------- + +**AD4030-24 Precision ADC Class** + +adi.AD4030.Rx Receives data from the AD4030-24 ADC +The adi.AD4030.Rx System object is a signal source that can receive +data from the AD4030-24. + +`rx = adi.AD4030.Rx;` +`rx = adi.AD4030.Rx('uri','192.168.2.1');` + +`AD4030-24 Datasheet `_ + +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 + +**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 + +**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 + +**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 + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4030.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4630_16_Rx.rst b/docs/source/reference_api/AD4630_16_Rx.rst new file mode 100644 index 0000000..b4c1da9 --- /dev/null +++ b/docs/source/reference_api/AD4630_16_Rx.rst @@ -0,0 +1,32 @@ +adi.AD4630_16.Rx +---------------- + +**AD4630-16 Precision ADC Class** + +adi.AD4630_16.Rx Receive data from the AD4630-16 ADC +The adi.AD4630_16.Rx System object is a signal source that can receive +data from the AD4630-16. + +`rx = adi.AD4630_16.Rx;` +`rx = adi.AD4630_16.Rx('uri','192.168.2.1');` + +`AD4630-16 Datasheet `_ + +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 + +**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.AD4630_16.Rx/SampleAveragingLength is inherited from superclass adi.AD463x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4630_16.Rx/SampleRate is inherited from superclass adi.AD463x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer.Help for adi.AD4630_16.Rx/SamplesPerFrame is inherited from superclass adi.AD463x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4630_16.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4630_24_Rx.rst b/docs/source/reference_api/AD4630_24_Rx.rst new file mode 100644 index 0000000..86113c0 --- /dev/null +++ b/docs/source/reference_api/AD4630_24_Rx.rst @@ -0,0 +1,32 @@ +adi.AD4630_24.Rx +---------------- + +**AD4630-24 Precision ADC Class** + +adi.AD4630_24.Rx Receive data from the AD4630-24 ADC +The adi.AD4630_24.Rx System object is a signal source that can receive +data from the AD4630-24. + +`rx = adi.AD4630_24.Rx;` +`rx = adi.AD4630_24.Rx('uri','192.168.2.1');` + +`AD4630-24 Datasheet `_ + +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 + +**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.AD4630_24.Rx/SampleAveragingLength is inherited from superclass adi.AD463x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4630_24.Rx/SampleRate is inherited from superclass adi.AD463x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer.Help for adi.AD4630_24.Rx/SamplesPerFrame is inherited from superclass adi.AD463x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD4630_24.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD4858_Rx.rst b/docs/source/reference_api/AD4858_Rx.rst new file mode 100644 index 0000000..e4d301b --- /dev/null +++ b/docs/source/reference_api/AD4858_Rx.rst @@ -0,0 +1,29 @@ +adi.AD4858.Rx +------------- + +**AD4858 Precision ADC Class** + +adi.AD4858.Rx Receives data from the AD4858 ADC +The adi.AD4858.Rx System object is a signal source that can receive +data from the AD4858. + +`rx = adi.AD4858.Rx;` +`rx = adi.AD4858.Rx('uri','192.168.2.1');` + +`AD4858 Datasheet `_ + +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. + +**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.AD4858.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD5760_Tx.rst b/docs/source/reference_api/AD5760_Tx.rst new file mode 100644 index 0000000..9f43205 --- /dev/null +++ b/docs/source/reference_api/AD5760_Tx.rst @@ -0,0 +1,53 @@ +adi.AD5760.Tx +------------- + +**AD5760 Voltage output DAC Class** + +adi.AD5760.Tx Transmits data to the AD5760 DAC +The adi.AD5760.Tx System object is a signal sink that can transmit +data to the AD5760. + +`tx = adi.AD5760.Tx;` +`tx = adi.AD5760.Tx('uri','ip:192.168.2.1');` + +`AD5760 Datasheet `_ + +Class Properties +================ + +**CodeSelect Code Select** + Set to 2s_complement/offset_binaryHelp for adi.AD5760.Tx/CodeSelect is inherited from superclass adi.AD579x.Base + +**DDSFrequencies DDS Frequencies** + Frequencies values in Hz of the DDS tone generators. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5760.Tx/DDSFrequencies is inherited from superclass adi.common.DDS + +**DDSPhases DDS Phases** + Phases of DDS tones in range [0,360000]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5760.Tx/DDSPhases is inherited from superclass adi.common.DDS + +**DDSScales DDS Scales** + Scale of DDS tones in range [0,1]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5760.Tx/DDSScales is inherited from superclass adi.common.DDS + +**DataSource Data Source** + Data source, specified as one of the following: 'DMA' — Specify the host as the source of the data. 'DDS' — Specify the DDS on the radio hardware as the source of the data. In this case, each channel has two additive tones.Help for adi.AD5760.Tx/DataSource is inherited from superclass adi.common.DDS + +**EnableCyclicBuffers Enable Cyclic Buffers** + Enable Cyclic Buffers, configures transmit buffers to be cyclic, which makes them continuously repeatHelp for adi.AD5760.Tx/EnableCyclicBuffers is inherited from superclass adi.common.DDS + +**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 + +**PowerDown Power Down** + Set to true/false to power-up/power-down the device channelsHelp for adi.AD5760.Tx/PowerDown is inherited from superclass adi.AD579x.Base + +**Raw Channel Raw Value** + Help for adi.AD5760.Tx/Raw is inherited from superclass adi.AD579x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second. Help for adi.AD5760.Tx/SampleRate is inherited from superclass adi.AD579x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer. Help for adi.AD5760.Tx/SamplesPerFrame is inherited from superclass adi.AD579x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD5760.Tx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD5780_Tx.rst b/docs/source/reference_api/AD5780_Tx.rst new file mode 100644 index 0000000..e402756 --- /dev/null +++ b/docs/source/reference_api/AD5780_Tx.rst @@ -0,0 +1,53 @@ +adi.AD5780.Tx +------------- + +**AD5780 Voltage output DAC Class** + +adi.AD5780.Tx Transmits data to the AD5780 DAC +The adi.AD5780.Tx System object is a signal sink that can transmit +data to the AD5780. + +`tx = adi.AD5780.Tx;` +`tx = adi.AD5780.Tx('uri','ip:192.168.2.1');` + +`AD5780 Datasheet `_ + +Class Properties +================ + +**CodeSelect Code Select** + Set to 2s_complement/offset_binaryHelp for adi.AD5780.Tx/CodeSelect is inherited from superclass adi.AD579x.Base + +**DDSFrequencies DDS Frequencies** + Frequencies values in Hz of the DDS tone generators. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5780.Tx/DDSFrequencies is inherited from superclass adi.common.DDS + +**DDSPhases DDS Phases** + Phases of DDS tones in range [0,360000]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5780.Tx/DDSPhases is inherited from superclass adi.common.DDS + +**DDSScales DDS Scales** + Scale of DDS tones in range [0,1]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5780.Tx/DDSScales is inherited from superclass adi.common.DDS + +**DataSource Data Source** + Data source, specified as one of the following: 'DMA' — Specify the host as the source of the data. 'DDS' — Specify the DDS on the radio hardware as the source of the data. In this case, each channel has two additive tones.Help for adi.AD5780.Tx/DataSource is inherited from superclass adi.common.DDS + +**EnableCyclicBuffers Enable Cyclic Buffers** + Enable Cyclic Buffers, configures transmit buffers to be cyclic, which makes them continuously repeatHelp for adi.AD5780.Tx/EnableCyclicBuffers is inherited from superclass adi.common.DDS + +**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 + +**PowerDown Power Down** + Set to true/false to power-up/power-down the device channelsHelp for adi.AD5780.Tx/PowerDown is inherited from superclass adi.AD579x.Base + +**Raw Channel Raw Value** + Help for adi.AD5780.Tx/Raw is inherited from superclass adi.AD579x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second. Help for adi.AD5780.Tx/SampleRate is inherited from superclass adi.AD579x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer. Help for adi.AD5780.Tx/SamplesPerFrame is inherited from superclass adi.AD579x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD5780.Tx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD5781_Tx.rst b/docs/source/reference_api/AD5781_Tx.rst new file mode 100644 index 0000000..0f1156d --- /dev/null +++ b/docs/source/reference_api/AD5781_Tx.rst @@ -0,0 +1,53 @@ +adi.AD5781.Tx +------------- + +**AD5781 Voltage output DAC Class** + +adi.AD5781.Tx Transmits data to the AD5781 DAC +The adi.AD5781.Tx System object is a signal sink that can transmit +data to the AD5781. + +`tx = adi.AD5781.Tx;` +`tx = adi.AD5781.Tx('uri','ip:192.168.2.1');` + +`AD5781 Datasheet `_ + +Class Properties +================ + +**CodeSelect Code Select** + Set to 2s_complement/offset_binaryHelp for adi.AD5781.Tx/CodeSelect is inherited from superclass adi.AD579x.Base + +**DDSFrequencies DDS Frequencies** + Frequencies values in Hz of the DDS tone generators. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5781.Tx/DDSFrequencies is inherited from superclass adi.common.DDS + +**DDSPhases DDS Phases** + Phases of DDS tones in range [0,360000]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5781.Tx/DDSPhases is inherited from superclass adi.common.DDS + +**DDSScales DDS Scales** + Scale of DDS tones in range [0,1]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5781.Tx/DDSScales is inherited from superclass adi.common.DDS + +**DataSource Data Source** + Data source, specified as one of the following: 'DMA' — Specify the host as the source of the data. 'DDS' — Specify the DDS on the radio hardware as the source of the data. In this case, each channel has two additive tones.Help for adi.AD5781.Tx/DataSource is inherited from superclass adi.common.DDS + +**EnableCyclicBuffers Enable Cyclic Buffers** + Enable Cyclic Buffers, configures transmit buffers to be cyclic, which makes them continuously repeatHelp for adi.AD5781.Tx/EnableCyclicBuffers is inherited from superclass adi.common.DDS + +**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 + +**PowerDown Power Down** + Set to true/false to power-up/power-down the device channelsHelp for adi.AD5781.Tx/PowerDown is inherited from superclass adi.AD579x.Base + +**Raw Channel Raw Value** + Help for adi.AD5781.Tx/Raw is inherited from superclass adi.AD579x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second. Help for adi.AD5781.Tx/SampleRate is inherited from superclass adi.AD579x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer. Help for adi.AD5781.Tx/SamplesPerFrame is inherited from superclass adi.AD579x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD5781.Tx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD5790_Tx.rst b/docs/source/reference_api/AD5790_Tx.rst new file mode 100644 index 0000000..c3ae293 --- /dev/null +++ b/docs/source/reference_api/AD5790_Tx.rst @@ -0,0 +1,53 @@ +adi.AD5790.Tx +------------- + +**AD5790 Voltage output DAC Class** + +adi.AD5790.Tx Transmits data to the AD5790 DAC +The adi.AD5790.Tx System object is a signal sink that can transmit +data to the AD5790. + +`tx = adi.AD5790.Tx;` +`tx = adi.AD5790.Tx('uri','ip:192.168.2.1');` + +`AD5790 Datasheet `_ + +Class Properties +================ + +**CodeSelect Code Select** + Set to 2s_complement/offset_binaryHelp for adi.AD5790.Tx/CodeSelect is inherited from superclass adi.AD579x.Base + +**DDSFrequencies DDS Frequencies** + Frequencies values in Hz of the DDS tone generators. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5790.Tx/DDSFrequencies is inherited from superclass adi.common.DDS + +**DDSPhases DDS Phases** + Phases of DDS tones in range [0,360000]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5790.Tx/DDSPhases is inherited from superclass adi.common.DDS + +**DDSScales DDS Scales** + Scale of DDS tones in range [0,1]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5790.Tx/DDSScales is inherited from superclass adi.common.DDS + +**DataSource Data Source** + Data source, specified as one of the following: 'DMA' — Specify the host as the source of the data. 'DDS' — Specify the DDS on the radio hardware as the source of the data. In this case, each channel has two additive tones.Help for adi.AD5790.Tx/DataSource is inherited from superclass adi.common.DDS + +**EnableCyclicBuffers Enable Cyclic Buffers** + Enable Cyclic Buffers, configures transmit buffers to be cyclic, which makes them continuously repeatHelp for adi.AD5790.Tx/EnableCyclicBuffers is inherited from superclass adi.common.DDS + +**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 + +**PowerDown Power Down** + Set to true/false to power-up/power-down the device channelsHelp for adi.AD5790.Tx/PowerDown is inherited from superclass adi.AD579x.Base + +**Raw Channel Raw Value** + Help for adi.AD5790.Tx/Raw is inherited from superclass adi.AD579x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second. Help for adi.AD5790.Tx/SampleRate is inherited from superclass adi.AD579x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer. Help for adi.AD5790.Tx/SamplesPerFrame is inherited from superclass adi.AD579x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD5790.Tx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD5791_Tx.rst b/docs/source/reference_api/AD5791_Tx.rst new file mode 100644 index 0000000..3f86a53 --- /dev/null +++ b/docs/source/reference_api/AD5791_Tx.rst @@ -0,0 +1,53 @@ +adi.AD5791.Tx +------------- + +**AD5791 Voltage output DAC Class** + +adi.AD5791.Tx Transmits data to the AD5791 DAC +The adi.AD5791.Tx System object is a signal sink that can transmit +data to the AD5791. + +`tx = adi.AD5791.Tx;` +`tx = adi.AD5791.Tx('uri','ip:192.168.2.1');` + +`AD5791 Datasheet `_ + +Class Properties +================ + +**CodeSelect Code Select** + Set to 2s_complement/offset_binaryHelp for adi.AD5791.Tx/CodeSelect is inherited from superclass adi.AD579x.Base + +**DDSFrequencies DDS Frequencies** + Frequencies values in Hz of the DDS tone generators. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5791.Tx/DDSFrequencies is inherited from superclass adi.common.DDS + +**DDSPhases DDS Phases** + Phases of DDS tones in range [0,360000]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5791.Tx/DDSPhases is inherited from superclass adi.common.DDS + +**DDSScales DDS Scales** + Scale of DDS tones in range [0,1]. For complex data devices the input is a [2xN] matrix where N is the available channels on the board. For complex data devices this is at most max(EnabledChannels)*2. For non-complex data devices this is at most max(EnabledChannels). If N < this upper limit, other DDSs are not set.Help for adi.AD5791.Tx/DDSScales is inherited from superclass adi.common.DDS + +**DataSource Data Source** + Data source, specified as one of the following: 'DMA' — Specify the host as the source of the data. 'DDS' — Specify the DDS on the radio hardware as the source of the data. In this case, each channel has two additive tones.Help for adi.AD5791.Tx/DataSource is inherited from superclass adi.common.DDS + +**EnableCyclicBuffers Enable Cyclic Buffers** + Enable Cyclic Buffers, configures transmit buffers to be cyclic, which makes them continuously repeatHelp for adi.AD5791.Tx/EnableCyclicBuffers is inherited from superclass adi.common.DDS + +**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 + +**PowerDown Power Down** + Set to true/false to power-up/power-down the device channelsHelp for adi.AD5791.Tx/PowerDown is inherited from superclass adi.AD579x.Base + +**Raw Channel Raw Value** + Help for adi.AD5791.Tx/Raw is inherited from superclass adi.AD579x.Base + +**SampleRate Sample Rate** + Baseband sampling rate in Hz, specified as a scalar in samples per second. Help for adi.AD5791.Tx/SampleRate is inherited from superclass adi.AD579x.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer. Help for adi.AD5791.Tx/SamplesPerFrame is inherited from superclass adi.AD579x.Base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD5791.Tx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD7124_4_Rx.rst b/docs/source/reference_api/AD7124_4_Rx.rst new file mode 100644 index 0000000..dd2fd7a --- /dev/null +++ b/docs/source/reference_api/AD7124_4_Rx.rst @@ -0,0 +1,38 @@ +adi.AD7124_4.Rx +--------------- + +**AD7124-4 Precision ADC Class** + +adi.AD7124-4.Rx Receives data from the AD7124 ADC +The adi.AD7124-4.Rx System object is a signal source that can receive +data from the AD7124-4. + +`rx = adi.AD7124_4.Rx;` +`rx = adi.AD7124_4.Rx('uri','ip:192.168.2.1');` + +`AD7124-4 Datasheet `_ + +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.AD7124_4.Rx/SampleRate is inherited from superclass adi.AD7124.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer.Help for adi.AD7124_4.Rx/SamplesPerFrame is inherited from superclass adi.AD7124.Base + +**Data type for the output data** + A String Representing the data typeHelp for adi.AD7124_4.Rx/dataTypeStr is inherited from superclass matlabshared.libiio.base + +**Device name** + Name of the libIIO deviceHelp for adi.AD7124_4.Rx/devName is inherited from superclass matlabshared.libiio.base + +**Kernel buffers count** + The number of buffers allocated in the kernel for data transfersHelp for adi.AD7124_4.Rx/kernelBuffersCount is inherited from superclass matlabshared.libiio.base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD7124_4.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD7124_8_Rx.rst b/docs/source/reference_api/AD7124_8_Rx.rst new file mode 100644 index 0000000..b73fa23 --- /dev/null +++ b/docs/source/reference_api/AD7124_8_Rx.rst @@ -0,0 +1,38 @@ +adi.AD7124_8.Rx +--------------- + +**AD7124-8 Precision ADC Class** + +adi.AD7124-8.Rx Receives data from the AD7124 ADC +The adi.AD7124-8.Rx System object is a signal source that can receive +data from the AD7124-8. + +`rx = adi.AD7124_8.Rx;` +`rx = adi.AD7124_8.Rx('uri','ip:192.168.2.1');` + +`AD7124-8 Datasheet `_ + +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.AD7124_8.Rx/SampleRate is inherited from superclass adi.AD7124.Base + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer.Help for adi.AD7124_8.Rx/SamplesPerFrame is inherited from superclass adi.AD7124.Base + +**Data type for the output data** + A String Representing the data typeHelp for adi.AD7124_8.Rx/dataTypeStr is inherited from superclass matlabshared.libiio.base + +**Device name** + Name of the libIIO deviceHelp for adi.AD7124_8.Rx/devName is inherited from superclass matlabshared.libiio.base + +**Kernel buffers count** + The number of buffers allocated in the kernel for data transfersHelp for adi.AD7124_8.Rx/kernelBuffersCount is inherited from superclass matlabshared.libiio.base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD7124_8.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD7380_Rx.rst b/docs/source/reference_api/AD7380_Rx.rst new file mode 100644 index 0000000..0f39e69 --- /dev/null +++ b/docs/source/reference_api/AD7380_Rx.rst @@ -0,0 +1,29 @@ +adi.AD7380.Rx +------------- + +**AD7380 Precision ADC Class** + +adi.AD7380.Rx Receives data from the AD7380 ADC. +The adi.AD7380.Rx System object is a signal source that can receive +data from the AD7380. + +`rx = adi.AD7380.Rx;` +`rx = adi.AD7380.Rx('uri','192.168.2.1');` + +`AD7380 Datasheet `_ + +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. Options are: '256000','128000','64000','32000','16000','8000','4000', '2000','1000' + +**Frame size** + Size of the frame in samplesHelp for adi.AD7380.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD7380.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD7768_1_Rx.rst b/docs/source/reference_api/AD7768_1_Rx.rst new file mode 100644 index 0000000..7b2d192 --- /dev/null +++ b/docs/source/reference_api/AD7768_1_Rx.rst @@ -0,0 +1,32 @@ +adi.AD7768_1.Rx +--------------- + +**AD7768-1 Precision ADC Class** + +adi.AD7768_1.Rx Receives data from the AD7768-1 ADC +The adi.AD7768_1.Rx System object is a signal source that can receive +data from the AD7768-1. + +`rx = adi.AD7768_1.Rx;` +`rx = adi.AD7768_1.Rx('uri','192.168.2.1');` + +`AD7768-1 Datasheet `_ + +Class Properties +================ + +**SCommonModeVolts Common Mode Voltage** + Common mode voltage in volts, specified as a string Options are: '(AVDD1-AVSS)/2','2V5','2V05','1V9','1V65','1V1','0V9','OFF' + +**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. Options are: '256000','128000','64000','32000','16000','8000','4000', '2000','1000' + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer from 2 to 16,777,216. Using values less than 3660 can yield poor performance. + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD7768_1.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/AD7768_Rx.rst b/docs/source/reference_api/AD7768_Rx.rst new file mode 100644 index 0000000..1481cff --- /dev/null +++ b/docs/source/reference_api/AD7768_Rx.rst @@ -0,0 +1,29 @@ +adi.AD7768.Rx +------------- + +**AD7768 Precision ADC Class** + +adi.AD7768.Rx Receives data from the AD7768 ADC +The adi.AD7768.Rx System object is a signal source that can receive +data from the AD7768. + +`rx = adi.AD7768.Rx;` +`rx = adi.AD7768.Rx('uri','192.168.2.1');` + +`AD7768 Datasheet `_ + +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. Options are: '256000','128000','64000','32000','16000','8000','4000', '2000','1000' + +**SamplesPerFrame Samples Per Frame** + Number of samples per frame, specified as an even positive integer from 2 to 16,777,216. Using values less than 3660 can yield poor performance. + +**URI - remote host URI** + Hostname or IP address of remote libIIO deviceHelp for adi.AD7768.Rx/uri is inherited from superclass matlabshared.libiio.base + diff --git a/docs/source/reference_api/gen_sysobj_doc.m b/docs/source/reference_api/gen_sysobj_doc.m index 13dde42..c012bb6 100644 --- a/docs/source/reference_api/gen_sysobj_doc.m +++ b/docs/source/reference_api/gen_sysobj_doc.m @@ -70,16 +70,10 @@ all_props = [all_props,s]; end top_doc = help(dotmfilename); - disp("Hello") - disp(class(top_doc)) - disp(size(top_doc)) - disp(top_doc) top_doc = strsplit(top_doc,'\n'); - top_doc = top_doc(1:end - 3); top_doc = strtrim(top_doc); %Remove spurious leading whitespaces - disp(part) - disp(top_doc) + top_doc(1) = cellstr(strcat("**", top_doc(1), "**")); top_doc = strjoin(top_doc, '\n'); top_doc = char(top_doc); @@ -87,7 +81,6 @@ oname = struct('name',dotmfilename, 'dec',top_doc, 'props',all_props); all_devs = [all_devs, oname]; - template = ''; % Class name and section class_name = oname.name; diff --git a/docs/source/reference_api/index.rst b/docs/source/reference_api/index.rst index 69f1525..6593cde 100644 --- a/docs/source/reference_api/index.rst +++ b/docs/source/reference_api/index.rst @@ -4,4 +4,33 @@ Reference APIs .. toctree:: :maxdepth: 1 :caption: Driver Classes: - \ No newline at end of file + + AD7380_Rx.rst + AD7768_Rx.rst + AD7768_1_Rx.rst + AD4030_Rx.rst + AD4630_16_Rx.rst + AD4630_24_Rx.rst + AD4858_Rx.rst + AD2S1210_Rx.rst + AD4000_Rx.rst + AD4001_Rx.rst + AD4002_Rx.rst + AD4003_Rx.rst + AD4004_Rx.rst + AD4005_Rx.rst + AD4006_Rx.rst + AD4007_Rx.rst + AD4008_Rx.rst + AD4010_Rx.rst + AD4011_Rx.rst + AD4020_Rx.rst + AD4021_Rx.rst + AD4022_Rx.rst + AD5760_Tx.rst + AD5780_Tx.rst + AD5781_Tx.rst + AD5790_Tx.rst + AD5791_Tx.rst + AD7124_4_Rx.rst + AD7124_8_Rx.rst \ No newline at end of file