From e7aa714976206458242e8bd86ff8cd0637da8ccc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Tue, 26 Jan 2021 22:48:19 +0100 Subject: [PATCH] Update documentation regarding Unstable flag --- doc/source/firmware/pt1000-processing.rst | 11 +++++++++-- doc/source/firmware/pt1000.drawio | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/source/firmware/pt1000-processing.rst b/doc/source/firmware/pt1000-processing.rst index d254c49..2f017e8 100644 --- a/doc/source/firmware/pt1000-processing.rst +++ b/doc/source/firmware/pt1000-processing.rst @@ -87,9 +87,16 @@ and can be changed in code using .. doxygenfunction:: adc_pt1000_set_moving_average_filter_param -After initial startup and after each change of the filter constant, the filter will set the :ref:`safety_flags_adc_unstable` flag for a defined sample count of: +The moving average filter is considered unstable, if the input to output difference is greater than -.. doxygendefine:: ADC_FILTER_STARTUP_CYCLES +.. doxygendefine:: ADC_PT1000_FILTER_UNSTABLE_DIFF + +In this case, the :ref:`safety_flags_adc_unstable` flag will be set until the filter output converges within the range for at least + +.. doxygendefine:: ADC_PT1000_FILTER_STABLE_SAMPLE_COUNT + +samples. +If the input value keeps changing or oscillating, the error flag will be permanently set. The moving average filter's output signal is the Low Frequency (LF) PT1000 resistance signal used for internal PT1000 measurements. diff --git a/doc/source/firmware/pt1000.drawio b/doc/source/firmware/pt1000.drawio index f0b84f2..b0398c3 100644 --- a/doc/source/firmware/pt1000.drawio +++ b/doc/source/firmware/pt1000.drawio @@ -1 +1 @@ -7Vxbc9o4FP41zOw+hLEtXx9pgGanaZNtOs3uvjDCFuDEICqLAPn1K2HZ2JYwhJhLkuYhQceyZJ/Lp3MjDXA5XnwmcDr6igMUNQwtWDRAu2EYnquz35ywTAiWDRLCkIRBQtLXhLvwGQmiJqizMEBxYSLFOKLhtEj08WSCfFqgQULwvDhtgKPirlM4RBLhzoeRTL0PAzpKqK6lrelXKByO0p11TVzpQ/9xSPBsIvZrGGCw+kkuj2G6lpgfj2CA5zkS6DTAJcGYJp/Gi0sUcdambEvu6264mj03QRO6yw3oyvTGtNf99jBvYXS/aN3YDxe6IR6OLlOGoIDxRwwxoSM8xBMYddbUT6uXRnxZjY3Wc64xnjKizogPiNKlEDacUcxIIzqOxFW0COk/4nb++V/+uWmJUXuRu9Re5ga3iIRjRBERtJgS/IgucYTJ6tmBa/SBbfPZE0qW2RZ8kNuDD9ebrEbpLoMwinLrBRZyA5PRZWYL/sd4RnzBuQfwS3uGXxc9//sM/gUWP90huhDWQCEZIlohCSeZx7mf20CI8jPC7L3Jkk0gKII0fCpqLxRGMMzmZbfe4pA9sqEJewW2UEdhrnqq6OkSyYOKu9bqxD7kHmNNWinZSxTOecsKt69arUa7a+/ptFC361bDggJVaEvVYz/BaCZ2arXZSnbE3uFTn7BPQ5rxJadST4jQkGH8Neyj6BbHIQ3xhF3qY0rxmPM+BWMuiADGo0y7YBQO+VSf8ZiLKq9G6bItMYdy9eNrTfm+48WQn5BNFLFzivB5TdhnQoY+bQbQX+kxheJJVvuGhM1MxnMU8zdhKwQh27ktXyopBdKZWjgqNfJsB0A7t1juWtvquO1KVeLviBaVshdXDasIJZ4w7fn6GHXEjFHuBDXtAymLbp0PtLjgNeDS9GqAFzQJWtw/YsMJnqCE0g05T1VH3Q76tD/8mDL8KOedF/qkYHgOCqXb+yhUtQbUepp9CHVS+1RuyaVydnOpmGzgMjdtyifEm7fx1J5bd8fpjlYyiGT/fb07tcW4p7QYvWAxrwBg/YPCLzgr+DUl5+/8/Tzm4PX4CoMonF6lkmaff4qVa5T67o6arhehwLEkRy3LauQ9NU87kGSt7ZJdgSEinSfEMbEollNLO2bzYNRLzC5u+jPChdNLzfA0QjZKcK9JMjYVIrYPJeLqg0Ag4tnE9ccE4yM5JSbzGU3DtRzxWy+oR6Yf9ad9ql76rVo8QXEYU0zi5hMkIexHqJeSVnCfj+QnXI/lYP80yF8CfhkUbAUoZIdB7ajgbVeDnN/kRzCOQ78ou41c2WpQube2FG+d0l6bYPWajq3lfqyi4ZVYm8CFZHcvXfZwWVy1n/+mywavxu63lsfYwezOBWkjPAz93hBS5lhFeD5lCNBj0JksfBoM9bamOS1DhpM60pzKFD14K6a3qYqxue6xk2Gq6xY7GmbtEe4GtNZKOnPkIptk73dwPGWaYGg/GBIS9vcPNkd7vHr+U9KmnNQLZj4fhcwop3Alhzmz23pFvLtBArPIXEP2ajKbLVhkDV6Nkt0nTRO/Nun18ipklia70JqanlGSBzA9sE+2bH/LV+S2lPMM7zim75R8br3s8dWUDXZMU7lPXfndKmbngKWzmLJYfkJDGMl12a/4KZwM2Q0tZt28D8fQuslZ/h7cj+OgnQ3ss3I/dPMkaLdnqepAPRZVHTzbeyxOlmaveux8jwWTDOZm+3NFM7R7SP1RwElv3ldI1TfvLKgSo+WAuj77kXtaOt+/S5xNMYqtGE5jVLSGrbye5o5XsULuxC2LYjAYGL6vEkVg922rJlG4JZ9Y5bcBV5ZESqtdEkZ1KxqK+nj+Tly2/UGt/oawTTX0slN/GLfJLBfr7SO4TUB/d5p2kgbbSg3deu4C7TiqbFn7RQC1Rf9yseWWoMFvx/uFroPnnZfjrcjimppI40hyZS9JiyKRxFWW0TgMggR+UBw+8yKXELTAVLau9alhtflaDHHiBHwqazIv4DbYmmVVlarKplWfc6Bt4HbXficcN+2tHFe17x6O44qukPfFcduzzovjrsTxqy4btyGF7E+Dx0XnI4CzCFqyxHI+fjSOKjT5GLj+LbRqoSmaoY4rNFBdtDuTAOANfLmp0rHfGgGI3M+ZJN7A0fMP+cKNU2pyNr0Ti3l7/GbVLT51/Gbb6mN6S8vOSzMR0jbV7fzl6W71dMspYqDtlfT1EGkO+WjqEvSryUiXI+Q/KtV9FXge7jyS1a3SFqVDJvviudilkf/yturwYbZlWKBUm0tGr20qAM00F5qu2ywnR/FgEKODZBWAHBCl5YGLhmHDMQ/wxbcxtZvRWBJ2Eb5WWeu7YtY6pwInifitUgya9UHm/AZX4TYcrLEAyPXWrDazrslo3QjKpZn37+Y5pTybYbmym6eq7RzOzZND2I9Z27Fkw1GVdg5nOHIKdPXFcd7+lHQkfFSbKXkRQBEZ6QcymS9G5wr9TW4evxjXy8H9D/O/J1fRqtb61rq++VxxfOgvPj52bhRVHP8SuzfyttQnauyaKqjjOzhK3hoSb9vhMKS8U0fjKxvaHR7QOXvBWrm982H9Km4DxzozdsuF/ZsZnc5oLjnDmV5ukuoQwviTIFJcqyB2hpRXCcIpRRpA4TXVJQg2XP/DpMSzXf9TKtD5Hw== \ No newline at end of file +7Vxbd6M4Ev41Pmf3IT7cL49ObHfmTHqS7cx07+yLj4xlWx2MHJAvya9fCQQGJGPHBl/S0w9pKGQJqr66qKqgpd/N1l9CMJ9+xSPotzRltG7p3ZamuY5K/zLCW0JQLUtPKJMQjThtQ3hG75ATFU5doBGMCgMJxj5B8yLRw0EAPVKggTDEq+KwMfaLq87BBAqEZw/4IvUHGpFpQnVMZUO/h2gyTVdWFX5lCLyXSYgXAV+vpenj+F9yeQbSufj4aApGeJUj6b2WfhdiTJKj2foO+oy3KduS3/W3XM3uO4QB2ecH8N5wZ2TQ/+PnqoPhj3Xn0fp5o2r85shbyhA4ovzhpzgkUzzBAfB7G+pt/NCQTavQs82YB4znlKhS4k9IyBsXNlgQTElTMvP5VbhG5L/85+z4b3bcNvlZd5271H3LnTzBEM0ggSGnRSTEL/AO+ziM7113tKFuWWx0QMK3bAl2kluDnW4Wic/SVcbI93PzjUzojAxKF5nN+R/hRehxzv3UX5V38HU98L4twG/6+rszgTdcGwgIJ5BUSMJOxjHu5xbgovwCMX3u8I0OCKEPCFoW0Qu4EkyycdlPnzCit6wpXGF1i8Mx1dcU6OkUyY3yX23gRA9yt7EhxSD7CODsawbcobCKz/ZH7/lQqFp1w7AAoAq0VN32EvgLvlKnS2eyfPoMt8OQHk1IxpccpJYwJIja+AcwhP4TjhBBOKCXhpgQPGO8T40xE8QIRNMMXcBHEzbUozxmosrDKJ22w8cQBj8215ytO1tPmItsQ5/6qZCNa4MhFTLwSHsEvBjHBPA7iddFIR2ZnK9gxJ6EzjBCdOWueKkECqhSWNgyGLmWrQMrN1nuWtfsOd1KKLFnhOtK2fOrmlk0JS5X7dXGjdp8xDTnQQ2rIbCo5uWYFkc/xri03RrMCwxGHRYf0dMABzCh9BHjqczV7YGnw82PIZof6bjLsj6pMbwEQKnWIYCqRkCt3uyXgJM8pnJKIZW9X0hFZQPecsPmbEC0fRlXHrn19xxuKyWFSNY/NLqTa4xzTo1RCxpzhAFWf1Hzq1+U+TWE4K+LxmNIH58+rKZ0ZnMfjREMxXjwC0ABHRH/SEkTDZccHtK4cMBmGPtofp8ChB5/5zPXCJb94ztVLVoQ2xTiuywZkg/wXKUhQJgCIATJxjYUhr0lZKa0KJZzSzui44A/SLQ1anuLkAlnkGrveYSslbyEIsjYkIjYakrE1f6DG9KLSQec0oafKJYxaKhpaI5p879qAR4ZPurPFlU99LVqfAgjFBEcRu0lCBEY+nCQkmJzn08ABAzHYo7gPJa/ZPhFo2BJjELmDGq3Cu5uGOTCLc8HUYS8ouy2cmWnQuWe2pQ8dUo7Ni/rtm1Lyf0zi4pXYm1iLgS9++i0zSV/5duDq642HG27ry39Iaqd1tYogJT7d/rn4eli42ofT5A3mABCwywfr+bUHgyoIU0mPo9FdXfmSk1NNC515EqleX79WhRxWylke/FkLzWVFz/2VNPat8lbbLdSwsyJK3WC9j8DuuVmW+8/qV2km23lX3SM8nL//m8BTTmpF9R8NUVUKecglsOK6m29It5fIXWjyFxNjHEynS1oZA0xjpTdZ801H5s5+3gpM8u13ShtRc0oyQ0Yrn5Iyu1wzZckyKTjNPc0qm+XInC1HP/VlFK2DUO6Tl1J4qGrWl9ty/vr5vX19jnovg6Wy5uzdgAcnSP2h3EAk8YkeSjnMsV/t3JZ5CPKKHsbwxIia1MDqQT1RkBv2UXQ66f1d2K6ubee44AyEVExCznmr3iJggnLQ1MosB4zTeknIeZniIpP44Qt3bqoqFg1zmKaDizDNtQ/VNWdtrt/6GwlpKrbzvcPUclgprbfY5qm/ADEm44Y6epD2BS++RhWlr0vZ33q0x+xX6v37ZvA2dRG0RnRPIJFbdjJ63nOY/IZck60LIrxeKx5nkwUI2tomTWJwilt1WTbCd0RJZHSapeEVh1kxVHMRcZXpzRq9Tc7busPKe81m4nmjXIjilVvNC/PJKmfDmlnaR6vROhOv5vGyk1D2TQP25jWlpQSK4JPIRz/E3h/MHRw3csKvCUVPkPh2UVBrvQhSVEkgrjKMpqh0SgxPzBC76wSywXNbSqd17xtmV02F7U4UWJ8KguHH+C2vjP5L6unllWrvuBA2cLtvvVJOG5YOzkua01vjuOS1qXPxfFyxvLsHHcEjt/36XkXEED/a7F90eUI4CI2LVm9I79/1E4qNNENPPwjtGqhSTr2Tis0vbqWfCEbgCt4ca8ysN+5A+C5nwtJvOknzz/k64l2qYHfcM8s5t37N7Nu8W2psVjFBrDUTe/oK/toJkJYpvpVlfJwp3q4WSoUWW4Jr02kOUTX1A/ha5uS7qbQe5HCPd54NuePRLhV6qLgZLKPKvBVWvkPE8icD9UtzdRLJePk7Ni8gt5WiltStW0UJ8HjcQSPTSpIy5lXVfW5vKqxzEU1Vzb+sCkqv+FQ/kzGjvHp4zVrXcQdeVqfumlpFpixDBN/1V15nM4EwBbhGJdNnotlkxz0zpJyMktJkKxbPBe4OpK4tbGGK10s+GfFwU1RUOn7QKwNfv59hl1K9GqmI4hLWlxsbp8h5lB+zeKiKSqOrLbYnOKIOfj4qxysLTRpiflVdaYUxuqSrbnakMr8rvXu4X/Cx5fftYe38Y8/jf8tHUkLb+ePzsPjlwr3oX7YfZymgb7UP6/tm6uq401FKW81gbddNEGEtYopbGZNecZjsqLPXCu3T1Qfss0LY7fYWfK4IPMFC9zS7CBjerlLrxeGlD+JRYpqFcSJTIrQE3lCQUiDeIlNiY3/X0GU7CNT88+j1mAYzTNeXJs7kGyZBXFWuIPSTkLyHmVjqVqp7ESbdTUR1FGScJTia8w3JwyhpIK46s+knCrZcMLW83KIfaO5bce1TFO1NUPVbVcpNerV1+ay/SmrX3i+lOaWzSfuoE/98OHwOErDs6/OpgI0xI+V6Jqo4eV3DGrTcDFd/FuQhCtpYueZukvkI8KeokvVK/kQwFndZA2CMJ1i5Ch1ek11AsgDFjG3FueelNad1ro1O/ToLvkUy/Uzf/f+U/bBngNYT083Xy5OrN7m89B67/8= \ No newline at end of file