Issue 21: Change documentation for calibration path

This commit is contained in:
Mario Hüttel 2020-11-16 18:38:50 +01:00
parent c02d988350
commit 8f6462bcc9

View File

@ -132,7 +132,7 @@ and
.. doxygenfunction:: adc_pt1000_get_resistance_calibration
:outline:
are used to set the reistance calibration internally. For a guide on how to calibrate the deivce, see the corresponding :ref:`usage_calibration` usage page.
are used to set the resistance calibration internally. For a guide on how to calibrate the deivce, see the corresponding :ref:`usage_calibration` usage page.
The calibration is calculated the following way:
@ -147,13 +147,13 @@ The calibration is calculated the following way:
OFFSET [label="Offset", description="Offset Correction :math:`O`"];
OUT [shape=endpoint, description="Corrected Value"];
LF -> SENS -> OFFSET -> OUT
LF -> OFFSET -> SENS -> OUT
}
The final calibrated PT1000 resistance is calculated as:
.. math::
R_{PT1000_{corr}} = R_{PT1000_{LF}} \cdot (1 + \sigma) + O
R_{PT1000_{corr}} = (R_{PT1000_{LF}} - O) \cdot (1 + \sigma)
The default values, if no calibration is loaded / executed, are: