Giter Club home page Giter Club logo

esphome-project-template's Introduction

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 for users to easily install your project onto their device.

Instructions

  1. Use this repo template to 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 to contain your own YAML config filename(s). b. Update .github/workflows/ci.yml to contain your own YAML config filename(s).
  5. Update static/_config.yml to change the title, description and basic theme of the generated website.
  6. Add more content to the 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.

esphome-project-template's People

Contributors

balloob avatar jesserockz avatar kbx81 avatar martijnvwezel avatar tntlarsn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

esphome-project-template's Issues

Using esphome core helper functions in lambdas

In this YAML I want use remap template function from esphome/core/helpers.h. Local build is successfull, but esphome/build-action fails.

yaml:

number:
  - platform: template
    name: Hands Sensor Sensitivity
    icon: mdi:signal-distance-variant
    entity_category: config
    mode: slider
    optimistic: true
    restore_value: true
    min_value: 1
    max_value: 10
    step: 0.5
    on_value:
    - output.set_level:
        id: hands_sensor
        level: !lambda "return esphome::remap(x, 1.0f, 10.0f, id(hands_sensor).get_min_power(), id(hands_sensor).get_max_power());"

Log:

monochrome-delay.yaml: In lambda function:
monochrome-delay.yaml:171:14: error: 'remap' is not a member of 'esphome'

Build process exit with code 1 after ESPHome Update to 2023.8.1

Logs: https://github.com/TheRealFalseReality/aquapi/actions/runs/5971333448/job/16200240502

Using your template for my project: https://github.com/TheRealFalseReality/aquapi

But it seems like then ESPHome updated to 2023.8.1, but now getting this error:

    File "/usr/local/lib/python3.9/dist-packages/yaml/scanner.py", line 577, in fetch_value
      raise ScannerError(None, None,
  yaml.scanner.ScannerError: mapping values are not allowed here
    in "<unicode string>", line 437, column 24:
        ssid: \033[5m    name: Connected SSID\033[6m
                             ^
  
  Error: Process completed with exit code 1.

This started to fail only after ESPHome updated to 8.1, all I did was edit my README.md file to trigger the Action. But since, it hasn't been able to build and publish....

Any ideas?

The process '/usr/bin/git' failed with exit code 128

Hi,

I'm using your template for my esphome project: https://github.com/JamesSwift/localbytes-plug-pm

But I'm getting errors on the "publish" step:

/usr/bin/git worktree remove github-pages-deploy-action-temp-deployment-folder --force
Error: The deploy step encountered an error: The process '/usr/bin/git' failed with exit code 128 ❌

https://github.com/JamesSwift/localbytes-plug-pm/runs/6430826564?check_suite_focus=true

Any idea's what's going wrong here?

"Error: Process completed with exit code 1." when updating

I've got a couple of ESPHome devices that I built a project for using this template - as they're all the same so it makes it easier for me to make new ones and deploy them around the house (they're just a simple light attached to an ESP).

I updated the code to fix the breaking changes with the OTA platform in 2024.6.0 but now when I save the main file I'm getting an error in my actions when it's doing its thing, here's the last few lines of the log with the error at the bottom:

#7 exporting to image
#7 exporting layers
#7 exporting layers 1.0s done
#7 writing image sha256:68ad9a5ec56a729[85](https://github.com/grayfrost90/bottle-lights/actions/runs/9610534301/job/26507215507#step:3:87)d084b2fc12bb1c233f7791f39762aa4a847e21b28a80ac3
#7 writing image sha256:68ad9a5ec56a72985d084b2fc12bb1c233f7791f39762aa4a847e21b28a80ac3 done
#7 naming to docker.io/library/esphome:latest done
#7 DONE 1.0s
Run docker run --rm \
Compile firmware
Get ESPHome version
Get config
Get IDEData
Copy firmware file(s) to folder
  Error: Process completed with exit code 1.

I don't really know enough to debug it though so was hoping someone could help me out

thanks

Jack

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.