Merge branch 'master' of https://vcs01.picotech.co.uk/Tech-Support/PicoSDK-VNA-Examples/picosdk-matlab-picovna-vector-network-analyzer-toolbox

Author: neil-hamilton

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -1,57 +1,59 @@
-# PicoVNA Vector Network Analyzer Toolbox
-
-The PicoVNA Vector Network Analyzer Toolbox provides a set of functions and examples for use with Pico Technology PicoVNA<sup>TM</sup> Vector Network Analyzer products directly from MATLAB. 
-This toolbox contains Help documentation that can be accessed via the Documentation page in the MATLAB Help menu.
-
-Users downloading the zip file will need to add the root folder and sub-folders to the MATLAB path.
-
-## Getting started
-
-### Prerequisites
-
-* [MATLAB](https://uk.mathworks.com/products/matlab.html) for Microsoft Windows (32-bit)
-* PicoVNA 2 software (see [Installing software](#Installing software))
-
-**Notes:**
-
-* MATLAB 2015b is recommended for 32-bit versions of MATLAB on Microsoft Windows operating systems.
-* The interface to the PicoVNA Network Analyzers is not currently compatible with 64-bit versions of MATLAB. 
-
-### Supported models
-
-* PicoVNA 106
-
-### Installing the PicoVNA Vector Network Analyzer Toolbox files
-
-We recommend using the [Add-Ons Explorer](https://uk.mathworks.com/help/matlab/matlab_env/get-add-ons.html) in MATLAB in order to install these files and obtain updates.
-
-If your version of MATLAB does not have the Add-Ons Explorer, download the zip file from the [MATLAB Central File Exchange page]()
- and add the root and sub-folders to the MATLAB path.
- 
-### Installing software
-
-* Download the PicoVNA 2 software from our [Downloads page](https://www.picotech.com/downloads).
-
-## Obtaining support
-
-Please visit our [Support page](https://www.picotech.com/tech-support) to contact us directly or visit our [Test and Measurement Forum](https://www.picotech.com/support/forum71.html) to post questions.
-
-Issues can be reported via the [Issues tab](https://github.com/picotech/picosdk-matlab-picovna-vector-network-analyzer-toolbox/issues).
-
-Please leave a comment and rating for this submission on our [MATLAB Central File Exchange page]().
-
-## Code of conduct
-
-Please refer to our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
-
-## Copyright and licensing
-
-See [LICENSE.md](LICENSE.md) for license terms. 
-
-*PicoVNA* is a registered trademark of Pico Technology Ltd. 
-
-*MATLAB* is a registered trademark of The Mathworks, Inc.
-
-*Windows* is a registered trademark of Microsoft Corporation. 
-
+# PicoVNA Vector Network Analyzer Toolbox
+
+The PicoVNA Vector Network Analyzer Toolbox provides a set of functions and examples for use with Pico Technology PicoVNA<sup>®</sup> Vector Network Analyzer products directly from MATLAB. 
+This toolbox contains Help documentation that can be accessed via the Documentation page in the MATLAB Help menu.
+
+Users downloading the zip file will need to add the root folder and sub-folders to the MATLAB path.
+
+## Getting started
+
+### Prerequisites
+
+* [MATLAB](https://uk.mathworks.com/products/matlab.html) for Microsoft Windows (32-bit)
+* [RF Toolbox](https://uk.mathworks.com/products/rftoolbox.html)
+* PicoVNA 2 software (see [Installing software](#installing-software))
+
+**Notes:**
+
+* MATLAB 2015b is recommended for 32-bit versions of MATLAB on Microsoft Windows operating systems.
+* The interface to the PicoVNA Network Analyzers is not currently compatible with 64-bit versions of MATLAB. 
+* RF Toolbox is required for the S11 Smith Chart example.
+
+### Supported models
+
+* PicoVNA 106
+
+### Installing the PicoVNA Vector Network Analyzer Toolbox files
+
+We recommend using the [Add-Ons Explorer](https://uk.mathworks.com/help/matlab/matlab_env/get-add-ons.html) in MATLAB in order to install these files and obtain updates.
+
+If your version of MATLAB does not have the Add-Ons Explorer, download the zip file from the [MATLAB Central File Exchange page](https://uk.mathworks.com/matlabcentral/fileexchange/66035-picovna-vector-network-analyzer-toolbox)
+ and add the root and sub-folders to the MATLAB path.
+ 
+### Installing software
+
+* Download the PicoVNA 2 software from our [Downloads page](https://www.picotech.com/downloads).
+
+## Obtaining support
+
+Please visit our [Support page](https://www.picotech.com/tech-support) to contact us directly or visit our [Test and Measurement Forum](https://www.picotech.com/support/forum71.html) to post questions.
+
+Issues can be reported via the [Issues tab](https://github.com/picotech/picosdk-matlab-picovna-vector-network-analyzer-toolbox/issues).
+
+Please leave a comment and rating for this submission on our [MATLAB Central File Exchange page](https://uk.mathworks.com/matlabcentral/fileexchange/66035-picovna-vector-network-analyzer-toolbox).
+
+## Code of conduct
+
+Please refer to our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
+
+## Copyright and licensing
+
+See [LICENSE.md](LICENSE.md) for license terms.
+
+*PicoVNA* is a registered trademark of Pico Technology Ltd.
+
+*MATLAB* is a registered trademark of The Mathworks, Inc. *RF Toolbox* is a registered trademark of The Mathworks, Inc.
+
+*Windows* is a registered trademark of Microsoft Corporation.
+
 Copyright © 2017-2018 Pico Technology Ltd. All rights reserved.

examples/PicoVNA_DUT_PassFail_Testing_Example.m

@@ -2,17 +2,17 @@
 %
 % This is an example of a Pass/Fail test using the PicoVNA. This compares a
 % S21 log magnitude sweep from a device to the same measurement of a
-% prevously measured Golden DUT using the PicoVNA_GoldenDUT_Example.m file.
+% previously measured Golden DUT using the |PicoVNA_GoldenDUT_Example.m| file.
 %
 % To run this example session, type the name of the file,
-% PicoVNA_DUT_PassFail_Testing_Example, in the MATLAB Command Window.
+% |PicoVNA_DUT_PassFail_Testing_Example|, in the MATLAB Command Window.
 %
-% The file, PicoVNA_DUT_PassFail_Testing_Example.m must be on your MATLAB
-% Path. For additional information on setting your MATLAB path, type 'help
-% addpath' in the MATLAB Command Window
+% The file, |PicoVNA_DUT_PassFail_Testing_Example.m| must be on your MATLAB
+% Path. For additional information on setting your MATLAB path, see
+% <matlab:doc('addpath') addpath>.
 %
-% Additionally you must have the .cal file for your device and the
-% GoldenDUT.mat file in the current folder.
+% Additionally you must have the |.cal| file for your device and the
+% |GoldenDUT.mat| file in the current folder.
 %
 % *Example:*
 %   PicoVNA_DUT_PassFail_Testing_Example;
@@ -37,21 +37,21 @@
 %% Load calibration
 % Load a calibration and settings file.
 % This needs to be generated and saved using the PicoVNA2 software.
-
-% Replace DefCal.cal with the correct calibration for your device, 'Pico TD
-% demo with limits [Serial#].cal'.
+%
+% Replace |DefCal.cal| with the correct calibration for your device, |Pico TD
+% demo with limits [Serial#].cal|.
 
 picoVNACOMObj.LoadCal('DefCal.cal');
 
 %% Load Golden DUT log magnitude
 % Load in the reference data from the Golden Dut captured using
-% PicoVNA_GoldenDUT_Example.m
+% <PicoVNA_GoldenDUT_Example.html |PicoVNA_GoldenDUT_Example|>
 
 load('GoldenDUT.mat');
 
 %% Create pass band
 % Create a pass band using the Golden DUT data and the tolererance in dB of
-% the testing for comparision with the DUTs later.
+% the testing for comparison with the DUTs later.
 
 tolerance = 0.2; % Tolerance of the cable in dB
 
@@ -159,4 +159,4 @@
 
 disconnectVNA(picoVNACOMObj)
 close PicoVNA 
-clear ans ax1 flag go i k n picoVNACOMObj
+clear ans ax1 flag go i k n picoVNACOMObj

examples/PicoVNA_GoldenDUT_Example.m

@@ -3,16 +3,16 @@
 % This is an example of Golden DUT data aquisition using the PicoVNA.  This
 % makes a measurement of the Golden DUT and retrieves the S21 log magnitude
 % data from the VNA ready for use in the
-% PicoVNA_DUT_PassFail_Testing_Example.
+% <PicoVNA_DUT_PassFail_testing_Example.html |PicoVNA_DUT_PassFail_Testing_Example|>.
 %
 % To run this example session, type the name of the file,
-% PicoVNA_GoldenDUT_Example, in the MATLAB Command Window.
+% |PicoVNA_GoldenDUT_Example|, in the MATLAB Command Window.
 %
-% The file, PicoVNA_GoldenDUT_Example.m must be on your MATLAB PAth. For
-% additional information on setting your MATLAB path, type 'help addpath'
-% in the MATLAB Command Window
+% The file, |PicoVNA_GoldenDUT_Example.m| must be on your MATLAB Path. For
+% additional information on setting your MATLAB path, see
+% <matlab:doc('addpath') addpath>.
 %
-% Additionally you must have the .cal file for your device in the current
+% Additionally you must have the |.cal| file for your device in the current
 % folder.
 %
 % *Example:*
@@ -36,10 +36,10 @@
 
 %% Load calibration
 % Load a calibration and settings file.
-% This needs to be generated and saved using the PicoVNA2 software.
-
-% Replace DefCal.cal with the correct calibration for your device, 'Pico TD
-% demo with limits [Serial#].cal'.
+% This needs to be generated and saved using the PicoVNA 2 software.
+%
+% Replace |DefCal.cal| with the correct calibration for your device, |Pico TD
+% demo with limits [Serial#].cal|.
 picoVNACOMObj.LoadCal('DefCal.cal');
 
 %% Measure Golden DUT
@@ -50,12 +50,12 @@
 [Golden.Frequency, Golden.S12LogMag] = getBlockDataVNA(picoVNACOMObj,'S21','logmag');
 
 %% Save Golden DUT Data
-% Save the Golden DUT data read for use in the Pass/Fail Testing Example.
+% Save the Golden DUT data read for use in the <PicoVNA_DUT_PassFail_Testing_example.html Pass/Fail Testing Example>.
 
 save ('GoldenDUT.mat', 'Golden');
 
 %% Disconnect VNA
 
 disconnectVNA(picoVNACOMObj);
 
-disp('Complete');
+disp('Complete');

examples/PicoVNA_S11_Smith_Chart_Example.m

@@ -5,13 +5,13 @@
 % Chart.
 %
 % To run this example session, type the name of the file,
-% PicoVNA_S11_Smith_Chart_Example, in the MATLAB Command Window.
+% |PicoVNA_S11_Smith_Chart_Example|, in the MATLAB Command Window.
 %
-% The file, PicoVNA_S11_Smith_Chart_Example.m must be on your MATLAB Path. For
-% additional information on setting your MATLAB path, type 'help addpath' in
-% the MATLAB Command Window.
+% The file, |PicoVNA_S11_Smith_Chart_Example.m| must be on your MATLAB Path. For
+% additional information on setting your MATLAB path, see
+% <matlab:doc('addpath') addpath>.
 %
-% Additionally you must have the .cal file for your device in the current
+% Additionally you must have the |.cal| file for your device in the current
 % folder.
 %
 % <https://uk.mathworks.com/products/rftoolbox.html RF Toolbox> is required for this example.
@@ -36,10 +36,10 @@
 
 %% Load calibration
 % Load a calibration and settings file.
-% This needs to be generated and saved using the PicoVNA2 software.
-
-% Replace DefCal.cal with the correct calibration for your device, 'Pico TD
-% demo with limits [Serial#].cal'.
+% This needs to be generated and saved using the PicoVNA 2 software.
+%
+% Replace |DefCal.cal| with the correct calibration for your device, |Pico TD
+% demo with limits [Serial#].cal|.
 
 picoVNACOMObj.LoadCal('DefCal.cal');
 
@@ -91,4 +91,4 @@
 
 % Tidy workspace
 close PicoVNA 
-clear ans flag go stopFig picoVNACOMObj
+clear ans flag go stopFig picoVNACOMObj

examples/PicoVNA_Rapid_Block_Example.m examples/PicoVNA_S_Parameter_Example.mexamples/PicoVNA_Rapid_Block_Example.m renamed to examples/PicoVNA_S_Parameter_Example.m

@@ -1,26 +1,27 @@
-%% PicoVNA Rapid Block Example
+%% PicoVNA S-Parameter Example
 %
 % This is an example of setting up the connection with the Pico Technology
-% PicoVNA 106, loading calibration data, making measurements and collecting
-% the log magnitude data for S11, S12, S21 and S22.
+% PicoVNA Vector Newtwork Analyzer, loading calibration data, making measurements and collecting
+% the log magnitude data for S11, S12, S21 and S22 parameters.
 %
 % To run this example session, type the name of the file,
-% PicoVNA_Rapid_Block_Example, in the MATLAB Command Window.
+% |PicoVNA_S_Parameter_Example|, in the MATLAB Command Window.
 %
-% The file, PicoVNA_Rapid_Block_Example.m must be on your MATLAB Path. For
-% additional information on setting your MATLAB path, type 'help addpath' in
-% the MATLAB Command Window
+% The file, |PicoVNA_S_Parameter_Example.m| must be on your MATLAB Path. For
+% additional information on setting your MATLAB path, see
+% <matlab:doc('addpath') addpath>.
 %
-% Additionally you must have the .cal file for your device in the current
+% Additionally you must have the |.cal| file for your device in the current
 % folder.
 %
 % *Example:*
-%   PicoVNA_Rapid_Block_Example;
+%   PicoVNA_S-Parameter_Example;
 %
 % *Description:*
 % Demonstrates how to connect to the VNA, load in a calibration, make
-% measurements and collect data for S11, S12, S21 and S22.  The measurement
-% and data collection is looped until the user stops the process.
+% measurements and collect data for S11, S12, S21 and S22 parameters.  The
+% S-parameters are plotted onto auto-scaled plots.  The measurement and
+% data collection is looped until the user stops the process.
 %
 % *Copyright:* © 2017-2018 Pico Technology Ltd. See LICENSE file for terms.
 
@@ -36,6 +37,7 @@
 
 %% Load Calibration
 % Load a calibration and settings file.
+<<<<<<< HEAD:examples/PicoVNA_Rapid_Block_Example.m
 % This needs to be generated and saved using the PicoVNA2 software.
 
 % Replace DefCal.cal with the correct calibration for your device, 'Pico TD
@@ -44,6 +46,13 @@
 
 %%
 ans1 = picoVNACOMObj.SetEnhance('BW', 140000);
+=======
+% This needs to be generated and saved using the PicoVNA 2 software.
+%
+% Replace |DefCal.cal| with the correct calibration for your device, |Pico TD
+% demo with limits [Serial#].cal|.
+picoVNACOMObj.LoadCal('DefCal.cal');
+>>>>>>> 2cfc4b692078fea93da97288c75f6be6cdb49fa4:examples/PicoVNA_S_Parameter_Example.m
 
 %% Stop button for exiting loop
 % Create a stop button for exiting rapid block capture and for displaying
@@ -196,4 +205,4 @@
 disconnectVNA(picoVNACOMObj)
 
 % Tidy workspace
-clear ans flag go maxS11 minS11 maxS12 minS12 maxS21 minS21 maxS22 minS22 picoVNACOMObj
+clear ans flag go maxS11 minS11 maxS12 minS12 maxS21 minS21 maxS22 minS22 picoVNACOMObj