Add a readme

This commit is contained in:
Prashant Sinha
2021-09-12 12:36:23 +02:00
parent c4828e0f0e
commit 87e0e999a8

19
README.md Normal file
View File

@@ -0,0 +1,19 @@
# esphome-frekvens-component
A custom component for esp-home to interface with IKEA's Frekvens Cube.
## Sources
This repo is heavily based on the original [FrekvensPanel library by @frumperino][https://github.com/frumperino/FrekvensPanel].
It's also inspired from the esphome component PCD8544.
## Usage
Currently there is a dependency upon Adafruit GFX library. In your esphome config, add these lines:
- Declare necessary libraries
- Define frekvenspanel component
## License
[TBD] the original library does not specify the license. This repo is consecutively not licensed yet either.