From e69f63611a27eac41d48c8fa1d5a0e1e8755374d Mon Sep 17 00:00:00 2001 From: Ing-Dom Date: Wed, 3 Jul 2024 11:27:25 +0200 Subject: [PATCH] Release V2.1.0 --- README.md | 57 ++++++++++++---------------------------------- library.json | 23 +++++++++++++++++++ library.properties | 4 ++-- 3 files changed, 40 insertions(+), 44 deletions(-) create mode 100644 library.json diff --git a/README.md b/README.md index 953cfa8..8f84371 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,26 @@ # knx +This is a fork of the thelsing/knx stack from Thomas Kunze for and by the OpenKNX Team. + +While we did not remove support for any plattform, the testing focus is on RP2040 (main), ESP32 (experimental) and SAMD21(deprecated). + This projects provides a knx-device stack for arduino (ESP8266, ESP32, SAMD21, RP2040, STM32), CC1310 and linux. (more are quite easy to add) It implements most of System-B specification and can be configured with ETS. The necessary knxprod-files can be generated with the [Kaenx-Creator](https://github.com/OpenKNX/Kaenx-Creator) tool. -For ESP8266 and ESP32 [WifiManager](https://github.com/tzapu/WiFiManager) is used to configure wifi. -Don't forget to reset ESP8266 manually (disconnect power) after flashing. The reboot doen't work during configuration with ETS otherwise. +## Usage +See the examples for basic usage options -Generated documentation can be found [here](https://knx.readthedocs.io/en/latest/). -## Stack configuration possibilities +## Changelog -Specify prog button GPIO other then `GPIO0`: -```C++ -knx.buttonPin(3); // Use GPIO3 Pin -``` +### V2.1.0 - 2024-07-03 +- complete rework of the TPUart DataLinkLayer with support interrupt-based handling and optimized queue handling +- added DMA support for RP2040 platform +- fix some issues with continous integration causing github actions to fail +- added rp2040 plattform to knx-demo example +- added bool GroupObject::valueCompare method for only sending the value when it has changed -Specify a LED GPIO for programming mode other then the `LED_BUILTIN`: -```C++ -knx.ledPin(5); -``` - -Use a custom function instead of a LED connected to GPIO to indicate the programming mode: -```C++ -#include -#include -#include -// create a pixel strand with 1 pixel on PIN_NEOPIXEL -Adafruit_NeoPixel pixels(1, PIN_NEOPIXEL); - -void progLedOff() -{ - pixels.clear(); - pixels.show(); -} - -void progLedOn() -{ - pixels.setPixelColor(0, pixels.Color(20, 0, 0)); - pixels.show(); -} - -void main () -{ - knx.setProgLedOffCallback(progLedOff); - knx.setProgLedOnCallback(progLedOn); - [...] -} -``` - -More configuration options can be found in the examples. +### V2.0.0 - 2024-02-13 +- first OpenKNX version \ No newline at end of file diff --git a/library.json b/library.json new file mode 100644 index 0000000..a8ff4f3 --- /dev/null +++ b/library.json @@ -0,0 +1,23 @@ +{ + "name": "knx", + "version": "2.1.0", + "dependencies": { + }, + "description": "knx stack", + "homepage": "https://openknx.de", + "authors": [ + { + "name": "Thomas Kunze" + }, + { + "name": "OpenKNX", + "email": "info@openknx.de", + "url": "https://openknx.de", + "maintainer": true + } + ], + "repository": { + "type": "git", + "url": "https://github.com/OpenKNX/knx" + } +} \ No newline at end of file diff --git a/library.properties b/library.properties index 980e8ea..8a6dcf8 100644 --- a/library.properties +++ b/library.properties @@ -1,6 +1,6 @@ name=knx -version=2.0.0 -author=Thomas Kunze et al. +version=2.1.0 +author=Thomas Kunze, the OpenKNX Team, et. al. maintainer=OpenKNX Team sentence=knx stack paragraph=