Skip to content

Add documentation and MATLAB code linting #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tfcollins wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Add documentation and MATLAB code linting #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8dc9252
Initial work for linting jobs
tfcollins Dec 13, 2022
9d0d107
Add doc linting, formatting, and Sphinx config improvements
tfcollins May 22, 2026
74398a5
Merge remote-tracking branch 'origin/tfcollins/lint' into tfcollins/lint
tfcollins May 22, 2026
4d8befa
Modernize Lint workflow action versions
tfcollins May 22, 2026
401ff07
Add miss_hit.cfg and fix mh_metric command in Lint workflow
tfcollins May 22, 2026
c10b112
Replace non-ASCII punctuation in +adi comments with ASCII
tfcollins May 22, 2026
3a1e165
Apply mh_style --fix to +adi MATLAB sources
tfcollins May 22, 2026
2f5a369
Reach zero mh_style issues: defer line_length, fix indentation
tfcollins May 22, 2026
f3d734c
Pin miss_hit to 0.9.44 for reproducible Lint CI
tfcollins May 22, 2026
3489012
Merge remote-tracking branch 'origin/master' into tfcollins/lint
tfcollins May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 58 additions & 53 deletions +adi/+AD9361/Base.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,151 +4,156 @@
adi.common.DebugAttribute & ...
matlabshared.libiio.base

%adi.AD9361.Base Class
% adi.AD9361.Base Class
% This class contains shared parameters and methods between TX and RX
% classes
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.
SamplesPerFrame = 2^15;
SamplesPerFrame = 2^15
end

properties (Nontunable, Logical)
%EnableCustomFilter Enable Custom Filter
% Enable use of custom filter file to set SamplingRate,
% EnableCustomFilter Enable Custom Filter
% Enable use of custom filter file to set SamplingRate,
% RFBandwidth, and FIR in datapaths
EnableCustomFilter = false;
EnableCustomFilter = false
end

properties (Nontunable)
%CustomFilterFileName Custom Filter File Name
% CustomFilterFileName Custom Filter File Name
% Path to custom filter file created from filter wizard
CustomFilterFileName = '';
CustomFilterFileName = ''
end

properties (Abstract)
%CenterFrequency Center Frequency
% CenterFrequency Center Frequency
% RF center frequency, specified in Hz as a scalar. The
% default is 2.4e9. This property is tunable.
CenterFrequency
%SamplingRate Sampling Rate
% SamplingRate Sampling Rate
% Baseband sampling rate in Hz, specified as a scalar
% from 65105 to 61.44e6 samples per second.
SamplingRate
%RFBandwidth RF Bandwidth
% RFBandwidth RF Bandwidth
% RF Bandwidth of front-end analog filter in Hz, specified as a
% scalar from 200 kHz to 56 MHz.
RFBandwidth
end
properties(Nontunable, Hidden)
Timeout = Inf;
kernelBuffersCount = 2;
dataTypeStr = 'int16';
phyDevName = 'ad9361-phy';

properties (Nontunable, Hidden)
Timeout = Inf
kernelBuffersCount = 2
dataTypeStr = 'int16'
phyDevName = 'ad9361-phy'
iioDevPHY
end

properties (Hidden, Constant)
ComplexData = true;
ComplexData = true
end

methods

%% Constructor
function obj = Base(varargin)
coder.allowpcode('plain');
obj = obj@matlabshared.libiio.base(varargin{:});
end

% Destructor
function delete(obj)
teardownLibad9361(obj);
delete@adi.common.RxTx(obj);
end

% Check SamplesPerFrame
function set.SamplesPerFrame(obj, value)
validateattributes( value, { 'double','single' }, ...
{ 'real', 'positive','scalar', 'finite', 'nonnan', 'nonempty','integer','>',0,'<=',2^20}, ...
'', 'SamplesPerFrame');
validateattributes(value, { 'double', 'single' }, ...
{ 'real', 'positive', 'scalar', 'finite', 'nonnan', 'nonempty', 'integer', '>', 0, '<=', 2^20}, ...
'', 'SamplesPerFrame');
obj.SamplesPerFrame = value;
end

% Check EnableCustomFilter
function set.EnableCustomFilter(obj, value)
validateattributes( value, { 'logical' }, ...
{ }, ...
'', 'EnableCustomFilter');
validateattributes(value, { 'logical' }, ...
{ }, ...
'', 'EnableCustomFilter');
obj.EnableCustomFilter = value;
end

% Check CustomFilterFileName
function set.CustomFilterFileName(obj, value)
validateattributes( value, { 'char' }, ...
{ }, ...
'', 'CustomFilterFileName');
validateattributes(value, { 'char' }, ...
{ }, ...
'', 'CustomFilterFileName');
obj.CustomFilterFileName = value;
if obj.EnableCustomFilter && obj.ConnectedToDevice %#ok<MCSUP>
writeFilterFile(obj);
end
end

end

%% API Functions
methods (Hidden, Access = protected)

function icon = getIconImpl(obj)
icon = sprintf(['AD9361 ',obj.Type]);
icon = sprintf(['AD9361 ', obj.Type]);
end

function setupLibad9361(obj)
libName = 'libad9361';
ad9361wrapperh = 'ad9361-wrapper.h';
ad9361h = 'ad9361.h';
fp = fileparts(which(ad9361h));
loadlibraryArgs = {ad9361wrapperh,'includepath',fp,'addheader',ad9361h};
loadlibraryArgs = {ad9361wrapperh, 'includepath', fp, 'addheader', ad9361h};
if ~libisloaded(libName)
msgID = 'MATLAB:loadlibrary:StructTypeExists';
warnStruct = warning('off',msgID);
warnStruct = warning('off', msgID);
[~, ~] = loadlibrary(libName, loadlibraryArgs{:});
warning(warnStruct);
end
obj.iioDevPHY = calllib('libiio', 'iio_context_find_device',obj.iioCtx,'ad9361-phy');
obj.iioDevPHY = calllib('libiio', 'iio_context_find_device', obj.iioCtx, 'ad9361-phy');
end

function teardownLibad9361(~)
libName = 'libad9361';
if libisloaded(libName)
unloadlibrary(libName);
end
end

function writeFilterFile(obj)
fir_data_file = obj.CustomFilterFileName;
fir_data_str = fileread(fir_data_file);
obj.setAttributeRAW('voltage0','filter_fir_en','0',false);
obj.setAttributeRAW('voltage0','filter_fir_en','0',true);
obj.setDeviceAttributeRAW('filter_fir_config',fir_data_str);
obj.setAttributeRAW('voltage0','filter_fir_en','1',true);
obj.setAttributeRAW('voltage0','filter_fir_en','1',false);
obj.setAttributeRAW('voltage0', 'filter_fir_en', '0', false);
obj.setAttributeRAW('voltage0', 'filter_fir_en', '0', true);
obj.setDeviceAttributeRAW('filter_fir_config', fir_data_str);
obj.setAttributeRAW('voltage0', 'filter_fir_en', '1', true);
obj.setAttributeRAW('voltage0', 'filter_fir_en', '1', false);
end

end

%% External Dependency Methods
methods (Hidden, Static)

function tf = isSupportedContext(bldCfg)
tf = matlabshared.libiio.ExternalDependency.isSupportedContext(bldCfg);
end

function updateBuildInfo(buildInfo, bldCfg)
% Call the matlabshared.libiio.method first
matlabshared.libiio.ExternalDependency.updateBuildInfo(buildInfo, bldCfg);
end

function bName = getDescriptiveName(~)
bName = 'AD9361';
end

end
end

Loading
Loading