From dd5367eaac109febf01bc0b18bba93990232ed23 Mon Sep 17 00:00:00 2001 From: Thomas Kunze Date: Fri, 9 Aug 2024 20:18:10 +0200 Subject: [PATCH] lib props --- README.md | 47 ++-------------------------------------------- library.json | 16 ++++++++++++++++ library.properties | 8 ++++---- 3 files changed, 22 insertions(+), 49 deletions(-) create mode 100644 library.json diff --git a/README.md b/README.md index 953cfa8..3d6b0f5 100644 --- a/README.md +++ b/README.md @@ -4,50 +4,7 @@ This projects provides a knx-device stack for arduino (ESP8266, ESP32, SAMD21, R 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. - Generated documentation can be found [here](https://knx.readthedocs.io/en/latest/). -## Stack configuration possibilities - -Specify prog button GPIO other then `GPIO0`: -```C++ -knx.buttonPin(3); // Use GPIO3 Pin -``` - -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. +## Usage +See the examples for basic usage options diff --git a/library.json b/library.json new file mode 100644 index 0000000..8f76877 --- /dev/null +++ b/library.json @@ -0,0 +1,16 @@ +{ + "name": "knx", + "version": "1.2.0", + "dependencies": { + }, + "description": "knx stack", + "authors": [ + { + "name": "Thomas Kunze" + } + ], + "repository": { + "type": "git", + "url": "https://github.com/thelsing/knx" + } +} \ No newline at end of file diff --git a/library.properties b/library.properties index 980e8ea..3e79e42 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ name=knx -version=2.0.0 -author=Thomas Kunze et al. -maintainer=OpenKNX Team +version=1.2.0 +author=Thomas Kunze, et. al. +maintainer=Thomas Kunze sentence=knx stack paragraph= category=Communication -url=https://github.com/OpenKNX/knx +url=https://github.com/thelsing/knx architectures=* includes=knx.h \ No newline at end of file