Browse Source

Rename Key enum values to be inline with names used in the extension (U1..U6)

v0.9.4
Guy Turcotte 3 years ago
parent
commit
e8779ef417
  1. 2
      CHANGES.md
  2. 6
      README.md
  3. 4
      include/drivers/press_keys.hpp
  4. 2
      library.json

2
CHANGES.md

@ -89,4 +89,4 @@ A hierarchy of frame buffer classes has been added. These allow for flexible ada
## press_keys (.hpp, .cpp)
This class implements the Buttons Extension: 6 mechanical press buttons that replace the touch keys. To be used, at compile time, BUTTONS_EXTENSION must be #defined. The touch_keys class will then not be included.
This class implements the Buttons Extension: 6 mechanical press buttons that replace the touch keys. To be used, at compile time, BUTTONS_EXTENSION must be #defined. The `TouchKeys` class will then **not** be included.

6
README.md

@ -1,4 +1,8 @@
# ESP-IDF-InkPlate Library Version 0.9.3
# ESP-IDF-InkPlate Library Version 0.9.4
(March 3, 2021)
Version 0.9.4: Added `PressKeys` class in support of the Buttons Extended Case as described [here](https://github.com/turgu1/InkPlate-6-Extended-Case). To be used, at compile time, BUTTONS_EXTENSION must be #defined. The `TouchKeys` class will then **not** be included.
(March 2, 2021)

4
include/drivers/press_keys.hpp

@ -6,7 +6,7 @@
class PressKeys : NonCopyable
{
public:
enum class Key : uint8_t { KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5 };
enum class Key : uint8_t { U2, U4, U1, U5, U3, U6 };
PressKeys(MCP23017 & _mcp) : mcp(_mcp) {}
bool setup();
@ -16,7 +16,7 @@ class PressKeys : NonCopyable
*
* Read one of the six presskeys.
*
* @param key presskey (KEY_0, KEY_1, or KEY_2)
* @param key presskey (U1 .. U6)
* @return uint8_t 1 if pressed, 0 if not
*/
uint8_t read_key(Key key);

2
library.json

@ -1,6 +1,6 @@
{
"name": "ESP-IDF-Inkplate",
"version": "0.9.3",
"version": "0.9.4",
"description": "Implements common functions for Inkplate e-paper displays",
"keywords": "e-ink, e-paper, display, esp32",
"repository":

Loading…
Cancel
Save