root
445 lines
16 KiB
YAML
445 lines
16 KiB
YAML
##########################################################################################
|
||
##########################################################################################
|
||
# CEILING FAN - BEDROOM 2
|
||
# - 3 speed fan using Sonoff IFan02
|
||
# - Also, single Light Output
|
||
#
|
||
# Controlled by a Sonoff IFan 02
|
||
#
|
||
# V1.0 - 2025-07-21 First Setup (and replacement of Tasmota)
|
||
#
|
||
# NOTES:
|
||
# Command the fan with MQTT
|
||
# ${mqtt_local_command_full_topic}/speed/set 1,2,3,0,+,-
|
||
# ${mqtt_local_command_full_topic}/light/set ON,OFF
|
||
# Status of the fan is in MQTT
|
||
# ${mqtt_local_command_full_topic}/speed/state 1,2,3,0
|
||
# ${mqtt_local_command_full_topic}/light/state ON,OFF
|
||
#
|
||
##########################################################################################
|
||
##########################################################################################
|
||
|
||
##########################################################################################
|
||
# 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-bedrm2ceilingfan"
|
||
friendly_name: "Bedroom 2 Ceiling Fan"
|
||
description_comment: "3 Speed Overhead Ceiling Fan Bedroom 2 :: Sonoff ifan02"
|
||
device_area: "Bedroom 2" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||
|
||
# Project Naming
|
||
project_name: "Sonoff Technologies.Sonoff ifan02" # Project Details
|
||
project_version: "v1.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||
|
||
# Passwords & Secrets
|
||
api_key: !secret esp-api_key
|
||
ota_pass: !secret esp-ota_pass
|
||
static_ip_address: !secret esp-bedrm2ceilingfan_ip # unfortunately you can't use substitutions inside secrets names
|
||
mqtt_local_command_main_topic: !secret mqtt_command_main_topic
|
||
mqtt_local_status_main_topic: !secret mqtt_status_main_topic
|
||
|
||
# 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: "bedroom2-ceilingfan"
|
||
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
|
||
|
||
# Button Naming & Icons
|
||
|
||
# Switch/Relay Naming & Icons
|
||
#relay_icon: "mdi:lightbulb-group"
|
||
light_1_name: "Fan Light"
|
||
switch_2_name: "Fan 2 Relay"
|
||
switch_3_name: "Fan 3 Relay"
|
||
switch_4_name: "Fan 4 Relay"
|
||
|
||
##########################################################################################
|
||
# 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_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}"
|
||
on_boot: # This weird toggle thing makes sure the states get restored on reboot
|
||
priority : -100
|
||
then:
|
||
- delay: 200ms
|
||
#- fan.toggle: ifan02_fan
|
||
#- fan.toggle: ifan02_fan
|
||
#- delay: 200ms
|
||
#- light.toggle: ifan02_light
|
||
#- delay: 1ms
|
||
#- light.toggle: ifan02_light
|
||
#- delay: 1s
|
||
- mqtt.publish:
|
||
topic: "${mqtt_local_status_topic}/speed/state"
|
||
payload: !lambda 'return to_string(id(speed_value));'
|
||
# platformio_options:
|
||
# build_flags:
|
||
# - "-Os" # optimize for size
|
||
# - "-Wl,--gc-sections" # drop unused code/data
|
||
# - "-fno-exceptions" # strip C++ exceptaions
|
||
# - "-fno-rtti" # strip C++ RTTI
|
||
|
||
##########################################################################################
|
||
# ESP Platform and Framework
|
||
# https://esphome.io/components/esp32.html
|
||
##########################################################################################
|
||
esp8266:
|
||
board: esp01_1m # The original sonoff basic
|
||
restore_from_flash: True # restore some values on reboot
|
||
|
||
preferences:
|
||
flash_write_interval: 5min
|
||
|
||
mdns:
|
||
disabled: True # Disabling will make the build file smaller (and it is still available via static IP)
|
||
|
||
##########################################################################################
|
||
# GLOBAL VARIABLES
|
||
##########################################################################################
|
||
globals:
|
||
- id: speed_value
|
||
type: int
|
||
restore_value: yes
|
||
initial_value: '0'
|
||
|
||
##########################################################################################
|
||
# 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, Serial control)
|
||
#esp8266_store_log_strings_in_flash: false
|
||
#tx_buffer_size: 64
|
||
|
||
##########################################################################################
|
||
# UART: Fan MCU / RF Remote Sniff (iFan02 -> ESP over UART0)
|
||
# - Uses GPIO3 (RX0) to listen to the fan microcontroller frames (433 MHz remote is decoded there)
|
||
# - 9600 8N1 is typical; if no frames appear, try 19200 (uncomment below)
|
||
# - If still nothing, some revisions route MCU TX to another pin; try rx_pin: GPIO13
|
||
##########################################################################################
|
||
uart:
|
||
id: ifan_uart
|
||
tx_pin: GPIO1 # ESP TX0 -> Fan MCU RX (not required for sniffing, but harmless)
|
||
rx_pin: GPIO3 # ESP RX0 <- Fan MCU TX (primary source for RF button frames)
|
||
baud_rate: 9600
|
||
#baud_rate: 19200 # <-- try this if you see no frames in logs
|
||
rx_buffer_size: 256
|
||
# NOTE: If no frames appear at either 9600 or 19200, try moving rx_pin to GPIO13 and reflash:
|
||
# rx_pin: GPIO13
|
||
|
||
##########################################################################################
|
||
# INTERVAL: Accumulate UART bytes and publish last frame to text sensor
|
||
# - Publishes after ~60ms of silence to group a single button press into one frame
|
||
##########################################################################################
|
||
interval:
|
||
- interval: 50ms
|
||
then:
|
||
- lambda: |-
|
||
static std::string frame;
|
||
static uint32_t last = 0;
|
||
uint8_t b;
|
||
while (id(ifan_uart).available()) {
|
||
if (id(ifan_uart).read_byte(&b)) {
|
||
char buf[4];
|
||
sprintf(buf, "%02X", b);
|
||
frame += buf;
|
||
frame += " ";
|
||
last = millis();
|
||
} else {
|
||
break;
|
||
}
|
||
}
|
||
if (!frame.empty() && (millis() - last > 60)) {
|
||
ESP_LOGI("ifan02", "MCU frame: %s", frame.c_str());
|
||
id(ifan_last_rf).publish_state(frame.c_str());
|
||
frame.clear();
|
||
}
|
||
|
||
##########################################################################################
|
||
# TEXT SENSORS: RF/MCU debug output (last frame seen)
|
||
# - Shows the last raw hex bytes received from the fan MCU when you press the RF remote
|
||
##########################################################################################
|
||
text_sensor:
|
||
- platform: template
|
||
id: ifan_last_rf
|
||
name: "iFan02 Remote Last Frame"
|
||
update_interval: never
|
||
|
||
##########################################################################################
|
||
# MQTT COMMANDS
|
||
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
||
##########################################################################################
|
||
mqtt:
|
||
on_message:
|
||
# Light control
|
||
- topic: "${mqtt_local_command_topic}/light/set"
|
||
payload: "ON"
|
||
then:
|
||
- light.turn_on: ifan02_light
|
||
- topic: "${mqtt_local_command_topic}/light/set"
|
||
payload: "OFF"
|
||
then:
|
||
- light.turn_off: ifan02_light
|
||
|
||
# Fan speed control (0–3) + ramp up/down (+ / -)
|
||
- topic: "${mqtt_local_command_topic}/speed/set"
|
||
then:
|
||
# 1) Compute new speed_value based on payload
|
||
- lambda: |-
|
||
std::string s = x;
|
||
int val = id(speed_value);
|
||
if (s == "+") {
|
||
val++;
|
||
} else if (s == "-") {
|
||
val--;
|
||
} else if (s.size() && isdigit(s[0])) {
|
||
val = atoi(s.c_str());
|
||
} else {
|
||
ESP_LOGE("ifan02", "Invalid speed payload: '%s'", x.c_str());
|
||
return;
|
||
}
|
||
// Clamp between 0 and 3
|
||
if (val < 0) val = 0;
|
||
if (val > 3) val = 3;
|
||
id(speed_value) = val;
|
||
|
||
# 2) Drive the fan based on the new value
|
||
- if:
|
||
condition:
|
||
lambda: 'return id(speed_value) == 0;'
|
||
then:
|
||
- fan.turn_off: ifan02_fan
|
||
else:
|
||
- fan.turn_on:
|
||
id: ifan02_fan
|
||
speed: !lambda 'return id(speed_value);'
|
||
|
||
##########################################################################################
|
||
# SWITCH COMPONENT
|
||
# https://esphome.io/components/switch/
|
||
##########################################################################################
|
||
# Sonoff ifan02 has relays, but they don't need to be shown in HA because
|
||
# the speed of the fan is the important part (and combinations of the relays give that)
|
||
##########################################################################################
|
||
switch:
|
||
- platform: gpio
|
||
name: "${switch_3_name}"
|
||
pin: GPIO4
|
||
id: fan3sw
|
||
restore_mode: RESTORE_DEFAULT_OFF
|
||
internal: true
|
||
- platform: gpio
|
||
name: "${switch_2_name}"
|
||
pin: GPIO5
|
||
id: fan2sw
|
||
restore_mode: RESTORE_DEFAULT_OFF
|
||
internal: true
|
||
- platform: gpio
|
||
name: "${switch_4_name}"
|
||
pin: GPIO15
|
||
id: fan4sw
|
||
restore_mode: RESTORE_DEFAULT_OFF
|
||
internal: true
|
||
|
||
##########################################################################################
|
||
# SELECT COMPONENT
|
||
# https://esphome.io/components/select/index.html
|
||
##########################################################################################
|
||
select:
|
||
- platform: template
|
||
name: "Bedroom 2 Fan Speed"
|
||
id: bedroom2_fan_speed_select
|
||
options:
|
||
- "Off"
|
||
- "Low"
|
||
- "Medium"
|
||
- "High"
|
||
update_interval: 1s
|
||
lambda: |-
|
||
switch (id(speed_value)) {
|
||
case 1: return esphome::optional<std::string>("Low");
|
||
case 2: return esphome::optional<std::string>("Medium");
|
||
case 3: return esphome::optional<std::string>("High");
|
||
default: return esphome::optional<std::string>("Off");
|
||
}
|
||
set_action:
|
||
# OFF
|
||
- if:
|
||
condition:
|
||
lambda: 'return x == "Off";'
|
||
then:
|
||
- lambda: |-
|
||
id(speed_value) = 0;
|
||
- fan.turn_off: ifan02_fan
|
||
# LOW (1)
|
||
- if:
|
||
condition:
|
||
lambda: 'return x == "Low";'
|
||
then:
|
||
- lambda: |-
|
||
id(speed_value) = 1;
|
||
- fan.turn_on:
|
||
id: ifan02_fan
|
||
speed: 1
|
||
# MEDIUM (2)
|
||
- if:
|
||
condition:
|
||
lambda: 'return x == "Medium";'
|
||
then:
|
||
- lambda: |-
|
||
id(speed_value) = 2;
|
||
- fan.turn_on:
|
||
id: ifan02_fan
|
||
speed: 2
|
||
# HIGH (3)
|
||
- if:
|
||
condition:
|
||
lambda: 'return x == "High";'
|
||
then:
|
||
- lambda: |-
|
||
id(speed_value) = 3;
|
||
- fan.turn_on:
|
||
id: ifan02_fan
|
||
speed: 3
|
||
|
||
################################################################################
|
||
# TEMPLATE OUTPUTS: drive the real relays when the states change
|
||
################################################################################
|
||
output:
|
||
- platform: gpio
|
||
pin: GPIO12
|
||
id: lightrelay
|
||
- platform: template
|
||
type: float
|
||
id: fan_decode
|
||
write_action:
|
||
- lambda: |-
|
||
if (state < 0.25) {
|
||
id(fan2sw).turn_off();
|
||
id(fan3sw).turn_off();
|
||
id(fan4sw).turn_off();
|
||
}
|
||
else if (state < 0.5) {
|
||
id(fan2sw).turn_on();
|
||
id(fan3sw).turn_off();
|
||
id(fan4sw).turn_off();
|
||
}
|
||
else if (state < 0.75) {
|
||
id(fan2sw).turn_on();
|
||
id(fan3sw).turn_on();
|
||
id(fan4sw).turn_off();
|
||
}
|
||
else {
|
||
id(fan2sw).turn_on();
|
||
id(fan3sw).turn_off();
|
||
id(fan4sw).turn_on();
|
||
}
|
||
|
||
##########################################################################################
|
||
# LIGHT COMPONENT
|
||
# https://esphome.io/components/light/
|
||
##########################################################################################
|
||
light:
|
||
- platform: binary
|
||
name: "${light_1_name}"
|
||
output: lightrelay
|
||
restore_mode: RESTORE_DEFAULT_OFF
|
||
id: ifan02_light
|
||
# publish status updates when the light turns on/off:
|
||
on_turn_on:
|
||
- mqtt.publish:
|
||
topic: "${mqtt_local_status_topic}/light/state"
|
||
payload: "ON"
|
||
on_turn_off:
|
||
- mqtt.publish:
|
||
topic: "${mqtt_local_status_topic}/light/state"
|
||
payload: "OFF"
|
||
|
||
##########################################################################################
|
||
# FAN COMPONENT
|
||
# https://esphome.io/components/fan/index.html
|
||
##########################################################################################
|
||
fan:
|
||
- platform: speed
|
||
output: fan_decode
|
||
name: "Fan"
|
||
id: ifan02_fan
|
||
speed_count: 3
|
||
restore_mode: RESTORE_DEFAULT_OFF
|
||
# whenever you explicitly set a speed (1–3):
|
||
on_speed_set:
|
||
- lambda: |-
|
||
id(speed_value) = x;
|
||
- mqtt.publish:
|
||
topic: "${mqtt_local_status_topic}/speed/state"
|
||
payload: !lambda 'return to_string(id(speed_value));'
|
||
# whenever the fan goes fully off:
|
||
on_turn_off:
|
||
- lambda: |-
|
||
id(speed_value) = 0;
|
||
- mqtt.publish:
|
||
topic: "${mqtt_local_status_topic}/speed/state"
|
||
payload: "0"
|
||
# whenever the fan goes off→on (e.g. via HA’s Fan switch):
|
||
on_turn_on:
|
||
- lambda: |-
|
||
// bump 0->1 if we were off
|
||
if (id(speed_value) == 0) id(speed_value) = 1;
|
||
- fan.turn_on:
|
||
id: ifan02_fan
|
||
speed: !lambda 'return id(speed_value);'
|
||
- mqtt.publish:
|
||
topic: "${mqtt_local_status_topic}/speed/state"
|
||
payload: !lambda 'return to_string(id(speed_value));'
|