From 1d0024ff90646881d42a95e1cff0561d97214e93 Mon Sep 17 00:00:00 2001 From: Mischa Siekmann Date: Wed, 15 Jan 2025 12:07:56 +0100 Subject: [PATCH 1/4] introduce dashboard config file to be imported fully --- config/common/components.external.yaml | 9 ++++ config/common/debug.yaml | 12 ----- config/common/developer.yaml | 5 +- config/satellite1.base.yaml | 8 ++- config/satellite1.yaml | 69 +++++++++++++++++++------- 5 files changed, 71 insertions(+), 32 deletions(-) create mode 100644 config/common/components.external.yaml diff --git a/config/common/components.external.yaml b/config/common/components.external.yaml new file mode 100644 index 0000000..3b9adfb --- /dev/null +++ b/config/common/components.external.yaml @@ -0,0 +1,9 @@ +substitutions: + ext_comp_repo_ref: develop + +external_components: + - source: + type: git + url: https://github.com/FutureProofHomes/Satellite1-ESPHome + ref: ${ext_comp_repo_ref} + components: [ i2s_audio, satellite1, memory_flasher, tas2780, pcm5122, fusb302b ] diff --git a/config/common/debug.yaml b/config/common/debug.yaml index 7c55816..e7aca20 100644 --- a/config/common/debug.yaml +++ b/config/common/debug.yaml @@ -1,18 +1,6 @@ - -external_components: - - source: - type: local - path: ../esphome/components - components: [ version ] - debug: update_interval: 5s -logger: - deassert_rts_dtr: true - hardware_uart : USB_SERIAL_JTAG - level: debug - # # OPTIONAL Persist logs to a an MQTT broker so you can go back in time and inspect them. Read more here: https://esphome.io/components/mqtt.html # mqtt: # broker: homeassistant.local diff --git a/config/common/developer.yaml b/config/common/developer.yaml index b90370b..42b4104 100644 --- a/config/common/developer.yaml +++ b/config/common/developer.yaml @@ -3,8 +3,9 @@ external_components: - source: - type: local - path: ../esphome/components + type: git + url: https://github.com/FutureProofHomes/Satellite1-ESPHome + ref: develop components: [ udp_stream ] diff --git a/config/satellite1.base.yaml b/config/satellite1.base.yaml index 69ef4a5..0e2256e 100644 --- a/config/satellite1.base.yaml +++ b/config/satellite1.base.yaml @@ -12,6 +12,7 @@ substitutions: project_name: Satellite1 component_name: Core + esp32_fw_version: dev xmos_fw_version: "v1.0.1" built_for_core_hw_version: "v1.0.0-beta.1" built_for_hat_hw_version: "v1.0.0-beta.1" @@ -41,6 +42,10 @@ esphome: friendly_name: ${friendly_name} min_version: 2024.12.2 + project: + name: ${company_name}.${project_name} + version: ${esp32_fw_version} + on_boot: - priority: 375 then: @@ -71,7 +76,8 @@ ota: id: ota_esphome dashboard_import: - package_import_url: github://futureproofhomes/satellite1-esphome/config/satellite1.yaml@develop + package_import_url: github://futureproofhomes/satellite1-esphome/config/satellite1.yaml@dashboard_test + import_full_config: true packages: diff --git a/config/satellite1.yaml b/config/satellite1.yaml index 43481f5..f00e99e 100644 --- a/config/satellite1.yaml +++ b/config/satellite1.yaml @@ -1,26 +1,61 @@ substitutions: - company_name: FutureProofHomes - project_name: Satellite1 + name: satellite1 + friendly_name: Satellite1 + + xmos_fw_version: "v1.0.1" - esp32_fw_version: dev + # set the log level to debug, info, warn, error + log_level: debug -packages: - fph-satellite1: !include satellite1.base.yaml esphome: - project: - name: ${company_name}.${project_name} - version: ${esp32_fw_version} + name: ${name} + name_add_mac_suffix: true + friendly_name: ${friendly_name} -external_components: - - source: - type: git - url: https://github.com/FutureProofHomes/Satellite1-ESPHome - ref: develop - components: [ i2s_audio, satellite1, memory_flasher, tas2780, pcm5122, fusb302b ] +packages: + FutureProofHomes.Satellite1: + url: https://github.com/futureproofhomes/satellite1-esphome + ref: dashboard_test # optional + refresh: 1s # optional + files: + # main config files, don't remove + - config/satellite1.base.yaml + - config/common/components.external.yaml + + # mmwave_ld2410 + #- config/common/mmwave_ld2410.yaml + + # mmwave_ld2450 + #- config/common/mmwave_ld2450.yaml + + # add memory usage, wifi signal strength, and xmos flashing options + #- config/common/debug.yaml + logger: - deassert_rts_dtr: true - hardware_uart : USB_SERIAL_JTAG - level: debug \ No newline at end of file + level: ${log_level} + +# Enable transport encryption for the API layer by uncommenting the following lines +# and replacing "REPLACE_BY_32_BIT_RANDOM_KEY" with a 32-character random key. +# For more information, refer to the ESPHome documentation: +# https://esphome.io/components/api.html +# Note: The documentation also provides a tool to generate a random key, +# which you can copy and paste here. + +#api: +# encryption: +# key: REPLACE_BY_32_BIT_RANDOM_KEY + + +# By default, the Wi-Fi credentials provisioned on the Satellite1 device +# during setup will be used. +# +# To override this and use the Wi-Fi credentials stored in the secrets.yaml +# file of the ESPHome dashboard, uncomment the following lines. +# This allows you to manage Wi-Fi credentials centrally for all your devices. + +#wifi: +# ssid: !secret wifi_ssid +# password: !secret wifi_password From 2f2e93b6df7a2318bebc085047ec34f070d00dc8 Mon Sep 17 00:00:00 2001 From: that1guy Date: Fri, 17 Jan 2025 00:16:45 -0500 Subject: [PATCH 2/4] proposing minor changes to the english in the commented instructions --- config/common/wifi_improv.yaml | 1 + config/satellite1.yaml | 44 ++++++++++++++-------------------- 2 files changed, 19 insertions(+), 26 deletions(-) diff --git a/config/common/wifi_improv.yaml b/config/common/wifi_improv.yaml index 133a95b..445703a 100644 --- a/config/common/wifi_improv.yaml +++ b/config/common/wifi_improv.yaml @@ -6,6 +6,7 @@ globals: wifi: id: wifi_id + use_address: satellite1-92725c.local on_connect: - lambda: id(improv_ble_in_progress) = false; - script.execute: control_leds diff --git a/config/satellite1.yaml b/config/satellite1.yaml index f00e99e..dc18ef1 100644 --- a/config/satellite1.yaml +++ b/config/satellite1.yaml @@ -1,61 +1,53 @@ substitutions: name: satellite1 friendly_name: Satellite1 - xmos_fw_version: "v1.0.1" - # set the log level to debug, info, warn, error + # OPTIONALLY, set the log level to debug, info, warn, error log_level: debug - esphome: name: ${name} name_add_mac_suffix: true friendly_name: ${friendly_name} - packages: FutureProofHomes.Satellite1: url: https://github.com/futureproofhomes/satellite1-esphome - ref: dashboard_test # optional - refresh: 1s # optional + ref: dashboard_test # OPTIONAL + refresh: 1s # OPTIONAL files: - # main config files, don't remove + # Main config files, don't remove - config/satellite1.base.yaml - config/common/components.external.yaml - - # mmwave_ld2410 + + ## OPTIONALLY, uncomment if you have the smaller LD2410 mmWave sensor connected to your HAT. #- config/common/mmwave_ld2410.yaml - # mmwave_ld2450 + ## OPTIONALLY, uncomment if you have the larger LD2450 mmWave sensor connected to your HAT. #- config/common/mmwave_ld2450.yaml - # add memory usage, wifi signal strength, and xmos flashing options + ## OPTIONALLY, uncomment if want extra memory, wifi and xmos control of the device. #- config/common/debug.yaml - logger: level: ${log_level} -# Enable transport encryption for the API layer by uncommenting the following lines -# and replacing "REPLACE_BY_32_BIT_RANDOM_KEY" with a 32-character random key. -# For more information, refer to the ESPHome documentation: -# https://esphome.io/components/api.html -# Note: The documentation also provides a tool to generate a random key, -# which you can copy and paste here. +## OPTIONALLY, enable transport encryption for the API layer by uncommenting the following lines +## and replacing "REPLACE_BY_32_BIT_RANDOM_KEY" with a 32-character random key. +## For more information, refer to the ESPHome documentation: +## https://esphome.io/components/api.html +## Note: The documentation also provides a tool to generate a random key #api: # encryption: # key: REPLACE_BY_32_BIT_RANDOM_KEY - -# By default, the Wi-Fi credentials provisioned on the Satellite1 device -# during setup will be used. -# -# To override this and use the Wi-Fi credentials stored in the secrets.yaml -# file of the ESPHome dashboard, uncomment the following lines. -# This allows you to manage Wi-Fi credentials centrally for all your devices. +## OPTIONALLY, override the default Wi-Fi credentials provisioned on the Satellite1 device +## during setup by using your Wi-Fi credentials stored in the `secrets.yaml` file of the +## ESPHome dashboard. Uncomment the below lines to enable this feature, allowing you +## to manage Wi-Fi credentials centrally for all your devices. #wifi: # ssid: !secret wifi_ssid -# password: !secret wifi_password +# password: !secret wifi_password \ No newline at end of file From c512af8f402e7cbcb5bcc6871ea1de7157ce9417 Mon Sep 17 00:00:00 2001 From: Mischa Siekmann Date: Fri, 17 Jan 2025 07:06:50 +0100 Subject: [PATCH 3/4] removed accidentilly added use_address line from wifi settings --- config/common/wifi_improv.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/config/common/wifi_improv.yaml b/config/common/wifi_improv.yaml index 445703a..133a95b 100644 --- a/config/common/wifi_improv.yaml +++ b/config/common/wifi_improv.yaml @@ -6,7 +6,6 @@ globals: wifi: id: wifi_id - use_address: satellite1-92725c.local on_connect: - lambda: id(improv_ble_in_progress) = false; - script.execute: control_leds From f32e09b0f0696f0dc2b60426808746e66dea4949 Mon Sep 17 00:00:00 2001 From: Mischa Siekmann Date: Fri, 17 Jan 2025 07:10:33 +0100 Subject: [PATCH 4/4] changed dashbaord import ref to develop branch --- config/satellite1.base.yaml | 2 +- config/satellite1.yaml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/config/satellite1.base.yaml b/config/satellite1.base.yaml index 0e2256e..fe4de5c 100644 --- a/config/satellite1.base.yaml +++ b/config/satellite1.base.yaml @@ -76,7 +76,7 @@ ota: id: ota_esphome dashboard_import: - package_import_url: github://futureproofhomes/satellite1-esphome/config/satellite1.yaml@dashboard_test + package_import_url: github://futureproofhomes/satellite1-esphome/config/satellite1.yaml@develop import_full_config: true diff --git a/config/satellite1.yaml b/config/satellite1.yaml index dc18ef1..47f0ae1 100644 --- a/config/satellite1.yaml +++ b/config/satellite1.yaml @@ -14,8 +14,8 @@ esphome: packages: FutureProofHomes.Satellite1: url: https://github.com/futureproofhomes/satellite1-esphome - ref: dashboard_test # OPTIONAL - refresh: 1s # OPTIONAL + ref: develop + refresh: 1s files: # Main config files, don't remove - config/satellite1.base.yaml