From d15d17fa2e60392e05df80c74622b97a962a6dee Mon Sep 17 00:00:00 2001 From: Stanca Pop Date: Tue, 11 Jul 2023 13:41:37 +0300 Subject: [PATCH] +adi/+AD3552R: Add properties documentation --- +adi/+AD3552R/Base.m | 30 ++++++++++++++++++++++++++---- +adi/+AD3552R/Tx.m | 13 ++++++++++--- 2 files changed, 36 insertions(+), 7 deletions(-) diff --git a/+adi/+AD3552R/Base.m b/+adi/+AD3552R/Base.m index a561bcc..a3ca618 100755 --- a/+adi/+AD3552R/Base.m +++ b/+adi/+AD3552R/Base.m @@ -2,11 +2,19 @@ adi.common.RxTx & ... matlabshared.libiio.base & ... adi.common.Attribute - %AD3552R Base Summary of this class goes here - % Detailed explanation goes here - + % adi.AD3552R.Tx Transmit data to the AD3552R high speed DAC + % The adi.AD3552R.Tx System object is a signal source that can send + % complex data from the AD3552R. + % + % tx = adi.AD3552R.Tx; + % tx = adi.AD3552R.Tx('uri','192.168.2.1'); + % + % AD3552R Datasheet + % + % See also adi.CN0585.Tx + properties (Nontunable) - %SamplesPerFrame Samples Per Frame + % 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. @@ -27,6 +35,20 @@ ComplexData = false; end + properties (Nontunable) + % InputSource + % Lists all the available input sources of the DAC. + % Options are: 'adc_input', 'dma_input', 'ramp_input'. + InputSource = 'adc_input'; + end + + properties (Nontunable) + % OutputRange + % Lists all the available voltage ranges of the output signal. + % Options are: '0/2.5V', '0/5V', '0/10V', '-5/+5V', '-10/+10V'. + InputSource = '-10/+10V'; + end + properties InputSourceSet = matlab.system.StringSet({... 'adc_input', 'dma_input', 'ramp_input'}) diff --git a/+adi/+AD3552R/Tx.m b/+adi/+AD3552R/Tx.m index 28e0403..a689b98 100755 --- a/+adi/+AD3552R/Tx.m +++ b/+adi/+AD3552R/Tx.m @@ -11,9 +11,9 @@ % See also adi.CN0585.Tx properties (Constant) - %SamplingRate Sampling Rate + % SamplingRate Sampling Rate % Baseband sampling rate in Hz, specified as a scalar - % in samples per second. This value is constant + % in samples per second. This value is constant. SamplingRate = 15e6; end @@ -31,7 +31,14 @@ channel_names = {'voltage0', 'voltage1'}; end - propertiesi (Hidden, Constant) + properties (Nontunable) + % StreamStatus + % Describes the status of the data streaming. + % Options are: 'start_stream_synced', 'start_stream', 'stop_stream'. + StreamStatus = 'stop_stream'; + end + + properties (Hidden, Constant) StreamStatusSet = matlab.system.StringSet({ ... 'start_stream_synced', 'start_stream', 'stop_stream'}) end