Update host-related docs (#4058)

This commit is contained in:
Clyde Stubbs 2024-07-17 10:31:51 +10:00 committed by GitHub
parent c34865a27e
commit d8fa6e6f60
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 12 deletions

View File

@ -17,14 +17,13 @@ than compiling for and flashing a microcontroller target system.
.. code-block:: yaml
# Example configuration entry
esphome:
name: sdl
host:
mac_address: "62:23:45:AF:B3:DD"
display:
- platform: sdl
id: sdl_display
update_interval: 1s
auto_clear_enabled: false
show_test_card: true
dimensions:
width: 450
@ -95,13 +94,7 @@ Linux instructions above. See https://learn.microsoft.com/en-us/windows/wsl/inst
Build and run
-------------
The ``esphome`` command will not automatically run the build file on the ``host`` platform. Instead use ``esphome compile yourfile.yaml``
then locate the executable file called ``program`` within the ``.esphome`` build tree:
.. code-block:: sh
`find .esphome -name program`
The ``esphome run yourfile.yaml`` command will compile and automatically run the build file on the ``host`` platform.
See Also
--------

View File

@ -23,17 +23,23 @@ configure wifi - network will automatically be available using the host computer
# Example configuration entry
host:
mac_address: "98:35:69:ab:f6:79"
mac_address: "06:35:69:ab:f6:79"
Configuration variables:
------------------------
- **mac_address** (**Optional**, MAC address): A dummy MAC address to use when communicating with HA.
Build and run
-------------
The ``esphome run yourfile.yaml`` command will compile and automatically run the build file on the ``host`` platform.
See Also
--------
- :ref:`SDL display <sdl>`
- :doc:`esphome`
- :doc:`/components/time/host`
- :ghedit:`Edit`