-
-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Description
Problem
Currently, the documentation suggests using local file includes for the packages:
packages:
respeaker-satellite: !include common/respeaker-satellite-base.yamlThis requires users to manually download and maintain the repository files locally.
Suggestion
ESPHome supports remote packages directly from GitHub, which would simplify the setup and ensure users always get the latest (or pinned) version. The example could be updated to:
packages:
respeaker-satellite:
url: https://github.com/formatBCE/Respeaker-Lite-ESPHome-integration
ref: main # or a specific tag like v1.0.0
files:
- config/common/respeaker-satellite-base.yaml
refresh: 1d
esphome:
name: respeaker-satellite
friendly_name: ReSpeaker Satellite
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_passwordBenefits
- ✅ No need to download repository files manually
- ✅ Easier updates (just change the
refor rely onrefresh) - ✅ Cleaner ESPHome config directory
- ✅ Users can pin to specific versions for stability
Documentation
ESPHome remote packages documentation: https://esphome.io/components/packages.html#git-packages
Would you consider updating the examples in the README to reflect this approach?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels