add more comments explaining various parameters

pull/2/head
xyqyear 2023-07-16 08:46:18 +08:00
parent 61e33fac36
commit 47a7828b42
1 changed files with 22 additions and 2 deletions

View File

@ -72,6 +72,11 @@ const uint8_t RELEASE_THREASHOLD_OFFSET = 0;
// NHDF = 1 // NHDF = 1
// NCLF = 16 // NCLF = 16
// FDLF = 4 // FDLF = 4
// rising NHD is larger than falling NHD because rising is the release direction
// the rising changes are more likely to be environmental changes
// rising NCL being smaller than falling NCL is because of the same reason
// the user can experiment with different values to find the best one
// but those values should be a good for most cases
const uint8_t MHDR = 2; const uint8_t MHDR = 2;
const uint8_t NHDR = 2; const uint8_t NHDR = 2;
const uint8_t NCLR = 4; const uint8_t NCLR = 4;
@ -89,6 +94,7 @@ const uint8_t FDLF = 4;
// aka. first filter averaging samples // aka. first filter averaging samples
// the highest and lowest are tossed // the highest and lowest are tossed
// so theoretically, the less samples, the system is less prone to noise // so theoretically, the less samples, the system is less prone to noise
// the user shouldn't change this value in any case
const uint8_t FIRST_FILTER_ITERATIONS = 0; const uint8_t FIRST_FILTER_ITERATIONS = 0;
// range: 0 - 7 // range: 0 - 7
@ -102,25 +108,36 @@ const uint8_t CHARGE_DISCHARGE_TIME = 1;
// 2: 10 samples // 2: 10 samples
// 3: 18 samples // 3: 18 samples
// aka. second filter averaging samples // aka. second filter averaging samples
// this value and the next value determines the response time and second stage filtering
// changing any of them is basically the same
// setting those two values higher will result in a smoother signal but slower response time
// if the user notices the signal is too noisy, they can try to increase this value
const uint8_t SECOND_FILTER_ITERATIONS = 0; const uint8_t SECOND_FILTER_ITERATIONS = 0;
// range: 0 - 7 // range: 0 - 7
// 2^ESI ms of first stage samples are taken into account // 2^ESI ms of first stage samples are taken into account
// all the first stage samples in the period is averaged // all the first stage samples in the period is averaged
// regarding how to set this value, please refer to the comment above
const uint8_t ELECTRODE_SAMPLE_INTERVAL = 0; const uint8_t ELECTRODE_SAMPLE_INTERVAL = 0;
// range: 0 - 7 // range: 0 - 7
// when DR + 1 samples are lower than the threshold, the electrode is released // when DR + 1 samples are lower than the threshold, the electrode is released
// this smoothes out the signal and prevents false release
// however, a debounce value that's too high might cause releases that are too short to be missed
// if the user notices too many false releases, try to increase this value. but don't set it too high
const uint8_t RELEASE_DEBOUNCE = 1; const uint8_t RELEASE_DEBOUNCE = 1;
// range: 0 - 7 // range: 0 - 7
// when DT + 1 samples are higher than the threshold, the electrode is touched // when DT + 1 samples are higher than the threshold, the electrode is touched
// a debounce value that's too low might cause touches that's too short to be missed // this smoothes out the signal and prevents false touch
// however, a debounce value that's too high might cause touches that are too short to be missed
// if the user notices too many false touches, try to increase this value. but don't set it too high
const uint8_t TOUCH_DEBOUNCE = 1; const uint8_t TOUCH_DEBOUNCE = 1;
// ! the touch response time is debounce * SFI * ESI ms // ! the touch response time is debounce * SFI * ESI ms
// ! so in the code bellow we set read interval to SFI * ESI ms // ! so in the code bellow we set read interval to SFI * ESI ms
// please refer to AN3889 page 9 for more information // please refer to AN3889 page 9 for more information
// the user should not change those values
const uint8_t AUTO_CONFIG_RETRY = 0; const uint8_t AUTO_CONFIG_RETRY = 0;
const uint8_t AUTO_CONFIG_BVA = 2; const uint8_t AUTO_CONFIG_BVA = 2;
const uint8_t AUTO_CONFIG_ARE = 1; const uint8_t AUTO_CONFIG_ARE = 1;
@ -131,12 +148,15 @@ const uint8_t AUTO_CONFIG_ACE = 1;
// which means it will use a fixed CDT and only search for CDC // which means it will use a fixed CDT and only search for CDC
// this results in a known first stage sample amount // this results in a known first stage sample amount
// however, through testing, setting this to 1 will greatly degrade signal quality // however, through testing, setting this to 1 will greatly degrade signal quality
// the user should not change this value
const uint8_t SCTS = 0; const uint8_t SCTS = 0;
// those values are suitable for 3.3V, for other voltage systems, please refer to AN3889 page 7 through 8 // those values are suitable for 3.3V
// for other voltage systems, please refer to AN3889 page 7 through 8
const uint8_t USL = 202; const uint8_t USL = 202;
const uint8_t TL = 182; const uint8_t TL = 182;
const uint8_t LSL = 131; const uint8_t LSL = 131;
// please refer to page 16 of the datasheet for more information // please refer to page 16 of the datasheet for more information
// this value should be the same as AUTO_CONFIG_BVA
const uint8_t CALIBRATION_LOCK = 0x10; const uint8_t CALIBRATION_LOCK = 0x10;