mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-22 21:41:39 +01:00
Advertise esphomeflasher (#76)
This commit is contained in:
Otto Winter
GitHub
parent
1c54afc2a8
commit
b716ba0a8d
@ -35,6 +35,10 @@ Configuration variables:
|
||||
to https://esphomelib.com/_static/webserver-v1.min.js.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
|
||||
.. note::
|
||||
|
||||
Starting with version 1.9.0, you can also upload firmware files OTA with the web server.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
||||
@ -38,6 +38,42 @@ Tips for using esphomeyaml
|
||||
.. |include| replace:: ``!include``
|
||||
.. _include: https://www.home-assistant.io/docs/configuration/splitting_configuration/
|
||||
|
||||
I can't get flashing over USB to work.
|
||||
--------------------------------------
|
||||
|
||||
esphomeyaml depends on the operating system the tool is running on to recognize
|
||||
the ESP. This can sometimes fail (driver missing, inside docker container, ...).
|
||||
Starting with esphomelib 1.9.0, the esphomelib suite provides
|
||||
`esphomeflasher <https://github.com/OttoWinter/esphomeflasher>`__, a tool to flash ESPs over USB.
|
||||
|
||||
First, you need to get the firmware file to flash. For HassIO add-on based installs you can
|
||||
use the ``COMPILE`` button and then press ``Download Binary``. For command line based installs you
|
||||
can access the file under ``<CONFIG_DIR>/<NODE_NAME>/.pioenvs/<NODE_NAME>/firmware.bin``.
|
||||
|
||||
Then, install esphomeflasher by going to the `releases page <https://github.com/OttoWinter/esphomeflasher/releases>`__
|
||||
and downloading one of the pre-compiled binaries. Open up the application and select the serial port
|
||||
you want to flash to (on windows you can use the "device manager" to check if it's the right one).
|
||||
|
||||
.. figure:: images/esphomeflasher-ui.png
|
||||
:align: center
|
||||
:width: 80%
|
||||
|
||||
Select the firmware binary and finally press "Flash ESP".
|
||||
|
||||
.. note::
|
||||
|
||||
If the serial port is not showing up, you might not have the required drivers installed.
|
||||
ESPs usually ship with one of these two UART chips:
|
||||
|
||||
* CP2102 (square chip): `driver <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`__
|
||||
* CH341: `driver <https://github.com/nodemcu/nodemcu-devkit/tree/master/Drivers>`__
|
||||
|
||||
.. note::
|
||||
|
||||
If you're just seeing ``Connecting....____....`` on the screen and the flashing fails, that's
|
||||
usually a sign that the ESP is defect or cannot be programmed. Please double check the UART wires
|
||||
are connected correctly if flashing using a USB to UART bridge.
|
||||
|
||||
What's the difference between esphomelib and esphomeyaml?
|
||||
---------------------------------------------------------
|
||||
|
||||
@ -258,6 +294,18 @@ First we temporary 'remove' (comment out) all components from the ``yaml`` file,
|
||||
|
||||
This will result in really small firmware data which has a high chance of fitting the remaining space on your device. After this OTA update has succeeded you are left with a device with no functionality except OTA. Now you can re-enable all components previously commented out and perform a 'normal' OTA update again.
|
||||
|
||||
Donations
|
||||
---------
|
||||
|
||||
I invest lots of time into this project, so if you like esphomelib and want to support the project, donations
|
||||
are very welcome.
|
||||
|
||||
Before donating here though, please consider donating to charity (for example the red cross, UNICEF, greenpeace, ...).
|
||||
They can use the money much better than I can. Also, I don't want donations for feature requests as I cannot
|
||||
_guarantee_ that I can get a specific feature to work reliably.
|
||||
|
||||
Donations are currently only possible via PayPal: https://www.paypal.me/ottowinter
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
||||
@ -35,11 +35,6 @@ creating your first configuration.
|
||||
:align: center
|
||||
:width: 95.0%
|
||||
|
||||
.. note::
|
||||
|
||||
If the UI isn't showing up correctly, it's probably because your browser isn't
|
||||
supported. Please try using Google Chrome in that case.
|
||||
|
||||
Dashboard Interface
|
||||
-------------------
|
||||
|
||||
@ -68,8 +63,8 @@ there are three basic actions you can perform:
|
||||
.. note::
|
||||
|
||||
If you're having problems with flashing over USB, you can always download the firmware using the
|
||||
``COMPILE`` button and upload the firmware using an application like
|
||||
`pyflasher <https://github.com/marcelstoer/nodemcu-pyflasher>`__.
|
||||
``COMPILE`` button and flash the firmware using `esphomeflasher
|
||||
<https://github.com/OttoWinter/esphomeflasher/releases>`__.
|
||||
|
||||
- **SHOW LOGS**: With this command you can view all the logs the node is outputting. If a USB device is
|
||||
connected, it will attempt to use the serial connection. Otherwise it will use the built-in MQTT logs.
|
||||
@ -87,7 +82,7 @@ intend to flash an esphomeyaml firmware onto. Then proceed with uploading the fi
|
||||
upload button.
|
||||
|
||||
HassIO add-on options
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
*********************
|
||||
|
||||
Since version 1.8.0, you can optionally specify a password to use for all traffic to esphomeyaml
|
||||
using the ``password`` option in the HassIO add-on page. By default, this is an empty string
|
||||
|
||||
BIN
esphomeyaml/guides/images/esphomeflasher-ui.png
Normal file
BIN
esphomeyaml/guides/images/esphomeflasher-ui.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
79
esphomeyaml/images/logo.svg
Normal file
79
esphomeyaml/images/logo.svg
Normal file
@ -0,0 +1,79 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 107.72 85.04" style="enable-background:new 0 0 107.72 85.04;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:none;stroke:#000000;stroke-width:2.1775;stroke-miterlimit:10;}
|
||||
.st1{fill:none;stroke:#000000;stroke-width:2.4195;stroke-miterlimit:10;}
|
||||
.st2{fill:none;stroke:#000000;stroke-width:1.961;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
|
||||
.st3{fill:none;stroke:#000000;stroke-width:2.1586;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
|
||||
</style>
|
||||
<g id="XMLID_91_">
|
||||
<g id="XMLID_113_">
|
||||
<g id="XMLID_124_">
|
||||
<path id="XMLID_125_" class="st0" d="M80.63,26.18l0-4.18c0-1.47,1.19-2.66,2.66-2.66s2.66,1.19,2.66,2.66l0,4.18"/>
|
||||
</g>
|
||||
<g id="XMLID_122_">
|
||||
<path id="XMLID_123_" class="st0" d="M71.68,26.18l0-4.18c0-1.47,1.19-2.66,2.66-2.66S77,20.52,77,21.99l0,4.18"/>
|
||||
</g>
|
||||
<g id="XMLID_120_">
|
||||
<path id="XMLID_121_" class="st0" d="M62.72,26.18l0-4.18c0-1.47,1.19-2.66,2.66-2.66s2.66,1.19,2.66,2.66v4.18"/>
|
||||
</g>
|
||||
<g id="XMLID_118_">
|
||||
<path id="XMLID_119_" class="st0" d="M53.76,26.18l0-4.18c0-1.47,1.19-2.66,2.66-2.66s2.66,1.19,2.66,2.66v4.18"/>
|
||||
</g>
|
||||
<g id="XMLID_116_">
|
||||
<path id="XMLID_117_" class="st0" d="M44.8,26.18l0-4.18c0-1.47,1.19-2.66,2.66-2.66s2.66,1.19,2.66,2.66l0,4.18"/>
|
||||
</g>
|
||||
<g id="XMLID_114_">
|
||||
<path id="XMLID_115_" class="st0" d="M35.85,26.18l0-4.18c0-1.47,1.19-2.66,2.66-2.66s2.66,1.19,2.66,2.66l0,4.18"/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="XMLID_100_">
|
||||
<g id="XMLID_111_">
|
||||
<path id="XMLID_112_" class="st0" d="M85.95,66.07v4.68c0,1.47-1.19,2.66-2.66,2.66c-1.47,0-2.66-1.19-2.66-2.66v-4.68"/>
|
||||
</g>
|
||||
<g id="XMLID_109_">
|
||||
<path id="XMLID_110_" class="st0" d="M77,66.07l0,4.68c0,1.47-1.19,2.66-2.66,2.66c-1.47,0-2.66-1.19-2.66-2.66l0-4.68"/>
|
||||
</g>
|
||||
<g id="XMLID_107_">
|
||||
<path id="XMLID_108_" class="st0" d="M68.04,66.07l0,4.68c0,1.47-1.19,2.66-2.66,2.66c-1.47,0-2.66-1.19-2.66-2.66v-4.68"/>
|
||||
</g>
|
||||
<g id="XMLID_105_">
|
||||
<path id="XMLID_106_" class="st0" d="M59.08,66.07l0,4.68c0,1.47-1.19,2.66-2.66,2.66c-1.47,0-2.66-1.19-2.66-2.66l0-4.68"/>
|
||||
</g>
|
||||
<g id="XMLID_103_">
|
||||
<path id="XMLID_104_" class="st0" d="M50.12,66.07v4.68c0,1.47-1.19,2.66-2.66,2.66c-1.47,0-2.66-1.19-2.66-2.66l0-4.68"/>
|
||||
</g>
|
||||
<g id="XMLID_101_">
|
||||
<path id="XMLID_102_" class="st0" d="M41.17,66.33l0,4.43c0,1.47-1.19,2.66-2.66,2.66c-1.47,0-2.66-1.19-2.66-2.66l0-4.43"/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="XMLID_98_">
|
||||
<path id="XMLID_99_" class="st1" d="M87.29,26.18H34.51c-0.53,0-0.97,0.43-0.97,0.97l0,37.96c0,0.53,0.43,0.97,0.97,0.97l52.77,0
|
||||
c0.53,0,0.97-0.43,0.97-0.97l0-37.96C88.25,26.61,87.82,26.18,87.29,26.18z"/>
|
||||
</g>
|
||||
<g id="XMLID_95_">
|
||||
<polygon id="XMLID_97_" points="69.6,45.42 69.6,40.35 67.8,40.35 67.8,43.63 60.99,36.82 49.5,48.32 52.37,48.32 52.37,56.07
|
||||
69.62,56.07 69.62,48.32 72.49,48.32 "/>
|
||||
<polygon id="XMLID_96_" class="st2" points="69.6,45.42 69.6,40.35 67.8,40.35 67.8,43.63 60.99,36.82 49.5,48.32 52.37,48.32
|
||||
52.37,56.07 69.62,56.07 69.62,48.32 72.49,48.32 "/>
|
||||
</g>
|
||||
<g id="XMLID_93_">
|
||||
<polyline id="XMLID_94_" class="st3" points="33.34,63.77 17.52,63.77 17.52,59.88 29.38,59.88 29.38,55.99 17.52,55.99
|
||||
17.52,52.11 29.38,52.11 29.38,48.22 17.52,48.22 17.52,44.33 29.38,44.33 29.38,40.45 17.52,40.45 17.52,28.47 "/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="XMLID_225_">
|
||||
</g>
|
||||
<g id="XMLID_226_">
|
||||
</g>
|
||||
<g id="XMLID_227_">
|
||||
</g>
|
||||
<g id="XMLID_228_">
|
||||
</g>
|
||||
<g id="XMLID_229_">
|
||||
</g>
|
||||
<g id="XMLID_230_">
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.7 KiB |
Loading…
Reference in New Issue
Block a user