Updated Creating Your First Device in Home Assistant ‐ ESPHome (markdown)
@@ -2,11 +2,11 @@
|
|||||||
|
|
||||||
You now have a board which you are excited to add to Home Assistant. So let's get started.
|
You now have a board which you are excited to add to Home Assistant. So let's get started.
|
||||||
|
|
||||||
Note: This is a step by step guide, so please follow the prompts where needed.
|
Note: This is not a step by step guide, so please follow the prompts where needed and you should be able to flow through the process.
|
||||||
|
|
||||||
### Top Level
|
### Top Level
|
||||||
|
|
||||||
- Use Home Assitant **ESPHome** to Create and Maintain Devices
|
- Use Home Assistant **ESPHome** to Create and Maintain Devices
|
||||||
- Use existing **External Component**(s). (Think of these as libraries.)
|
- Use existing **External Component**(s). (Think of these as libraries.)
|
||||||
- **Create Device**
|
- **Create Device**
|
||||||
- Paste or Edit **YAML code**
|
- Paste or Edit **YAML code**
|
||||||
@@ -70,9 +70,9 @@ Assuming you have added ESPHome device builder to your left menu bar within Home
|
|||||||
|
|
||||||
#### Secrets
|
#### Secrets
|
||||||
|
|
||||||
ESPHome configuration for a device lives in a .yaml file. Within this yaml file, you can add a whole range of device configuration information, the most common between devices is your Wi-Fi setup information.
|
ESPHome configuration for a device lives in a .yaml file. Within this YAML file, you can add a whole range of device configuration information, the most common between devices is your Wi-Fi setup information.
|
||||||
|
|
||||||
If not already configured, I would recommend you setup your 'secrets' file. Withn yaml, this is `<<: !include ../secrets.yaml`
|
If not already configured, I would recommend you setup your 'secrets' file. Within YAML , this is `<<: !include ../secrets.yaml`
|
||||||
|
|
||||||
To configure the secrets file, you need to
|
To configure the secrets file, you need to
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ Excellent! Your new device should not be added to the ESPHome Device Builder da
|
|||||||
Now you have a 'blank device' you could run through flashing it with blank code, to ensure it then appears in the dash as online.
|
Now you have a 'blank device' you could run through flashing it with blank code, to ensure it then appears in the dash as online.
|
||||||
|
|
||||||
If you right click the three dots on your device, you will be requested to install the YAML to the device itself.
|
If you right click the three dots on your device, you will be requested to install the YAML to the device itself.
|
||||||
As this is a new device and does not know about Wi-Fi etc, simply use the [Plug into this computer] option.
|
As this is a new device and does not know about Wi-Fi etc., simply use the [Plug into this computer] option.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -135,7 +135,7 @@ Chose the downloaded and saved file.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Finally - Success! Your board is flashed with a blank code. It should then show in teh dash as online.
|
Finally - Success! Your board is flashed with a blank code. It should then show in the dash as online.
|
||||||
[](https://github.com/DitroniX/Home-Assistant-Dev/blob/main/Datasheets%20and%20Information/Example%20of%20Installed.png)
|
[](https://github.com/DitroniX/Home-Assistant-Dev/blob/main/Datasheets%20and%20Information/Example%20of%20Installed.png)
|
||||||
|
|
||||||

|

|
||||||
@@ -143,7 +143,7 @@ Finally - Success! Your board is flashed with a blank code. It should then sho
|
|||||||
#### Adding the DitroniX configuration
|
#### Adding the DitroniX configuration
|
||||||
You are now at a stage where you can edit the device YAML and add the test code.
|
You are now at a stage where you can edit the device YAML and add the test code.
|
||||||
|
|
||||||
YAML Test code is provided in the indivudal product repositors, or in the YAML folder.
|
YAML Test code is provided in the individual product repositors, or in the YAML folder.
|
||||||
[https://github.com/DitroniX/Home-Assistant-Dev/tree/main/YAML%20Examples](https://github.com/DitroniX/Home-Assistant-Dev/tree/main/YAML%20Examples)
|
[https://github.com/DitroniX/Home-Assistant-Dev/tree/main/YAML%20Examples](https://github.com/DitroniX/Home-Assistant-Dev/tree/main/YAML%20Examples)
|
||||||
|
|
||||||
Click the [EDIT] button on the device dash and this should open the YAML Editor.
|
Click the [EDIT] button on the device dash and this should open the YAML Editor.
|
||||||
|
|||||||
Reference in New Issue
Block a user