From c1ec3cbea7d46734e2cc6dcc0eb287c995dc37c6 Mon Sep 17 00:00:00 2001 From: Mark Veinot Date: Wed, 11 Oct 2023 22:27:39 -0300 Subject: [PATCH] As3935 calibration (#3173) --- components/sensor/as3935.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/components/sensor/as3935.rst b/components/sensor/as3935.rst index 0d770e66e..7bc0aa4f0 100644 --- a/components/sensor/as3935.rst +++ b/components/sensor/as3935.rst @@ -99,7 +99,14 @@ Configuration variables: detection and distance sensing. It's possible to add up to 120pF in steps of 8pF to the antenna. Defaults to ``0``. - **watchdog_threshold** (*Optional*, int): Determines the threshold for events that trigger the IRQ pin. Defaults to ``2``. - +- **tune_antenna** (*Optional*, boolean): Start sensor in antenna tuning mode. It will emit oscillator + frequency to be read on the INT pin. Please follow AS3935 documentation. Note that while this mode is enabled, + lightings will not be detected. It should be used for initial calibration only, in order to determine correct value of + ``capacitance`` and/or ``div_ratio`` parameters. + Defaults to ``False``. +- **calibration** (*Optional*, boolean): Enable/disable oscillator calibration on startup. It is recommended to perform + antenna tuning procedure first and adjust parameters, so that RLC antenna resonance is tuned within optimal range. + Defaults to ``True``. Over I²C -------- @@ -152,7 +159,14 @@ Configuration variables: detection and distance sensing. It's possible to add up to 120pF in steps of 8pF to the antenna. Defaults to ``0``. - **watchdog_threshold** (*Optional*, int): Determines the threshold for events that trigger the IRQ pin. Defaults to ``2``. - +- **tune_antenna** (*Optional*, boolean): Start sensor in antenna tuning mode. It will emit oscillator + frequency to be read on the INT pin. Please follow AS3935 documentation. Note that while this mode is enabled, + lightings will not be detected. It should be used for initial calibration only, in order to determine correct value of + ``capacitance`` and/or ``div_ratio`` parameters. + Defaults to ``False``. +- **calibration** (*Optional*, boolean): Enable/disable oscillator calibration on startup. It is recommended to perform + antenna tuning procedure first and adjust parameters, so that RLC antenna resonance is tuned within optimal range. + Defaults to ``True``. Sensor ------