265 lines
9.8 KiB
YAML
265 lines
9.8 KiB
YAML
##########################################################################################
|
|
##########################################################################################
|
|
# BEDROOM 2 FAN SWITCH
|
|
#
|
|
# Controlled by a Zemismart KS-811 Triple push button
|
|
# pinout/schematic https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
|
#
|
|
# V1.0 - 2025-07-23 First Setup (and replacement of Tasmota)
|
|
#
|
|
# NOTES
|
|
# - Switch for Ceiling Fan
|
|
# - 3 Switches, Up, Down and Off
|
|
# - Remote commands to the fan ${mqtt_remote_command_full_topic}/speed/set 1,2,3,0,+,-
|
|
#
|
|
##########################################################################################
|
|
##########################################################################################
|
|
|
|
##########################################################################################
|
|
# 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-bedrm2fanswitch"
|
|
friendly_name: "Bedroom 2 Fan Wall Switch (3)"
|
|
description_comment: "Switch for Bedroom 2 Ceiling Fan using Zemismart KS-811 Triple Push Button. Speed Up (1), Speed Down (2), Fan Off (3)"
|
|
device_area: "Bedroom 2" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811-3 (Triple)" # Project Details
|
|
project_version: "v1" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
|
|
|
entity_prefix: "Main Bathroom" # Simple device name where we want to prefix a sensor or switch, eg "Load" Current.
|
|
|
|
# Passwords
|
|
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-bedrm2fanswitch_ip
|
|
mqtt_command_main_topic: !secret mqtt_command_main_topic
|
|
mqtt_status_main_topic: !secret mqtt_status_main_topic
|
|
|
|
# Device Settings
|
|
#relay_icon: "mdi:heating-coil"
|
|
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: "bedroom2-ceilingfan-switch"
|
|
#mqtt_local_command_topic: "${mqtt_local_command_main_topic}/${mqtt_device_name}" # Topic we will use to command this locally without HA
|
|
#mqtt_local_status_topic: "${mqtt_local_status_main_topic}/${mqtt_device_name}" # Topic we will use to view status locally without HA
|
|
|
|
# MQTT REMOTE Controls
|
|
mqtt_remote_device_name: "bedroom2-ceilingfan"
|
|
mqtt_remote_device_command_topic: "${mqtt_command_main_topic}/${mqtt_remote_device_name}/speed/set"
|
|
mqtt_remote_device_command1: "+"
|
|
mqtt_remote_device_command2: "-"
|
|
mqtt_remote_device_command3: "0"
|
|
mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_remote_device_name}/speed/state" # Topic we will use to view status locally without HA
|
|
|
|
# Button Naming & Icons
|
|
|
|
# Switch/Relay Naming & Icons
|
|
#relay_icon: "mdi:heating-coil"
|
|
switch_1_name: "Fan Speed Up" # This is virtual only, no power connected to 1st relay
|
|
switch_2_name: "Fan Speed Down" # This is virtual only, no power connected to 2nd relay
|
|
switch_3_name: "Fan Off" # This is virtual only, no power connected to 3rd relay
|
|
|
|
##########################################################################################
|
|
# PACKAGES: Included Common Packages
|
|
# https://esphome.io/components/packages.html
|
|
##########################################################################################
|
|
packages:
|
|
common_wifi: !include
|
|
file: common/network_common.yaml
|
|
vars:
|
|
local_device_name: "${device_name}"
|
|
local_static_ip_address: "${static_ip_address}"
|
|
local_ota_pass: "${ota_pass}"
|
|
common_api: !include
|
|
file: common/api_common.yaml
|
|
vars:
|
|
local_api_key: "${api_key}"
|
|
#common_webportal: !include
|
|
# file: common/webportal_common.yaml
|
|
common_mqtt: !include
|
|
file: common/mqtt_common.yaml
|
|
vars:
|
|
local_device_name: "${device_name}"
|
|
common_sntp: !include
|
|
file: common/sntp_common.yaml
|
|
common_general_sensors: !include
|
|
file: common/sensors_common.yaml
|
|
vars:
|
|
local_friendly_name: "${friendly_name}"
|
|
local_update_interval: "${update_interval}"
|
|
|
|
##########################################################################################
|
|
# 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}"
|
|
platformio_options:
|
|
build_flags:
|
|
- "-Os" # optimize for size
|
|
- "-Wl,--gc-sections" # drop unused code/data
|
|
- "-fno-exceptions" # strip C++ exceptions
|
|
- "-fno-rtti" # strip C++ RTTI
|
|
# on_boot:
|
|
# priority: 200
|
|
# then:
|
|
# - switch.turn_on: Relay_3
|
|
|
|
##########################################################################################
|
|
# ESP Platform and Framework
|
|
# https://esphome.io/components/esp32.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
|
|
|
|
##########################################################################################
|
|
# ESPHome Logging Enable
|
|
# 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 for KS-811 is GPIO02
|
|
##########################################################################################
|
|
status_led:
|
|
pin:
|
|
number: GPIO02
|
|
inverted: yes
|
|
|
|
##########################################################################################
|
|
# BINARY SENSORS
|
|
# https://esphome.io/components/binary_sensor/
|
|
##########################################################################################
|
|
# Buttons for KS-811-3 are GPIO16, GPIO05, GPIO04
|
|
##########################################################################################
|
|
binary_sensor:
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO16
|
|
mode: INPUT
|
|
inverted: True
|
|
name: "Button 1: ${switch_1_name}"
|
|
on_press:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device_command_topic}"
|
|
payload: "${mqtt_remote_device_command1}"
|
|
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO05
|
|
mode: INPUT
|
|
inverted: True
|
|
name: "Button 2: ${switch_2_name}"
|
|
on_press:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device_command_topic}"
|
|
payload: "${mqtt_remote_device_command2}"
|
|
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO4
|
|
mode: INPUT
|
|
inverted: True
|
|
name: "Button 3: ${switch_3_name}"
|
|
on_press:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device_command_topic}"
|
|
payload: "${mqtt_remote_device_command3}"
|
|
|
|
##########################################################################################
|
|
# SWITCH COMPONENT
|
|
# https://esphome.io/components/switch/
|
|
##########################################################################################
|
|
# Relays for KS-811-3 are GPIO13, GPIO12, GPIO14
|
|
##########################################################################################
|
|
switch:
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: GPIO13
|
|
id: Relay_1
|
|
- platform: gpio
|
|
name: "Relay 2: ${switch_2_name}"
|
|
pin: GPIO12
|
|
id: Relay_2
|
|
- platform: gpio
|
|
name: "Relay 3: ${switch_3_name}"
|
|
pin: GPIO14
|
|
id: Relay_3
|
|
|
|
mqtt:
|
|
on_message:
|
|
- topic: "${mqtt_local_status_topic}"
|
|
then:
|
|
- lambda: |-
|
|
int val = atoi(x.c_str());
|
|
ESP_LOGI("fan_switch", "Received requested speed: %d", val);
|
|
|
|
// Desired states
|
|
bool r1 = false;
|
|
bool r2 = false;
|
|
bool r3 = false;
|
|
|
|
switch (val) {
|
|
case 1:
|
|
r3 = true;
|
|
break;
|
|
case 2:
|
|
r2 = true;
|
|
r3 = true;
|
|
break;
|
|
case 3:
|
|
r1 = true;
|
|
r2 = true;
|
|
r3 = true;
|
|
break;
|
|
case 0:
|
|
default:
|
|
// all remain false
|
|
break;
|
|
}
|
|
|
|
// Only change relays if necessary
|
|
if (id(Relay_1).state != r1) {
|
|
if (r1) {
|
|
id(Relay_1).turn_on();
|
|
} else {
|
|
id(Relay_1).turn_off();
|
|
}
|
|
}
|
|
|
|
if (id(Relay_2).state != r2) {
|
|
if (r2) {
|
|
id(Relay_2).turn_on();
|
|
} else {
|
|
id(Relay_2).turn_off();
|
|
}
|
|
}
|
|
|
|
if (id(Relay_3).state != r3) {
|
|
if (r3) {
|
|
id(Relay_3).turn_on();
|
|
} else {
|
|
id(Relay_3).turn_off();
|
|
}
|
|
} |