As3935 calibration (#3173)

This commit is contained in:
Mark Veinot 2023-10-11 22:27:39 -03:00 committed by GitHub
parent f37d2d1005
commit c1ec3cbea7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions

View File

@ -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
------