diff --git a/+adi/+AD2S1210/Rx.m b/+adi/+AD2S1210/Rx.m index 0585d4d..3263fa3 100644 --- a/+adi/+AD2S1210/Rx.m +++ b/+adi/+AD2S1210/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.common.Rx & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD2S1210.Rx;` + % `rx = adi.AD2S1210.Rx('uri','192.168.2.1');` % - % AD2S1210 Datasheet + % `AD2S1210 Datasheet `_ properties (Nontunable) % SamplesPerFrame Samples Per Frame diff --git a/+adi/+AD4000/Rx.m b/+adi/+AD4000/Rx.m index 1dc75fc..ea0813d 100644 --- a/+adi/+AD4000/Rx.m +++ b/+adi/+AD4000/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4000.Rx;` + % `rx = adi.AD4000.Rx('uri','192.168.2.1');` % - % AD4000 Datasheet + % `AD4000 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4001/Rx.m b/+adi/+AD4001/Rx.m index 820f409..1fedb5b 100644 --- a/+adi/+AD4001/Rx.m +++ b/+adi/+AD4001/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4001.Rx;` + % `rx = adi.AD4001.Rx('uri','192.168.2.1');` % - % AD4001 Datasheet + % `AD4001 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4002/Rx.m b/+adi/+AD4002/Rx.m index 40be46a..bbd40f4 100644 --- a/+adi/+AD4002/Rx.m +++ b/+adi/+AD4002/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4002.Rx;` + % `rx = adi.AD4002.Rx('uri','192.168.2.1');` % - % AD4002 Datasheet + % `AD4002 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4003/Rx.m b/+adi/+AD4003/Rx.m index 93daf2b..39b471c 100644 --- a/+adi/+AD4003/Rx.m +++ b/+adi/+AD4003/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4003.Rx;` + % `rx = adi.AD4003.Rx('uri','192.168.2.1');` % - % AD4003 Datasheet + % `AD4003 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4004/Rx.m b/+adi/+AD4004/Rx.m index 0039c5d..47f614f 100644 --- a/+adi/+AD4004/Rx.m +++ b/+adi/+AD4004/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4004.Rx;` + % `rx = adi.AD4004.Rx('uri','192.168.2.1');` % - % AD4004 Datasheet + % `AD4004 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4005/Rx.m b/+adi/+AD4005/Rx.m index 3bc1b35..721e175 100644 --- a/+adi/+AD4005/Rx.m +++ b/+adi/+AD4005/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4005.Rx;` + % `rx = adi.AD4005.Rx('uri','192.168.2.1');` % - % AD4005 Datasheet + % `AD4005 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4006/Rx.m b/+adi/+AD4006/Rx.m index 8c64664..f38ffec 100644 --- a/+adi/+AD4006/Rx.m +++ b/+adi/+AD4006/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4006.Rx;` + % `rx = adi.AD4006.Rx('uri','192.168.2.1');` % - % AD4006 Datasheet + % `AD4006 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4007/Rx.m b/+adi/+AD4007/Rx.m index de1b9f7..fc377a8 100644 --- a/+adi/+AD4007/Rx.m +++ b/+adi/+AD4007/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4007.Rx;` + % `rx = adi.AD4007.Rx('uri','192.168.2.1');` % - % AD4007 Datasheet + % `AD4007 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4008/Rx.m b/+adi/+AD4008/Rx.m index d320d98..94b596e 100644 --- a/+adi/+AD4008/Rx.m +++ b/+adi/+AD4008/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4008.Rx;` + % `rx = adi.AD4008.Rx('uri','192.168.2.1');` % - % AD4008 Datasheet + % `AD4008 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4010/Rx.m b/+adi/+AD4010/Rx.m index d99c62c..31001ad 100644 --- a/+adi/+AD4010/Rx.m +++ b/+adi/+AD4010/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4010.Rx;` + % `rx = adi.AD4010.Rx('uri','192.168.2.1');` % - % AD4010 Datasheet + % `AD4010 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4011/Rx.m b/+adi/+AD4011/Rx.m index da21b86..c489ee2 100644 --- a/+adi/+AD4011/Rx.m +++ b/+adi/+AD4011/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4011.Rx;` + % `rx = adi.AD4011.Rx('uri','192.168.2.1');` % - % AD4011 Datasheet + % `AD4011 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4020/Rx.m b/+adi/+AD4020/Rx.m index d26f183..0a5b173 100644 --- a/+adi/+AD4020/Rx.m +++ b/+adi/+AD4020/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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 + % `AD4020 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4021/Rx.m b/+adi/+AD4021/Rx.m index b54e361..369a37c 100644 --- a/+adi/+AD4021/Rx.m +++ b/+adi/+AD4021/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4021.Rx;` + % `rx = adi.AD4021.Rx('uri','192.168.2.1');` % - % AD4021 Datasheet + % `AD4021 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4022/Rx.m b/+adi/+AD4022/Rx.m index 4a9a9a8..ecafe9c 100644 --- a/+adi/+AD4022/Rx.m +++ b/+adi/+AD4022/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4022.Rx;` + % `rx = adi.AD4022.Rx('uri','192.168.2.1');` % - % AD4022 Datasheet + % `AD4022 Datasheet `_ methods %% Constructor diff --git a/+adi/+AD4030/Rx.m b/+adi/+AD4030/Rx.m index 86d8ae2..4d87be0 100644 --- a/+adi/+AD4030/Rx.m +++ b/+adi/+AD4030/Rx.m @@ -2,14 +2,15 @@ & adi.AD463x.Base % 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. + % 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'); + % `rx = adi.AD4030.Rx;` + % `rx = adi.AD4030.Rx('uri','192.168.2.1');` % - % AD4030-24 Datasheet + % `AD4030-24 Datasheet `_ properties (Nontunable, Hidden, Constant) Type = 'Rx' diff --git a/+adi/+AD4630_16/Rx.m b/+adi/+AD4630_16/Rx.m index f555eb6..23a8bc4 100644 --- a/+adi/+AD4630_16/Rx.m +++ b/+adi/+AD4630_16/Rx.m @@ -2,14 +2,15 @@ & adi.AD463x.Base % 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. + % 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'); + % `rx = adi.AD4630_16.Rx;` + % `rx = adi.AD4630_16.Rx('uri','192.168.2.1');` % - % AD4630-16 Datasheet + % `AD4630-16 Datasheet `_ properties (Nontunable, Hidden, Constant) Type = 'Rx' diff --git a/+adi/+AD4630_24/Rx.m b/+adi/+AD4630_24/Rx.m index f63d9a5..ead174d 100644 --- a/+adi/+AD4630_24/Rx.m +++ b/+adi/+AD4630_24/Rx.m @@ -2,14 +2,15 @@ & adi.AD463x.Base % 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. + % 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'); + % `rx = adi.AD4630_24.Rx;` + % `rx = adi.AD4630_24.Rx('uri','192.168.2.1');` % - % AD4630-24 Datasheet + % `AD4630-24 Datasheet `_ properties (Nontunable, Hidden, Constant) Type = 'Rx' diff --git a/+adi/+AD4858/Rx.m b/+adi/+AD4858/Rx.m index 89d5945..a58417e 100644 --- a/+adi/+AD4858/Rx.m +++ b/+adi/+AD4858/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.common.Rx & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD4858.Rx;` + % `rx = adi.AD4858.Rx('uri','192.168.2.1');` % - % AD4858 Datasheet + % `AD4858 Datasheet `_ properties (Nontunable) % SampleRate Sample Rate diff --git a/+adi/+AD5760/Tx.m b/+adi/+AD5760/Tx.m index f30da8f..6dda576 100644 --- a/+adi/+AD5760/Tx.m +++ b/+adi/+AD5760/Tx.m @@ -1,13 +1,14 @@ classdef Tx < adi.AD579x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `tx = adi.AD5760.Tx;` + % `tx = adi.AD5760.Tx('uri','ip:192.168.2.1');` % - % AD5760 Datasheet + % `AD5760 Datasheet `_ methods diff --git a/+adi/+AD5780/Tx.m b/+adi/+AD5780/Tx.m index 7c9b622..7831d6d 100644 --- a/+adi/+AD5780/Tx.m +++ b/+adi/+AD5780/Tx.m @@ -1,13 +1,14 @@ classdef Tx < adi.AD579x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `tx = adi.AD5780.Tx;` + % `tx = adi.AD5780.Tx('uri','ip:192.168.2.1');` % - % AD5780 Datasheet + % `AD5780 Datasheet `_ methods diff --git a/+adi/+AD5781/Tx.m b/+adi/+AD5781/Tx.m index 809eba1..89919bc 100644 --- a/+adi/+AD5781/Tx.m +++ b/+adi/+AD5781/Tx.m @@ -1,13 +1,14 @@ classdef Tx < adi.AD579x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `tx = adi.AD5781.Tx;` + % `tx = adi.AD5781.Tx('uri','ip:192.168.2.1');` % - % AD5781 Datasheet + % `AD5781 Datasheet `_ methods diff --git a/+adi/+AD5790/Tx.m b/+adi/+AD5790/Tx.m index 260b8e6..c42e23d 100644 --- a/+adi/+AD5790/Tx.m +++ b/+adi/+AD5790/Tx.m @@ -1,13 +1,14 @@ classdef Tx < adi.AD579x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `tx = adi.AD5790.Tx;` + % `tx = adi.AD5790.Tx('uri','ip:192.168.2.1');` % - % AD5790 Datasheet + % `AD5790 Datasheet `_ methods diff --git a/+adi/+AD5791/Tx.m b/+adi/+AD5791/Tx.m index 4d990c8..7bfb947 100644 --- a/+adi/+AD5791/Tx.m +++ b/+adi/+AD5791/Tx.m @@ -1,13 +1,14 @@ classdef Tx < adi.AD579x.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `tx = adi.AD5791.Tx;` + % `tx = adi.AD5791.Tx('uri','ip:192.168.2.1');` % - % AD5791 Datasheet + % `AD5791 Datasheet `_ methods diff --git a/+adi/+AD7124_4/Rx.m b/+adi/+AD7124_4/Rx.m index 0c62926..3a17cfe 100644 --- a/+adi/+AD7124_4/Rx.m +++ b/+adi/+AD7124_4/Rx.m @@ -1,14 +1,15 @@ classdef Rx < adi.common.Rx & adi.common.RxTx ... & adi.AD7124.Base % 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. + % 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'); + % `rx = adi.AD7124_4.Rx;` + % `rx = adi.AD7124_4.Rx('uri','ip:192.168.2.1');` % - % AD7124-4 Datasheet + % `AD7124-4 Datasheet `_ properties (Nontunable, Hidden) channel_names = {'voltage0','voltage1','voltage2'... diff --git a/+adi/+AD7124_8/Rx.m b/+adi/+AD7124_8/Rx.m index 84cf2ad..b0688fb 100644 --- a/+adi/+AD7124_8/Rx.m +++ b/+adi/+AD7124_8/Rx.m @@ -1,14 +1,15 @@ classdef Rx < adi.common.Rx & adi.common.RxTx ... & adi.AD7124.Base % 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. + % 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'); + % `rx = adi.AD7124_8.Rx;` + % `rx = adi.AD7124_8.Rx('uri','ip:192.168.2.1');` % - % AD7124-8 Datasheet + % `AD7124-8 Datasheet `_ properties (Nontunable, Hidden) diff --git a/+adi/+AD7380/Rx.m b/+adi/+AD7380/Rx.m index e880f12..f8ea412 100644 --- a/+adi/+AD7380/Rx.m +++ b/+adi/+AD7380/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.common.Rx & matlabshared.libiio.base & adi.common.Attribute % 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'); + % 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. % - % AD7380 Datasheet + % `rx = adi.AD7380.Rx;` + % `rx = adi.AD7380.Rx('uri','192.168.2.1');` + % + % `AD7380 Datasheet `_ properties (Nontunable) % SampleRate Sample Rate diff --git a/+adi/+AD7768/Rx.m b/+adi/+AD7768/Rx.m index 0869a22..4f6de99 100644 --- a/+adi/+AD7768/Rx.m +++ b/+adi/+AD7768/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD7768.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD7768.Rx;` + % `rx = adi.AD7768.Rx('uri','192.168.2.1');` % - % AD7768 Datasheet + % `AD7768 Datasheet `_ properties (Nontunable) % SampleRate Sample Rate diff --git a/+adi/+AD7768_1/Rx.m b/+adi/+AD7768_1/Rx.m index 8004a40..0893ecc 100644 --- a/+adi/+AD7768_1/Rx.m +++ b/+adi/+AD7768_1/Rx.m @@ -1,13 +1,14 @@ classdef Rx < adi.AD7768.Base & matlabshared.libiio.base & adi.common.Attribute % 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. + % 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'); + % `rx = adi.AD7768_1.Rx;` + % `rx = adi.AD7768_1.Rx('uri','192.168.2.1');` % - % AD7768-1 Datasheet + % `AD7768-1 Datasheet `_ properties (Nontunable) % SampleRate Sample Rate diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 4461156..86b552c 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -8,6 +8,8 @@ jobs: steps: - uses: actions/checkout@v2 + with: + submodules: recursive - name: Set up Python 3.7 uses: actions/setup-python@v2 with: @@ -17,12 +19,17 @@ jobs: run: | sudo apt install -y python3-numpy pip install -r requirements_doc.txt + python -m pip install sphinx-toolbox + pip install sphinx myst_parser + sudo apt-get install doxygen graphviz -y + - name: Check doc build run: | - make -C CI/gen_doc doc + cd docs + make html - name: Publish master doc if: github.ref == 'refs/heads/main' uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./doc \ No newline at end of file + publish_dir: ./docs/build/html \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/adi_logo.png b/docs/source/adi_logo.png new file mode 100644 index 0000000..179fb30 Binary files /dev/null and b/docs/source/adi_logo.png differ diff --git a/docs/source/common/data_streaming.rst b/docs/source/common/data_streaming.rst new file mode 100644 index 0000000..ee1a3f9 --- /dev/null +++ b/docs/source/common/data_streaming.rst @@ -0,0 +1,91 @@ +Data Streaming +-------------- + +Remote data streaming to and from hardware is made available through `system object interfaces `_ , which are unique for each component or platform. The hardware interfacing system objects provide a since class to both configure a given platform and move data back and forth from the device. + +Command and control of hardware from MATLAB is accomplished by leveraging the `IIO drivers `_ built into the target platform's kernel and `libiio `_ which provides remote backends to control drivers across different backends. Backends can be Ethernet/IP/USB based. Below is a diagram of the different components in the stack for a setup targeting the evaluation of the AD7380, but the setup will be nearly similar for other ADCs as well. + + .. image:: images/PCXEvalStack.png + :width: 600 + +Since libiio is cross-platform it can be used from Windows, Linux, or macOS based systems. It is also a lower level library independent of MATLAB, so when moving toward production or untethered systems similar APIs that are used in MATLAB can be used in C, C++, Python, or other languages. + +============================ +Connecting and Configuration +============================ + +Connecting to hardware is done by setting the **uri** property of the system object interface. The **uri** for libiio always has the convention "*< backend >:< address >*", where *backend* can be ethernet, ip or usb. *address* will be specific to the backend. This is documented in the `libiio API `_ . + +Below is a basic example of setting up a generic ADC using an Ethernet/IP backend: + +.. code-block:: MATLAB + + rx = adi.ADxxxx.Rx; + rx.uri = 'ip:analog.local'; + data = rx(); + +With the code above, the hardware is not contacted until the operator or step method is called on line 3. Therefore, any properties that are set or defined before line 3 are not applied or updated on the hardware until after line 3. However, after line 3 has completed the object will become locked and certain configuration changes cannot be applied after this point. These will primarily sample rates and buffer sizes. + +The state of the object follows the flow of the diagram below triggered by line 3 above. + +Once the object becomes locked it must be released if the sample rate or buffers need to be modified. This will disconnect from the hardware: + +.. code-block:: MATLAB + + rx.release(); % Release object + +To provide a complete example we can do more advanced configuration like so to demonstrate property changes: + +.. code-block:: MATLAB + + rx = adi.ADxxxx.Rx; + rx.uri = 'ip:analog.local'; + rx.SamplesPerFrame = 1024; + rx.SampleRate = 256000; + data1 = rx(); + + % Update tunable property + rx.SampleRate = 128000; + data2 = rx(); + + % Update non-tunable property + rx.release(); + rx.SamplesPerFrame = 4096; + dataLargerBuffer = rx(); + +============== +Receiving Data +============== + +To receive or capture data from a given device first you must instantiate that device's interface class. For a generic ADC, this would be as follows: + +.. code-block:: MATLAB + + rx = adi.ADxxxx.Rx; + +Once instantiated you can configure the number of samples to be captured by setting the property **SamplesPerFrame.** + +.. code-block:: MATLAB + + rx.SamplesPerFrame = 1e6; + +**SamplesPerFrame** is the number of samples per channel which will be captured. If your device produces complex data (I and Q) this is the number of complex samples. There will be a limit to the maximum samples which can be collected. By default this is set to 2^20, but it may be possible to make it larger depending on hardware. Once the operator methods are used for a give instantiation, the object will become locked and the **SamplesPerFrame** property cannot be changed. This is known as a non-tunable property. + +To actually collect the samples or perform the capture, the operator of the system object should be used or the **step** method as so: + +.. code-block:: MATLAB + + data = rx(); % Operator method + data = rx.step(); % Step method + +Both method calls are equivalent, and the produced matrix **data** will be of size [SamplesPerFrame x length(EnabledChannels)]. **EnabledChannels** determines the channels which data will be collected from. **EnabledChannels** is a [1xN] vector with indexes starting at 1 of the desired channels. + +=========================== +Continuous Data Acquisition +=========================== + +If you are capturing multiple frames or buffers of data, then there might arise situations where discontinuities appear in the samples, when plotted. + +Some detail and tips are discussed in this wiki page on `IIO System Considerations, Tips and Tricks `_ + +The IIO buffer size is governed by the SamplesPerFrame property of the System Object classes. The kernelBuffersCount is also a property defined for the classes, and can be modified. diff --git a/docs/source/common/examples.rst b/docs/source/common/examples.rst new file mode 100644 index 0000000..942e0a6 --- /dev/null +++ b/docs/source/common/examples.rst @@ -0,0 +1,12 @@ +Examples +-------- + +Examples for streaming data are listed within the Toolbox documentation itself. To view run the following with MATLAB: + +.. code-block:: MATLAB + + doc adi + +They can also be viewed on GitHub: + + - `Streaming examples `_ \ No newline at end of file diff --git a/docs/source/common/images/PCXEvalStack.png b/docs/source/common/images/PCXEvalStack.png new file mode 100644 index 0000000..bfa091d Binary files /dev/null and b/docs/source/common/images/PCXEvalStack.png differ diff --git a/docs/source/common/installation.rst b/docs/source/common/installation.rst new file mode 100644 index 0000000..8d2c924 --- /dev/null +++ b/docs/source/common/installation.rst @@ -0,0 +1,45 @@ +Installation +------------ + +============ +Dependencies +============ + +The toolbox has different dependencies based on the features required. The base dependencies for streaming data are listed below. + +The base dependencies for the toolbox requires libiio and the libiio MATLAB bindings. There are three options for this install with different required MathWorks Toolboxes: + +- `Communications Toolbox Support Package for Xilinx Zynq-Based Radio `_ + - Communications Toolbox + - Signal Processing Toolbox :sup:`TM` + - DSP System Toolbox :sup:`TM` +- `Communications Toolbox Support Package for Analog Devices ADALM-Pluto Radio `_ + - Communications Toolbox + - Signal Processing Toolbox :sup:`TM` + - DSP System Toolbox :sup:`TM` +- `libiio MATLAB Binding Standalone Installer (R2021b+) `_ + - Signal Processing Toolbox :sup:`TM` + + +========================= +Precision Toolbox Install +========================= + +The Precision Toolbox itself can be installed either from: + +- `MATLAB's Add-On Explorer `_ +- `GitHub Releases page `_ + +.. warning:: + Before installing Precision Toolbox check the `Release Page `_ to check for the latest supported version of MATLAB. The latest version is the one which is available in `Add-on Explorer `_ , since Add-On Explorer does not currently support hosting multiple versions. If you have an older release of MATLAB, download the MLTBX installer from matching release on the `Release Page `_ . + +=========================== +Add-On Explorer Walkthrough +=========================== + +To install the toolbox from within MATLAB using the Add-On Explorer: + + - Launch the Add-Ons Explorer from MATLAB's Home tab + - Search for 'Precision Toolbox' + - Select Precision Toolbox from Analog Devices, Inc. from the results: + - Install the toolbox \ No newline at end of file diff --git a/docs/source/common/limitations.rst b/docs/source/common/limitations.rst new file mode 100644 index 0000000..d60fa45 --- /dev/null +++ b/docs/source/common/limitations.rst @@ -0,0 +1,27 @@ +Limitations +----------- + +Known Limitations, Bugs and Quirks +================================== + +Some limitations and bugs are known to be present in the support for the ADCs relevant to the Precision Toolbox. They have been summarized below. + +**Libiio backend** + +Currently only ethernet/IP backends are supported for all the parts in the toolbox. For AD4030-24, AD4630-16 and AD4630-24 the usb backend can also be used. Serial backends are not supported. + +**AD7380** + +Trigger setup needs to be done before running any of the toolbox scripts that interact with the AD7380. Refer to the `Trigger Management section on the AD738x Linux IIO driver wiki page `_ + +**AD7768** + +The Linux IIO driver for the AD7768 returns data for all the channels whenever a data capture is requested. So, in order to get sensible outputs, ensure that the EnabledChannels array consists of indices for all the channels. + +**AD4030-24. AD4630-16, AD4630-24** + +The Linux IIO driver for the three parts (there's a common Linux driver that addresses all three parts) returns data for all the channels whenever a data capture is requested. In order to have sensible outputs, ensure that the EnabledChannels array consists of indices for all the channels. + +Another known issue here has to do with the case where the ADC sends out common mode voltage data along with the differential voltage data. The EnabledChannel property values that consist of more than two indices (even when there are 4 IIO channels), are not 'valid'. Of the possible groupings with two channel indices, the ones that correspond to {differential0, common_voltage0} and {differential1, common_voltage1} are also not 'valid' + +It is possible to get data (common-mode and differential) for all the ADC channels, by using a 'valid' channel grouping, setting the BufferTypeConversionEnable property to 'false' in the Base class for the AD463x family, and adding custom parsing logic to extract the data for all IIO channels, from the 32-bit raw words you get from the data capture. \ No newline at end of file diff --git a/docs/source/common/support.rst b/docs/source/common/support.rst new file mode 100644 index 0000000..f023a60 --- /dev/null +++ b/docs/source/common/support.rst @@ -0,0 +1,9 @@ +Support +------- + +Support is provided online through the EngineerZone forums. If you have questions related to the hardware itself outside of this BSP, contact your local FAE or ask on the forums. + +Question regarding specific aspect of the BSP should be asked in the following places: + +- `Software Interface Tools `_ for questions on the BSP itself +- `Linux Software Drivers `_ for libiio and iio driver questions \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..cb77de2 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,45 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Precision Toolbox for MATLAB' +copyright = '2023, Analog Devices Inc.' +author = 'Analog Devices Inc.' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +#extensions = [] +# +#templates_path = ['_templates'] +#exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +#html_theme = 'alabaster' +#html_static_path = ['_static'] + + +extensions = [ + 'sphinx_toolbox.collapse' + ] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "bizstyle" +html_static_path = ['_static'] + +html_logo = "adi_logo.png" \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..c15f19e --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,55 @@ +.. pctlbx-docs documentation master file, created by + sphinx-quickstart on Mon Apr 1 11:50:10 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Precision Toolbox for MATLAB +============================ + + .. image:: /pctlbxLogo.png + :width: 600 + +ADI maintains a set of tools to interface with ADI precision converters within MATLAB and Simulink. These are combined into a single toolbox. Currently, the toolbox supports only converter configuration and data streaming. + +.. toctree:: + :maxdepth: 1 + :caption: Index: + + /common/installation.rst + /common/data_streaming.rst + /common/examples.rst + /common/limitations.rst + /common/support.rst + /reference_api/index.rst + +The following have device-specific implementations in MATLAB and Simulink. In general, if a device has an IIO driver, MATLAB support is possible, but a device-specific MATLAB or Simulink interface may not exist yet. + +.. csv-table:: Supported Parts + :header: "Evaluation Card", "FPGA Board", "Streaming Support", "Targeting", "Variants and Minimum Supported Release" + :widths: 30, 30, 30, 30, 30 + + "AD7380", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD7768", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD7768-1", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4030-24", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4630-16", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4630-24", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4858", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD2S1210", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4000", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4001", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4002", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4003", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4004", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4005", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4006", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4007", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4008", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4010", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4011", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4020", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4021", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD4022", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD7124-4", "Zedboard", "Yes", "No", "ADI (2021b)" + "AD7124-8", "Zedboard", "Yes", "No", "ADI (2021b)" + diff --git a/docs/source/pctlbxLogo.png b/docs/source/pctlbxLogo.png new file mode 100644 index 0000000..5aa1c09 Binary files /dev/null and b/docs/source/pctlbxLogo.png differ 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 new file mode 100644 index 0000000..a99f4a1 --- /dev/null +++ b/docs/source/reference_api/gen_sysobj_doc.m @@ -0,0 +1,143 @@ +[filepath,name,ext] = fileparts(mfilename('fullpath')); +cd(filepath); + +mfiledir = fullfile('adi'); + +rootClasses = {... + {'AD7380',{'Rx'}}... + , {'AD7768', {'Rx'}}... + , {'AD7768_1', {'Rx'}}... + , {'AD4030', {'Rx'}}... + , {'AD4630_16', {'Rx'}}... + , {'AD4630_24', {'Rx'}}... + , {'AD4858', {'Rx'}}... + , {'AD2S1210', {'Rx'}}... + , {'AD4000', {'Rx'}}... + , {'AD4001', {'Rx'}}... + , {'AD4002', {'Rx'}}... + , {'AD4003', {'Rx'}}... + , {'AD4004', {'Rx'}}... + , {'AD4005', {'Rx'}}... + , {'AD4006', {'Rx'}}... + , {'AD4007', {'Rx'}}... + , {'AD4008', {'Rx'}}... + , {'AD4010', {'Rx'}}... + , {'AD4011', {'Rx'}}... + , {'AD4020', {'Rx'}}... + , {'AD4021', {'Rx'}}... + , {'AD4022', {'Rx'}}... + , {'AD5760', {'Tx'}}... + , {'AD5780', {'Tx'}}... + , {'AD5781', {'Tx'}}... + , {'AD5790', {'Tx'}}... + , {'AD5791', {'Tx'}}... + , {'AD7124_4', {'Rx'}}... + , {'AD7124_8', {'Rx'}}... + }; + +all_devs = []; +rstFiles = []; + +for ii = 1:numel(rootClasses) + for jj = 1:numel(rootClasses{ii}{2}) + part = rootClasses{ii}{1}; + tmp = rootClasses{ii}{2}; + trx_file = tmp{jj}; + all_props = []; + dotmfilename = strcat(mfiledir, '.', part, '.', trx_file); + props = unique(properties(dotmfilename)); + for prop = 1:length(props) + + if props{prop} == "enIO" + continue; + end + pdoc = help(strcat(dotmfilename,'.',props{prop})); + + pdocs = strsplit(pdoc,'\n'); + prop_title = pdocs{1}; + prop_description = strip(replace(strjoin(pdocs(2:end),'\n'),'\n','')); + prop_description = int32(prop_description); + prop_description(prop_description==10) = []; + prop_description(prop_description==13) = []; + prop_description = char(prop_description); + prop_description = replace(prop_description,' ',' '); + prop_description = replace(prop_description,' ',' '); + + s = struct('prop_name',props{prop},... + 'prop_title',prop_title,... + 'prop_description',prop_description); + all_props = [all_props,s]; + end + top_doc = help(dotmfilename); + top_doc = strsplit(top_doc,'\n'); + top_doc = top_doc(1:end - 3); + top_doc = strtrim(top_doc); %Remove spurious leading whitespaces + + top_doc(1) = cellstr(strcat("**", top_doc(1), "**")); + top_doc = strjoin(top_doc, '\n'); + top_doc = char(top_doc); + + oname = struct('name',dotmfilename, 'dec',top_doc, 'props',all_props); + all_devs = [all_devs, oname]; + + template = ''; + % Class name and section + class_name = oname.name; + template = append(template, class_name); + template = append(template, '\n'); + template = append(template, repelem('-', length(class_name)), '\n'); + + % Add description + template = append(template, '\n', convertStringsToChars(top_doc)); + + % Add properties + template = append(template, '\n\n', 'Class Properties', '\n', repelem('=', 16), '\n\n'); %TODO replace hardcoded 16 + + num_props = size(all_props, 2); + for p = 1:num_props + my_prop = all_props(p); + prop_title = strtrim(my_prop.prop_title); + prop_desc = strtrim(my_prop.prop_description); + template = append(template, '**', prop_title, '**\n', ' ', prop_desc, '\n\n'); + end + + % Create file + fileID = fopen([part '_' trx_file '.rst'],'wt'); + fprintf(fileID, template); + fclose(fileID); + + rstFiles = [rstFiles, convertCharsToStrings([' ' part '_' trx_file '.rst'])]; + end + +end + +%% Overwrite any existing index.rst file +if isfile('index_template.tmpl') + template = []; + fileID = fopen('index_template.tmpl','r'); + current_line = convertCharsToStrings(fgetl(fileID)); + + while isstring(current_line) + template = [template, current_line]; + current_line = convertCharsToStrings(fgetl(fileID)); + end + fclose(fileID); + + fileID = fopen('index.rst','wt'); + for i = 1:length(template) + fprintf(fileID, template(i)); + fprintf(fileID, '\n'); + end + + fclose(fileID); + +end + +%% Add toctree to the reference api index.rst file using the rstFiles +fileID = fopen('index.rst','a+'); +fprintf(fileID, '\n'); +for i = 1:length(rstFiles) + fprintf(fileID, "%s", rstFiles(i)); + fprintf(fileID, '\n'); +end +fclose(fileID); diff --git a/docs/source/reference_api/index_template.tmpl b/docs/source/reference_api/index_template.tmpl new file mode 100644 index 0000000..7958b1e --- /dev/null +++ b/docs/source/reference_api/index_template.tmpl @@ -0,0 +1,6 @@ +Reference APIs +-------------- + +.. toctree:: + :maxdepth: 1 + :caption: Driver Classes: