Skip to content

Commit 1f8cd8c

Browse files
committed
Proofread and typos fixed
1 parent 78a10e5 commit 1f8cd8c

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

guides/beginners_guide_adding_devices.rst

+16-11
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,16 @@ This guide is for people who are not so tech-orientated but wish to get their fe
1212
ESPHome devices usually rely on Home Assistant. It's more than just an excellent way to control and automate your home.
1313
It can also manage many IoT devices. Read more about `Home Assistant <https://www.home-assistant.io/>`__.
1414

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`.
1520

1621
Setting up your Secrets
1722
-----------------------
1823

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.
2025

2126
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.
2227

@@ -47,8 +52,8 @@ Finally, ``ap_password`` sets a password for the hotspot that an ESPHome device
4752

4853
.. note::
4954

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.
5257

5358
.. warning::
5459

@@ -65,8 +70,8 @@ OTA
6570
6671
An ``ota_password`` is used to securely send Over-the-Air (OTA) updates from ESPHome to a device.
6772
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.
7075

7176
MQTT
7277
****
@@ -79,7 +84,7 @@ MQTT
7984
8085
These lines regard the MQTT (Message Queue Telemetry Transport) protocol. MQTT is a lightweight, publish-subscribe-based messaging protocol that is
8186
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.
8388

8489
Save
8590
****
@@ -371,7 +376,7 @@ ota:
371376
This section is pretty important. It allows `Over-the-Air Updates <https://esphome.io/components/ota/>`__.
372377
Unless you want to make a physical connection to the device every time you want to update it, you should keep this section.
373378

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.
375380
As a bonus, we finally get to use one of the secrets we created earlier.
376381

377382
.. code-block:: yaml
@@ -445,10 +450,10 @@ captive_portal:
445450
captive_portal:
446451
447452
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.
449454
This allows you allows you to give the device new wireless network credentials when the device cannot connect to the network it expects.
450455

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
452457
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.
453458

454459
Other Sections (Device Configuration)
@@ -602,10 +607,10 @@ What's Next?
602607
Now you're ready to actually flash the device with your fresh ESPHome binary!
603608

604609
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>`,
606611
it's also pretty easy.
607612

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>`!
609614

610615
See Also
611616
--------

guides/beginners_guide_docker_desktop.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Install Docker Desktop
2828
----------------------
2929

3030
Download and install the appropriate version of Docker Desktop from `the official site <https://www.docker.com/products/docker-desktop/>`__.
31-
On Windows, this will also install any needed dependencies like WSL (Windows Subsystem for Linux). MacOS may install VirtualBox.
32-
You should accept any required other installs.
31+
On Windows, this will also install any needed dependencies like WSL (Windows Subsystem for Linux). On Mac, it will make sure you have
32+
Apple Virtualization Framework. You should accept any required other installs.
3333

3434
If you have installation issues, please refer to the docker documentation for
3535
`Windows <https://docs.docker.com/desktop/install/windows-install/>`__,
@@ -40,9 +40,9 @@ Please note that although Docker Desktop is not particularly large, containers l
4040
can take up a lot of space, too. You might be okay with 5GB free space but 10GB or more is highly recommended as a minimum since building
4141
binaries can also take up space.
4242

43-
If you Docker asks you to login, you can skip this.
43+
If Docker asks you to login, you can skip this.
4444

45-
Docker usually needs to reboot to finalize the installation.
45+
Docker may also require a reboot to finalize the installation.
4646

4747
Add the ESPHome container
4848
-------------------------
@@ -99,7 +99,6 @@ If your window looks like something like this, congratulations! You are now run
9999
:width: 95.0%
100100
:alt: Docker Desktop showing the container running
101101

102-
103102
Go back to the Containers tab to manage the ESPHome container and ``Open with browser`` anytime the container is running.
104103

105104
.. figure:: images/noob_docker_6.png
@@ -192,7 +191,7 @@ and restart the container with your previous settings. It will do this to all e
192191
What's Next?
193192
------------
194193

195-
Now you can add your :ref:`first ESPHome device <beginners_guide_adding_devices>`!
194+
Now you can add your :doc:`first ESPHome device <beginners_guide_adding_devices>`!
196195

197196
See Also
198197
--------

0 commit comments

Comments
 (0)