From 627da0def5e74d3fd6939a2d1e7d4d3eb3e02aeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Sun, 23 Aug 2020 00:04:02 +0200 Subject: [PATCH] Fix-up documentation --- doc/source/firmware/flags.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/firmware/flags.rst b/doc/source/firmware/flags.rst index 808ef87..aec37d1 100644 --- a/doc/source/firmware/flags.rst +++ b/doc/source/firmware/flags.rst @@ -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. +---------------------------------------------------------------------------------------------------------------------------------- + .. _safety_flags_adc_overflow: ERR_FLAG_MEAS_ADC_OVERFLOW @@ -22,12 +24,14 @@ persistent self-clearing Stops PID Panic Mode yes no yes no ========== ============= ============= =========== +---------------------------------------------------------------------------------------------------------------------------------- + .. _safety_flags_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. ========== ============= ============= =========== @@ -36,6 +40,7 @@ persistent self-clearing Stops PID Panic Mode no yes yes no ========== ============= ============= =========== +---------------------------------------------------------------------------------------------------------------------------------- .. _safety_flags_adc_watchdog: @@ -52,6 +57,7 @@ persistent self-clearing Stops PID Panic Mode no no yes no ========== ============= ============= =========== +---------------------------------------------------------------------------------------------------------------------------------- .. _safety_flags_adc_unstable: