Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Reference.md

This commit is contained in:
HomeSpan 2024-01-15 21:31:19 -06:00 committed by GitHub
parent 1a6bc93632
commit fe0b8c1a42
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Reference.md
View File

@ -33,14 +33,11 @@ Methods with a return type of `Span&` return a reference to `homeSpan` itself an
* sets the ESP32 *pin* to use for the HomeSpan Control Button * sets the ESP32 *pin* to use for the HomeSpan Control Button
* if this method is not called, HomeSpan will assume there is no Control Button * if this method is not called, HomeSpan will assume there is no Control Button
* the optional second argument, *triggerType*, configures the Control Button as follows: * the optional second argument, *triggerType*, configures the Control Button as follows:
* `PushButton::TRIGGER_ON_LOW` * `PushButton::TRIGGER_ON_LOW` - triggers when *pin* is driven LOW
* triggers when *pin* is driven LOW
* suitable for buttons that connect *pin* to GROUND (this is the default when *triggerType* is not specified) * suitable for buttons that connect *pin* to GROUND (this is the default when *triggerType* is not specified)
* `PushButton::TRIGGER_ON_HIGH` * `PushButton::TRIGGER_ON_HIGH` - triggers when *pin* is driven HIGH
* triggers when *pin* is driven HIGH
* suitable for buttons that connect *pin* to VCC (typically 3.3V) * suitable for buttons that connect *pin* to VCC (typically 3.3V)
* `PushButton::TRIGGER_ON_TOUCH` * `PushButton::TRIGGER_ON_TOUCH` - uses the device's touch-sensor peripheral to trigger when *pin* has been touched
* uses the device's touch-sensor peripheral to trigger when a sensor attached to *pin* has been touched
* not available on ESP32-C3 * not available on ESP32-C3
* as an alternative, you can set *triggerType* to any user-defined function of the form `boolean(int arg)` to utilize any device as a Control Button. See **SpanButton** below for details * as an alternative, you can set *triggerType* to any user-defined function of the form `boolean(int arg)` to utilize any device as a Control Button. See **SpanButton** below for details