https://github.com/duhow/esphome-devices

Custom ESPHome device templates
https://github.com/duhow/esphome-devices

esp32 esphome esphome-devices

Last synced: 3 days ago
JSON representation

Custom ESPHome device templates

• Host: GitHub
• URL: https://github.com/duhow/esphome-devices
• Owner: duhow
• Created: 2024-06-16T18:43:51.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-16T18:55:45.000Z (7 months ago)
• Last Synced: 2024-11-08T04:21:31.779Z (about 2 months ago)
• Topics: esp32, esphome, esphome-devices
• Homepage: http://duhowpi.net/esphome-devices/
• Size: 292 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ESPHome Project Template

This repo serves as a template for creating a new ESPHome project.

It includes a GitHub workflow that will automatically build the configuration(s) and then deploys a simple 

website via GitHub pages that utilises [ESP Web Tools](https://esphome.github.io/esp-web-tools/) for users to 

easily install your project onto their device.

## Instructions

1. Use this repo template to [generate](https://github.com/esphome/esphome-project-template/generate) your own repository.

   - Make sure to check `Include all branches` so that GitHub Pages is automatically enabled.

2. Clone your new repository.

3. Add your project specific YAML configuration(s) along with the contents of the `project-template-....yaml` files, taking note of the comments in this template file and name accordingly.

4. 

    a. Update [.github/workflows/publish.yml](.github/workflows/publish.yml) to contain your own YAML config filename(s).

    b. Update [.github/workflows/ci.yml](.github/workflows/ci.yml) to contain your own YAML config filename(s).

5. Update [static/_config.yml](static/_config.yml) to change the title, description and basic theme of the generated website.

6. Add more content to the [static/index.md](static/index.md) file to explain your project.

    Make sure to leave the installation code tags in place so users get the install button.

7. Add permission to github-actions[bot]

   a. go to your project Settings, under the Actions collapsible, click on General.

   b. scroll down until you find Workflow permissions and mark the option Read and write permissions.

   c. Hit the save button

8. Push your changes to the repository and GitHub Actions will automatically build and deploy your project.