mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
Document host platform (#3893)
This commit is contained in:
Clyde Stubbs
GitHub
parent
0626032aca
commit
66e70ecc88
38
components/host.rst
Normal file
38
components/host.rst
Normal file
@ -0,0 +1,38 @@
|
||||
HOST Platform
|
||||
=============
|
||||
|
||||
.. seo::
|
||||
:description: Configuration for the host platform for ESPHome.
|
||||
:image: host.svg
|
||||
|
||||
The ``host`` platform allows ESPHome configurations to be compiled and run on a desktop computer. This is known
|
||||
to work on MacOS and Linux. On Windows `WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_ (Windows Subsystem for Linux) can be used to create a Linux environment that will run ESPHome.
|
||||
|
||||
The only configuration required is to optionally set a dummy MAC address that will be used to identify the
|
||||
configuration to Home Assistant (the native MAC address is not readily available.)
|
||||
|
||||
.. note::
|
||||
|
||||
HA will not automatically discover an ESPHome instance running on ``host`` using MDNS, and you will need
|
||||
to add it explicitly using the IP address of your host computer.
|
||||
|
||||
Many components, especially those interfacing to actual hardware, will not be available when using ``host``. Do not
|
||||
configure wifi - network will automatically be available using the host computer.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
host:
|
||||
mac_address: "98:35:69:ab:f6:79"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **mac_address** (**Optional**, MAC address): A dummy MAC address to use when communicating with HA.
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`esphome`
|
||||
- :ghedit:`Edit`
|
||||
19
images/host.svg
Normal file
19
images/host.svg
Normal file
@ -0,0 +1,19 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
|
||||
<svg height="300px" width="300px" version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
viewBox="0 0 34.418 34.418" xml:space="preserve">
|
||||
<g>
|
||||
<path style="fill:#010002;" d="M32.335,11.606h-6.533v-1.009h6.533V11.606z M32.335,12.264h-6.533v1.011h6.533V12.264z
|
||||
M32.331,7.687h-6.523V9.91h6.523V7.687z M34.418,5.297v23.827c-0.001,0.357-0.292,0.648-0.65,0.648h-9.397
|
||||
c-0.359,0-0.649-0.291-0.649-0.649V5.297c0-0.358,0.29-0.65,0.649-0.65h9.397C34.127,4.647,34.418,4.939,34.418,5.297z
|
||||
M33.119,5.944h-8.1v22.53h8.1V5.944z M32.335,13.932h-6.533v1.008h6.533V13.932z M31.272,21.45c0,1.162-0.939,2.099-2.097,2.099
|
||||
c-1.16,0-2.099-0.938-2.099-2.099c0-1.158,0.94-2.098,2.099-2.098C30.333,19.352,31.272,20.293,31.272,21.45z M30.515,21.45
|
||||
c0-0.739-0.6-1.341-1.341-1.341c-0.742,0-1.342,0.601-1.342,1.341s0.6,1.34,1.342,1.34C29.915,22.79,30.515,22.19,30.515,21.45z
|
||||
M21.937,9.218v13.505c0,0.814-0.655,1.473-1.461,1.473H13.18c0,0-0.414,2.948,2.212,2.948v1.475H13.18H8.758H6.546v-1.473
|
||||
c2.529,0,2.212-2.948,2.212-2.948H1.465C0.656,24.198,0,23.539,0,22.725V9.218c0-0.814,0.656-1.47,1.465-1.47h19.01
|
||||
C21.282,7.748,21.937,8.404,21.937,9.218z M12.332,22.394c0-0.698-0.566-1.263-1.264-1.263c-0.699,0-1.266,0.565-1.266,1.263
|
||||
s0.566,1.265,1.266,1.265C11.767,23.659,12.332,23.092,12.332,22.394z M20.371,9.311H1.568v11.387H20.37h0.001
|
||||
C20.371,20.698,20.371,9.311,20.371,9.311z M11.081,21.603c-0.434,0-0.785,0.352-0.785,0.785s0.352,0.785,0.785,0.785
|
||||
s0.785-0.352,0.785-0.785S11.515,21.603,11.081,21.603z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.6 KiB |
Loading…
Reference in New Issue
Block a user