Add a few flags to the documentation

This commit is contained in:
Mario Hüttel 2021-03-18 23:12:44 +01:00
parent 1797dac60b
commit 001f2be176

View File

@ -68,7 +68,8 @@ no no yes no
ERR_FLAG_MEAS_ADC_UNSTABLE ERR_FLAG_MEAS_ADC_UNSTABLE
-------------------------- --------------------------
``ERR_FLAG_MEAS_ADC_UNSTABLE`` is set after startup of the PT1000 measuremnt or after reconfiguring the filter settings. ``ERR_FLAG_MEAS_ADC_UNSTABLE`` is set if the Moving Average Filter of the PT1000 ADC detects a bigger deviation between input and filtered output value.
The flag is automatically cleared by the controller as soon as the unstable condition is not met anymore. For this, the filter input to filter output difference has to stay below a certain threshold for a defined amount of samples.
.. seealso:: :ref:`firmware_meas_adc_filter` .. seealso:: :ref:`firmware_meas_adc_filter`
@ -86,7 +87,7 @@ ERR_FLAG_SAFETY_MEM_CORRUPT
``ERR_FLAG_SAFETY_MEM_CORRUPT`` is set during the initialization of the controller, in case a corrupted safety memory is encountered. ``ERR_FLAG_SAFETY_MEM_CORRUPT`` is set during the initialization of the controller, in case a corrupted safety memory is encountered.
In this case the error memory is reinitialized and the flag is set in the error memory. Afer a reboot it will stay asserted until the In this case the error memory is reinitialized and the flag is set in the error memory. Afer a reboot it will stay asserted until the
safety backup memory is cleared safety backup memory is cleared.
.. seealso:: :ref:`backup_ram` .. seealso:: :ref:`backup_ram`
@ -102,7 +103,7 @@ yes no yes no
ERR_FLAG_STACK ERR_FLAG_STACK
--------------------------- ---------------------------
``ERR_FLAG_STACK`` ialization of the controller, in case a corrupted safety memory is encountered. ``ERR_FLAG_STACK`` Shutdown of the controller, in case a corrupted safety memory is encountered.
This error is not recoverable and will trigger the panic mode. This error is not recoverable and will trigger the panic mode.
.. seealso:: :ref:`safety_stack_checking` .. seealso:: :ref:`safety_stack_checking`
@ -112,3 +113,34 @@ persistent self-clearing Stops PID Panic Mode
========== ============= ============= =========== ========== ============= ============= ===========
yes no yes yes yes no yes yes
========== ============= ============= =========== ========== ============= ============= ===========
.. _safety_flags_timing_pid:
ERR_FLAG_TIMING_PID
---------------------------
``ERR_FLAG_TIMING_PID`` is set if the timing monitor of the PID controller detects a violation in the sample frequency.
The flag is recoverable and only shuts down the PID and therefore the oven control output.
.. seealso:: Timing Monitor
========== ============= ============= ===========
persistent self-clearing Stops PID Panic Mode
========== ============= ============= ===========
no no yes no
========== ============= ============= ===========
.. _safety_flags_overtemp:
ERR_FLAG_OVERTEMP
---------------------------
``ERR_FLAG_OVERTEMP`` is set if the :ref:`pt1000_processing` detects an overtemperature.
The default limit is ``260 degrees Celsius``. However, it is possible to configure the limit and permanenty store it in the EEPROM since hardware version v1.3.
========== ============= ============= ===========
persistent self-clearing Stops PID Panic Mode
========== ============= ============= ===========
no no yes no
========== ============= ============= ===========