Automatic doc update: c633867

Sensirion · Oct 6, 2023 · 51fc76d · 51fc76d
1 parent e4dfb34
commit 51fc76d
Show file tree

Hide file tree

Showing 23 changed files with 162 additions and 81 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 412fcc15acb92df00c6d76ac89b054b3
+config: 7805b28a66c7c0b6fc1949127548b041
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/index.html b/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; sensirion_i2c_sfm_sf06 1.0.0 documentation</title>
+  <title>Overview: module code &mdash; sensirion_i2c_sfm_sf06 2.0.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../index.html" class="icon icon-home"> sensirion_i2c_sfm_sf06
           </a>
               <div class="version">
-                1.0.0
+                2.0.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/_modules/sensirion_i2c_sfm_sf06/commands.html b/_modules/sensirion_i2c_sfm_sf06/commands.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>sensirion_i2c_sfm_sf06.commands &mdash; sensirion_i2c_sfm_sf06 1.0.0 documentation</title>
+  <title>sensirion_i2c_sfm_sf06.commands &mdash; sensirion_i2c_sfm_sf06 2.0.0 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../index.html" class="icon icon-home"> sensirion_i2c_sfm_sf06
           </a>
               <div class="version">
-                1.0.0
+                2.0.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -78,9 +78,9 @@ <h1>Source code for sensirion_i2c_sfm_sf06.commands</h1><div class="highlight"><
 <span class="c1">#</span>
 <span class="c1">#     THIS FILE IS AUTOMATICALLY GENERATED!</span>
 <span class="c1">#</span>
-<span class="c1"># Generator:    sensirion-driver-generator 0.20.0</span>
-<span class="c1"># Product:      sfm_sf06</span>
-<span class="c1"># Version:      1.0</span>
+<span class="c1"># Generator:     sensirion-driver-generator 0.32.0</span>
+<span class="c1"># Product:       sfm_sf06</span>
+<span class="c1"># Model-Version: 1.3</span>
 <span class="c1">#</span>
 <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">The transfer classes specify the data that is transferred between host and sensor. The generated transfer classes</span>

diff --git a/_modules/sensirion_i2c_sfm_sf06/device.html b/_modules/sensirion_i2c_sfm_sf06/device.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>sensirion_i2c_sfm_sf06.device &mdash; sensirion_i2c_sfm_sf06 1.0.0 documentation</title>
+  <title>sensirion_i2c_sfm_sf06.device &mdash; sensirion_i2c_sfm_sf06 2.0.0 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../index.html" class="icon icon-home"> sensirion_i2c_sfm_sf06
           </a>
               <div class="version">
-                1.0.0
+                2.0.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -78,17 +78,16 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 <span class="c1">#</span>
 <span class="c1">#     THIS FILE IS AUTOMATICALLY GENERATED!</span>
 <span class="c1">#</span>
-<span class="c1"># Generator:    sensirion-driver-generator 0.20.0</span>
-<span class="c1"># Product:      sfm_sf06</span>
-<span class="c1"># Version:      1.0</span>
+<span class="c1"># Generator:     sensirion-driver-generator 0.32.0</span>
+<span class="c1"># Product:       sfm_sf06</span>
+<span class="c1"># Model-Version: 1.3</span>
 <span class="c1">#</span>
 <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">The class SfmSf06DeviceBase implements the low level interface of the sensor.</span>
 <span class="sd">The class SfmSf06Device extends the SfmSf06DeviceBase. It provides additional functions to ease the use of the</span>
 <span class="sd">sensor.</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
-<span class="kn">import</span> <span class="nn">time</span>
 <span class="kn">from</span> <span class="nn">sensirion_driver_adapters.transfer</span> <span class="kn">import</span> <span class="n">execute_transfer</span>
 <span class="kn">from</span> <span class="nn">sensirion_driver_support_types.mixin_access</span> <span class="kn">import</span> <span class="n">MixinAccess</span>
 <span class="kn">from</span> <span class="nn">sensirion_i2c_sfm_sf06.commands</span> <span class="kn">import</span> <span class="p">(</span><span class="n">ConfigureAveraging</span><span class="p">,</span> <span class="n">EnterSleep</span><span class="p">,</span> <span class="n">ExitSleep</span><span class="p">,</span> <span class="n">ReadMeasurementData</span><span class="p">,</span>
@@ -126,6 +125,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 <span class="sd">          - SFM3013-300-CL</span>
 <span class="sd">          - SFM3013-300-CLM</span>
 <span class="sd">          - SFM3019</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during</span>
+<span class="sd">            the first 30ms (including the 12ms)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">StartO2ContinuousMeasurement</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>
@@ -144,6 +147,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 <span class="sd">          - SFM3013-300-CL</span>
 <span class="sd">          - SFM3013-300-CLM</span>
 <span class="sd">          - SFM3019</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during</span>
+<span class="sd">            the first 30ms (including the 12ms)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">StartAirContinuousMeasurement</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>
@@ -158,6 +165,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 <span class="sd">        Supported by products:</span>
 <span class="sd">          - SFM4300-20</span>
 <span class="sd">          - SFM3013-300-CLM (HeOx)</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during the first 30ms</span>
+<span class="sd">            (including the 12ms)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">StartN2OContinuousMeasurement</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>
@@ -171,6 +182,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 
 <span class="sd">        Supported by products:</span>
 <span class="sd">          - SFM4300-20</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during</span>
+<span class="sd">            the first 30ms (including the 12ms)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">StartCO2ContinuousMeasurement</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>
@@ -244,6 +259,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 <span class="sd">            Gives information about the measurement command that is currently running, information on the currently selected</span>
 <span class="sd">            averaging mode, and the defined gas concentration of the current measurement command.</span>
 <span class="sd">            A detailed description of the *status_word* can be found in the data sheet.</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during</span>
+<span class="sd">            the first 30ms (including the 12ms)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">ReadMeasurementData</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>
@@ -257,6 +276,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 
 <span class="sd">        :param volume_fraction:</span>
 <span class="sd">            Fraction value</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            - The concentration value must not be updated more than once per millisecond</span>
+<span class="sd">            - If a concentration value greater than 1000 is passed to the sensor, the measurement mode will stop.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">UpdateConcentrationSet</span><span class="p">(</span><span class="n">volume_fraction</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>
@@ -267,6 +290,10 @@ <h1>Source code for sensirion_i2c_sfm_sf06.device</h1><div class="highlight"><pr
 <span class="sd">        The instruction resets the I2C address pointer to the regular result output buffer such that the measurement</span>
 <span class="sd">        data as described by the transfer read_measurement_data are optained upon a subsequent read.</span>
 <span class="sd">        This instruction refers to *Reset-i2c address pointer*. For more details see data-sheet section *Update Concentration*</span>
+
+<span class="sd">        .. note::</span>
+<span class="sd">            - The concentration value must not be updated more than once per millisecond</span>
+<span class="sd">            - If a concentration value greater than 1000 is passed to the sensor, the measurement mode will stop.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">transfer</span> <span class="o">=</span> <span class="n">UpdateConcentrationActivate</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">execute_transfer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span> <span class="n">transfer</span><span class="p">)</span></div>

diff --git a/_modules/sensirion_i2c_sfm_sf06/result_types.html b/_modules/sensirion_i2c_sfm_sf06/result_types.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>sensirion_i2c_sfm_sf06.result_types &mdash; sensirion_i2c_sfm_sf06 1.0.0 documentation</title>
+  <title>sensirion_i2c_sfm_sf06.result_types &mdash; sensirion_i2c_sfm_sf06 2.0.0 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -29,7 +29,7 @@
             <a href="../../index.html" class="icon icon-home"> sensirion_i2c_sfm_sf06
           </a>
               <div class="version">
-                1.0.0
+                2.0.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -78,9 +78,9 @@ <h1>Source code for sensirion_i2c_sfm_sf06.result_types</h1><div class="highligh
 <span class="c1">#</span>
 <span class="c1">#     THIS FILE IS AUTOMATICALLY GENERATED!</span>
 <span class="c1">#</span>
-<span class="c1"># Generator:    sensirion-driver-generator 0.20.0</span>
-<span class="c1"># Product:      sfm_sf06</span>
-<span class="c1"># Version:      1.0</span>
+<span class="c1"># Generator:     sensirion-driver-generator 0.32.0</span>
+<span class="c1"># Product:       sfm_sf06</span>
+<span class="c1"># Model-Version: 1.3</span>
 <span class="c1">#</span>
 <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">The signal classes specify transformations of the raw sensor signals into a meaningful units.</span>

diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -7,6 +7,7 @@ SFM-SF06
 SfmSf06Device
 ~~~~~~~~~~~~~
 
+
 .. automodule:: sensirion_i2c_sfm_sf06.device
 
 Commands

diff --git a/_sources/execute-measurements.rst.txt b/_sources/execute-measurements.rst.txt
@@ -16,11 +16,11 @@ execute a simple measurement.
 5. Run the example script from the root of the repository.
 
    By default the script assumes the SensorBridge is connected to :code:`COM1` serial port. If this is different on your system,
-   pass the port in use with the :code:`--serial_port` parameter as outlined below.
+   pass the port in use with the :code:`--serial-port` parameter as outlined below.
 
    .. sourcecode:: bash
 
-        python examples/example_usage_sensorbridge_sfm_sf06.py --serial_port <your COM port>
+        python examples/example_usage_sensorbridge_sfm_sf06.py --serial-port <your COM port>
 
 
 .. _Sensirion SEK-SensorBridge: https://developer.sensirion.com/sensirion-products/sek-sensorbridge/
@@ -43,11 +43,11 @@ How this can be done is shown in the following.
 3. Run the example script from the root of the repository.
 
    By default the script assumes you have the sensor connected to :code:`/dev/i2c-1`.
-   If this is different on your system, pass the port in use with the :code:`--i2c_port` parameter as outlined below.
+   If this is different on your system, pass the port in use with the :code:`--i2c-port` parameter as outlined below.
 
    .. sourcecode:: bash
 
-      python examples/example_usage_sensorbridge_sfm_sf06.py --i2c_port <your I2C port>
+      python examples/example_usage_linux_sfm_sf06.py --i2c-port <your I2C port>
 
 Example script
 ~~~~~~~~~~~~~~

diff --git a/_sources/run-tests.rst.txt b/_sources/run-tests.rst.txt
@@ -6,16 +6,26 @@ Unit tests can be run with `pytest <https://pytest.org>`_:
 .. code-block:: bash
 
     pip install -e .[test]                       # Install requirements
-    pytest -m "not needs_device"                 # Run tests without hardware
-    pytest                                       # Run all tests
-    pytest -m "needs_device"                     # Run all tests for SFM-SF06
 
 
-The tests with the marker `needs_device` have following requirements:
+We provide a mock implementation that allows you to execute the tests for SFM-SF06 without hardware.
+
+.. code-block:: bash
+
+    pytest                                       # Run all tests for SFM-SF06 using a driver mock
+
+To use the real hardware you have to connect your SFM-SF06 sensor to a
+`SensorBridge <https://sensirion.com/products/catalog/SEK-SensorBridge/>`_ on port 1. Assuming the SensorBridge is
+attached to COM1 you can start the tests with the following command:
+
+.. code-block:: bash
+
+    pytest --serial-port=COM1                    # Run all tests for SFM-SF06 on the sensor attached to COM1
+
+
+.. note::
+    The SensorBridge must have default settings (baudrate 460800, address 0)
+
+
 
-- The SFM-SF06 sensor must be connected to a
-  `SensorBridge <https://sensirion.com/products/catalog/SEK-SensorBridge/>`_ on port 1.
-- Pass the serial port where the SensorBridge is connected with
-  `--serial-port`, e.g. `pytest --serial-port=COM7`
-- The SensorBridge must have default settings (baudrate 460800, address 0)
 
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.0',
+    VERSION: '2.0.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/pygments.css b/_static/pygments.css
@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */