Add initial support and doc for ad4020

This adds initial support and doc for AD4020 ADC. Signed-off-by: Apelete Seketeli <[email protected]>
analogdevicesinc · Sep 29, 2023 · 2b2681b · 2b2681b
1 parent a6e79aa
commit 2b2681b
Show file tree

Hide file tree

Showing 7 changed files with 139 additions and 1 deletion.
diff --git a/+adi/+AD4020/Rx.m b/+adi/+AD4020/Rx.m
@@ -0,0 +1,116 @@
+classdef Rx < adi.common.Rx & 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.
+    %
+    %   rx = adi.AD4020.Rx;
+    %   rx = adi.AD4020.Rx('uri','192.168.2.1');
+    %
+    %   <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf">AD4020 Datasheet</a>
+
+    properties (Nontunable)
+        % SamplesPerFrame Samples Per Frame
+        %   Number of samples per frame, specified as an even positive
+        %   integer.
+        SamplesPerFrame = 4096
+    end
+
+    properties (Dependent)
+        % Voltage
+        %   ADC Voltage in mV
+        Voltage
+
+        % VoltageScale Voltage Scale
+        %   ADC Voltage scale.
+        VoltageScale
+
+        % VoltageOffset Voltage Offset
+        %   ADC Voltage offset.
+        VoltageOffset
+    end
+
+    properties
+        % SamplingFrequency
+        %   Sampling Frequency in Hertz.
+        SamplingFrequency = 0
+    end
+
+    properties (Hidden)
+        % Number of frames or buffers of data to capture
+        FrameCount = 1
+    end
+
+    % Channel names
+    properties (Nontunable, Hidden, Constant)
+        channel_names = {'voltage0'}
+    end
+
+    % isOutput
+    properties (Hidden, Nontunable, Access = protected)
+        isOutput = false
+    end
+
+    properties (Nontunable, Hidden)
+        Timeout = Inf
+        kernelBuffersCount = 1
+        dataTypeStr = 'int32'
+        phyDevName = 'ad4020'
+        devName = 'ad4020'
+    end
+
+    properties (Nontunable, Hidden, Constant)
+        Type = 'Rx'
+    end
+
+    properties (Hidden, Constant)
+        ComplexData = false
+    end
+
+    methods
+        %% Constructor
+        function obj = Rx(varargin)
+            obj = [email protected](varargin{:});
+            obj.enableExplicitPolling = false;
+            obj.EnabledChannels = 1;
+            obj.BufferTypeConversionEnable = true;
+        end
+
+        %% Check Voltage
+        function rValue = get.Voltage(obj)
+            if obj.ConnectedToDevice
+                rValue = obj.getAttributeRAW('voltage0', 'raw', obj.isOutput);
+            else
+                rValue = NaN;
+            end
+        end
+
+        %% Check Voltage Scale
+        function rValue = get.VoltageScale(obj)
+            if obj.ConnectedToDevice
+                rValue = obj.getAttributeDouble('voltage0', 'scale', obj.isOutput);
+            else
+                rValue = NaN;
+            end
+        end
+
+        %% Check Voltage Offset
+        function rValue = get.VoltageOffset(obj)
+            if obj.ConnectedToDevice
+                rValue = obj.getAttributeDouble('voltage0', 'offset', obj.isOutput);
+            else
+                rValue = NaN;
+            end
+        end
+    end
+
+    %% API Functions
+    methods (Hidden, Access = protected)
+
+        function setupInit(obj)
+            % Write sampling frequency attribute from device once connected.
+
+            obj.SamplingFrequency = obj.getDeviceAttributeLongLong('sampling_frequency');
+        end
+    end
+end
diff --git a/+adi/Contents.m b/+adi/Contents.m
@@ -11,3 +11,4 @@
 %   <a href="matlab:help adi.AD4030            ">AD4030-24</a>      - ADC
 %   <a href="matlab:help adi.AD4630_16          ">AD4630-16</a>     - ADC
 %   <a href="matlab:help adi.AD4630_24          ">AD4630-24</a>     - ADC
+%   <a href="matlab:help adi.AD4020            ">AD4020</a>         - ADC
diff --git a/CI/doc/SysObjsProps.m b/CI/doc/SysObjsProps.m
@@ -6,4 +6,5 @@
 % * AD4030 <AD4030_Rx.html Rx>
 % * AD463x <AD463x_Rx.html Rx>
 % * AD7768 <AD7768_Rx.html Rx>
+% * AD4020 <AD4020_Rx.html Rx>
 
diff --git a/CI/doc/genhtml.m b/CI/doc/genhtml.m
@@ -1,6 +1,6 @@
 mfiledir = '..\..\+adi\';
 docdir = '..\..\doc\';
-parts = {'AD4630','AD4030','AD463x','AD7768'};
+parts = {'AD4630','AD4030','AD463x','AD7768','AD4020'};
 trx_files = {'Rx','Base','Tx'};
 for ii = 1:numel(parts)
     for jj = 1:numel(trx_files)

diff --git a/CI/gen_doc/docs/_pages/index.md b/CI/gen_doc/docs/_pages/index.md
@@ -33,3 +33,4 @@ The following have device-specific implementations in MATLAB and Simulink. If a
 | AD4030-24 | Zedboard  | Yes   | No    | ADI (2021b) |
 | AD4630-16 | Zedboard  | Yes   | No    | ADI (2021b) |
 | AD4630-24 | Zedboard  | Yes   | No    | ADI (2021b) |
+| AD4020    | Zedboard  | Yes   | No    | ADI (2021b) |
diff --git a/CI/gen_doc/docs/gen_sysobj_doc.m b/CI/gen_doc/docs/gen_sysobj_doc.m
@@ -13,6 +13,7 @@
     , {'AD4030', {'Rx'}}...
     , {'AD4630_16', {'Rx'}}...
     , {'AD4630_24', {'Rx'}}...
+    , {'AD4020', {'Rx'}}...
     %{'QuadMxFE',{'Rx','Tx'}}...
     };
 

diff --git a/examples/ad4020_DataCapture.m b/examples/ad4020_DataCapture.m
@@ -0,0 +1,18 @@
+%% Script for capturing data from a connected AD4020 board
+
+% Instantiate the system object
+rx = adi.AD4020.Rx('uri','ip:analog.local');
+
+% Connect to device and initialize data
+rx();
+
+% Retrieve ADC voltage, scale and offset
+rx.Voltage();
+rx.VoltageScale();
+rx.VoltageOffset();
+
+% Print system object properties
+rx
+
+% Delete the system object
+release(rx)