You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/beginners_guide_adding_devices.rst
+16-11
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,16 @@ This guide is for people who are not so tech-orientated but wish to get their fe
12
12
ESPHome devices usually rely on Home Assistant. It's more than just an excellent way to control and automate your home.
13
13
It can also manage many IoT devices. Read more about `Home Assistant <https://www.home-assistant.io/>`__.
14
14
15
+
If you are already running Home Assistant, check out :doc:`getting_started_hassio` to run ESPHome as an add-on.
16
+
17
+
If running Home Assistant in Docker, get ESPHome by following instructions in the first part of :doc:`getting_started_command_line`.
18
+
19
+
Or if not running Docker or Home Assistant at all, you can try :doc:`beginners_guide_docker_desktop`.
15
20
16
21
Setting up your Secrets
17
22
-----------------------
18
23
19
-
The first thing you should do is edit up your ``Secrets`` file. This contains reusable elements that you can "hide" from the main ESPHome GUI.
24
+
The first thing you should do is edit your ``Secrets`` file. This contains reusable elements that you can "hide" from the main ESPHome GUI.
20
25
21
26
Also, it allows you to copy and paste YAMLs from your own code to share with others (and vice versa) without the worry of leaking details about your home network.
22
27
@@ -47,8 +52,8 @@ Finally, ``ap_password`` sets a password for the hotspot that an ESPHome device
47
52
48
53
.. note::
49
54
50
-
Please note in the above example, I have included comments with the ``#`` character. Comments can be added as their own lines at the end of lines.
51
-
Anything in the line following the ``#`` are ignored. In more complicated YAML files, comments can be used to explain what a particular section of code is doing.
55
+
Please note in the above example, I have included comments with the ``#`` character. Comments can be added as their own lines or at the end of lines.
56
+
Anything in the line after the ``#`` are ignored. Often, comments can be used to explain what a particular section of code is doing.
52
57
53
58
.. warning::
54
59
@@ -65,8 +70,8 @@ OTA
65
70
66
71
An ``ota_password`` is used to securely send Over-the-Air (OTA) updates from ESPHome to a device.
67
72
For beginners, it is a good idea to use the same password for all of your ESPHome devices. This will ensure your updates are not broken by ESPHome's
68
-
default behavior of creating new passwords for every device. You can make this password however long and complicated
69
-
as you like because you will not have to remember it.
73
+
default behavior of creating new passwords for every device. You can make this password as long and complicated as you like because
74
+
you will not have to remember it.
70
75
71
76
MQTT
72
77
****
@@ -79,7 +84,7 @@ MQTT
79
84
80
85
These lines regard the MQTT (Message Queue Telemetry Transport) protocol. MQTT is a lightweight, publish-subscribe-based messaging protocol that is
81
86
commonly used in IoT devices. The ``mqtt_broker`` is the IP address of the MQTT server and the ``mqtt_name`` and ``mqtt_password`` are the username and password.
82
-
If you are not running an MQTT server, you do not need to add these to your secrets just yet.
87
+
If you are not running an MQTT server, you do not need to add these to your secrets yet.
83
88
84
89
Save
85
90
****
@@ -371,7 +376,7 @@ ota:
371
376
This section is pretty important. It allows `Over-the-Air Updates <https://esphome.io/components/ota/>`__.
372
377
Unless you want to make a physical connection to the device every time you want to update it, you should keep this section.
373
378
374
-
And unfortunately, it's incomplete. As of 2024.6.0, ESPHome has changed the way OTA updates are specified.
379
+
Unfortunately, it's incomplete. As of 2024.6.0, ESPHome has changed the way OTA updates are specified.
375
380
As a bonus, we finally get to use one of the secrets we created earlier.
376
381
377
382
.. code-block:: yaml
@@ -445,10 +450,10 @@ captive_portal:
445
450
captive_portal:
446
451
447
452
The `captive_portal <https://esphome.io/components/captive_portal.html>`__ section is responsible to create a special web server using
448
-
the hotspot created in conjunction with the `ap` information specified above.
453
+
the hotspot created in conjunction with the `ap:` information specified above.
449
454
This allows you allows you to give the device new wireless network credentials when the device cannot connect to the network it expects.
450
455
451
-
When you connect to the fallback network, the web interface should open automatically or there should be a prompt on your phone to open
456
+
When you connect to the fallback hotspot, the web interface should open automatically or there should be a prompt on your phone to open
452
457
the login. If that does not work, you can also navigate to `http://192.168.4.1/ <http://192.168.4.1/>`__ manually in your browser.
453
458
454
459
Other Sections (Device Configuration)
@@ -602,10 +607,10 @@ What's Next?
602
607
Now you're ready to actually flash the device with your fresh ESPHome binary!
603
608
604
609
If you're lucky, the device already has ESPHome, you can actually just connect to it via web browser and upload your new binary file.
605
-
If your device already has :ref:`Tasmota <migrate_sonoff_tasmota>`, :ref:`ESPEasy <migrate_espeasy>`, or :ref:`ESPurna <migrate_espurna>`,
610
+
If your device already has :doc:`Tasmota <migrate_sonoff_tasmota>`, :doc:`ESPEasy <migrate_espeasy>`, or :doc:`ESPurna <migrate_espurna>`,
606
611
it's also pretty easy.
607
612
608
-
Harder, but possibly necessary, make a :ref:`physical connection to the device <physical device connection>`!
613
+
Harder, but possibly necessary, make a :doc:`physical connection to the device <physical device connection>`!
0 commit comments