199 lines
7.2 KiB
YAML
199 lines
7.2 KiB
YAML
#############################################
|
|
#############################################
|
|
# OFFICE USB HUB POWER
|
|
# Controlled by a Sonoff Basic R1
|
|
#
|
|
# V1.0 2025-06-14 Initial Version
|
|
#
|
|
##########################################################################################
|
|
##########################################################################################
|
|
|
|
##########################################################################################
|
|
# 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-officeusbhubpower"
|
|
friendly_name: "Office USB Hub Power"
|
|
description_comment: "Office USB Hub Power Supply control in the Office (On wall) :: Sonoff Basic"
|
|
device_area: "Office" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
|
|
|
# Project Naming
|
|
project_name: "Sonoff Technologies.Sonoff Basic V1" # Project Details
|
|
project_version: "v1.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
|
|
|
# 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-officeusbhubpower_ip
|
|
mqtt_main_command_topic: !secret mqtt_main_command_topic
|
|
|
|
# Device Settings
|
|
relay_icon: "mdi:generator-portable"
|
|
log_level: "ERROR" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
|
update_interval: "60s" # update time for for general sensors etc
|
|
|
|
# Device Naming
|
|
relay_1_name: "USB Hub Power Supply"
|
|
button_1_name: "Power Button"
|
|
|
|
# MQTT Controls
|
|
mqtt_device_name: "office-usbhub-power"
|
|
mqtt_main_topic: "${mqtt_main_command_topic}/${mqtt_device_name}" # Topic we will use to command stuff from external without HA
|
|
|
|
##########################################################################################
|
|
# 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}"
|
|
# 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
|
|
|
|
##########################################################################################
|
|
# 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: False
|
|
|
|
##########################################################################################
|
|
# 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
|
|
|
|
##########################################################################################
|
|
# SWITCH COMPONENT
|
|
# https://esphome.io/components/switch/
|
|
##########################################################################################
|
|
# Sonoff Basic R1 Relay Switch is GPIO12
|
|
#############################################
|
|
switch:
|
|
- platform: gpio
|
|
name: "${relay_1_name}"
|
|
pin: GPIO12
|
|
id: relay1
|
|
restore_mode: RESTORE_DEFAULT_ON
|
|
icon: "${relay_icon}"
|
|
|
|
##########################################################################################
|
|
# BINARY SENSORS
|
|
# https://esphome.io/components/binary_sensor/
|
|
##########################################################################################
|
|
# Sonoff Basic R1 Button is GPIO03
|
|
#############################################
|
|
binary_sensor:
|
|
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO03
|
|
mode: INPUT_PULLUP
|
|
inverted: true
|
|
name: "${button_1_name}"
|
|
id: power_button
|
|
filters:
|
|
- delayed_on: 20ms
|
|
on_click:
|
|
- min_length: 20ms
|
|
max_length: 500ms
|
|
then:
|
|
- lambda: |-
|
|
if (id(relay1).state) {
|
|
// Relay is ON: turn it OFF
|
|
id(relay1).turn_off();
|
|
} else {
|
|
// Relay is OFF: turn it ON
|
|
id(relay1).turn_on();
|
|
}
|
|
|
|
# Mimics actual relay status (but not controllable)
|
|
- platform: template
|
|
name: "${relay_1_name} Status"
|
|
lambda: |-
|
|
return id(relay1).state;
|
|
on_press:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_topic}/relay1/state"
|
|
payload: "ON"
|
|
on_release:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_topic}/relay1/state"
|
|
payload: "OFF"
|
|
|
|
##########################################################################################
|
|
# STATUS LED
|
|
# https://esphome.io/components/status_led.html
|
|
##########################################################################################
|
|
# Sonoff Basic R1 LED is GPIO13
|
|
#############################################
|
|
status_led:
|
|
pin:
|
|
number: GPIO13
|
|
inverted: yes
|
|
|
|
##########################################################################################
|
|
# MQTT COMMANDS
|
|
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
|
##########################################################################################
|
|
mqtt:
|
|
on_message:
|
|
# Relay 1 control
|
|
- topic: "${mqtt_main_topic}/relay1/set"
|
|
payload: "ON"
|
|
then:
|
|
- switch.turn_on: relay1
|
|
- topic: "${mqtt_main_topic}/relay1/set"
|
|
payload: "OFF"
|
|
then:
|
|
- switch.turn_off: relay1
|
|
|