esphome-frekvens-panel's Introduction

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.

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

Here is a short config to demonstrate the usage to display time on panel:

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);