mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
commit
12c3b85fa3
2
Doxygen
2
Doxygen
@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
|
|||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 2021.10.0b3
|
PROJECT_NUMBER = 2021.10.0b4
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
|||||||
ESPHOME_PATH = ../esphome
|
ESPHOME_PATH = ../esphome
|
||||||
ESPHOME_REF = 2021.10.0b3
|
ESPHOME_REF = 2021.10.0b4
|
||||||
|
|
||||||
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
2021.10.0b3
|
2021.10.0b4
|
@ -161,6 +161,13 @@ Beta Fixes
|
|||||||
- Fix: Color modes not being correctly used in light partitions :esphomepr:`2513` by :ghuser:`paulmonigatti`
|
- Fix: Color modes not being correctly used in light partitions :esphomepr:`2513` by :ghuser:`paulmonigatti`
|
||||||
- Don't define UART_SELECTION_UART2 when UART2 is unavailable :esphomepr:`2512` by :ghuser:`oxan`
|
- Don't define UART_SELECTION_UART2 when UART2 is unavailable :esphomepr:`2512` by :ghuser:`oxan`
|
||||||
- Remove BME680_BSEC test :esphomepr:`2518` by :ghuser:`paulmonigatti`
|
- Remove BME680_BSEC test :esphomepr:`2518` by :ghuser:`paulmonigatti`
|
||||||
|
- Add pressure compensation during runtime :esphomepr:`2493` by :ghuser:`martgras`
|
||||||
|
- Fix Nextion HTTPClient error for ESP32 :esphomepr:`2524` by :ghuser:`kbx81`
|
||||||
|
- Fix bug in register name definition :esphomepr:`2526` by :ghuser:`martgras`
|
||||||
|
- Replace framework version_hint with source option :esphomepr:`2529` by :ghuser:`oxan`
|
||||||
|
- Fix bitshift on read in ADE7953 :esphomepr:`2537` by :ghuser:`oxan`
|
||||||
|
- Allow downloading all bin files from backend in dashboard :esphomepr:`2514` by :ghuser:`jesserockz`
|
||||||
|
- Bump dashboard to 20211015.0 :esphomepr:`2525` by :ghuser:`balloob`
|
||||||
|
|
||||||
All changes
|
All changes
|
||||||
^^^^^^^^^^^
|
^^^^^^^^^^^
|
||||||
@ -346,6 +353,13 @@ All changes
|
|||||||
- Fix: Color modes not being correctly used in light partitions :esphomepr:`2513` by :ghuser:`paulmonigatti`
|
- Fix: Color modes not being correctly used in light partitions :esphomepr:`2513` by :ghuser:`paulmonigatti`
|
||||||
- Don't define UART_SELECTION_UART2 when UART2 is unavailable :esphomepr:`2512` by :ghuser:`oxan`
|
- Don't define UART_SELECTION_UART2 when UART2 is unavailable :esphomepr:`2512` by :ghuser:`oxan`
|
||||||
- Remove BME680_BSEC test :esphomepr:`2518` by :ghuser:`paulmonigatti`
|
- Remove BME680_BSEC test :esphomepr:`2518` by :ghuser:`paulmonigatti`
|
||||||
|
- Add pressure compensation during runtime :esphomepr:`2493` by :ghuser:`martgras`
|
||||||
|
- Fix Nextion HTTPClient error for ESP32 :esphomepr:`2524` by :ghuser:`kbx81`
|
||||||
|
- Fix bug in register name definition :esphomepr:`2526` by :ghuser:`martgras`
|
||||||
|
- Replace framework version_hint with source option :esphomepr:`2529` by :ghuser:`oxan`
|
||||||
|
- Fix bitshift on read in ADE7953 :esphomepr:`2537` by :ghuser:`oxan`
|
||||||
|
- Allow downloading all bin files from backend in dashboard :esphomepr:`2514` by :ghuser:`jesserockz`
|
||||||
|
- Bump dashboard to 20211015.0 :esphomepr:`2525` by :ghuser:`balloob`
|
||||||
|
|
||||||
Past Changelogs
|
Past Changelogs
|
||||||
---------------
|
---------------
|
||||||
|
@ -25,7 +25,7 @@ transmitted data.
|
|||||||
|
|
||||||
The CAN bus itself has only two wires named Can High and Can Low or CanH and CanL. For the ESPHome
|
The CAN bus itself has only two wires named Can High and Can Low or CanH and CanL. For the ESPHome
|
||||||
CAN bus to work you need to select the device that has the physical CAN bus implemented.
|
CAN bus to work you need to select the device that has the physical CAN bus implemented.
|
||||||
At this moment only the MCP2515 driver is supported. You can configure multiple buses.
|
At this moment only the MCP2515 controller is supported. You can configure multiple buses.
|
||||||
|
|
||||||
Any can bus node can transmit data at any time, and any node can send any ``can_id`` value and any
|
Any can bus node can transmit data at any time, and any node can send any ``can_id`` value and any
|
||||||
node can receive any can_id too. Is up to you how to organize the can_id values. You can setup a can
|
node can receive any can_id too. Is up to you how to organize the can_id values. You can setup a can
|
||||||
|
@ -58,6 +58,7 @@ Configuration variables:
|
|||||||
- **pin** (*Optional*, int): The pin for the device, as
|
- **pin** (*Optional*, int): The pin for the device, as
|
||||||
set in the app. The default is usually printed on the
|
set in the app. The default is usually printed on the
|
||||||
device. Defaults to ``8888``.
|
device. Defaults to ``8888``.
|
||||||
|
- **invert_position** (*Optional*, boolean): Inverts the position value to and from the device. Set if ESPHome is swapping around the open/close state of the cover.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||||
- All other options from :ref:`Cover <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
|
2
conf.py
2
conf.py
@ -69,7 +69,7 @@ author = "Otto Winter"
|
|||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = "2021.10"
|
version = "2021.10"
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = "2021.10.0b3"
|
release = "2021.10.0b4"
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
Using ESPHome for your Project
|
Sharing ESPHome devices
|
||||||
==============================
|
=======================
|
||||||
|
|
||||||
.. seo::
|
.. seo::
|
||||||
:description: Information for creators when using ESPHome firmware.
|
:description: Information for creating and sharing devices using ESPHome firmware.
|
||||||
|
|
||||||
We have added configuration options to ESPHome to make it easier for creators
|
We have added configuration options to ESPHome to make it easier
|
||||||
to create, configure, install and distribute devices running ESPHome.
|
to create, configure, install and distribute devices running ESPHome.
|
||||||
|
|
||||||
Example configuration
|
Example configuration
|
||||||
@ -24,6 +24,10 @@ Example configuration
|
|||||||
name: jesse.temperature_monitor
|
name: jesse.temperature_monitor
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
|
|
||||||
|
# This should point to the public location of this yaml file.
|
||||||
|
dashboard_import:
|
||||||
|
package_import_url: github://jesserockz/dummy-esphome-configs@v1/temperature-monitor.yaml
|
||||||
|
|
||||||
wifi:
|
wifi:
|
||||||
# Set up a wifi access point
|
# Set up a wifi access point
|
||||||
ap:
|
ap:
|
||||||
@ -50,6 +54,9 @@ Relevant Documentation
|
|||||||
- ``wifi`` -> ``networks: []`` allows you to flash a device that will not contain any
|
- ``wifi`` -> ``networks: []`` allows you to flash a device that will not contain any
|
||||||
credentials and they must be set by the user via either the ``ap`` + ``captive_portal`` or
|
credentials and they must be set by the user via either the ``ap`` + ``captive_portal`` or
|
||||||
the ``esp32_improv`` components.
|
the ``esp32_improv`` components.
|
||||||
|
- ``dashboard_import`` -> ``package_import_url`` - This should point to the public repository containing
|
||||||
|
the configuration for the device so that the user's ESPHome dashboard can autodetect this device and
|
||||||
|
create a minimal YAML using :ref:`config-git_packages`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -726,7 +726,6 @@ Contributors
|
|||||||
- `workingmanrob (@workingmanrob) <https://github.com/workingmanrob>`__
|
- `workingmanrob (@workingmanrob) <https://github.com/workingmanrob>`__
|
||||||
- `Wojtek Strzalka (@wstrzalka) <https://github.com/wstrzalka>`__
|
- `Wojtek Strzalka (@wstrzalka) <https://github.com/wstrzalka>`__
|
||||||
- `wutr (@wutr) <https://github.com/wutr>`__
|
- `wutr (@wutr) <https://github.com/wutr>`__
|
||||||
- `xheronimo (@xheronimo) <https://github.com/xheronimo>`__
|
|
||||||
- `Mike (@xsnoopy) <https://github.com/xsnoopy>`__
|
- `Mike (@xsnoopy) <https://github.com/xsnoopy>`__
|
||||||
- `Yaroslav (@Yarikx) <https://github.com/Yarikx>`__
|
- `Yaroslav (@Yarikx) <https://github.com/Yarikx>`__
|
||||||
- `Marcin Jaworski (@yawor) <https://github.com/yawor>`__
|
- `Marcin Jaworski (@yawor) <https://github.com/yawor>`__
|
||||||
@ -739,7 +738,8 @@ Contributors
|
|||||||
- `zaluthar (@zaluthar) <https://github.com/zaluthar>`__
|
- `zaluthar (@zaluthar) <https://github.com/zaluthar>`__
|
||||||
- `ZJY (@zhangjingye03) <https://github.com/zhangjingye03>`__
|
- `ZJY (@zhangjingye03) <https://github.com/zhangjingye03>`__
|
||||||
- `San (@zhujunsan) <https://github.com/zhujunsan>`__
|
- `San (@zhujunsan) <https://github.com/zhujunsan>`__
|
||||||
|
- `Zoltant7 (@Zoltant7) <https://github.com/Zoltant7>`__
|
||||||
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
||||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||||
|
|
||||||
*This page was last updated October 15, 2021.*
|
*This page was last updated October 17, 2021.*
|
||||||
|
@ -69,7 +69,7 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
|
|||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a class="reference" href="/guides/creators.html">
|
<a class="reference" href="/guides/creators.html">
|
||||||
Creating a Project
|
Sharing ESPHome devices
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
|
Loading…
Reference in New Issue
Block a user