diff --git a/.buildinfo b/.buildinfo index 09d7f78..1d97f05 100644 --- 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 index 4bbd525..74153fe 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -3,7 +3,7 @@ - Overview: module code — sensirion_i2c_sfm_sf06 1.0.0 documentation + Overview: module code — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -29,7 +29,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
diff --git a/_modules/sensirion_i2c_sfm_sf06/commands.html b/_modules/sensirion_i2c_sfm_sf06/commands.html index a62acfa..5909b9d 100644 --- a/_modules/sensirion_i2c_sfm_sf06/commands.html +++ b/_modules/sensirion_i2c_sfm_sf06/commands.html @@ -3,7 +3,7 @@ - sensirion_i2c_sfm_sf06.commands — sensirion_i2c_sfm_sf06 1.0.0 documentation + sensirion_i2c_sfm_sf06.commands — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -29,7 +29,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
@@ -78,9 +78,9 @@

Source code for sensirion_i2c_sfm_sf06.commands

< # # THIS FILE IS AUTOMATICALLY GENERATED! # -# Generator: sensirion-driver-generator 0.20.0 -# Product: sfm_sf06 -# Version: 1.0 +# Generator: sensirion-driver-generator 0.32.0 +# Product: sfm_sf06 +# Model-Version: 1.3 # """ The transfer classes specify the data that is transferred between host and sensor. The generated transfer classes diff --git a/_modules/sensirion_i2c_sfm_sf06/device.html b/_modules/sensirion_i2c_sfm_sf06/device.html index b2a3e7c..c013545 100644 --- a/_modules/sensirion_i2c_sfm_sf06/device.html +++ b/_modules/sensirion_i2c_sfm_sf06/device.html @@ -3,7 +3,7 @@ - sensirion_i2c_sfm_sf06.device — sensirion_i2c_sfm_sf06 1.0.0 documentation + sensirion_i2c_sfm_sf06.device — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -29,7 +29,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
@@ -78,9 +78,9 @@

Source code for sensirion_i2c_sfm_sf06.device

# # THIS FILE IS AUTOMATICALLY GENERATED! # -# Generator: sensirion-driver-generator 0.20.0 -# Product: sfm_sf06 -# Version: 1.0 +# Generator: sensirion-driver-generator 0.32.0 +# Product: sfm_sf06 +# Model-Version: 1.3 # """ The class SfmSf06DeviceBase implements the low level interface of the sensor. @@ -88,7 +88,6 @@

Source code for sensirion_i2c_sfm_sf06.device

sensor. """ -import time from sensirion_driver_adapters.transfer import execute_transfer from sensirion_driver_support_types.mixin_access import MixinAccess from sensirion_i2c_sfm_sf06.commands import (ConfigureAveraging, EnterSleep, ExitSleep, ReadMeasurementData, @@ -126,6 +125,10 @@

Source code for sensirion_i2c_sfm_sf06.device

- SFM3013-300-CL - SFM3013-300-CLM - SFM3019 + + .. note:: + The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during + the first 30ms (including the 12ms) """ transfer = StartO2ContinuousMeasurement() return execute_transfer(self._channel, transfer)
@@ -144,6 +147,10 @@

Source code for sensirion_i2c_sfm_sf06.device

- SFM3013-300-CL - SFM3013-300-CLM - SFM3019 + + .. note:: + The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during + the first 30ms (including the 12ms) """ transfer = StartAirContinuousMeasurement() return execute_transfer(self._channel, transfer)
@@ -158,6 +165,10 @@

Source code for sensirion_i2c_sfm_sf06.device

Supported by products: - SFM4300-20 - SFM3013-300-CLM (HeOx) + + .. note:: + The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during the first 30ms + (including the 12ms) """ transfer = StartN2OContinuousMeasurement() return execute_transfer(self._channel, transfer)
@@ -171,6 +182,10 @@

Source code for sensirion_i2c_sfm_sf06.device

Supported by products: - SFM4300-20 + + .. note:: + The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during + the first 30ms (including the 12ms) """ transfer = StartCO2ContinuousMeasurement() return execute_transfer(self._channel, transfer)
@@ -244,6 +259,10 @@

Source code for sensirion_i2c_sfm_sf06.device

Gives information about the measurement command that is currently running, information on the currently selected averaging mode, and the defined gas concentration of the current measurement command. A detailed description of the *status_word* can be found in the data sheet. + + .. note:: + The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during + the first 30ms (including the 12ms) """ transfer = ReadMeasurementData() return execute_transfer(self._channel, transfer)
@@ -257,6 +276,10 @@

Source code for sensirion_i2c_sfm_sf06.device

:param volume_fraction: Fraction value + + .. note:: + - The concentration value must not be updated more than once per millisecond + - If a concentration value greater than 1000 is passed to the sensor, the measurement mode will stop. """ transfer = UpdateConcentrationSet(volume_fraction) return execute_transfer(self._channel, transfer)
@@ -267,6 +290,10 @@

Source code for sensirion_i2c_sfm_sf06.device

The instruction resets the I2C address pointer to the regular result output buffer such that the measurement data as described by the transfer read_measurement_data are optained upon a subsequent read. This instruction refers to *Reset-i2c address pointer*. For more details see data-sheet section *Update Concentration* + + .. note:: + - The concentration value must not be updated more than once per millisecond + - If a concentration value greater than 1000 is passed to the sensor, the measurement mode will stop. """ transfer = UpdateConcentrationActivate() return execute_transfer(self._channel, transfer)
diff --git a/_modules/sensirion_i2c_sfm_sf06/result_types.html b/_modules/sensirion_i2c_sfm_sf06/result_types.html index 76709f8..3a47b58 100644 --- a/_modules/sensirion_i2c_sfm_sf06/result_types.html +++ b/_modules/sensirion_i2c_sfm_sf06/result_types.html @@ -3,7 +3,7 @@ - sensirion_i2c_sfm_sf06.result_types — sensirion_i2c_sfm_sf06 1.0.0 documentation + sensirion_i2c_sfm_sf06.result_types — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -29,7 +29,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
@@ -78,9 +78,9 @@

Source code for sensirion_i2c_sfm_sf06.result_types

# # THIS FILE IS AUTOMATICALLY GENERATED! # -# Generator: sensirion-driver-generator 0.20.0 -# Product: sfm_sf06 -# Version: 1.0 +# Generator: sensirion-driver-generator 0.32.0 +# Product: sfm_sf06 +# Model-Version: 1.3 # """ The signal classes specify transformations of the raw sensor signals into a meaningful units. diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt index cd01a04..6519de9 100644 --- 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 index dfae639..8b5862e 100644 --- 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 + python examples/example_usage_sensorbridge_sfm_sf06.py --serial-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 + python examples/example_usage_linux_sfm_sf06.py --i2c-port Example script ~~~~~~~~~~~~~~ diff --git a/_sources/run-tests.rst.txt b/_sources/run-tests.rst.txt index 4079af2..5db8b75 100644 --- a/_sources/run-tests.rst.txt +++ b/_sources/run-tests.rst.txt @@ -6,16 +6,26 @@ Unit tests can be run with `pytest `_: .. 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 `_ 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 `_ 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 index 2f08d25..5a94801 100644 --- 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 index 691aeb8..0d49244 100644 --- 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 */ diff --git a/api.html b/api.html index 85d8f2e..51d9079 100644 --- a/api.html +++ b/api.html @@ -4,7 +4,7 @@ - API Documentation — sensirion_i2c_sfm_sf06 1.0.0 documentation + API Documentation — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -31,7 +31,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
@@ -141,6 +146,11 @@

SFM-SF06 +

Note

+

The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during +the first 30ms (including the 12ms)

+

@@ -157,6 +167,11 @@

SFM-SF06 +

Note

+

The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during the first 30ms +(including the 12ms)

+

@@ -172,6 +187,11 @@

SFM-SF06 +

Note

+

The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during +the first 30ms (including the 12ms)

+

@@ -260,6 +280,11 @@

SFM-SF06 +

Note

+

The first measurement result will be available after 12ms. Small accuracy deviations (few % of reading) can occur during +the first 30ms (including the 12ms)

+

@@ -274,6 +299,13 @@

SFM-SF06

volume_fraction – Fraction value

+
+

Note

+
    +
  • The concentration value must not be updated more than once per millisecond

  • +
  • If a concentration value greater than 1000 is passed to the sensor, the measurement mode will stop.

  • +
+
@@ -283,6 +315,13 @@

SFM-SF06 +

Note

+
    +
  • The concentration value must not be updated more than once per millisecond

  • +
  • If a concentration value greater than 1000 is passed to the sensor, the measurement mode will stop.

  • +
+

diff --git a/build-documentation.html b/build-documentation.html index ed619e5..312588d 100644 --- a/build-documentation.html +++ b/build-documentation.html @@ -4,7 +4,7 @@ - Build documentation — sensirion_i2c_sfm_sf06 1.0.0 documentation + Build documentation — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
diff --git a/development.html b/development.html index feed915..f244192 100644 --- a/development.html +++ b/development.html @@ -4,7 +4,7 @@ - Development — sensirion_i2c_sfm_sf06 1.0.0 documentation + Development — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
diff --git a/execute-measurements.html b/execute-measurements.html index 3b9436b..8c08f95 100644 --- a/execute-measurements.html +++ b/execute-measurements.html @@ -4,7 +4,7 @@ - Execute measurements with SensorBridge — sensirion_i2c_sfm_sf06 1.0.0 documentation + Execute measurements with SensorBridge — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
- 1.0.0 + 2.0.0
@@ -99,8 +99,8 @@

Execute measurements with SensorBridgeCOM1 serial port. If this is different on your system, -pass the port in use with the --serial_port parameter as outlined below.

-
python examples/example_usage_sensorbridge_sfm_sf06.py --serial_port <your COM port>
+pass the port in use with the --serial-port parameter as outlined below.

+
python examples/example_usage_sensorbridge_sfm_sf06.py --serial-port <your COM port>
 
@@ -114,9 +114,9 @@

Example script# # THIS FILE IS AUTOMATICALLY GENERATED! # -# Generator: sensirion-driver-generator 0.20.0 -# Product: sfm_sf06 -# Version: 1.0 +# Generator: sensirion-driver-generator 0.32.0 +# Product: sfm_sf06 +# Model-Version: 1.3 # import argparse @@ -130,7 +130,7 @@

Example scriptfrom sensirion_i2c_sfm_sf06.device import SfmSf06Device parser = argparse.ArgumentParser() -parser.add_argument('--serial_port', '-p', default='COM1') +parser.add_argument('--serial-port', '-p', default='COM1') args = parser.parse_args() with ShdlcSerialPort(port=args.serial_port, baudrate=460800) as port: @@ -179,8 +179,8 @@

Execute measurements using internal Linux I²C driver

Connect the SFM-SF06 sensor to the I²C port of your system (for example to the I²C port 1 of a Raspberry Pi).

  • Run the example script from the root of the repository.

    By default the script assumes you have the sensor connected to /dev/i2c-1. -If this is different on your system, pass the port in use with the --i2c_port parameter as outlined below.

    -
    python examples/example_usage_sensorbridge_sfm_sf06.py --i2c_port <your I2C port>
    +If this is different on your system, pass the port in use with the --i2c-port parameter as outlined below.

    +
    python examples/example_usage_linux_sfm_sf06.py --i2c-port <your I2C port>
     
  • @@ -190,13 +190,13 @@

    Example script
    #!/usr/bin/env python
     # -*- coding: utf-8 -*-
     #
    -# (c) Copyright 2022 Sensirion AG, Switzerland
    +# (c) Copyright 2023 Sensirion AG, Switzerland
     #
     #     THIS FILE IS AUTOMATICALLY GENERATED!
     #
    -# Generator:    sensirion-driver-generator 0.19.0
    -# Product:      sfm_sf06
    -# Version:      1.0
    +# Generator:     sensirion-driver-generator 0.32.0
    +# Product:       sfm_sf06
    +# Model-Version: 1.3
     #
     
     import argparse
    @@ -206,7 +206,7 @@ 

    Example scriptfrom sensirion_i2c_sfm_sf06.device import SfmSf06Device parser = argparse.ArgumentParser() -parser.add_argument('--i2c_port', '-p', default='/dev/i2c-1') +parser.add_argument('--i2c-port', '-p', default='/dev/i2c-1') args = parser.parse_args() with LinuxI2cTransceiver(args.i2c_port) as i2c_transceiver: diff --git a/genindex.html b/genindex.html index 9b44c06..2e9c87e 100644 --- a/genindex.html +++ b/genindex.html @@ -3,7 +3,7 @@ - Index — sensirion_i2c_sfm_sf06 1.0.0 documentation + Index — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -29,7 +29,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    diff --git a/index.html b/index.html index 5d1f59c..3f6d506 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - Sensirion SFM-SF06 I2C Python Driver — sensirion_i2c_sfm_sf06 1.0.0 documentation + Sensirion SFM-SF06 I2C Python Driver — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -31,7 +31,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    diff --git a/installation.html b/installation.html index aeb4fa5..15ca3f2 100644 --- a/installation.html +++ b/installation.html @@ -4,7 +4,7 @@ - Installation — sensirion_i2c_sfm_sf06 1.0.0 documentation + Installation — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    diff --git a/objects.inv b/objects.inv index c1674d1..6d7efc6 100644 --- a/objects.inv +++ b/objects.inv @@ -1,6 +1,6 @@ # Sphinx inventory version 2 # Project: sensirion_i2c_sfm_sf06 -# Version: 1.0.0 +# Version: 2.0.0 # The remainder of this file is compressed using zlib. xڽA:~ ޻Jzfpʃy;2bj!aDQ!c ο; p$YD63~2cǟo͙YW2ۛNc{?|˒B$MOJdR0,d1/Tk> diff --git a/py-modindex.html b/py-modindex.html index 349a576..6348166 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -3,7 +3,7 @@ - Python Module Index — sensirion_i2c_sfm_sf06 1.0.0 documentation + Python Module Index — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    diff --git a/quickstart.html b/quickstart.html index 334381f..1eb483a 100644 --- a/quickstart.html +++ b/quickstart.html @@ -4,7 +4,7 @@ - Quick Start — sensirion_i2c_sfm_sf06 1.0.0 documentation + Quick Start — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    diff --git a/run-tests.html b/run-tests.html index 77e404f..76e7c14 100644 --- a/run-tests.html +++ b/run-tests.html @@ -4,7 +4,7 @@ - Run tests — sensirion_i2c_sfm_sf06 1.0.0 documentation + Run tests — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    @@ -82,19 +82,22 @@

    Run tests

    Unit tests can be run with pytest:

    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:

    -
      -
    • The SFM-SF06 sensor must be connected to a -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)

    • -
    +

    We provide a mock implementation that allows you to execute the tests for SFM-SF06 without hardware.

    +
    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 on port 1. Assuming the SensorBridge is +attached to COM1 you can start the tests with the following command:

    +
    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)

    +
    diff --git a/search.html b/search.html index 45be178..b93e961 100644 --- a/search.html +++ b/search.html @@ -3,7 +3,7 @@ - Search — sensirion_i2c_sfm_sf06 1.0.0 documentation + Search — sensirion_i2c_sfm_sf06 2.0.0 documentation @@ -32,7 +32,7 @@ sensirion_i2c_sfm_sf06
    - 1.0.0 + 2.0.0
    diff --git a/searchindex.js b/searchindex.js index 080f576..a261e39 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["api","build-documentation","development","execute-measurements","index","installation","quickstart","run-tests"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api.rst","build-documentation.rst","development.rst","execute-measurements.rst","index.rst","installation.rst","quickstart.rst","run-tests.rst"],objects:{"sensirion_i2c_sfm_sf06.commands":{ConfigureAveraging:[0,1,1,""],EnterSleep:[0,1,1,""],ErrorCodeT:[0,1,1,""],ExitSleep:[0,1,1,""],FlowUnitT:[0,1,1,""],ReadMeasurementData:[0,1,1,""],ReadProductIdentifier:[0,1,1,""],ReadScaleOffsetUnit:[0,1,1,""],StartAirContinuousMeasurement:[0,1,1,""],StartAirO2ContinuousMeasurement:[0,1,1,""],StartCO2ContinuousMeasurement:[0,1,1,""],StartCO2O2ContinuousMeasurement:[0,1,1,""],StartN2OContinuousMeasurement:[0,1,1,""],StartN2OO2ContinuousMeasurement:[0,1,1,""],StartO2ContinuousMeasurement:[0,1,1,""],StatusWordT:[0,1,1,""],StopContinuousMeasurement:[0,1,1,""],UpdateConcentrationActivate:[0,1,1,""],UpdateConcentrationSet:[0,1,1,""]},"sensirion_i2c_sfm_sf06.commands.ConfigureAveraging":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.EnterSleep":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ErrorCodeT":{I2C_ERROR:[0,2,1,""],TIMEOUT:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ExitSleep":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.FlowUnitT":{prefix:[0,2,1,""],time_base:[0,2,1,""],unit:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ReadMeasurementData":{pack:[0,3,1,""],rx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ReadProductIdentifier":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],rx:[0,2,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ReadScaleOffsetUnit":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],rx:[0,2,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartAirContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartAirO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartCO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartCO2O2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartN2OContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartN2OO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StatusWordT":{avg_mode_flag:[0,2,1,""],command_code:[0,2,1,""],exp_smoothing_flag:[0,2,1,""],gas_conc:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StopContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.UpdateConcentrationActivate":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.UpdateConcentrationSet":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.device":{SfmSf06Device:[0,1,1,""],SfmSf06DeviceBase:[0,1,1,""]},"sensirion_i2c_sfm_sf06.device.SfmSf06Device":{__init__:[0,3,1,""],read_measurement_data:[0,3,1,""],read_measurement_data_raw:[0,3,1,""],sf06:[0,2,1,""],start_air_continuous_measurement:[0,3,1,""],start_co2_continuous_measurement:[0,3,1,""],start_co2_o2_continuous_measurement:[0,3,1,""],start_n2o_continuous_measurement:[0,3,1,""],start_n2o_o2_continuous_measurement:[0,3,1,""],start_o2_continuous_measurement:[0,3,1,""],update_concentration:[0,3,1,""]},"sensirion_i2c_sfm_sf06.device.SfmSf06DeviceBase":{__init__:[0,3,1,""],channel:[0,4,1,""],configure_averaging:[0,3,1,""],enter_sleep:[0,3,1,""],exit_sleep:[0,3,1,""],read_measurement_data:[0,3,1,""],read_product_identifier:[0,3,1,""],read_scale_offset_unit:[0,3,1,""],start_air_continuous_measurement:[0,3,1,""],start_air_o2_continuous_measurement:[0,3,1,""],start_co2_continuous_measurement:[0,3,1,""],start_co2_o2_continuous_measurement:[0,3,1,""],start_n2o_continuous_measurement:[0,3,1,""],start_n2o_o2_continuous_measurement:[0,3,1,""],start_o2_continuous_measurement:[0,3,1,""],stop_continuous_measurement:[0,3,1,""],update_concentration_activate:[0,3,1,""],update_concentration_set:[0,3,1,""]},"sensirion_i2c_sfm_sf06.result_types":{SignalFlow:[0,1,1,""],SignalTemperature:[0,1,1,""]},"sensirion_i2c_sfm_sf06.result_types.SignalFlow":{value:[0,4,1,""]},"sensirion_i2c_sfm_sf06.result_types.SignalTemperature":{value:[0,4,1,""]},sensirion_i2c_sfm_sf06:{commands:[0,0,0,"-"],device:[0,0,0,"-"],result_types:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","property","Python property"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:property"},terms:{"0":[0,3,7],"0x0":3,"0x2a":3,"0x31":3,"0xff":3,"1":[0,3,7],"10":0,"100":3,"100e3":3,"11":0,"12":0,"128":0,"13827":0,"13832":0,"13845":0,"13854":0,"13874":0,"13881":0,"13894":0,"13921":0,"13930":0,"13943":0,"16377":0,"16m":0,"19":3,"20":[0,3],"2022":3,"2023":3,"3":[0,3],"300":0,"32":0,"4":0,"460800":[3,7],"50":0,"57344":0,"57602":0,"57725":0,"5m":0,"64":0,"8":[0,3],"class":0,"co\u2082":0,"default":[0,3,7],"function":0,"i\u00b2c":[4,6],"import":3,"int":0,"n\u2082o":0,"new":0,"o\u2082":0,"return":0,"try":3,A:0,By:[0,3],For:0,IS:3,If:[0,3],In:0,It:[0,4],ONE:3,On:3,The:[0,1,3,5,7],To:0,__init__:0,_build:1,a_flow:[0,3],a_status_word:[0,3],a_temperatur:[0,3],about:0,access:0,acknowledg:0,activ:0,add_argu:3,addit:0,address:[0,7],after:0,ag:3,air:0,all:[0,3,7],allow:0,amount:0,an:0,api:4,appli:0,applic:0,appropri:0,ar:0,arg:3,argpars:3,argument:0,argumentpars:3,assum:3,automat:3,averag:0,average_window:0,avg_mode_flag:0,b:1,base:0,baseexcept:3,batteri:0,baudrat:[3,7],becom:0,been:0,below:3,between:0,bin:3,binari:0,bit:0,bitfield:0,both:0,bridg:3,buffer:0,build:[2,4],built:1,c:[0,3],calibr:0,can:[0,3,5,7],cannot:0,celsiu:0,channel:[0,3],chip:0,circuit:0,cl:0,clm:0,cmd_id:0,cmdargument:0,code:[0,3],com1:3,com7:7,com:3,command:4,command_cod:0,complex:0,concentr:0,configur:0,configure_averag:0,configureaverag:0,connect:[3,7],contain:4,continu:[0,3],convert:0,copyright:3,correspond:0,crc:3,crccalcul:3,current:0,data:0,defin:0,degre:0,describ:[0,3],descript:0,desir:0,detail:0,dev:3,develop:4,devic:[0,3],differ:3,dioxigen:0,direct:0,directli:3,doc:1,document:[2,4],done:3,down:0,driver:[0,6],dynam:0,e:[0,7],eas:0,enter:0,enter_sleep:0,entersleep:0,enumer:0,env:3,errorcodet:0,exampl:[4,6],example_usage_sensorbridge_sfm_sf06:3,except:3,execut:[0,4,6],exit:0,exit_sleep:0,exitsleep:0,exp_smoothing_flag:0,extend:0,f:[0,3],factor:0,famili:4,file:3,first:0,fix:0,flow:0,flow_offset:0,flow_raw:0,flow_scale_factor:0,flow_unit:0,flowunitt:0,follow:[3,7],found:0,fraction:0,frequenc:3,from:[0,3],furthermor:3,g:7,ga:0,gas_conc:0,gener:[0,3],give:0,ha:0,hardwar:[4,7],have:[0,3,7],heater:0,heox:0,higher:0,highest:0,host:0,how:3,html:1,i2c:[0,3],i2c_adapt:3,i2c_channel:3,i2c_error:0,i2c_port:3,i2c_transceiv:3,i2cchannel:3,i2cconnect:3,i:[0,3],identifi:0,idl:0,implement:0,independ:4,inform:0,instal:[1,3,4,7],instruct:0,int_valu:0,intend:0,interfac:[0,4],intern:[0,4,6],its:0,level:0,linux:[4,6],linuxi2ctransceiv:3,lookup:0,low:0,m:7,mainli:0,marker:7,maxim:0,meaning:0,measur:[0,4,6],mesur:0,minim:0,minimum:0,mixtur:0,mode:0,more:0,much:0,must:7,n:0,necessari:0,need:0,needs_devic:7,no2:0,note:0,number:0,object:0,offset:0,one:0,onli:0,oper:0,optain:0,out:0,outlin:3,output:0,over:[0,3],overrul:0,overwritten:0,p:3,pack:0,packag:[1,3,4,5],paramet:[0,3],parse_arg:3,parser:3,particularli:0,pass:[3,7],pc:3,perform:0,physic:0,pi:3,pip:[1,3,5,7],pointer:0,poll:0,port:[3,7],possibl:[0,3],power:0,prefix:0,previous:0,print:3,product:[0,3],product_identifi:[0,3],properti:0,provid:[0,4],put:0,py:[1,3],pytest:7,python:[1,3],quick:4,r:1,rang:3,raspberri:3,raw:0,re:0,read:0,read_measurement_data:[0,3],read_measurement_data_raw:0,read_product_identifi:[0,3],read_scale_offset_unit:0,readmeasurementdata:0,readout:0,readproductidentifi:0,readscaleoffsetunit:0,receiv:0,recept:0,recommend:5,reduc:0,refer:0,reflect:0,regular:0,renam:0,repositori:3,repres:0,requir:[1,3,7],reset:0,result:4,result_typ:0,revis:0,root:3,run:[0,2,3,4],rx:0,rx_tx_data:0,rxdata:0,s:0,sampl:0,scale:0,script:[4,6],sec:0,section:0,see:0,sek:3,select:0,sensirion:3,sensirion_driver_adapt:[0,3],sensirion_i2c_driv:3,sensirion_i2c_sfm_sf06:[0,3,5],sensirion_shdlc_driv:3,sensirion_shdlc_sensorbridg:3,sensor:[0,3,4,7],sensorbridg:[4,6,7],sensorbridgei2cproxi:3,sensorbridgeport:3,sensorbridgeshdlcdevic:3,sent:0,serial:[0,3,7],serial_numb:[0,3],serial_port:3,set:[0,7],set_i2c_frequ:3,set_supply_voltag:3,setup:1,sf06:[3,7],sfm3003:0,sfm3013:0,sfm3019:0,sfm3119:0,sfm4300:0,sfm:[3,7],sfm_sf06:[0,3],sfmsf06devic:[3,4],sfmsf06devicebas:0,shdlc:3,shdlcconnect:3,shdlcserialport:3,sheet:0,should:0,show:3,shown:3,signal:0,signalflow:0,signaltemperatur:0,simpl:3,singl:0,slave_address:3,sleep:[0,3],smf3013:0,soft:0,sourc:0,space:3,specif:0,specifi:0,sphinx:1,start:[0,4],start_air_continuous_measur:0,start_air_o2_continuous_measur:0,start_co2_continuous_measur:0,start_co2_o2_continuous_measur:0,start_n2o_continuous_measur:0,start_n2o_o2_continuous_measur:0,start_o2_continuous_measur:[0,3],start_xx_continuous_measur:0,startaircontinuousmeasur:0,startairo2continuousmeasur:0,startco2continuousmeasur:0,startco2o2continuousmeasur:0,startn2ocontinuousmeasur:0,startn2oo2continuousmeasur:0,starto2continuousmeasur:0,state:0,statu:0,status_word:0,statuswordt:0,step:3,stop:0,stop_continuous_measur:[0,3],stopcontinuousmeasur:0,subsequ:0,support:0,switch_supply_on:3,switzerland:3,system:3,tabl:0,take:0,temperatur:0,temperature_raw:0,test:[2,4],therefor:0,thi:[0,3,4],three:0,through:0,time:3,time_bas:0,timeout:0,togeth:0,transceiv:4,transfer:0,transform:0,transmit:0,tx:0,txdata:0,txt:1,type:4,typic:0,uniqu:0,unit:[0,7],until:0,up:0,updat:0,update_concentr:0,update_concentration_activ:0,update_concentration_set:0,updateconcentrationactiv:0,updateconcentrationset:0,upon:0,us:[0,4,6],usag:5,usb:3,user:3,usr:3,utf:3,valid:0,valu:0,variou:4,version:3,virtualenv:5,voltag:3,volum:0,volume_fract:0,wai:0,want:0,we:0,when:0,where:[0,7],whether:0,which:[0,4],width:0,window:[0,3],within:5,without:[0,7],woken:0,word:0,work:4,write:0,you:3,your:3},titles:["API Documentation","Build documentation","Development","Execute measurements with SensorBridge","Sensirion SFM-SF06 I2C Python Driver","Installation","Quick Start","Run tests"],titleterms:{"i\u00b2c":3,api:0,build:1,command:0,content:4,develop:2,document:[0,1],driver:[3,4],exampl:3,execut:3,i2c:4,instal:5,intern:3,linux:3,measur:3,python:4,quick:6,result:0,run:7,script:3,sensirion:4,sensorbridg:3,sf06:[0,4],sfm:[0,4],sfmsf06devic:0,start:6,test:7,type:0,us:3}}) \ No newline at end of file +Search.setIndex({docnames:["api","build-documentation","development","execute-measurements","index","installation","quickstart","run-tests"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api.rst","build-documentation.rst","development.rst","execute-measurements.rst","index.rst","installation.rst","quickstart.rst","run-tests.rst"],objects:{"sensirion_i2c_sfm_sf06.commands":{ConfigureAveraging:[0,1,1,""],EnterSleep:[0,1,1,""],ErrorCodeT:[0,1,1,""],ExitSleep:[0,1,1,""],FlowUnitT:[0,1,1,""],ReadMeasurementData:[0,1,1,""],ReadProductIdentifier:[0,1,1,""],ReadScaleOffsetUnit:[0,1,1,""],StartAirContinuousMeasurement:[0,1,1,""],StartAirO2ContinuousMeasurement:[0,1,1,""],StartCO2ContinuousMeasurement:[0,1,1,""],StartCO2O2ContinuousMeasurement:[0,1,1,""],StartN2OContinuousMeasurement:[0,1,1,""],StartN2OO2ContinuousMeasurement:[0,1,1,""],StartO2ContinuousMeasurement:[0,1,1,""],StatusWordT:[0,1,1,""],StopContinuousMeasurement:[0,1,1,""],UpdateConcentrationActivate:[0,1,1,""],UpdateConcentrationSet:[0,1,1,""]},"sensirion_i2c_sfm_sf06.commands.ConfigureAveraging":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.EnterSleep":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ErrorCodeT":{I2C_ERROR:[0,2,1,""],TIMEOUT:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ExitSleep":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.FlowUnitT":{prefix:[0,2,1,""],time_base:[0,2,1,""],unit:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ReadMeasurementData":{pack:[0,3,1,""],rx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ReadProductIdentifier":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],rx:[0,2,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.ReadScaleOffsetUnit":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],rx:[0,2,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartAirContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartAirO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartCO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartCO2O2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartN2OContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartN2OO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StartO2ContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StatusWordT":{avg_mode_flag:[0,2,1,""],command_code:[0,2,1,""],exp_smoothing_flag:[0,2,1,""],gas_conc:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.StopContinuousMeasurement":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.UpdateConcentrationActivate":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.commands.UpdateConcentrationSet":{CMD_ID:[0,2,1,""],pack:[0,3,1,""],tx:[0,2,1,""]},"sensirion_i2c_sfm_sf06.device":{SfmSf06Device:[0,1,1,""],SfmSf06DeviceBase:[0,1,1,""]},"sensirion_i2c_sfm_sf06.device.SfmSf06Device":{__init__:[0,3,1,""],read_measurement_data:[0,3,1,""],read_measurement_data_raw:[0,3,1,""],sf06:[0,2,1,""],start_air_continuous_measurement:[0,3,1,""],start_co2_continuous_measurement:[0,3,1,""],start_co2_o2_continuous_measurement:[0,3,1,""],start_n2o_continuous_measurement:[0,3,1,""],start_n2o_o2_continuous_measurement:[0,3,1,""],start_o2_continuous_measurement:[0,3,1,""],update_concentration:[0,3,1,""]},"sensirion_i2c_sfm_sf06.device.SfmSf06DeviceBase":{__init__:[0,3,1,""],channel:[0,4,1,""],configure_averaging:[0,3,1,""],enter_sleep:[0,3,1,""],exit_sleep:[0,3,1,""],read_measurement_data:[0,3,1,""],read_product_identifier:[0,3,1,""],read_scale_offset_unit:[0,3,1,""],start_air_continuous_measurement:[0,3,1,""],start_air_o2_continuous_measurement:[0,3,1,""],start_co2_continuous_measurement:[0,3,1,""],start_co2_o2_continuous_measurement:[0,3,1,""],start_n2o_continuous_measurement:[0,3,1,""],start_n2o_o2_continuous_measurement:[0,3,1,""],start_o2_continuous_measurement:[0,3,1,""],stop_continuous_measurement:[0,3,1,""],update_concentration_activate:[0,3,1,""],update_concentration_set:[0,3,1,""]},"sensirion_i2c_sfm_sf06.result_types":{SignalFlow:[0,1,1,""],SignalTemperature:[0,1,1,""]},"sensirion_i2c_sfm_sf06.result_types.SignalFlow":{value:[0,4,1,""]},"sensirion_i2c_sfm_sf06.result_types.SignalTemperature":{value:[0,4,1,""]},sensirion_i2c_sfm_sf06:{commands:[0,0,0,"-"],device:[0,0,0,"-"],result_types:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","property","Python property"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:property"},terms:{"0":[0,3,7],"0x0":3,"0x2a":3,"0x31":3,"0xff":3,"1":[0,3,7],"10":0,"100":3,"1000":0,"100e3":3,"11":0,"12":0,"128":0,"12m":0,"13827":0,"13832":0,"13845":0,"13854":0,"13874":0,"13881":0,"13894":0,"13921":0,"13930":0,"13943":0,"16377":0,"16m":0,"20":0,"2023":3,"3":[0,3],"300":0,"30m":0,"32":[0,3],"4":0,"460800":[3,7],"50":0,"57344":0,"57602":0,"57725":0,"5m":0,"64":0,"8":[0,3],"class":0,"co\u2082":0,"default":[0,3,7],"function":0,"i\u00b2c":[4,6],"import":3,"int":0,"n\u2082o":0,"new":0,"o\u2082":0,"return":0,"try":3,A:0,By:[0,3],For:0,IS:3,If:[0,3],In:0,It:[0,4],ONE:3,On:3,The:[0,1,3,5,7],To:[0,7],__init__:0,_build:1,a_flow:[0,3],a_status_word:[0,3],a_temperatur:[0,3],about:0,access:0,accuraci:0,acknowledg:0,activ:0,add_argu:3,addit:0,address:[0,7],after:0,ag:3,air:0,all:[0,3,7],allow:[0,7],amount:0,an:0,api:4,appli:0,applic:0,appropri:0,ar:0,arg:3,argpars:3,argument:0,argumentpars:3,assum:[3,7],attach:7,automat:3,avail:0,averag:0,average_window:0,avg_mode_flag:0,b:1,base:0,baseexcept:3,batteri:0,baudrat:[3,7],becom:0,been:0,below:3,between:0,bin:3,binari:0,bit:0,bitfield:0,both:0,bridg:3,buffer:0,build:[2,4],built:1,c:[0,3],calibr:0,can:[0,3,5,7],cannot:0,celsiu:0,channel:[0,3],chip:0,circuit:0,cl:0,clm:0,cmd_id:0,cmdargument:0,code:[0,3],com1:[3,7],com:3,command:[4,7],command_cod:0,complex:0,concentr:0,configur:0,configure_averag:0,configureaverag:0,connect:[3,7],contain:4,continu:[0,3],convert:0,copyright:3,correspond:0,crc:3,crccalcul:3,current:0,data:0,defin:0,degre:0,describ:[0,3],descript:0,desir:0,detail:0,dev:3,develop:4,deviat:0,devic:[0,3],differ:3,dioxigen:0,direct:0,directli:3,doc:1,document:[2,4],done:3,down:0,driver:[0,6,7],dure:0,dynam:0,e:[0,7],eas:0,enter:0,enter_sleep:0,entersleep:0,enumer:0,env:3,errorcodet:0,exampl:[4,6],example_usage_linux_sfm_sf06:3,example_usage_sensorbridge_sfm_sf06:3,except:3,execut:[0,4,6,7],exit:0,exit_sleep:0,exitsleep:0,exp_smoothing_flag:0,extend:0,f:[0,3],factor:0,famili:4,few:0,file:3,first:0,fix:0,flow:0,flow_offset:0,flow_raw:0,flow_scale_factor:0,flow_unit:0,flowunitt:0,follow:[3,7],found:0,fraction:0,frequenc:3,from:[0,3],furthermor:3,ga:0,gas_conc:0,gener:[0,3],give:0,greater:0,ha:0,hardwar:[4,7],have:[0,3,7],heater:0,heox:0,higher:0,highest:0,host:0,how:3,html:1,i2c:[0,3],i2c_adapt:3,i2c_channel:3,i2c_error:0,i2c_port:3,i2c_transceiv:3,i2cchannel:3,i2cconnect:3,i:[0,3],identifi:0,idl:0,implement:[0,7],includ:0,independ:4,inform:0,instal:[1,3,4,7],instruct:0,int_valu:0,intend:0,interfac:[0,4],intern:[0,4,6],its:0,level:0,linux:[4,6],linuxi2ctransceiv:3,lookup:0,low:0,mainli:0,maxim:0,meaning:0,measur:[0,4,6],mesur:0,millisecond:0,minim:0,minimum:0,mixtur:0,mock:7,mode:0,model:3,more:0,much:0,must:[0,7],n:0,necessari:0,need:0,no2:0,note:0,number:0,object:0,occur:0,offset:0,onc:0,one:0,onli:0,oper:0,optain:0,out:0,outlin:3,output:0,over:[0,3],overrul:0,overwritten:0,p:3,pack:0,packag:[1,3,4,5],paramet:[0,3],parse_arg:3,parser:3,particularli:0,pass:[0,3],pc:3,per:0,perform:0,physic:0,pi:3,pip:[1,3,5,7],pointer:0,poll:0,port:[3,7],possibl:[0,3],power:0,prefix:0,previous:0,print:3,product:[0,3],product_identifi:[0,3],properti:0,provid:[0,4,7],put:0,py:[1,3],pytest:7,python:[1,3],quick:4,r:1,rang:3,raspberri:3,raw:0,re:0,read:0,read_measurement_data:[0,3],read_measurement_data_raw:0,read_product_identifi:[0,3],read_scale_offset_unit:0,readmeasurementdata:0,readout:0,readproductidentifi:0,readscaleoffsetunit:0,real:7,receiv:0,recept:0,recommend:5,reduc:0,refer:0,reflect:0,regular:0,renam:0,repositori:3,repres:0,requir:[1,3,7],reset:0,result:4,result_typ:0,revis:0,root:3,run:[0,2,3,4],rx:0,rx_tx_data:0,rxdata:0,s:0,sampl:0,scale:0,script:[4,6],sec:0,section:0,see:0,sek:3,select:0,sensirion:3,sensirion_driver_adapt:[0,3],sensirion_i2c_driv:3,sensirion_i2c_sfm_sf06:[0,3,5],sensirion_shdlc_driv:3,sensirion_shdlc_sensorbridg:3,sensor:[0,3,4,7],sensorbridg:[4,6,7],sensorbridgei2cproxi:3,sensorbridgeport:3,sensorbridgeshdlcdevic:3,sent:0,serial:[0,3,7],serial_numb:[0,3],serial_port:3,set:[0,7],set_i2c_frequ:3,set_supply_voltag:3,setup:1,sf06:[3,7],sfm3003:0,sfm3013:0,sfm3019:0,sfm3119:0,sfm4300:0,sfm:[3,7],sfm_sf06:[0,3],sfmsf06devic:[3,4],sfmsf06devicebas:0,shdlc:3,shdlcconnect:3,shdlcserialport:3,sheet:0,should:0,show:3,shown:3,signal:0,signalflow:0,signaltemperatur:0,simpl:3,singl:0,slave_address:3,sleep:[0,3],small:0,smf3013:0,soft:0,sourc:0,space:3,specif:0,specifi:0,sphinx:1,start:[0,4,7],start_air_continuous_measur:0,start_air_o2_continuous_measur:0,start_co2_continuous_measur:0,start_co2_o2_continuous_measur:0,start_n2o_continuous_measur:0,start_n2o_o2_continuous_measur:0,start_o2_continuous_measur:[0,3],start_xx_continuous_measur:0,startaircontinuousmeasur:0,startairo2continuousmeasur:0,startco2continuousmeasur:0,startco2o2continuousmeasur:0,startn2ocontinuousmeasur:0,startn2oo2continuousmeasur:0,starto2continuousmeasur:0,state:0,statu:0,status_word:0,statuswordt:0,step:3,stop:0,stop_continuous_measur:[0,3],stopcontinuousmeasur:0,subsequ:0,support:0,switch_supply_on:3,switzerland:3,system:3,tabl:0,take:0,temperatur:0,temperature_raw:0,test:[2,4],than:0,therefor:0,thi:[0,3,4],three:0,through:0,time:3,time_bas:0,timeout:0,togeth:0,transceiv:4,transfer:0,transform:0,transmit:0,tx:0,txdata:0,txt:1,type:4,typic:0,uniqu:0,unit:[0,7],until:0,up:0,updat:0,update_concentr:0,update_concentration_activ:0,update_concentration_set:0,updateconcentrationactiv:0,updateconcentrationset:0,upon:0,us:[0,4,6,7],usag:5,usb:3,user:3,usr:3,utf:3,valid:0,valu:0,variou:4,version:3,virtualenv:5,voltag:3,volum:0,volume_fract:0,wai:0,want:0,we:[0,7],when:0,where:0,whether:0,which:[0,4],width:0,window:[0,3],within:5,without:[0,7],woken:0,word:0,work:4,write:0,you:[3,7],your:[3,7]},titles:["API Documentation","Build documentation","Development","Execute measurements with SensorBridge","Sensirion SFM-SF06 I2C Python Driver","Installation","Quick Start","Run tests"],titleterms:{"i\u00b2c":3,api:0,build:1,command:0,content:4,develop:2,document:[0,1],driver:[3,4],exampl:3,execut:3,i2c:4,instal:5,intern:3,linux:3,measur:3,python:4,quick:6,result:0,run:7,script:3,sensirion:4,sensorbridg:3,sf06:[0,4],sfm:[0,4],sfmsf06devic:0,start:6,test:7,type:0,us:3}}) \ No newline at end of file