Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.17.0b1 #1070

Merged
merged 48 commits into from
Mar 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
14fbfe3
Bump version to v1.17.0-dev
jesserockz Jan 8, 2021
f848da8
DS1307 real time clock component (#910)
badbadc0ffee Jan 8, 2021
51175fb
add rc522 i2c config variant (#933)
glmnet Jan 12, 2021
da4a791
Updated Mcp3008 to support reference_voltage and voltage_sampler::Vol…
SenexCrenshaw Jan 13, 2021
4ef6fa0
Add docs for pn532 NDEF functionality (#936)
jesserockz Jan 14, 2021
b6eeb6e
Adding Inkplate 6 docs (#778)
nitko12 Jan 16, 2021
ec56d2d
update time (sync) documentation (#924)
badbadc0ffee Jan 18, 2021
ea65adb
Added docs for pr147 (#963)
mhentschke Jan 26, 2021
ce72498
Add docs for MHO-C401 (#957)
nikito7 Jan 27, 2021
2c2ddd4
Update scd30 docs to show sensors are optional (#970)
jesserockz Jan 30, 2021
63998c7
Adding documentation for Inkbird IBS-TH1 Mini sensor (#657)
fkirill Feb 6, 2021
5bfeb3e
Add MCP4725 docs (#889)
JJK801 Feb 6, 2021
9420c45
Fix format consistency (#989)
glmnet Feb 7, 2021
f9e93f9
Added energy sensor to hlw8012 (#707)
FrankBakkerNl Feb 13, 2021
4159933
MCP230xx open drain interrupt pins (#728)
kbx81 Feb 13, 2021
5c4a645
Changed configuration items to snake_case (#1000)
SenexCrenshaw Feb 14, 2021
1c678f4
Add doc for device_class attribute of sensor (#996)
marecabo Feb 15, 2021
79adb22
Add sleep duration to enter deep sleep action (#995)
nuttytree Feb 15, 2021
5aaf095
Added documentation for Waveshare 2.90inch V2 e-ink display (#1010)
K-r-i-s-t-i-a-n Feb 17, 2021
ea65e46
Add reverse_enable for max7219 (#983)
ssieb Feb 17, 2021
896afdc
Fix format next (#1023)
glmnet Feb 20, 2021
28abbe9
Icon is ignored by HA when device class is set (#1011)
marecabo Feb 20, 2021
3cb84bb
Add docs for Xiaomi Miscale v1 and v2 (#1021)
dckiller51 Feb 22, 2021
11b46de
Sim800l dial (#1027)
spilin Feb 25, 2021
06d923c
Update vl53l0x docs (#679)
kkellner Feb 25, 2021
0bcaea6
Document uart switch send_every (#986)
gabe565 Feb 27, 2021
f2b2bd4
Added remote samsung36 protocol docs (#904)
tuxBurner Feb 27, 2021
bf3e251
Migrate ESPColor to Color (#1036)
SenexCrenshaw Mar 2, 2021
8e01f33
Added documentation for the SM300D2 sensor (#993)
moritzgloeckl Mar 3, 2021
2f81ac4
Document new min/max filters (#1032)
gabe565 Mar 5, 2021
d886292
Uart invert option for ESP32 (#1039)
Mynasru Mar 6, 2021
0915aba
add-black (#1044)
glmnet Mar 7, 2021
122e7e7
Update MCP23XXX docs with interrupts and pin schemas (#1028)
jesserockz Mar 7, 2021
234810e
Dump schema (#1030)
glmnet Mar 8, 2021
979e0a2
pin schema and other fixes (#1047)
glmnet Mar 9, 2021
f6c277c
schema-filters (#1052)
glmnet Mar 11, 2021
62f0802
Documentation for fan speed levels (#1056)
blejdfist Mar 17, 2021
d5d917d
Midea Climate support (#804)
dudanov Mar 17, 2021
e7c82f4
Add docs for `name_add_mac_suffix` config (#1058)
jesserockz Mar 17, 2021
ced6164
Add docs for addressable_light display (#755)
justfalter Mar 18, 2021
06ea351
Add documentation for pulse_meter (#900)
stevebaxter Mar 19, 2021
9b266ec
Add docs for ttgo-b1 version (#808)
matikij Mar 20, 2021
dc6154e
SenseAir: background calibration & ABC commands (#1066)
nmaggioni Mar 21, 2021
9265b6c
Add docs for http_request on_response trigger (#1049)
jesserockz Mar 22, 2021
5bb554f
Merge branch 'current' into next
jesserockz Mar 22, 2021
093b442
Bump version to v1.17.0b1
jesserockz Mar 22, 2021
35330c4
Update changelog for 1.17.0b1
jesserockz Mar 22, 2021
a7bf56b
Update supporters for 1.17.0b1
jesserockz Mar 22, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/ambv/black
rev: 20.8b1
hooks:
- id: black
args:
- --safe
- --quiet
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.4
hooks:
- id: flake8
additional_dependencies:
- flake8-docstrings==1.5.0
- pydocstyle==5.1.1
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.4.0
hooks:
- id: no-commit-to-branch
args:
- --branch=current
- --branch=next
- --branch=beta
2 changes: 1 addition & 1 deletion Doxygen
Original file line number Diff line number Diff line change
Expand Up @@ -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.2
PROJECT_NUMBER = 1.17.0b1

# 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
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ESPHOME_PATH = ../esphome
ESPHOME_REF = v1.16.2
ESPHOME_REF = v1.17.0b1

.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png

Expand Down
2 changes: 1 addition & 1 deletion _static/version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.16.2
1.17.0b1
2 changes: 1 addition & 1 deletion changelog/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Changelog
=========

.. redirect::
:url: /changelog/v1.16.0.html
:url: /changelog/v1.17.0.html

.. toctree::
:glob:
Expand Down
2 changes: 1 addition & 1 deletion changelog/v1.14.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Changelog - Version 1.14.0 - November 1
SGP30, components/sensor/sgp30, sgp30.jpg

Tx20, components/sensor/tx20, tx20.jpg
VL53L0x, components/sensor/vl53l0x, vl53l0x.svg
VL53L0x, components/sensor/vl53l0x, vl53l0x.png
Xiaomi CGG1, components/sensor/xiaomi_cgg1, xiaomi_cgg1.jpg
Xiaomi LYWSD02, components/sensor/xiaomi_lywsd02, xiaomi_lywsd02.jpg
ZyAura, components/sensor/zyaura, zgm053.jpg
Expand Down
176 changes: 176 additions & 0 deletions changelog/v1.17.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
Changelog - Version 1.17.0 - TBD 2021
===============================================

.. seo::
:description: Changelog for ESPHome version 1.17.0.
:image: /_static/changelog-1.17.0.png
:author_twitter: @esphome_

.. imgtable::
:columns: 4

Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg
MCP4725, components/output/mcp4725, mcp4725.jpg
Xiaomi Miscale, components/sensor/xiaomi_miscale, xiaomi_miscale.jpg
Xiaomi Miscale2, components/sensor/xiaomi_miscale2, xiaomi_miscale2.jpg
Midea Air Conditioner, components/climate/midea_ac, midea.svg
Addressable Light Display, components/display/addressable_light, addressable_light.jpg
Pulse Meter, components/sensor/pulse_meter, pulse.svg

RELEASE NOTES TO GO HERE

New Features
------------

- esphome: Vl53l0x change address :esphomepr:`1126` by :ghuser:`kkellner` (new-feature)
- esphome: Background calibration & ABC commands for SenseAir S8 :esphomepr:`1623` by :ghuser:`nmaggioni` (new-feature)
- esphome: Add trigger for http actions to receive the status code :esphomepr:`1599` by :ghuser:`jesserockz` (new-feature)

New Integrations
----------------

- esphome: Adding support for the Inkbird IBS-TH1 Mini sensor :esphomepr:`1099` by :ghuser:`fkirill` (new-integration)
- esphome: Add MCP4725 DAC Component :esphomepr:`1418` by :ghuser:`JJK801` (new-integration)
- esphome: Add Xiaomi Miscale v1 and v2 :esphomepr:`1368` by :ghuser:`dckiller51` (new-integration)
- esphome: Add support for the SM300D2 7-in-1 sensor module :esphomepr:`1524` by :ghuser:`moritzgloeckl` (new-integration)
- esphome: Midea climate support :esphomepr:`1328` by :ghuser:`dudanov` (new-integration)
- esphome: Add addressable_light display platform :esphomepr:`1272` by :ghuser:`justfalter` (new-integration) (notable-change)
- esphome: Implement pulse_meter as an improvement on pulse_counter and pulse_width for meters :esphomepr:`1434` by :ghuser:`stevebaxter` (new-integration)

Breaking Changes
----------------

- esphome: MCP23XXX Refactor :esphomepr:`1560` by :ghuser:`jesserockz` (breaking-change)

Notable Changes
---------------

- esphome: Device class attribute for sensor component :esphomepr:`1525` by :ghuser:`marecabo` (notable-change)
- esphome: Add default device classes to sensor components :esphomepr:`1533` by :ghuser:`marecabo` (notable-change)
- esphome: Add addressable_light display platform :esphomepr:`1272` by :ghuser:`justfalter` (new-integration) (notable-change)

All changes
-----------

- esphome: Bump voluptuous from 0.12.0 to 0.12.1 :esphomepr:`1411` by :ghuser:`dependabot[bot]`
- esphome: add http request tests :esphomepr:`1448` by :ghuser:`glmnet`
- esphome: codegen: Lambda improvements :esphomepr:`1476` by :ghuser:`balrog-kun`
- docs: Add options to control pulse duration on Climate_IR_LG Component :docspr:`963` by :ghuser:`mhentschke`
- esphome: Add options to control pulse duration on Climate_IR_LG Component :esphomepr:`1470` by :ghuser:`mhentschke`
- esphome: Adding support for the Inkbird IBS-TH1 Mini sensor :esphomepr:`1099` by :ghuser:`fkirill` (new-integration)
- docs: Adding documentation for Inkbird IBS-TH1 Mini sensor :docspr:`657` by :ghuser:`fkirill`
- esphome: Add config validator location :esphomepr:`1490` by :ghuser:`glmnet`
- esphome: Add MCP4725 DAC Component :esphomepr:`1418` by :ghuser:`JJK801` (new-integration)
- docs: Add MCP4725 docs :docspr:`889` by :ghuser:`JJK801`
- docs: Fix format consistency :docspr:`989` by :ghuser:`glmnet`
- esphome: Added codeowners to max7219digit :esphomepr:`1487` by :ghuser:`rspaargaren`
- esphome: Correct Native API Wire Format Documentation :esphomepr:`1528` by :ghuser:`justin-gerhardt`
- esphome: st7735_conf_fixes :esphomepr:`1530` by :ghuser:`SenexCrenshaw`
- docs: ST7735 Changed configuration items to snake_case :docspr:`1000` by :ghuser:`SenexCrenshaw`
- esphome: Device class attribute for sensor component :esphomepr:`1525` by :ghuser:`marecabo` (notable-change)
- docs: Add doc for device_class attribute of sensor :docspr:`996` by :ghuser:`marecabo`
- docs: Add sleep duration to enter deep sleep action :docspr:`995` by :ghuser:`nuttytree`
- esphome: Add duration option to action start deep sleep :esphomepr:`1526` by :ghuser:`nuttytree`
- esphome: fix substitution losing track of document range :esphomepr:`1547` by :ghuser:`glmnet`
- docs: Update esp32_camera.rst :docspr:`1020` by :ghuser:`lukaszrud`
- docs: Fix format next :docspr:`1023` by :ghuser:`glmnet`
- docs: Add another project to diy.rst :docspr:`1019` by :ghuser:`shish`
- docs: Update esphome-configs URL :docspr:`1018` by :ghuser:`shish`
- docs: Icon is ignored by HA when device class is set :docspr:`1011` by :ghuser:`marecabo`
- docs: Update pid.rst :docspr:`1006` by :ghuser:`boradwell`
- docs: Mention that Hyperion.NG works with E1.31 :docspr:`975` by :ghuser:`rradar`
- esphome: Add Xiaomi Miscale v1 and v2 :esphomepr:`1368` by :ghuser:`dckiller51` (new-integration)
- docs: Add docs for Xiaomi Miscale v1 and v2 :docspr:`1021` by :ghuser:`dckiller51`
- docs: Add missing closing parenthesis in example :docspr:`1029` by :ghuser:`lepinkainen`
- docs: Update Inkplate.rst :docspr:`1026` by :ghuser:`jakommo`
- docs: typo in st7735 model number :docspr:`1025` by :ghuser:`wjcarpenter`
- docs: Fix mcp23sXX id config :docspr:`1017` by :ghuser:`jesserockz`
- docs: Update bme680.rst :docspr:`1007` by :ghuser:`wifwucite`
- docs: Sim800l dial :docspr:`1027` by :ghuser:`spilin`
- esphome: Add dial support for sim800l component :esphomepr:`1558` by :ghuser:`spilin`
- esphome: Climate IR LG -keep previous temp and fan if swing :esphomepr:`1556` by :ghuser:`Otamay`
- esphome: Vl53l0x change address :esphomepr:`1126` by :ghuser:`kkellner` (new-feature)
- docs: Update vl53l0x docs :docspr:`679` by :ghuser:`kkellner`
- esphome: tuya: Use queue for sending command messages :esphomepr:`1404` by :ghuser:`stubs12`
- esphome: Replace substitutions in substitutions first :esphomepr:`1567` by :ghuser:`edenhaus`
- esphome: Added heater to climate_ir_lg :esphomepr:`1555` by :ghuser:`Otamay`
- esphome: More yaml validation :esphomepr:`1568` by :ghuser:`glmnet`
- esphome: Add default device classes to sensor components :esphomepr:`1533` by :ghuser:`marecabo` (notable-change)
- docs: Document recurring data in uart switch :docspr:`986` by :ghuser:`gabe565`
- esphome: Add support for recurring data in uart switch :esphomepr:`1514` by :ghuser:`gabe565`
- esphome: Added samsung36 ir protocol :esphomepr:`1438` by :ghuser:`tuxBurner`
- docs: Added remote samsung36 protocol docs :docspr:`904` by :ghuser:`tuxBurner`
- docs: Add IWOOLE Table Lamp cookbook entry :docspr:`947` by :ghuser:`Deinara`
- docs: Update uart.rst example to read all available characters :docspr:`1031` by :ghuser:`RoganDawes`
- esphome: ADC fix: GPIO0 not usable as output if ADC_VCC is used :esphomepr:`1557` by :ghuser:`ferbar`
- esphome: Add constants for device classes of binary_sensor :esphomepr:`1549` by :ghuser:`marecabo`
- esphome: fix path on windows escape :esphomepr:`1573` by :ghuser:`glmnet`
- esphome: Migrate ESPColor to Color :esphomepr:`1551` by :ghuser:`SenexCrenshaw`
- docs: Migrate ESPColor to Color :docspr:`1036` by :ghuser:`SenexCrenshaw`
- esphome: Add support for the SM300D2 7-in-1 sensor module :esphomepr:`1524` by :ghuser:`moritzgloeckl` (new-integration)
- docs: Added documentation for the SM300D2 sensor :docspr:`993` by :ghuser:`moritzgloeckl`
- esphome: changed color temp from float to int :esphomepr:`1522` by :ghuser:`codyjamestechnical`
- esphome: Bump pytest-cov from 2.10.1 to 2.11.1 :esphomepr:`1483` by :ghuser:`dependabot[bot]`
- esphome: Bump colorlog from 4.6.2 to 4.7.2 :esphomepr:`1473` by :ghuser:`dependabot[bot]`
- esphome: pins: Add three new boards :esphomepr:`1576` by :ghuser:`balrog-kun`
- esphome: Bump pytest from 6.2.1 to 6.2.2 :esphomepr:`1574` by :ghuser:`dependabot[bot]`
- esphome: Bump pytz from 2020.5 to 2021.1 :esphomepr:`1575` by :ghuser:`dependabot[bot]`
- esphome: Fix for waveshare 2.13in-ttgo-b73 :esphomepr:`1543` by :ghuser:`nikito7`
- docs: Added new blogpost :docspr:`1038` by :ghuser:`pieterbrink123`
- esphome: Add min/max filters :esphomepr:`1569` by :ghuser:`gabe565`
- docs: Document new min/max filters :docspr:`1032` by :ghuser:`gabe565`
- esphome: Bump pylint from 2.6.0 to 2.7.2 :esphomepr:`1582` by :ghuser:`dependabot[bot]`
- esphome: Extend 'uart:' with 'invert:' for esp32 :esphomepr:`1586` by :ghuser:`needspeed`
- docs: Uart invert option for ESP32 :docspr:`1039` by :ghuser:`Mynasru`
- esphome: Bump platformio from 5.0.4 to 5.1.0 :esphomepr:`1581` by :ghuser:`dependabot[bot]`
- esphome: fix servo warning :esphomepr:`1591` by :ghuser:`glmnet`
- docs: add-black :docspr:`1044` by :ghuser:`glmnet`
- esphome: add-black :esphomepr:`1593` by :ghuser:`glmnet`
- esphome: MCP23XXX Refactor :esphomepr:`1560` by :ghuser:`jesserockz` (breaking-change)
- docs: Update MCP23XXX docs with interrupts and pin schemas :docspr:`1028` by :ghuser:`jesserockz`
- esphome: Improve error checking: too many component id candidates :esphomepr:`1570` by :ghuser:`glmnet`
- esphome: Schema dump :esphomepr:`1564` by :ghuser:`glmnet`
- docs: Dump schema :docspr:`1030` by :ghuser:`glmnet`
- docs: Update i2c.rst :docspr:`1043` by :ghuser:`webeling67`
- docs: Update rf_bridge.rst :docspr:`1042` by :ghuser:`samnewman86`
- esphome: Inkplate 6 Optimizations :esphomepr:`1592` by :ghuser:`Sizurka`
- docs: Fix RF Bridge link to Portisch Repo :docspr:`1045` by :ghuser:`jesserockz`
- docs: pin schema and other fixes :docspr:`1047` by :ghuser:`glmnet`
- esphome: schema-dump-pins :esphomepr:`1596` by :ghuser:`glmnet`
- docs: Adding that mpr121_id is a valid option for binary_sensor :docspr:`966` by :ghuser:`minideezel`
- esphome: change lcd clear() to clear the buffer :esphomepr:`1600` by :ghuser:`ssieb`
- esphome: PN532 - don't read extra page and fix size :esphomepr:`1565` by :ghuser:`ssieb`
- docs: schema-filters :docspr:`1052` by :ghuser:`glmnet`
- esphome: Fix component_tests config :esphomepr:`1608` by :ghuser:`madron`
- esphome: Added receive for Fujitsu ACs :esphomepr:`1577` by :ghuser:`alex-richards`
- esphome: Change COLOR_ON to be 255 values instead of 1 :esphomepr:`1594` by :ghuser:`jesserockz`
- esphome: a4988 wait 1ms when coming out of sleep :esphomepr:`1597` by :ghuser:`WeekendWarrior1`
- docs: Remove cs_pin from rc522 i2c example :docspr:`1059` by :ghuser:`jesserockz`
- esphome: Support fan speed levels :esphomepr:`1541` by :ghuser:`blejdfist`
- docs: Documentation for fan speed levels :docspr:`1056` by :ghuser:`blejdfist`
- docs: Add CLI logs section :docspr:`1060` by :ghuser:`Tmin10`
- esphome: Add option to suffix name with mac address :esphomepr:`1615` by :ghuser:`jesserockz`
- esphome: Midea climate support :esphomepr:`1328` by :ghuser:`dudanov` (new-integration)
- docs: Midea Climate support :docspr:`804` by :ghuser:`dudanov`
- docs: Add docs for `name_add_mac_suffix` config :docspr:`1058` by :ghuser:`jesserockz`
- esphome: SPI transfer fix. Use write when no miso pin is set :esphomepr:`1563` by :ghuser:`SenexCrenshaw`
- esphome: SPI Improvements :esphomepr:`1617` by :ghuser:`SenexCrenshaw`
- esphome: Add addressable_light display platform :esphomepr:`1272` by :ghuser:`justfalter` (new-integration) (notable-change)
- docs: Add docs for addressable_light display :docspr:`755` by :ghuser:`justfalter`
- esphome: Implement pulse_meter as an improvement on pulse_counter and pulse_width for meters :esphomepr:`1434` by :ghuser:`stevebaxter` (new-integration)
- esphome: e131: fix issue 1579: limitation of maximum light count :esphomepr:`1619` by :ghuser:`docteurzoidberg`
- docs: Add documentation for pulse_meter :docspr:`900` by :ghuser:`stevebaxter`
- esphome: Bump platformio from 5.1.0 to 5.1.1 :esphomepr:`1618` by :ghuser:`dependabot[bot]`
- esphome: Fix pulse-meter with device_class and black :esphomepr:`1621` by :ghuser:`jesserockz`
- esphome: Declare Color objects in main.cpp :esphomepr:`1395` by :ghuser:`kbx81`
- esphome: Add 2.13in-ttgo-b1 waveshare epaper module. :esphomepr:`1326` by :ghuser:`matikij`
- docs: Add docs for ttgo-b1 version (next branch) :docspr:`808` by :ghuser:`matikij`
- esphome: Bump flake8 from 3.8.4 to 3.9.0 :esphomepr:`1612` by :ghuser:`dependabot[bot]`
- esphome: Bundle platformio lib_deps in docker images :esphomepr:`1625`
- esphome: Bump protobuf from 3.13.0 to 3.15.6 :esphomepr:`1607` by :ghuser:`dependabot[bot]`
- esphome: Bump pyyaml from 5.3.1 to 5.4.1 :esphomepr:`1482` by :ghuser:`dependabot[bot]`
- esphome: Switch docker images to debian :esphomepr:`1626`
- esphome: Background calibration & ABC commands for SenseAir S8 :esphomepr:`1623` by :ghuser:`nmaggioni` (new-feature)
- docs: SenseAir: background calibration & ABC commands :docspr:`1066` by :ghuser:`nmaggioni`
- esphome: Add trigger for http actions to receive the status code :esphomepr:`1599` by :ghuser:`jesserockz` (new-feature)
- docs: Add docs for http_request on_response trigger :docspr:`1049` by :ghuser:`jesserockz`
2 changes: 1 addition & 1 deletion components/binary_sensor/ble_presence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **mac_address** (*Optional*, MAC Address): The MAC address to track for this
binary sensor. Either this or ``service_uuid`` has to be present.
- **service_uuid** (*Optional*, string) 16 bit, 32 bit, or 128 bit BLE Service UUID
- **service_uuid** (*Optional*, string): 16 bit, 32 bit, or 128 bit BLE Service UUID
which can be tracked if the device randomizes the MAC address. Either
this or ``mac_address`` has to be present.
- **id** (*Optional*, :ref:`config-id`): Manually specify
Expand Down
51 changes: 34 additions & 17 deletions components/binary_sensor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,23 +85,40 @@ of these entries matters!)
return {};
}

Supported filters:

- **invert**: Simple filter that just inverts every value from the binary sensor.
- **delayed_on**: When a signal ON is received, wait for the specified time period until publishing
an ON state. If an OFF value is received while waiting, the ON action is discarded. Or in other words:
Only send an ON value if the binary sensor has stayed ON for at least the specified time period.
**Useful for debouncing push buttons**.
- **delayed_off**: When a signal OFF is received, wait for the specified time period until publishing
an OFF state. If an ON value is received while waiting, the OFF action is discarded. Or in other words:
Only send an OFF value if the binary sensor has stayed OFF for at least the specified time period.
**Useful for debouncing push buttons**.
- **delayed_on_off**: Only send an ON or OFF value if the binary sensor has stayed in the same state
for at least the specified time period.
**Useful for debouncing binary switches**.
- **lambda**: Specify any :ref:`lambda <config-lambda>` for more complex filters. The input value from
the binary sensor is ``x`` and you can return ``true`` for ON, ``false`` for OFF, and ``{}`` to stop
the filter chain.
``invert``
**********

Simple filter that just inverts every value from the binary sensor.

``delayed_on``
**************

(**Required**, :ref:`config-time`): When a signal ON is received, wait for the specified time period until publishing
an ON state. If an OFF value is received while waiting, the ON action is discarded. Or in other words:
Only send an ON value if the binary sensor has stayed ON for at least the specified time period.
**Useful for debouncing push buttons**.

``delayed_off``
***************

(**Required**, :ref:`config-time`): When a signal OFF is received, wait for the specified time period until publishing
an OFF state. If an ON value is received while waiting, the OFF action is discarded. Or in other words:
Only send an OFF value if the binary sensor has stayed OFF for at least the specified time period.
**Useful for debouncing push buttons**.

``delayed_on_off``
******************

(**Required**, :ref:`config-time`): Only send an ON or OFF value if the binary sensor has stayed in the same state
for at least the specified time period.
**Useful for debouncing binary switches**.

``lambda``
**********

Specify any :ref:`lambda <config-lambda>` for more complex filters. The input value from
the binary sensor is ``x`` and you can return ``true`` for ON, ``false`` for OFF, and ``{}`` to stop
the filter chain.

Binary Sensor Automation
------------------------
Expand Down
Loading