Skip to content

Commit faf6cf1

Browse files
authored
Update README.md
1 parent aff2def commit faf6cf1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# MicroPython ESP8266/ESP32 Driver for TTP229-BSF 16-key Capacitive Keypad in Serial Interface Mode
22

3-
This MicroPython driver is for TTP229-BSF capacitive keypad on ESP8266/ESP3. Tested on both ESP8266 and ESP32 v1.11 firmware.
3+
This MicroPython driver is for TTP229-BSF capacitive keypad on ESP8266/ESP3. Tested on both ESP8266 (WeMos D1 mini) and ESP32 (BPI:bit) with v1.11 firmware.
44

5-
The serial interface of TTP229-BSF <b>is not I2C</b> but it allows you to control this keypad via only 2 wires. Not to be confused with TTP229-LSF, which is a real I2C device.
5+
The serial interface of TTP229-BSF <b>is not I2C</b> but it allows you to control this keypad via only 2 wires. Not to be confused with TTP229-LSF, which is a true I2C device.
66

77
## Hardware Configuration
88

9-
TTP229-BSF's serial interface supports either 8 or 16 key mode, as well as single/multiple key mode. For some of the settings hardware configuration is required:
9+
TTP229-BSF's serial interface supports either 8 or 16 key mode (see [datasheet](https://www.sunrom.com/get/611100)), as well as single/multiple key mode. For some of the settings hardware configuration is required:
1010

1111
![11-1035x1200](https://user-images.githubusercontent.com/44191076/69064016-6ec49c00-0a58-11ea-9b46-c10f4f1a9cdf.jpg)
1212

@@ -49,7 +49,7 @@ while True:
4949

5050
<b>multi</b> parameter:
5151

52-
* multi=False: single mode
52+
* multi=False (default): single mode
5353
* multi=True: multiple mode
5454

5555
In single mode keypad.read() will return the index of the pressed key (0~15). Return -1 when no key is pressed.
@@ -58,7 +58,7 @@ In multiple mode keypad.read() will return a list containing all the indexes of
5858

5959
If the TTP229-BSF is configured to multiple mode, read it in single mode will return the lowest index of all pressed keys. Read in multiple mode for a keypad configured in single mode, you'll get a list containing only one key index if any key is pressed.
6060

61-
There's also a <b>raw</b> parameter. When set as True, keypad.read() will return the raw 8 or 16 key list indicating all keys' status (1=not pressed, 0=pressed).
61+
There's also a <b>raw</b> parameter, default False. When set as True, keypad.read() will return the raw 8 or 16 key list indicating all keys' status (1=not pressed, 0=pressed).
6262

6363
```python
6464
keypad = Keypad(scl=scl_pin, sdo=sdo_pin, inputs=16, multi=False, raw=True)

0 commit comments

Comments
 (0)