Browse Source

Fixed the styling of the example.yaml references.

pull/26/head
Maurice Makaay 3 years ago
parent
commit
3fba0aa3dc
4 changed files with 5 additions and 5 deletions
  1. +1
    -1
      README.md
  2. +2
    -2
      doc/configuration.md
  3. +1
    -1
      doc/installation.md
  4. +1
    -1
      doc/testplan.md

+ 1
- 1
README.md View File

@ -45,7 +45,7 @@ aspect of the lamp and to integrate the lamp in your Home Assistant setup.
For those who have experience with flashing ESPHome onto devices: For those who have experience with flashing ESPHome onto devices:
* Make sure you are using ESPHome v1.18.0 or newer. * Make sure you are using ESPHome v1.18.0 or newer.
* Copy `[example.yaml](example.yaml)` to `<CONFIG_DIR>/<NODE_NAME>.yaml`.
* Copy [`example.yaml`](example.yaml) to `<CONFIG_DIR>/<NODE_NAME>.yaml`.
* Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)). * Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)).
* Compile the `firmware.bin` file and download it to the device to which you have connected your * Compile the `firmware.bin` file and download it to the device to which you have connected your
serial to USB adapter. serial to USB adapter.


+ 2
- 2
doc/configuration.md View File

@ -3,7 +3,7 @@
# Configuration guide # Configuration guide
I think, the best starting point for creating your own yaml configuration, is to look at the I think, the best starting point for creating your own yaml configuration, is to look at the
[example.yaml](../example.yaml) file from the project documentation. This configuration was written
[`example.yaml`](../example.yaml) file from the project documentation. This configuration was written
with the functionality of the original firmware in mind and it makes use of all available options. with the functionality of the original firmware in mind and it makes use of all available options.
This configuration guide can be used to fill in the blanks. This configuration guide can be used to fill in the blanks.
@ -33,7 +33,7 @@ I do mention the platform configuration here for completeness sake, but **genera
to add the following configuration option to your yaml file**. It is loaded automatically by the to add the following configuration option to your yaml file**. It is loaded automatically by the
components that need it, and the GPIO + I2C configurations are fully prepared to work for the components that need it, and the GPIO + I2C configurations are fully prepared to work for the
Bedside Lamp 2 wiring out of the box. Therefore, you will not find this piece of configuration in Bedside Lamp 2 wiring out of the box. Therefore, you will not find this piece of configuration in
the [example.yaml](../example.yaml).
the [`example.yaml`](../example.yaml).
Having said that, here are the configuration options: Having said that, here are the configuration options:


+ 1
- 1
doc/installation.md View File

@ -12,7 +12,7 @@ the code manually. This leverages the external components feature that was intro
v1.18.0. Therefore, you must use ESPHome v1.18.0 or later. v1.18.0. Therefore, you must use ESPHome v1.18.0 or later.
Before you can compile the firmware, you will have to create the YAML configuration file for your Before you can compile the firmware, you will have to create the YAML configuration file for your
device. You can take the [example.yaml](../example.yaml) from this repository as a starting point, and
device. You can take the [`example.yaml`](../example.yaml) from this repository as a starting point, and
modify that one to your needs. Detailed information about the YAML configuration options can be modify that one to your needs. Detailed information about the YAML configuration options can be
found in the [Configuration guide](configuration.md). found in the [Configuration guide](configuration.md).


+ 1
- 1
doc/testplan.md View File

@ -13,7 +13,7 @@ been introduced.
* Remove the cached framework package: * Remove the cached framework package:
`/bin/rm -fR ~/.platformio/packages/framework-arduinoespressif32` `/bin/rm -fR ~/.platformio/packages/framework-arduinoespressif32`
* Copy `[example.yaml](../example.yaml)` to a clean build directory, and update the first two sections for the
* Copy [`example.yaml`](../example.yaml) to a clean build directory, and update the first two sections for the
local setup (substitutions, wifi, api, ota). local setup (substitutions, wifi, api, ota).
* Use `esphome example.yaml compile` to build the code. * Use `esphome example.yaml compile` to build the code.


Loading…
Cancel
Save