Skip to content

Commit b55b0d6

Browse files
Update documentation
1 parent e039cae commit b55b0d6

File tree

1 file changed

+0
-69
lines changed

1 file changed

+0
-69
lines changed

docs/api.md

Lines changed: 0 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
Members | Descriptions
44
--------------------------------|---------------------------------------------
55
`class ` [`CapacitiveTouch`](#class_capacitive_touch) | A user-friendly class for capacitive touch sensing.
6-
`struct ` [`CapTouchPinMapping`](#struct_cap_touch_pin_mapping) | Defines the mapping between an Arduino pin and its capacitive touch hardware settings.
76

87
# class `CapacitiveTouch` <a id="class_capacitive_touch" class="anchor"></a>
98

@@ -97,71 +96,3 @@ Retrieves the current detection threshold.
9796
int The current threshold value.
9897
<hr />
9998

100-
# struct `CapTouchPinMapping` <a id="struct_cap_touch_pin_mapping" class="anchor"></a>
101-
102-
Defines the mapping between an Arduino pin and its capacitive touch hardware settings.
103-
104-
Each entry includes the Arduino pin number, a flag indicating support, and additional hardware parameters needed for the CTSU.
105-
106-
## Summary
107-
108-
Members | Descriptions
109-
--------------------------------|---------------------------------------------
110-
| [`arduinoPin`](#struct_cap_touch_pin_mapping_1a8f558f88fa5298ded8cbbdd4830b4cbe) | Arduino pin number (e.g., D4, D3, A4) |
111-
| [`supported`](#struct_cap_touch_pin_mapping_1a4e27a8d3ce508ad4bfab32ef4d94e292) | True if this pin is supported for capacitive touch sensing. |
112-
| [`ts_num`](#struct_cap_touch_pin_mapping_1a64ecb7d254b91a6d02229c4b26b94f26) | Touch sensor channel number. |
113-
| [`chac_idx`](#struct_cap_touch_pin_mapping_1aff722690ee3b00afb64221eb1cde5a75) | Channel control register index. |
114-
| [`chac_val`](#struct_cap_touch_pin_mapping_1ad1a206d6af3ddf996713d18190cd2f2c) | Bit mask used to enable the sensor channel. |
115-
116-
## Members
117-
118-
### `arduinoPin` <a id="struct_cap_touch_pin_mapping_1a8f558f88fa5298ded8cbbdd4830b4cbe" class="anchor"></a>
119-
120-
```cpp
121-
uint8_t arduinoPin
122-
```
123-
124-
Arduino pin number (e.g., D4, D3, A4)
125-
126-
<hr />
127-
128-
### `supported` <a id="struct_cap_touch_pin_mapping_1a4e27a8d3ce508ad4bfab32ef4d94e292" class="anchor"></a>
129-
130-
```cpp
131-
bool supported
132-
```
133-
134-
True if this pin is supported for capacitive touch sensing.
135-
136-
<hr />
137-
138-
### `ts_num` <a id="struct_cap_touch_pin_mapping_1a64ecb7d254b91a6d02229c4b26b94f26" class="anchor"></a>
139-
140-
```cpp
141-
uint8_t ts_num
142-
```
143-
144-
Touch sensor channel number.
145-
146-
<hr />
147-
148-
### `chac_idx` <a id="struct_cap_touch_pin_mapping_1aff722690ee3b00afb64221eb1cde5a75" class="anchor"></a>
149-
150-
```cpp
151-
uint8_t chac_idx
152-
```
153-
154-
Channel control register index.
155-
156-
<hr />
157-
158-
### `chac_val` <a id="struct_cap_touch_pin_mapping_1ad1a206d6af3ddf996713d18190cd2f2c" class="anchor"></a>
159-
160-
```cpp
161-
uint8_t chac_val
162-
```
163-
164-
Bit mask used to enable the sensor channel.
165-
166-
<hr />
167-

0 commit comments

Comments
 (0)