diff --git a/.gitignore b/.gitignore index 0c42d92..172da3f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +/venv + # Gitignore settings for ESPHome # This is an example and may include too much for your use-case. # You can modify this file to suit your needs. diff --git a/README.md b/README.md index f32550b..7069323 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,51 @@ # esphome +## Installation + +Recommended: [venv](https://docs.python.org/3/library/venv.html). + +```shell +# Optional +$ python3 -m venv venv +$ source venv/bin/activate + +$ pip3 install -r requirements.txt +``` + +## Compiling + +``` +$ cp -i secrets.yaml{.sample,} +$ cp -i templates/secrets.yaml{.sample,} + +# Edit both secrets.yaml files. + +# Optional +$ source venv/bin/activate + +$ ./reflash.sh compile '' +``` + +## Running + +``` +# Optional +$ source venv/bin/activate + +$ ./reflash.sh +``` + +or + +``` +# Optional +$ source venv/bin/activate + +$ esphome run file.yaml +``` + +Look up list of runnable files inside `reflash.sh` script. + ## Hardware: heating ### Photoresistor diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f449edd --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +esphome >= 2025.2.1