From cc52b33cf5ed74b3ea028a958d04cec4e750f922 Mon Sep 17 00:00:00 2001 From: Rob Tillaart Date: Sun, 13 Nov 2022 09:39:07 +0100 Subject: [PATCH] add changelog.md (#2) --- .arduino-ci.yml | 19 ++++++++++++++++++- CHANGELOG.md | 15 +++++++++++++++ I2CKeyPad8x8.cpp | 6 ++---- I2CKeyPad8x8.h | 8 ++++---- LICENSE | 2 +- README.md | 25 ++++++++++++++----------- library.json | 2 +- library.properties | 2 +- 8 files changed, 56 insertions(+), 23 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.arduino-ci.yml b/.arduino-ci.yml index cecf585..77a333f 100644 --- a/.arduino-ci.yml +++ b/.arduino-ci.yml @@ -1,3 +1,18 @@ +platforms: + rpipico: + board: rp2040:rp2040:rpipico + package: rp2040:rp2040 + gcc: + features: + defines: + - ARDUINO_ARCH_RP2040 + warnings: + flags: + +packages: + rp2040:rp2040: + url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json + compile: # Choosing to run compilation tests on 2 different Arduino platforms platforms: @@ -7,5 +22,7 @@ compile: # - leonardo - m4 - esp32 - # - esp8266 + - esp8266 # - mega2560 + - rpipico + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4a60e6c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Change Log I2CKeyPad8x8 + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + + +## [0.1.1] - 2022-11-12 +- Add RP2040 support to build-CI. +- Add CHANGELOG.md + + +## [0.1.0] - 2022-09-29 +- initial version diff --git a/I2CKeyPad8x8.cpp b/I2CKeyPad8x8.cpp index 53445c9..166f2f5 100644 --- a/I2CKeyPad8x8.cpp +++ b/I2CKeyPad8x8.cpp @@ -1,13 +1,11 @@ // // FILE: I2CKeyPad8x8.cpp // AUTHOR: Rob Tillaart -// VERSION: 0.1.0 +// VERSION: 0.1.1 // PURPOSE: Arduino library for 8x8 or smaller KeyPad connected to an I2C PCF8575. // URL: https://github.com/RobTillaart/I2CKeyPad8x8 // -// HISTORY: -// 0.1.0 2022-09-29 initial version - +// HISTORY: see changelog.md #include "I2CKeyPad8x8.h" diff --git a/I2CKeyPad8x8.h b/I2CKeyPad8x8.h index 652eb00..8bf828a 100644 --- a/I2CKeyPad8x8.h +++ b/I2CKeyPad8x8.h @@ -2,7 +2,7 @@ // // FILE: I2CKeyPad8x8.h // AUTHOR: Rob Tillaart -// VERSION: 0.1.0 +// VERSION: 0.1.1 // PURPOSE: Arduino library for 8x8 or smaller KeyPad connected to an I2C PCF8575. // URL: https://github.com/RobTillaart/I2CKeyPad @@ -11,10 +11,10 @@ #include "Wire.h" -#define I2C_KEYPAD8x8_LIB_VERSION (F("0.1.0")) +#define I2C_KEYPAD8x8_LIB_VERSION (F("0.1.1")) -#define I2C_KEYPAD8x8_NOKEY 64 -#define I2C_KEYPAD8x8_FAIL 65 +#define I2C_KEYPAD8x8_NOKEY 64 +#define I2C_KEYPAD8x8_FAIL 65 class I2CKeyPad8x8 diff --git a/LICENSE b/LICENSE index ea27d2d..cb50267 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Rob Tillaart +Copyright (c) 2022-2022 Rob Tillaart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 0a3728f..e65b8a9 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,15 @@ See the conceptual schema below. PROC PCF8575 KEYPAD +--------+ +--------+ +--------+ | | | 0|----------|R | - | SDA |--------| 1|----------|O | - | SCL |--------| 2|----------|W | - | | | 3|----------|S | + | SDA |--------| .|----------|O | + | SCL |--------| .|----------|W | + | | | 7|----------|S | | | | .| | | | | | .| | | | | | 8|----------|C | - | | | 9|----------|O | - | | | 10|----------|L | - | | | 11|----------|S | - | | | .| | | - | | | .| | | - | | | 16|----------| | - + | | | .|----------|O | + | | | .|----------|L | + | | | 15|----------|S | +--------+ +--------+ +--------+ ``` @@ -110,10 +106,17 @@ See examples ## Future + +#### must +- update documentation + +#### should - test extensively - basic working (OK) - interrupts - keymapping - performance -- update documentation - keep in sync with **I2CKeyPad** as much as possible. + +#### would + diff --git a/library.json b/library.json index 3175c71..1ce06f8 100644 --- a/library.json +++ b/library.json @@ -15,7 +15,7 @@ "type": "git", "url": "https://github.com/RobTillaart/I2CKeyPad8x8.git" }, - "version": "0.1.0", + "version": "0.1.1", "license": "MIT", "frameworks": "arduino", "platforms": "*", diff --git a/library.properties b/library.properties index 3deea40..6de8003 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=I2CKeyPad8x8 -version=0.1.0 +version=0.1.1 author=Rob Tillaart maintainer=Rob Tillaart sentence=Arduino library for a KeyPad connected to a PCF8575.