mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-29 22:51:44 +01:00
commit
f7e42d18d4
2
Doxygen
2
Doxygen
@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = 1.16.0b1
|
||||
PROJECT_NUMBER = 1.16.0b2
|
||||
|
||||
# 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
|
||||
|
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
||||
ESPHOME_PATH = ../esphome
|
||||
ESPHOME_REF = v1.16.0b1
|
||||
ESPHOME_REF = v1.16.0b2
|
||||
|
||||
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png
|
||||
|
||||
|
@ -1 +1 @@
|
||||
1.16.0b1
|
||||
1.16.0b2
|
@ -230,3 +230,8 @@ All changes
|
||||
- esphome: Bump platformio from 5.0.3 to 5.0.4 :esphomepr:`1444` by :ghuser:`dependabot[bot]`
|
||||
- esphome: Fix SN74HC595 with optional OE pin :esphomepr:`1454` by :ghuser:`rradar`
|
||||
- esphome: Fix stepper half half step mode :esphomepr:`1397` by :ghuser:`Fractal147`
|
||||
- esphome: fix safe_mode :esphomepr:`1421` by :ghuser:`alexyao2015`
|
||||
- esphome: DS1307 real time clock component :esphomepr:`1441` by :ghuser:`badbadc0ffee` (new-integration)
|
||||
- docs: DS1307 real time clock component :docspr:`910` by :ghuser:`badbadc0ffee`
|
||||
- esphome: Add encode_uint32 method, similar to encode_uint16 :esphomepr:`1427` by :ghuser:`e28eta`
|
||||
- esphome: Rotary Encoder: Don't call callbacks in the isr :esphomepr:`1456` by :ghuser:`mknjc`
|
||||
|
@ -88,6 +88,78 @@ Configuration variables:
|
||||
- **on_time** (*Optional*, :ref:`Automation <automation>`): Automation to run at specific intervals using
|
||||
a cron-like syntax. See :ref:`time-on_time`.
|
||||
|
||||
DS1307 Time Source
|
||||
------------------
|
||||
|
||||
You first need to set up the :doc:`I2C </components/i2c>` component.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
time:
|
||||
- platform: ds1307
|
||||
id: ds1307_time
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **id** (*Optional*, :ref:`config-id`): Specify the ID of the time for use in lambdas.
|
||||
- **address** (*Optional*, int): Manually specify the I²C address of the RTC. Defaults to ``0x68``.
|
||||
- **timezone** (*Optional*, string): Manually tell ESPHome what time zone to use with `this format
|
||||
<https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html>`__ (warning: the format is quite complicated)
|
||||
or the simpler `TZ database name <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>`__ in the form
|
||||
<Region>/<City>. ESPHome tries to automatically infer the time zone string based on the time zone of the computer
|
||||
that is running ESPHome, but this might not always be accurate.
|
||||
- **on_time** (*Optional*, :ref:`Automation <automation>`): Automation to run at specific intervals using
|
||||
a cron-like syntax. See :ref:`time-on_time`.
|
||||
|
||||
DS1307 Actions
|
||||
--------------
|
||||
|
||||
The DS1307 component supports :ref:`actions <config-action>` that can be used to synchronize the RTC hardware and
|
||||
the system clock.
|
||||
|
||||
.. _ds1307-write_action:
|
||||
|
||||
``ds1307.write`` Action
|
||||
***********************
|
||||
|
||||
This :ref:`Action <config-action>` triggers a synchronization of the current system time to the RTC hardware.
|
||||
|
||||
.. note::
|
||||
|
||||
The DS1307 component will *not* write the RTC clock if not triggered *explicitely* by this action.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
on_...:
|
||||
- ds1307.write
|
||||
|
||||
# in case you need to specify the DS1307 id
|
||||
- ds1307.write:
|
||||
id: ds1307_time
|
||||
|
||||
.. _ds1307-read_action:
|
||||
|
||||
``ds1307.read`` Action
|
||||
**********************
|
||||
|
||||
This :ref:`Action <config-action>` triggers a synchronization of the current system time from the RTC hardware.
|
||||
|
||||
.. note::
|
||||
|
||||
The DS1307 component will automatically read the RTC clock every 15 minutes by default and synchronize the
|
||||
system clock when a valid timestamp was read from the RTC. (The ``update_interval`` can be changed.)
|
||||
This action can be used to trigger *additional* synchronizations.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
on_...:
|
||||
- ds1307.read
|
||||
|
||||
# in case you need to specify the DS1307 id
|
||||
- ds1307.read:
|
||||
id: ds1307_time
|
||||
|
||||
Use In Lambdas
|
||||
--------------
|
||||
|
||||
@ -142,7 +214,7 @@ created based on a given format. If you want to get the current time attributes,
|
||||
.. _strftime:
|
||||
|
||||
strftime
|
||||
^^^^^^^^
|
||||
********
|
||||
|
||||
The second way to use the time object is to directly transform it into a string like ``2018-08-16 16:31``.
|
||||
This is directly done using C's `strftime <http://www.cplusplus.com/reference/ctime/strftime/>`__ function which
|
||||
|
2
conf.py
2
conf.py
@ -72,7 +72,7 @@ author = 'Otto Winter'
|
||||
# The short X.Y version.
|
||||
version = '1.16'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.16.0b1'
|
||||
release = '1.16.0b2'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
@ -374,6 +374,8 @@ All Actions
|
||||
- :ref:`http_request.get <http_request-get_action>` / :ref:`http_request.post <http_request-post_action>` / :ref:`http_request.send <http_request-send_action>`
|
||||
- :ref:`rf_bridge.send_code <rf_bridge-send_code_action>`
|
||||
- :ref:`rf_bridge.learn <rf_bridge-learn_action>`
|
||||
- :ref:`ds1307.read <ds1307-read_action>`
|
||||
- :ref:`ds1307.write <ds1307-write_action>`
|
||||
|
||||
.. _config-condition:
|
||||
|
||||
|
@ -124,7 +124,7 @@ Contributors
|
||||
- `Alexander Leisentritt (@Alex9779) <https://github.com/Alex9779>`__ - 10 contributions
|
||||
- `Alexandre Danault (@AlexDanault) <https://github.com/AlexDanault>`__ - 1 contribution
|
||||
- `Alex Mekkering (@AlexMekkering) <https://github.com/AlexMekkering>`__ - 3 contributions
|
||||
- `Alex (@alexyao2015) <https://github.com/alexyao2015>`__ - 2 contributions
|
||||
- `Alex (@alexyao2015) <https://github.com/alexyao2015>`__ - 3 contributions
|
||||
- `Amish Vishwakarma (@amishv) <https://github.com/amishv>`__ - 3 contributions
|
||||
- `András Bíró (@andrasbiro) <https://github.com/andrasbiro>`__ - 1 contribution
|
||||
- `Andreas Hergert (@andreashergert1984) <https://github.com/andreashergert1984>`__ - 1 contribution
|
||||
@ -140,7 +140,7 @@ Contributors
|
||||
- `Achilleas Pipinellis (@axilleas) <https://github.com/axilleas>`__ - 1 contribution
|
||||
- `Kamil Trzciński (@ayufan) <https://github.com/ayufan>`__ - 7 contributions
|
||||
- `Nicholas Peters (@Azimath) <https://github.com/Azimath>`__ - 2 contributions
|
||||
- `Florian Mösch (@badbadc0ffee) <https://github.com/badbadc0ffee>`__ - 4 contributions
|
||||
- `Florian Mösch (@badbadc0ffee) <https://github.com/badbadc0ffee>`__ - 5 contributions
|
||||
- `balk77 (@balk77) <https://github.com/balk77>`__ - 2 contributions
|
||||
- `Paulus Schoutsen (@balloob) <https://github.com/balloob>`__ - 41 contributions
|
||||
- `Andrew Zaborowski (@balrog-kun) <https://github.com/balrog-kun>`__ - 7 contributions
|
||||
@ -208,6 +208,7 @@ Contributors
|
||||
- `dubit0 (@dubit0) <https://github.com/dubit0>`__ - 1 contribution
|
||||
- `Dimitris Zervas (@dzervas) <https://github.com/dzervas>`__ - 1 contribution
|
||||
- `dziobson (@dziobson) <https://github.com/dziobson>`__ - 1 contribution
|
||||
- `Dan Jackson (@e28eta) <https://github.com/e28eta>`__ - 1 contribution
|
||||
- `Ermanno Baschiera (@ebaschiera) <https://github.com/ebaschiera>`__ - 1 contribution
|
||||
- `Niclas Larsson (@edge90) <https://github.com/edge90>`__ - 1 contribution
|
||||
- `Eenoo (@Eenoo) <https://github.com/Eenoo>`__ - 1 contribution
|
||||
@ -226,12 +227,13 @@ Contributors
|
||||
- `Eric Hiller (@erichiller) <https://github.com/erichiller>`__ - 1 contribution
|
||||
- `Ernst Klamer (@Ernst79) <https://github.com/Ernst79>`__ - 1 contribution
|
||||
- `escoand (@escoand) <https://github.com/escoand>`__ - 7 contributions
|
||||
- `esphomebot (@esphomebot) <https://github.com/esphomebot>`__ - 5 contributions
|
||||
- `esphomebot (@esphomebot) <https://github.com/esphomebot>`__ - 6 contributions
|
||||
- `Evan Coleman (@evandcoleman) <https://github.com/evandcoleman>`__ - 3 contributions
|
||||
- `Malte Franken (@exxamalte) <https://github.com/exxamalte>`__ - 2 contributions
|
||||
- `Fabian Affolter (@fabaff) <https://github.com/fabaff>`__ - 28 contributions
|
||||
- `C W (@fake-name) <https://github.com/fake-name>`__ - 2 contributions
|
||||
- `Christian Ferbar (@ferbar) <https://github.com/ferbar>`__ - 2 contributions
|
||||
- `Fractal147 (@Fractal147) <https://github.com/Fractal147>`__ - 1 contribution
|
||||
- `Francis-labo (@Francis-labo) <https://github.com/Francis-labo>`__ - 1 contribution
|
||||
- `Francisk0 (@Francisk0) <https://github.com/Francisk0>`__ - 1 contribution
|
||||
- `Frank Bakker (@FrankBakkerNl) <https://github.com/FrankBakkerNl>`__ - 2 contributions
|
||||
@ -281,7 +283,7 @@ Contributors
|
||||
- `Joshua Dadswell (@jdads1) <https://github.com/jdads1>`__ - 1 contribution
|
||||
- `jeff-h (@jeff-h) <https://github.com/jeff-h>`__ - 2 contributions
|
||||
- `Jeff Rescignano (@JeffResc) <https://github.com/JeffResc>`__ - 11 contributions
|
||||
- `Jesse Hills (@jesserockz) <https://github.com/jesserockz>`__ - 50 contributions
|
||||
- `Jesse Hills (@jesserockz) <https://github.com/jesserockz>`__ - 52 contributions
|
||||
- `Jonathan Jefferies (@jjok) <https://github.com/jjok>`__ - 1 contribution
|
||||
- `Jeppe Ladefoged (@jladefoged) <https://github.com/jladefoged>`__ - 2 contributions
|
||||
- `Jonathan Martens (@jmartens) <https://github.com/jmartens>`__ - 1 contribution
|
||||
@ -359,6 +361,7 @@ Contributors
|
||||
- `Matthew Edwards (@mje-nz) <https://github.com/mje-nz>`__ - 1 contribution
|
||||
- `Maarten (@mjkl-gh) <https://github.com/mjkl-gh>`__ - 1 contribution
|
||||
- `mjoshd (@mjoshd) <https://github.com/mjoshd>`__ - 2 contributions
|
||||
- `mknjc (@mknjc) <https://github.com/mknjc>`__ - 1 contribution
|
||||
- `mnaz (@mnaz) <https://github.com/mnaz>`__ - 1 contribution
|
||||
- `Michael Nieß (@mniess) <https://github.com/mniess>`__ - 1 contribution
|
||||
- `Matt N. (@mnoorenberghe) <https://github.com/mnoorenberghe>`__ - 1 contribution
|
||||
@ -434,7 +437,7 @@ Contributors
|
||||
- `RockBomber (@RockBomber) <https://github.com/RockBomber>`__ - 1 contribution
|
||||
- `Jérôme W. (@RomRider) <https://github.com/RomRider>`__ - 1 contribution
|
||||
- `Robbie Page (@rorpage) <https://github.com/rorpage>`__ - 1 contribution
|
||||
- `rradar (@rradar) <https://github.com/rradar>`__ - 5 contributions
|
||||
- `rradar (@rradar) <https://github.com/rradar>`__ - 6 contributions
|
||||
- `rspaargaren (@rspaargaren) <https://github.com/rspaargaren>`__ - 5 contributions
|
||||
- `Rubén G. (@rubengargar) <https://github.com/rubengargar>`__ - 1 contribution
|
||||
- `rudgr (@rudgr) <https://github.com/rudgr>`__ - 1 contribution
|
||||
@ -527,4 +530,4 @@ Contributors
|
||||
- `ZabojnikM (@ZabojnikM) <https://github.com/ZabojnikM>`__ - 1 contribution
|
||||
- `San (@zhujunsan) <https://github.com/zhujunsan>`__ - 1 contribution
|
||||
|
||||
*This page was last updated January 7, 2021.*
|
||||
*This page was last updated January 11, 2021.*
|
||||
|
Loading…
Reference in New Issue
Block a user