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

neil.hamilton · neil.hamilton · commit 20242e8332ee · 2018-03-14T15:59:00.000Z
diff --git a/.github/CODE_OF_CONDUCT.md b/.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 support@picotech.com. 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/
diff --git a/README.md b/README.md
@@ -10,12 +10,14 @@ Users downloading the zip file will need to add the root folder and sub-folders
 ### Prerequisites
 
 * [MATLAB](https://uk.mathworks.com/products/matlab.html) for Microsoft Windows (32-bit)
-* PicoVNA 2 software (see [Installing software](#Installing software))
+* [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
 
@@ -25,7 +27,7 @@ Users downloading the zip file will need to add the root folder and sub-folders
 
 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]()
+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
@@ -38,7 +40,7 @@ Please visit our [Support page](https://www.picotech.com/tech-support) to contac
 
 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]().
+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
 
@@ -50,8 +52,8 @@ See [LICENSE.md](LICENSE.md) for license terms.
 
 *PicoVNA* is a trademark of Pico Technology Ltd. 
 
-*MATLAB* is a registered trademark of The Mathworks, Inc.
+*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.
+Copyright � 2017-2018 Pico Technology Ltd. All rights reserved.
diff --git a/examples/PicoVNA_S_Parameter_Example.m b/examples/PicoVNA_S_Parameter_Example.m
@@ -5,10 +5,11 @@
 % the log magnitude data for S11, S12, S21 and S22 parameters.
 %
 % To run this example session, type the name of the file,
-% |PicoVNA_S-Parameter_Example|, in the MATLAB Command Window.
+% |PicoVNA_S_Parameter_Example|, 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>
+% 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
 % folder.
diff --git a/help/demos.xml b/help/demos.xml
@@ -11,7 +11,7 @@
         <demoitem>
             <label>PicoVNA S-Parameter Example</label>
             <type>M-file</type>
-            <source>PicoVNA_S-Paramater_Example</source>
+            <source>PicoVNA_S-Parameter_Example</source>
         </demoitem>
         <demoitem>
             <label>PicoVNA S11 Smith Chart Example</label>
diff --git a/help/html/PicoVNA_S_Parameter_Example.html b/help/html/PicoVNA_S_Parameter_Example.html
@@ -6,7 +6,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>PicoVNA S-Parameter Example</title><meta name="generator" content="MATLAB 8.6"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2018-02-12"><meta name="DC.source" content="PicoVNA_S-Parameter_Example.m"><style type="text/css">
+      --><title>PicoVNA S-Parameter Example</title><meta name="generator" content="MATLAB 8.6"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2018-02-13"><meta name="DC.source" content="PicoVNA_S_Parameter_Example.m"><style type="text/css">
 html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outine:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
 
 html { min-height:100%; margin-bottom:1px; }
@@ -66,7 +66,7 @@
 
 
 
-  </style></head><body><div class="content"><h1>PicoVNA S-Parameter Example</h1><!--introduction--><p>This is an example of setting up the connection with the Pico Technology PicoVNA Vector Newtwork Analyzer, loading calibration data, making measurements and collecting the log magnitude data for S11, S12, S21 and S22 parameters.</p><p>To run this example session, type the name of the file, <tt>PicoVNA_S-Parameter_Example</tt>, in the MATLAB Command Window.</p><p>The file, <tt>PicoVNA_S-Parameter_Example.m</tt> must be on your MATLAB Path. For additional information on setting your MATLAB path, see <a href="matlab:doc('addpath')">addpath</a></p><p>Additionally you must have the <tt>.cal</tt> file for your device in the current folder.</p><p><b>Example:</b>   PicoVNA_S-Parameter_Example;</p><p><b>Description:</b> Demonstrates how to connect to the VNA, load in a calibration, make 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.</p><p><b>Copyright:</b> &copy; 2017-2018 Pico Technology Ltd. See LICENSE file for terms.</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Clear workspace, command window and close figures</a></li><li><a href="#2">Connect to VNA</a></li><li><a href="#3">Load Calibration</a></li><li><a href="#4">Stop button for exiting loop</a></li><li><a href="#5">Capture and plot data</a></li><li><a href="#6">Disconnect VNA</a></li></ul></div><h2>Clear workspace, command window and close figures<a name="1"></a></h2><pre class="codeinput">clear;
+  </style></head><body><div class="content"><h1>PicoVNA S-Parameter Example</h1><!--introduction--><p>This is an example of setting up the connection with the Pico Technology PicoVNA Vector Newtwork Analyzer, loading calibration data, making measurements and collecting the log magnitude data for S11, S12, S21 and S22 parameters.</p><p>To run this example session, type the name of the file, <tt>PicoVNA_S_Parameter_Example</tt>, in the MATLAB Command Window.</p><p>The file, <tt>PicoVNA_S_Parameter_Example.m</tt> must be on your MATLAB Path. For additional information on setting your MATLAB path, see <a href="matlab:doc('addpath')">addpath</a>.</p><p>Additionally you must have the <tt>.cal</tt> file for your device in the current folder.</p><p><b>Example:</b>   PicoVNA_S-Parameter_Example;</p><p><b>Description:</b> Demonstrates how to connect to the VNA, load in a calibration, make 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.</p><p><b>Copyright:</b> &copy; 2017-2018 Pico Technology Ltd. See LICENSE file for terms.</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Clear workspace, command window and close figures</a></li><li><a href="#2">Connect to VNA</a></li><li><a href="#3">Load Calibration</a></li><li><a href="#4">Stop button for exiting loop</a></li><li><a href="#5">Capture and plot data</a></li><li><a href="#6">Disconnect VNA</a></li></ul></div><h2>Clear workspace, command window and close figures<a name="1"></a></h2><pre class="codeinput">clear;
 clc;
 close <span class="string">all</span>;
 </pre><h2>Connect to VNA<a name="2"></a></h2><pre class="codeinput">picoVNACOMObj = connectVNA;
@@ -224,10 +224,11 @@
 % the log magnitude data for S11, S12, S21 and S22 parameters.
 %
 % To run this example session, type the name of the file,
-% |PicoVNA_S-Parameter_Example|, in the MATLAB Command Window.
+% |PicoVNA_S_Parameter_Example|, 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>
+% 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
 % folder.
diff --git a/help/html/helptoc.xml b/help/html/helptoc.xml
@@ -1,9 +1,9 @@
 <?xml version='1.0' encoding="utf-8"?>
 <toc version="2.0">
     <tocitem target="picovna_tbx_gettingstarted.html"> Getting Started with PicoVNA Vector Network Analyzer
-        <tocitem target="picovna_tbx_support.html">Support</tocitem>
-        <tocitem target="picovna_tbx_troubleshooting.html">Troubleshooting</tocitem>
-        <tocitem target="picovna_tbx_releasenotes.html">Release Notes</tocitem>
         <tocitem target="picovna_tbx_functions.html">Functions</tocitem>
+        <tocitem target="picovna_tbx_releasenotes.html">Release Notes</tocitem>
+        <tocitem target="picovna_tbx_troubleshooting.html">Troubleshooting</tocitem>
+        <tocitem target="picovna_tbx_support.html">Support</tocitem>
     </tocitem>
 </toc>
diff --git a/help/html/picovna_tbx_releasenotes.html b/help/html/picovna_tbx_releasenotes.html
@@ -6,7 +6,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Release Notes</title><meta name="generator" content="MATLAB 8.6"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2018-02-08"><meta name="DC.source" content="picovna_tbx_releasenotes.m"><style type="text/css">
+      --><title>Release Notes</title><meta name="generator" content="MATLAB 8.6"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2018-02-13"><meta name="DC.source" content="picovna_tbx_releasenotes.m"><style type="text/css">
 html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outine:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
 
 html { min-height:100%; margin-bottom:1px; }
@@ -66,11 +66,10 @@
 
 
 
-  </style></head><body><div class="content"><h1>Release Notes</h1><p>Version 1.0: X Feb 2018 - Initial Submission on MATLAB Central File Exchange</p><p class="footer"><br><a href="http://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2015b</a><br></p></div><!--
+  </style></head><body><div class="content"><h1>Release Notes</h1><div><ul><li><b>Version 1.0:</b> 13th Feb. 2018 - Initial release.</li></ul></div><p class="footer"><br><a href="http://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2015b</a><br></p></div><!--
 ##### SOURCE BEGIN #####
 %% Release Notes
 %
-% Version 1.0: X Feb 2018 - Initial Submission on MATLAB Central File
-% Exchange
+% * *Version 1.0:* 13th Feb. 2018 - Initial release.
 ##### SOURCE END #####
 --></body></html>

Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,11 @@`
`5`	`5`	`% the log magnitude data for S11, S12, S21 and S22 parameters.`
`6`	`6`	`%`
`7`	`7`	`% To run this example session, type the name of the file,`
`8`		`-% \|PicoVNA_S-Parameter_Example\|, in the MATLAB Command Window.`
	`8`	`+% \|PicoVNA_S_Parameter_Example\|, in the MATLAB Command Window.`
`9`	`9`	`%`
`10`		`-% The file, \|PicoVNA_S-Parameter_Example.m\| must be on your MATLAB Path. For`
`11`		`-% additional information on setting your MATLAB path, see <matlab:doc('addpath') addpath>`
	`10`	`+% The file, \|PicoVNA_S_Parameter_Example.m\| must be on your MATLAB Path. For`
	`11`	`+% additional information on setting your MATLAB path, see`
	`12`	`+% <matlab:doc('addpath') addpath>.`
`12`	`13`	`%`
`13`	`14`	`% Additionally you must have the \|.cal\| file for your device in the current`
`14`	`15`	`% folder.`