Files
esp32-configs/athom-8ch-relay-board.yaml
T
2026-07-24 11:22:34 +08:00

437 lines
11 KiB
YAML

substitutions:
name: "athom-8ch-relay-board"
friendly_name: "Athom 8CH Relay Board"
room: ""
device_description: "athom esp32 8ch relay board"
project_name: "Athom Technology.ESP32 8CH Relay Board"
project_version: "v2.0.7"
update_interval: 60s
# Define a domain for this device to use. i.e. iot.home.lan (so device will appear as athom-smart-plug-v2.iot.home.lan in DNS/DHCP logs)
dns_domain: ".local"
# Set timezone of the smart plug. Useful if the plug is in a location different to the HA server. Can be entered in unix Country/Area format (i.e. "Australia/Sydney")
timezone: ""
# Set the duration between the sntp service polling ntp.org servers for an update
sntp_update_interval: 6h
# Network time servers for your region, enter from lowest to highest priority. To use local servers update as per zones or countries at: https://www.ntppool.org/zone/@
sntp_server_1: "0.pool.ntp.org"
sntp_server_2: "1.pool.ntp.org"
sntp_server_3: "2.pool.ntp.org"
# Enables faster network connections, with last connected SSID being connected to and no full scan for SSID being undertaken
wifi_fast_connect: "false"
# Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
log_level: "DEBUG"
# Enable or disable the use of IPv6 networking on the device
ipv6_enable: "false"
relay1_restore_mode: RESTORE_DEFAULT_OFF
relay2_restore_mode: RESTORE_DEFAULT_OFF
relay3_restore_mode: RESTORE_DEFAULT_OFF
relay4_restore_mode: RESTORE_DEFAULT_OFF
relay5_restore_mode: RESTORE_DEFAULT_OFF
relay6_restore_mode: RESTORE_DEFAULT_OFF
relay7_restore_mode: RESTORE_DEFAULT_OFF
relay8_restore_mode: RESTORE_DEFAULT_OFF
esphome:
name: "${name}"
friendly_name: "${friendly_name}"
comment: "${device_description}"
area: "${room}"
name_add_mac_suffix: true
min_version: 2026.6.0
project:
name: "${project_name}"
version: "${project_version}"
platformio_options:
board_build.flash_mode: dio
esp32:
board: esp32dev
flash_size: 4MB
framework:
type: esp-idf
version: recommended
sdkconfig_options:
# @grigi found in testing that these options resulted in better responsiveness.
# BLE 4.2 is supported by ALL ESP32 boards that have bluetooth, the original and derivatives.
CONFIG_BT_BLE_42_FEATURES_SUPPORTED: y
# Extend the watchdog timeout, so the device reboots if the device appears locked up for over 10 seconds.
CONFIG_ESP_TASK_WDT_TIMEOUT_S: "10"
preferences:
flash_write_interval: 5min
# Enable logging
logger:
baud_rate: 115200
level: ${log_level}
mdns:
disabled: false
web_server:
port: 80
# Enable Home Assistant API
api:
on_client_connected:
- esp32_ble_tracker.start_scan:
continuous: true
# Disable BLE tracking when there are no api connections live
on_client_disconnected:
if:
condition:
not:
api.connected:
then:
- esp32_ble_tracker.stop_scan:
ota:
- platform: esphome
id: ota_esphome
# Enables OTA firmware flashing from a URL (used by the update component below)
- platform: http_request
id: ota_http_request
# Required by the ota http_request platform and the update component.
# verify_ssl: false skips TLS cert validation to reduce heap/RAM pressure during
# the download; the manifest's MD5 still verifies firmware integrity before flashing.
http_request:
id: http_request_component
verify_ssl: false
update:
# Managed updates via HTTP request: periodically checks the published manifest
# and exposes a "Firmware Update" entity, pointing at this device's GitHub Pages
# manifest. Pages URLs avoid the redirect/buffer issues of Release download URLs.
- platform: http_request
id: update_http_request
name: "Firmware Update"
source: https://athom-tech.github.io/esp32-configs/firmware/athom-8ch-relay-board.manifest.json
# update_interval defaults to 6h (how often it checks, not installs)
network:
enable_ipv6: ${ipv6_enable}
wifi:
# This spawns an AP with the device name and mac address with no password.
ap: {}
# Allow rapid re-connection to previously connect WiFi SSID, skipping scan of all SSID
fast_connect: "${wifi_fast_connect}"
# Define dns domain / suffix to add to hostname
domain: "${dns_domain}"
captive_portal:
improv_serial:
esp32_improv:
authorizer: none
esp32_ble_tracker:
scan_parameters:
# Don't auto start BLE scanning, we control it in the `api` block's automation.
continuous: false
active: true # send scan-request packets to gather more info, like device name for some devices.
interval: 320ms # default 320ms - how long to spend on each advert channel
window: 300ms # default 30ms - how long to actually "listen" in each interval. Reduce this if device is unstable.
# If the device cannot keep up or becomes unstable, reduce the "window" setting. This may be
# required if your device is controlling other sensors or doing PWM for lights etc.
bluetooth_proxy:
active: true
dashboard_import:
package_import_url: github://athom-tech/esp32-configs/athom-8ch-relay-board.yaml
remote_receiver:
pin: GPIO17
dump: rc_switch
id: "rc_switch_receiver"
binary_sensor:
- platform: status
name: "Status"
entity_category: "diagnostic"
- platform: gpio
pin:
number: GPIO26
mode:
input: true
inverted: true
name: "Power Button1"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay1
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO25
mode:
input: true
inverted: true
name: "Power Button2"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay2
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO33
mode:
input: true
inverted: true
name: "Power Button3"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay3
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO32
mode:
input: true
inverted: true
name: "Power Button4"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay4
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO35
mode:
input: true
inverted: true
name: "Power Button5"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay5
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO34
mode:
input: true
inverted: true
name: "Power Button6"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay6
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO39
mode:
input: true
inverted: true
name: "Power Button7"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay7
- timing:
- ON for at least 4s
then:
- button.press: Reset
- platform: gpio
pin:
number: GPIO36
mode:
input: true
inverted: true
name: "Power Button8"
disabled_by_default: true
on_multi_click:
- timing:
- ON for at most 1s
- OFF for at least 0.2s
then:
- switch.toggle: relay8
- timing:
- ON for at least 4s
then:
- button.press: Reset
sensor:
- platform: uptime
name: "Uptime Sensor"
id: uptime_sensor
type:
timestamp
entity_category: "diagnostic"
- platform: wifi_signal # Reports the WiFi signal strength/RSSI in dB
name: "WiFi Signal dB"
id: wifi_signal_db
update_interval: "${update_interval}"
entity_category: "diagnostic"
- platform: copy # Reports the WiFi signal strength in %
source_id: wifi_signal_db
name: "WiFi Signal Percent"
filters:
- lambda: return min(max(2 * (x + 100.0), 0.0), 100.0);
unit_of_measurement: "Signal %"
entity_category: "diagnostic"
device_class: ""
button:
- platform: restart
name: "Restart"
entity_category: "config"
- platform: factory_reset
name: "Factory Reset"
id: Reset
entity_category: "config"
- platform: safe_mode
name: "Safe Mode"
internal: false
entity_category: "config"
switch:
# Relay
- platform: gpio
name: "Relay1"
pin: GPIO27
id: relay1
restore_mode: ${relay1_restore_mode}
- platform: gpio
name: "Relay2"
pin: GPIO14
id: relay2
restore_mode: ${relay2_restore_mode}
- platform: gpio
name: "Relay3"
pin: GPIO12
id: relay3
restore_mode: ${relay3_restore_mode}
- platform: gpio
name: "Relay4"
pin: GPIO13
id: relay4
restore_mode: ${relay4_restore_mode}
- platform: gpio
name: "Relay5"
pin: GPIO2
id: relay5
restore_mode: ${relay5_restore_mode}
- platform: gpio
name: "Relay6"
pin: GPIO4
id: relay6
restore_mode: ${relay6_restore_mode}
- platform: gpio
name: "Relay7"
pin: GPIO5
id: relay7
restore_mode: ${relay7_restore_mode}
- platform: gpio
name: "Relay8"
pin: GPIO18
id: relay8
restore_mode: ${relay8_restore_mode}
light:
- platform: status_led
name: "Status LED"
disabled_by_default: true
pin: GPIO15
text_sensor:
- platform: wifi_info
ip_address:
name: "IP Address"
entity_category: "diagnostic"
ssid:
name: "Connected SSID"
entity_category: "diagnostic"
mac_address:
name: "Mac Address"
entity_category: "diagnostic"
# Creates a sensor showing when the device was last restarted
- platform: template
name: 'Last Restart'
id: device_last_restart
icon: mdi:clock
entity_category: "diagnostic"
# device_class: timestamp
time:
- platform: sntp
id: sntp_time
# Define the timezone of the device
timezone: "${timezone}"
# Change sync interval from default 5min to 6 hours (or as set in substitutions)
update_interval: ${sntp_update_interval}
# Set specific sntp servers to use
servers:
- "${sntp_server_1}"
- "${sntp_server_2}"
- "${sntp_server_3}"
# Publish the time the device was last restarted
on_time_sync:
then:
# Update last restart time, but only once.
- if:
condition:
lambda: 'return id(device_last_restart).state == "";'
then:
- text_sensor.template.publish:
id: device_last_restart
state: !lambda 'return id(sntp_time).now().strftime("%a %d %b %Y - %I:%M:%S %p");'