Compare commits
299 Commits
v2024.12.6
...
v2025.10.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cd39fee788 | ||
|
|
d9f361b404 | ||
|
|
6ffa73b321 | ||
|
|
e2b4fa4186 | ||
|
|
63c98fcc68 | ||
|
|
8943dc7ea9 | ||
|
|
15c7ddc4b4 | ||
|
|
22a99017fa | ||
|
|
67d1c2cdce | ||
|
|
65d08194aa | ||
|
|
0690ae14d8 | ||
|
|
0b430a7ce0 | ||
|
|
03e0004e8c | ||
|
|
6d2de0d32b | ||
|
|
8af692e82d | ||
|
|
fc135875c5 | ||
|
|
aae3eaa204 | ||
|
|
fe745c0132 | ||
|
|
5757714b31 | ||
|
|
6520b8050e | ||
|
|
a10edb3d06 | ||
|
|
1df58e162f | ||
|
|
d905b69ad2 | ||
|
|
462b131cb6 | ||
|
|
cf8590b460 | ||
|
|
eca54c01ed | ||
|
|
0d0de08e19 | ||
|
|
3557c847b2 | ||
|
|
dbbbc4040d | ||
|
|
1bb444e008 | ||
|
|
00d70efc3b | ||
|
|
3c53b21fbe | ||
|
|
0fb4b5fe09 | ||
|
|
4634b650d9 | ||
|
|
6a1a5d5ae2 | ||
|
|
271aa74f99 | ||
|
|
ce54db0f6d | ||
|
|
93120a8b51 | ||
|
|
91f24db3b1 | ||
|
|
fa2e8f3b62 | ||
|
|
c9a85504f1 | ||
|
|
33bbad6adb | ||
|
|
bda597f748 | ||
|
|
1552aaec6c | ||
|
|
250b22562d | ||
|
|
243a18bdf2 | ||
|
|
07de172188 | ||
|
|
c1f1b5a7e7 | ||
|
|
1d8b4fee1a | ||
|
|
6d16d7d645 | ||
|
|
42ae160217 | ||
|
|
ecfc64d2f3 | ||
|
|
db83050d7b | ||
|
|
d7dcc05506 | ||
|
|
b6dc915469 | ||
|
|
dcc68f7077 | ||
|
|
23d28a32a3 | ||
|
|
ba8f19060f | ||
|
|
c36af8a220 | ||
|
|
6fad9d7074 | ||
|
|
f79ed28364 | ||
|
|
11807ce892 | ||
|
|
526b257ad6 | ||
|
|
0a95a7f8d0 | ||
|
|
6687c5c6a5 | ||
|
|
ad92799035 | ||
|
|
8e4bbda412 | ||
|
|
8eaa60b5c0 | ||
|
|
334932c6c8 | ||
|
|
0480f2ddf3 | ||
|
|
720cf3ab36 | ||
|
|
9edd43079b | ||
|
|
a67f3dfd4a | ||
|
|
796eb7620c | ||
|
|
e53334ac18 | ||
|
|
7d2080cd8d | ||
|
|
efd44fab02 | ||
|
|
8422168837 | ||
|
|
0b7f83ebca | ||
|
|
5aecb343f6 | ||
|
|
a4340da836 | ||
|
|
912607d1ec | ||
|
|
ba041a9d50 | ||
|
|
b99a6b8c54 | ||
|
|
29b292bf45 | ||
|
|
4c0a83851e | ||
|
|
9663f295d5 | ||
|
|
4707506c74 | ||
|
|
5b77f44ae2 | ||
|
|
efd4eaa6bb | ||
|
|
bc0b775df2 | ||
|
|
ddfd4b3220 | ||
|
|
54ac959abb | ||
|
|
9fdfd52ad4 | ||
|
|
e326f03502 | ||
|
|
754ad9cffe | ||
|
|
637f47583a | ||
|
|
bd86371453 | ||
|
|
54c9119a63 | ||
|
|
2d1ef49ca9 | ||
|
|
1190802ccd | ||
|
|
2cc8199593 | ||
|
|
669a78a427 | ||
|
|
78d820d91e | ||
|
|
a8277e5b88 | ||
|
|
458273206d | ||
|
|
982c64c1c1 | ||
|
|
66d1b27c0d | ||
|
|
f9da912777 | ||
|
|
6d663323e5 | ||
|
|
122cfff8db | ||
|
|
70a054616c | ||
|
|
5957e277b7 | ||
|
|
7e070617ae | ||
|
|
50a11f61ff | ||
|
|
97b193d7c3 | ||
|
|
644ba8e711 | ||
|
|
36b28a2475 | ||
|
|
1bd51f304d | ||
|
|
680042a428 | ||
|
|
0a3ceb97f5 | ||
|
|
daaffdb6ca | ||
|
|
ffdb3a22b5 | ||
|
|
b426bdd5dc | ||
|
|
3cdd9f87af | ||
|
|
ddb26cd833 | ||
|
|
5ea4f2015b | ||
|
|
ddb5e0f783 | ||
|
|
ab078f597a | ||
|
|
5eb42082db | ||
|
|
b1a978b3f3 | ||
|
|
4ec44e611f | ||
|
|
4d7895a2e9 | ||
|
|
be76ebd603 | ||
|
|
49a0f088e7 | ||
|
|
ace945a4ea | ||
|
|
e944cd2c21 | ||
|
|
1cf6f60c78 | ||
|
|
58ba5e0136 | ||
|
|
b0b19fee45 | ||
|
|
fe222ffe32 | ||
|
|
bb09d7f7f7 | ||
|
|
b6e3f41952 | ||
|
|
ba3fc89032 | ||
|
|
fcbc92aaec | ||
|
|
a59f667e7d | ||
|
|
ff3bf05ed1 | ||
|
|
8a4009dd7e | ||
|
|
6bdf6e97b7 | ||
|
|
acb602c4ca | ||
|
|
9bae016573 | ||
|
|
e47726dc47 | ||
|
|
5988681132 | ||
|
|
5d80ce1117 | ||
|
|
036e62b277 | ||
|
|
56c613a70f | ||
|
|
12fd2d3747 | ||
|
|
81f0420987 | ||
|
|
e89adca5cb | ||
|
|
a64c45b37b | ||
|
|
95291c0381 | ||
|
|
39cf0f2b10 | ||
|
|
8d03105caf | ||
|
|
e911482deb | ||
|
|
ef4f412223 | ||
|
|
9d64b099a4 | ||
|
|
037801e961 | ||
|
|
79b57304c7 | ||
|
|
48ddfbf8b0 | ||
|
|
2e43160acb | ||
|
|
8656d0c4ca | ||
|
|
133d571874 | ||
|
|
1489bc5237 | ||
|
|
11b21de8a9 | ||
|
|
e8346e4436 | ||
|
|
e3abc6c6d5 | ||
|
|
3e847bbd4a | ||
|
|
ba69b43688 | ||
|
|
f84b9af1ee | ||
|
|
9fa79bbde6 | ||
|
|
8a343ab8fe | ||
|
|
b5a96387cb | ||
|
|
8b7fad76c1 | ||
|
|
a224cd5f86 | ||
|
|
da9dfbf808 | ||
|
|
bd5091293e | ||
|
|
05c40cf7b5 | ||
|
|
ebd8a5432a | ||
|
|
0779279d44 | ||
|
|
09514e1331 | ||
|
|
b7a66b2e87 | ||
|
|
4266a7cdd8 | ||
|
|
40f8165d5c | ||
|
|
d3d5c21d38 | ||
|
|
4b1aed33ef | ||
|
|
72a666cd3c | ||
|
|
5255912fcf | ||
|
|
c50bd5ca16 | ||
|
|
6313709fd5 | ||
|
|
b431041b15 | ||
|
|
9fad193892 | ||
|
|
e6bf60555d | ||
|
|
6a12074b71 | ||
|
|
fee446c5e2 | ||
|
|
088213137f | ||
|
|
02c7c1aff1 | ||
|
|
3401aaf4a3 | ||
|
|
f154a483cc | ||
|
|
b69bc6916b | ||
|
|
9d0fcf6bfa | ||
|
|
fa516a66cc | ||
|
|
2811eedffb | ||
|
|
0c9a5ac65e | ||
|
|
9828b6ff8a | ||
|
|
6221e109e8 | ||
|
|
3d21c2ebcb | ||
|
|
7d12ddb0e5 | ||
|
|
ea12c1d422 | ||
|
|
c73cb950eb | ||
|
|
e69873cab5 | ||
|
|
d4a18dc595 | ||
|
|
45b30d30fa | ||
|
|
d656f4b73f | ||
|
|
493dcb0abb | ||
|
|
f8fa9a2363 | ||
|
|
47744c7144 | ||
|
|
fa2c5dcc29 | ||
|
|
3cf6a11bc7 | ||
|
|
0109771731 | ||
|
|
b7df1686b6 | ||
|
|
c22d8eb847 | ||
|
|
f3b84e9d4e | ||
|
|
81c6620fbf | ||
|
|
4378952d97 | ||
|
|
876d03ace5 | ||
|
|
5ddf5388bd | ||
|
|
7aee88c38f | ||
|
|
e546fedf08 | ||
|
|
cca59bbe2a | ||
|
|
aec1aa69d3 | ||
|
|
bcf4396c6f | ||
|
|
403cdce2b5 | ||
|
|
44b3586a17 | ||
|
|
93990e78c1 | ||
|
|
e8470f56e4 | ||
|
|
2429c9d616 | ||
|
|
7a5a537847 | ||
|
|
2aa036dc0e | ||
|
|
802acdc476 | ||
|
|
37b2e93896 | ||
|
|
695cca07a0 | ||
|
|
f258b8f783 | ||
|
|
7e055e7737 | ||
|
|
9fec812b66 | ||
|
|
269ba89bd3 | ||
|
|
a44e486411 | ||
|
|
c4b2b8917f | ||
|
|
ae87f025a3 | ||
|
|
303a3f1267 | ||
|
|
a716e8e9cf | ||
|
|
d77d761497 | ||
|
|
60a3248c6b | ||
|
|
ec528ec128 | ||
|
|
4ed98e533f | ||
|
|
1ef73d5cd0 | ||
|
|
420225b6ba | ||
|
|
8996cfbdf8 | ||
|
|
085250c471 | ||
|
|
6230e31323 | ||
|
|
248f7e9cd8 | ||
|
|
6343e6eb4a | ||
|
|
226d5db7c8 | ||
|
|
dbde1da920 | ||
|
|
f2ff037c82 | ||
|
|
82af8b6687 | ||
|
|
73ecbba3b2 | ||
|
|
eb1a3954a9 | ||
|
|
5d5a3d3e77 | ||
|
|
f9e9243de5 | ||
|
|
be6a4a51e2 | ||
|
|
2a8255b788 | ||
|
|
a00e15fa85 | ||
|
|
4ea7f1ee57 | ||
|
|
bd4f6836c9 | ||
|
|
98ea8810f8 | ||
|
|
552b83f065 | ||
|
|
ee6f565447 | ||
|
|
aa4e27ec35 | ||
|
|
8a509cedc8 | ||
|
|
ddea93af6a | ||
|
|
dc99319397 | ||
|
|
5ae45fff63 | ||
|
|
bbbaeeb0d4 | ||
|
|
a9f82d958f | ||
|
|
c07e4f195a | ||
|
|
f1f545198b | ||
|
|
d87b86bfca | ||
|
|
f11840d2bc | ||
|
|
42afe71365 |
430
.github/workflows/validate_esphome.yml
vendored
430
.github/workflows/validate_esphome.yml
vendored
@@ -1,9 +1,36 @@
|
||||
---
|
||||
name: Validate ESPHome
|
||||
|
||||
# yamllint disable-line rule:truthy
|
||||
on:
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
|
||||
on: # yamllint disable-line rule:truthy
|
||||
push:
|
||||
paths:
|
||||
- "**/*.yml"
|
||||
- "**/*.yaml"
|
||||
- "**/*.h"
|
||||
- "**/*.cpp"
|
||||
- "**/*.c"
|
||||
- "**/*.py"
|
||||
|
||||
pull_request:
|
||||
paths:
|
||||
- "**/*.yml"
|
||||
- "**/*.yaml"
|
||||
- "**/*.h"
|
||||
- "**/*.cpp"
|
||||
- "**/*.c"
|
||||
- "**/*.py"
|
||||
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
skip_dev:
|
||||
description: 'Skip dev testing (test only on latest)'
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
@@ -12,49 +39,416 @@ concurrency:
|
||||
jobs:
|
||||
code_scan:
|
||||
name: Code scan (YAML)
|
||||
runs-on: "ubuntu-latest"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@main
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@main
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
python-version: '3.11'
|
||||
- name: Install Yamllint
|
||||
run: pip install yamllint
|
||||
|
||||
- name: Validate YAML files
|
||||
run: find . -name "*.yaml" -exec yamllint -c ./.rules/yamllint.yml {} +
|
||||
|
||||
build_basic:
|
||||
name: Basic
|
||||
# Arduino Framework - Foundation (latest)
|
||||
build_ard_core:
|
||||
name: "🏗️ Arduino Core (latest)"
|
||||
needs: code_scan
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build core
|
||||
- name: Build Arduino Core - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_core.yaml"
|
||||
version: latest
|
||||
|
||||
build_ard_core_dev:
|
||||
name: "🏗️ Arduino Core (dev)"
|
||||
needs: code_scan
|
||||
if: ${{ success() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build Arduino Core - dev
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_core.yaml"
|
||||
version: dev
|
||||
build_ard_basic:
|
||||
name: "📦 Arduino Basic (latest)"
|
||||
needs: build_ard_core
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build Arduino Basic - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_basic.yaml"
|
||||
version: latest
|
||||
|
||||
build_bluetooth_proxy_4:
|
||||
name: Bluetooth Proxy (IDF)
|
||||
build_ard_basic_dev:
|
||||
name: "📦 Arduino Basic (dev)"
|
||||
needs: build_ard_core_dev
|
||||
if: ${{ success() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build core
|
||||
- name: Build Arduino Basic - dev
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_bluetooth_proxy.yaml"
|
||||
yaml-file: ".test/esphome_ard_basic.yaml"
|
||||
version: dev
|
||||
|
||||
build_bluetooth_proxy_53:
|
||||
name: Bluetooth Proxy (IDF v5.3)
|
||||
build_ard_hw_relays:
|
||||
name: "🔌 Arduino HW Relays (latest)"
|
||||
needs: build_ard_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build core
|
||||
- name: Build Arduino HW Relays - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf53_bluetooth_proxy.yaml"
|
||||
yaml-file: ".test/esphome_ard_hw_relays.yaml"
|
||||
version: latest
|
||||
|
||||
build_ard_hw_speaker:
|
||||
name: "🔌 Arduino HW Speaker (latest)"
|
||||
needs: build_ard_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build Arduino HW Speaker - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_hw_speaker.yaml"
|
||||
version: latest
|
||||
|
||||
build_ard_hw_vibration:
|
||||
name: "🔌 Arduino HW Vibration (latest)"
|
||||
needs: build_ard_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build Arduino HW Vibration - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_hw_vibration.yaml"
|
||||
version: latest
|
||||
|
||||
build_ard_ble_proxy_latest:
|
||||
name: "⚡ Arduino BLE Proxy (latest)"
|
||||
needs: build_ard_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build Arduino BLE Proxy - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_ble_proxy.yaml"
|
||||
version: latest
|
||||
|
||||
build_ard_ble_proxy_dev:
|
||||
name: "⚡ Arduino BLE Proxy (dev)"
|
||||
needs: build_ard_basic_dev
|
||||
if: ${{ success() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build Arduino BLE Proxy - dev
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_ble_proxy.yaml"
|
||||
version: dev
|
||||
|
||||
# IDF Framework - Foundation (latest)
|
||||
build_idf_core:
|
||||
name: "🏗️ IDF Core (latest)"
|
||||
needs: code_scan
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF Core - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_core.yaml"
|
||||
version: latest
|
||||
|
||||
build_idf_core_dev:
|
||||
name: "🏗️ IDF Core (dev)"
|
||||
needs: code_scan
|
||||
if: ${{ success() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF Core - dev
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_core.yaml"
|
||||
version: dev
|
||||
|
||||
build_idf_basic:
|
||||
name: "📦 IDF Basic (latest)"
|
||||
needs: build_idf_core
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF Basic - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_basic.yaml"
|
||||
version: latest
|
||||
|
||||
build_idf_basic_dev:
|
||||
name: "📦 IDF Basic (dev)"
|
||||
needs: build_idf_core_dev
|
||||
if: ${{ success() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF Basic - dev
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_basic.yaml"
|
||||
version: dev
|
||||
|
||||
build_idf_hw_relays:
|
||||
name: "🔌 IDF HW Relays (latest)"
|
||||
needs: build_idf_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF HW Relays - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_hw_relays.yaml"
|
||||
version: latest
|
||||
|
||||
build_idf_hw_speaker:
|
||||
name: "🔌 IDF HW Speaker (latest)"
|
||||
needs: build_idf_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF HW Speaker - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_hw_speaker.yaml"
|
||||
version: latest
|
||||
|
||||
build_idf_hw_vibration:
|
||||
name: "🔌 IDF HW Vibration (latest)"
|
||||
needs: build_idf_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF HW Vibration - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_hw_vibration.yaml"
|
||||
version: latest
|
||||
|
||||
build_idf_ble_proxy_latest:
|
||||
name: "⚡ IDF BLE Proxy (latest)"
|
||||
needs: build_idf_basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF BLE Proxy - latest
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_ble_proxy.yaml"
|
||||
version: latest
|
||||
|
||||
build_idf_ble_proxy_dev:
|
||||
name: "⚡ IDF BLE Proxy (dev)"
|
||||
needs: build_idf_basic_dev
|
||||
if: ${{ success() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build IDF BLE Proxy - dev
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_ble_proxy.yaml"
|
||||
version: dev
|
||||
|
||||
# Summary Jobs - Grouped by framework and environment
|
||||
summary_arduino:
|
||||
name: "📊 Arduino Framework"
|
||||
needs:
|
||||
- build_ard_core
|
||||
- build_ard_core_dev
|
||||
- build_ard_basic
|
||||
- build_ard_basic_dev
|
||||
- build_ard_hw_relays
|
||||
- build_ard_hw_speaker
|
||||
- build_ard_hw_vibration
|
||||
- build_ard_ble_proxy_latest
|
||||
- build_ard_ble_proxy_dev
|
||||
if: always()
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Arduino Framework Results
|
||||
run: |
|
||||
SUCCESS=0
|
||||
TOTAL=0
|
||||
|
||||
# Count latest builds (always run)
|
||||
[ "${{ needs.build_ard_core.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_basic.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_hw_relays.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_hw_speaker.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_hw_vibration.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_ble_proxy_latest.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
TOTAL=$((TOTAL + 6))
|
||||
|
||||
# Count dev builds (if not skipped)
|
||||
if [ "${{ github.event.inputs.skip_dev }}" != "true" ]; then
|
||||
[ "${{ needs.build_ard_core_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_basic_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_ble_proxy_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
TOTAL=$((TOTAL + 3))
|
||||
fi
|
||||
|
||||
echo "🤖 Arduino Framework: $SUCCESS/$TOTAL builds passed"
|
||||
|
||||
if [ "$SUCCESS" -eq "$TOTAL" ]; then
|
||||
echo "✅ All Arduino builds successful!"
|
||||
else
|
||||
echo "❌ Some Arduino builds failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
summary_idf:
|
||||
name: "📊 ESP-IDF Framework"
|
||||
needs:
|
||||
- build_idf_core
|
||||
- build_idf_core_dev
|
||||
- build_idf_basic
|
||||
- build_idf_basic_dev
|
||||
- build_idf_hw_relays
|
||||
- build_idf_hw_speaker
|
||||
- build_idf_hw_vibration
|
||||
- build_idf_ble_proxy_latest
|
||||
- build_idf_ble_proxy_dev
|
||||
if: always()
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: ESP-IDF Framework Results
|
||||
run: |
|
||||
SUCCESS=0
|
||||
TOTAL=0
|
||||
|
||||
# Count latest builds (always run)
|
||||
[ "${{ needs.build_idf_core.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_basic.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_hw_relays.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_hw_speaker.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_hw_vibration.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_ble_proxy_latest.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
TOTAL=$((TOTAL + 6))
|
||||
|
||||
# Count dev builds (if not skipped)
|
||||
if [ "${{ github.event.inputs.skip_dev }}" != "true" ]; then
|
||||
[ "${{ needs.build_idf_core_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_basic_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_ble_proxy_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
TOTAL=$((TOTAL + 3))
|
||||
fi
|
||||
|
||||
echo "🔧 ESP-IDF Framework: $SUCCESS/$TOTAL builds passed"
|
||||
|
||||
if [ "$SUCCESS" -eq "$TOTAL" ]; then
|
||||
echo "✅ All ESP-IDF builds successful!"
|
||||
else
|
||||
echo "❌ Some ESP-IDF builds failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
summary_latest:
|
||||
name: "📊 ESPHome (Latest)"
|
||||
needs:
|
||||
- build_ard_core
|
||||
- build_ard_basic
|
||||
- build_ard_hw_relays
|
||||
- build_ard_hw_speaker
|
||||
- build_ard_hw_vibration
|
||||
- build_ard_ble_proxy_latest
|
||||
- build_idf_core
|
||||
- build_idf_basic
|
||||
- build_idf_hw_relays
|
||||
- build_idf_hw_speaker
|
||||
- build_idf_hw_vibration
|
||||
- build_idf_ble_proxy_latest
|
||||
if: always()
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Latest ESPHome Results
|
||||
run: |
|
||||
SUCCESS=0
|
||||
TOTAL=12
|
||||
|
||||
# Arduino Latest builds
|
||||
[ "${{ needs.build_ard_core.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_basic.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_hw_relays.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_hw_speaker.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_hw_vibration.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_ble_proxy_latest.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
|
||||
# ESP-IDF Latest builds
|
||||
[ "${{ needs.build_idf_core.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_basic.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_hw_relays.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_hw_speaker.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_hw_vibration.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_ble_proxy_latest.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
|
||||
echo "📋 ESPHome (Latest): $SUCCESS/$TOTAL builds passed"
|
||||
|
||||
if [ "$SUCCESS" -eq "$TOTAL" ]; then
|
||||
echo "✅ All builds on latest ESPHome successful!"
|
||||
else
|
||||
echo "❌ Some builds on latest ESPHome failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
summary_dev:
|
||||
name: "📊 ESPHome (Dev)"
|
||||
needs:
|
||||
- build_ard_core_dev
|
||||
- build_ard_basic_dev
|
||||
- build_ard_ble_proxy_dev
|
||||
- build_idf_core_dev
|
||||
- build_idf_basic_dev
|
||||
- build_idf_ble_proxy_dev
|
||||
if: ${{ always() && (github.event_name != 'workflow_dispatch' || github.event.inputs.skip_dev != 'true') }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Dev ESPHome Results
|
||||
run: |
|
||||
SUCCESS=0
|
||||
TOTAL=6
|
||||
|
||||
# Arduino Dev builds
|
||||
[ "${{ needs.build_ard_core_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_basic_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_ard_ble_proxy_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
|
||||
# ESP-IDF Dev builds
|
||||
[ "${{ needs.build_idf_core_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_basic_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
[ "${{ needs.build_idf_ble_proxy_dev.result }}" == "success" ] && SUCCESS=$((SUCCESS + 1))
|
||||
|
||||
echo "🚀 ESPHome (Dev): $SUCCESS/$TOTAL builds passed"
|
||||
|
||||
if [ "$SUCCESS" -eq "$TOTAL" ]; then
|
||||
echo "✅ All builds on dev ESPHome successful!"
|
||||
else
|
||||
echo "❌ Some builds on dev ESPHome failed"
|
||||
exit 1
|
||||
fi
|
||||
...
|
||||
|
||||
80
.github/workflows/validate_esphome_beta.yml
vendored
80
.github/workflows/validate_esphome_beta.yml
vendored
@@ -1,80 +0,0 @@
|
||||
---
|
||||
name: Validate ESPHome (Beta)
|
||||
|
||||
on: # yamllint disable-line rule:truthy
|
||||
push:
|
||||
paths:
|
||||
- "*.yaml"
|
||||
- "ESPHome/*.yaml"
|
||||
- ".test/*.yaml"
|
||||
- "*.h"
|
||||
- "*.c"
|
||||
- "*.cpp"
|
||||
- "*.py"
|
||||
pull_request:
|
||||
paths:
|
||||
- "*.yaml"
|
||||
- "ESPHome/*.yaml"
|
||||
- ".test/*.yaml"
|
||||
- "*.h"
|
||||
- "*.c"
|
||||
- "*.cpp"
|
||||
- "*.py"
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
code_scan:
|
||||
name: Code scan (YAML)
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@main
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@main
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Install Yamllint
|
||||
run: pip install yamllint
|
||||
|
||||
- name: Validate YAML files
|
||||
run: find . -name "*.yaml" -exec yamllint -c ./.rules/yamllint.yml {} +
|
||||
|
||||
build_basic:
|
||||
name: Basic
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build core
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_ard_basic.yaml"
|
||||
version: beta
|
||||
|
||||
build_bluetooth_proxy_4:
|
||||
name: Bluetooth Proxy (IDF)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build core
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf_bluetooth_proxy.yaml"
|
||||
version: beta
|
||||
|
||||
build_bluetooth_proxy_53:
|
||||
name: Bluetooth Proxy (IDF v5.3)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- name: Build core
|
||||
uses: esphome/build-action@main
|
||||
with:
|
||||
yaml-file: ".test/esphome_idf53_bluetooth_proxy.yaml"
|
||||
version: beta
|
||||
...
|
||||
45
.github/workflows/validate_markdown.yml
vendored
45
.github/workflows/validate_markdown.yml
vendored
@@ -17,23 +17,28 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@main
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: '0'
|
||||
fetch-depth: 0 # Ensures full commit history for diff
|
||||
|
||||
# https://github.com/marketplace/actions/markdownlint-cli2-action
|
||||
- name: Identify changed files
|
||||
uses: tj-actions/changed-files@v41
|
||||
id: changed-files
|
||||
with:
|
||||
files: '**/*.md'
|
||||
separator: ","
|
||||
# https://github.com/marketplace/actions/markdownlint-cli2-action
|
||||
run: |
|
||||
BASE=${{ github.event.before }}
|
||||
HEAD=${{ github.sha }}
|
||||
FILES=$(git diff --name-only $BASE $HEAD -- '**/*.md' | tr '\n' ',')
|
||||
echo "changed_files=$FILES" >> $GITHUB_ENV
|
||||
if [[ -n "$FILES" ]]; then
|
||||
echo "any_changed=true" >> $GITHUB_ENV
|
||||
else
|
||||
echo "any_changed=false" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
- name: Markdown Lint
|
||||
uses: DavidAnson/markdownlint-cli2-action@v14
|
||||
if: steps.changed-files.outputs.any_changed == 'true'
|
||||
if: env.any_changed == 'true'
|
||||
with:
|
||||
globs: ${{ steps.changed-files.outputs.all_changed_files }}
|
||||
globs: ${{ env.changed_files }}
|
||||
separator: ","
|
||||
config: '.rules/.markdownlint.jsonc'
|
||||
fix: true
|
||||
@@ -43,15 +48,27 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@main
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: '0'
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Identify changed files
|
||||
id: changed-files
|
||||
run: |
|
||||
BASE=${{ github.event.before }}
|
||||
HEAD=${{ github.sha }}
|
||||
FILES=$(git diff --name-only $BASE $HEAD -- '**/*.md' | tr '\n' ',')
|
||||
echo "changed_files=$FILES" >> $GITHUB_ENV
|
||||
if [[ -n "$FILES" ]]; then
|
||||
echo "any_changed=true" >> $GITHUB_ENV
|
||||
else
|
||||
echo "any_changed=false" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
# https://github.com/gaurav-nelson/github-action-markdown-link-check
|
||||
- name: Markdown links
|
||||
uses: gaurav-nelson/github-action-markdown-link-check@v1
|
||||
if: env.any_changed == 'true'
|
||||
with:
|
||||
# yamllint disable-line rule:truthy
|
||||
check-modified-files-only: yes
|
||||
config-file: '.rules/mlc_config.json'
|
||||
base-branch: 'main'
|
||||
|
||||
25
.github/workflows/validate_yamllint.yml
vendored
25
.github/workflows/validate_yamllint.yml
vendored
@@ -19,24 +19,29 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@main
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: '0'
|
||||
fetch-depth: 0 # Ensures full commit history for diff
|
||||
|
||||
- name: Identify changed files
|
||||
uses: tj-actions/changed-files@v41
|
||||
id: changed-files
|
||||
with:
|
||||
files: '**/*.y*ml'
|
||||
separator: ","
|
||||
run: |
|
||||
BASE=${{ github.event.before }}
|
||||
HEAD=${{ github.sha }}
|
||||
FILES=$(git diff --name-only $BASE $HEAD -- '**/*.yml' '**/*.yaml' | tr '\n' ',')
|
||||
echo "changed_files=$FILES" >> $GITHUB_ENV
|
||||
if [[ -n "$FILES" ]]; then
|
||||
echo "any_changed=true" >> $GITHUB_ENV
|
||||
else
|
||||
echo "any_changed=false" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
- name: Validate YAML
|
||||
if: steps.changed-files.outputs.any_changed == 'true'
|
||||
if: env.any_changed == 'true'
|
||||
run: |
|
||||
IFS=',' read -ra FILES <<< "${{ steps.changed-files.outputs.all_changed_files }}"
|
||||
IFS=',' read -ra FILES <<< "${{ env.changed_files }}"
|
||||
for file in "${FILES[@]}"; do
|
||||
if [[ "$file" =~ ^*\.yaml$ ]] || \
|
||||
[[ "$file" =~ ^ESPHome/*\.yaml$ ]]; then
|
||||
if [[ "$file" =~ ^.*\.yaml$ ]] || [[ "$file" =~ ^ESPHome/.*\.yaml$ ]]; then
|
||||
echo "Skipping $file"
|
||||
continue
|
||||
fi
|
||||
|
||||
88
.github/workflows/versioning.yml
vendored
88
.github/workflows/versioning.yml
vendored
@@ -4,7 +4,6 @@
|
||||
# 2. Manual dispatch - allows independent control over stable and latest tags
|
||||
|
||||
---
|
||||
|
||||
name: Version and Tags
|
||||
|
||||
on: # yamllint disable-line rule:truthy
|
||||
@@ -42,11 +41,84 @@ jobs:
|
||||
git config user.name "GitHub Actions"
|
||||
git config user.email "actions@github.com"
|
||||
|
||||
- name: Get PR information
|
||||
id: pr_info
|
||||
if: github.event_name == 'push'
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
try {
|
||||
// Use GitHub's reliable API to find PRs associated with this commit
|
||||
const { data: associatedPRs } = await github.rest.repos.listPullRequestsAssociatedWithCommit({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
commit_sha: context.sha
|
||||
});
|
||||
|
||||
if (associatedPRs.length > 0) {
|
||||
// Get the most recent merged PR
|
||||
const pr = associatedPRs.find(pr => pr.state === 'closed' && pr.merged_at) || associatedPRs[0];
|
||||
|
||||
return {
|
||||
title: pr.title,
|
||||
body: pr.body || 'No description provided',
|
||||
number: pr.number,
|
||||
found: true
|
||||
};
|
||||
} else {
|
||||
// Fallback for direct pushes or when no PR is found
|
||||
const commit = await github.rest.repos.getCommit({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
ref: context.sha
|
||||
});
|
||||
|
||||
return {
|
||||
title: 'Direct push to main',
|
||||
body: commit.data.commit.message,
|
||||
number: null,
|
||||
found: false
|
||||
};
|
||||
}
|
||||
} catch (error) {
|
||||
console.log('Could not get PR info:', error.message);
|
||||
return {
|
||||
title: 'Version update',
|
||||
body: 'Automated version bump',
|
||||
number: null,
|
||||
found: false
|
||||
};
|
||||
}
|
||||
|
||||
- name: Bump version
|
||||
run: |
|
||||
chmod +x ./versioning/bump_version.sh
|
||||
./versioning/bump_version.sh
|
||||
|
||||
- name: Create tag message
|
||||
id: tag_message
|
||||
run: |
|
||||
NEW_VERSION=$(cat ./versioning/VERSION)
|
||||
|
||||
if [ "${{ github.event_name }}" == "push" ] && [ "${{ steps.pr_info.outcome }}" == "success" ]; then
|
||||
# Use PR information directly in heredoc to avoid quoting issues
|
||||
cat > tag_message.txt << EOF
|
||||
# v${NEW_VERSION} - ${{ fromJson(steps.pr_info.outputs.result).title }}
|
||||
|
||||
${{ fromJson(steps.pr_info.outputs.result).body }}
|
||||
EOF
|
||||
else
|
||||
# Manual dispatch or PR info unavailable - simpler message
|
||||
cat > tag_message.txt << EOF
|
||||
# v${NEW_VERSION} - Manual tag update
|
||||
|
||||
Tag updated via manual workflow dispatch.
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Store the message for use in subsequent steps
|
||||
echo "TAG_MESSAGE_FILE=tag_message.txt" >> $GITHUB_ENV
|
||||
|
||||
- name: Push Changes and Tags
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -73,10 +145,10 @@ jobs:
|
||||
echo "Backing up current stable tag ($OLD_STABLE)"
|
||||
fi
|
||||
|
||||
# Update tag
|
||||
# Update tag with detailed message
|
||||
NEW_VERSION=$(cat ./versioning/VERSION)
|
||||
echo "Updating stable tag to $NEW_VERSION"
|
||||
git tag -fa stable -m "Update stable tag"
|
||||
git tag -fa stable -F "$TAG_MESSAGE_FILE"
|
||||
git push origin stable --force
|
||||
|
||||
- name: Update latest tag
|
||||
@@ -98,9 +170,15 @@ jobs:
|
||||
echo "Backing up current latest tag ($OLD_LATEST)"
|
||||
fi
|
||||
|
||||
# Update tag
|
||||
# Update tag with detailed message
|
||||
NEW_VERSION=$(cat ./versioning/VERSION)
|
||||
echo "Updating latest tag to $NEW_VERSION"
|
||||
git tag -fa latest -m "Update latest tag"
|
||||
git tag -fa latest -F "$TAG_MESSAGE_FILE"
|
||||
git push origin latest --force
|
||||
|
||||
- name: Cleanup
|
||||
if: always()
|
||||
run: |
|
||||
# Clean up temporary files
|
||||
[ -f tag_message.txt ] && rm tag_message.txt || true
|
||||
...
|
||||
|
||||
5
.test/common.yaml
Normal file
5
.test/common.yaml
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
...
|
||||
8
.test/common_ard.yaml
Normal file
8
.test/common_ard.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
packages:
|
||||
common: !include common.yaml
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
type: arduino
|
||||
...
|
||||
8
.test/common_idf.yaml
Normal file
8
.test/common_idf.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
packages:
|
||||
common: !include common.yaml
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
type: esp-idf
|
||||
...
|
||||
@@ -1,8 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
basic_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml # Basic package
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
type: arduino
|
||||
common_arduino: !include common_ard.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard.yaml
|
||||
...
|
||||
|
||||
8
.test/esphome_ard_ble_proxy.yaml
Normal file
8
.test/esphome_ard_ble_proxy.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
packages:
|
||||
common_arduino: !include common_ard.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard.yaml
|
||||
|
||||
bluetooth_proxy:
|
||||
...
|
||||
5
.test/esphome_ard_core.yaml
Normal file
5
.test/esphome_ard_core.yaml
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
packages:
|
||||
common_arduino: !include common_ard.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
...
|
||||
6
.test/esphome_ard_hw_relays.yaml
Normal file
6
.test/esphome_ard_hw_relays.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_arduino: !include common_ard.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_hw_relays_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml
|
||||
...
|
||||
6
.test/esphome_ard_hw_speaker.yaml
Normal file
6
.test/esphome_ard_hw_speaker.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_arduino: !include common_ard.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_hw_speaker_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml
|
||||
...
|
||||
6
.test/esphome_ard_hw_vibration.yaml
Normal file
6
.test/esphome_ard_hw_vibration.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_arduino: !include common_ard.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_hw_vibration_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_vibration.yaml
|
||||
...
|
||||
@@ -1,11 +0,0 @@
|
||||
---
|
||||
packages:
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
addon_bluetooth_proxy: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_addon_ble_proxy.yaml
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
type: esp-idf
|
||||
version: 5.3.1
|
||||
platform_version: 6.9.0
|
||||
...
|
||||
6
.test/esphome_idf_basic.yaml
Normal file
6
.test/esphome_idf_basic.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_idf: !include common_idf.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard.yaml
|
||||
...
|
||||
8
.test/esphome_idf_ble_proxy.yaml
Normal file
8
.test/esphome_idf_ble_proxy.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
packages:
|
||||
common: !include common.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard.yaml
|
||||
|
||||
bluetooth_proxy:
|
||||
...
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
packages:
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
addon_bluetooth_proxy: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_addon_ble_proxy.yaml
|
||||
...
|
||||
5
.test/esphome_idf_core.yaml
Normal file
5
.test/esphome_idf_core.yaml
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
packages:
|
||||
common_idf: !include common_idf.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
...
|
||||
6
.test/esphome_idf_hw_relays.yaml
Normal file
6
.test/esphome_idf_hw_relays.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_idf: !include common_idf.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_hw_relays_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml
|
||||
...
|
||||
6
.test/esphome_idf_hw_speaker.yaml
Normal file
6
.test/esphome_idf_hw_speaker.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_idf: !include common_idf.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_hw_speaker_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml
|
||||
...
|
||||
6
.test/esphome_idf_hw_vibration.yaml
Normal file
6
.test/esphome_idf_hw_vibration.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
packages:
|
||||
common_idf: !include common_idf.yaml
|
||||
core_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard_hw_vibration_package: !include ../ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_vibration.yaml
|
||||
...
|
||||
BIN
Assets/Logo_dark.png
Normal file
BIN
Assets/Logo_dark.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 KiB |
BIN
Assets/Logo_dark.webp
Normal file
BIN
Assets/Logo_dark.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 261 KiB |
BIN
Assets/Logo_light.png
Normal file
BIN
Assets/Logo_light.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
@@ -2,7 +2,7 @@
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome Core - Hardware - Speaker #####
|
||||
##### Purpose: ESPHome Basic (includes core plus non-essential, but recommended packages) #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
@@ -11,19 +11,9 @@
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
i2s_audio:
|
||||
id: if_i2s_audio
|
||||
i2s_bclk_pin: GPIO2
|
||||
i2s_lrclk_pin: GPIO4
|
||||
|
||||
media_player:
|
||||
- id: mp_speaker
|
||||
name: Speaker
|
||||
platform: i2s_audio
|
||||
i2s_dout_pin: GPIO15
|
||||
i2s_audio_id: if_i2s_audio
|
||||
i2s_comm_fmt: lsb
|
||||
dac_type: external
|
||||
mode: mono
|
||||
internal: false
|
||||
packages:
|
||||
# yamllint disable rule:colons
|
||||
core: !include TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
standard: !include TX-Ultimate-Easy-ESPHome_standard.yaml
|
||||
# yamllint enable rule:colons
|
||||
...
|
||||
@@ -2,48 +2,22 @@
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome Core - Add-on - BLE Proxy #####
|
||||
##### Purpose: ESPHome Core - Add-on - BLE Proxy (REMOVED) #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### NOTE: #####
|
||||
##### - Make changes ONLY if absolutely necessary and you have the required knowledge. #####
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
##### REMOVAL NOTICE: #####
|
||||
##### This package has been removed. Please update your configuration. #####
|
||||
##### Add BLE proxy functionality directly in your YAML configuration instead: #####
|
||||
##### bluetooth_proxy: #####
|
||||
####################################################################################################
|
||||
---
|
||||
bluetooth_proxy:
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
type: esp-idf
|
||||
sdkconfig_options:
|
||||
CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST: "y"
|
||||
CONFIG_BT_BLE_DYNAMIC_ENV_MEMORY: "y"
|
||||
CONFIG_ESP32_REV_MIN_3: "y"
|
||||
CONFIG_MBEDTLS_DYNAMIC_BUFFER: "y"
|
||||
CONFIG_MBEDTLS_DYNAMIC_FREE_CA_CERT: "y"
|
||||
CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA: "y"
|
||||
CONFIG_MBEDTLS_EXTERNAL_MEM_ALLOC: "y"
|
||||
CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY: "y"
|
||||
CONFIG_SPIRAM_RODATA: "y"
|
||||
CONFIG_SPIRAM_TRY_ALLOCATE_WIFI_LWIP: "y"
|
||||
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_ADDON_BLE_PROXY
|
||||
|
||||
i2s_audio: !remove
|
||||
|
||||
light:
|
||||
- id: !extend light_full
|
||||
platform: esp32_rmt_led_strip
|
||||
rgb_order: GRB
|
||||
rmt_channel: 0
|
||||
chipset: ws2812
|
||||
type: !remove
|
||||
variant: !remove
|
||||
max_refresh_rate: 33ms
|
||||
|
||||
media_player: !remove
|
||||
# Trigger the error at compile time
|
||||
script:
|
||||
- id: force_compilation_error
|
||||
then:
|
||||
- lambda: |-
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_addon_ble_proxy.yaml has been removed." \
|
||||
"Please remove this package from your configuration and add" \
|
||||
"'bluetooth_proxy:' directly to your YAML instead."
|
||||
...
|
||||
|
||||
@@ -11,183 +11,11 @@
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
substitutions:
|
||||
name: tx-ultimate-easy
|
||||
friendly_name: TX Ultimate Easy
|
||||
|
||||
<<: !include ../versioning/VERSION_YAML
|
||||
|
||||
TX_MODEL_FORMAT_EU_TEXT: "EU (Square, T5-xC-86)"
|
||||
TX_MODEL_FORMAT_US_TEXT: "US (Rectangle, T5-xC-120)"
|
||||
|
||||
TX_MODEL_1_GANG_TEXT: "1 Gang"
|
||||
TX_MODEL_2_GANG_TEXT: "2 Gang"
|
||||
TX_MODEL_3_GANG_TEXT: "3 Gang"
|
||||
TX_MODEL_4_GANG_TEXT: "4 Gang"
|
||||
|
||||
packages:
|
||||
# yamllint disable rule:colons
|
||||
core_api: !include TX-Ultimate-Easy-ESPHome_core_api.yaml
|
||||
core_hw_buttons: !include TX-Ultimate-Easy-ESPHome_core_hw_buttons.yaml
|
||||
core_hw_leds: !include TX-Ultimate-Easy-ESPHome_core_hw_leds.yaml
|
||||
core_hw_relays: !include TX-Ultimate-Easy-ESPHome_core_hw_relays.yaml
|
||||
core_hw_speaker: !include TX-Ultimate-Easy-ESPHome_core_hw_speaker.yaml
|
||||
core_hw_touch: !include TX-Ultimate-Easy-ESPHome_core_hw_touch.yaml
|
||||
core_hw_vibration: !include TX-Ultimate-Easy-ESPHome_core_hw_vibration.yaml
|
||||
core_common: !include TX-Ultimate-Easy-ESPHome_core_common.yaml
|
||||
core_hw_buttons: !include TX-Ultimate-Easy-ESPHome_core_hw_buttons.yaml
|
||||
core_hw_leds: !include TX-Ultimate-Easy-ESPHome_core_hw_leds.yaml
|
||||
core_hw_touch: !include TX-Ultimate-Easy-ESPHome_core_hw_touch.yaml
|
||||
# yamllint enable rule:colons
|
||||
|
||||
button:
|
||||
- id: bt_restart
|
||||
name: Restart
|
||||
internal: false
|
||||
platform: restart
|
||||
|
||||
captive_portal:
|
||||
id: ap_captive_portal
|
||||
|
||||
esp32:
|
||||
board: esp32dev
|
||||
flash_size: 8MB
|
||||
|
||||
esphome:
|
||||
name: ${name}
|
||||
friendly_name: ${friendly_name}
|
||||
comment: TX Ultimate Easy
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_CORE
|
||||
|
||||
on_boot:
|
||||
- priority: 700
|
||||
then:
|
||||
- script.execute: boot_initialize
|
||||
|
||||
- priority: 600 # This is where most sensors are set up.
|
||||
then:
|
||||
- script.execute: boot_sequence
|
||||
|
||||
- priority: -100 # At this priority, pretty much everything should already be initialized.
|
||||
then:
|
||||
- script.execute: boot_done
|
||||
|
||||
improv_serial:
|
||||
id: serial_improv
|
||||
|
||||
logger:
|
||||
level: DEBUG
|
||||
|
||||
ota:
|
||||
platform: esphome
|
||||
|
||||
psram:
|
||||
|
||||
script:
|
||||
- id: boot_done
|
||||
mode: restart
|
||||
then:
|
||||
- script.execute:
|
||||
id: send_event_to_ha
|
||||
component: boot
|
||||
event: done
|
||||
|
||||
- id: boot_initialize
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
# - HW Relays
|
||||
# - HW Touch
|
||||
- script.execute:
|
||||
id: send_event_to_ha
|
||||
component: boot
|
||||
event: start
|
||||
|
||||
- id: boot_sequence
|
||||
mode: restart
|
||||
then:
|
||||
- script.execute: publish_device_info
|
||||
|
||||
- id: publish_device_info
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
tx_fw_version->publish_state("${version}");
|
||||
tx_device_name->publish_state(App.get_name().c_str());
|
||||
|
||||
select:
|
||||
- id: sl_tx_model_format
|
||||
name: Model (Format)
|
||||
platform: template
|
||||
options:
|
||||
- "${TX_MODEL_FORMAT_EU_TEXT}"
|
||||
- "${TX_MODEL_FORMAT_US_TEXT}"
|
||||
initial_option: "${TX_MODEL_FORMAT_EU_TEXT}"
|
||||
optimistic: true
|
||||
restore_value: true
|
||||
internal: false
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:tablet-cellphone
|
||||
|
||||
- id: sl_tx_model_gang
|
||||
name: Model (Gang)
|
||||
platform: template
|
||||
options:
|
||||
- "${TX_MODEL_1_GANG_TEXT}"
|
||||
- "${TX_MODEL_2_GANG_TEXT}"
|
||||
- "${TX_MODEL_3_GANG_TEXT}"
|
||||
- "${TX_MODEL_4_GANG_TEXT}"
|
||||
initial_option: "${TX_MODEL_1_GANG_TEXT}"
|
||||
optimistic: true
|
||||
restore_value: true
|
||||
internal: false
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:dip-switch
|
||||
|
||||
text_sensor:
|
||||
- id: tx_fw_version
|
||||
name: Firmware version
|
||||
platform: template
|
||||
entity_category: diagnostic
|
||||
icon: mdi:tag-text-outline
|
||||
internal: false
|
||||
update_interval: never
|
||||
lambda: |-
|
||||
return {"${version}"};
|
||||
|
||||
- id: tx_device_name
|
||||
name: Device Name
|
||||
platform: template
|
||||
icon: mdi:identifier
|
||||
entity_category: diagnostic
|
||||
internal: false
|
||||
disabled_by_default: false
|
||||
update_interval: never
|
||||
lambda: |-
|
||||
return {"${name}"};
|
||||
filters:
|
||||
- lambda: |-
|
||||
const std::string raw_name = x;
|
||||
std::string result;
|
||||
bool last_was_underscore = false;
|
||||
for (const char& c : raw_name) {
|
||||
if (isalnum(c)) {
|
||||
result += tolower(c); // Add alphanumeric characters as lowercase
|
||||
last_was_underscore = false;
|
||||
} else if (!last_was_underscore) { // Replace non-alphanumeric with '_' but avoid consecutive '_'
|
||||
result += '_';
|
||||
last_was_underscore = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
|
||||
time:
|
||||
- id: time_source
|
||||
platform: homeassistant
|
||||
|
||||
web_server:
|
||||
|
||||
wifi:
|
||||
ap:
|
||||
...
|
||||
|
||||
378
ESPHome/TX-Ultimate-Easy-ESPHome_core_common.yaml
Normal file
378
ESPHome/TX-Ultimate-Easy-ESPHome_core_common.yaml
Normal file
@@ -0,0 +1,378 @@
|
||||
####################################################################################################
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome Core - Common #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### NOTE: #####
|
||||
##### - Make changes ONLY if absolutely necessary and you have the required knowledge. #####
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
substitutions:
|
||||
name: tx-ultimate-easy
|
||||
friendly_name: TX Ultimate Easy
|
||||
|
||||
<<: !include ../versioning/VERSION_YAML
|
||||
|
||||
EVENT_NAME: esphome.tx_ultimate_easy
|
||||
|
||||
TX_MODEL_FORMAT_EU_TEXT: "EU (Square, T5-xC-86)"
|
||||
TX_MODEL_FORMAT_US_TEXT: "US (Rectangle, T5-xC-120)"
|
||||
|
||||
TX_MODEL_1_GANG_TEXT: "1 Gang"
|
||||
TX_MODEL_2_GANG_TEXT: "2 Gang"
|
||||
TX_MODEL_3_GANG_TEXT: "3 Gang"
|
||||
TX_MODEL_4_GANG_TEXT: "4 Gang"
|
||||
|
||||
DUMP_CONFIG_CALLER_DELAY: 5s # Delay to dump config after requested
|
||||
|
||||
TAG_CORE_COMMON: core.common
|
||||
|
||||
api:
|
||||
id: api_server
|
||||
on_client_connected:
|
||||
then:
|
||||
- script.execute: dump_config_caller
|
||||
- script.execute: publish_device_info
|
||||
|
||||
binary_sensor:
|
||||
- id: bs_pending_restart
|
||||
name: Pending Restart Status
|
||||
internal: false
|
||||
disabled_by_default: false
|
||||
platform: template
|
||||
entity_category: diagnostic
|
||||
device_class: problem
|
||||
on_state:
|
||||
then:
|
||||
- script.execute: dump_config_caller
|
||||
|
||||
- id: bs_boot_completed
|
||||
name: Boot Completed
|
||||
internal: false
|
||||
disabled_by_default: false
|
||||
platform: template
|
||||
entity_category: diagnostic
|
||||
device_class: connectivity
|
||||
icon: mdi:rocket-launch
|
||||
on_state:
|
||||
then:
|
||||
- script.execute: dump_config_caller
|
||||
|
||||
button:
|
||||
- id: bt_restart
|
||||
name: Restart
|
||||
internal: false
|
||||
platform: restart
|
||||
|
||||
esp32:
|
||||
board: esp32dev
|
||||
flash_size: 8MB
|
||||
framework:
|
||||
type: esp-idf
|
||||
|
||||
esphome:
|
||||
name: ${name}
|
||||
friendly_name: ${friendly_name}
|
||||
comment: TX Ultimate Easy
|
||||
min_version: 2025.8.0
|
||||
project:
|
||||
name: "edwardtfn.tx_ultimate_easy"
|
||||
version: ${version}
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_CORE_COMMON
|
||||
|
||||
on_boot:
|
||||
- priority: 1000 # Very early in boot process
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_boot_completed
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
- priority: 750
|
||||
then:
|
||||
- script.execute: restore_from_nvs
|
||||
|
||||
- priority: 700
|
||||
then:
|
||||
- script.execute: boot_initialize
|
||||
|
||||
- priority: 600 # This is where most sensors are set up.
|
||||
then:
|
||||
- script.execute: boot_sequence
|
||||
|
||||
- priority: -100 # At this priority, pretty much everything should already be initialized.
|
||||
then:
|
||||
- script.execute: boot_done
|
||||
|
||||
external_components:
|
||||
- source:
|
||||
type: git
|
||||
url: https://github.com/edwardtfn/TX-Ultimate-Easy
|
||||
ref: v${version}
|
||||
refresh: 1h
|
||||
components:
|
||||
- tx_ultimate_easy
|
||||
|
||||
globals:
|
||||
- id: gang_count
|
||||
type: uint8_t
|
||||
restore_value: true
|
||||
initial_value: '0'
|
||||
|
||||
- id: is_us_model
|
||||
type: bool
|
||||
restore_value: true
|
||||
initial_value: 'false'
|
||||
|
||||
logger:
|
||||
level: DEBUG
|
||||
|
||||
ota:
|
||||
platform: esphome
|
||||
|
||||
psram:
|
||||
|
||||
script:
|
||||
- id: api_send_ha_event_boot
|
||||
mode: queued
|
||||
parameters:
|
||||
type: string
|
||||
then:
|
||||
- lambda: |-
|
||||
// Send event to Home Assistant
|
||||
esphome::api::CustomAPIDevice ha_event;
|
||||
ha_event.fire_homeassistant_event("${EVENT_NAME}", {
|
||||
{"device_name", id(tx_device_name).state.c_str()},
|
||||
{"firmware", "${version}"},
|
||||
{"domain", "boot"},
|
||||
{"type", type.c_str()}
|
||||
});
|
||||
|
||||
- id: boot_done
|
||||
mode: restart
|
||||
then:
|
||||
- script.wait: restore_from_nvs
|
||||
- script.wait: boot_initialize
|
||||
- script.wait: boot_sequence
|
||||
- script.execute:
|
||||
id: api_send_ha_event_boot
|
||||
type: done
|
||||
- script.wait: api_send_ha_event_boot
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_boot_completed
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
|
||||
- id: boot_initialize
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
# - HW Relays
|
||||
# - HW Touch
|
||||
- script.execute:
|
||||
id: api_send_ha_event_boot
|
||||
type: start
|
||||
- wait_until:
|
||||
condition:
|
||||
- lambda: return sl_tx_model_format->active_index().has_value();
|
||||
- lambda: return sl_tx_model_gang->active_index().has_value();
|
||||
- lambda: |-
|
||||
id(is_us_model) = (sl_tx_model_format->state == "${TX_MODEL_FORMAT_US_TEXT}");
|
||||
id(gang_count) = sl_tx_model_gang->active_index().value() + 1;
|
||||
if (id(gang_count) < 1 || id(gang_count) > 4) {
|
||||
ESP_LOGE("${TAG_CORE_COMMON}", "Invalid number of gangs: %" PRIu8, id(gang_count));
|
||||
}
|
||||
|
||||
- id: boot_sequence
|
||||
mode: restart
|
||||
then:
|
||||
- script.execute: publish_device_info
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_pending_restart
|
||||
state: false
|
||||
|
||||
- id: dump_config
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by all modules
|
||||
- lambda: |-
|
||||
// Device identification
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Device friendly name: ${friendly_name}");
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Device name: ${name}");
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Device name (HA): %s", tx_device_name->state.c_str());
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Device hostname: %s", App.get_name().c_str());
|
||||
|
||||
dump_config_versions->execute();
|
||||
|
||||
// Framework detection
|
||||
#ifdef USE_ARDUINO
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Framework: Arduino");
|
||||
#elif defined(USE_ESP_IDF)
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Framework: ESP-IDF");
|
||||
#else
|
||||
ESP_LOGW("${TAG_CORE_COMMON}", "Framework: UNKNOWN");
|
||||
#endif
|
||||
|
||||
// Model configuration
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Model format (selected): %s",
|
||||
sl_tx_model_format->state.c_str());
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Model format (detected): %s",
|
||||
id(is_us_model) ? "US" : "EU");
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Gangs (selected): %s",
|
||||
sl_tx_model_gang->state.c_str());
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Gangs (detected): %" PRIu8 "-Gang%s",
|
||||
id(gang_count), id(gang_count) > 1 ? "s" : "");
|
||||
|
||||
// Boot completion status
|
||||
if (bs_boot_completed->state)
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Boot completed: Yes");
|
||||
else
|
||||
ESP_LOGW("${TAG_CORE_COMMON}", "Boot completed: NO");
|
||||
|
||||
// System state
|
||||
if (bs_pending_restart->state)
|
||||
ESP_LOGW("${TAG_CORE_COMMON}", "Pending restart: YES");
|
||||
else
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "Pending restart: No");
|
||||
|
||||
- id: dump_config_caller
|
||||
mode: restart
|
||||
then:
|
||||
- delay: ${DUMP_CONFIG_CALLER_DELAY}
|
||||
- script.execute: dump_config
|
||||
- script.wait: dump_config
|
||||
- script.execute: dump_config_list_packages
|
||||
|
||||
- id: dump_config_list_packages
|
||||
mode: restart
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, "Installed packages:");
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Core");
|
||||
|
||||
- id: dump_config_versions
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
// Version information
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "TX Ultimate firmware version: ${version}");
|
||||
// ESPHome builder information
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "ESPHome builder: " ESPHOME_VERSION);
|
||||
ESP_LOGCONFIG("${TAG_CORE_COMMON}", "ESPHome build timestamp: %s", App.get_compilation_time().c_str());
|
||||
|
||||
- id: publish_device_info
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
tx_fw_version->publish_state("${version}");
|
||||
tx_device_name->publish_state(App.get_name().c_str());
|
||||
|
||||
- id: restore_from_nvs
|
||||
mode: single
|
||||
then:
|
||||
- select.set_index:
|
||||
id: sl_tx_model_format
|
||||
index: !lambda if (id(is_us_model)) return 1; else return 0;
|
||||
- select.set_index:
|
||||
id: sl_tx_model_gang
|
||||
index: !lambda |-
|
||||
if (id(gang_count) < 1 || id(gang_count) > 4) return 0; // default to 1-Gang
|
||||
return static_cast<uint8_t>(id(gang_count)) - 1;
|
||||
|
||||
select:
|
||||
- id: sl_tx_model_format
|
||||
name: Model (Format)
|
||||
platform: template
|
||||
options:
|
||||
- "${TX_MODEL_FORMAT_EU_TEXT}"
|
||||
- "${TX_MODEL_FORMAT_US_TEXT}"
|
||||
initial_option: "${TX_MODEL_FORMAT_EU_TEXT}"
|
||||
optimistic: true
|
||||
restore_value: false
|
||||
internal: false
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:tablet-cellphone
|
||||
on_value:
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_pending_restart
|
||||
state: true
|
||||
- lambda: |-
|
||||
id(is_us_model) = (x == "${TX_MODEL_FORMAT_US_TEXT}");
|
||||
|
||||
- id: sl_tx_model_gang
|
||||
name: Model (Gang)
|
||||
platform: template
|
||||
options:
|
||||
- "${TX_MODEL_1_GANG_TEXT}"
|
||||
- "${TX_MODEL_2_GANG_TEXT}"
|
||||
- "${TX_MODEL_3_GANG_TEXT}"
|
||||
- "${TX_MODEL_4_GANG_TEXT}"
|
||||
initial_option: "${TX_MODEL_1_GANG_TEXT}"
|
||||
optimistic: true
|
||||
restore_value: false
|
||||
internal: false
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:dip-switch
|
||||
on_value:
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_pending_restart
|
||||
state: true
|
||||
- lambda: |-
|
||||
id(gang_count) = static_cast<uint8_t>(i) + 1;
|
||||
tx_ultimate->set_gang_count(id(gang_count));
|
||||
|
||||
text_sensor:
|
||||
- id: tx_fw_version
|
||||
name: TX Ultimate Easy Firmware Version
|
||||
platform: template
|
||||
entity_category: diagnostic
|
||||
icon: mdi:tag-text-outline
|
||||
internal: false
|
||||
update_interval: never
|
||||
lambda: |-
|
||||
return {"${version}"};
|
||||
|
||||
- id: tx_device_name
|
||||
name: Device Name
|
||||
platform: template
|
||||
icon: mdi:identifier
|
||||
entity_category: diagnostic
|
||||
internal: false
|
||||
disabled_by_default: false
|
||||
update_interval: never
|
||||
lambda: |-
|
||||
return {"${name}"};
|
||||
filters:
|
||||
- lambda: |-
|
||||
const std::string raw_name = x;
|
||||
std::string result;
|
||||
bool last_was_underscore = false;
|
||||
for (const char& c : raw_name) {
|
||||
if (isalnum(c)) {
|
||||
result += tolower(c); // Add alphanumeric characters as lowercase
|
||||
last_was_underscore = false;
|
||||
} else if (!last_was_underscore) { // Replace non-alphanumeric with '_' but avoid consecutive '_'
|
||||
result += '_';
|
||||
last_was_underscore = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
|
||||
tx_ultimate_easy:
|
||||
id: tx_ultimate
|
||||
|
||||
wifi:
|
||||
id: wifi_component
|
||||
...
|
||||
@@ -19,6 +19,10 @@ substitutions:
|
||||
BUTTON_2_ACTION_TEXT: "Relay 2 (toggle)"
|
||||
BUTTON_3_ACTION_TEXT: "Relay 3 (toggle)"
|
||||
BUTTON_4_ACTION_TEXT: "Relay 4 (toggle)"
|
||||
BUTTON_1_ACTION_FAILSAFE_TEXT: "Relay 1 (API failsafe only)"
|
||||
BUTTON_2_ACTION_FAILSAFE_TEXT: "Relay 2 (API failsafe only)"
|
||||
BUTTON_3_ACTION_FAILSAFE_TEXT: "Relay 3 (API failsafe only)"
|
||||
BUTTON_4_ACTION_FAILSAFE_TEXT: "Relay 4 (API failsafe only)"
|
||||
|
||||
BUTTON_CLICK_MIN_LENGTH: '50' # The minimum duration the click should last, in msec
|
||||
BUTTON_CLICK_MAX_LENGTH: '350' # The maximum duration the click should last, in msec
|
||||
@@ -26,6 +30,14 @@ substitutions:
|
||||
BUTTON_PRESS_TIMEOUT: '10000' # Ignore if button is pressed for longer than this time, in msec
|
||||
BUTTON_LONG_PRESS_DELAY: '800' # The time to wait to consider a long press, in msec
|
||||
|
||||
# Button numbers constants
|
||||
BUTTON_1_ID: '1'
|
||||
BUTTON_2_ID: '2'
|
||||
BUTTON_3_ID: '3'
|
||||
BUTTON_4_ID: '4'
|
||||
|
||||
TAG_CORE_HW_BUTTONS: core.hw.buttons
|
||||
|
||||
binary_sensor:
|
||||
- &binary_sensor_button_base
|
||||
id: bs_button_2
|
||||
@@ -47,7 +59,20 @@ binary_sensor:
|
||||
internal: false
|
||||
<<: *binary_sensor_button_base
|
||||
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_CORE_HW_BUTTONS
|
||||
|
||||
globals:
|
||||
# Packed button actions - replaces 4 separate selects
|
||||
- id: button_actions_packed
|
||||
type: uint16_t
|
||||
restore_value: true
|
||||
initial_value: '4369' # Binary: 0001000100010001 = all buttons set to option 1 (default action)
|
||||
# Bit layout: [button4(4)][button3(4)][button2(4)][button1(4)]
|
||||
# Each button uses 4 bits: 0=None, 1=Toggle, 2=Failsafe, 3-15=Reserved for future options
|
||||
|
||||
- id: button_press_button
|
||||
type: uint8_t
|
||||
restore_value: false
|
||||
@@ -76,59 +101,107 @@ script:
|
||||
- id: boot_initialize_buttons
|
||||
mode: restart
|
||||
then:
|
||||
- wait_until:
|
||||
condition:
|
||||
- lambda: return sl_tx_model_gang->active_index().has_value();
|
||||
- lambda: |-
|
||||
const uint8_t num_gangs = (sl_tx_model_gang->active_index().has_value()) ?
|
||||
(sl_tx_model_gang->active_index().value() + 1) : 0;
|
||||
if (num_gangs < 1 || num_gangs > 4) {
|
||||
ESP_LOGE("core_hw_buttons", "Invalid number of gangs: %" PRIu8, num_gangs);
|
||||
return;
|
||||
}
|
||||
bs_button_1->publish_state(false);
|
||||
bs_button_1->set_internal(num_gangs < 1);
|
||||
sl_button_1_action->set_internal(num_gangs < 1);
|
||||
bs_button_1->set_internal(id(gang_count) < 1);
|
||||
sl_button_1_action->set_internal(id(gang_count) < 1);
|
||||
bs_button_2->publish_state(false);
|
||||
bs_button_2->set_internal(num_gangs < 2);
|
||||
sl_button_2_action->set_internal(num_gangs < 2);
|
||||
bs_button_2->set_internal(id(gang_count) < 2);
|
||||
sl_button_2_action->set_internal(id(gang_count) < 2);
|
||||
bs_button_3->publish_state(false);
|
||||
bs_button_3->set_internal(num_gangs < 3);
|
||||
sl_button_3_action->set_internal(num_gangs < 3);
|
||||
bs_button_3->set_internal(id(gang_count) < 3);
|
||||
sl_button_3_action->set_internal(id(gang_count) < 3);
|
||||
bs_button_4->publish_state(false);
|
||||
bs_button_4->set_internal(num_gangs < 4);
|
||||
sl_button_4_action->set_internal(num_gangs < 4);
|
||||
bs_button_4->set_internal(id(gang_count) < 4);
|
||||
sl_button_4_action->set_internal(id(gang_count) < 4);
|
||||
|
||||
- id: button_action
|
||||
mode: parallel
|
||||
parameters:
|
||||
component: string
|
||||
event: string
|
||||
button: uint8_t
|
||||
action: string
|
||||
count: uint8_t
|
||||
then:
|
||||
# Extended by:
|
||||
# - core_api
|
||||
- lambda: |-
|
||||
ESP_LOGI("core_hw_buttons", "Button '%s' action: '%s'", component.c_str(), event.c_str());
|
||||
// Send event to Home Assistant
|
||||
esphome::api::CustomAPIDevice ha_event;
|
||||
ha_event.fire_homeassistant_event("${EVENT_NAME}", {
|
||||
{"device_name", id(tx_device_name).state.c_str()},
|
||||
{"firmware", "${version}"},
|
||||
{"domain", "touch"},
|
||||
{"type", "button"},
|
||||
{"action", action.c_str()},
|
||||
{"button_id", std::to_string(button)},
|
||||
{"count", std::to_string(count)},
|
||||
{"position", std::to_string(id(button_press_position))}
|
||||
});
|
||||
ESP_LOGI("${TAG_CORE_HW_BUTTONS}", "Button %" PRIu8 " action: '%s'", button, action.c_str());
|
||||
if (action == "click") {
|
||||
switch (button) {
|
||||
case ${BUTTON_1_ID}:
|
||||
bs_button_1_click_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_2_ID}:
|
||||
bs_button_2_click_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_3_ID}:
|
||||
bs_button_3_click_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_4_ID}:
|
||||
bs_button_4_click_event->publish_state(true);
|
||||
break;
|
||||
}
|
||||
} else if (action == "double_click") {
|
||||
switch (button) {
|
||||
case ${BUTTON_1_ID}:
|
||||
bs_button_1_double_click_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_2_ID}:
|
||||
bs_button_2_double_click_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_3_ID}:
|
||||
bs_button_3_double_click_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_4_ID}:
|
||||
bs_button_4_double_click_event->publish_state(true);
|
||||
break;
|
||||
}
|
||||
} else if (action == "long_press") {
|
||||
switch (button) {
|
||||
case ${BUTTON_1_ID}:
|
||||
bs_button_1_long_press_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_2_ID}:
|
||||
bs_button_2_long_press_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_3_ID}:
|
||||
bs_button_3_long_press_event->publish_state(true);
|
||||
break;
|
||||
case ${BUTTON_4_ID}:
|
||||
bs_button_4_long_press_event->publish_state(true);
|
||||
break;
|
||||
}
|
||||
}
|
||||
id(button_press_button) = 0;
|
||||
id(click_counter) = 0;
|
||||
id(button_press_position) = 0;
|
||||
id(button_press_start_time) = 0;
|
||||
id(click_counter) = 0;
|
||||
buttons_release->execute();
|
||||
|
||||
- id: button_click_event
|
||||
mode: restart
|
||||
parameters:
|
||||
button_id: uint8_t
|
||||
button: uint8_t
|
||||
click_count: uint8_t
|
||||
then:
|
||||
- delay:
|
||||
milliseconds: ${BUTTON_MULTI_CLICK_DELAY}
|
||||
- lambda: |-
|
||||
const std::string button_name = "bs_button_" + std::to_string(button_id);
|
||||
std::string event_name;
|
||||
if (click_count == 1) event_name = "click";
|
||||
else if (click_count == 2) event_name = "double_click";
|
||||
else event_name = std::to_string(click_count) + "_click";
|
||||
button_action->execute(button_name.c_str(), event_name.c_str());
|
||||
else event_name = "multiple_click";
|
||||
button_action->execute(button, event_name.c_str(), click_count);
|
||||
|
||||
- id: buttons_release
|
||||
mode: restart
|
||||
@@ -143,6 +216,53 @@ script:
|
||||
}
|
||||
}
|
||||
|
||||
- id: !extend dump_config
|
||||
then:
|
||||
- lambda: |-
|
||||
std::string gang_count_plural_suffix = id(gang_count) > 1 ? "s" : "";
|
||||
// Button's actions
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_BUTTONS}", "Button%s action%s:",
|
||||
gang_count_plural_suffix.c_str(),
|
||||
gang_count_plural_suffix.c_str());
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_BUTTONS}", " Relay 1: %s", sl_button_1_action->has_state() ?
|
||||
sl_button_1_action->state.c_str() : "Unknown");
|
||||
if (id(gang_count) >= 2)
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_BUTTONS}", " Relay 2: %s", sl_button_2_action->has_state() ?
|
||||
sl_button_2_action->state.c_str() : "Unknown");
|
||||
if (id(gang_count) >= 3)
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_BUTTONS}", " Relay 3: %s", sl_button_3_action->has_state() ?
|
||||
sl_button_3_action->state.c_str() : "Unknown");
|
||||
if (id(gang_count) >= 4)
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_BUTTONS}", " Relay 4: %s", sl_button_4_action->has_state() ?
|
||||
sl_button_4_action->state.c_str() : "Unknown");
|
||||
|
||||
- id: !extend dump_config_list_packages
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
// Check for requirements
|
||||
#if !defined(TX_ULTIMATE_EASY_CORE_COMMON)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_core_common.yaml is required."
|
||||
#endif
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Core - Hardware - Buttons");
|
||||
|
||||
- id: !extend restore_from_nvs
|
||||
then:
|
||||
- select.set_index:
|
||||
id: sl_button_1_action
|
||||
index: !lambda return std::min((uint8_t)(id(button_actions_packed) & 0x0F), (uint8_t)2);
|
||||
- select.set_index:
|
||||
id: sl_button_2_action
|
||||
index: !lambda return std::min((uint8_t)((id(button_actions_packed) >> 4) & 0x0F), (uint8_t)2);
|
||||
- select.set_index:
|
||||
id: sl_button_3_action
|
||||
index: !lambda return std::min((uint8_t)((id(button_actions_packed) >> 8) & 0x0F), (uint8_t)2);
|
||||
- select.set_index:
|
||||
id: sl_button_4_action
|
||||
index: !lambda return std::min((uint8_t)((id(button_actions_packed) >> 12) & 0x0F), (uint8_t)2);
|
||||
|
||||
- id: !extend touch_on_multi_touch_release
|
||||
then:
|
||||
- script.execute: buttons_release
|
||||
@@ -151,30 +271,24 @@ script:
|
||||
then:
|
||||
- script.execute:
|
||||
id: touch_on_press_buttons
|
||||
touch_position: !lambda return touch_position;
|
||||
button: !lambda return button;
|
||||
position: !lambda return position;
|
||||
|
||||
- id: touch_on_press_buttons
|
||||
mode: restart
|
||||
parameters:
|
||||
touch_position: uint8_t
|
||||
button: uint8_t
|
||||
position: uint8_t
|
||||
then:
|
||||
- lambda: |-
|
||||
id(button_press_start_time) = millis();
|
||||
id(button_press_position) = touch_position;
|
||||
uint8_t button = 0;
|
||||
auto model_index = sl_tx_model_gang->active_index();
|
||||
if (model_index.has_value()) {
|
||||
const uint8_t model_idx = model_index.value() + 1; // Increment for 1-based indexing
|
||||
if (model_idx == 1) {
|
||||
button = 1; // Single button, always 1
|
||||
} else {
|
||||
const uint8_t width = ${TOUCH_POSITION_MAX_VALUE} / model_idx; // Width of each button region
|
||||
ESP_LOGV("core_hw_buttons", "Button regions: width=%" PRIu8 ", touch_position=%" PRIu8,
|
||||
width, touch_position);
|
||||
button = (touch_position / width) + 1; // Determine button region
|
||||
if (button > model_idx)
|
||||
button = model_idx; // Clamp to max button count
|
||||
}
|
||||
id(button_press_button) = button;
|
||||
// Update counters
|
||||
if (id(button_press_position) == position) {
|
||||
id(click_counter)++;
|
||||
} else {
|
||||
id(click_counter) = 1;
|
||||
id(button_press_position) = position;
|
||||
}
|
||||
// Update binary sensor
|
||||
switch (button) {
|
||||
@@ -191,13 +305,6 @@ script:
|
||||
bs_button_4->publish_state(true);
|
||||
break;
|
||||
}
|
||||
// Update counters
|
||||
if (id(button_press_button) == button) {
|
||||
id(click_counter)++;
|
||||
} else {
|
||||
id(click_counter) = 1;
|
||||
id(button_press_button) = button;
|
||||
}
|
||||
|
||||
- id: !extend touch_on_release
|
||||
then:
|
||||
@@ -208,19 +315,20 @@ script:
|
||||
id(button_press_start_time) < current_time) {
|
||||
uint32_t press_duration = current_time - id(button_press_start_time);
|
||||
// Handle overflow (optional, since it's unlikely to happen here)
|
||||
ESP_LOGI("core_hw_buttons", "Button press duration: %" PRIu32 " ms", press_duration);
|
||||
ESP_LOGI("${TAG_CORE_HW_BUTTONS}", "Button press duration: %" PRIu32 " ms", press_duration);
|
||||
if (press_duration < ${BUTTON_CLICK_MIN_LENGTH}) {
|
||||
ESP_LOGW("core_hw_buttons", "Ignoring button press (too short)");
|
||||
ESP_LOGW("${TAG_CORE_HW_BUTTONS}", "Ignoring button press (too short)");
|
||||
} else if (press_duration >= ${BUTTON_CLICK_MIN_LENGTH} and
|
||||
press_duration <= ${BUTTON_CLICK_MAX_LENGTH}) { // Short/normal click
|
||||
button_click_event->execute(id(button_press_button), id(click_counter));
|
||||
} else if (press_duration >= ${BUTTON_LONG_PRESS_DELAY} and press_duration <= ${BUTTON_PRESS_TIMEOUT}) {
|
||||
button_action->execute(("bs_button_" + std::to_string(id(button_press_button))).c_str(), "long_click");
|
||||
button_action->execute(id(button_press_button), "long_press", 1);
|
||||
} else if (press_duration > ${BUTTON_PRESS_TIMEOUT}) { // Timeout or invalid
|
||||
ESP_LOGW("core_hw_buttons", "Button press cancelled or timed out after ${BUTTON_PRESS_TIMEOUT} ms");
|
||||
ESP_LOGW("${TAG_CORE_HW_BUTTONS}",
|
||||
"Button press cancelled or timed out after ${BUTTON_PRESS_TIMEOUT} ms");
|
||||
}
|
||||
} else {
|
||||
ESP_LOGW("core_hw_buttons", "Press event timestamp not recorded yet");
|
||||
ESP_LOGW("${TAG_CORE_HW_BUTTONS}", "Press event timestamp not recorded yet");
|
||||
}
|
||||
id(button_press_start_time) = 0;
|
||||
|
||||
@@ -240,13 +348,19 @@ select:
|
||||
options:
|
||||
- "${BUTTON_ACTION_NONE_TEXT}"
|
||||
- "${BUTTON_1_ACTION_TEXT}"
|
||||
- "${BUTTON_1_ACTION_FAILSAFE_TEXT}"
|
||||
initial_option: "${BUTTON_1_ACTION_TEXT}"
|
||||
optimistic: true
|
||||
restore_value: true
|
||||
restore_value: false
|
||||
internal: true
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:dip-switch
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
id(button_actions_packed) = (id(button_actions_packed) & ~(0x0F << 0)) |
|
||||
((id(sl_button_1_action).active_index().value_or(1) & 0x0F) << 0);
|
||||
|
||||
- id: sl_button_2_action
|
||||
name: Button 2 action
|
||||
@@ -254,8 +368,14 @@ select:
|
||||
options:
|
||||
- "${BUTTON_ACTION_NONE_TEXT}"
|
||||
- "${BUTTON_2_ACTION_TEXT}"
|
||||
- "${BUTTON_2_ACTION_FAILSAFE_TEXT}"
|
||||
initial_option: "${BUTTON_2_ACTION_TEXT}"
|
||||
<<: *button_select_action_base
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
id(button_actions_packed) = (id(button_actions_packed) & ~(0x0F << 4)) |
|
||||
((id(sl_button_2_action).active_index().value_or(1) & 0x0F) << 4);
|
||||
|
||||
- id: sl_button_3_action
|
||||
name: Button 3 action
|
||||
@@ -263,8 +383,14 @@ select:
|
||||
options:
|
||||
- "${BUTTON_ACTION_NONE_TEXT}"
|
||||
- "${BUTTON_3_ACTION_TEXT}"
|
||||
- "${BUTTON_3_ACTION_FAILSAFE_TEXT}"
|
||||
initial_option: "${BUTTON_3_ACTION_TEXT}"
|
||||
<<: *button_select_action_base
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
id(button_actions_packed) = (id(button_actions_packed) & ~(0x0F << 8)) |
|
||||
((id(sl_button_3_action).active_index().value_or(1) & 0x0F) << 8);
|
||||
|
||||
- id: sl_button_4_action
|
||||
name: Button 4 action
|
||||
@@ -272,6 +398,12 @@ select:
|
||||
options:
|
||||
- "${BUTTON_ACTION_NONE_TEXT}"
|
||||
- "${BUTTON_4_ACTION_TEXT}"
|
||||
- "${BUTTON_4_ACTION_FAILSAFE_TEXT}"
|
||||
initial_option: "${BUTTON_4_ACTION_TEXT}"
|
||||
<<: *button_select_action_base
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
id(button_actions_packed) = (id(button_actions_packed) & ~(0x0F << 12)) |
|
||||
((id(sl_button_4_action).active_index().value_or(1) & 0x0F) << 12);
|
||||
...
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,283 +0,0 @@
|
||||
####################################################################################################
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome Core - Hardware - Relays #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### NOTE: #####
|
||||
##### - Make changes ONLY if absolutely necessary and you have the required knowledge. #####
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
globals:
|
||||
- id: boot_initialization_relays
|
||||
type: bool
|
||||
restore_value: false
|
||||
initial_value: 'false'
|
||||
|
||||
light:
|
||||
# These lights are used for the physical relays to be shown as lights
|
||||
- &light_binary_base
|
||||
id: light_output_1
|
||||
name: Light output 1
|
||||
output: output_relay_1
|
||||
platform: binary
|
||||
internal: true
|
||||
- id: light_output_2
|
||||
name: Light output 2
|
||||
output: output_relay_2
|
||||
<<: *light_binary_base
|
||||
- id: light_output_3
|
||||
name: Light output 3
|
||||
output: output_relay_3
|
||||
<<: *light_binary_base
|
||||
- id: light_output_4
|
||||
name: Light output 4
|
||||
output: output_relay_4
|
||||
<<: *light_binary_base
|
||||
|
||||
output:
|
||||
- id: output_relay_1
|
||||
platform: gpio
|
||||
pin: GPIO18
|
||||
|
||||
- id: output_relay_2
|
||||
platform: gpio
|
||||
pin: GPIO17
|
||||
|
||||
- id: output_relay_3
|
||||
platform: gpio
|
||||
pin: GPIO27
|
||||
|
||||
- id: output_relay_4
|
||||
platform: gpio
|
||||
pin: GPIO23
|
||||
|
||||
script:
|
||||
- id: !extend boot_initialize
|
||||
then:
|
||||
- script.execute: boot_initialize_relays
|
||||
|
||||
- id: boot_initialize_relays
|
||||
mode: restart
|
||||
then:
|
||||
- wait_until:
|
||||
condition:
|
||||
- lambda: return sl_tx_model_format->active_index().has_value();
|
||||
- lambda: return sl_tx_model_gang->active_index().has_value();
|
||||
- lambda: |-
|
||||
const bool is_model_us = sl_tx_model_format->active_index().has_value() and
|
||||
sl_tx_model_format->active_index().value() == 1;
|
||||
const uint8_t num_gangs = (sl_tx_model_gang->active_index().has_value()) ?
|
||||
(sl_tx_model_gang->active_index().value() + 1) : 0;
|
||||
if (num_gangs < 1 || num_gangs > 4) {
|
||||
ESP_LOGE("core_hw_relays", "Invalid number of gangs: %" PRIu8, num_gangs);
|
||||
return;
|
||||
}
|
||||
sl_relay_1_mode->set_internal(num_gangs < 1);
|
||||
sl_relay_1_light_mode_eu->set_internal(is_model_us or num_gangs < 1);
|
||||
sl_relay_1_light_mode_us->set_internal(!is_model_us or num_gangs < 1);
|
||||
sl_relay_2_mode->set_internal(num_gangs < 2);
|
||||
sl_relay_2_light_mode_eu->set_internal(is_model_us or num_gangs < 2);
|
||||
sl_relay_2_light_mode_us->set_internal(!is_model_us or num_gangs < 2);
|
||||
sl_relay_3_mode->set_internal(num_gangs < 3);
|
||||
sl_relay_3_light_mode_eu->set_internal(is_model_us or num_gangs < 3);
|
||||
sl_relay_3_light_mode_us->set_internal(!is_model_us or num_gangs < 3);
|
||||
sl_relay_4_mode->set_internal(num_gangs < 4);
|
||||
sl_relay_4_light_mode_eu->set_internal(is_model_us or num_gangs < 4);
|
||||
sl_relay_4_light_mode_us->set_internal(!is_model_us or num_gangs < 4);
|
||||
auto relay_mode_index = sl_relay_1_mode->active_index();
|
||||
if (relay_mode_index.has_value()) {
|
||||
light_output_1->set_internal(false or relay_mode_index.value() != 1);
|
||||
sw_relay_1->set_internal(false or relay_mode_index.value() != 0);
|
||||
}
|
||||
relay_mode_index = sl_relay_2_mode->active_index();
|
||||
if (relay_mode_index.has_value()) {
|
||||
light_output_2->set_internal(num_gangs < 2 or relay_mode_index.value() != 1);
|
||||
sw_relay_2->set_internal(num_gangs < 2 or relay_mode_index.value() != 0);
|
||||
}
|
||||
relay_mode_index = sl_relay_3_mode->active_index();
|
||||
if (relay_mode_index.has_value()) {
|
||||
light_output_3->set_internal(num_gangs < 3 or relay_mode_index.value() != 1);
|
||||
sw_relay_3->set_internal(num_gangs < 3 or relay_mode_index.value() != 0);
|
||||
}
|
||||
relay_mode_index = sl_relay_4_mode->active_index();
|
||||
if (relay_mode_index.has_value()) {
|
||||
light_output_4->set_internal(num_gangs < 4 or relay_mode_index.value() != 1);
|
||||
sw_relay_4->set_internal(num_gangs < 4 or relay_mode_index.value() != 0);
|
||||
}
|
||||
id(boot_initialization_relays) = true;
|
||||
|
||||
- id: !extend button_click_event
|
||||
then:
|
||||
- lambda: |-
|
||||
// Handle only single clicks
|
||||
if (click_count != 1)
|
||||
return;
|
||||
|
||||
// Ignore if other touch events are active
|
||||
if (bs_multi_touch->state ||
|
||||
bs_swipe_left->state ||
|
||||
bs_swipe_down->state ||
|
||||
bs_swipe_right->state) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Toggle relay if corresponding button action is enabled
|
||||
switch (button_id) {
|
||||
case 1:
|
||||
if (sl_button_1_action->active_index().has_value() and
|
||||
sl_button_1_action->active_index().value() == 1)
|
||||
sw_relay_1->toggle();
|
||||
break;
|
||||
case 2:
|
||||
if (sl_button_2_action->active_index().has_value() and
|
||||
sl_button_2_action->active_index().value() == 1)
|
||||
sw_relay_2->toggle();
|
||||
break;
|
||||
case 3:
|
||||
if (sl_button_3_action->active_index().has_value() and
|
||||
sl_button_3_action->active_index().value() == 1)
|
||||
sw_relay_3->toggle();
|
||||
break;
|
||||
case 4:
|
||||
if (sl_button_4_action->active_index().has_value() and
|
||||
sl_button_4_action->active_index().value() == 1)
|
||||
sw_relay_4->toggle();
|
||||
break;
|
||||
}
|
||||
|
||||
- id: show_relay_status
|
||||
mode: restart
|
||||
then:
|
||||
- script.wait: boot_initialize_relays
|
||||
- wait_until:
|
||||
condition:
|
||||
- lambda: return id(boot_initialization_relays);
|
||||
- lambda: |-
|
||||
const bool is_model_us = sl_tx_model_format->active_index().has_value() and
|
||||
sl_tx_model_format->active_index().value() == 1;
|
||||
const uint8_t num_gangs = (sl_tx_model_gang->active_index().has_value())
|
||||
? (sl_tx_model_gang->active_index().value() + 1)
|
||||
: 0;
|
||||
|
||||
if (num_gangs < 1 || num_gangs > 4) {
|
||||
ESP_LOGE("core_hw_relays", "Invalid number of gangs: %" PRIu8, num_gangs);
|
||||
return;
|
||||
}
|
||||
|
||||
for (uint8_t i = 0; i < num_gangs; i++) {
|
||||
bool relay_state = false;
|
||||
std::string light_mode;
|
||||
const std::string light_mode_group_1 = is_model_us
|
||||
? "${LIGHT_MODE_LEFT_TEXT}"
|
||||
: "${LIGHT_MODE_BOTTOM_TEXT}";
|
||||
const std::string light_mode_group_2 = is_model_us
|
||||
? "${LIGHT_MODE_RIGHT_TEXT}"
|
||||
: "${LIGHT_MODE_TOP_TEXT}";
|
||||
|
||||
// Determine relay state and light mode
|
||||
switch (i) {
|
||||
case 0:
|
||||
relay_state = id(sw_relay_1).state;
|
||||
light_mode = is_model_us
|
||||
? id(sl_relay_1_light_mode_us)->state
|
||||
: id(sl_relay_1_light_mode_eu)->state;
|
||||
break;
|
||||
case 1:
|
||||
relay_state = id(sw_relay_2).state;
|
||||
light_mode = is_model_us
|
||||
? id(sl_relay_2_light_mode_us)->state
|
||||
: id(sl_relay_2_light_mode_eu)->state;
|
||||
break;
|
||||
case 2:
|
||||
relay_state = id(sw_relay_3).state;
|
||||
light_mode = is_model_us
|
||||
? id(sl_relay_3_light_mode_us)->state
|
||||
: id(sl_relay_3_light_mode_eu)->state;
|
||||
break;
|
||||
case 3:
|
||||
relay_state = id(sw_relay_4).state;
|
||||
light_mode = is_model_us
|
||||
? id(sl_relay_4_light_mode_us)->state
|
||||
: id(sl_relay_4_light_mode_eu)->state;
|
||||
break;
|
||||
}
|
||||
|
||||
ESP_LOGV("core_hw_relays", "Relay %" PRIu8 " is %s", i + 1, relay_state ? "ON" : "OFF");
|
||||
ESP_LOGV("core_hw_relays", "Light Mode for Relay %" PRIu8 ": %s", i + 1, light_mode.c_str());
|
||||
|
||||
// Use light_set_state for light updates
|
||||
if (relay_state) {
|
||||
if (light_mode == light_mode_group_1 || light_mode == "${LIGHT_MODE_BOTH_TEXT}") {
|
||||
light_set_state->execute(1, i, true); // Left/bottom light
|
||||
}
|
||||
if (light_mode == light_mode_group_2 || light_mode == "${LIGHT_MODE_BOTH_TEXT}") {
|
||||
light_set_state->execute(2, i, true); // Right/top light
|
||||
}
|
||||
} else {
|
||||
light_set_state->execute(1, i, false); // Turn off left/bottom light
|
||||
light_set_state->execute(2, i, false); // Turn off right/top light
|
||||
}
|
||||
}
|
||||
|
||||
select:
|
||||
- &relay_select_mode_base
|
||||
id: sl_relay_1_mode
|
||||
name: Relay 1 mode
|
||||
platform: template
|
||||
options:
|
||||
- "Relay"
|
||||
- "Light"
|
||||
- "Not in use"
|
||||
optimistic: true
|
||||
restore_value: true
|
||||
internal: true
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:dip-switch
|
||||
|
||||
- id: sl_relay_2_mode
|
||||
name: Relay 2 mode
|
||||
<<: *relay_select_mode_base
|
||||
|
||||
- id: sl_relay_3_mode
|
||||
name: Relay 3 mode
|
||||
<<: *relay_select_mode_base
|
||||
|
||||
- id: sl_relay_4_mode
|
||||
name: Relay 4 mode
|
||||
<<: *relay_select_mode_base
|
||||
|
||||
switch:
|
||||
- &relay_switch_base
|
||||
id: sw_relay_1
|
||||
name: Relay 1
|
||||
platform: output
|
||||
output: output_relay_1
|
||||
restore_mode: RESTORE_DEFAULT_OFF
|
||||
internal: true
|
||||
on_turn_on:
|
||||
then:
|
||||
- script.execute: show_relay_status
|
||||
on_turn_off:
|
||||
then:
|
||||
- script.execute: show_relay_status
|
||||
|
||||
- id: sw_relay_2
|
||||
name: Relay 2
|
||||
output: output_relay_2
|
||||
<<: *relay_switch_base
|
||||
|
||||
- id: sw_relay_3
|
||||
name: Relay 3
|
||||
output: output_relay_3
|
||||
<<: *relay_switch_base
|
||||
|
||||
- id: sw_relay_4
|
||||
name: Relay 4
|
||||
output: output_relay_4
|
||||
<<: *relay_switch_base
|
||||
...
|
||||
@@ -14,64 +14,200 @@
|
||||
substitutions:
|
||||
TOUCH_POSITION_MAX_VALUE: '10' # Maximum touch position value returned by the touch pad via uart
|
||||
|
||||
TAG_CORE_HW_TOUCH: core.hw.touch
|
||||
|
||||
binary_sensor:
|
||||
- &bs_button_event_template
|
||||
id: bs_button_event_template
|
||||
icon: mdi:gesture-tap-box
|
||||
internal: true
|
||||
disabled_by_default: true
|
||||
platform: template
|
||||
|
||||
- id: bs_button_1_click_event
|
||||
name: Button 1 - Click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_1_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_2_click_event
|
||||
name: Button 2 - Click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_2_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_3_click_event
|
||||
name: Button 3 - Click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_3_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_4_click_event
|
||||
name: Button 4 - Click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_4_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
- id: bs_button_1_double_click_event
|
||||
name: Button 1 - Double-click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_1_double_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_2_double_click_event
|
||||
name: Button 2 - Double-click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_2_double_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_3_double_click_event
|
||||
name: Button 3 - Double-click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_3_double_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_4_double_click_event
|
||||
name: Button 4 - Double-click event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_4_double_click_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
- id: bs_button_1_long_press_event
|
||||
name: Button 1 - Long-press event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_1_long_press_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_2_long_press_event
|
||||
name: Button 2 - Long-press event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_2_long_press_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_3_long_press_event
|
||||
name: Button 3 - Long-press event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_3_long_press_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_button_4_long_press_event
|
||||
name: Button 4 - Long-press event
|
||||
internal: false
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_button_4_long_press_event
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
- id: bs_multi_touch
|
||||
name: Multi-touch
|
||||
name: Multi-touch event
|
||||
icon: mdi:gesture-two-tap
|
||||
internal: false
|
||||
platform: template
|
||||
on_click:
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- lambda: send_event_to_ha->execute("multi_touch", "multi_touch");
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_multi_touch
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
- id: bs_swipe_left
|
||||
name: Swipe left
|
||||
name: Swipe left event
|
||||
icon: mdi:gesture-swipe-left
|
||||
internal: true
|
||||
platform: template
|
||||
on_click:
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- lambda: send_event_to_ha->execute("swipe", "left");
|
||||
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_left
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_swipe_right
|
||||
name: Swipe right
|
||||
name: Swipe right event
|
||||
icon: mdi:gesture-swipe-right
|
||||
internal: true
|
||||
platform: template
|
||||
on_click:
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- lambda: send_event_to_ha->execute("swipe", "right");
|
||||
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_right
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_swipe_up
|
||||
name: Swipe up
|
||||
name: Swipe up event
|
||||
icon: mdi:gesture-swipe-up
|
||||
internal: true
|
||||
platform: template
|
||||
on_click:
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- lambda: send_event_to_ha->execute("swipe", "up");
|
||||
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_up
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- id: bs_swipe_down
|
||||
name: Swipe down
|
||||
name: Swipe down event
|
||||
icon: mdi:gesture-swipe-down
|
||||
internal: true
|
||||
platform: template
|
||||
on_click:
|
||||
<<: *bs_button_event_template
|
||||
on_press:
|
||||
then:
|
||||
- lambda: send_event_to_ha->execute("swipe", "down");
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_down
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
external_components:
|
||||
- source:
|
||||
type: git
|
||||
url: https://github.com/edwardtfn/TX-Ultimate-Easy
|
||||
ref: v${version}
|
||||
refresh: 1h
|
||||
components:
|
||||
- tx_ultimate_easy
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_CORE_HW_TOUCH
|
||||
|
||||
number:
|
||||
- id: nr_touch_duration
|
||||
name: Touch duration
|
||||
name: Touch event duration
|
||||
icon: mdi:timer-cog-outline
|
||||
unit_of_measurement: ms
|
||||
# mode: box
|
||||
@@ -91,6 +227,12 @@ script:
|
||||
- script.execute: boot_initialize_touch
|
||||
|
||||
- id: boot_initialize_touch
|
||||
mode: restart
|
||||
then:
|
||||
- script.execute: boot_initialize_touch_format
|
||||
- script.execute: boot_initialize_touch_gang
|
||||
|
||||
- id: boot_initialize_touch_format
|
||||
mode: restart
|
||||
then:
|
||||
- wait_until:
|
||||
@@ -109,25 +251,73 @@ script:
|
||||
bs_swipe_up->publish_state(false);
|
||||
bs_swipe_up->set_internal(!is_model_us);
|
||||
|
||||
- id: boot_initialize_touch_gang
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
tx_ultimate->set_gang_count(id(gang_count));
|
||||
bs_button_1_click_event->publish_state(false);
|
||||
bs_button_2_click_event->publish_state(false);
|
||||
bs_button_3_click_event->publish_state(false);
|
||||
bs_button_4_click_event->publish_state(false);
|
||||
bs_button_1_double_click_event->publish_state(false);
|
||||
bs_button_2_double_click_event->publish_state(false);
|
||||
bs_button_3_double_click_event->publish_state(false);
|
||||
bs_button_4_double_click_event->publish_state(false);
|
||||
bs_button_1_long_press_event->publish_state(false);
|
||||
bs_button_2_long_press_event->publish_state(false);
|
||||
bs_button_3_long_press_event->publish_state(false);
|
||||
bs_button_4_long_press_event->publish_state(false);
|
||||
bs_button_1_click_event->set_internal(id(gang_count) < 1);
|
||||
bs_button_2_click_event->set_internal(id(gang_count) < 2);
|
||||
bs_button_3_click_event->set_internal(id(gang_count) < 3);
|
||||
bs_button_4_click_event->set_internal(id(gang_count) < 4);
|
||||
bs_button_1_double_click_event->set_internal(id(gang_count) < 1);
|
||||
bs_button_2_double_click_event->set_internal(id(gang_count) < 2);
|
||||
bs_button_3_double_click_event->set_internal(id(gang_count) < 3);
|
||||
bs_button_4_double_click_event->set_internal(id(gang_count) < 4);
|
||||
bs_button_1_long_press_event->set_internal(id(gang_count) < 1);
|
||||
bs_button_2_long_press_event->set_internal(id(gang_count) < 2);
|
||||
bs_button_3_long_press_event->set_internal(id(gang_count) < 3);
|
||||
bs_button_4_long_press_event->set_internal(id(gang_count) < 4);
|
||||
|
||||
- id: !extend dump_config
|
||||
then:
|
||||
- lambda: |-
|
||||
// Touch panel's state
|
||||
if (sw_touch_panel_power->state)
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_TOUCH}", "Touch panel - Power: On");
|
||||
else
|
||||
ESP_LOGW("${TAG_CORE_HW_TOUCH}", "Touch panel - Power: OFF");
|
||||
ESP_LOGCONFIG("${TAG_CORE_HW_TOUCH}", "Touch event duration: %.0fms", nr_touch_duration->state);
|
||||
|
||||
- id: !extend dump_config_list_packages
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
// Check for requirements
|
||||
#if !defined(TX_ULTIMATE_EASY_CORE_COMMON)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_core_common.yaml is required."
|
||||
#endif
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Core - Hardware - Touchpad");
|
||||
|
||||
- id: touch_on_multi_touch_release
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
# - HW Vibration
|
||||
- script.execute: touch_on_multi_touch_release_touch
|
||||
|
||||
- id: touch_on_multi_touch_release_touch
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: bs_multi_touch->publish_state(true);
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- lambda: bs_multi_touch->publish_state(false);
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_multi_touch
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
|
||||
- id: touch_on_press
|
||||
mode: restart
|
||||
parameters:
|
||||
touch_position: uint8_t
|
||||
button: uint8_t
|
||||
position: uint8_t
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
@@ -136,60 +326,33 @@ script:
|
||||
- id: touch_on_release
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
# - HW Vibration
|
||||
- script.execute: touch_swipe_turn_off_binary_sensor
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
# - HW Vibration
|
||||
|
||||
- id: touch_swipe_left
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
- script.execute: touch_swipe_left_touch
|
||||
|
||||
- id: touch_swipe_left_touch
|
||||
mode: restart
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_left
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- script.execute: touch_swipe_turn_off_binary_sensor
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_down
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
|
||||
- id: touch_swipe_right
|
||||
mode: restart
|
||||
then:
|
||||
# Extended by:
|
||||
# - HW Buttons
|
||||
- script.execute: touch_swipe_right_touch
|
||||
|
||||
- id: touch_swipe_right_touch
|
||||
mode: restart
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_right
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
- delay: !lambda return nr_touch_duration->state;
|
||||
- script.execute: touch_swipe_turn_off_binary_sensor
|
||||
|
||||
- id: touch_swipe_turn_off_binary_sensor
|
||||
mode: restart
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
binary_sensor.is_on: bs_swipe_left
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_left
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- if:
|
||||
condition:
|
||||
binary_sensor.is_on: bs_swipe_right
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_right
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_swipe_up
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
|
||||
switch:
|
||||
- id: sw_touch_panel_power
|
||||
@@ -203,49 +366,104 @@ switch:
|
||||
entity_category: config
|
||||
|
||||
tx_ultimate_easy:
|
||||
id: tx_ultimate
|
||||
uart: uart_touch
|
||||
|
||||
on_long_touch_release:
|
||||
- lambda: |-
|
||||
const uint8_t touch_position = static_cast<uint8_t>(touch.x);
|
||||
if (touch_position > ${TOUCH_POSITION_MAX_VALUE}) { // Check for valid range
|
||||
ESP_LOGE("tx_ultimate_easy", "Invalid long-touch position: %" PRIu8, touch_position);
|
||||
ESP_LOGE("${TAG_CORE_HW_TOUCH}", "Invalid long-touch position: %" PRIu8, touch_position);
|
||||
} else {
|
||||
ESP_LOGI("tx_ultimate_easy", "Long-touch released at position %" PRIu8, touch_position);
|
||||
ESP_LOGI("${TAG_CORE_HW_TOUCH}", "Long-touch released at position %" PRIu8, touch_position);
|
||||
}
|
||||
|
||||
on_multi_touch_release:
|
||||
- lambda: ESP_LOGI("tx_ultimate_easy", "Multi-touch released");
|
||||
- script.execute: touch_on_multi_touch_release
|
||||
then:
|
||||
- homeassistant.event:
|
||||
event: ${EVENT_NAME}
|
||||
data:
|
||||
device_name: !lambda return id(tx_device_name).state.c_str();
|
||||
firmware: ${version}
|
||||
domain: touch
|
||||
type: multi_touch
|
||||
action: release
|
||||
position: !lambda return std::to_string(touch.x);
|
||||
- lambda: |-
|
||||
ESP_LOGI("${TAG_CORE_HW_TOUCH}", "Multi-touch released");
|
||||
touch_on_multi_touch_release->execute();
|
||||
|
||||
on_press:
|
||||
- lambda: |-
|
||||
const uint8_t touch_position = static_cast<uint8_t>(touch.x);
|
||||
if (touch_position > ${TOUCH_POSITION_MAX_VALUE}) { // Check for valid range
|
||||
ESP_LOGE("tx_ultimate_easy", "Invalid touch position: %" PRIu8, touch_position);
|
||||
} else {
|
||||
ESP_LOGI("tx_ultimate_easy", "Pressed at position %" PRIu8, touch_position);
|
||||
touch_on_press->execute(touch_position);
|
||||
}
|
||||
then:
|
||||
- lambda: |-
|
||||
const uint8_t position = static_cast<uint8_t>(touch.x);
|
||||
if (position > ${TOUCH_POSITION_MAX_VALUE}) { // Check for valid range
|
||||
ESP_LOGE("${TAG_CORE_HW_TOUCH}", "Invalid touch position: %" PRIu8, position);
|
||||
} else {
|
||||
ESP_LOGI("${TAG_CORE_HW_TOUCH}", "Pressed at position %" PRIu8, position);
|
||||
touch_on_press->execute(static_cast<uint8_t>(touch.button), position);
|
||||
}
|
||||
|
||||
on_release:
|
||||
- lambda: ESP_LOGI("tx_ultimate_easy", "Released");
|
||||
- script.execute: touch_on_release
|
||||
then:
|
||||
- lambda: |-
|
||||
ESP_LOGI("${TAG_CORE_HW_TOUCH}", "Released");
|
||||
- script.execute: touch_on_release
|
||||
|
||||
on_swipe_left:
|
||||
- lambda: ESP_LOGI("tx_ultimate_easy", "Swipe left");
|
||||
- script.execute: touch_swipe_left
|
||||
then:
|
||||
- homeassistant.event:
|
||||
event: ${EVENT_NAME}
|
||||
data:
|
||||
device_name: !lambda return id(tx_device_name).state.c_str();
|
||||
firmware: ${version}
|
||||
domain: touch
|
||||
type: swipe
|
||||
action: !lambda |-
|
||||
if (sl_tx_model_format->state == "${TX_MODEL_FORMAT_EU_TEXT}")
|
||||
return "left";
|
||||
else
|
||||
return "down";
|
||||
swipe-direction: !lambda |-
|
||||
if (sl_tx_model_format->state == "${TX_MODEL_FORMAT_EU_TEXT}")
|
||||
return "left";
|
||||
else
|
||||
return "down";
|
||||
position: !lambda return std::to_string(touch.x);
|
||||
- lambda: |-
|
||||
ESP_LOGI("${TAG_CORE_HW_TOUCH}", "Swipe %s",
|
||||
(sl_tx_model_format->state == "${TX_MODEL_FORMAT_EU_TEXT}") ? "left" : "down");
|
||||
touch_swipe_left->execute();
|
||||
|
||||
on_swipe_right:
|
||||
- lambda: ESP_LOGI("tx_ultimate_easy", "Swipe right");
|
||||
- script.execute: touch_swipe_right
|
||||
then:
|
||||
- homeassistant.event:
|
||||
event: ${EVENT_NAME}
|
||||
data:
|
||||
device_name: !lambda return id(tx_device_name).state.c_str();
|
||||
firmware: ${version}
|
||||
domain: touch
|
||||
type: swipe
|
||||
action: !lambda |-
|
||||
if (sl_tx_model_format->state == "${TX_MODEL_FORMAT_EU_TEXT}")
|
||||
return "right";
|
||||
else
|
||||
return "up";
|
||||
swipe-direction: !lambda |-
|
||||
if (sl_tx_model_format->state == "${TX_MODEL_FORMAT_EU_TEXT}")
|
||||
return "right";
|
||||
else
|
||||
return "up";
|
||||
position: !lambda return std::to_string(touch.x);
|
||||
- lambda: |-
|
||||
ESP_LOGI("${TAG_CORE_HW_TOUCH}", "Swipe %s",
|
||||
(sl_tx_model_format->state == "${TX_MODEL_FORMAT_EU_TEXT}") ? "right" : "up");
|
||||
touch_swipe_right->execute();
|
||||
|
||||
on_touch_event:
|
||||
- lambda: |-
|
||||
ESP_LOGD("tx_ultimate_easy", "Touch event:");
|
||||
ESP_LOGD("tx_ultimate_easy", " State: %i (%s)", touch.state, touch.state_str.c_str());
|
||||
ESP_LOGD("tx_ultimate_easy", " Position: %i", touch.x);
|
||||
ESP_LOGD("${TAG_CORE_HW_TOUCH}", "Touch event:");
|
||||
ESP_LOGD("${TAG_CORE_HW_TOUCH}", " State: %i (%s)", touch.state, touch.state_str.c_str());
|
||||
ESP_LOGD("${TAG_CORE_HW_TOUCH}", " Position: %i", touch.x);
|
||||
|
||||
uart:
|
||||
- id: uart_touch
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome Core - API #####
|
||||
##### Purpose: ESPHome Standard (non-essential, but recommended packages) #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
@@ -11,31 +11,10 @@
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
api:
|
||||
id: api_server
|
||||
on_client_connected:
|
||||
then:
|
||||
- script.execute: publish_device_info
|
||||
|
||||
script:
|
||||
- id: !extend button_action
|
||||
then:
|
||||
- script.execute:
|
||||
id: send_event_to_ha
|
||||
component: !lambda return component.c_str();
|
||||
event: !lambda return event.c_str();
|
||||
|
||||
- id: send_event_to_ha
|
||||
mode: queued
|
||||
parameters:
|
||||
component: string
|
||||
event: string
|
||||
then:
|
||||
- homeassistant.event:
|
||||
event: esphome.tx_ultimate_easy
|
||||
data:
|
||||
device_name: !lambda return tx_device_name->state.c_str();
|
||||
firmware: ${version}
|
||||
component: !lambda return component.c_str();
|
||||
event: !lambda return event.c_str();
|
||||
packages:
|
||||
# yamllint disable rule:colons
|
||||
standard_hw_relays: !include TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml
|
||||
standard_hw_vibration: !include TX-Ultimate-Easy-ESPHome_standard_hw_vibration.yaml
|
||||
standard_media_player: !include TX-Ultimate-Easy-ESPHome_standard_media_player.yaml
|
||||
# yamllint enable rule:colons
|
||||
...
|
||||
52
ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_audio.yaml
Normal file
52
ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_audio.yaml
Normal file
@@ -0,0 +1,52 @@
|
||||
####################################################################################################
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome - Standard - I2S Audio #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### NOTE: #####
|
||||
##### - Make changes ONLY if absolutely necessary and you have the required knowledge. #####
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
substitutions:
|
||||
SWITCH_AUDIO_AMPLIFIER_RESTORE_MODE: RESTORE_DEFAULT_ON
|
||||
|
||||
TAG_STD_HW_AUDIO: std.hw.audio
|
||||
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_STANDARD_HW_AUDIO
|
||||
|
||||
i2s_audio:
|
||||
- id: if_i2s_audio
|
||||
i2s_bclk_pin: GPIO2
|
||||
i2s_lrclk_pin: GPIO4
|
||||
|
||||
script:
|
||||
- id: !extend dump_config_list_packages
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
// Check for requirements
|
||||
#if !defined(TX_ULTIMATE_EASY_CORE_COMMON)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_core_common.yaml is required."
|
||||
#endif
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Standard - Hardware - Audio");
|
||||
|
||||
switch:
|
||||
- id: sw_audio_amplifier
|
||||
name: Audio Amplifier
|
||||
platform: gpio
|
||||
pin:
|
||||
number: GPIO26
|
||||
inverted: false
|
||||
restore_mode: ${SWITCH_AUDIO_AMPLIFIER_RESTORE_MODE}
|
||||
internal: true
|
||||
entity_category: config
|
||||
...
|
||||
1912
ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml
Normal file
1912
ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml
Normal file
File diff suppressed because it is too large
Load Diff
188
ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml
Normal file
188
ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml
Normal file
@@ -0,0 +1,188 @@
|
||||
####################################################################################################
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome - Standard - Hardware - Speaker #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### NOTE: #####
|
||||
##### - Make changes ONLY if absolutely necessary and you have the required knowledge. #####
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
substitutions:
|
||||
# RTTTL format: name:d=duration,o=octave,b=tempo:notes
|
||||
# d=32 (32nd note), o=5 (octave 5), b=100 (tempo 100)
|
||||
tone_volume_change: "scale_up:d=32,o=5,b=100:c,c#,d#,e,f#,g#,a#,b" # Use "none" to disable sound
|
||||
|
||||
TAG_STD_HW_SPEAKER: std.hw.speaker
|
||||
|
||||
packages:
|
||||
standard_hw_audio: !include TX-Ultimate-Easy-ESPHome_standard_hw_audio.yaml
|
||||
|
||||
api:
|
||||
actions:
|
||||
- action: rtttl_play
|
||||
variables:
|
||||
# The RTTTL string for the melody to be played.
|
||||
# It should follow the RTTTL format, including the melody's name,
|
||||
# default settings, and a sequence of notes.
|
||||
tone: string
|
||||
then:
|
||||
- lambda: |-
|
||||
rtttl_speaker->stop();
|
||||
if (speaker_volume->state > 0) {
|
||||
ESP_LOGI("${TAG_STD_HW_SPEAKER}", "Play tone: '%s'", tone.c_str());
|
||||
rtttl_speaker->play(tone.c_str());
|
||||
}
|
||||
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_STANDARD_HW_SPEAKER
|
||||
|
||||
number:
|
||||
- id: speaker_volume
|
||||
name: Speaker Volume
|
||||
platform: template
|
||||
max_value: 100
|
||||
min_value: 0
|
||||
step: 1
|
||||
initial_value: 100
|
||||
unit_of_measurement: "%"
|
||||
internal: false
|
||||
disabled_by_default: true
|
||||
entity_category: config
|
||||
device_class: sound_pressure
|
||||
restore_value: true
|
||||
optimistic: true
|
||||
set_action:
|
||||
then:
|
||||
- speaker.volume_set:
|
||||
id: speaker_embedded
|
||||
volume: !lambda return x/100.0f;
|
||||
- lambda: |-
|
||||
static const std::string tone_volume_change = "${tone_volume_change}";
|
||||
// Play sound if tone_volume_change is not "none"
|
||||
if (x > 0 and !tone_volume_change.empty() and tone_volume_change != "none")
|
||||
rtttl_speaker->play(tone_volume_change);
|
||||
|
||||
rtttl:
|
||||
- id: rtttl_speaker
|
||||
speaker: speaker_embedded
|
||||
|
||||
script:
|
||||
- id: !extend dump_config_list_packages
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
// Check for requirements
|
||||
#if !defined(TX_ULTIMATE_EASY_CORE_COMMON)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_core_common.yaml is required."
|
||||
#endif
|
||||
#if !defined(TX_ULTIMATE_EASY_STANDARD_HW_AUDIO)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_standard_hw_audio.yaml is required."
|
||||
#endif
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Standard - Hardware - Speaker");
|
||||
|
||||
- id: speaker_play_click
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
not:
|
||||
- speaker.is_playing: speaker_embedded
|
||||
then:
|
||||
- speaker.play:
|
||||
id: speaker_embedded
|
||||
data: [
|
||||
0x01, 0x02, 0x04, 0x06, 0x07, 0x08, 0x08, 0x06, 0x01, 0xFA, 0xF4,
|
||||
0xEF, 0xEE, 0xF1, 0xF7, 0xFF, 0x07, 0x0E, 0x11, 0x11, 0x10, 0x0C,
|
||||
0x06, 0xFF, 0xF8, 0xF1, 0xEC, 0xEA, 0xEC, 0xF2, 0xF9, 0xFF, 0x05,
|
||||
0x0A, 0x10, 0x14, 0x17, 0x17, 0x14, 0x0B, 0xFD, 0xED, 0xE0, 0xD9,
|
||||
0xDB, 0xE6, 0xF7, 0x0A, 0x19, 0x20, 0x1E, 0x14, 0x05, 0xF4, 0xE5,
|
||||
0xDF, 0xE4, 0xF4, 0x0C, 0x24, 0x36, 0x3D, 0x35, 0x20, 0xFF, 0xDD,
|
||||
0xC0, 0xAE, 0xA9, 0xB0, 0xC4, 0xE0, 0x03, 0x26, 0x48, 0x62, 0x70,
|
||||
0x6D, 0x59, 0x35, 0x08, 0xD8, 0xAC, 0x8D, 0x80, 0x85, 0x9C, 0xC1,
|
||||
0xF0, 0x21, 0x4E, 0x6F, 0x7F, 0x7A, 0x63, 0x3D, 0x0F, 0xE0, 0xB7,
|
||||
0x9B, 0x90, 0x96, 0xAC, 0xCE, 0xF6, 0x1D, 0x3C, 0x50, 0x55, 0x4D,
|
||||
0x3A, 0x20, 0x04, 0xEC, 0xD8, 0xCC, 0xC9, 0xCD, 0xD8, 0xE8, 0xF9,
|
||||
0x0A, 0x17, 0x1F, 0x20, 0x1C, 0x12, 0x07, 0xFC, 0xF2, 0xEC, 0xEB,
|
||||
0xED, 0xF3, 0xFA, 0x02, 0x0A, 0x10, 0x12, 0x12, 0x0E, 0x07, 0xFE,
|
||||
0xF5, 0xED, 0xEA, 0xEB, 0xEF, 0xF7, 0x00, 0x0A, 0x10, 0x13, 0x12,
|
||||
0x0F, 0x09, 0x02, 0xFB, 0xF5, 0xF3, 0xF2, 0xF3, 0xF6, 0xFB, 0xFF,
|
||||
0x03, 0x05, 0x07, 0x08, 0x07, 0x05, 0x03, 0x01, 0xFF, 0xFE, 0xFC,
|
||||
0xFB, 0xFB, 0xFC, 0xFC, 0xFD, 0xFE, 0xFF, 0x00, 0x01, 0x02, 0x02,
|
||||
0x01]
|
||||
|
||||
- wait_until:
|
||||
condition:
|
||||
not:
|
||||
- speaker.is_playing: speaker_embedded
|
||||
- speaker.stop: speaker_embedded
|
||||
|
||||
- id: !extend touch_on_multi_touch_release
|
||||
then:
|
||||
- script.execute: touch_on_multi_touch_release_speaker
|
||||
|
||||
- id: touch_on_multi_touch_release_speaker
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
if (sl_touch_speaker_feedback->state != "Disabled")
|
||||
speaker_play_click->execute();
|
||||
|
||||
- id: !extend touch_on_press
|
||||
then:
|
||||
- script.execute: touch_on_press_speaker
|
||||
|
||||
- id: touch_on_press_speaker
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
if (sl_touch_speaker_feedback->state == "On press" or sl_touch_speaker_feedback->state == "Always")
|
||||
speaker_play_click->execute();
|
||||
|
||||
- id: !extend touch_on_release
|
||||
then:
|
||||
- script.execute: touch_on_release_speaker
|
||||
|
||||
- id: touch_on_release_speaker
|
||||
mode: restart
|
||||
then:
|
||||
- lambda: |-
|
||||
if (sl_touch_speaker_feedback->state == "On release" or sl_touch_speaker_feedback->state == "Always")
|
||||
speaker_play_click->execute();
|
||||
|
||||
select:
|
||||
- id: sl_touch_speaker_feedback
|
||||
name: Touch - Speaker feedback
|
||||
platform: template
|
||||
options:
|
||||
- "Disabled"
|
||||
- "On press"
|
||||
- "On release"
|
||||
- "Always"
|
||||
initial_option: "Disabled"
|
||||
optimistic: true
|
||||
restore_value: true
|
||||
internal: false
|
||||
entity_category: config
|
||||
disabled_by_default: false
|
||||
icon: mdi:vibrate
|
||||
|
||||
speaker:
|
||||
- id: speaker_embedded
|
||||
platform: i2s_audio
|
||||
dac_type: external
|
||||
i2s_dout_pin: GPIO15
|
||||
i2s_audio_id: if_i2s_audio
|
||||
i2s_comm_fmt: stand_msb
|
||||
channel: mono
|
||||
timeout: never
|
||||
bits_per_sample: 16bit
|
||||
sample_rate: 48000
|
||||
buffer_duration: 500ms
|
||||
...
|
||||
@@ -2,7 +2,7 @@
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome Core - Hardware - Vibration system #####
|
||||
##### Purpose: ESPHome - Standard - Hardware - Vibration system #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
@@ -14,6 +14,8 @@
|
||||
substitutions:
|
||||
vibration_max_duration: 2s
|
||||
|
||||
TAG_STD_HW_VIBRATION: std.hw.vibration
|
||||
|
||||
binary_sensor:
|
||||
- id: bs_vibrating
|
||||
name: Vibrating
|
||||
@@ -32,6 +34,11 @@ button:
|
||||
then:
|
||||
- script.execute: vibrate
|
||||
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_STANDARD_HW_VIBRATION
|
||||
|
||||
number:
|
||||
- id: nr_vibrating_duration
|
||||
name: Vibrate duration
|
||||
@@ -53,6 +60,33 @@ ota:
|
||||
- switch.turn_off: sw_vibration_motor
|
||||
|
||||
script:
|
||||
- id: !extend dump_config
|
||||
then:
|
||||
- lambda: |-
|
||||
// Configuration
|
||||
ESP_LOGCONFIG("${TAG_STD_HW_VIBRATION}", "Touch - Vibration feedback: %s",
|
||||
sl_touch_vibration_feedback->state.c_str());
|
||||
ESP_LOGCONFIG("${TAG_STD_HW_VIBRATION}", "Vibrate duration: %.0fms", nr_vibrating_duration->state);
|
||||
ESP_LOGCONFIG("${TAG_STD_HW_VIBRATION}", "Vibrate max duration: ${vibration_max_duration}");
|
||||
|
||||
// State
|
||||
if (bs_vibrating->state)
|
||||
ESP_LOGW("${TAG_STD_HW_VIBRATION}", "Vibrating now: YES");
|
||||
else
|
||||
ESP_LOGCONFIG("${TAG_STD_HW_VIBRATION}", "Vibrating now: No");
|
||||
|
||||
- id: !extend dump_config_list_packages
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
// Check for requirements
|
||||
#if !defined(TX_ULTIMATE_EASY_CORE_COMMON)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_core_common.yaml is required."
|
||||
#endif
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Standard - Hardware - Vibration");
|
||||
|
||||
- id: !extend touch_on_multi_touch_release
|
||||
then:
|
||||
- script.execute: touch_on_multi_touch_release_vibration
|
||||
@@ -117,21 +151,17 @@ switch:
|
||||
pin: GPIO21
|
||||
restore_mode: ALWAYS_OFF
|
||||
internal: true
|
||||
on_turn_on:
|
||||
on_state:
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_vibrating
|
||||
state: ON # yamllint disable-line rule:truthy
|
||||
state: !lambda return x;
|
||||
on_turn_on:
|
||||
then:
|
||||
- delay: ${vibration_max_duration}
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: sw_vibration_motor
|
||||
then:
|
||||
- switch.turn_off: sw_vibration_motor
|
||||
on_turn_off:
|
||||
then:
|
||||
- binary_sensor.template.publish:
|
||||
id: bs_vibrating
|
||||
state: OFF # yamllint disable-line rule:truthy
|
||||
|
||||
...
|
||||
118
ESPHome/TX-Ultimate-Easy-ESPHome_standard_media_player.yaml
Normal file
118
ESPHome/TX-Ultimate-Easy-ESPHome_standard_media_player.yaml
Normal file
@@ -0,0 +1,118 @@
|
||||
####################################################################################################
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Purpose: ESPHome - Add-on - Media player #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### NOTE: #####
|
||||
##### - Make changes ONLY if absolutely necessary and you have the required knowledge. #####
|
||||
##### - For normal system use, modifications to this file are NOT required. #####
|
||||
####################################################################################################
|
||||
---
|
||||
substitutions:
|
||||
TAG_STD_MEDIA_PLAYER: "std.media-player"
|
||||
|
||||
packages:
|
||||
standard_hw_speaker: !include TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml
|
||||
|
||||
esphome:
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -D TX_ULTIMATE_EASY_STANDARD_MEDIA_PLAYER
|
||||
|
||||
globals:
|
||||
- id: last_media_player_volume
|
||||
type: uint8_t
|
||||
restore_value: false
|
||||
initial_value: '100'
|
||||
- id: persistent_media_player_volume
|
||||
type: uint8_t
|
||||
restore_value: true
|
||||
initial_value: '100'
|
||||
|
||||
media_player:
|
||||
- id: mp_media_player
|
||||
name: Media Player
|
||||
internal: false
|
||||
platform: speaker
|
||||
codec_support_enabled: true
|
||||
buffer_size: 250000
|
||||
task_stack_in_psram: false
|
||||
announcement_pipeline:
|
||||
speaker: announcement_spk_resampling_input
|
||||
format: WAV
|
||||
num_channels: 1
|
||||
sample_rate: 48000
|
||||
media_pipeline:
|
||||
speaker: media_spk_resampling_input
|
||||
format: FLAC
|
||||
num_channels: 1
|
||||
sample_rate: 48000
|
||||
on_state:
|
||||
then:
|
||||
- lambda: |-
|
||||
// Check if volume has changed and update number entity
|
||||
id(persistent_media_player_volume) = static_cast<uint8_t>(mp_media_player->volume * 100.0f);
|
||||
if (id(persistent_media_player_volume) != id(last_media_player_volume)) {
|
||||
id(last_media_player_volume) = id(persistent_media_player_volume);
|
||||
ESP_LOGD("${TAG_STD_MEDIA_PLAYER}", "Media player volume changed to %" PRIu8 "%%, updating number entity",
|
||||
id(persistent_media_player_volume));
|
||||
}
|
||||
|
||||
script:
|
||||
- id: !extend boot_sequence
|
||||
then:
|
||||
- script.execute: sync_initial_volume
|
||||
|
||||
- id: !extend dump_config
|
||||
then:
|
||||
- lambda: |-
|
||||
// Volume sync configuration
|
||||
ESP_LOGCONFIG("${TAG_STD_MEDIA_PLAYER}", "Media Player Volume Sync:");
|
||||
ESP_LOGCONFIG("${TAG_STD_MEDIA_PLAYER}", " Persistent volume: %" PRIu8 "%",
|
||||
id(persistent_media_player_volume));
|
||||
ESP_LOGCONFIG("${TAG_STD_MEDIA_PLAYER}", " Current volume: %.1f%%", mp_media_player->volume * 100.0f);
|
||||
|
||||
- id: !extend dump_config_list_packages
|
||||
then:
|
||||
- script.wait: dump_config
|
||||
- lambda: |-
|
||||
// Check for requirements
|
||||
#if !defined(TX_ULTIMATE_EASY_CORE_COMMON)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_core_common.yaml is required."
|
||||
#endif // TX_ULTIMATE_EASY_CORE
|
||||
#if !defined(TX_ULTIMATE_EASY_STANDARD_HW_SPEAKER)
|
||||
#error "The package TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml is required."
|
||||
#endif // TX_ULTIMATE_EASY_STANDARD_HW_SPEAKER
|
||||
|
||||
// Identify itself
|
||||
ESP_LOGCONFIG(ESPHOME_PROJECT_NAME, " - Standard - Media Player");
|
||||
|
||||
- id: sync_initial_volume
|
||||
mode: restart
|
||||
then:
|
||||
- delay: 2s # Wait for media player to initialize
|
||||
- media_player.volume_set: # Sync initial volume from persisted number entity to media player
|
||||
id: mp_media_player
|
||||
volume: !lambda return id(persistent_media_player_volume) / 100.0f;
|
||||
- lambda: |-
|
||||
id(last_media_player_volume) = id(persistent_media_player_volume);
|
||||
ESP_LOGI("${TAG_STD_MEDIA_PLAYER}", "Initial volume sync: %.1f%% (restored from persistence)",
|
||||
id(persistent_media_player_volume));
|
||||
|
||||
speaker:
|
||||
- platform: mixer
|
||||
id: mixer_speaker_embedded
|
||||
output_speaker: speaker_embedded
|
||||
source_speakers:
|
||||
- id: announcement_speaker_embedded
|
||||
- id: media_speaker_embedded
|
||||
- platform: resampler
|
||||
id: announcement_spk_resampling_input
|
||||
output_speaker: announcement_speaker_embedded
|
||||
- platform: resampler
|
||||
id: media_spk_resampling_input
|
||||
output_speaker: media_speaker_embedded
|
||||
...
|
||||
336
README.md
336
README.md
@@ -8,10 +8,10 @@
|
||||
[![Discord][discord-shield]](https://discord.gg/Db6WJWzWuf)
|
||||
[![Buy me an ice-cream][buymeacoffee-shield]](https://www.buymeacoffee.com/edwardfirmo)
|
||||
|
||||
<!-- markdownlint-disable MD013 -->
|
||||
|  | TX Ultimate Easy provides custom ESPHome firmware for Sonoff TX Ultimate devices. Our project focuses on user-friendly configuration through the Home Assistant UI, eliminating the need for manual YAML editing. Whether you're new to home automation or an experienced user, TX Ultimate Easy makes it simple to manage your device. |
|
||||
<!-- markdownlint-disable MD013 MD033 -->
|
||||
| <picture><source media="(prefers-color-scheme: dark)" srcset="Assets/Logo_dark.png"><source media="(prefers-color-scheme: light)" srcset="Assets/Logo_light.png"><img alt="TX Ultimate Easy Logo" src="Assets/Logo_light.png"></picture> | TX Ultimate Easy provides custom ESPHome firmware for Sonoff TX Ultimate devices. Our project focuses on user-friendly configuration through the Home Assistant UI, eliminating the need for manual YAML editing. Whether you're new to home automation or an experienced user, TX Ultimate Easy makes it simple to manage your device. |
|
||||
| --- | :-- |
|
||||
<!-- markdownlint-enable MD013 -->
|
||||
<!-- markdownlint-enable MD013 MD033 -->
|
||||
|
||||
[version-shield]: https://img.shields.io/github/v/tag/edwardtfn/TX-Ultimate-Easy?label=version
|
||||
[version]: https://github.com/edwardtfn/TX-Ultimate-Easy/tags
|
||||
@@ -27,16 +27,83 @@
|
||||
[buymeacoffee-shield]: https://img.shields.io/static/v1?label=Buy%20me%20an%20ice%20cream&message=❄&color=blue
|
||||
[buymeacoffee]: https://www.buymeacoffee.com/edwardfirmo
|
||||
|
||||
> [!WARNING]
|
||||
> ESPHome builder v2025.8.0+ is required
|
||||
|
||||
## Framework Migration to ESP-IDF
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ESP-IDF Framework Migration**
|
||||
>
|
||||
> Starting with version **2025.8.0**, TX Ultimate Easy will use **ESP-IDF** as the default framework, following ESPHome's direction towards ESP-IDF for better performance, stability, and feature support.
|
||||
>
|
||||
> **What this means for you:**
|
||||
> - **New installations**: Will automatically use ESP-IDF (no action required)
|
||||
> - **Existing Arduino users**: Can continue using Arduino but with limited support
|
||||
> - **Migration recommended**: For better performance and full feature support
|
||||
>
|
||||
> **Arduino Framework Support:**
|
||||
> - Still functional but **no longer actively tested**
|
||||
> - **Limited support** will be provided for Arduino-specific issues
|
||||
> - May miss out on new features optimized for ESP-IDF
|
||||
|
||||
### Migration Guidelines
|
||||
|
||||
#### For New Users
|
||||
No action required - ESP-IDF will be used automatically.
|
||||
|
||||
#### For Existing Arduino Users
|
||||
|
||||
**Option 1: Migrate to ESP-IDF (Recommended)**
|
||||
1. **Best practice**: Flash via serial/USB to ensure proper partition setup
|
||||
2. **Alternative**: If serial flashing isn't possible, flash OTA twice consecutively to improve success rate
|
||||
|
||||
**Option 2: Continue with Arduino**
|
||||
Add this to your YAML configuration to force Arduino framework:
|
||||
```yaml
|
||||
esp32:
|
||||
framework:
|
||||
type: arduino
|
||||
```
|
||||
|
||||
> [!WARNING]
|
||||
> **Migration via OTA:** When switching frameworks via OTA, the partition table may not update correctly. Flash twice in succession to ensure both firmware partitions contain the latest firmware and prevent boot failures.
|
||||
|
||||
## Integration with Home Assistant
|
||||
|
||||
TX Ultimate Easy exposes your device's components (sensors, touch panel, relays, etc.) to Home Assistant, allowing you to:
|
||||
TX Ultimate Easy exposes your device's components (sensors, touch panel, relays, etc.) to Home Assistant,
|
||||
allowing you to:
|
||||
|
||||
- Monitor sensor states and values
|
||||
- Control device components through the Home Assistant UI
|
||||
- Use device triggers and states in your Home Assistant automations and scripts
|
||||
- Configure device behavior through Home Assistant's service calls
|
||||
|
||||
All automation capabilities are handled through Home Assistant's native automation system - this project focuses on providing reliable device integration rather than implementing its own automation tools.
|
||||
All automation capabilities are handled through Home Assistant's
|
||||
native automation system - this project focuses on providing reliable
|
||||
device integration rather than implementing its own automation tools.
|
||||
|
||||
### Event-Based Automation
|
||||
|
||||
TX Ultimate Easy uses Home Assistant's native Events system for reliable automation triggers.
|
||||
While sensors show the current state (e.g., button pressed/not pressed),
|
||||
events capture-specific actions like clicks, swipes, and long presses.
|
||||
|
||||
For more details, please refer to our **[Events docs](docs/events.md)**.
|
||||
|
||||
### Device Configuration
|
||||
#### Relay Modes
|
||||
- **Light Mode**: Exposes the relay as a light entity with brightness controls (if supported)
|
||||
- **Switch Mode**: Exposes the relay as a simple on/off switch entity
|
||||
|
||||
#### Button Actions
|
||||
- **None**: Allows using button events for custom automations
|
||||
Example: Trigger scenes or complex automations through Home Assistant
|
||||
- **Relay Toggle**: Direct control of the associated relay
|
||||
Example: Toggle relay state with each press, independent of Home Assistant
|
||||
|
||||
#### Automation
|
||||
All device behaviors can be customized through Home Assistant automations without relying on local device triggers.
|
||||
|
||||
## Key Features
|
||||
|
||||
@@ -45,9 +112,10 @@ All automation capabilities are handled through Home Assistant's native automati
|
||||
- **Flexible Light Control**: Customize LED behavior and effects
|
||||
- **Touch Panel Support**: Full support for touch gestures and multi-touch capabilities
|
||||
- **Advanced Automations**: Create complex automations using Home Assistant's powerful automation engine
|
||||
- **BLE Proxy Support**: Optional Bluetooth Low Energy proxy functionality
|
||||
- **Bluetooth Proxy Support**: Compatible with ESPHome's bluetooth_proxy component for BLE device integration
|
||||
- **Audio Feedback**: Built-in speaker support for audible feedback
|
||||
- **Haptic Feedback**: Vibration motor support for tactile feedback
|
||||
- **ESP-IDF Framework**: Enhanced performance and stability with ESP-IDF support
|
||||
|
||||
## Hardware Support
|
||||
|
||||
@@ -67,12 +135,233 @@ Before getting started, ensure you have:
|
||||
|
||||
## Installation
|
||||
|
||||
Detailed installation instructions coming soon. The process will include:
|
||||
Follow these steps to get your TX Ultimate device up and running with ESPHome.
|
||||
|
||||
1. Initial ESPHome setup
|
||||
2. Device flashing
|
||||
3. Home Assistant integration
|
||||
4. Basic configuration
|
||||
### ESPHome Integration Setup
|
||||
|
||||
1. Install the ESPHome add-on in Home Assistant if not already installed:
|
||||
- Go to Settings → Add-ons → Add-on Store
|
||||
- Search for "ESPHome"
|
||||
- Click Install
|
||||
2. Start the ESPHome add-on and verify it's running
|
||||
3. Access ESPHome dashboard through Home Assistant
|
||||
|
||||
### Setup Device
|
||||
|
||||
1. In the ESPHome dashboard, click "+ New Device"
|
||||
2. Name your device (e.g., "tx-ultimate-living-room")
|
||||
3. Select ESP32 as your device type
|
||||
4. Copy this basic configuration to your new device:
|
||||
```yaml
|
||||
substitutions:
|
||||
name: tx-ultimate-easy
|
||||
friendly_name: TX Ultimate Easy
|
||||
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
|
||||
packages:
|
||||
remote_package:
|
||||
url: https://github.com/edwardtfn/TX-Ultimate-Easy
|
||||
ref: main # Or you can specify a version, like `ref: v2024.12.6` or `ref: latest`
|
||||
refresh: 5min
|
||||
files:
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml # Core (essential) packages
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard.yaml # Non-essential, but recommended packages
|
||||
```
|
||||
You can also use a specific version tag for better control over updates:
|
||||
```yaml
|
||||
ref: v2024.12.2 # Using specific version for controlled updates
|
||||
```
|
||||
**Notes:**
|
||||
- [Click here](https://github.com/edwardtfn/TX-Ultimate-Easy/tags) for a full list of versions available.
|
||||
- [Click here](TX-Ultimate-Easy-ESPHome.yaml)
|
||||
for the latest version of this yaml.
|
||||
5. Click "Save" and then "Install"
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Starting from version 2025.1.0, non-essential components like `web_server`, `captive_portal`, and `wifi`
|
||||
> are no longer included in the core package. If you need these components,
|
||||
> you must add them manually to your local configuration file.
|
||||
> For example:
|
||||
> ```yaml
|
||||
> # Add these to your configuration if needed
|
||||
> web_server:
|
||||
> captive_portal:
|
||||
> wifi:
|
||||
> ap: # Access point configuration
|
||||
> ```
|
||||
|
||||
### Optional Features
|
||||
|
||||
#### Bluetooth Proxy
|
||||
TX Ultimate Easy is fully compatible with ESPHome's `bluetooth_proxy` component.
|
||||
To enable Bluetooth proxy functionality, add the following to your device configuration:
|
||||
|
||||
```yaml
|
||||
bluetooth_proxy:
|
||||
# Optional: Configure specific settings
|
||||
# active: true
|
||||
```
|
||||
|
||||
**Requirements for Bluetooth Proxy:**
|
||||
- ESP-IDF framework (default framework, not recommended with Arduino framework)
|
||||
- Sufficient memory (TX Ultimate Easy components are compatible,
|
||||
but adding additional custom components may require memory optimization)
|
||||
|
||||
> [!NOTE]
|
||||
> Bluetooth proxy functionality is provided by ESPHome's native component.
|
||||
> TX Ultimate Easy ensures compatibility but does not include it by default to maintain optimal memory usage.
|
||||
|
||||
### Advanced Settings
|
||||
For more granular control over components,
|
||||
you can use our [advanced configuration template](TX-Ultimate-Easy-ESPHome_advanced.yaml).
|
||||
This template allows you to selectively include specific packages, which can be useful for:
|
||||
|
||||
- Troubleshooting specific components
|
||||
- Reducing memory usage by excluding unused features
|
||||
- Customizing functionality for specific use cases
|
||||
|
||||
Here's an example of the advanced configuration:
|
||||
```yaml
|
||||
packages:
|
||||
remote_package:
|
||||
url: https://github.com/edwardtfn/TX-Ultimate-Easy
|
||||
ref: main # Or you can specify a version, like `ref: v2024.12.6` or `ref: latest`
|
||||
refresh: 5min
|
||||
files:
|
||||
# Core (essential) packages
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_common.yaml # Basic shared settings
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_hw_buttons.yaml # Button logic
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_hw_leds.yaml # LED configuration
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_hw_touch.yaml # Touch panel support
|
||||
|
||||
# Optional but recommended packages
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml # Relay control
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_vibration.yaml # Haptic feedback
|
||||
|
||||
# Audio options (use none or choose only one - using both will fail)
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard_media_player.yaml # Media player (Recommended for most users)
|
||||
# - ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml # Basic speaker
|
||||
|
||||
# Optional: Add Bluetooth proxy support
|
||||
bluetooth_proxy:
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Use the advanced configuration with caution. Excluding core packages may cause instability or reduced functionality.
|
||||
|
||||
### Device Flashing
|
||||
|
||||
Initial flashing must be done via serial connection.
|
||||
We recommend using [ESPHome Web](https://web.esphome.io) for the simplest experience.
|
||||
|
||||
<!-- markdownlint-disable MD028 -->
|
||||
> [!IMPORTANT]
|
||||
> **SAFETY WARNINGS**
|
||||
> - ALWAYS disconnect the device from mains power before opening
|
||||
> - NEVER work on the device while connected to mains power
|
||||
> - Ensure the device is completely powered off before making any connections
|
||||
> - Keep your workspace clean, dry, and static-free
|
||||
> - Use proper insulated tools when working with electronics
|
||||
> - If unsure about any step, seek help from an experienced person
|
||||
|
||||
> [!CAUTION]
|
||||
>⚡ **CRITICAL: VOLTAGE WARNING**
|
||||
> Using a UART adapter with voltage higher than 3.3V WILL DAMAGE YOUR DEVICE.
|
||||
> Double-check your adapter's voltage before connecting - many common FTDI adapters
|
||||
> default to 5V which will permanently damage the ESP32 chip.
|
||||
<!-- markdownlint-enable MD028 -->
|
||||
|
||||
#### Required Hardware
|
||||
- USB-to-UART adapter:
|
||||
- 3.3V logic level ONLY (DO NOT use 5V adapters)
|
||||
- Must be capable of supplying at least 500mA
|
||||
- Common adapters: CP2102, CH340, FTDI (ensure 3.3V setting)
|
||||
- Small Phillips screwdriver
|
||||
- 5 wires for connections (including one for BOOT to GND)
|
||||
|
||||
#### Flashing Process
|
||||
1. Open your TX Ultimate device carefully
|
||||
2. Locate the programming header pins
|
||||
3. Connect your USB-to-UART adapter:
|
||||
|
||||
| Adapter | Device |
|
||||
|---------|--------|
|
||||
| GND | GND |
|
||||
| 3.3V | 3.3V |
|
||||
| TX | RX |
|
||||
| RX | TX |
|
||||
|
||||
4. Put device in flash mode:
|
||||
- Temporarily connect the BOOT pin to GND using a jumper wire
|
||||
- While holding BOOT to GND, power up the device
|
||||
- After device powers up (wait a couple of seconds), remove the BOOT to GND connection
|
||||
5. Visit [ESPHome Web](https://web.esphome.io)
|
||||
6. Connect to your device and flash the firmware
|
||||
7. After successful flash, device will restart and be ready for OTA updates
|
||||
|
||||
#### Detailed Visual Guides
|
||||
<!-- markdownlint-disable MD013 -->
|
||||
For step-by-step visual instructions, you can reference these existing guides:
|
||||
- 🇬🇧 [WirelessThings Guide](https://wirelessthings.io/index.php/2023/12/19/how-to-flash-sonoff-tx-ultimate-with-esphome/) - English guide with detailed photos
|
||||
- 🇪🇸 [Un loco y su tecnología](https://youtu.be/58v8oqSQgXQ?t=143) - Spanish video tutorial
|
||||
- 🇩🇪 [SmartHome yourself](https://youtu.be/naDLhX89enQ?t=465) - German video tutorial
|
||||
<!-- markdownlint-enable MD013 -->
|
||||
|
||||
Note: While these guides may use different firmware, the physical flashing process remains the same.
|
||||
|
||||
#### Subsequent Updates
|
||||
After initial flashing, all future updates can be done wirelessly (OTA)
|
||||
through the ESPHome dashboard in your ESPHome add-on.
|
||||
|
||||
### Home Assistant Integration
|
||||
|
||||
After successful flashing:
|
||||
1. Ensure your device and Home Assistant are on the same network
|
||||
2. Device should be automatically discovered within 1–2 minutes
|
||||
3. Accept the discovery notification in Home Assistant to add device
|
||||
Note: If discovery takes longer than 5 minutes, proceed to troubleshooting steps
|
||||
4. Device will appear in your Home Assistant Devices dashboard
|
||||
|
||||
#### Troubleshooting Integration
|
||||
If the device isn't discovered automatically:
|
||||
1. Verify your device is powered and connected to your network:
|
||||
- Look for the device in your router's client list
|
||||
- Consider using [manual IP](https://esphome.io/components/wifi.html#manual-ips) in your device
|
||||
2. If you missed the discovery notification:
|
||||
- Go to Settings → Devices & Services
|
||||
- Click "Add Integration"
|
||||
- Search for "ESPHome" and enter your device's IP address
|
||||
3. Still having issues?
|
||||
- Check your network allows mDNS/discovery traffic
|
||||
- Verify there are no VLANs or network isolation preventing communication
|
||||
- Try rebooting both the device and Home Assistant
|
||||
|
||||
### Initial Configuration
|
||||
|
||||
1. In Home Assistant, navigate to:
|
||||
- Settings → Devices & Services → ESPHome
|
||||
- Click on your device to access its configuration page
|
||||
2. Set basic device parameters:
|
||||
- Model format (EU/US)
|
||||
- Number of gangs (1-4)
|
||||
- Relay modes (switch/light)
|
||||
- Button actions
|
||||
3. Optional: Configure advanced features
|
||||
- LED behaviors
|
||||
- Touch duration
|
||||
- Haptic feedback
|
||||
- Audio feedback
|
||||
4. Test your configuration:
|
||||
- Verify each relay responds to controls
|
||||
- Test configured button actions
|
||||
- Confirm LED behavior matches settings
|
||||
- Check haptic/audio feedback if enabled
|
||||
|
||||
> [!NOTE]
|
||||
> Some changes may require a device restart
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -82,17 +371,18 @@ After installation, you can:
|
||||
2. Customize touch behaviors
|
||||
3. Set up LED patterns and effects
|
||||
4. Create automations
|
||||
5. Enable optional features like BLE proxy
|
||||
5. Enable optional features like Bluetooth proxy
|
||||
|
||||
## Configuration Options
|
||||
|
||||
TX Ultimate Easy offers extensive configuration options:
|
||||
|
||||
- Touch panel sensitivity and gestures
|
||||
- Touch panel gestures
|
||||
- LED colors, patterns, and behaviors
|
||||
- Relay modes and functions
|
||||
- Audio and haptic feedback settings
|
||||
- Network and connectivity options
|
||||
- Optional Bluetooth proxy functionality
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -104,6 +394,7 @@ We welcome contributions from the community! Here's how you can help:
|
||||
4. Submit a pull request targeting the `main` branch
|
||||
|
||||
Please ensure your code follows our standards:
|
||||
|
||||
- Passes all lint checks (YAML, C++, Markdown)
|
||||
- Includes appropriate documentation
|
||||
- Follows existing code style
|
||||
@@ -112,11 +403,15 @@ Please ensure your code follows our standards:
|
||||
|
||||
Need help? Here are your options:
|
||||
|
||||
- **Bug Reports & Feature Requests**: Use [GitHub Issues](https://github.com/edwardtfn/TX-Ultimate-Easy/issues) for all bug reports and feature requests
|
||||
- **Community Chat**: Join our [Discord Server](https://discord.gg/Db6WJWzWuf) for discussions and community interaction
|
||||
- **Bug Reports & Feature Requests**: Use [GitHub Issues](https://github.com/edwardtfn/TX-Ultimate-Easy/issues)
|
||||
for all bug reports and feature requests
|
||||
- **Community Chat**: Join our [Discord Server](https://discord.gg/Db6WJWzWuf)
|
||||
for discussions and community interaction
|
||||
- **Support the Project**: Consider supporting through Buy Me a Coffee
|
||||
|
||||
Note: For proper tracking and resolution, all bug reports and feature requests must be submitted through GitHub Issues, not Discord. The Issues page can be found at: [Issues · edwardtfn/TX-Ultimate-Easy](https://github.com/edwardtfn/TX-Ultimate-Easy/issues)
|
||||
Note: For proper tracking and resolution:
|
||||
- All bug reports and feature requests must be submitted through GitHub Issues, not Discord
|
||||
- Submit issues here: [Issues · edwardtfn/TX-Ultimate-Easy](https://github.com/edwardtfn/TX-Ultimate-Easy/issues)
|
||||
|
||||
[](https://www.buymeacoffee.com/edwardfirmo)
|
||||
|
||||
@@ -124,8 +419,11 @@ Note: For proper tracking and resolution, all bug reports and feature requests m
|
||||
|
||||
This project builds upon the work of several amazing projects and contributors:
|
||||
|
||||
<!-- markdownlint-disable MD013 -->
|
||||
- [SmartHome yourself - SONOFF TX Ultimate for ESPHome](https://github.com/SmartHome-yourself/sonoff-tx-ultimate-for-esphome)
|
||||
- [Un loco y su tecnología - Sonoff TX Ultimate with ESPHome](https://www.youtube.com/watch?v=58v8oqSQgXQ)
|
||||
- [@PxPert](https://github.com/PxPert) - [Sonoff TX Ultimate and Voice Assistant](https://community.home-assistant.io/t/sonoff-tx-ultimate-and-voice-assistant/682214?u=edwardtfn)
|
||||
<!-- markdownlint-enable MD013 -->
|
||||
|
||||
Special thanks to all contributors and community members who help make this project better.
|
||||
|
||||
@@ -136,5 +434,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<img src="Assets/Logo.webp" alt="TX Ultimate Easy Logo" width="100"/>
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="Assets/Logo_dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="Assets/Logo_light.png">
|
||||
<img alt="TX Ultimate Easy Logo" src="Assets/Logo_light.png" width="100">
|
||||
</picture>
|
||||
<!-- markdownlint-enable MD033 -->
|
||||
|
||||
@@ -16,9 +16,10 @@ wifi:
|
||||
packages:
|
||||
remote_package:
|
||||
url: https://github.com/edwardtfn/TX-Ultimate-Easy
|
||||
ref: main
|
||||
refresh: 30s
|
||||
ref: stable # Or you can specify a version, like `ref: v2024.12.6` or `ref: latest` to the latest non-stable
|
||||
refresh: 5min
|
||||
files:
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml
|
||||
# - ESPHome/TX-Ultimate-Easy-ESPHome_addon_ble_proxy.yaml # Adds experimental BLE proxy support (limited)
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core.yaml # Core (essential) packages
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard.yaml # Non-essential, but recommended packages
|
||||
# - ESPHome/TX-Ultimate-Easy-ESPHome_addon_ble_proxy.yaml # Adds BLE proxy support
|
||||
...
|
||||
|
||||
38
TX-Ultimate-Easy-ESPHome_advanced.yaml
Normal file
38
TX-Ultimate-Easy-ESPHome_advanced.yaml
Normal file
@@ -0,0 +1,38 @@
|
||||
####################################################################################################
|
||||
##### TX Ultimate Easy for ESPHome #####
|
||||
##### Repository: https://github.com/edwardtfn/TX-Ultimate-Easy #####
|
||||
####################################################################################################
|
||||
##### Author: edwardtfn - https://github.com/edwardtfn - https://buymeacoffee.com/edwardfirmo #####
|
||||
####################################################################################################
|
||||
##### WARNING: This is an advanced configuration template. Use with caution as improper #####
|
||||
##### configuration may lead to reduced functionality or system instability. #####
|
||||
####################################################################################################
|
||||
---
|
||||
substitutions:
|
||||
name: tx-ultimate-easy-adv
|
||||
friendly_name: TX Ultimate Easy Advanced
|
||||
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
|
||||
packages:
|
||||
remote_package:
|
||||
url: https://github.com/edwardtfn/TX-Ultimate-Easy
|
||||
ref: stable # Or you can specify a version, like `ref: v2024.12.6` or `ref: latest` to the latest non-stable
|
||||
refresh: 5min
|
||||
files:
|
||||
# Core (essential) packages - Do not disable these unless you know what you're doing
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_common.yaml # Basic shared settings
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_hw_buttons.yaml # Button logic
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_hw_leds.yaml # LED configuration
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_core_hw_touch.yaml # Touch panel support
|
||||
|
||||
# Optional functionality - Can be enabled/disabled as needed
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_relays.yaml # Relay control
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_vibration.yaml # Haptic feedback
|
||||
|
||||
# Audio options (use none or choose only one - using both will fail)
|
||||
- ESPHome/TX-Ultimate-Easy-ESPHome_standard_media_player.yaml # Media player (Recommended for most users)
|
||||
# - ESPHome/TX-Ultimate-Easy-ESPHome_standard_hw_speaker.yaml # Basic speaker
|
||||
...
|
||||
@@ -1,11 +1,12 @@
|
||||
import esphome.codegen as cg
|
||||
import esphome.config_validation as cv
|
||||
from esphome import automation
|
||||
from esphome.components import uart
|
||||
from esphome.components.esp32 import add_idf_sdkconfig_option
|
||||
from esphome.const import (
|
||||
CONF_ID,
|
||||
)
|
||||
|
||||
from esphome import automation
|
||||
from esphome.core import CORE
|
||||
|
||||
CODEOWNERS = ["@edwardtfn"]
|
||||
DEPENDENCIES = ['uart']
|
||||
@@ -109,3 +110,17 @@ async def to_code(config):
|
||||
await cg.register_component(var, config)
|
||||
await uart.register_uart_device(var, config)
|
||||
await register_tx_ultimate_easy(var, config)
|
||||
|
||||
if CORE.using_esp_idf:
|
||||
add_idf_sdkconfig_option("CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST", True)
|
||||
add_idf_sdkconfig_option("CONFIG_BT_BLE_DYNAMIC_ENV_MEMORY", True)
|
||||
add_idf_sdkconfig_option("CONFIG_ESP32_REV_MIN_3", True)
|
||||
add_idf_sdkconfig_option("CONFIG_MBEDTLS_DYNAMIC_BUFFER", True)
|
||||
add_idf_sdkconfig_option("CONFIG_MBEDTLS_DYNAMIC_FREE_CA_CERT", True)
|
||||
add_idf_sdkconfig_option("CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA", True)
|
||||
add_idf_sdkconfig_option("CONFIG_MBEDTLS_EXTERNAL_MEM_ALLOC", True)
|
||||
add_idf_sdkconfig_option("CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY", True)
|
||||
add_idf_sdkconfig_option("CONFIG_SPIRAM_RODATA", True)
|
||||
add_idf_sdkconfig_option("CONFIG_SPIRAM_TRY_ALLOCATE_WIFI_LWIP", True)
|
||||
|
||||
cg.add_define("USE_TX_ULTIMATE_EASY")
|
||||
|
||||
58
components/tx_ultimate_easy/tx_ultimate_easy_light.cpp
Normal file
58
components/tx_ultimate_easy/tx_ultimate_easy_light.cpp
Normal file
@@ -0,0 +1,58 @@
|
||||
// tx_ultimate_easy_light.cpp
|
||||
|
||||
#ifdef TX_ULTIMATE_EASY_CORE_HW_LEDS
|
||||
|
||||
#include "esphome/core/log.h"
|
||||
#include "tx_ultimate_easy_light.h"
|
||||
#include <cinttypes>
|
||||
#include <string>
|
||||
|
||||
namespace esphome {
|
||||
namespace tx_ultimate_easy {
|
||||
|
||||
// Log tag
|
||||
static const char *TAG = "tx_ultimate_easy.light";
|
||||
|
||||
// Constant definitions
|
||||
const LightAttributes LIGHT_ATTRS_DEFAULT = {100, 255, 255, 255};
|
||||
const uint32_t LIGHT_ATTRS_DEFAULT_PACKED = 0x64FFFFFF;
|
||||
const uint64_t DEFAULT_DUAL_LIGHT_ATTRS_PACKED = 0x64FFFFFF64FFFFFF;
|
||||
|
||||
// Function implementations
|
||||
uint32_t pack_light_attributes(const LightAttributes& attr) {
|
||||
return (uint32_t(std::min(attr.brightness, uint8_t(100))) << 24) |
|
||||
(uint32_t(attr.red) << 16) |
|
||||
(uint32_t(attr.green) << 8) |
|
||||
(uint32_t(attr.blue));
|
||||
}
|
||||
|
||||
LightAttributes unpack_light_attributes(uint32_t packed) {
|
||||
return {
|
||||
.brightness = std::min(uint8_t((packed >> 24) & 0xFF), uint8_t(100)),
|
||||
.red = uint8_t((packed >> 16) & 0xFF),
|
||||
.green = uint8_t((packed >> 8) & 0xFF),
|
||||
.blue = uint8_t(packed & 0xFF)
|
||||
};
|
||||
}
|
||||
|
||||
uint64_t pack_dual_light_attributes(const LightAttributes& group1_attrs, const LightAttributes& group2_attrs) {
|
||||
uint32_t group1_packed = pack_light_attributes(group1_attrs);
|
||||
uint32_t group2_packed = pack_light_attributes(group2_attrs);
|
||||
|
||||
return (uint64_t(group2_packed) << 32) | uint64_t(group1_packed);
|
||||
}
|
||||
|
||||
std::pair<LightAttributes, LightAttributes> unpack_dual_light_attributes(uint64_t packed) {
|
||||
uint32_t group1_packed = uint32_t(packed & 0xFFFFFFFF); // Lower 32 bits
|
||||
uint32_t group2_packed = uint32_t((packed >> 32) & 0xFFFFFFFF); // Upper 32 bits
|
||||
|
||||
return std::make_pair(
|
||||
unpack_light_attributes(group1_packed),
|
||||
unpack_light_attributes(group2_packed)
|
||||
);
|
||||
}
|
||||
|
||||
} // namespace tx_ultimate_easy
|
||||
} // namespace esphome
|
||||
|
||||
#endif // TX_ULTIMATE_EASY_CORE_HW_LEDS
|
||||
116
components/tx_ultimate_easy/tx_ultimate_easy_light.h
Normal file
116
components/tx_ultimate_easy/tx_ultimate_easy_light.h
Normal file
@@ -0,0 +1,116 @@
|
||||
// tx_ultimate_easy_light.h
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef TX_ULTIMATE_EASY_CORE_HW_LEDS
|
||||
|
||||
#include "esphome/core/automation.h"
|
||||
#include "esphome/core/component.h"
|
||||
#include "esphome/components/uart/uart.h"
|
||||
#include "esphome/components/uart/uart_component.h"
|
||||
#include "esphome/components/binary_sensor/binary_sensor.h"
|
||||
#include "esphome/components/switch/switch.h"
|
||||
#include "esphome/components/light/addressable_light.h"
|
||||
#include <array>
|
||||
|
||||
namespace esphome {
|
||||
namespace tx_ultimate_easy {
|
||||
/**
|
||||
* @brief Light attributes structure for storing color and brightness data.
|
||||
*
|
||||
* This structure represents the visual attributes of a light without the state (on/off).
|
||||
* It's designed to be packed efficiently into a 32-bit integer for NVS storage.
|
||||
* RGB components use the full 8-bit range (0-255) while brightness uses percentage (0-100).
|
||||
*/
|
||||
struct LightAttributes {
|
||||
uint8_t brightness; ///< Light brightness percentage (0-100, where 100 = full brightness)
|
||||
uint8_t red; ///< Red color component (0-255)
|
||||
uint8_t green; ///< Green color component (0-255)
|
||||
uint8_t blue; ///< Blue color component (0-255)
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Packs LightAttributes structure into a 32-bit integer for storage.
|
||||
*
|
||||
* Bit layout: [brightness(8)][red(8)][green(8)][blue(8)]
|
||||
* This allows efficient storage in ESPHome globals with restore_value support.
|
||||
* Note: Brightness values > 100 will be clamped to 100 during packing.
|
||||
*
|
||||
* @param attr The LightAttributes structure to pack
|
||||
* @return uint32_t Packed representation suitable for NVS storage
|
||||
*
|
||||
* @example
|
||||
* LightAttributes attrs = {75, 255, 128, 64};
|
||||
* uint32_t packed = pack_light_attributes(attrs); // Returns 0x4BFF8040
|
||||
*/
|
||||
uint32_t pack_light_attributes(const LightAttributes& attr);
|
||||
|
||||
/**
|
||||
* @brief Unpacks a 32-bit integer back into LightAttributes structure.
|
||||
*
|
||||
* Reverses the packing operation to extract individual color and brightness values.
|
||||
* Brightness values > 100 in the packed data will be clamped to 100.
|
||||
*
|
||||
* @param packed The packed 32-bit representation
|
||||
* @return LightAttributes The unpacked structure with individual components
|
||||
*
|
||||
* @example
|
||||
* uint32_t packed = 0x4BFF8040;
|
||||
* LightAttributes attrs = unpack_light_attributes(packed);
|
||||
* // attrs.brightness = 75, attrs.red = 255, attrs.green = 128, attrs.blue = 64
|
||||
*/
|
||||
LightAttributes unpack_light_attributes(uint32_t packed);
|
||||
|
||||
/**
|
||||
* @brief Default light attributes for initialization.
|
||||
*
|
||||
* Provides sensible defaults for new lights:
|
||||
* - Brightness: 100 (full brightness)
|
||||
* - Red: 255 (full intensity)
|
||||
* - Green: 255 (full intensity)
|
||||
* - Blue: 255 (full intensity)
|
||||
* Result: Pure white color at full brightness
|
||||
*/
|
||||
extern const LightAttributes LIGHT_ATTRS_DEFAULT;
|
||||
|
||||
/**
|
||||
* @brief Pre-packed version of DEFAULT_LIGHT_ATTRS for convenience.
|
||||
*
|
||||
* This constant contains LIGHT_ATTRS_DEFAULT already packed into uint32_t format,
|
||||
* suitable for direct use in ESPHome YAML initial_value fields.
|
||||
*
|
||||
* Value: 0x64FFFFFF (brightness=100, RGB=255,255,255)
|
||||
*/
|
||||
extern const uint32_t LIGHT_ATTRS_DEFAULT_PACKED;
|
||||
|
||||
/**
|
||||
* @brief Packs two LightAttributes into a single uint64_t for dual light storage.
|
||||
*
|
||||
* Bit layout: [group2_light(32)][group1_light(32)]
|
||||
* Each light uses 32 bits: [brightness(8)][red(8)][green(8)][blue(8)]
|
||||
*
|
||||
* @param group1_attrs First light attributes (stored in lower 32 bits)
|
||||
* @param group2_attrs Second light attributes (stored in upper 32 bits)
|
||||
* @return uint64_t Packed representation suitable for NVS storage
|
||||
*/
|
||||
uint64_t pack_dual_light_attributes(const LightAttributes& group1_attrs, const LightAttributes& group2_attrs);
|
||||
|
||||
/**
|
||||
* @brief Unpacks uint64_t back into two LightAttributes structures.
|
||||
*
|
||||
* @param packed The packed 64-bit representation
|
||||
* @return std::pair<LightAttributes, LightAttributes> Pair of (group1, group2) attributes
|
||||
*/
|
||||
std::pair<LightAttributes, LightAttributes> unpack_dual_light_attributes(uint64_t packed);
|
||||
|
||||
/**
|
||||
* @brief Pre-packed version of dual default attributes for convenience.
|
||||
*
|
||||
* Value: 0x64FFFFFF64FFFFFF (both lights: brightness=100, RGB=255,255,255)
|
||||
*/
|
||||
extern const uint64_t DEFAULT_DUAL_LIGHT_ATTRS_PACKED;
|
||||
|
||||
} // namespace tx_ultimate_easy
|
||||
} // namespace esphome
|
||||
|
||||
#endif // TX_ULTIMATE_EASY_CORE_HW_LEDS
|
||||
@@ -1,12 +1,18 @@
|
||||
// tx_ultimate_easy.cpp
|
||||
// tx_ultimate_easy_touch.cpp
|
||||
|
||||
#ifdef TX_ULTIMATE_EASY_CORE_HW_TOUCH
|
||||
|
||||
#include "esphome/core/log.h"
|
||||
#include "tx_ultimate_easy.h"
|
||||
#include "tx_ultimate_easy_touch.h"
|
||||
#include <cinttypes>
|
||||
#include <string>
|
||||
|
||||
namespace esphome {
|
||||
namespace tx_ultimate_easy {
|
||||
|
||||
// Log tag
|
||||
static const char *TAG = "tx_ultimate_easy.touch";
|
||||
|
||||
void TxUltimateEasy::setup() {
|
||||
ESP_LOGI(TAG, "TX Ultimate Easy is initialized");
|
||||
}
|
||||
@@ -68,9 +74,10 @@ namespace esphome {
|
||||
if (this->gang_count_ == 1)
|
||||
return 1;
|
||||
|
||||
// Calculate button number
|
||||
const uint8_t width = (TOUCH_MAX_POSITION + 1) / this->gang_count_; // Width of each button region
|
||||
if (width < 1 or width > this->gang_count_) // Invalid width - and prevents division by zero
|
||||
// Calculate button width (rounds up to ensure full coverage)
|
||||
const uint8_t width =
|
||||
(TOUCH_MAX_POSITION + this->gang_count_) / this->gang_count_; // Width of each button region
|
||||
if (width < 1) // Invalid width - and prevents division by zero
|
||||
return 0;
|
||||
const uint8_t button = std::min(
|
||||
static_cast<uint8_t>((position / width) + 1), // Convert position to button index
|
||||
@@ -140,8 +147,36 @@ namespace esphome {
|
||||
switch (uart_received_bytes[4]) {
|
||||
case TOUCH_STATE_RELEASE:
|
||||
case TOUCH_STATE_MULTI_TOUCH:
|
||||
return uart_received_bytes[5];
|
||||
|
||||
case TOUCH_STATE_SWIPE_LEFT:
|
||||
case TOUCH_STATE_SWIPE_RIGHT:
|
||||
// uart_received_bytes[5] indicates swipe direction:
|
||||
// 12 = find last touch position (scan right to left)
|
||||
// 13 = find first touch position (scan left to right)
|
||||
// Bytes 6-7 contain a 10-bit bitmap of touch positions:
|
||||
// Byte 7: bits 0-7 represent positions 1-8
|
||||
// Byte 6: bits 0-1 represent positions 9-10
|
||||
switch (uart_received_bytes[5]) {
|
||||
case 12:
|
||||
for (uint8_t i = 10; i > 0; i--) {
|
||||
if (i > 8
|
||||
? uart_received_bytes[6] & (1 << (i - 9))
|
||||
: uart_received_bytes[7] & (1 << (i - 1))) {
|
||||
return i;
|
||||
}
|
||||
}
|
||||
break;
|
||||
case 13:
|
||||
for (uint8_t i = 1; i <= 10; i++) {
|
||||
if (i > 8
|
||||
? uart_received_bytes[6] & (1 << (i - 9))
|
||||
: uart_received_bytes[7] & (1 << (i - 1))) {
|
||||
return i;
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
return uart_received_bytes[5];
|
||||
|
||||
default:
|
||||
@@ -151,8 +186,10 @@ namespace esphome {
|
||||
|
||||
int TxUltimateEasy::get_touch_state(const std::array<int, UART_RECEIVED_BYTES_SIZE> &uart_received_bytes) {
|
||||
int state = uart_received_bytes[4];
|
||||
if (state == TOUCH_STATE_PRESS && uart_received_bytes[5] != 0) state = TOUCH_STATE_RELEASE;
|
||||
if (state == TOUCH_STATE_RELEASE && uart_received_bytes[5] == TOUCH_STATE_MULTI_TOUCH) state = TOUCH_STATE_MULTI_TOUCH;
|
||||
if (state == TOUCH_STATE_PRESS && uart_received_bytes[5] != 0)
|
||||
state = TOUCH_STATE_RELEASE;
|
||||
if (state == TOUCH_STATE_RELEASE && uart_received_bytes[5] == TOUCH_STATE_MULTI_TOUCH)
|
||||
state = TOUCH_STATE_MULTI_TOUCH;
|
||||
if (state == TOUCH_STATE_SWIPE) {
|
||||
state = (uart_received_bytes[5] == TOUCH_STATE_SWIPE_RIGHT) ? TOUCH_STATE_SWIPE_RIGHT :
|
||||
(uart_received_bytes[5] == TOUCH_STATE_SWIPE_LEFT) ? TOUCH_STATE_SWIPE_LEFT : state;
|
||||
@@ -194,3 +231,5 @@ namespace esphome {
|
||||
|
||||
} // namespace tx_ultimate_easy
|
||||
} // namespace esphome
|
||||
|
||||
#endif // TX_ULTIMATE_EASY_CORE_HW_TOUCH
|
||||
@@ -1,7 +1,9 @@
|
||||
// tx_ultimate_easy.h
|
||||
// tx_ultimate_easy_touch.h
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef TX_ULTIMATE_EASY_CORE_HW_TOUCH
|
||||
|
||||
#include "esphome/core/automation.h"
|
||||
#include "esphome/core/component.h"
|
||||
#include "esphome/components/uart/uart.h"
|
||||
@@ -31,9 +33,6 @@ namespace esphome {
|
||||
constexpr int VALID_DATA_BYTE_2 = 0x01;
|
||||
constexpr int VALID_DATA_BYTE_3 = 0x02;
|
||||
|
||||
// Log tag
|
||||
static const char *TAG = "tx_ultimate_easy";
|
||||
|
||||
struct TouchPoint {
|
||||
uint8_t button = 0;
|
||||
int8_t x = -1;
|
||||
@@ -84,3 +83,5 @@ namespace esphome {
|
||||
|
||||
} // namespace tx_ultimate_easy
|
||||
} // namespace esphome
|
||||
|
||||
#endif // TX_ULTIMATE_EASY_CORE_HW_TOUCH
|
||||
236
docs/events.md
Normal file
236
docs/events.md
Normal file
@@ -0,0 +1,236 @@
|
||||
# Updating the Event Engine in TX Ultimate Easy
|
||||
|
||||
## Overview of the Event System
|
||||
|
||||
The TX Ultimate Easy firmware introduces a powerful
|
||||
and flexible event system designed to handle various types of interactions,
|
||||
such as touch gestures and device states.
|
||||
This system leverages Home Assistant's native event structure,
|
||||
ensuring seamless integration and enabling users to create advanced automations.
|
||||
|
||||
### Event Structure
|
||||
|
||||
All events emitted by the device are categorized under the `esphome.tx_ultimate_easy` event type in Home Assistant.
|
||||
The `data` field within the event payload provides details about the specific interaction.
|
||||
Below is a detailed description of the keys used:
|
||||
|
||||
#### Example Event Payload
|
||||
|
||||
```yaml
|
||||
event:
|
||||
event_type: esphome.tx_ultimate_easy
|
||||
data:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: touch
|
||||
type: button
|
||||
action: click
|
||||
button_id: 2
|
||||
count: 1
|
||||
position: 3
|
||||
```
|
||||
|
||||
### Key Definitions
|
||||
|
||||
#### `device_id`
|
||||
|
||||
- **Description**: A unique identifier for the device emitting the event.
|
||||
- **Example**: `device_id: "abc123"`
|
||||
|
||||
#### `device_name`
|
||||
|
||||
- **Description**: A Home Assistant-compatible version of the hostname, with blanks and invalid characters replaced by `_`.
|
||||
- **Example**: `device_name: "living_room_panel"`
|
||||
|
||||
#### `firmware`
|
||||
|
||||
- **Description**: The firmware version of the device, formatted as `YYYY.M.S`.
|
||||
- **Example**: `firmware: "2024.12.1"`
|
||||
|
||||
#### `domain`
|
||||
|
||||
- **Description**: The high-level category of the event.
|
||||
- **Examples**:
|
||||
- `boot`
|
||||
- `touch`
|
||||
|
||||
#### `type`
|
||||
|
||||
- **Description**: Specifies the subcategory within the `domain`.
|
||||
- **Examples**:
|
||||
- For `domain: boot`: `start`, `done`
|
||||
- For `domain: touch`: `button`, `swipe`, `multi_touch`
|
||||
|
||||
#### `action`
|
||||
|
||||
- **Description**: Indicates the specific action or interaction.
|
||||
- **Examples**:
|
||||
- For `type: button`: `click`, `double-click`, `long-press`, `multiple-click`
|
||||
- For `type: swipe`: `left`, `right`, `up`, `down`
|
||||
|
||||
#### `button_id`
|
||||
|
||||
- **Description**: Identifies the button involved in the event (specific to `type: button`).
|
||||
- **Example**: `button_id: 2`
|
||||
|
||||
#### `count`
|
||||
|
||||
- **Description**: Indicates the number of clicks or interactions (used with `action: multiple-click`).
|
||||
- **Example**: `count: 3`
|
||||
|
||||
#### `swipe-direction`
|
||||
|
||||
- **Description**: Specifies the direction of a swipe (used with `type: swipe`).
|
||||
- **Examples**: `left`, `right`, `up`, `down`
|
||||
|
||||
#### `position`
|
||||
|
||||
- **Description**: An integer from 1 to 10 indicating the touch position (available on all touch events).
|
||||
- **Example**: `position: 3`
|
||||
|
||||
### Supported Event Types
|
||||
|
||||
#### Boot Events
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: boot
|
||||
type: start
|
||||
action: null
|
||||
```
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: boot
|
||||
type: done
|
||||
action: null
|
||||
```
|
||||
|
||||
#### Touch Events
|
||||
|
||||
##### Button Event
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: touch
|
||||
type: button
|
||||
action: click
|
||||
button_id: 1
|
||||
count: 1
|
||||
position: 3
|
||||
```
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: touch
|
||||
type: button
|
||||
action: multiple-click
|
||||
button_id: 1
|
||||
count: 5
|
||||
position: 3
|
||||
```
|
||||
|
||||
##### Swipe Event
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: touch
|
||||
type: swipe
|
||||
action: left
|
||||
swipe-direction: left
|
||||
position: 3
|
||||
```
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: touch
|
||||
type: swipe
|
||||
action: up
|
||||
swipe-direction: up
|
||||
position: 3
|
||||
```
|
||||
|
||||
##### Multi-Touch Event
|
||||
|
||||
```yaml
|
||||
event:
|
||||
device_id: "abc123"
|
||||
device_name: "living_room_panel"
|
||||
firmware: "2024.12.1"
|
||||
domain: touch
|
||||
type: multi_touch
|
||||
action: release
|
||||
position: 3
|
||||
```
|
||||
|
||||
### Integration in Automations
|
||||
|
||||
#### Listening to Events
|
||||
|
||||
To utilize these events in Home Assistant, follow these steps:
|
||||
|
||||
1. Open the **Developer Tools** in Home Assistant.
|
||||
2. Navigate to the **Events** tab.
|
||||
3. Enter `esphome.tx_ultimate_easy` in the "Event to subscribe to" field.
|
||||
4. Click "Start listening."
|
||||
5. Trigger interactions on your TX Ultimate Easy device to see the events in real-time.
|
||||
|
||||
#### Example Automation YAML
|
||||
|
||||
##### Automation for a Single Click
|
||||
|
||||
```yaml
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: esphome.tx_ultimate_easy
|
||||
event_data:
|
||||
domain: touch
|
||||
type: button
|
||||
action: click
|
||||
button_id: 1
|
||||
position: 3
|
||||
action:
|
||||
- service: light.toggle
|
||||
target:
|
||||
entity_id: light.living_room
|
||||
```
|
||||
|
||||
##### Automation for a Swipe Gesture
|
||||
|
||||
```yaml
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: esphome.tx_ultimate_easy
|
||||
event_data:
|
||||
domain: touch
|
||||
type: swipe
|
||||
action: left
|
||||
swipe-direction: left
|
||||
position: 3
|
||||
action:
|
||||
- service: script.activate_scene
|
||||
target:
|
||||
entity_id: scene.relax_mode
|
||||
```
|
||||
|
||||
This event engine provides a robust and extensible framework for handling device interactions,
|
||||
allowing users to implement highly customized automations with ease.
|
||||
@@ -1 +1 @@
|
||||
2024.12.6
|
||||
2025.10.1
|
||||
|
||||
@@ -1 +1 @@
|
||||
version: 2024.12.6
|
||||
version: 2025.10.1
|
||||
|
||||
Reference in New Issue
Block a user