Fix-up documentation

This commit is contained in:
Mario Hüttel 2020-08-23 00:04:02 +02:00
parent 324e6d506d
commit 627da0def5

View File

@ -9,6 +9,8 @@ The safety flags are represented in software by the following enums
The safety flags can be temporarily or permanent. Some temporary flags are reset automatically, once the error condition disappears. Others have to be explicitly cleared. The safety flags can be temporarily or permanent. Some temporary flags are reset automatically, once the error condition disappears. Others have to be explicitly cleared.
----------------------------------------------------------------------------------------------------------------------------------
.. _safety_flags_adc_overflow: .. _safety_flags_adc_overflow:
ERR_FLAG_MEAS_ADC_OVERFLOW ERR_FLAG_MEAS_ADC_OVERFLOW
@ -22,12 +24,14 @@ persistent self-clearing Stops PID Panic Mode
yes no yes no yes no yes no
========== ============= ============= =========== ========== ============= ============= ===========
----------------------------------------------------------------------------------------------------------------------------------
.. _safety_flags_adc_off: .. _safety_flags_adc_off:
ERR_FLAG_MEAS_ADC_OFF ERR_FLAG_MEAS_ADC_OFF
--------------------- ---------------------
``ERR_FLAG_MEAS_ADC_OFF`` signals that the measurment ADC for the PT1000 sensor is deactivated. This flag is automatically cleared by the firmware ``ERR_FLAG_MEAS_ADC_OFF`` signals that the measurement ADC for the PT1000 sensor is deactivated. This flag is automatically cleared by the firmware
once the ADC is started. once the ADC is started.
========== ============= ============= =========== ========== ============= ============= ===========
@ -36,6 +40,7 @@ persistent self-clearing Stops PID Panic Mode
no yes yes no no yes yes no
========== ============= ============= =========== ========== ============= ============= ===========
----------------------------------------------------------------------------------------------------------------------------------
.. _safety_flags_adc_watchdog: .. _safety_flags_adc_watchdog:
@ -52,6 +57,7 @@ persistent self-clearing Stops PID Panic Mode
no no yes no no no yes no
========== ============= ============= =========== ========== ============= ============= ===========
----------------------------------------------------------------------------------------------------------------------------------
.. _safety_flags_adc_unstable: .. _safety_flags_adc_unstable: