PAR Sensor Calibration
======================

.. automodule:: jii_multispeq_protocols.protocols.calibrations.par_sensor_calibration
  :members:
  :undoc-members:
  :show-inheritance:
  :no-index:
  :no-title:

Basic Usage
-----------

.. code-block:: python
  :caption: *Example:* Import statement for the **par_sensor_calibration** protocol

  ## Import par_sensor_calibration
  from jii_multispeq_protocols.protocols.calibrations import par_sensor_calibration as _par_sensor_calibration

----

Sequence
--------

.. mermaid::

   %%{
   init: {
     "theme": "base",
     "themeVariables": {"primaryColor": "#49e06d", "primaryTextColor": "#005e5e", "primaryBorderColor": "#005e5e", "lineColor": "#fff381", "secondaryColor": "#afd7f4", "tertiaryColor": "#D7EBF9"}
   }
   }%%
   flowchart TD
   	START((Start))
   	A0["`**Protocol**`"]:::protocol
   	START ==> A0
   	A1["`**Protocol**`"]:::protocol
   	A0 ==> A1
   	A2["`**Protocol**`"]:::protocol
   	A1 ==> A2
   	A3["`**Protocol**`"]:::protocol
   	A2 ==> A3
   	A4["`**Protocol**`"]:::protocol
   	A3 ==> A4
   	A5["`**pre_qlight_to_qpar**
   *Repeats*: 10`"]:::protocol
   	A4 ==> A5
   	A6["`**qlight_to_qpar**
   *Repeats*: 10`"]:::protocol
   	A5 ==> A6
   	A7["`**Protocol**`"]:::protocol
   	A6 ==> A7
   	A8["`**light**
   *Repeats*: 10
   *Sensor:* PAR light sensor`"]:::protocol
   	A7 ==> A8
   	A9["`**dark**
   *Repeats*: 5
   *Sensor:* PAR light sensor`"]:::protocol
   	A8 ==> A9
   	A9 ==> END
   	END(( End ))
   	classDef protocol text-align:left,white-space:pre;


----

Details
-------



Code
~~~~

.. code-block:: python
   :caption: Protocol Code
   
   [  {  '_protocol_set_': [  {  'alert': 'Connect the CaliQ USB-C cable to the '
                                          'MultispeQ. Be sure to get the correct '
                                          'orientation.',
                                 'check_battery': 1},
                              {  'set_par': [  0.3618,
                                               -0.2348,
                                               -0.1362,
                                               -0.0105,
                                               6.7386]},
                              {'par_tweak': 1, 'set_par_dark': 0},
                              {  'alert': 'Clip CaliQ Light Source and CaliQ PAR '
                                          'Sensor together.',
                                 'protocols_pre_delay': 1000},
                              {'qlight': [1, 100]},
                              {  'label': 'pre_qlight_to_qpar',
                                 'protocol_repeats': 10,
                                 'qpar': [1]},
                              {  'label': 'qlight_to_qpar',
                                 'protocol_repeats': 10,
                                 'qpar': [1]},
                              {  'alert': 'Place CaliQ Light Source on the '
                                          'MultispeQ PAR sensor. Make sure there '
                                          'is no visible gap. (LED light should '
                                          'be on)',
                                 'par_tweak': 1},
                              {  'environmental': [['light_intensity']],
                                 'label': 'light',
                                 'protocol_repeats': 10},
                              {  'environmental': [['light_intensity']],
                                 'label': 'dark',
                                 'protocol_repeats': 5,
                                 'qlight': [1, 0]}],
         'require_firmware': [2, 100.4]}]




----

Analysis
--------


Usage
~~~~~

.. code-block:: python
  :caption: Analysis Example (requires ``JII-MultispeQ`` package)

  from jii_multispeq import measurement as _measurement
  from jii_multispeq_protocols.protocols.calibrations import par_sensor_calibration as _par_sensor_calibration

  ## Take a measurement using the MultispeQ
  data, crc32 = _measurement.measure(port="<Selected Port>", protocol=_par_sensor_calibration, filename=None, notes="")

  ## The analyze function of JII-MultispeQ helps to provide the correct format
  output = _measurement.analyze( data, _par_sensor_calibration._analyze )

  ## View Analysis output (as table)
  _measurement.view( output )

Function Details
~~~~~~~~~~~~~~~~

.. autofunction:: jii_multispeq_protocols.protocols.calibrations.par_sensor_calibration._analyze
  :no-index:



Example Data
~~~~~~~~~~~~

===============  ==========================================================================
Parameter        Value
===============  ==========================================================================
device_battery   8
device_firmware  2.21
device_id        ff:ff:ff:ff
device_name      MultispeQ
device_version   2
error            Battery level too low for calibration! Please recharge until at least 50%!
time             1564325628723
===============  ==========================================================================