Mehr Infos zum M5 Stack Dial
Mit dieser Komponente wird der M5 Stack Dial zu einer universal-Fernbedienung für Home Assistant.
Aktuell werden folgende Entitäten unterstützt:
- climate
- cover
- fan
- light
- switch
- media_player
- lock
Für einen schnellen Austausch, Anregungen so wie Info's zum aktuellen Entwicklungsstand steht auch unser Discord zur Verfügung.
Einladungs-Link: https://discord.gg/pN7SpK7
substitutions:
devicename: "m5-dial"
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
packages:
m5_tough_package:
url: https://github.com/SmartHome-yourself/m5-dial-for-esphome
ref: main
file: shys-m5-dial.yaml
refresh: 1h
shys_m5_dial:
name: Dial
screen_off_time: 45000
rotary_step_width: 5
long_press_duration: 1200
font: FreeSans12pt7b
font_factor: 1
devices:
lights:
- entity: light.my_light1
name: Light 1
modes:
dimm_mode:
enable: true
rotary_step_width: 10
rgb_mode:
enable: true
rotary_step_width: 30
white_mode:
enable: true
rotary_step_width: 100
min_kelvin: 2500
min_kelvin: 7000
- entity: light.my_light2
name: Light 2
switches:
- entity: switch.my_switch
name: Switch 1
climates:
- entity: climate.my_climate1
name: Heater
modes:
temp_mode:
rotary_step_width: 1
min_temperature: 4
max_temperature: 30
covers:
- entity: cover.my_cover1
name: Cover 1
modes:
position_mode:
rotary_step_width: 5
fans:
- entity: fan.my_fan1
name: Fan 1
modes:
speed_mode:
changeable_direction: true
rotary_step_width: 10
media_player:
- entity: media_player.my_player1
name: MediaPlayer 1
modes:
play_mode:
rotary_step_width: 10
source_mode:
rotary_step_width: 1
sources:
- name: 1Live
content_id: 1Live
content_type: TUNEIN
- name: WDR2
content_id: "http://wdr-wdr2-bergischesland.icecast.wdr.de/wdr/wdr2/bergischesland/mp3/128/stream.mp3"
content_type: custom
lock:
- entity: lock.my_lock1
name: Lock 1
modes:
lock_mode:
rotary_step_width: 1
open_on_button: false
In den Substitutions muss auf jeden Fall der devicename angegeben werden.
Die Funknetzwerk-Verbindung muss entweder über den normalen wifi: Abschnitt vollständig konfiguriert werden, oder man kann alternativ auch einfach die WLAN-SSID und das WLAN-Passwort in den Substitutions angeben.
substitutions:
name: "m5-dial"
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
name
Der Hostname des Geräts. (default: m5-dial)
wifi_ssid
Der Hostname des Geräts. (default: !secret wifi_ssid)
wifi_password
Der Hostname des Geräts. (default: !secret wifi_password)
Allgemeine Attribute sind alle Parameter, die direkt unter der Custom-Component "shys_m5_dial" zur Verfügung stehen.
Code:
shys_m5_dial:
name: Dial
screenOffTime: 45000
rotaryStepWidth: 5
longPressDuration: 1200
name
Legt den Namen der Komponente fest.
screenOffTime (optional) (Default: 30000)
Gibt an, nach wie viel Millisekunden das Display sich automatisch abschaltet
rotaryStepWidth (optional) (Default: 10)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert gilt für alle Modi, bei denen keine abweichende Schrittweite angegeben wird.
longPressDuration (optional) (Default: 1200)
Gibt die Dauer an, ab wie viel Millisekunden ein Tastendruck als Long-Press gelten soll.
font (optional) (Default: FreeSans12pt7b)
Gibt die zu verwendende Schriftart an.
Alle zur Verfügung stehenden Schriften sind in einer Map in globals.h definiert.
font_factor (optional) (Default: 1)
Gibt den Faktor an, der auf die Schriftgröße angewendet werden soll.
Gültige Werte: 0.1 - 10.0
Unter Devices werden alle Entitäten angegeben, die mit dem M5 Dial gesteuert werden sollen.
Die Angabe der Entitäten erfolgt in einzelnen Listen je Geräteart (Domain) wie z.B. Lichter, Schalter, Jalousien usw.
Code:
shys_m5_dial:
...
devices:
Unter "devices - lights" werden alle Light-Entitäten angegeben.
Ohne weitere Angaben lässt sich die Lampe über den Dial nur an-/aus-schalten.
Um Farbe, Helligkeit oder den Weißwert einstellen zu können muss der jeweilige Mode aktiviert werden.
Code:
shys_m5_dial:
...
devices:
lights:
- entity: light.my_light1
name: Light 1
entity
Angabe der Light-Entity-ID aus Home Assistant, die gesteuert werden soll.
name
Der auf dem Display angezeigte Name der Entität.
Mit Hilfe des Dimm-Mode lässt sich die Helligkeit der Light-Entität regeln.
Ist der Dimm-Mode aktiv, ersetzt dieser den Standard-On/Off-Mode.
Die Helligkeit lässt sich sowohl über den Drehregler als auch per Touch steuern.
Ein Druck auf den Button schaltet das Licht an/aus.
Code:
shys_m5_dial:
...
devices:
lights:
- entity: light.my_light1
name: Light 1
modes:
dimm_mode:
enable: true
rotary_step_width: 10
enable (Default: false)
Durch setzen auf true wird der Modus für die Entität aktiviert.
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert überschreibt den allgemein eingestellten Wert und gilt nur für den Helligkeits-Modus dieser Light Entität.
Gültige Werte 1 - 100
Mit Hilfe des White-Mode lässt sich der Weißton für die Light-Entität in Kelvin regeln.
Der Weiß-Ton lässt sich sowohl über den Drehregler als auch per Touch steuern.
Ein Druck auf den Button schaltet das Licht an/aus.
Code:
shys_m5_dial:
...
devices:
lights:
- entity: light.my_light1
name: Light 1
modes:
white_mode:
enable: true
rotary_step_width: 100
min_kelvin: 2500
min_kelvin: 7000
enable (Default: false)
Durch setzen auf true wird der Modus für die Entität aktiviert.
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert überschreibt den allgemein eingestellten Wert und gilt nur für den Weiß-Ton Modus dieser Light Entität.
Gültige Werte 1 - 500
min_kelvin (optional) (Default: 2000)
Gibt den Minimalwert in Kelvin für die Weiß-Ton Steuerung an.
Gültige Werte 1000 - 10000
max_kelvin (optional) (Default: 6500)
Gibt den Maximalwert in Kelvin für die Weiß-Ton Steuerung an.
Gültige Werte 1000 - 10000
Mit Hilfe des RGB-Mode (Farbwahl) lässt sich die Farbe für die Light-Entität auswählen.
Die Farbe lässt sich sowohl über den Drehregler als auch per Touch steuern.
Ein Druck auf den Button schaltet das Licht an/aus.
Code:
shys_m5_dial:
...
devices:
lights:
- entity: light.my_light1
name: Light 1
modes:
rgb_mode:
enable: true
rotary_step_width: 30
enable Default: false
Durch setzen auf true wird der Modus für die Entität aktiviert.
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert überschreibt den allgemein eingestellten Wert und gilt nur für den Farbwahl-Modus dieser Light Entität.
Gültige Werte 1 - 100
Unter "devices - climates" werden alle Climate-Entitäten angegeben.
Code:
shys_m5_dial:
...
devices:
climates:
- entity: climate.my_climate1
name: Heater
entity
Angabe der Light-Entity-ID aus Home Assistant, die gesteuert werden soll.
name
Der auf dem Display angezeigte Name der Entität.
Mit Hilfe des Temp-Mode lässt sich die Temperatur der Climate-Entität regeln.
Die Temperatur lässt sich sowohl über den Drehregler als auch per Touch steuern.
Ein Druck auf den Button schalten die Heizung an/aus.
Code:
shys_m5_dial:
...
devices:
climates:
- entity: climate.my_climate1
name: Heater
modes:
temp_mode:
rotary_step_width: 1
min_temperature: 4
max_temperature: 30
rotary_step_width (optional) Default: 1
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Bei Climates gilt die 1 als Default, egal was als allgemeiner Standard in der Component eingestellt wurde.
Gültige Werte 1 - 100
min_temperature (optional) Default: 4
Legt die minimale Temperatur fest, die am Dial für diese Climate-Entität eingestellt werden kann.
max_temperature (optional) Default: 30
Legt die maximale Temperatur fest, die am Dial für diese Climate-Entität eingestellt werden kann.
Unter "devices - cover" werden alle Cover-Entitäten angegeben.
Code:
shys_m5_dial:
...
devices:
covers:
- entity: cover.my_cover1
name: Cover 1
entity
Angabe der Light-Entity-ID aus Home Assistant, die gesteuert werden soll.
name
Der auf dem Display angezeigte Name der Entität.
Mit Hilfe des Position-Mode lässt sich die Position der Cover-Entität steuern.
Die Position lässt sich sowohl über den Drehregler als auch per Touch steuern.
Code:
shys_m5_dial:
...
devices:
covers:
- entity: cover.my_cover1
name: Cover 1
modes:
position_mode:
rotary_step_width: 5
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert überschreibt den allgemein eingestellten Wert und gilt nur für den Position-Modus dieser Cover-Entität.
Gültige Werte 1 - 100
Unter "devices - cover" werden alle Fan-Entitäten angegeben.
Code:
shys_m5_dial:
...
devices:
fans:
- entity: fan.my_fan1
name: Fan 1
entity
Angabe der Fan-Entity-ID aus Home Assistant, die gesteuert werden soll.
name
Der auf dem Display angezeigte Name des Ventilators.
Mit Hilfe des Speed-Mode lässt sich die Geschwindigkeit der Fan-Entität steuern.
Die Geschwindigkeit lässt sich sowohl über den Drehregler als auch per Touch steuern.
Ein Druck auf den Button schalten den Ventilator an/aus.
Code:
shys_m5_dial:
...
devices:
fans:
- entity: fan.my_fan1
name: Fan 1
modes:
speed_mode:
changeable_direction: true
rotary_step_width: 10
changeable_direction (optional) (Default: false)
Gibt an, ob der Ventilator zwei Laufrichtungen hat und somit zwischen vorwärts und rückwärts umgestellt werden kann.
False = Nur eine Laufrichtung. Drehen nach rechts erhöht die Geschwindigkeit, Drehen nach links reduziert die Geschwindigkeit.
True = Zwei Laufrichtungen. Drehen nach rechts erhöht für Vorwärts die Geschwindigkeit. Drehen nach links reduziert die Geschwindigkeit für Vorwärts.
Man kann allerdings jetzt über 0 hinweg drehen und somit die Drehrichtung zu ändern.
Läuft der Lüfter rückwärts, erhöht links drehen die Geschwindigkeit und rechts drehen reduziert diese
Gültige Werte true / false
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert überschreibt den allgemein eingestellten Wert und gilt nur für den Speed-Modus dieser Ventilator-Entität.
Gültige Werte 1 - 100
Unter "devices - media_player" werden alle MediaPlayer-Entitäten angegeben.
Code:
shys_m5_dial:
...
devices:
media_player:
- entity: media_player.my_player1
name: MediaPlayer 1
entity
Angabe der MediaPlayer-Entity-ID aus Home Assistant, die gesteuert werden soll.
name
Der auf dem Display angezeigte Name des MediaPlayers.
Mit Hilfe des Play-Mode lässt sich über den Drehregler die Lautstärke regeln, so wie per Touch die Wiedergabe starten/pausieren oder zum nächsten bzw. vorherigen Lied wechseln.
Ein Druck auf den Button wechselt zwischen Play und Pause.
Code:
shys_m5_dial:
...
devices:
media_player:
- entity: media_player.my_player1
name: MediaPlayer 1
modes:
play_mode:
rotary_step_width: 10
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Der hier eingestellte Wert überschreibt den allgemein eingestellten Wert und gilt nur für den Play-Modus dieser MediaPlayer-Entität.
Gültige Werte 1 - 100
Mit Hilfe des Source-Mode lässt sich über den Drehregler eine Quelle aus den hinterlegten "Sources" auswählen, die abgespielt werden soll.
Ein Druck auf den Button startet die Wiedergabe der ausgewählten Quelle.
Code:
shys_m5_dial:
...
devices:
media_player:
- entity: media_player.my_player1
name: MediaPlayer 1
modes:
play_mode:
rotary_step_width: 10
source_mode:
rotary_step_width: 1
sources:
- name: 1Live
content_id: 1Live
content_type: TUNEIN
- name: WDR2
content_id: "http://wdr-wdr2-bergischesland.icecast.wdr.de/wdr/wdr2/bergischesland/mp3/128/stream.mp3"
content_type: custom
rotary_step_width (optional) (Default: 1)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Bei source_mode von media_player gilt die 1 als Default, egal was als allgemeiner Standard in der Component eingestellt wurde.
Gültige Werte 1 - 100
sources (optional)
Eine Liste von Audio-Quellen, die zum Abspielen zur Auswahl stehen sollen.
Die Einträge müssen immer die Attribute "name", "content_id" und "content_type" enthalten!
Beispiele für Amazon Echo (Alexa):
- name: 1Live
content_id: 1Live
content_type: TUNEIN
- name: Metallica
content_id: metallica
content_type: AMAZON_MUSIC
- name: Nothing else matters
content_id: play metallica nothing else matters
content_type: custom
Beispiel für DLNA Player:
- name: 1Live
content_id: "https://wdr-1live-live.icecastssl.wdr.de/wdr/1live/live/mp3/128/stream.mp3"
content_type: custom
Unter "devices - lock" werden alle Fan-Entitäten angegeben.
Code:
shys_m5_dial:
...
devices:
lock:
- entity: lock.my_lock1
name: Lock 1
entity
Angabe der Lock-Entity-ID aus Home Assistant, die gesteuert werden soll.
name
Der auf dem Display angezeigte Name des Schlosses.
Mit Hilfe des Lock-Mode lässt sich der Zustand der Lock-Entität steuern.
Das Schloss lässt sich über den Drehregler aufschließen, abschließen und öffnen.
Ein Druck auf den Button schließt normalerweise das Schloss je nach aktuellem Zustand auf oder ab.
Ist open_on_button allerdings auf true gesetzt, wird das Schloss wenn es abgeschlossen ist bei Druck auf den Button nicht aufgeschlossen, sondern geöffnet.
Code:
shys_m5_dial:
...
devices:
lock:
- entity: lock.my_lock1
name: Lock 1
modes:
lock_mode:
open_on_button: true
rotary_step_width: 10
open_on_button (optional) (Default: false)
Durch setzen auf true, öffnet ein Druck auf den Button das Schloss direkt, anstatt nur das Schloss aufzuschließen.
Steht der Parameter auf false (oder wird nicht angegeben), wird das Schloss nur aufgeschlossen, aber nicht ganz geöffnet.
Gültige Werte true / false
rotary_step_width (optional)
Gibt die allgemeine Schrittweite an, um die der Wert bei Verwendung des Drehreglers pro Schritt verändert wird.
Bei lock_mode von lock gilt die 1 als Default, egal was als allgemeiner Standard in der Component eingestellt wurde.
Wird hier eine Schrittweite von 2 angegeben, lässt sich durch drehen das Schloss nicht mehr nur aufschließen, sondern wird automatisch direkt geöffnet.
Gültige Werte 1 - 2
Die folgenden Attribute sind zwar vorhanden, sollten aber eigentlich nicht geändert werden müssen.
send_value_delay
Gibt die Verzögerung in Millisekunden an, die bei Wertänderung gewartet wird, bevor die Änderung an Home Assistant übertragen wird.
Das ist gerade bei Verwendung des Rotary-Encoders wichtig um nicht unnötig viele API-Aufrufe zu erzeugen. (Default: 1200)
send_value_lock
Gibt an, wie lange nach einem API-Aufruf gewartet werden soll, bevor der nächste API Aufruf erfolgen darf. (Default: 3000)