mirror of
https://github.com/thelsing/knx.git
synced 2024-12-29 00:05:42 +01:00
lib props
This commit is contained in:
parent
5ddbff2d16
commit
dd5367eaac
47
README.md
47
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 <Arduino.h>
|
||||
#include <Adafruit_NeoPixel.h>
|
||||
#include <knx.h>
|
||||
// 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
|
||||
|
16
library.json
Normal file
16
library.json
Normal file
@ -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"
|
||||
}
|
||||
}
|
@ -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
|
Loading…
Reference in New Issue
Block a user