Skip to content

Commit 7f567e0

Browse files
authored
Document multiple device address support in CLI commands (#5192)
1 parent 5a5b252 commit 7f567e0

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

guides/cli.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,16 @@ The ``esphome run <CONFIG>`` command is the most common command for ESPHome. It
7575

7676
Manually specify the upload port/IP to use. For example ``/dev/cu.SLAB_USBtoUART``, or ``192.168.1.176``
7777
to perform an OTA.
78+
79+
Multiple ``--device`` options can be specified to provide fallback addresses. ESPHome will
80+
try each address in order until one succeeds. This is particularly useful for devices with
81+
multiple IP addresses (IPv4/IPv6).
82+
83+
Example:
84+
85+
.. code-block:: console
86+
87+
esphome run my-device.yaml --device 192.168.1.100 --device 2001:db8::1
7888
7989
.. option:: --upload_speed BAUD_RATE
8090

@@ -141,6 +151,15 @@ The ``esphome upload <CONFIG>`` validates the configuration and uploads the most
141151

142152
Manually specify the upload port/IP address to use. For example ``/dev/cu.SLAB_USBtoUART``, or ``192.168.1.176``
143153
to perform an OTA.
154+
155+
Multiple ``--device`` options can be specified to provide fallback addresses. ESPHome will
156+
try each address in order until one succeeds.
157+
158+
Example:
159+
160+
.. code-block:: console
161+
162+
esphome upload my-device.yaml --device 192.168.1.100 --device 2001:db8::1
144163
145164
.. option:: --upload_speed BAUD_RATE
146165

@@ -267,6 +286,16 @@ The ``esphome logs <CONFIG>`` command validates the configuration and shows all
267286
.. option:: --device SERIAL_PORT
268287

269288
Manually specify a serial port/IP to use. For example ``/dev/cu.SLAB_USBtoUART``.
289+
290+
Multiple ``--device`` options can be specified to provide fallback addresses. When using the
291+
native API for logs, all addresses are passed to the API client which uses the Happy Eyeballs
292+
algorithm (RFC 8305) to efficiently connect using the fastest available address.
293+
294+
Example:
295+
296+
.. code-block:: console
297+
298+
esphome logs my-device.yaml --device 192.168.1.100 --device 2001:db8::1
270299
271300
.. option:: --reset
272301

0 commit comments

Comments
 (0)