various tidyups
This commit is contained in:
@@ -1,507 +0,0 @@
|
||||
#:########################################################################################:#
|
||||
# TITLE: LOUNGE MIDDLE LIGHTSWITCH
|
||||
# zorruno.com layout v1.1 2026
|
||||
#:########################################################################################:#
|
||||
# REPO:
|
||||
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-loungemiddleswitch.yaml
|
||||
#:########################################################################################:#
|
||||
# VERSIONS:
|
||||
# V3.6 2026-03-11 Updated yaml to zorruno layout V1.1
|
||||
# V3.5 2025-07-28 YAML tidyups
|
||||
#:########################################################################################:#
|
||||
# HARDWARE:
|
||||
# - Zemismart KS-811 Triple push button
|
||||
# - ESP8266 based
|
||||
# - pinout/schematic:
|
||||
# https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
||||
# - Relay 1 output on GPIO13
|
||||
# - Relay 2 output on GPIO12
|
||||
# - Relay 3 output on GPIO14
|
||||
# - Button 1 input on GPIO16
|
||||
# - Button 2 input on GPIO5
|
||||
# - Button 3 input on GPIO4
|
||||
# - Status LED on GPIO2
|
||||
#:########################################################################################:#
|
||||
# OPERATION NOTES:
|
||||
# - Button 1:
|
||||
# - Online with HA Loss manual override ON and HA Loss Test OFF:
|
||||
# - Uses Home Assistant last-scene logic
|
||||
# - If last scene is not "All Off", set "All Off"
|
||||
# - If last scene is "All Off", set "Bright"
|
||||
# - Offline/test with HA Loss manual override ON:
|
||||
# - Toggles Relay_1 locally
|
||||
# - Button 2:
|
||||
# - Online with HA Loss manual override ON and HA Loss Test OFF:
|
||||
# - Sets Home Assistant scene "Movie"
|
||||
# - Offline/test with HA Loss manual override ON:
|
||||
# - Toggles Relay_2 locally
|
||||
# - Button 3:
|
||||
# - Online with HA Loss manual override ON and HA Loss Test OFF:
|
||||
# - Sets Home Assistant scene "Reading On/Off"
|
||||
# - Offline/test with HA Loss manual override ON:
|
||||
# - Toggles Relay_3 locally
|
||||
# - On API connect:
|
||||
# - If HA Loss Test is OFF, Relay_1 and Relay_2 follow HA Loss manual override state
|
||||
# - If HA Loss Test is ON, relay override is not applied
|
||||
# - HA Loss manual override defaults ON and persists across restarts
|
||||
# - HA Loss Test defaults OFF and can force offline/test behaviour even when HA is connected
|
||||
#:########################################################################################:#
|
||||
# OFFLINE NOTES:
|
||||
# a) Home Assistant offline (network online):
|
||||
# - Device switches to manual/offline behaviour
|
||||
# - Buttons still operate local relays if HA Loss manual override is ON
|
||||
# - Home Assistant scene calls are unavailable
|
||||
# b) MQTT offline (or HA/MQTT offline):
|
||||
# - This yaml does not depend on MQTT for its button logic
|
||||
# - If Home Assistant/API is offline, device falls back to manual/offline behaviour
|
||||
# - Buttons still operate local relays if HA Loss manual override is ON
|
||||
# c) Entire WiFi/Network offline:
|
||||
# - Device operates in local manual/offline behaviour only
|
||||
# - Buttons still operate local relays if HA Loss manual override is ON
|
||||
# - Accurate time is not needed; SNTP is not required for operation
|
||||
#:########################################################################################:#
|
||||
|
||||
#:########################################################################################:#
|
||||
# SUBSTITUTIONS:
|
||||
# Specific device variable substitutions
|
||||
# If NOT using a secrets file, just replace these with the passwords etc (in quotes)
|
||||
#:########################################################################################:#
|
||||
substitutions:
|
||||
# Device Naming
|
||||
device_name: "esp-loungemiddleswitch"
|
||||
friendly_name: "Lounge Middle Lightswitch (3)"
|
||||
description_comment: "Lounge Main Lightswitch using a Zemismart KS-811 Triple Push Button. Downlights South (1), Downlights Middle (2), Downlights North (3) (Layout V1.1)"
|
||||
device_area: "Lounge" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
|
||||
# Project Naming
|
||||
project_name: "Zemismart Technologies.KS-811 Triple" # Project Details
|
||||
project_version: "v3.6" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
|
||||
# Passwords & Secrets
|
||||
api_key: !secret esp-api_key # unfortunately you can't use substitutions inside secrets names
|
||||
ota_pass: !secret esp-ota_pass # unfortunately you can't use substitutions inside secrets names
|
||||
static_ip_address: !secret esp-loungemiddleswitch_ip
|
||||
|
||||
# If we are changing IP addresses, you must update the current IP address here, otherwise it remains
|
||||
# Don't forget to switch it back when changed.
|
||||
current_ip_address: ${static_ip_address}
|
||||
|
||||
# Device Settings
|
||||
log_level: "INFO" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # update time for for general sensors etc
|
||||
|
||||
# MQTT LOCAL Controls
|
||||
#mqtt_device_name: "lounge-main-lights"
|
||||
#mqtt_local_command_topic: "${mqtt_command_main_topic}/${mqtt_device_name}" # Topic we will use to command this locally without HA
|
||||
#mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_device_name}" # Topic we will use to view status locally without HA
|
||||
|
||||
# MQTT REMOTE Controls
|
||||
|
||||
# Switch/Relay/Button Naming & Icons
|
||||
#relay_icon: "mdi:lightbulb-group"
|
||||
switch_1_name: "Downlights South" # Lights are connected via DMX dimmer (another esphome controller) (4 Downlights)
|
||||
switch_2_name: "Downlights Middle" # Lights are connected via DMX dimmer (another esphome controller) (6 Downlights)
|
||||
switch_3_name: "Downlights North" # Lights are directly connected (2 downlights)
|
||||
|
||||
#:########################################################################################:#
|
||||
# PACKAGES:
|
||||
# Included Common Packages
|
||||
# https://esphome.io/components/packages.html
|
||||
#:########################################################################################:#
|
||||
packages:
|
||||
#### WIFI, Network (Static/DHCP/IPV6 etc), Fallback AP, Safemode ####
|
||||
common_wifi: !include
|
||||
file: common/network_common.yaml
|
||||
vars:
|
||||
local_device_name: "${device_name}"
|
||||
local_static_ip_address: "${static_ip_address}"
|
||||
local_current_ip_address: "${current_ip_address}"
|
||||
local_ota_pass: "${ota_pass}"
|
||||
|
||||
#### HOME ASSISTANT API (choose encryption or no encryption options) ####
|
||||
common_api: !include
|
||||
file: common/api_common.yaml
|
||||
#file: common/api_common_noencryption.yaml
|
||||
vars:
|
||||
local_api_key: "${api_key}"
|
||||
|
||||
#### MQTT ####
|
||||
common_mqtt: !include
|
||||
file: common/mqtt_common.yaml
|
||||
vars:
|
||||
local_device_name: "${device_name}"
|
||||
|
||||
#### WEB PORTAL ####
|
||||
#common_webportal: !include common/webportal_common.yaml
|
||||
|
||||
#### SNTP (Only use if you want/need accurate timeclocks) ####
|
||||
#common_sntp: !include common/sntp_common.yaml
|
||||
|
||||
#### DIAGNOSTICS Sensors ####
|
||||
diag_basic: !include common/include_basic_diag_sensors.yaml
|
||||
diag_more: !include common/include_more_diag_sensors.yaml
|
||||
#diag_debug: !include common/include_debug_diag_sensors.yaml
|
||||
#diag_resetcount: !include common/include_resetcount_diag_sensors.yaml
|
||||
|
||||
#:########################################################################################:#
|
||||
# ESPHOME:
|
||||
# https://esphome.io/components/esphome.html
|
||||
#:########################################################################################:#
|
||||
esphome:
|
||||
name: "${device_name}"
|
||||
friendly_name: "${friendly_name}"
|
||||
comment: "${description_comment}" # Appears on the esphome page in HA
|
||||
area: "${device_area}"
|
||||
project:
|
||||
name: "${project_name}"
|
||||
version: "${project_version}"
|
||||
|
||||
#:########################################################################################:#
|
||||
# HOME ASSISTANT API:
|
||||
#:########################################################################################:#
|
||||
api:
|
||||
on_client_connected:
|
||||
then:
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "API connected: override=%s, ha_loss_test=%s"
|
||||
args:
|
||||
- 'id(ha_loss_override).state ? "true" : "false"'
|
||||
- 'id(ha_loss_test).state ? "true" : "false"'
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: ha_loss_test
|
||||
then:
|
||||
- logger.log:
|
||||
level: WARN
|
||||
format: "HA Loss Test is ON: not applying relay override on connect"
|
||||
else:
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: ha_loss_override
|
||||
then:
|
||||
- switch.turn_on: Relay_1
|
||||
- switch.turn_on: Relay_2
|
||||
else:
|
||||
- switch.turn_off: Relay_1
|
||||
- switch.turn_off: Relay_2
|
||||
|
||||
on_client_disconnected:
|
||||
then:
|
||||
- logger.log:
|
||||
level: WARN
|
||||
format: "API disconnected: switching to manual/offline behavior"
|
||||
|
||||
#:########################################################################################:#
|
||||
# ESP PLATFORM AND FRAMEWORK:
|
||||
# https://esphome.io/components/esp8266.html
|
||||
#:########################################################################################:#
|
||||
esp8266:
|
||||
board: esp01_1m
|
||||
early_pin_init: false # Initialise pins early to known values. Recommended false where switches are involved. Defaults to True.
|
||||
board_flash_mode: dout # Default is dout
|
||||
|
||||
#:########################################################################################:#
|
||||
# LOGGER:
|
||||
# https://esphome.io/components/logger.html
|
||||
#:########################################################################################:#
|
||||
logger:
|
||||
level: "${log_level}" # INFO Level suggested, or DEBUG for testing
|
||||
#baud_rate: 0 # set to 0 for no logging via UART, needed if you are using it for other serial things (eg PZEM)
|
||||
#esp8266_store_log_strings_in_flash: false
|
||||
#tx_buffer_size: 64
|
||||
|
||||
#:########################################################################################:#
|
||||
# STATUS LED:
|
||||
# https://esphome.io/components/status_led.html
|
||||
#:########################################################################################:#
|
||||
status_led:
|
||||
pin:
|
||||
number: GPIO2
|
||||
inverted: true
|
||||
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS:
|
||||
# https://esphome.io/components/binary_sensor/
|
||||
#:########################################################################################:#
|
||||
binary_sensor:
|
||||
# GPIO16 for KS-811 first button UNLESS
|
||||
# it is a single button KS-811 in which case it is GPIO00
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO16
|
||||
mode: INPUT
|
||||
inverted: true
|
||||
use_interrupt: false # This pin doesn't support interrupts so use polling. Only suppresses a warning.
|
||||
name: "Button 1: ${switch_1_name}"
|
||||
on_multi_click:
|
||||
# --- Single short click ---
|
||||
# Online (and override ON, and NOT test mode): use HA's last scene to decide.
|
||||
# Offline (override ON): toggle physical Relay_1
|
||||
# Test mode (override ON): behave like offline even if HA is connected
|
||||
- timing:
|
||||
- ON for at most 0.5s
|
||||
- OFF for at least 0.5s
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- switch.is_on: ha_loss_override
|
||||
- api.connected:
|
||||
- not:
|
||||
switch.is_on: ha_loss_test
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: |-
|
||||
// Defensive: treat empty/unknown as "not All Off" so we go to a safe "All Off".
|
||||
auto s = id(ha_last_scene).state;
|
||||
if (s.empty() || s == "unknown" || s == "unavailable") return true;
|
||||
return s != "All Off";
|
||||
then:
|
||||
- homeassistant.service:
|
||||
service: script.lounge_set_scene
|
||||
data:
|
||||
scene_name: "All Off"
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN1: Single click (online) -> Last scene was not 'All Off' -> Set 'All Off'"
|
||||
else:
|
||||
- homeassistant.service:
|
||||
service: script.lounge_set_scene
|
||||
data:
|
||||
scene_name: "Bright"
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN1: Single click (online) -> Last scene was 'All Off' -> Set 'Bright'"
|
||||
else:
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- switch.is_on: ha_loss_override
|
||||
- or:
|
||||
- not:
|
||||
api.connected:
|
||||
- switch.is_on: ha_loss_test
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: |-
|
||||
return id(Relay_1).state;
|
||||
then:
|
||||
- switch.turn_off: Relay_1
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN1: Single click (offline/test) -> Relay_1 OFF"
|
||||
else:
|
||||
- switch.turn_on: Relay_1
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN1: Single click (offline/test) -> Relay_1 ON"
|
||||
else:
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN1: Single click ignored (override OFF)"
|
||||
|
||||
# GPIO05 for second button (only for KS-811-2 Double or -3 Triple)
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO5
|
||||
mode: INPUT
|
||||
inverted: true
|
||||
name: "Button 2: ${switch_2_name}"
|
||||
on_multi_click:
|
||||
# --- Single short click ---
|
||||
# Online (override ON, NOT test mode): set scene
|
||||
# Offline/test (override ON): toggle Relay_2
|
||||
- timing:
|
||||
- ON for at most 0.5s
|
||||
- OFF for at least 0.5s
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- switch.is_on: ha_loss_override
|
||||
- api.connected:
|
||||
- not:
|
||||
switch.is_on: ha_loss_test
|
||||
then:
|
||||
- homeassistant.service:
|
||||
service: script.lounge_set_scene
|
||||
data:
|
||||
scene_name: "Movie"
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN2: Single click (online) -> Set 'Movie' Scene"
|
||||
else:
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- switch.is_on: ha_loss_override
|
||||
- or:
|
||||
- not:
|
||||
api.connected:
|
||||
- switch.is_on: ha_loss_test
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: |-
|
||||
return id(Relay_2).state;
|
||||
then:
|
||||
- switch.turn_off: Relay_2
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN2: Single click (offline/test) -> Relay_2 OFF"
|
||||
else:
|
||||
- switch.turn_on: Relay_2
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN2: Single click (offline/test) -> Relay_2 ON"
|
||||
else:
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN2: Single click ignored (override OFF)"
|
||||
|
||||
# GPIO04 for third button (only for KS-811-3 Triple)
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO4
|
||||
mode: INPUT
|
||||
inverted: true
|
||||
name: "Button 3: ${switch_3_name}"
|
||||
on_multi_click:
|
||||
# --- Single short click ---
|
||||
# Online (override ON, NOT test mode): set scene
|
||||
# Offline/test (override ON): toggle Relay_3
|
||||
- timing:
|
||||
- ON for at most 0.5s
|
||||
- OFF for at least 0.5s
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- switch.is_on: ha_loss_override
|
||||
- api.connected:
|
||||
- not:
|
||||
switch.is_on: ha_loss_test
|
||||
then:
|
||||
- homeassistant.service:
|
||||
service: script.lounge_set_scene
|
||||
data:
|
||||
scene_name: "Reading On/Off"
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN3: Single click (online) -> Set 'Reading On/Off' Scene"
|
||||
else:
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- switch.is_on: ha_loss_override
|
||||
- or:
|
||||
- not:
|
||||
api.connected:
|
||||
- switch.is_on: ha_loss_test
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: |-
|
||||
return id(Relay_3).state;
|
||||
then:
|
||||
- switch.turn_off: Relay_3
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN3: Single click (offline/test) -> Relay_3 OFF"
|
||||
else:
|
||||
- switch.turn_on: Relay_3
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN3: Single click (offline/test) -> Relay_3 ON"
|
||||
else:
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "BTN3: Single click ignored (override OFF)"
|
||||
|
||||
#:########################################################################################:#
|
||||
# TEXT SENSOR COMPONENT:
|
||||
# https://esphome.io/components/text_sensor/
|
||||
#:########################################################################################:#
|
||||
text_sensor:
|
||||
- platform: homeassistant
|
||||
id: ha_last_scene
|
||||
entity_id: input_text.lounge_last_scene
|
||||
on_value:
|
||||
- logger.log:
|
||||
level: DEBUG
|
||||
format: "HA last scene now: %s"
|
||||
args: ["x.c_str()"]
|
||||
|
||||
#:########################################################################################:#
|
||||
# SWITCH COMPONENT:
|
||||
# https://esphome.io/components/switch/
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
# GPIO13 for KS-811 first button UNLESS it is KS-811-1 then it is GPIO12
|
||||
- platform: gpio
|
||||
name: "Relay 1: ${switch_1_name}"
|
||||
pin: GPIO13
|
||||
id: Relay_1
|
||||
restore_mode: RESTORE_DEFAULT_ON
|
||||
|
||||
# GPIO12 for second relay (only for KS-811-2 Double or -3 Triple)
|
||||
- platform: gpio
|
||||
name: "Relay 2: ${switch_2_name}"
|
||||
pin: GPIO12
|
||||
id: Relay_2
|
||||
restore_mode: RESTORE_DEFAULT_ON
|
||||
|
||||
# GPIO14 for third relay (only for KS-811-3 Triple)
|
||||
- platform: gpio
|
||||
name: "Relay 3: ${switch_3_name}"
|
||||
pin: GPIO14
|
||||
id: Relay_3
|
||||
|
||||
# HA Loss manual override (default ON; persists across restarts)
|
||||
- platform: template
|
||||
name: "HA Loss manual override"
|
||||
id: ha_loss_override
|
||||
optimistic: true
|
||||
restore_mode: ALWAYS_ON
|
||||
|
||||
# HA Loss Test (default OFF): when ON, force "offline behavior" even if HA is connected
|
||||
- platform: template
|
||||
name: "HA Loss Test"
|
||||
id: ha_loss_test
|
||||
optimistic: true
|
||||
restore_mode: ALWAYS_OFF
|
||||
on_turn_on:
|
||||
- logger.log:
|
||||
level: WARN
|
||||
format: "HA Loss Test turned ON: forcing offline/test behavior for buttons"
|
||||
on_turn_off:
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "HA Loss Test turned OFF: forcing Relay_1 and Relay_2 ON, then restoring last scene in 30s"
|
||||
- switch.turn_on: Relay_1
|
||||
- switch.turn_on: Relay_2
|
||||
- delay: 30s
|
||||
- if:
|
||||
condition:
|
||||
and:
|
||||
- api.connected:
|
||||
- lambda: |-
|
||||
auto s = id(ha_last_scene).state;
|
||||
return !(s.empty() || s == "unknown" || s == "unavailable");
|
||||
then:
|
||||
- homeassistant.service:
|
||||
service: script.lounge_set_scene
|
||||
data:
|
||||
scene_name: !lambda |-
|
||||
return id(ha_last_scene).state;
|
||||
- logger.log:
|
||||
level: INFO
|
||||
format: "HA Loss Test OFF: restored last scene: %s"
|
||||
args: ['id(ha_last_scene).state.c_str()']
|
||||
else:
|
||||
- logger.log:
|
||||
level: WARN
|
||||
format: "HA Loss Test OFF: cannot restore scene (API not connected or last scene unknown)"
|
||||
@@ -1,477 +0,0 @@
|
||||
#############################################
|
||||
#############################################
|
||||
#
|
||||
# ESP Home
|
||||
# NFC Tag Reader for Home Assistant
|
||||
#
|
||||
#############################################
|
||||
#############################################
|
||||
# Project Link:
|
||||
# https://github.com/adonno/tagreader
|
||||
#############################################
|
||||
# Remember to set the switches on the PN532
|
||||
# for i2C, Switch1: On (up), Switch2: Off (down)
|
||||
#############################################
|
||||
|
||||
|
||||
#############################################
|
||||
# Substitution Text
|
||||
#############################################
|
||||
substitutions:
|
||||
name: esp-nfcaccess1-33ad74
|
||||
friendly_name: TagReader
|
||||
|
||||
#############################################
|
||||
# Inport the project from Github
|
||||
#############################################
|
||||
#dashboard_import:
|
||||
# package_import_url: github://adonno/tagreader/tagreader.yaml
|
||||
|
||||
#############################################
|
||||
# Use Wifi
|
||||
#############################################
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
# Details for fallback hotspot (captive portal)
|
||||
# in case wifi connection fails
|
||||
ap:
|
||||
ssid: "${name} Hotspot"
|
||||
password: !secret fallback_ap_password
|
||||
|
||||
#############################################
|
||||
# Improv
|
||||
# Use the open Improv standard for configuring Wi-Fi on the
|
||||
# device by using a serial connection to the device, eg. USB.
|
||||
#############################################
|
||||
improv_serial:
|
||||
|
||||
#############################################
|
||||
# Fallback captive portal
|
||||
# Enable the captive portal for inital WiFi setup
|
||||
#############################################
|
||||
captive_portal:
|
||||
|
||||
#############################################
|
||||
# Enable Over the Air Update Capability
|
||||
# Safe mode will detect boot loops
|
||||
#############################################
|
||||
ota:
|
||||
safe_mode: true # Avoid boot loops
|
||||
password: !secret esp-nfcaccess1-33ad74_ota_pass
|
||||
|
||||
#############################################
|
||||
# ESPHome Logging Enable
|
||||
#############################################
|
||||
logger:
|
||||
# baud_rate: 0 # Set baud rate to 0 if using the UART for soething else
|
||||
# level: VERY_VERBOSE
|
||||
# level: VERBOSE
|
||||
|
||||
#############################################
|
||||
# Web Portal for display and monitoring
|
||||
#############################################
|
||||
#web_server:
|
||||
# port: 80
|
||||
# auth:
|
||||
# username: !secret web_server_username
|
||||
# password: !secret web_server_password
|
||||
|
||||
########################################
|
||||
# Specific board for ESPHome device
|
||||
########################################
|
||||
esp8266:
|
||||
board: d1_mini
|
||||
|
||||
#############################################
|
||||
# ESPHome
|
||||
#############################################
|
||||
esphome:
|
||||
name: ${name}
|
||||
# Automatically add the mac address to the name
|
||||
# so you can use a single firmware for all devices
|
||||
name_add_mac_suffix: false
|
||||
# This will allow for (future) project identification,
|
||||
# configuration and updates.
|
||||
project:
|
||||
name: adonno.tag_reader
|
||||
version: "1.4"
|
||||
# If buzzer is enabled, notify on api connection success
|
||||
on_boot:
|
||||
priority: -10
|
||||
then:
|
||||
- wait_until:
|
||||
api.connected:
|
||||
- logger.log: API is connected!
|
||||
- rtttl.play: "success:d=24,o=5,b=100:c,g,b"
|
||||
- light.turn_on:
|
||||
id: activity_led
|
||||
brightness: 100%
|
||||
red: 0%
|
||||
green: 0%
|
||||
blue: 100%
|
||||
flash_length: 500ms
|
||||
- switch.turn_on: buzzer_enabled
|
||||
- switch.turn_on: led_enabled
|
||||
|
||||
|
||||
#############################################
|
||||
# Global variables
|
||||
#############################################
|
||||
globals:
|
||||
- id: source
|
||||
type: std::string
|
||||
- id: url
|
||||
type: std::string
|
||||
- id: info
|
||||
type: std::string
|
||||
|
||||
|
||||
#############################################
|
||||
#############################################
|
||||
# MAIN SENSORS
|
||||
#############################################
|
||||
#############################################
|
||||
|
||||
#############################################
|
||||
# Switches
|
||||
# Define switches to control LED and buzzer from HA
|
||||
#############################################
|
||||
switch:
|
||||
- platform: template
|
||||
name: "${friendly_name} Buzzer Enabled"
|
||||
id: buzzer_enabled
|
||||
icon: mdi:volume-high
|
||||
optimistic: true
|
||||
restore_state: true
|
||||
entity_category: config
|
||||
- platform: template
|
||||
name: "${friendly_name} LED enabled"
|
||||
id: led_enabled
|
||||
icon: mdi:alarm-light-outline
|
||||
optimistic: true
|
||||
restore_state: true
|
||||
entity_category: config
|
||||
|
||||
#############################################
|
||||
# Buttons
|
||||
# Define buttons for writing tags via HA
|
||||
#############################################
|
||||
button:
|
||||
- platform: template
|
||||
name: Write Tag Random
|
||||
id: write_tag_random
|
||||
# Optional variables:
|
||||
icon: "mdi:pencil-box"
|
||||
on_press:
|
||||
then:
|
||||
- light.turn_on:
|
||||
id: activity_led
|
||||
brightness: 100%
|
||||
red: 100%
|
||||
green: 0%
|
||||
blue: 100%
|
||||
- lambda: |-
|
||||
static const char alphanum[] = "0123456789abcdef";
|
||||
std::string uri = "https://www.home-assistant.io/tag/";
|
||||
for (int i = 0; i < 8; i++)
|
||||
uri += alphanum[random_uint32() % (sizeof(alphanum) - 1)];
|
||||
uri += "-";
|
||||
for (int j = 0; j < 3; j++) {
|
||||
for (int i = 0; i < 4; i++)
|
||||
uri += alphanum[random_uint32() % (sizeof(alphanum) - 1)];
|
||||
uri += "-";
|
||||
}
|
||||
for (int i = 0; i < 12; i++)
|
||||
uri += alphanum[random_uint32() % (sizeof(alphanum) - 1)];
|
||||
auto message = new nfc::NdefMessage();
|
||||
message->add_uri_record(uri);
|
||||
ESP_LOGD("tagreader", "Writing payload: %s", uri.c_str());
|
||||
id(pn532_board).write_mode(message);
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b"
|
||||
- wait_until:
|
||||
not:
|
||||
pn532.is_writing:
|
||||
- light.turn_off:
|
||||
id: activity_led
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b,b"
|
||||
|
||||
- platform: template
|
||||
name: Clean Tag
|
||||
id: clean_tag
|
||||
icon: "mdi:nfc-variant-off"
|
||||
on_press:
|
||||
then:
|
||||
- light.turn_on:
|
||||
id: activity_led
|
||||
brightness: 100%
|
||||
red: 100%
|
||||
green: 64.7%
|
||||
blue: 0%
|
||||
- lambda: 'id(pn532_board).clean_mode();'
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b"
|
||||
- wait_until:
|
||||
not:
|
||||
pn532.is_writing:
|
||||
- light.turn_off:
|
||||
id: activity_led
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b,b"
|
||||
|
||||
- platform: template
|
||||
name: Cancel writing
|
||||
id: cancel_writing
|
||||
icon: "mdi:pencil-off"
|
||||
on_press:
|
||||
then:
|
||||
- lambda: 'id(pn532_board).read_mode();'
|
||||
- light.turn_off:
|
||||
id: activity_led
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b,b"
|
||||
|
||||
- platform: restart
|
||||
name: "${friendly_name} Restart"
|
||||
entity_category: config
|
||||
|
||||
#############################################
|
||||
# HA API
|
||||
# Enable Home Assistant API
|
||||
#############################################
|
||||
api:
|
||||
encryption:
|
||||
key: "K2H5vBNv8NLegc3RmwTQVFV7ULtba2DWDOlABmXmGBM="
|
||||
services:
|
||||
- service: rfidreader_tag_ok
|
||||
then:
|
||||
- rtttl.play: "beep:d=16,o=5,b=100:b"
|
||||
- service: rfidreader_tag_ko
|
||||
then:
|
||||
- rtttl.play: "beep:d=8,o=5,b=100:b"
|
||||
- service: play_rtttl
|
||||
variables:
|
||||
song_str: string
|
||||
then:
|
||||
- rtttl.play: !lambda 'return song_str;'
|
||||
- service: write_tag_id
|
||||
variables:
|
||||
tag_id: string
|
||||
then:
|
||||
- light.turn_on:
|
||||
id: activity_led
|
||||
brightness: 100%
|
||||
red: 100%
|
||||
green: 0%
|
||||
blue: 0%
|
||||
- lambda: |-
|
||||
auto message = new nfc::NdefMessage();
|
||||
std::string uri = "https://www.home-assistant.io/tag/";
|
||||
uri += tag_id;
|
||||
message->add_uri_record(uri);
|
||||
id(pn532_board).write_mode(message);
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b"
|
||||
- wait_until:
|
||||
not:
|
||||
pn532.is_writing:
|
||||
- light.turn_off:
|
||||
id: activity_led
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b,b"
|
||||
- service: write_music_tag
|
||||
variables:
|
||||
music_url: string
|
||||
music_info: string
|
||||
then:
|
||||
- light.turn_on:
|
||||
id: activity_led
|
||||
brightness: 100%
|
||||
red: 100%
|
||||
green: 0%
|
||||
blue: 0%
|
||||
- lambda: |-
|
||||
auto message = new nfc::NdefMessage();
|
||||
std::string uri = "";
|
||||
std::string text = "";
|
||||
uri += music_url;
|
||||
text += music_info;
|
||||
if ( music_url != "" ) {
|
||||
message->add_uri_record(uri);
|
||||
}
|
||||
if ( music_info != "" ) {
|
||||
message->add_text_record(text);
|
||||
}
|
||||
id(pn532_board).write_mode(message);
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b"
|
||||
- wait_until:
|
||||
not:
|
||||
pn532.is_writing:
|
||||
- light.turn_off:
|
||||
id: activity_led
|
||||
- rtttl.play: "write:d=24,o=5,b=100:b,b"
|
||||
|
||||
#############################################
|
||||
# i2C bus
|
||||
#############################################
|
||||
i2c:
|
||||
scan: False
|
||||
frequency: 400kHz
|
||||
|
||||
#############################################
|
||||
# NFC Reader
|
||||
#############################################
|
||||
pn532_i2c:
|
||||
id: pn532_board
|
||||
on_tag:
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: led_enabled
|
||||
then:
|
||||
- light.turn_on:
|
||||
id: activity_led
|
||||
brightness: 100%
|
||||
red: 0%
|
||||
green: 100%
|
||||
blue: 0%
|
||||
flash_length: 500ms
|
||||
|
||||
- delay: 0.15s #to fix slow component
|
||||
|
||||
- lambda: |-
|
||||
id(source)="";
|
||||
id(url)="";
|
||||
id(info)="";
|
||||
if (tag.has_ndef_message()) {
|
||||
auto message = tag.get_ndef_message();
|
||||
auto records = message->get_records();
|
||||
for (auto &record : records) {
|
||||
std::string payload = record->get_payload();
|
||||
std::string type = record->get_type();
|
||||
size_t hass = payload.find("https://www.home-assistant.io/tag/");
|
||||
size_t applemusic = payload.find("https://music.apple.com");
|
||||
size_t spotify = payload.find("https://open.spotify.com");
|
||||
size_t sonos = payload.find("sonos-2://");
|
||||
|
||||
if (type == "U" and hass != std::string::npos ) {
|
||||
ESP_LOGD("tagreader", "Found Home Assistant tag NDEF");
|
||||
id(source)="hass";
|
||||
id(url)=payload;
|
||||
id(info)=payload.substr(hass + 34);
|
||||
}
|
||||
else if (type == "U" and applemusic != std::string::npos ) {
|
||||
ESP_LOGD("tagreader", "Found Apple Music tag NDEF");
|
||||
id(source)="amusic";
|
||||
id(url)=payload;
|
||||
}
|
||||
else if (type == "U" and spotify != std::string::npos ) {
|
||||
ESP_LOGD("tagreader", "Found Spotify tag NDEF");
|
||||
id(source)="spotify";
|
||||
id(url)=payload;
|
||||
}
|
||||
else if (type == "U" and sonos != std::string::npos ) {
|
||||
ESP_LOGD("tagreader", "Found Sonos app tag NDEF");
|
||||
id(source)="sonos";
|
||||
id(url)=payload;
|
||||
}
|
||||
else if (type == "T" ) {
|
||||
ESP_LOGD("tagreader", "Found music info tag NDEF");
|
||||
id(info)=payload;
|
||||
}
|
||||
else if ( id(source)=="" ) {
|
||||
id(source)="uid";
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
id(source)="uid";
|
||||
}
|
||||
|
||||
- if:
|
||||
condition:
|
||||
lambda: 'return ( id(source)=="uid" );'
|
||||
then:
|
||||
- homeassistant.tag_scanned: !lambda |-
|
||||
ESP_LOGD("tagreader", "No HA NDEF, using UID");
|
||||
return x;
|
||||
else:
|
||||
- if:
|
||||
condition:
|
||||
lambda: 'return ( id(source)=="hass" );'
|
||||
then:
|
||||
- homeassistant.tag_scanned: !lambda 'return id(info);'
|
||||
else:
|
||||
- homeassistant.event:
|
||||
event: esphome.music_tag
|
||||
data:
|
||||
reader: !lambda |-
|
||||
return App.get_name().c_str();
|
||||
source: !lambda |-
|
||||
return id(source);
|
||||
url: !lambda |-
|
||||
return id(url);
|
||||
info: !lambda |-
|
||||
return id(info);
|
||||
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: buzzer_enabled
|
||||
then:
|
||||
- rtttl.play: "success:d=24,o=5,b=100:c,g,b"
|
||||
on_tag_removed:
|
||||
then:
|
||||
- homeassistant.event:
|
||||
event: esphome.tag_removed
|
||||
|
||||
#############################################
|
||||
# OUTPUTS
|
||||
#############################################
|
||||
# Define the buzzer output
|
||||
output:
|
||||
- platform: esp8266_pwm
|
||||
pin: D7
|
||||
id: buzzer
|
||||
|
||||
#############################################
|
||||
# BINARY SENSORS
|
||||
#############################################
|
||||
binary_sensor:
|
||||
- platform: status
|
||||
name: "${friendly_name} Status"
|
||||
entity_category: diagnostic
|
||||
|
||||
#############################################
|
||||
# TEXT SENSORS
|
||||
#############################################
|
||||
text_sensor:
|
||||
- platform: version
|
||||
hide_timestamp: true
|
||||
name: "${friendly_name} ESPHome Version"
|
||||
entity_category: diagnostic
|
||||
- platform: wifi_info
|
||||
ip_address:
|
||||
name: "${friendly_name} IP Address"
|
||||
icon: mdi:wifi
|
||||
entity_category: diagnostic
|
||||
ssid:
|
||||
name: "${friendly_name} Connected SSID"
|
||||
icon: mdi:wifi-strength-2
|
||||
entity_category: diagnostic
|
||||
|
||||
#############################################
|
||||
# Ring Tone Text Transfer Language for melody
|
||||
#############################################
|
||||
# Define buzzer as output for RTTTL
|
||||
rtttl:
|
||||
output: buzzer
|
||||
|
||||
#############################################
|
||||
# LED
|
||||
#############################################
|
||||
# Configure LED
|
||||
light:
|
||||
- platform: neopixelbus
|
||||
variant: WS2812
|
||||
pin: D8
|
||||
num_leds: 1
|
||||
flash_transition_length: 500ms
|
||||
type: GRB
|
||||
id: activity_led
|
||||
name: "${friendly_name} LED"
|
||||
restore_mode: ALWAYS_OFF
|
||||
@@ -1,136 +0,0 @@
|
||||
substitutions:
|
||||
name: m5stack-atom-echo-80be58
|
||||
friendly_name: M5Stack Atom Echo 80be58
|
||||
|
||||
esphome:
|
||||
name: "${name}"
|
||||
friendly_name: "${friendly_name}"
|
||||
name_add_mac_suffix: false
|
||||
project:
|
||||
name: m5stack.atom-echo-voice-assistant
|
||||
version: "1.0"
|
||||
min_version: 2023.5.0
|
||||
|
||||
api:
|
||||
encryption:
|
||||
key: XmXtlYVEuioSNapvz8G/9caKCI0T7aRW/CFy/f83D6g=
|
||||
|
||||
esp32:
|
||||
board: m5stack-atom
|
||||
framework:
|
||||
type: esp-idf
|
||||
|
||||
logger:
|
||||
ota:
|
||||
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
|
||||
|
||||
dashboard_import:
|
||||
package_import_url: github://esphome/firmware/voice-assistant/m5stack-atom-echo.yaml@main
|
||||
|
||||
improv_serial:
|
||||
|
||||
i2s_audio:
|
||||
i2s_lrclk_pin: GPIO33
|
||||
i2s_bclk_pin: GPIO19
|
||||
|
||||
microphone:
|
||||
- platform: i2s_audio
|
||||
id: echo_microphone
|
||||
i2s_din_pin: GPIO23
|
||||
adc_type: external
|
||||
pdm: true
|
||||
|
||||
speaker:
|
||||
- platform: i2s_audio
|
||||
id: echo_speaker
|
||||
i2s_dout_pin: GPIO22
|
||||
dac_type: external
|
||||
mode: mono
|
||||
|
||||
voice_assistant:
|
||||
microphone: echo_microphone
|
||||
speaker: echo_speaker
|
||||
on_start:
|
||||
- light.turn_on:
|
||||
id: led
|
||||
blue: 100%
|
||||
red: 0%
|
||||
green: 0%
|
||||
effect: none
|
||||
on_tts_start:
|
||||
- light.turn_on:
|
||||
id: led
|
||||
blue: 0%
|
||||
red: 0%
|
||||
green: 100%
|
||||
effect: none
|
||||
on_tts_end:
|
||||
- light.turn_on:
|
||||
id: led
|
||||
blue: 0%
|
||||
red: 0%
|
||||
green: 100%
|
||||
effect: pulse
|
||||
on_end:
|
||||
- delay: 1s
|
||||
- wait_until:
|
||||
not:
|
||||
speaker.is_playing:
|
||||
- light.turn_off: led
|
||||
on_error:
|
||||
- light.turn_on:
|
||||
id: led
|
||||
blue: 0%
|
||||
red: 100%
|
||||
green: 0%
|
||||
effect: none
|
||||
- delay: 1s
|
||||
- light.turn_off: led
|
||||
|
||||
|
||||
binary_sensor:
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO39
|
||||
inverted: true
|
||||
name: Button
|
||||
disabled_by_default: true
|
||||
entity_category: diagnostic
|
||||
id: echo_button
|
||||
on_multi_click:
|
||||
- timing:
|
||||
- ON FOR AT LEAST 350ms
|
||||
then:
|
||||
- voice_assistant.start:
|
||||
- timing:
|
||||
- ON FOR AT LEAST 350ms
|
||||
- OFF FOR AT LEAST 10ms
|
||||
then:
|
||||
- light.turn_on:
|
||||
id: led
|
||||
blue: 100%
|
||||
red: 0%
|
||||
green: 0%
|
||||
effect: pulse
|
||||
- voice_assistant.stop:
|
||||
|
||||
light:
|
||||
- platform: esp32_rmt_led_strip
|
||||
id: led
|
||||
name: None
|
||||
disabled_by_default: true
|
||||
entity_category: config
|
||||
pin: GPIO27
|
||||
default_transition_length: 0s
|
||||
chipset: SK6812
|
||||
num_leds: 1
|
||||
rgb_order: grb
|
||||
rmt_channel: 0
|
||||
effects:
|
||||
- pulse:
|
||||
transition_length: 250ms
|
||||
update_interval: 250ms
|
||||
@@ -1,17 +0,0 @@
|
||||
substitutions:
|
||||
name: m5stack-atom-echo-82d244
|
||||
friendly_name: M5Stack Atom Echo 82d244
|
||||
packages:
|
||||
m5stack.atom-echo-voice-assistant: github://esphome/firmware/voice-assistant/m5stack-atom-echo.yaml@main
|
||||
esphome:
|
||||
name: ${name}
|
||||
name_add_mac_suffix: false
|
||||
friendly_name: ${friendly_name}
|
||||
api:
|
||||
encryption:
|
||||
key: Oh2XL+cpsK1jjTO8lW31IZ6CQiQNdqCpUgCZpoe4eYI=
|
||||
|
||||
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
Reference in New Issue
Block a user