mirror of
https://github.com/sascha-hemi/esphome-ikea-led-matrix.git
synced 2026-03-21 04:06:00 +01:00
Expand readme to include sample config file
This commit is contained in:
59
README.md
59
README.md
@@ -4,7 +4,7 @@ A custom component for esp-home to interface with IKEA's Frekvens Cube.
|
|||||||
|
|
||||||
## Sources
|
## Sources
|
||||||
|
|
||||||
This repo is heavily based on the original [FrekvensPanel library by @frumperino][https://github.com/frumperino/FrekvensPanel].
|
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.
|
It's also inspired from the esphome component PCD8544.
|
||||||
|
|
||||||
@@ -15,5 +15,62 @@ Currently there is a dependency upon Adafruit GFX library. In your esphome confi
|
|||||||
- Declare necessary libraries
|
- Declare necessary libraries
|
||||||
- Define frekvenspanel component
|
- Define frekvenspanel component
|
||||||
|
|
||||||
|
Here is a short config to demonstrate the usage to display time on panel:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
esphome:
|
||||||
|
name: frekvens8266-weather
|
||||||
|
platform: ESP8266
|
||||||
|
board: d1_mini
|
||||||
|
platformio_options:
|
||||||
|
upload_speed: 115200
|
||||||
|
lib_deps:
|
||||||
|
- me-no-dev/ESPAsyncTCP
|
||||||
|
- adafruit/Adafruit GFX Library # Required for FrekvensPanel.
|
||||||
|
- Adafruit BusIO # Required by GFX Library.
|
||||||
|
- Wire # Also required by GFX.
|
||||||
|
- SPI # Also required by GFX.
|
||||||
|
|
||||||
|
external_components:
|
||||||
|
- source:
|
||||||
|
type: local
|
||||||
|
path: <path of directory containing frekvens_panel>
|
||||||
|
|
||||||
|
light:
|
||||||
|
- platform: monochromatic
|
||||||
|
name: 'Brightness'
|
||||||
|
output: matrix_brightness
|
||||||
|
restore_mode: RESTORE_DEFAULT_ON
|
||||||
|
|
||||||
|
output:
|
||||||
|
- platform: esp8266_pwm
|
||||||
|
# Enables brightness control.
|
||||||
|
id: matrix_brightness
|
||||||
|
pin:
|
||||||
|
number: GPIO14
|
||||||
|
inverted: True
|
||||||
|
|
||||||
|
time:
|
||||||
|
- platform: sntp
|
||||||
|
id: ntp_time
|
||||||
|
timezone: 'Europe/Paris'
|
||||||
|
|
||||||
|
font:
|
||||||
|
- file: "04B03.ttf"
|
||||||
|
id: b03
|
||||||
|
size: 8
|
||||||
|
|
||||||
|
display:
|
||||||
|
- platform: frekvens_panel
|
||||||
|
latch_pin: 12
|
||||||
|
clock_pin: 04
|
||||||
|
data_pin: 05
|
||||||
|
|
||||||
|
lambda: |-
|
||||||
|
auto time = id(ntp_time).now();
|
||||||
|
it.printf(0, 0, id(b03), "%d:%d", time.hour, time.minute);
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
[TBD] the original library does not specify the license. This repo is consecutively not licensed yet either.
|
[TBD] the original library does not specify the license. This repo is consecutively not licensed yet either.
|
||||||
|
|||||||
Reference in New Issue
Block a user