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/+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..b30c988 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -17,12 +17,24 @@ 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: Set up MATLAB + uses: matlab-actions/setup-matlab@v2 + + - name: Run script + uses: matlab-actions/run-command@v2 + with: + command: cd docs/source, gen_sysobj_doc + - 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/source/index.rst b/docs/source/index.rst index ad92f6e..5c1aca3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,9 +9,7 @@ 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. The list of supported parts is provided below. - -The following have device-specific implementations in MATLAB and Simulink. If a device has an IIO driver, MATLAB support is possible, but a device-specific MATLAB or Simulink interface may not exist yet. +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 configuration and data streaming. .. toctree:: :maxdepth: 1 @@ -24,6 +22,7 @@ The following have device-specific implementations in MATLAB and Simulink. If a /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" @@ -54,10 +53,3 @@ The following have device-specific implementations in MATLAB and Simulink. If a "AD7124-4", "Zedboard", "Yes", "No", "ADI (2021b)" "AD7124-8", "Zedboard", "Yes", "No", "ADI (2021b)" - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/source/reference_api/gen_sysobj_doc.m b/docs/source/reference_api/gen_sysobj_doc.m index 4aa1f43..1cc17e6 100644 --- a/docs/source/reference_api/gen_sysobj_doc.m +++ b/docs/source/reference_api/gen_sysobj_doc.m @@ -76,7 +76,6 @@ 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 = replace(top_doc,'\n','
'); top_doc = char(top_doc); oname = struct('name',dotmfilename, 'dec',top_doc, 'props',all_props); @@ -105,9 +104,7 @@ end % Create file - %template = strsplit(template, '\n'); fileID = fopen([part '_' trx_file '.rst'],'wt'); - %fprintf(fileID, template(1:end - 3)); fprintf(fileID, template); fclose(fileID); @@ -116,11 +113,6 @@ end -%% -%jsonText = jsonencode(all_devs,'PrettyPrint',true); -%fid = fopen('docs/sysobjs.json', 'w'); -%fprintf(fid, '%s', jsonText); -%fclose(fid); %% Add toctree to the reference api index.rst file using the rstFiles fileID = fopen('index.rst','a+');