Skip to content

Suggestion: Use remote GitHub packages in documentation examples instead of local files #70

@oangelo

Description

@oangelo

Problem

Currently, the documentation suggests using local file includes for the packages:

packages:
  respeaker-satellite: !include common/respeaker-satellite-base.yaml

This 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_password

Benefits

  • ✅ No need to download repository files manually
  • ✅ Easier updates (just change the ref or rely on refresh)
  • ✅ 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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions