mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 13:26:54 +00:00
Merge pull request #21435 from home-assistant/rc
This commit is contained in:
Franck Nijhof
GitHub
commit
8a33ac1bf9
@ -233,7 +233,7 @@
|
||||
"SwitchBot",
|
||||
"Synology",
|
||||
"Tado",
|
||||
"Tahoma",
|
||||
"TaHoma",
|
||||
"TCP/IP",
|
||||
"TensorFlow",
|
||||
"Tesla",
|
||||
|
||||
1
.vscode/cSpell.json
vendored
1
.vscode/cSpell.json
vendored
@ -57,6 +57,7 @@
|
||||
"nginx",
|
||||
"Nijhof",
|
||||
"Nmap",
|
||||
"OctoPrint",
|
||||
"ohmconnect",
|
||||
"Onkyo",
|
||||
"OpenZWave",
|
||||
|
||||
74
CODEOWNERS
74
CODEOWNERS
@ -14,7 +14,6 @@ source/_integrations/acmeda.markdown @atmurray
|
||||
source/_integrations/adax.markdown @danielhiversen
|
||||
source/_integrations/adguard.markdown @frenck
|
||||
source/_integrations/advantage_air.markdown @Bre77
|
||||
source/_integrations/aemet.markdown @noltari
|
||||
source/_integrations/agent_dvr.markdown @ispysoftware
|
||||
source/_integrations/airly.markdown @bieniu
|
||||
source/_integrations/airnow.markdown @asymworks
|
||||
@ -32,16 +31,16 @@ source/_integrations/ambiclimate.markdown @danielhiversen
|
||||
source/_integrations/ambient_station.markdown @bachya
|
||||
source/_integrations/amcrest.markdown @flacjacket
|
||||
source/_integrations/analytics.markdown @home-assistant/core @ludeeus
|
||||
source/_integrations/androidtv.markdown @JeffLIrion
|
||||
source/_integrations/androidtv.markdown @JeffLIrion @ollo69
|
||||
source/_integrations/apache_kafka.markdown @bachya
|
||||
source/_integrations/api.markdown @home-assistant/core
|
||||
source/_integrations/apple_tv.markdown @postlund
|
||||
source/_integrations/apprise.markdown @caronc
|
||||
source/_integrations/aprs.markdown @PhilRW
|
||||
source/_integrations/arcam_fmj.markdown @elupus
|
||||
source/_integrations/arduino.markdown @fabaff
|
||||
source/_integrations/arest.markdown @fabaff
|
||||
source/_integrations/arris_tg2492lg.markdown @vanbalken
|
||||
source/_integrations/aseko_pool_live.markdown @milanmeu
|
||||
source/_integrations/asuswrt.markdown @kennedyshead @ollo69
|
||||
source/_integrations/atag.markdown @MatsNL
|
||||
source/_integrations/aten_pe.markdown @mtdcr
|
||||
@ -49,6 +48,7 @@ source/_integrations/atome.markdown @baqs
|
||||
source/_integrations/august.markdown @bdraco
|
||||
source/_integrations/aurora.markdown @djtimca
|
||||
source/_integrations/aurora_abb_powerone.markdown @davet2001
|
||||
source/_integrations/aussie_broadband.markdown @nickw444 @Bre77
|
||||
source/_integrations/auth.markdown @home-assistant/core
|
||||
source/_integrations/automation.markdown @home-assistant/core
|
||||
source/_integrations/avea.markdown @pattyland
|
||||
@ -98,7 +98,7 @@ source/_integrations/coolmaster.markdown @OnFreund
|
||||
source/_integrations/coronavirus.markdown @home-assistant/core
|
||||
source/_integrations/counter.markdown @fabaff
|
||||
source/_integrations/cover.markdown @home-assistant/core
|
||||
source/_integrations/cpuspeed.markdown @fabaff
|
||||
source/_integrations/cpuspeed.markdown @fabaff @frenck
|
||||
source/_integrations/crownstone.markdown @Crownstone @RicArch97
|
||||
source/_integrations/cups.markdown @fabaff
|
||||
source/_integrations/daikin.markdown @fredrike
|
||||
@ -118,7 +118,8 @@ source/_integrations/dht.markdown @thegardenmonkey
|
||||
source/_integrations/digital_ocean.markdown @fabaff
|
||||
source/_integrations/discogs.markdown @thibmaek
|
||||
source/_integrations/dlna_dmr.markdown @StevenLooman @chishm
|
||||
source/_integrations/doorbird.markdown @oblogic7 @bdraco
|
||||
source/_integrations/dnsip.markdown @gjohansson-ST
|
||||
source/_integrations/doorbird.markdown @oblogic7 @bdraco @flacjacket
|
||||
source/_integrations/dsmr.markdown @Robbie1221 @frenck
|
||||
source/_integrations/dsmr_reader.markdown @depl0y
|
||||
source/_integrations/dunehd.markdown @bieniu
|
||||
@ -134,6 +135,7 @@ source/_integrations/egardia.markdown @jeroenterheerdt
|
||||
source/_integrations/eight_sleep.markdown @mezz64 @raman325
|
||||
source/_integrations/elgato.markdown @frenck
|
||||
source/_integrations/elkm1.markdown @gwww @bdraco
|
||||
source/_integrations/elmax.markdown @albertogeniola
|
||||
source/_integrations/elv.markdown @majuss
|
||||
source/_integrations/emby.markdown @mezz64
|
||||
source/_integrations/emoncms.markdown @borpin
|
||||
@ -167,14 +169,14 @@ source/_integrations/flo.markdown @dmulcahey
|
||||
source/_integrations/flock.markdown @fabaff
|
||||
source/_integrations/flume.markdown @ChrisMandich @bdraco
|
||||
source/_integrations/flunearyou.markdown @bachya
|
||||
source/_integrations/flux_led.markdown @icemanch
|
||||
source/_integrations/flux_led.markdown @icemanch @bdraco
|
||||
source/_integrations/forecast_solar.markdown @klaasnicolaas @frenck
|
||||
source/_integrations/forked_daapd.markdown @uvjustin
|
||||
source/_integrations/fortios.markdown @kimfrellsen
|
||||
source/_integrations/foscam.markdown @skgsergio
|
||||
source/_integrations/freebox.markdown @hacf-fr @Quentame
|
||||
source/_integrations/freedompro.markdown @stefano055415
|
||||
source/_integrations/fritz.markdown @mammuth @AaronDavidSchneider @chemelli74
|
||||
source/_integrations/fritz.markdown @mammuth @AaronDavidSchneider @chemelli74 @mib1185
|
||||
source/_integrations/fritzbox.markdown @mib1185 @flabbamann
|
||||
source/_integrations/fronius.markdown @nielstron @farmio
|
||||
source/_integrations/frontend.markdown @home-assistant/frontend
|
||||
@ -192,6 +194,7 @@ source/_integrations/gitter.markdown @fabaff
|
||||
source/_integrations/glances.markdown @fabaff @engrbm87
|
||||
source/_integrations/goalzero.markdown @tkdrob
|
||||
source/_integrations/gogogate2.markdown @vangorra @bdraco
|
||||
source/_integrations/goodwe.markdown @mletenay @starkillerOG
|
||||
source/_integrations/google_assistant.markdown @home-assistant/cloud
|
||||
source/_integrations/google_cloud.markdown @lufton
|
||||
source/_integrations/gpsd.markdown @fabaff
|
||||
@ -218,6 +221,7 @@ source/_integrations/homeassistant.markdown @home-assistant/core
|
||||
source/_integrations/homekit.markdown @bdraco
|
||||
source/_integrations/homekit_controller.markdown @Jc2k @bdraco
|
||||
source/_integrations/homematic.markdown @pvizeli @danielperna84
|
||||
source/_integrations/homewizard.markdown @DCSBL
|
||||
source/_integrations/honeywell.markdown @rdfurman
|
||||
source/_integrations/http.markdown @home-assistant/core
|
||||
source/_integrations/huawei_lte.markdown @scop @fphammerle
|
||||
@ -237,12 +241,14 @@ source/_integrations/image.markdown @home-assistant/core
|
||||
source/_integrations/incomfort.markdown @zxdavb
|
||||
source/_integrations/influxdb.markdown @fabaff @mdegat01
|
||||
source/_integrations/input_boolean.markdown @home-assistant/core
|
||||
source/_integrations/input_button.markdown @home-assistant/core
|
||||
source/_integrations/input_datetime.markdown @home-assistant/core
|
||||
source/_integrations/input_number.markdown @home-assistant/core
|
||||
source/_integrations/input_select.markdown @home-assistant/core
|
||||
source/_integrations/input_text.markdown @home-assistant/core
|
||||
source/_integrations/insteon.markdown @teharris1
|
||||
source/_integrations/integration.markdown @dgomes
|
||||
source/_integrations/intellifire.markdown @jeeftor
|
||||
source/_integrations/intesishome.markdown @jnimmo
|
||||
source/_integrations/ios.markdown @robbiet480
|
||||
source/_integrations/iotawatt.markdown @gtdiehl @jyavenard
|
||||
@ -264,12 +270,12 @@ source/_integrations/keyboard_remote.markdown @bendavid @lanrat
|
||||
source/_integrations/kmtronic.markdown @dgomes
|
||||
source/_integrations/knx.markdown @Julius2342 @farmio @marvin-w
|
||||
source/_integrations/kodi.markdown @OnFreund @cgtobi
|
||||
source/_integrations/konnected.markdown @heythisisnate @kit-klein
|
||||
source/_integrations/konnected.markdown @heythisisnate
|
||||
source/_integrations/kostal_plenticore.markdown @stegm
|
||||
source/_integrations/kraken.markdown @eifinger
|
||||
source/_integrations/kulersky.markdown @emlove
|
||||
source/_integrations/lametric.markdown @robbiet480
|
||||
source/_integrations/launch_library.markdown @ludeeus
|
||||
source/_integrations/lametric.markdown @robbiet480 @frenck
|
||||
source/_integrations/launch_library.markdown @ludeeus @DurgNomis-drol
|
||||
source/_integrations/lcn.markdown @alengwenus
|
||||
source/_integrations/lg_netcast.markdown @Drafteed
|
||||
source/_integrations/life360.markdown @pnbruckner
|
||||
@ -279,9 +285,9 @@ source/_integrations/litterrobot.markdown @natekspencer
|
||||
source/_integrations/local_ip.markdown @issacg
|
||||
source/_integrations/logger.markdown @home-assistant/core
|
||||
source/_integrations/logi_circle.markdown @evanjd
|
||||
source/_integrations/lookin.markdown @ANMalko
|
||||
source/_integrations/lookin.markdown @ANMalko @bdraco
|
||||
source/_integrations/luci.markdown @mzdrale
|
||||
source/_integrations/luftdaten.markdown @fabaff
|
||||
source/_integrations/luftdaten.markdown @fabaff @frenck
|
||||
source/_integrations/lupusec.markdown @majuss
|
||||
source/_integrations/lutron.markdown @JonGilmore
|
||||
source/_integrations/lutron_caseta.markdown @swails @bdraco
|
||||
@ -306,7 +312,7 @@ source/_integrations/mill.markdown @danielhiversen
|
||||
source/_integrations/min_max.markdown @fabaff
|
||||
source/_integrations/minecraft_server.markdown @elmurato
|
||||
source/_integrations/minio.markdown @tkislan
|
||||
source/_integrations/mobile_app.markdown @robbiet480
|
||||
source/_integrations/mobile_app.markdown @home-assistant/core
|
||||
source/_integrations/modbus.markdown @adamchengtkc @janiversen @vzahradnik
|
||||
source/_integrations/modem_callerid.markdown @tkdrob
|
||||
source/_integrations/modern_forms.markdown @wonderslug
|
||||
@ -338,8 +344,8 @@ source/_integrations/nextcloud.markdown @meichthys
|
||||
source/_integrations/nfandroidtv.markdown @tkdrob
|
||||
source/_integrations/nightscout.markdown @marciogranzotto
|
||||
source/_integrations/nilu.markdown @hfurubotten
|
||||
source/_integrations/nina.markdown @DeerMaximum
|
||||
source/_integrations/nissan_leaf.markdown @filcole
|
||||
source/_integrations/nmap_tracker.markdown @bdraco
|
||||
source/_integrations/nmbs.markdown @thibmaek
|
||||
source/_integrations/no_ip.markdown @fabaff
|
||||
source/_integrations/noaa_tides.markdown @jdelaney72
|
||||
@ -360,9 +366,11 @@ source/_integrations/ohmconnect.markdown @robbiet480
|
||||
source/_integrations/ombi.markdown @larssont
|
||||
source/_integrations/omnilogic.markdown @oliver84 @djtimca @gentoosu
|
||||
source/_integrations/onboarding.markdown @home-assistant/core
|
||||
source/_integrations/oncue.markdown @bdraco
|
||||
source/_integrations/ondilo_ico.markdown @JeromeHXP
|
||||
source/_integrations/onewire.markdown @garbled1 @epenet
|
||||
source/_integrations/onvif.markdown @hunterjm
|
||||
source/_integrations/open_meteo.markdown @frenck
|
||||
source/_integrations/openerz.markdown @misialq
|
||||
source/_integrations/opengarage.markdown @danielhiversen
|
||||
source/_integrations/openhome.markdown @bazwilliams
|
||||
@ -372,6 +380,7 @@ source/_integrations/openweathermap.markdown @fabaff @freekode @nzapponi
|
||||
source/_integrations/opnsense.markdown @mtreinish
|
||||
source/_integrations/orangepi_gpio.markdown @pascallj
|
||||
source/_integrations/oru.markdown @bvlaicu
|
||||
source/_integrations/overkiz.markdown @imicknl @vlebourl @tetienne
|
||||
source/_integrations/ovo_energy.markdown @timmo001
|
||||
source/_integrations/ozw.markdown @cgarwood @marcelveldt @MartinHjelmare
|
||||
source/_integrations/p1_monitor.markdown @klaasnicolaas
|
||||
@ -395,14 +404,13 @@ source/_integrations/profiler.markdown @bdraco
|
||||
source/_integrations/progettihwsw.markdown @ardaseremet
|
||||
source/_integrations/prometheus.markdown @knyar
|
||||
source/_integrations/prosegur.markdown @dgomes
|
||||
source/_integrations/proxmoxve.markdown @k4ds3 @jhollowe @Corbeno
|
||||
source/_integrations/proxmoxve.markdown @jhollowe @Corbeno
|
||||
source/_integrations/ps4.markdown @ktnrg45
|
||||
source/_integrations/push.markdown @dgomes
|
||||
source/_integrations/pvoutput.markdown @fabaff
|
||||
source/_integrations/pvoutput.markdown @fabaff @frenck
|
||||
source/_integrations/pvpc_hourly_pricing.markdown @azogue
|
||||
source/_integrations/qbittorrent.markdown @geoffreylagaisse
|
||||
source/_integrations/qld_bushfire.markdown @exxamalte
|
||||
source/_integrations/qnap.markdown @colinodell
|
||||
source/_integrations/quantum_gateway.markdown @cisasteelersfan
|
||||
source/_integrations/qvr_pro.markdown @oblogic7
|
||||
source/_integrations/qwikswitch.markdown @kellerza
|
||||
@ -418,7 +426,7 @@ source/_integrations/recollect_waste.markdown @bachya
|
||||
source/_integrations/recorder.markdown @home-assistant/core
|
||||
source/_integrations/rejseplanen.markdown @DarkFox
|
||||
source/_integrations/renault.markdown @epenet
|
||||
source/_integrations/repetier.markdown @MTrab
|
||||
source/_integrations/repetier.markdown @MTrab @ShadowBr0ther
|
||||
source/_integrations/rflink.markdown @javicalle
|
||||
source/_integrations/rfxtrx.markdown @danielhiversen @elupus @RobBie1221
|
||||
source/_integrations/ridwell.markdown @bachya
|
||||
@ -431,6 +439,7 @@ source/_integrations/roomba.markdown @pschmitt @cyr-ius @shenxn
|
||||
source/_integrations/roon.markdown @pavoni
|
||||
source/_integrations/rpi_gpio_pwm.markdown @soldag
|
||||
source/_integrations/rpi_power.markdown @shenxn @swetoast
|
||||
source/_integrations/rtsp_to_webrtc.markdown @allenporter
|
||||
source/_integrations/ruckus_unleashed.markdown @gabe565
|
||||
source/_integrations/safe_mode.markdown @home-assistant/core
|
||||
source/_integrations/saj.markdown @fredericvl
|
||||
@ -438,12 +447,13 @@ source/_integrations/samsungtv.markdown @escoand @chemelli74
|
||||
source/_integrations/scene.markdown @home-assistant/core
|
||||
source/_integrations/schluter.markdown @prairieapps
|
||||
source/_integrations/scrape.markdown @fabaff
|
||||
source/_integrations/screenlogic.markdown @dieselrabbit
|
||||
source/_integrations/screenlogic.markdown @dieselrabbit @bdraco
|
||||
source/_integrations/script.markdown @home-assistant/core
|
||||
source/_integrations/search.markdown @home-assistant/core
|
||||
source/_integrations/select.markdown @home-assistant/core
|
||||
source/_integrations/sense.markdown @kbickar
|
||||
source/_integrations/sensibo.markdown @andrey-git
|
||||
source/_integrations/senseme.markdown @mikelawrence @bdraco
|
||||
source/_integrations/sensibo.markdown @andrey-git @gjohansson-ST
|
||||
source/_integrations/sentry.markdown @dcramer @frenck
|
||||
source/_integrations/serial.markdown @fabaff
|
||||
source/_integrations/seven_segments.markdown @fabaff
|
||||
@ -469,13 +479,14 @@ source/_integrations/smarthab.markdown @outadoc
|
||||
source/_integrations/smartthings.markdown @andrewsayre
|
||||
source/_integrations/smarttub.markdown @mdz
|
||||
source/_integrations/smarty.markdown @z0mbieprocess
|
||||
source/_integrations/smhi.markdown @gjohansson-ST
|
||||
source/_integrations/sms.markdown @ocalvo
|
||||
source/_integrations/smtp.markdown @fabaff
|
||||
source/_integrations/solaredge.markdown @frenck
|
||||
source/_integrations/solaredge_local.markdown @drobtravels @scheric
|
||||
source/_integrations/solarlog.markdown @Ernst79
|
||||
source/_integrations/solax.markdown @squishykid
|
||||
source/_integrations/soma.markdown @ratsept
|
||||
source/_integrations/soma.markdown @ratsept @sebfortier2288
|
||||
source/_integrations/somfy.markdown @tetienne
|
||||
source/_integrations/sonarr.markdown @ctalkington
|
||||
source/_integrations/songpal.markdown @rytilahti @shenxn
|
||||
@ -489,7 +500,8 @@ source/_integrations/sql.markdown @dgomes
|
||||
source/_integrations/squeezebox.markdown @rajlaud
|
||||
source/_integrations/srp_energy.markdown @briglx
|
||||
source/_integrations/starline.markdown @anonym-tsk
|
||||
source/_integrations/statistics.markdown @fabaff
|
||||
source/_integrations/statistics.markdown @fabaff @ThomDietrich
|
||||
source/_integrations/steamist.markdown @bdraco
|
||||
source/_integrations/stiebel_eltron.markdown @fucm
|
||||
source/_integrations/stookalert.markdown @fwestenberg @frenck
|
||||
source/_integrations/stream.markdown @hunterjm @uvjustin @allenporter
|
||||
@ -510,9 +522,8 @@ source/_integrations/synology_dsm.markdown @hacf-fr @Quentame @mib1185
|
||||
source/_integrations/synology_srm.markdown @aerialls
|
||||
source/_integrations/syslog.markdown @fabaff
|
||||
source/_integrations/system_bridge.markdown @timmo001
|
||||
source/_integrations/tado.markdown @michaelarnauts @noltari
|
||||
source/_integrations/tado.markdown @michaelarnauts
|
||||
source/_integrations/tag.markdown @balloob @dmulcahey
|
||||
source/_integrations/tahoma.markdown @philklei
|
||||
source/_integrations/tailscale.markdown @frenck
|
||||
source/_integrations/tankerkoenig.markdown @guillempages
|
||||
source/_integrations/tapsaff.markdown @bazwilliams
|
||||
@ -534,26 +545,26 @@ source/_integrations/totalconnect.markdown @austinmroczek
|
||||
source/_integrations/tplink.markdown @rytilahti @thegardenmonkey
|
||||
source/_integrations/traccar.markdown @ludeeus
|
||||
source/_integrations/tractive.markdown @Danielhiversen @zhulik @bieniu
|
||||
source/_integrations/trafikverket_train.markdown @endor-force
|
||||
source/_integrations/trafikverket_weatherstation.markdown @endor-force
|
||||
source/_integrations/trafikverket_train.markdown @endor-force @gjohansson-ST
|
||||
source/_integrations/trafikverket_weatherstation.markdown @endor-force @gjohansson-ST
|
||||
source/_integrations/transmission.markdown @engrbm87 @JPHutchins
|
||||
source/_integrations/tts.markdown @pvizeli
|
||||
source/_integrations/tuya.markdown @Tuya @zlinoliver @METISU @frenck
|
||||
source/_integrations/twentemilieu.markdown @frenck
|
||||
source/_integrations/twinkly.markdown @dr1rrb
|
||||
source/_integrations/ubus.markdown @noltari
|
||||
source/_integrations/twinkly.markdown @dr1rrb @Robbie1221
|
||||
source/_integrations/unifi.markdown @Kane610
|
||||
source/_integrations/unifiled.markdown @florisvdk
|
||||
source/_integrations/unifiprotect.markdown @briis @AngellusMortis @bdraco
|
||||
source/_integrations/upb.markdown @gwww
|
||||
source/_integrations/upc_connect.markdown @pvizeli @fabaff
|
||||
source/_integrations/upcloud.markdown @scop
|
||||
source/_integrations/updater.markdown @home-assistant/core
|
||||
source/_integrations/upnp.markdown @StevenLooman @ehendrix23
|
||||
source/_integrations/uptimerobot.markdown @ludeeus
|
||||
source/_integrations/uptimerobot.markdown @ludeeus @chemelli74
|
||||
source/_integrations/usb.markdown @bdraco
|
||||
source/_integrations/usgs_earthquakes_feed.markdown @exxamalte
|
||||
source/_integrations/utility_meter.markdown @dgomes
|
||||
source/_integrations/vallox.markdown @andre-richter
|
||||
source/_integrations/vallox.markdown @andre-richter @slovdahl @viiru-
|
||||
source/_integrations/velbus.markdown @Cereal2nd @brefra
|
||||
source/_integrations/velux.markdown @Julius2342
|
||||
source/_integrations/venstar.markdown @garbled1
|
||||
@ -580,6 +591,7 @@ source/_integrations/webostv.markdown @bendavid @thecode
|
||||
source/_integrations/websocket_api.markdown @home-assistant/core
|
||||
source/_integrations/wemo.markdown @esev
|
||||
source/_integrations/whirlpool.markdown @abmantis
|
||||
source/_integrations/whois.markdown @frenck
|
||||
source/_integrations/wiffi.markdown @mampfes
|
||||
source/_integrations/wilight.markdown @leofig-rj
|
||||
source/_integrations/wirelesstag.markdown @sergeymaysak
|
||||
@ -597,7 +609,7 @@ source/_integrations/xmpp.markdown @fabaff @flowolf
|
||||
source/_integrations/yale_smart_alarm.markdown @gjohansson-ST
|
||||
source/_integrations/yamaha_musiccast.markdown @vigonotion @micha91
|
||||
source/_integrations/yandex_transport.markdown @rishatik92 @devbis
|
||||
source/_integrations/yeelight.markdown @rytilahti @zewelor @shenxn @starkillerOG
|
||||
source/_integrations/yeelight.markdown @zewelor @shenxn @starkillerOG
|
||||
source/_integrations/yeelightsunflower.markdown @lindsaymarkward
|
||||
source/_integrations/yi.markdown @bachya
|
||||
source/_integrations/youless.markdown @gjong
|
||||
|
||||
@ -105,10 +105,10 @@ social:
|
||||
account: home_assistant
|
||||
|
||||
# Home Assistant release details
|
||||
current_major_version: 2021
|
||||
current_minor_version: 12
|
||||
current_patch_version: 10
|
||||
date_released: 2022-01-17
|
||||
current_major_version: 2022
|
||||
current_minor_version: 02
|
||||
current_patch_version: 0
|
||||
date_released: 2022-02-02
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
@ -208,6 +208,28 @@ The same thing can also be expressed as a filter:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{% raw %}
|
||||
|
||||
```text
|
||||
{% for energy in expand('group.energy_sensors') if is_number(energy.state) %}
|
||||
{{ energy.state }}
|
||||
{%- if not loop.last %}, {% endif -%}
|
||||
{% endfor %}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
The same thing can also be expressed as a test:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```text
|
||||
{{ expand('group.energy_sensors')
|
||||
| selectattr("state", 'is_number') | join(', ') }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Devices
|
||||
|
||||
- `device_entities(device_id)` returns a list of entities that are associated with a given device ID. Can also be used as a filter.
|
||||
@ -297,6 +319,62 @@ The same thing can also be expressed as a filter:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Immediate if (iif)
|
||||
|
||||
A common case is to conditionally return a value based on another value.
|
||||
For example, return a "Yes" or "No" when the light is on or off.
|
||||
|
||||
This can be written as:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```text
|
||||
{% if is_state('light.kitchen', 'on') %}
|
||||
Yes
|
||||
{% else %}
|
||||
No
|
||||
{% endif %}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
Or using a shorter syntax:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```text
|
||||
{{ 'Yes' if is_state('light.kitchen', 'on') else 'No' }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
Additionally, to the above, you can use the `iif` function/filter, which is
|
||||
an immediate if.
|
||||
|
||||
Syntax: `iif(condition, if_true, if_false, if_none)`
|
||||
|
||||
`iif` returns the value of `if_true` if the condition is truthy, the value of `if_false` if it's `falsy` and the value of `if_none` if it's `None`.
|
||||
An empty string, an empty mapping or an an empty list, are all falsy, refer to [the Python documentation](https://docs.python.org/3/library/stdtypes.html#truth-value-testing) for an in depth explanation.
|
||||
|
||||
`if_true` is optional, if it's omitted `True` is returned if the condition is truthy.
|
||||
`if_false` is optional, if it's omitted `False` is returned if the condition is falsy.
|
||||
`if_none` is optional, if it's omitted the value of `if_false` is returned if the condition is `None`.
|
||||
|
||||
Examples using `iif`:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```text
|
||||
{{ iif(is_state('light.kitchen', 'on'), 'Yes', 'No') }}
|
||||
|
||||
{{ is_state('light.kitchen', 'on') | iif('Yes', 'No') }}
|
||||
|
||||
{{ (state('light.kitchen') == 'on') | iif('Yes', 'No') }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
|
||||
### Time
|
||||
|
||||
`now()` and `utcnow()` are not supported in [limited templates](#limited-templates).
|
||||
@ -558,6 +636,9 @@ The numeric functions and filters will not fail if the input is not a valid numb
|
||||
- `atan(value, default)` will return the arcus tangent of the input. If `value` can't be converted to a `float`, returns the `default` value, or if omitted `value`. Can be used as a filter.
|
||||
- `atan2(y, x, default)` will return the four quadrant arcus tangent of y / x. If `y` or `x` can't be converted to a `float`, returns the `default` value, or if omitted `value`. Can be used as a filter.
|
||||
- `sqrt(value, default)` will return the square root of the input. If `value` can't be converted to a `float`, returns the `default` value, or if omitted `value`. Can be used as a filter.
|
||||
- `max([x, y, ...])` will obtain the largest item in a sequence. Uses the same parameters as the built-in [max](https://jinja.palletsprojects.com/en/latest/templates/#jinja-filters.max) filter.
|
||||
- `min([x, y, ...])` will obtain the smallest item in a sequence. Uses the same parameters as the built-in [min](https://jinja.palletsprojects.com/en/latest/templates/#jinja-filters.min) filter.
|
||||
- `average([x, y, ...])` will return the average value of the sequence. Can be used as a filter.
|
||||
- `e` mathematical constant, approximately 2.71828.
|
||||
- `pi` mathematical constant, approximately 3.14159.
|
||||
- `tau` mathematical constant, approximately 6.28318.
|
||||
@ -565,9 +646,6 @@ The numeric functions and filters will not fail if the input is not a valid numb
|
||||
- `round(precision, "floor", default)` will always round down to `precision` decimals
|
||||
- `round(precision, "ceil", default)` will always round up to `precision` decimals
|
||||
- `round(1, "half", default)` will always round to the nearest .5 value. `precision` should be 1 for this mode
|
||||
- Filter `[x, y, ...] | max` will obtain the largest item in a sequence.
|
||||
- Filter `[x, y, ...] | min` will obtain the smallest item in a sequence.
|
||||
- Filter `[x, y, ...] | average` will return the average value of the sequence.
|
||||
- Filter `value_one|bitwise_and(value_two)` perform a bitwise and(&) operation with two values.
|
||||
- Filter `value_one|bitwise_or(value_two)` perform a bitwise or(\|) operation with two values.
|
||||
- Filter `ord` will return for a string of length one an integer representing the Unicode code point of the character when the argument is a Unicode object, or the value of the byte when the argument is an 8-bit string.
|
||||
@ -600,6 +678,7 @@ Some examples:
|
||||
### String filters
|
||||
|
||||
- Filter `urlencode` will convert an object to a percent-encoded ASCII text string (e.g., for HTTP requests using `application/x-www-form-urlencoded`).
|
||||
- Filter `slugify(separator="_")` will convert a given string into a "slug".
|
||||
|
||||
### Regular expressions
|
||||
|
||||
@ -714,6 +793,51 @@ To evaluate a response, go to **{% my developer_template title="Developer Tools
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Using templates with the MQTT integration
|
||||
|
||||
The [MQTT integration](/integrations/mqtt/) relies heavily on templates. Templates are used to transform incoming payloads (value templates) to status updates or incoming service calls (command templates) to payloads that configure the MQTT device.
|
||||
|
||||
#### Using value templates with MQTT
|
||||
|
||||
For incoming data a value template translates incoming JSON or raw data to a valid payload.
|
||||
Incoming payloads are rendered with possible JSON values, so when rendering the `value_json` can be used access the attributes in a JSON based payload.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Example value template:
|
||||
|
||||
With given payload:
|
||||
|
||||
```json
|
||||
{ "state": "ON", "temperature": 21.902 }
|
||||
```
|
||||
|
||||
Template {% raw %}```{{ value_json.temperature | round(1) }}```{% endraw %} renders to `21.9`.
|
||||
|
||||
Additional the MQTT entity attributes `entity_id` and `name` can be used as variables in the template.
|
||||
|
||||
</div>
|
||||
|
||||
#### Using command templates with MQTT
|
||||
|
||||
For service calls command templates are defined to format the outgoing MQTT payload to the device. When a service call is executed `value` can be used to generate the correct payload to the device.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Example command template:
|
||||
|
||||
With given value `21.9` template {% raw %}```{"temperature": {{ value }} }```{% endraw %} renders to:
|
||||
|
||||
```json
|
||||
{
|
||||
"temperature": 21.9
|
||||
}
|
||||
```
|
||||
|
||||
Additional the MQTT entity attributes `entity_id` and `name` can be used as variables in the template.
|
||||
|
||||
</div>
|
||||
|
||||
## Some more things to keep in mind
|
||||
|
||||
### `entity_id` that begins with a number
|
||||
|
||||
@ -424,7 +424,7 @@ condition:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
But also in the `repeat` action's `while` or `until` option, or in a `choose` action's `conditions` option:
|
||||
It's also supported in the `repeat` action's `while` or `until` option, or in a `choose` action's `conditions` option:
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -447,15 +447,15 @@ But also in the `repeat` action's `while` or `until` option, or in a `choose` ac
|
||||
|
||||
{% endraw %}
|
||||
|
||||
<div class="note warning">
|
||||
It's also supported in script or automation `condition` actions:
|
||||
|
||||
While conditions can be used in script sequences or automation actions, the
|
||||
shorthand for template conditions cannot be used directly in those constructs.
|
||||
{% raw %}
|
||||
|
||||
However, if an used action supports conditions itself, like `choose` and
|
||||
`repeat`, the shorthand template conditions will be accepted in those cases.
|
||||
```yaml
|
||||
- condition: "{{ is_state('device_tracker.iphone', 'away') }}"
|
||||
```
|
||||
|
||||
</div>
|
||||
{% endraw %}
|
||||
|
||||
[template]: /topics/templating/
|
||||
[automation-templating]: /getting-started/automation-templating/
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate Adax heater into Home Assistant.
|
||||
ha_category:
|
||||
- Climate
|
||||
ha_release: 2021.8
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
- '@danielhiversen'
|
||||
ha_domain: adax
|
||||
@ -15,7 +15,11 @@ ha_platforms:
|
||||
|
||||
Integrates Adax heater into Home Assistant.
|
||||
|
||||
You'll need the Account ID (which can be found in the Adax Wifi app, pressing 'Account'). You will also need a credential, which you can create in the Adax app:
|
||||
You can configure the heaters to use a local or cloud interface.
|
||||
|
||||
The local integrations only works with newer Adax heaters with both Bluetooth and wifi. Home Assistant uses Bluetooth to configure the heaters. For the local integration, you have to reset the heater by pressing + and OK until the display shows 'Reset'. Then press and hold the OK button on the heater until the blue LED starts blinking before pressing Submit. Configuring the heater might take some minutes. Using the local integration will disable cloud communication and the Adax app will not work.
|
||||
|
||||
For the cloud integration, you'll need the Account ID (which can be found in the Adax Wifi app, pressing 'Account'). You will also need a credential, which you can create in the Adax app:
|
||||
|
||||
1. Navigate to Account Tab,
|
||||
2. Select “Remote user client API”
|
||||
|
||||
@ -11,6 +11,7 @@ ha_domain: advantage_air
|
||||
ha_quality_scale: platinum
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- diagnostics
|
||||
- climate
|
||||
- cover
|
||||
- sensor
|
||||
|
||||
@ -7,8 +7,6 @@ ha_category:
|
||||
- Sensor
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@noltari'
|
||||
ha_domain: aemet
|
||||
ha_platforms:
|
||||
- sensor
|
||||
|
||||
@ -10,6 +10,7 @@ ha_codeowners:
|
||||
ha_domain: airvisual
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
|
||||
@ -148,6 +148,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -11,6 +11,7 @@ ha_codeowners:
|
||||
ha_domain: ambient_station
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
|
||||
@ -4,9 +4,11 @@ description: Instructions on how to integrate Android TV and Fire TV devices int
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.7.6
|
||||
ha_config_flow: true
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
- '@JeffLIrion'
|
||||
- '@ollo69'
|
||||
ha_domain: androidtv
|
||||
ha_platforms:
|
||||
- media_player
|
||||
@ -34,152 +36,45 @@ For Fire TV devices, the instructions are as follows:
|
||||
- From the main (Launcher) screen, select Settings.
|
||||
- Select My Fire TV > About > Network.
|
||||
|
||||
## Configuration
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
# Use the Python ADB implementation
|
||||
- platform: androidtv
|
||||
name: Android TV 1
|
||||
host: 192.168.0.111
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address for your Android TV / Fire TV device.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The friendly name of the device.
|
||||
required: false
|
||||
default: Android TV
|
||||
type: string
|
||||
port:
|
||||
description: The port for your Android TV / Fire TV device.
|
||||
required: false
|
||||
default: 5555
|
||||
type: integer
|
||||
adbkey:
|
||||
description: The path to your `adbkey` file; if not provided, Home Assistant will generate a key for you (if necessary).
|
||||
required: false
|
||||
type: string
|
||||
adb_server_ip:
|
||||
description: The IP address of the ADB server. If this is provided, the integration will utilize an [ADB server](#2-adb-server) to communicate with the device.
|
||||
required: false
|
||||
type: string
|
||||
adb_server_port:
|
||||
description: The port for the ADB server.
|
||||
required: false
|
||||
default: 5037
|
||||
type: integer
|
||||
get_sources:
|
||||
description: Whether or not to retrieve the running apps as the list of sources.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
apps:
|
||||
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below. If a name is not provided, the app will never be shown in the sources list. ([These app names](https://github.com/JeffLIrion/python-androidtv/blob/748d6b71cad611c624ef7526d9928431167531a3/androidtv/constants.py#L290-L308) are configured in the backend package and do not need to be included in your configuration.)
|
||||
required: false
|
||||
default: {}
|
||||
type: map
|
||||
exclude_unnamed_apps:
|
||||
description: If this is true, then only the apps you specify in the `apps` configuration parameter and [those specified in the backend library](https://github.com/JeffLIrion/python-androidtv/blob/5c39196ade3f88ab453b205fd15b32472d3e0482/androidtv/constants.py#L267-L283) will be shown in the sources list.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
device_class:
|
||||
description: "The type of device: `auto` (detect whether it is an Android TV or Fire TV device), `androidtv`, or `firetv`."
|
||||
required: false
|
||||
default: auto
|
||||
type: string
|
||||
state_detection_rules:
|
||||
description: A dictionary whose keys are app IDs and whose values are lists of state detection rules; see the section [Custom State Detection](#custom-state-detection) for more info.
|
||||
required: false
|
||||
default: {}
|
||||
type: map
|
||||
turn_on_command:
|
||||
description: An ADB shell command that will override the default `turn_on` command.
|
||||
required: false
|
||||
type: string
|
||||
turn_off_command:
|
||||
description: An ADB shell command that will override the default `turn_off` command.
|
||||
required: false
|
||||
type: string
|
||||
screencap:
|
||||
description: Determines if album art should be pulled from what is shown onscreen.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
### Full Configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
# Use the Python ADB implementation with a user-provided key to setup an
|
||||
# Android TV device. Provide some app names and don't display other apps
|
||||
# in the sources menu. Override the default turn on/off commands, and
|
||||
# provide custom state detection rules.
|
||||
- platform: androidtv
|
||||
name: Android TV
|
||||
device_class: androidtv
|
||||
host: 192.168.0.222
|
||||
adbkey: "/config/android/adbkey"
|
||||
exclude_unnamed_apps: true
|
||||
apps:
|
||||
com.amazon.tv.launcher: "Fire TV"
|
||||
some.background.app: # this will never show up in the sources list
|
||||
another.background.app: "" # this will also never show up in the sources list
|
||||
turn_on_command: "input keyevent 3"
|
||||
turn_off_command: "input keyevent 223"
|
||||
state_detection_rules:
|
||||
'com.amazon.tv.launcher':
|
||||
- 'standby'
|
||||
'com.netflix.ninja':
|
||||
- 'media_session_state'
|
||||
'com.ellation.vrv':
|
||||
- 'audio_state'
|
||||
'com.plexapp.android':
|
||||
- 'paused':
|
||||
'media_session_state': 3 # this indentation is important!
|
||||
'wake_lock_size': 1 # this indentation is important!
|
||||
- 'playing':
|
||||
'media_session_state': 3 # this indentation is important!
|
||||
- 'standby'
|
||||
'com.amazon.avod':
|
||||
- 'playing':
|
||||
'wake_lock_size': 4 # this indentation is important!
|
||||
- 'playing':
|
||||
'wake_lock_size': 3 # this indentation is important!
|
||||
- 'paused':
|
||||
'wake_lock_size': 2 # this indentation is important!
|
||||
- 'paused':
|
||||
'wake_lock_size': 1 # this indentation is important!
|
||||
- 'standby'
|
||||
|
||||
# Use an ADB server to setup a Fire TV device and don't get the running apps.
|
||||
- platform: androidtv
|
||||
name: Fire TV
|
||||
device_class: firetv
|
||||
host: 192.168.0.222
|
||||
adb_server_ip: 127.0.0.1
|
||||
adb_server_port: 5037
|
||||
get_sources: false
|
||||
```
|
||||
{% include integrations/option_flow.md %}
|
||||
{% configuration_basic %}
|
||||
Configure Applications List:
|
||||
description: Here you can define applications that are not automatically detected by the backend library, where the keys are app IDs and the values are app names that will be displayed in the UI. If a name is not provided and the option `Exclude apps with unknown name` is enabled, the app will never be shown in the sources list.
|
||||
Retrieve the running apps as the list of sources:
|
||||
description: "Whether or not to retrieve the running apps as the list of sources. If this option is checked, the running apps will be retrieved and used as the sources. If not, there will be only one source: the current app."
|
||||
Exclude apps with unknown name:
|
||||
description: "Exclude app with unknown name from the source list. If this option is checked, then only apps configured in `Configured Application List` option will be listed among the sources."
|
||||
Use screen capture for album art:
|
||||
description: "Determines if album art should be pulled from what is shown on screen."
|
||||
ADB shell turn off command:
|
||||
description: "ADB shell command to override default turn off command. Leave empty to use default."
|
||||
ADB shell turn on command:
|
||||
description: "ADB shell command to override default turn on command. Leave empty to use default."
|
||||
Configure State Detection Rules:
|
||||
description: Here you can configure a list of rules where the rule key is the app IDs and whose values are lists of state detection rules. As example a valid value for a detection rule is `["standby", {"playing":{"media_session_state":4}}, {"paused":{"media_session_state":3, "wake_lock_size":4}}]`. Note that rule values must be always inside square bracket (`[...]`). See the section [Custom State Detection](#custom-state-detection) for more info.
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## ADB Setup
|
||||
|
||||
This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
When connecting to your device for the first time, a dialog will appear on your Android TV / Fire TV asking you to approve the connection. Check the box that says "always allow connections from this device" and hit OK.
|
||||
|
||||
</div>
|
||||
|
||||
### 1. Python ADB Implementation
|
||||
|
||||
The default approach is to connect to your device using the `adb-shell` Python package. As of Home Assistant 0.101, if a key is needed for authentication and it is not provided by the `adbkey` configuration option, then Home Assistant will generate a key for you.
|
||||
The default approach is to connect to your device using the `adb-shell` Python package. As of Home Assistant 0.101, if a key is needed for authentication and it is not provided by the `ADB Key` setup option, then Home Assistant will generate a key for you.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
To be able to provide `ADB Key` on integration setup, you need to enable [advanced mode](/blog/2019/07/17/release-96/#advanced-mode).
|
||||
|
||||
</div>
|
||||
|
||||
Prior to Home Assistant 0.101, this approach did not work well for newer devices. Efforts have been made to resolve these issues, but if you experience problems then you should use the ADB server option.
|
||||
|
||||
@ -187,6 +82,12 @@ Prior to Home Assistant 0.101, this approach did not work well for newer devices
|
||||
|
||||
The second option is to use an ADB server to connect to your Android TV and Fire TV devices.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
To configure ADB server on integration setup, you need to enable [advanced mode](/blog/2019/07/17/release-96/#advanced-mode).
|
||||
|
||||
</div>
|
||||
|
||||
Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
|
||||
|
||||
## ADB Troubleshooting
|
||||
@ -264,7 +165,7 @@ Available key commands include:
|
||||
- `BACK`
|
||||
- `MENU`
|
||||
|
||||
The full list of key commands can be found [here](https://github.com/JeffLIrion/python-androidtv/blob/748d6b71cad611c624ef7526d9928431167531a3/androidtv/constants.py#L189-L233).
|
||||
The full list of key commands can be found in the backend [androidtv](https://github.com/JeffLIrion/python-androidtv) package.
|
||||
|
||||
You can also use the command `GET_PROPERTIES` to retrieve the properties used by Home Assistant to update the device's state. These will be stored in the media player's `'adb_response'` attribute and logged at the INFO level. This information can be used to help improve state detection in the backend [androidtv](https://github.com/JeffLIrion/python-androidtv) package, and also to define your own [custom state detection](#custom-state-detection) rules.
|
||||
|
||||
|
||||
@ -10,6 +10,13 @@ ha_platforms:
|
||||
- notify
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
We recommend using our mobile companion applications instead.
|
||||
|
||||
</div>
|
||||
|
||||
The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant.
|
||||
|
||||
## Setup
|
||||
|
||||
@ -1,154 +0,0 @@
|
||||
---
|
||||
title: Arduino
|
||||
description: Instructions on how to setup an Arduino boards within Home Assistant.
|
||||
ha_category:
|
||||
- DIY
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
- '@fabaff'
|
||||
ha_domain: arduino
|
||||
ha_platforms:
|
||||
- sensor
|
||||
- switch
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated. Please move to the [Firmata integration](/integrations/firmata).
|
||||
|
||||
</div>
|
||||
|
||||
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection.
|
||||
The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of the board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
|
||||
|
||||
There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
|
||||
|
||||
The `arduino` integration is designed to let you use a directly attached board to your Home Assistant host over USB.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Sensor](#sensor)
|
||||
- [Switch](#switch)
|
||||
|
||||
## Configuration
|
||||
|
||||
You need to have the [Firmata firmware](https://github.com/firmata/) on your board. Please upload the `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information.
|
||||
|
||||
To integrate an Arduino boards with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
arduino:
|
||||
port: /dev/ttyACM0
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
port:
|
||||
description: The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named `ttyACM*` otherwise `ttyUSB*`.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
The exact number can be determined with the command shown below.
|
||||
|
||||
```bash
|
||||
ls /dev/ttyACM*
|
||||
```
|
||||
|
||||
If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g., `/dev/ttyUSB*`).
|
||||
|
||||
<div class='note warning'>
|
||||
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
|
||||
</div>
|
||||
|
||||
Add the user who is used to run Home Assistant to the groups to allow access to the serial port.
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout,lock $USER
|
||||
```
|
||||
|
||||
## Sensor
|
||||
|
||||
The `arduino` sensor platform allows you to get numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024.
|
||||
|
||||
To enable an Arduino sensor with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
platform: arduino
|
||||
pins:
|
||||
1:
|
||||
name: Door switch
|
||||
0:
|
||||
name: Brightness
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
pins:
|
||||
description: List of pins to use.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
pin_number:
|
||||
description: The pin number that corresponds with the pin numbering schema of your board.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name that will be used in the frontend for the pin.
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
The 6 analog pins of an Arduino UNO are numbered from A0 to A5.
|
||||
|
||||
## Switch
|
||||
|
||||
The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3, 5, 6, 9, 10, and 11 on an Arduino Uno) is not supported yet.
|
||||
|
||||
To enable the Arduino pins with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: arduino
|
||||
pins:
|
||||
11:
|
||||
name: Fan Office
|
||||
12:
|
||||
name: Light Desk
|
||||
initial: true
|
||||
negate: true
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
pins:
|
||||
description: List of pins to use.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
pin_number:
|
||||
description: The pin number that corresponds with the pin numbering schema of your board.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name that will be used in the frontend for the pin.
|
||||
type: string
|
||||
required: false
|
||||
initial:
|
||||
description: The initial value for this port.
|
||||
type: boolean
|
||||
required: false
|
||||
default: false
|
||||
negate:
|
||||
description: If this pin should be inverted.
|
||||
type: boolean
|
||||
required: false
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
The digital pins are numbered from 0 to 13 on a Arduino UNO. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED.
|
||||
22
source/_integrations/aseko_pool_live.markdown
Normal file
22
source/_integrations/aseko_pool_live.markdown
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Aseko Pool Live
|
||||
description: Instructions on how to integrate Aseko ASIN AQUA dosing systems within Home Assistant.
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_release: 2022.2
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_codeowners:
|
||||
- '@milanmeu'
|
||||
ha_domain: aseko_pool_live
|
||||
ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
The Aseko Pool Live integration allows you to monitor your Aseko ASIN Aqua dosing systems.
|
||||
|
||||
The integration is fully compatible with ASIN AQUA Net and ASIN AQUA Home.
|
||||
|
||||
If you have an ASIN AQUA Oxygen, Home, Salt or Profi dosing system and not all probes are listed in Home Assistant, [open an issue on GitHub](https://github.com/home-assistant/core/issues/new?template=bug_report.yml&title=Add%20support%20for%20ASIN%20AQUA%20[your%20device%20model]) and include the first 8 digits of your serial number so that your device model can be made fully compatible with Home Assistant.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
45
source/_integrations/aussie_broadband.markdown
Normal file
45
source/_integrations/aussie_broadband.markdown
Normal file
@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Aussie Broadband
|
||||
description: Instructions on how to integrate Aussie Broadband within Home Assistant.
|
||||
ha_category:
|
||||
- Network
|
||||
- Sensor
|
||||
ha_release: 2022.2
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@nickw444'
|
||||
- '@Bre77'
|
||||
ha_domain: aussie_broadband
|
||||
ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
The Aussie Broadband integration displays various service metrics using the [Aussie Broadband API](https://myaussie-api.aussiebroadband.com.au).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You must have a [My Aussie Broadband](https://my.aussiebroadband.com.au) account, and at least 1 active service.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Entities
|
||||
|
||||
### Sensor
|
||||
|
||||
The integration will create sensor entities for a variety of metrics that relate to your service:
|
||||
|
||||
#### NBN/Internet Services
|
||||
- Total Usage
|
||||
- Downloaded Data
|
||||
- Uploaded Data
|
||||
- Billing Cycle Length
|
||||
- Billing Cycle Remaining
|
||||
|
||||
#### Mobile Phone
|
||||
- Data Usage
|
||||
- National Calls
|
||||
- Mobile Calls
|
||||
- SMS Sent
|
||||
- Billing Cycle Length
|
||||
- Billing Cycle Remaining
|
||||
@ -20,6 +20,7 @@ ha_dhcp: true
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- camera
|
||||
- diagnostics
|
||||
- light
|
||||
- switch
|
||||
---
|
||||
|
||||
@ -8,6 +8,7 @@ ha_iot_class: Cloud Push
|
||||
ha_codeowners:
|
||||
- '@eavanvalkenburg'
|
||||
ha_domain: azure_event_hub
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to an [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
|
||||
@ -24,60 +25,59 @@ Once you have the name of your namespace, instance, Shared Access Policy and the
|
||||
|
||||
The alternative approach is to use a connection string and instance name, this can be retrieved in the same way as the Shared Access Policy and this can also be gotten for a device in an IoT Hub (Event Hub-compatible connection string). In the case of IoT Hub, you need to put the Device ID as the instance name.
|
||||
|
||||
The final thing to consider is how often you want the integration to send messages in a batch to your hub, this is set with the `send_interval`, with a default of 5 seconds. The other thing to look at is what the maximum delay you want to use, since this component runs in an asynchronous way there is no guarantee that the sending happens exactly on time, so depending on your semantics you might want messages discarded. The actual check of the time happens with `max_delay` plus `send_interval`, so that even with a long `send_interval` the semantics are the same.
|
||||
The final thing to consider is how often you want the integration to send messages in a batch to your hub, this is set with the `send_interval`, with a default of 5 seconds. Since this component runs in an asynchronous way there is no guarantee that the sending happens exactly on time, and because your Home Assistant might be very busy with lots of events happening it might discard several events that are older then 20 seconds plus the `send_interval`.
|
||||
|
||||
## Configuration
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
Add the following lines to your `configuration.yaml` file:
|
||||
You can setup [filters](#filter-configuration) through the `configuration.yaml`.
|
||||
|
||||
<div class='note warning'>
|
||||
Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space and bandwidth.
|
||||
</div>
|
||||
|
||||
<div class='note warning'>
|
||||
Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
|
||||
</div>
|
||||
|
||||
### Filter Configuration
|
||||
|
||||
By default, no entity will be excluded. To limit which entities are being exposed to `Azure Event Hub`, you can use the `filter` parameter.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example filter to include specified domains and exclude specified entities
|
||||
azure_event_hub:
|
||||
event_hub_namespace: NAMESPACE_NAME
|
||||
event_hub_instance_name: EVENT_HUB_INSTANCE_NAME
|
||||
event_hub_sas_policy: SAS_POLICY_NAME
|
||||
event_hub_sas_key: SAS_KEY
|
||||
filter:
|
||||
include_domains:
|
||||
- homeassistant
|
||||
- alarm_control_panel
|
||||
- light
|
||||
- media_player
|
||||
include_entity_globs:
|
||||
- binary_sensor.*_occupancy
|
||||
exclude_entities:
|
||||
- light.kitchen_light
|
||||
```
|
||||
|
||||
Filters are applied as follows:
|
||||
|
||||
1. No includes or excludes - pass all entities
|
||||
2. Includes, no excludes - only include specified entities
|
||||
3. Excludes, no includes - only exclude specified entities
|
||||
4. Both includes and excludes:
|
||||
- Include domain and/or glob patterns specified
|
||||
- If domain is included, and entity not excluded or match exclude glob pattern, pass
|
||||
- If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
|
||||
- If domain is not included, glob pattern does not match, and entity not included, fail
|
||||
- Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
|
||||
- If domain is excluded and entity not included, fail
|
||||
- If entity matches exclude glob pattern and entity not included, fail
|
||||
- If entity does not match any exclude criteria (domain, glob pattern or listed), pass
|
||||
- Neither include or exclude specifies domains or glob patterns
|
||||
- If entity is included, pass (as #2 above)
|
||||
- If entity include and exclude, the entity exclude is ignored
|
||||
|
||||
{% configuration %}
|
||||
event_hub_namespace:
|
||||
description: The name of your Event Hub namespace.
|
||||
required: exclusive
|
||||
type: string
|
||||
event_hub_instance_name:
|
||||
description: The name of your Event Hub instance.
|
||||
required: true
|
||||
type: string
|
||||
event_hub_sas_policy:
|
||||
description: The name of your Shared Access Policy.
|
||||
required: exclusive
|
||||
type: string
|
||||
event_hub_sas_key:
|
||||
description: The key for the Shared Access Policy.
|
||||
required: exclusive
|
||||
type: string
|
||||
event_hub_connection_string:
|
||||
description: The connection string to your event hub.
|
||||
required: exclusive
|
||||
type: string
|
||||
send_interval:
|
||||
description: The interval in seconds should events be sent to the Event Hub.
|
||||
required: false
|
||||
type: integer
|
||||
default: 5
|
||||
max_delay:
|
||||
description: The time in seconds after which a message is to be discarded.
|
||||
required: false
|
||||
type: integer
|
||||
default: 30
|
||||
filter:
|
||||
description: Filter domains and entities for Event Hub. ([Configure Filter](#configure-filter))
|
||||
required: true
|
||||
description: Filter domains and entities for Event Hub.
|
||||
required: false
|
||||
type: map
|
||||
default: Includes all entities from all domains
|
||||
keys:
|
||||
@ -107,66 +107,6 @@ filter:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
<div class='note warning'>
|
||||
Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space.
|
||||
</div>
|
||||
|
||||
<div class='note warning'>
|
||||
Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
|
||||
</div>
|
||||
|
||||
### Configure Filter
|
||||
|
||||
By default, no entity will be excluded. To limit which entities are being exposed to `Azure Event Hub`, you can use the `filter` parameter.
|
||||
|
||||
```yaml
|
||||
# Example filter to include specified domains and exclude specified entities
|
||||
azure_event_hub:
|
||||
event_hub_namespace: NAMESPACE_NAME
|
||||
event_hub_instance_name: EVENT_HUB_INSTANCE_NAME
|
||||
event_hub_sas_policy: SAS_POLICY_NAME
|
||||
event_hub_sas_key: SAS_KEY
|
||||
filter:
|
||||
include_domains:
|
||||
- alarm_control_panel
|
||||
- light
|
||||
include_entity_globs:
|
||||
- binary_sensor.*_occupancy
|
||||
exclude_entities:
|
||||
- light.kitchen_light
|
||||
```
|
||||
|
||||
Filters are applied as follows:
|
||||
|
||||
1. No includes or excludes - pass all entities
|
||||
2. Includes, no excludes - only include specified entities
|
||||
3. Excludes, no includes - only exclude specified entities
|
||||
4. Both includes and excludes:
|
||||
- Include domain and/or glob patterns specified
|
||||
- If domain is included, and entity not excluded or match exclude glob pattern, pass
|
||||
- If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
|
||||
- If domain is not included, glob pattern does not match, and entity not included, fail
|
||||
- Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
|
||||
- If domain is excluded and entity not included, fail
|
||||
- If entity matches exclude glob pattern and entity not included, fail
|
||||
- If entity does not match any exclude criteria (domain, glob pattern or listed), pass
|
||||
- Neither include or exclude specifies domains or glob patterns
|
||||
- If entity is included, pass (as #2 above)
|
||||
- If entity include and exclude, the entity exclude is ignored
|
||||
|
||||
### Advanced configuration
|
||||
|
||||
This is what the configuration will look like when using a connection string directly, instead of the four parameters. It also shows how to set the send_interval and max_delay to something other than the default. This means once every minute the integration will connect to your hub and send messages, but the messages have to be less than 65 seconds old at the time of sending for them to be counted (send_interval + max_delay).
|
||||
|
||||
```yaml
|
||||
# Connection string config with non-defaults for send_interval and max_delay
|
||||
azure_event_hub:
|
||||
event_hub_connection_string: CONNECTION_STRING
|
||||
event_hub_instance_name: EVENT_HUB_INSTANCE_NAME
|
||||
send_interval: 60
|
||||
max_delay: 5
|
||||
```
|
||||
|
||||
## Using the data in Azure
|
||||
|
||||
There are a number of ways to stream the data that comes into the Event Hub into storages in Azure, the easiest way is to use the built-in Capture function and this allows you to capture the data in Azure Blob Storage or Azure Data Lake store, [details here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-capture-overview).
|
||||
|
||||
@ -13,6 +13,14 @@ ha_platforms:
|
||||
- switch
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `bbb_gpio` integration is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
|
||||
There is no setup needed for the integration itself.
|
||||
|
||||
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](https://www.mouser.com/ds/2/348/bh1750fvi-e-186247.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
|
||||
|
||||
Tested devices:
|
||||
|
||||
@ -46,6 +46,7 @@ The full list of supported binary sensor device classes is below
|
||||
- **None**: Generic on/off. This is the default and doesn't need to be set.
|
||||
- **battery**: `on` means low, `off` means normal
|
||||
- **battery_charging**: `on` means charging, `off` means not charging
|
||||
- **carbon_monoxide**: `on` means carbon monoxide detected, `off` no carbon monoxide (clear)
|
||||
- **cold**: `on` means cold, `off` means normal
|
||||
- **connectivity**: `on` means connected, `off` means disconnected
|
||||
- **door**: `on` means open, `off` means closed
|
||||
|
||||
@ -118,7 +118,7 @@ enabled_by_default:
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payload received at `state_topic` and availability topics `availability_topic` and `topic`. Set to `""` to disable decoding.
|
||||
description: The encoding of the payloads received. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- light
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The Bosch BME280 integration allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins) or connected via SPI. It allows you to use all the operation modes of the sensor described in its datasheet.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement.
|
||||
|
||||
Tested devices:
|
||||
|
||||
@ -15,6 +15,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `bmp280` sensor platform allows you to read temperature and pressure values of a [Bosch BMP280 Environmental sensor](https://www.bosch-sensortec.com/products/environmental-sensors/pressure-sensors/bmp280/) connected via [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins).
|
||||
|
||||
This integration has been tested on a Raspberry Pi 4B, but it should work on any device which is supported by [CircuitPython](https://circuitpython.org/).
|
||||
|
||||
@ -4,6 +4,7 @@ description: Instructions on how to setup your BMW Connected Drive account with
|
||||
ha_category:
|
||||
- Car
|
||||
- Binary Sensor
|
||||
- Button
|
||||
- Presence Detection
|
||||
- Lock
|
||||
- Sensor
|
||||
@ -17,6 +18,7 @@ ha_codeowners:
|
||||
ha_domain: bmw_connected_drive
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- device_tracker
|
||||
- lock
|
||||
- notify
|
||||
@ -37,10 +39,10 @@ This integration provides the following platforms:
|
||||
|
||||
- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
|
||||
- Device tracker: The location of your car.
|
||||
- Lock: Control the lock of your car.
|
||||
- [Lock](/integrations/bmw_connected_drive/#lock): Control the lock of your car.
|
||||
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
|
||||
- Notifications: Send Points of Interest (POI) to your car.
|
||||
- Services: Turn on air condition, sound the horn, flash the lights, update the vehicle location and update the state. More details can be found [here](/integrations/bmw_connected_drive/#services).
|
||||
- [Notifications](/integrations/bmw_connected_drive/#notifications): Send Points of Interest (POI) to your car.
|
||||
- [Buttons](/integrations/bmw_connected_drive/#buttons): Turn on air condition, sound the horn, flash the lights, update the vehicle location and update the state.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -98,11 +100,7 @@ bmw_connected_drive:
|
||||
The `bmw_connected_drive` integration offers a notification service. Using this service you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination.
|
||||
The name of the service is `notify.bmw_connected_drive_<your_vehicle>`.
|
||||
|
||||
### Examples
|
||||
|
||||
A few examples on how to use the notification service.
|
||||
|
||||
#### Send a Point of Interest to your vehicle
|
||||
### Send a Point of Interest to your vehicle
|
||||
|
||||
```yaml
|
||||
...
|
||||
@ -120,39 +118,37 @@ action:
|
||||
country: Country # Optional
|
||||
```
|
||||
|
||||
## Services
|
||||
## Lock
|
||||
|
||||
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all entities, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
|
||||
The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking, make sure it's safe to lock/unlock the vehicle in the current situation.
|
||||
|
||||
Using these services will impact the state of your vehicle. So use these services with care!
|
||||
## Buttons
|
||||
|
||||
### Locking and unlocking
|
||||
The `bmw_connected_drive` integration offers several buttons to trigger actions in your car. The buttons are automatically created and can be pressed/executed from the UI or using the `button.press` service. Please see the [button documentation](/integrations/button/) for more information.
|
||||
|
||||
The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation.
|
||||
Using these buttons will impact the state of your vehicle. So use these services with care!
|
||||
|
||||
### Air condition
|
||||
|
||||
The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`.
|
||||
The air condition of the vehicle can be activated with the `button.<your_vehicle>_activate_air_conditioning` button.
|
||||
|
||||
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
|
||||
|
||||
Some newer cars also support stopping an active air conditioning with the service `bmw_connected_drive.deactivate_air_conditioning`.
|
||||
Some newer cars also support stopping an active air conditioning with the `button.<your_vehicle>_deactivate_air_conditioning` button.
|
||||
|
||||
This will only work if you have the option to stop the AC in the *MyBMW* app. If your car doesn't support this service, nothing will happen.
|
||||
|
||||
The vehicle is identified via the parameter `vin`.
|
||||
|
||||
### Sound the horn
|
||||
|
||||
The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`.
|
||||
The `button.<your_vehicle>_sound_horn` button sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors.
|
||||
|
||||
### Flash the lights
|
||||
|
||||
The service `bmw_connected_drive.light_flash` flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`.
|
||||
The `button.<your_vehicle>_light_flash` button flashes the lights of the vehicle.
|
||||
|
||||
### Vehicle finder
|
||||
|
||||
The service `bmw_connected_drive.find_vehicle` requests the vehicle to update the GPS location. This can be used for older vehicles which don't automatically send the updated GPS location. The vehicle is identified via the parameter `vin`.
|
||||
The `button.<your_vehicle>_find_vehicle` button requests the vehicle to update the GPS location. This can be used for older vehicles which don't automatically send the updated GPS location.
|
||||
|
||||
<div class="note warning">
|
||||
|
||||
@ -167,11 +163,9 @@ The service `bmw_connected_drive.find_vehicle` requests the vehicle to update th
|
||||
|
||||
</div>
|
||||
|
||||
### Update the state
|
||||
### Update the state / refresh from API
|
||||
|
||||
The service `bmw_connected_drive.update_state` fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
|
||||
|
||||
This service does not require any attributes.
|
||||
The `button.<vehicle_model>_refresh_from_api` button fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Bond
|
||||
description: Instructions on setting up Bond Bridge within Home Assistant.
|
||||
ha_category:
|
||||
- Button
|
||||
- Hub
|
||||
- Cover
|
||||
- Fan
|
||||
@ -18,6 +19,7 @@ ha_config_flow: true
|
||||
ha_quality_scale: platinum
|
||||
ha_zeroconf: true
|
||||
ha_platforms:
|
||||
- button
|
||||
- cover
|
||||
- fan
|
||||
- light
|
||||
@ -58,31 +60,6 @@ upgrade your firmware from Bond app before adding this integration.
|
||||
Firmware version 2.10.8 or newer is required for push updates. The integration
|
||||
will fallback to polling for 2.10.x versions lower than .8
|
||||
|
||||
### Service `bond.start_increasing_brightness`
|
||||
|
||||
Start increasing the light brightness.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of strings of `entity_id`s.
|
||||
|
||||
### Service `bond.start_decreasing_brightness`
|
||||
|
||||
Start decreasing the light brightness.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of strings of `entity_id`s.
|
||||
|
||||
### Service `bond.stop`
|
||||
|
||||
Stop any in-progress action and empty the queue. Calling this service will
|
||||
stop any increase or decrease in brightness that is in progress.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of strings of `entity_id`s.
|
||||
|
||||
### Service `bond.set_fan_speed_tracked_state`
|
||||
|
||||
Sets the tracked fan speed for a bond fan.
|
||||
|
||||
@ -12,6 +12,7 @@ ha_domain: brother
|
||||
ha_quality_scale: platinum
|
||||
ha_zeroconf: true
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
|
||||
@ -56,6 +56,10 @@ availability_topic:
|
||||
description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
|
||||
required: false
|
||||
type: string
|
||||
command_template:
|
||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `command_topic`.
|
||||
required: false
|
||||
type: template
|
||||
command_topic:
|
||||
description: The MQTT topic to publish commands to trigger the button.
|
||||
required: false
|
||||
@ -111,6 +115,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the published messages.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -145,6 +145,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -7,6 +7,7 @@ ha_release: 0.87
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_domain: co2signal
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
@ -8,6 +8,7 @@ ha_release: 0.61
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_domain: coinbase
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
ha_codeowners:
|
||||
- '@tombrien'
|
||||
|
||||
@ -72,6 +72,10 @@ command_timeout:
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this binary sensor. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Execution
|
||||
|
||||
@ -67,6 +67,10 @@ covers:
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this cover. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Examples
|
||||
|
||||
@ -127,6 +127,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -8,12 +8,15 @@ ha_release: pre 0.7
|
||||
ha_iot_class: Local Push
|
||||
ha_codeowners:
|
||||
- '@fabaff'
|
||||
- '@frenck'
|
||||
ha_domain: cpuspeed
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
The `cpuspeed` sensor platform to allow you to monitor the current CPU speed.
|
||||
The CPU Speed integration allows you to monitor the current CPU speed.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
@ -21,20 +24,4 @@ The `cpuspeed` sensor platform to allow you to monitor the current CPU speed.
|
||||
|
||||
</div>
|
||||
|
||||
## Configuration
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: cpuspeed
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: CPU speed
|
||||
{% endconfiguration %}
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -99,23 +99,25 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom
|
||||
- Inside temperature
|
||||
- Outside temperature
|
||||
- Inside humidity
|
||||
- Total instant power consumption
|
||||
- Estimated power consumption
|
||||
- Hourly energy consumption in cool mode
|
||||
- Hourly energy consumption in heat mode
|
||||
- Outside compressor frequency
|
||||
- Outside unit's compressor frequency
|
||||
- Today's total energy consumption (resets at 00:00)
|
||||
|
||||
<div class='note'>
|
||||
|
||||
- Some models only report outside temperature when they are turned on.
|
||||
- Some models does not have humidity sensor.
|
||||
- Some models does not report the power/energy consumption.
|
||||
- Some models does not report the compressor frequency.
|
||||
- Some models do not have humidity sensor.
|
||||
- Some models do not report the power/energy consumption.
|
||||
- Some models do not report the compressor frequency.
|
||||
|
||||
</div>
|
||||
|
||||
<div class='note'>
|
||||
|
||||
- The 'total' power sensor is updated every time 100 Wh are consumed by all the AC summed together.
|
||||
- The 'Today's total energy consumption' and 'Estimated power consumption' sensor is updated every time 100 Wh are consumed by all different operating modes summed together.
|
||||
- The 'Estimated power consumption' sensor is derived from the energy consumption and not provided by the AC directly.
|
||||
- The 'cool/heat' energy sensors are updated hourly with the previous hour energy consumption
|
||||
of a given mode and a given AC.
|
||||
- The 'cool' mode also includes the 'fan' and 'dehumidifier' modes' power consumption.
|
||||
|
||||
@ -24,6 +24,7 @@ ha_ssdp: true
|
||||
ha_platforms:
|
||||
- alarm_control_panel
|
||||
- binary_sensor
|
||||
- diagnostics
|
||||
- climate
|
||||
- cover
|
||||
- fan
|
||||
|
||||
@ -7,6 +7,7 @@ ha_category:
|
||||
- Cover
|
||||
- Light
|
||||
- Sensor
|
||||
- Siren
|
||||
- Switch
|
||||
ha_release: '0.110'
|
||||
ha_iot_class: Local Push
|
||||
@ -22,6 +23,7 @@ ha_platforms:
|
||||
- cover
|
||||
- light
|
||||
- sensor
|
||||
- siren
|
||||
- switch
|
||||
ha_zeroconf: true
|
||||
---
|
||||
@ -91,3 +93,9 @@ The integration provides support for the following features:
|
||||
- Temperature and brightness of devolo Sensors, that support it
|
||||
- Consumptions of devolo and Qubino devices, that support it
|
||||
- Voltage of devolo Metering Plug v2
|
||||
|
||||
## Siren
|
||||
|
||||
The integration provides support for the following Z-Wave devices:
|
||||
|
||||
- devolo Siren
|
||||
|
||||
@ -13,6 +13,14 @@ ha_codeowners:
|
||||
- '@thegardenmonkey'
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22 or AM2302 device.
|
||||
|
||||
## Setup
|
||||
|
||||
@ -4,72 +4,25 @@ description: Instructions on how to integrate a DNS IP sensor into Home Assistan
|
||||
ha_category:
|
||||
- Network
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_release: '0.40'
|
||||
ha_domain: dnsip
|
||||
ha_platforms:
|
||||
- sensor
|
||||
ha_codeowners:
|
||||
- '@gjohansson-ST'
|
||||
---
|
||||
|
||||
The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its value. There are two operational modes:
|
||||
The DNS IP integration will expose an IP address, fetched via DNS resolution, as its value. It provides both IPv4 and IPv6 lookup as separate sensors depending on accessibility to resolvers.
|
||||
|
||||
1. When you enable the sensor with minimal configuration, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
|
||||
1. When you enable the integration with the default value, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
|
||||
2. If you specify a `hostname`, a regular DNS lookup will be performed, providing you the IP the hostname resolves to.
|
||||
|
||||
You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like.
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Configuration
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: dnsip
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
hostname:
|
||||
description: The hostname for which to perform the DNS query.
|
||||
required: false
|
||||
default: "`myip.opendns.com` (special hostname that resolves to your public IP)"
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: false
|
||||
default: "`myip` or hostname without dots if specified"
|
||||
type: string
|
||||
resolver:
|
||||
description: The DNS server to target the query at.
|
||||
required: false
|
||||
default: "`208.67.222.222` (OpenDNS)"
|
||||
type: string
|
||||
ipv6:
|
||||
description: Set this to `true` or `false` if IPv6 should be used. When resolving the public IP, this will be the IP of the machine where Home Assistant is running on.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
resolver_ipv6:
|
||||
description: The IPv6 DNS server to target the query at.
|
||||
required: false
|
||||
default: "`2620:0:ccc::2` (OpenDNS)"
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Defines number of seconds for polling interval.
|
||||
required: false
|
||||
default: "`120`"
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
## Extended example
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
# Own public IPv4 address
|
||||
- platform: dnsip
|
||||
# Resolve IP address of home-assistant.io via Google DNS
|
||||
- platform: dnsip
|
||||
hostname: home-assistant.io
|
||||
name: hass
|
||||
resolver: 8.8.8.8
|
||||
```
|
||||
{% configuration_basic %}
|
||||
Resolver:
|
||||
description: "You may override the default nameservers that are being used by setting any nameserver you like."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
@ -2,20 +2,21 @@
|
||||
title: DoorBird
|
||||
description: Instructions on how to integrate your DoorBird video doorbell with Home Assistant.
|
||||
ha_category:
|
||||
- Doorbell
|
||||
- Button
|
||||
- Camera
|
||||
- Switch
|
||||
- Doorbell
|
||||
ha_release: 0.54
|
||||
ha_iot_class: Local Push
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@oblogic7'
|
||||
- '@bdraco'
|
||||
- '@flacjacket'
|
||||
ha_domain: doorbird
|
||||
ha_zeroconf: true
|
||||
ha_platforms:
|
||||
- camera
|
||||
- switch
|
||||
- button
|
||||
---
|
||||
|
||||
The `doorbird` implementation allows you to integrate your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
|
||||
@ -23,7 +24,7 @@ The `doorbird` implementation allows you to integrate your [DoorBird](https://ww
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Camera](#camera) - View live and historical event based images.
|
||||
- [Switch](#switch) - Enable control of relays and camera night vision.
|
||||
- [Button](#button) - Enable control of relays and camera night vision.
|
||||
|
||||
## Setup
|
||||
|
||||
@ -112,6 +113,6 @@ Note: Remember to complete the schedule assignment steps above for each event ty
|
||||
The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
|
||||
|
||||
|
||||
## Switch
|
||||
## Button
|
||||
|
||||
The `doorbird` switch platform allows you to power connected relays and trigger the IR array in your [DoorBird](https://www.doorbird.com/) video doorbell device.
|
||||
The `doorbird` button platform allows you to power connected relays and trigger the IR array in your [DoorBird](https://www.doorbird.com/) video doorbell device.
|
||||
|
||||
@ -17,7 +17,7 @@ ha_platforms:
|
||||
|
||||
A sensor platform for Belgian, Dutch, Luxembourg and Swedish Smart Meters which comply to DSMR (Dutch Smart Meter Requirements), also known as 'Slimme meter' or 'P1 poort'. Swedish meters with a 'HAN port' are not supported by this integration.
|
||||
|
||||
- Currently support DSMR V2.2, V3, V4, V5, Belgian V5 variant, Luxembourg V5 variant (Smarty) and the Swedish V5 variant through the [dsmr_parser](https://github.com/ndokter/dsmr_parser) module by Nigel Dokter.
|
||||
- Currently support DSMR V2.2, V3, V4, V5, Belgian V5 variant, Luxembourg V5 variant (Smarty), Swedish V5 variant and the EasyMeter Q3D (Germany) through the [dsmr_parser](https://github.com/ndokter/dsmr_parser) module by Nigel Dokter.
|
||||
- For official information about DSMR refer to: [DSMR Document](https://www.netbeheernederland.nl/dossiers/slimme-meter-15)
|
||||
- For official information about the P1 port refer to: [P1 Companion Standard](https://www.netbeheernederland.nl/_upload/Files/Slimme_meter_15_a727fce1f1.pdf)
|
||||
- For unofficial hardware connection examples refer to: [Domoticx](http://domoticx.com/p1-poort-slimme-meter-hardware/)
|
||||
@ -33,6 +33,7 @@ A sensor platform for Belgian, Dutch, Luxembourg and Swedish Smart Meters which
|
||||
- For Dutch meters, choose DSMR version `2.2`, `4`, or `5`
|
||||
- For Luxembourg meters, choose DSMR version `5L`
|
||||
- For Swedish meters, choose DSMR version `5S`
|
||||
- For EasyMeter Q3D, choose DSMR version `Q3D`
|
||||
|
||||
### Options
|
||||
|
||||
@ -59,6 +60,7 @@ This integration is known to work for:
|
||||
- Sagemcom XS210 ESMR5
|
||||
- Sagemcom T211
|
||||
- Ziv E0058 ESMR5
|
||||
- EasyMeter Q3D
|
||||
|
||||
### Connecting to the meter
|
||||
|
||||
@ -80,6 +82,7 @@ $ docker run --device /dev/ttyUSB0:/dev/ttyUSB0 -d --name="home-assistant" -v /h
|
||||
#### Serial to network proxies:
|
||||
|
||||
- [ser2net](http://ser2net.sourceforge.net)
|
||||
- [WIZnet WIZ110SR](https://www.wiznet.io/product-item/wiz110sr/)
|
||||
|
||||
DIY solutions (ESP8266 based):
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate DSMR Reader.
|
||||
ha_category:
|
||||
- Energy
|
||||
- Sensor
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.103
|
||||
ha_codeowners:
|
||||
- '@depl0y'
|
||||
|
||||
@ -22,6 +22,8 @@ ha_platforms:
|
||||
- notify
|
||||
- sensor
|
||||
- weather
|
||||
ha_zeroconf: true
|
||||
ha_homekit: true
|
||||
---
|
||||
|
||||
The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
title: EE Bright Box
|
||||
description: Instructions on how to integrate EE Bright Box router into Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.87
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: ee_brightbox
|
||||
ha_platforms:
|
||||
- device_tracker
|
||||
---
|
||||
|
||||
This platform offers presence detection by looking at connected devices to a [EE Bright Box 2](https://ee.co.uk/help/phones-and-device/home-broadband/bright-box-2-wireless-router/bright-box-2-wireless-router) router.
|
||||
|
||||
## Configuration
|
||||
|
||||
To use a EE Bright Box router in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: ee_brightbox
|
||||
password: router-admin-password
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of your router
|
||||
default: 192.168.1.1
|
||||
required: false
|
||||
type: string
|
||||
username:
|
||||
description: Found at the back of the router in 'Router login details' section
|
||||
default: admin
|
||||
required: false
|
||||
type: string
|
||||
password:
|
||||
description: Found at the back of the router in 'Router login details' section
|
||||
required: true
|
||||
type: string
|
||||
version:
|
||||
description: Currently only version 2 of the router is supported
|
||||
default: 2
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [device tracker integration page](/integrations/device_tracker/) for instructions on how to configure the people to be tracked.
|
||||
@ -13,6 +13,7 @@ ha_domain: elgato
|
||||
ha_zeroconf: true
|
||||
ha_platforms:
|
||||
- button
|
||||
- diagnostics
|
||||
- light
|
||||
---
|
||||
|
||||
|
||||
23
source/_integrations/elmax.markdown
Normal file
23
source/_integrations/elmax.markdown
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Elmax
|
||||
description: Instructions on how to integrate Elmax panels within Home Assistant.
|
||||
ha_category:
|
||||
- Switch
|
||||
ha_release: 2022.2
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@albertogeniola'
|
||||
ha_domain: elmax
|
||||
ha_platforms:
|
||||
- switch
|
||||
---
|
||||
|
||||
The Elmax integration enables Home Assistant integration with
|
||||
[ELMAX](https://www.elmaxsrl.it/) control panels. Elmax panels are
|
||||
domotic systems focused on intrusion detection and home surveillance.
|
||||
|
||||
The current integration is capable of controlling domotic switches
|
||||
and actuators connected to the Elmax panels.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `envirophat` sensor platform allows you to display information collected by an [Enviro pHAT](https://shop.pimoroni.com/products/enviro-phat) add-on board for the Raspberry Pi. The board features a wide range of sensors, such as:
|
||||
|
||||
- BMP280 temperature/pressure sensor
|
||||
|
||||
@ -5,6 +5,7 @@ ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 0.23
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: envisalink
|
||||
@ -12,6 +13,7 @@ ha_platforms:
|
||||
- alarm_control_panel
|
||||
- binary_sensor
|
||||
- sensor
|
||||
- switch
|
||||
---
|
||||
|
||||
The `envisalink` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this integration is built. Currently, the Envisalink version 4 is the latest model. This integration supports both the evl3 and the evl4.
|
||||
@ -23,6 +25,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- Binary Sensor: Reports on zone status (Check the [type/class](/integrations/binary_sensor/#device-class) list for a possible visualization of your zone.)
|
||||
- Sensor: Emulates an alphanumeric keypad attached to the alarm panel
|
||||
- Alarm Control Panel: Reports on partition status, and can be used to arm/disarm the system
|
||||
- Switch: Bypass individual zones. Bypass switches are only available on DSC alarm panels due to limitations in the Honeywell interface.
|
||||
|
||||
This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ ha_platforms:
|
||||
- binary_sensor
|
||||
- camera
|
||||
- button
|
||||
- diagnostics
|
||||
- climate
|
||||
- cover
|
||||
- fan
|
||||
|
||||
@ -10,6 +10,7 @@ ha_codeowners:
|
||||
- '@balloob'
|
||||
ha_domain: evil_genius_labs
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- light
|
||||
---
|
||||
|
||||
|
||||
@ -118,6 +118,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -10,6 +10,7 @@ ha_codeowners:
|
||||
ha_domain: flunearyou
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
|
||||
@ -1,24 +1,34 @@
|
||||
---
|
||||
title: Flux LED/MagicHome
|
||||
description: Instructions on how to setup Flux led/MagicHome/MagicLight within Home Assistant.
|
||||
title: Magic Home
|
||||
description: Instructions on how to setup Magic Home within Home Assistant.
|
||||
ha_category:
|
||||
- Button
|
||||
- Light
|
||||
- Number
|
||||
- Select
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.25
|
||||
ha_domain: flux_led
|
||||
ha_platforms:
|
||||
- button
|
||||
- light
|
||||
- number
|
||||
- sensor
|
||||
- select
|
||||
- switch
|
||||
ha_codeowners:
|
||||
- '@icemanch'
|
||||
- '@bdraco'
|
||||
ha_quality_scale: platinum
|
||||
ha_config_flow: true
|
||||
ha_dhcp: true
|
||||
---
|
||||
|
||||
The Magic Home (aka Flux LED) integration supports several brands of smart sockets, LED bulbs, and LED controllers that use the same protocol over WiFi. If you can control your device with the MagicHome app, and it is listed as supported below, this integration can control the device.
|
||||
The Magic Home integration supports several brands of switches, bulbs, and controllers that use the same protocol. Chances are high that your bulb or controller (eg. WiFi LED CONTROLLER) will work with this integration if you can control the device with the Magic Home app.
|
||||
|
||||
This integration will provide local control over your LED lights/strips and can be configured to auto-scan your network for controllers or for you to manually configure individual lights by their IP address.
|
||||
|
||||
Example of bulbs:
|
||||
|
||||
@ -43,18 +53,83 @@ Examples of addressable controllers:
|
||||
- [Addressable v3](https://www.amazon.com/gp/product/B09BMBSCRF/)
|
||||
|
||||
Examples of addressable controllers with strip:
|
||||
|
||||
- [Addressable v1](https://www.amazon.com/gp/product/B07RLF7C86/)
|
||||
- [Addressable v2](https://www.amazon.com/gp/product/B07B7CQ2ZB/)
|
||||
|
||||
Examples of sockets:
|
||||
|
||||
- [MagicLight Smart Plugs](https://www.magiclightbulbs.com/smart-plugs) or [Amazon](https://www.amazon.com/gp/product/B07XNBVVXV/)
|
||||
|
||||
These devices have been sold under at least the following brands:
|
||||
|
||||
- Aislan
|
||||
- [Allkeys](http://allkeystech.com/)
|
||||
- Apobob
|
||||
- [Arilux](https://www.ariluxworldwide.com/)
|
||||
- Aubric
|
||||
- BERENNIS
|
||||
- BHGY
|
||||
- [Brizled](https://www.brizled.com/)
|
||||
- Bunpeon
|
||||
- [Chichin](https://chichinlighting.com/)
|
||||
- Comoyda
|
||||
- dalattin
|
||||
- [DALS RGBW / Armacost Lighting / MyLED](https://www.armacostlighting.com/)
|
||||
- DARKPROOF
|
||||
- [Daybetter](https://www.daybetter.com/)
|
||||
- deerdance
|
||||
- DIAMOND
|
||||
- [Diode Dynamics](https://www.diodedynamics.com/)
|
||||
- [Flux LED](https://www.fluxsmartlighting.com/)
|
||||
- [FVTLED](https://fvtled.com/)
|
||||
- [GEV LIG](https://www.gev.de/)
|
||||
- GEYUEYA Home
|
||||
- GIDEALED
|
||||
- [GIDERWEL](https://giderwel.com/)
|
||||
- GMK
|
||||
- Goldwin
|
||||
- Hakkatronics
|
||||
- [HaoDeng](http://www.zengge.com/appkzd)
|
||||
- [Heissner](https://www.heissner.de/)
|
||||
- HDDFL
|
||||
- [illume RGBW](https://dals.com/illume/)
|
||||
- [Illumination FX](https://www.illumination-fx.com/)
|
||||
- INDARUN
|
||||
- iNextStation
|
||||
- [Koopower](https://www.koopower.com/)
|
||||
- [Lallumer](https://www.lapuretes.cn/)
|
||||
- LEDENET
|
||||
- [LiteWRX](https://litewrx.com/)
|
||||
- Lytworx
|
||||
- Magic Ambient
|
||||
- [Magic Home](http://www.zengge.com/appkzd)
|
||||
- [Magic Hue](http://www.magichue.com/)
|
||||
- [Magic Light](https://www.magiclightbulbs.com/)
|
||||
- Miheal
|
||||
- Mowelai
|
||||
- Nexlux
|
||||
- OBSESS
|
||||
- [Offdarks](http://offdarks.net)
|
||||
- PH LED
|
||||
- PHOPOLLO
|
||||
- [Pin Stadium Pinball Lights](https://pinstadium.com/)
|
||||
- POV Lamp
|
||||
- [PROTEAM Europe Pool Lights](https://proteam-me.com/)
|
||||
- [Rimikon](https://www.rimikon.com/)
|
||||
- SMFX
|
||||
- [Sumaote](https://fvtled.com/)
|
||||
- [Superhome](https://superhome.com.cy/)
|
||||
- [SuperlightingLED](https://www.superlightingled.com/)
|
||||
- Svipear
|
||||
- Tommox
|
||||
- Vanance
|
||||
- Yetaida
|
||||
- YHW
|
||||
- [Zengge](http://www.zengge.com/sy)
|
||||
- Zombber
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
After the devices have been added they can be configured with different effects listed below. These settings can be accessed by navigating to the integration settings in Configuration -> Integrations and selecting the "Flux Led/Magic Home" configuration for the bulb or controller. Devices listed as unsupported below are likely to work, however, they have not been tested by the integration's developers.
|
||||
|
||||
After the devices have been added they can be configured with different effects listed below. These settings can be accessed by navigating to the integration settings in Configuration -> Integrations and selecting the "Magic Home" configuration for the bulb or controller.
|
||||
|
||||
**Custom Effect**\
|
||||
A list of RGB colors can be entered to create an effect. The effect speed can be adjusted using the slider underneath.
|
||||
@ -131,7 +206,7 @@ If a strip controller device will not stay on wifi or goes offline during adjust
|
||||
|
||||
### Effects
|
||||
|
||||
The Flux LED light offers a number of effects which are not included in other lighting packages. These can be selected from the front-end, or sent in the effect field of the `light.turn_on` command.
|
||||
The Magic Home light offers a number of effects which are not included in other lighting packages. These can be selected from the front-end, or sent in the effect field of the `light.turn_on` command.
|
||||
|
||||
| Effect Name | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
|
||||
@ -167,3 +242,60 @@ colors:
|
||||
speed_pct: 80
|
||||
transition: "jump"
|
||||
```
|
||||
|
||||
### Set Zones - Service `flux_led.set_zones`
|
||||
|
||||
The Addressable v3 (0xA3) models allow setting a color effect per zone. The length of each zone is the number of pixels per segment divided by the number of colors. If the device is turned off, setting the zones will not turn it on. A separate call to `light.turn_on` is needed to turn on the device.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| ---------------------- | ----------- |
|
||||
| `entity_id` | The entity_id of the LED light to set the effect on. |
|
||||
| `colors` | List of colors for each zone (RGB). (Max 2048 Colors) |
|
||||
| `speed_pct` | The speed of the effect in % (0-100. Default 50) |
|
||||
| `effect` | The effect you would like. Valid options are `static`, `running_water`, `strobe`, `jump`, or `breathing`. (Default `static`) |
|
||||
|
||||
```yaml
|
||||
#Example Service Call
|
||||
service: flux_led.set_zones
|
||||
target:
|
||||
entity_id:
|
||||
- light.addressable_v3_8e2f7f
|
||||
- light.addressable_v3_8ebdeb
|
||||
data:
|
||||
colors:
|
||||
- [255, 0, 0]
|
||||
- [0, 255, 0]
|
||||
- [0, 0, 255]
|
||||
- [255, 255, 255]
|
||||
speed_pct: 80
|
||||
```
|
||||
|
||||
### Set Music Mode - Service `flux_led.set_music_mode`
|
||||
|
||||
The RGB with MIC (0x08), Addressable v2 (0xA2), and Addressable v3 (0xA3) models have a built-in microphone that have multiple music mode settings.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| ---------------------- | ----------- |
|
||||
| `entity_id` | The entity_id of the LED light to set the effect on. |
|
||||
| `sensitivity` | Microphone sensitivity (0-100) |
|
||||
| `brightness` | Light brightness (0-100) |
|
||||
| `light_screen` | Light screen mode for 2 dimensional pixels (Addressable models only) |
|
||||
| `effect` | Effect (1-16 on Addressable models, 0-3 on RGB with MIC models)|
|
||||
| `foreground_color` | The foreground RGB color |
|
||||
| `background_color` | The background RGB color (Addressable models only) |
|
||||
|
||||
```yaml
|
||||
#Example Service Call
|
||||
service: flux_led.set_music_mode
|
||||
target:
|
||||
entity_id:
|
||||
- light.addressable_v3_8e2f7f
|
||||
- light.addressable_v3_8ebdeb
|
||||
data:
|
||||
sensitivity: 100
|
||||
brightness: 100
|
||||
effect: 2
|
||||
light_screen: false
|
||||
background_color: [0, 255, 0]
|
||||
foreground_color: [255, 0, 0]
|
||||
```
|
||||
|
||||
@ -3,26 +3,30 @@ title: FortiOS
|
||||
description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.97
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
- '@kimfrellsen'
|
||||
ha_release: 0.97
|
||||
ha_domain: fortios
|
||||
ha_platforms:
|
||||
- device_tracker
|
||||
ha_codeowners:
|
||||
- '@kimfrellsen'
|
||||
---
|
||||
|
||||
This integration enables Home Assistant to do device tracking of devices with a MAC address connected to a FortiGate from [Fortinet](https://www.fortinet.com).
|
||||
The FortiOS presence detection enables Home Assistant to track devices with a MAC address connected to a FortiGate from [Fortinet](https://www.fortinet.com).
|
||||
|
||||
The integration relies on the [fortiosapi](https://pypi.org/project/fortiosapi/).
|
||||
The integration has been tested both on FortiGate appliance and FortiGate VM running SW FortiOS v. 6.0.x and 6.2.0.
|
||||
The integration relies on the [fortiosapi](https://pypi.org/project/fortiosapi/). It has been verified on FortiGate appliances and FortiGate VM running FortiOS v. 6.4.x (up to 6.4.8) and 7.0.x (up to 7.0.4).
|
||||
The minimum version supported is FortiOS 6.4.3.
|
||||
|
||||
All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and Wi-Fi devices, including devices detected by LLDP.
|
||||
|
||||
The integration is based on the Home Assistant `device_tracker` platform.
|
||||
|
||||
### Example Configuration:
|
||||
|
||||
This example uses the FortiOS integration as a device tracker, with an API token and does not verify the SSL certificate.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yaml
|
||||
device_tracker:
|
||||
- platform: fortios
|
||||
host: YOUR_HOST
|
||||
@ -31,11 +35,11 @@ device_tracker:
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: Hostname or IP address of the FortiGate.
|
||||
description: Hostname or IP address of the FortiGate. Optionally port name can be added like this "10.10.10.10:443". Remember quotes if port number is added.
|
||||
required: true
|
||||
type: string
|
||||
token:
|
||||
description: "See: [Generate an API token for FortiOS](https://registry.terraform.io/providers/fortinetdev/fortios/latest/docs/guides/fgt_token) for how to create an API token. Remember this integration only needs read access to a FortiGate, so configure the API user to only to have limited and read-only access."
|
||||
description: "See: [Generate an API token for FortiOS](https://docs.fortinet.com/document/forticonverter/6.2.0/online-help/866905/connect-fortigate-device-via-api-token) for how to create an API token. This integration only needs read access to a FortiGate, so configure the API user to only to have limited and read-only access."
|
||||
required: true
|
||||
type: string
|
||||
verify_ssl:
|
||||
|
||||
@ -12,9 +12,12 @@ ha_codeowners:
|
||||
- '@mammuth'
|
||||
- '@AaronDavidSchneider'
|
||||
- '@chemelli74'
|
||||
- '@mib1185'
|
||||
ha_iot_class: Local Polling
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- diagnostics
|
||||
- device_tracker
|
||||
- sensor
|
||||
- switch
|
||||
@ -27,6 +30,7 @@ There is support for the following platform types within Home Assistant:
|
||||
|
||||
- **Device tracker** - presence detection by looking at connected devices.
|
||||
- **Binary sensor** - connectivity status.
|
||||
- **Button** - reboot, reconnect, firmware_update.
|
||||
- **Sensor** - external IP address, uptime and network monitors.
|
||||
- **Switch** - call deflection, port forward, parental control and Wi-Fi networks.
|
||||
|
||||
@ -44,29 +48,10 @@ The configuration in the UI asks for a username. Starting from FRITZ!OS 7.24 the
|
||||
|
||||
Currently supported services are Platform specific:
|
||||
|
||||
- `fritz.reconnect`
|
||||
- `fritz.reboot`
|
||||
- `fritz.cleanup`
|
||||
|
||||
### Platform Services
|
||||
|
||||
#### Service `fritz.reboot`
|
||||
|
||||
Reboot the router.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `device_id` | no | Only act on a specific router |
|
||||
|
||||
#### Service `fritz.reconnect`
|
||||
|
||||
Disconnect and reconnect the router to the Internet.
|
||||
If you have a dynamic IP address, most likely it will change.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `device_id` | no | Only act on a specific router |
|
||||
|
||||
#### Service `fritz.cleanup`
|
||||
|
||||
Remove all stale devices from Home Assistant.
|
||||
@ -112,11 +97,11 @@ The following script can be used to easily add a reconnect button to your UI. If
|
||||
|
||||
```yaml
|
||||
fritz_box_reconnect:
|
||||
alias: "Reconnect FRITZ!Box"
|
||||
alias: "Reboot FRITZ!Box"
|
||||
sequence:
|
||||
- service: fritz.reconnect
|
||||
- service: button.press
|
||||
target:
|
||||
entity_id: binary_sensor.fritzbox_7530_connection
|
||||
entity_id: button.fritzbox_7530_reboot
|
||||
|
||||
```
|
||||
|
||||
@ -124,14 +109,14 @@ fritz_box_reconnect:
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: "System - Reconnect FRITZ!Box"
|
||||
- alias: "Reconnect FRITZ!Box"
|
||||
trigger:
|
||||
- platform: time
|
||||
at: "05:00:00"
|
||||
action:
|
||||
- service: fritz.reconnect
|
||||
- service: button.press
|
||||
target:
|
||||
entity_id: binary_sensor.fritzbox_7530_connection
|
||||
entity_id: button.fritzbox_7530_reconnect
|
||||
|
||||
```
|
||||
|
||||
|
||||
@ -14,6 +14,7 @@ ha_config_flow: true
|
||||
ha_ssdp: true
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- diagnostics
|
||||
- climate
|
||||
- light
|
||||
- sensor
|
||||
|
||||
@ -28,11 +28,11 @@ camera:
|
||||
|
||||
{% configuration %}
|
||||
still_image_url:
|
||||
description: "The URL your camera serves the image on, e.g., `http://192.168.1.21:2112/`. Can be a [template](/topics/templating/)."
|
||||
required: true
|
||||
description: "The URL your camera serves the image on, e.g., `http://192.168.1.21:2112/`. Can be a [template](/topics/templating/). At least one of still_image_url or stream_source must be provided."
|
||||
required: false
|
||||
type: string
|
||||
stream_source:
|
||||
description: "The URL your camera serves the live stream on, e.g., `rtsp://192.168.1.21:554/`. Can be a [template](/topics/templating/)."
|
||||
description: "The URL your camera serves the live stream on, e.g., `rtsp://user:pass@192.168.1.21:554/`. Can be a [template](/topics/templating/). Usernames and passwords must be embedded in the URL. At least one of still_image_url or stream_source must be provided."
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
@ -40,11 +40,11 @@ name:
|
||||
required: false
|
||||
type: string
|
||||
username:
|
||||
description: The username for accessing your camera.
|
||||
description: The username for accessing your camera. Note that this username applies only to still_image_url and not to stream_source.
|
||||
required: false
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your camera.
|
||||
description: The password for accessing your camera. Note that this password applies only to still_image_url and not to stream_source.
|
||||
required: false
|
||||
type: string
|
||||
authentication:
|
||||
@ -121,6 +121,7 @@ camera:
|
||||
name: Host instance camera feed
|
||||
still_image_url: https://127.0.0.5:8123/api/camera_proxy/camera.live_view
|
||||
```
|
||||
|
||||
### Image from HTTP only camera
|
||||
|
||||
To access a camera which is only available via HTTP, you must turn off SSL verification.
|
||||
@ -142,7 +143,18 @@ camera:
|
||||
- platform: generic
|
||||
name: Streaming Enabled
|
||||
still_image_url: http://194.218.96.92/jpg/image.jpg
|
||||
stream_source: rtsp://194.218.96.92:554
|
||||
username: user
|
||||
password: pass
|
||||
stream_source: rtsp://user:pass@194.218.96.92:554
|
||||
```
|
||||
|
||||
If a camera only has a live stream URL and no snapshot URL, the [stream](/integrations/stream/) component can also generate still images from the live stream URL.
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
- platform: generic
|
||||
name: Streaming
|
||||
stream_source: rtsp://user:pass@194.218.96.92:554
|
||||
```
|
||||
|
||||
### Secured access to the camera
|
||||
|
||||
@ -81,7 +81,23 @@ initial_hvac_mode:
|
||||
required: false
|
||||
type: string
|
||||
away_temp:
|
||||
description: "Set the temperature used by `preset_mode: away`. If this is not specified, the preset mode feature will not be available."
|
||||
description: "Set the temperature used by `preset_mode: away`."
|
||||
required: false
|
||||
type: float
|
||||
comfort_temp:
|
||||
description: "Set the temperature used by `preset_mode: comfort`."
|
||||
required: false
|
||||
type: float
|
||||
home_temp:
|
||||
description: "Set the temperature used by `preset_mode: home`."
|
||||
required: false
|
||||
type: float
|
||||
sleep_temp:
|
||||
description: "Set the temperature used by `preset_mode: sleep`."
|
||||
required: false
|
||||
type: float
|
||||
activity_temp:
|
||||
description: "Set the temperature used by `preset_mode: activity`."
|
||||
required: false
|
||||
type: float
|
||||
precision:
|
||||
|
||||
@ -1,57 +1,40 @@
|
||||
---
|
||||
title: GitHub
|
||||
description: How to integrate the GitHub sensor into Home Assistant.
|
||||
description: Instructions on how to integrate the GitHub integration into Home Assistant.
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_config_flow: true
|
||||
ha_release: 0.88
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_domain: github
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
ha_codeowners:
|
||||
- '@timmo001'
|
||||
- '@ludeeus'
|
||||
---
|
||||
|
||||
The GitHub sensor allows you to monitor your favorite [GitHub](https://github.com/) repositories. Monitored information includes the amount of stargazers, forks, open issues and pull requests, the latest commit message, and more.
|
||||
The GitHub integration allows you to monitor your favorite [GitHub][github] repositories.
|
||||
|
||||
## Setup
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
To set up this sensor you will need a GitHub [personal access token](https://github.com/settings/tokens). You will need to check the `repo` scope for the sensor to function.
|
||||
When you set up this integration, you will first be guided to allow the integration to use the [GitHub API][github_api] on your behalf. If you do not yet have a [GitHub][github] account you will be prompted to create one during the configuration of the integration.
|
||||
|
||||
## Configuration
|
||||
When you have authorized the integration, you select repositories you want to monitor, the list contains repositories you have [starred][github_starred] on GitHub with your account.
|
||||
|
||||
To enable this platform, add the following to your `configuration.yaml` file:
|
||||
Most of the entities provided by this integration are disabled by default, you can enable these by going to the {% my entities title="entities panel" %}.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: github
|
||||
access_token: !secret github_access_token
|
||||
repositories:
|
||||
- path: 'home-assistant/core'
|
||||
```
|
||||
## Remove authorization
|
||||
|
||||
{% configuration %}
|
||||
access_token:
|
||||
description: Your GitHub Access Token
|
||||
required: true
|
||||
type: string
|
||||
url:
|
||||
description: If you are using a GitHub Enterprise server, add its URL here. For example, `https://mygithubserver.com`
|
||||
required: false
|
||||
type: string
|
||||
repositories:
|
||||
description: A list of repository paths and optionally a name
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
path:
|
||||
description: Path to the repository. For Home Assistant this will be `home-assistant/core`
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor. Gives the sensor a custom name in Home Assistant. Defaults to the repository name from GitHub if not specified.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
After you have removed the integration from {% my integrations title="Configuration -> Devices & Services" %}, you need to manually revoke OAuth app authorization.
|
||||
|
||||
1. Go to your [Authorized OAuth Apps][github_apps]
|
||||
2. Find the "Home Assistant GitHub Integration" application
|
||||
3. Click the 3 dots (`...`) to the right of the name
|
||||
4. Select "Revoke"
|
||||
|
||||
[github]: https://github.com/
|
||||
[github_api]: https://docs.github.com/en/rest
|
||||
[github_starred]: https://github.com/stars
|
||||
[github_apps]: https://github.com/settings/applications
|
||||
|
||||
58
source/_integrations/goodwe.markdown
Normal file
58
source/_integrations/goodwe.markdown
Normal file
@ -0,0 +1,58 @@
|
||||
---
|
||||
title: GoodWe Inverter
|
||||
description: Instructions on how to connect your GoodWe Inverter to Home Assistant.
|
||||
ha_category:
|
||||
- Sensor
|
||||
- Energy
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_release: 2022.2
|
||||
ha_codeowners:
|
||||
- '@mletenay'
|
||||
- '@starkillerOG'
|
||||
ha_domain: goodwe
|
||||
ha_platforms:
|
||||
- number
|
||||
- sensor
|
||||
- select
|
||||
---
|
||||
|
||||
The GoodWe integration will poll a [GoodWe](http://www.goodwe.com/) solar inverter over the local network and present its runtime values as sensors in Home Assistant.
|
||||
|
||||
It works with GoodWe ET, EH, BT, BH, ES, EM, DT, MS, D-NS, XS and BP families of inverters. Different inverter families/models expose different sets of sensors, the newer models have usually broader support.
|
||||
|
||||
<div class='note'>
|
||||
If you can't communicate with the inverter despite your model is listed above, it is possible you have an old ARM firmware version. You should ask manufacturer support to upgrade your ARM firmware (not just inverter firmware) to be able to communicate with the inverter via UDP.
|
||||
|
||||
It may work on other inverter families as well, as long as they listen on UDP port 8899 and respond to one of the supported communication protocols. In general, if you can communicate with the inverter via an official mobile application (PvMaster, SolarGo), it is very likely the integration will work too.
|
||||
</div>
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Energy dashboard
|
||||
|
||||
The plugin provides several values suitable for the energy dashboard.
|
||||
The best supported are the inverters of ET/EH families, where the sensors `Meter Total Energy (export)`, `Meter Total Energy (import)`, `Total PV Generation`, `Total Battery Charge` and `Total Battery Discharge` are the most suitable for the dashboard measurements and statistics.
|
||||
|
||||
For the other inverter families, if such sensors are not directly available by the inverter, they can be calculated from existing sensors. [Template Sensor](/integrations/template/) can be used to separate buy and sell power values and [Riemann Sum](/integrations/integration/) can be used to convert these instant power (W) values into cumulative energy values (Wh), which then can be used within the energy dashboard.
|
||||
|
||||
## Inverter polling frequency
|
||||
|
||||
The integration will poll the inverter for new values every 10 seconds. If you wish to receive fresh inverter data less (or more) frequently, you can disable the automatic refresh in the integration's system options (Enable polling for updates) and create your own automation with your desired polling frequency.
|
||||
|
||||
```yaml
|
||||
- alias: "Goodwe inverter data polling"
|
||||
trigger:
|
||||
- platform: time_pattern
|
||||
hours: "*"
|
||||
minutes: "*"
|
||||
seconds: "/30"
|
||||
action:
|
||||
- service: homeassistant.update_entity
|
||||
target:
|
||||
entity_id: sensor.ppv
|
||||
```
|
||||
|
||||
<div class='note'>
|
||||
It has been observed in some rare situations that frequent polling conflicts with updates to the Goodwe SEMS cloud portal and do not receive any updates anymore. Reducing polling frequency to 30 seconds or 1 minute seems to help in such cases.
|
||||
</div>
|
||||
@ -107,6 +107,21 @@ If you want to support active reporting of state to Google's server (configurati
|
||||
3. Click Enable HomeGraph API.
|
||||
3. Try "OK Google, sync my devices" - the Google Home app should import your exposed Home Assistant devices and prompt you to assign them to rooms.
|
||||
|
||||
### Enable Local Fulfillment
|
||||
|
||||
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
|
||||
2. Click `Develop` on the top of the page, then click `Actions` located in the hamburger menu on the top left.
|
||||
3. Upload [this Javascript file](/assets/integrations/google_assistant/app.js) for both Node and Chrome by clicking the `Upload Javascript files` button.
|
||||
4. Add device scan configuration:
|
||||
1. Click `+ New scan config`
|
||||
2. Select `MDNS`
|
||||
3. set mDNS service name to `_home-assistant._tcp.local`
|
||||
5. `Save` your changes.
|
||||
6. Either wait for 30 minutes, or restart your connected Google device.
|
||||
7. Restart Home Assistant Core.
|
||||
|
||||
You can debug the setup by following [these instructions](https://developers.google.com/assistant/smarthome/develop/local#debugging_from_chrome)
|
||||
|
||||
### YAML Configuration
|
||||
|
||||
Now add your setup to your `configuration.yaml` file, such as:
|
||||
|
||||
@ -94,10 +94,10 @@ When entities all have a single on and off state, the group state will
|
||||
be calculated as follows:
|
||||
|
||||
| Domain | on | off |
|
||||
|-------------------|--------|----------|
|
||||
|-------------------|----------|----------|
|
||||
| device_tracker | home | not_home |
|
||||
| cover | open | closed |
|
||||
| lock | locked | unlocked |
|
||||
| lock | unlocked | locked |
|
||||
| person | home | not_home |
|
||||
| media_player | ok | problem |
|
||||
|
||||
|
||||
@ -14,6 +14,7 @@ ha_domain: guardian
|
||||
ha_zeroconf: true
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- diagnostics
|
||||
- sensor
|
||||
- switch
|
||||
ha_dhcp: true
|
||||
|
||||
@ -338,7 +338,7 @@ To add a single entity in accessory mode:
|
||||
|
||||
## Configure Filter
|
||||
|
||||
By default, no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
|
||||
By default, all entities except categorized entities (config, diagnostic, and system entities) are included. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
|
||||
|
||||
```yaml
|
||||
# Example filter to include specified domains and exclude specified entities
|
||||
@ -371,6 +371,8 @@ Filters are applied as follows:
|
||||
- If entity is included, pass (as #2 above)
|
||||
- If entity include and exclude, the entity exclude is ignored
|
||||
|
||||
Categorized entities are not included (config, diagnostic, and system entities) unless they are explicitly matched by `include_entity_globs` or `include_entities` or selected in the UI in include mode.
|
||||
|
||||
## Docker Network Isolation
|
||||
|
||||
The `advertise_ip` option can be used to run this integration even inside an ephemeral Docker container with network isolation enabled, e.g., not using the host network.
|
||||
|
||||
@ -27,6 +27,7 @@ ha_platforms:
|
||||
- binary_sensor
|
||||
- camera
|
||||
- button
|
||||
- diagnostics
|
||||
- climate
|
||||
- cover
|
||||
- fan
|
||||
|
||||
63
source/_integrations/homewizard.markdown
Normal file
63
source/_integrations/homewizard.markdown
Normal file
@ -0,0 +1,63 @@
|
||||
---
|
||||
title: HomeWizard Energy
|
||||
description: Instructions on how to integrate HomeWizard Energy into Home Assistant.
|
||||
ha_release: 2022.2
|
||||
ha_category:
|
||||
- Energy
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_domain: homewizard
|
||||
ha_codeowners:
|
||||
- '@DCSBL'
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
- switch
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
Integration for the [HomeWizard Energy](https://www.homewizard.nl/energy) platform. It can collect data locally from the HomeWizard Energy products and create them as sensors in Home Assistant.
|
||||
|
||||
**Supported devices**
|
||||
|
||||
- [Wifi P1 Meter](https://www.homewizard.nl/p1-meter): Depending on the connected DSMR meter: sensors for power import/export, energy consumption (single or three phases) and gas. (Model: `HWE-P1`)
|
||||
- [Wifi Energy Socket](https://www.homewizard.nl/energy-socket): Sensors for power import/export and energy consumption and switches for controlling the outlet (model: `HWE-SKT`)
|
||||
- [Wifi kWh Meter](https://www.homewizard.nl/kwh-meter): Sensors for power import/export and energy consumption. (Models: `SDM230-wifi`, `SDM630-wifi`)
|
||||
|
||||
## Enable the API
|
||||
|
||||
You have to enable the local API to allow Home Assistant to communicate with your device. Do this in the HomeWizard Energy app:
|
||||
|
||||
1. Go to Settings. (Gear icon in the upper-right)
|
||||
2. Go to 'Meters'.
|
||||
3. Select your device.
|
||||
4. Scroll down and turn on 'Local API'.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Sensors
|
||||
|
||||
The HomeWizard Energy API only exposes properties that are used within the HomeWizard Energy app. The available properties are listed below.
|
||||
|
||||
| Name | Unit | Availability | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| Wifi SSID | | HWE-P1, SDM230-wifi, SDM630-wifi, HWE-SKT | The SSID of the connected network. |
|
||||
| Wifi Strength | % | HWE-P1, SDM230-wifi, SDM630-wifi, HWE-SKT | Percentage of the wifi connection. |
|
||||
| Total Energy Import_t1 | kWh | HWE-P1, SDM230-wifi, SDM630-wifi, HWE-SKT | Energy import reading. |
|
||||
| Total Energy Import_t2 | kWh | HWE-P1 | Energy import reading for other tariff. |
|
||||
| Total Energy Export_t1 | kWh | HWE-P1, SDM230-wifi, SDM630-wifi, HWE-SKT | Energy export reading. |
|
||||
| Total Energy Export_t2 | kWh | HWE-P1 | Energy export reading for other tariff. |
|
||||
| Active Power | w | HWE-P1, SDM230-wifi, SDM630-wifi, HWE-SKT | Active power usage. |
|
||||
| Active Power_l1 | w | HWE-P1, SDM230-wifi, SDM630-wifi, HWE-SKT | Active power usage Line 1, for `SDM230-wifi` and`HWE-SKT` this value is the same as `Active Power`. |
|
||||
| Active Power_l2 | w | HWE-P1, SDM630-wifi | Active power usage Line 2. |
|
||||
| Active Power_l3 | w | HWE-P1, SDM630-wifi | Active power usage Line 3. |
|
||||
| Total Gas | m3 | HWE-P1 | Current gas import reading, only available when your smart meter is connected to a gas meter. |
|
||||
| DSMR Version | | HWE-P1 | The detected DSMR version. |
|
||||
| Smart Meter Model | | HWE-P1 | The detected smart meter model. |
|
||||
|
||||
## Switches
|
||||
|
||||
The Wifi Energy Socket (`HWE-SKT`) outlet state can be controlled the switch platform. There are two switches:
|
||||
|
||||
- **Switch**: Controls the outlet state of the Energy Socket. This switch is locked out when `Switch Lock` is turned on.
|
||||
- **Switch Lock**: Forces the outlet state in the `on` position and disables the physical button. This option is useful when the socket is used for a device that must not be turned off, such as a refrigerator.
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `htu21d` sensor platform allows you to read the temperature and humidity from a [HTU21D sensor](https://cdn-shop.adafruit.com/datasheets/1899_HTU21D.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins).
|
||||
|
||||
Tested devices:
|
||||
|
||||
@ -36,20 +36,41 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
## Lights for Hue zones and rooms
|
||||
|
||||
The Hue concept is based on Rooms and zones. Although the underlying Hue lights are exposed directly to Home Assistant it might also be useful to interact with the `grouped lights` of the Hue ecosystem, for example to turn all lights in a Hue group on/off at the same time.
|
||||
The Hue concept is based on Rooms and Zones. Although the underlying Hue lights are exposed directly to Home Assistant it might also be useful to interact with the `grouped lights` of the Hue ecosystem, for example to turn all lights in a Hue group on/off at the same time.
|
||||
|
||||
Home Assistant creates lights for each Hue zone/room automatically but disables them by default.
|
||||
If you'd like to use those `grouped lights`, you can enable them from Configuration --> Integrations --> Hue --> entities.
|
||||
|
||||
## Scenes
|
||||
|
||||
In the Hue concept you can create (dynamic) scenes for the lights within rooms and zones. These Hue scenes are automatically imported in Home Assistant and available as scene entities. Creating or editing Hue scenes in Home Assistant is not supported.
|
||||
In the Hue concept you can create (dynamic) scenes for the lights within rooms and zones. You can create, edit and delete Hue scenes from the (official) Hue app on iOS and Android. Each Zone/Room can have it's own scenes assigned and there is a large library of precreated scenes for specific moods. These Hue scenes are automatically imported in Home Assistant and they're available as `scene entities`. Creating or editing Hue scenes in Home Assistant is not supported.
|
||||
|
||||
It is advised to use Hue scenes for controlling multiple lights at once for a smooth experience. If you individually control multiple lights and/or use Home Assistant scenes, each light command will be sent to each light one by one which doesn't give a very good user experience, while using a Hue scene sends commands to all lights at once in an optimized way, resulting in a smooth experience.
|
||||
|
||||
### Service `hue.activate_scene`
|
||||
|
||||
To have more control over Hue scenes we've implemented a secondary, more advanced service to activate a Hue scene and set some properties at the same time, such as the Dynamic mode and/or brightness.
|
||||
|
||||
| Service Data Attribute | Required | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Entity ID of the Hue Scene entity you want to activate. |
|
||||
| `transition` | no | Transition duration (in seconds) it takes to bring devices to the state defined in the scene. |
|
||||
| `dynamic` | no | Enable (true) or Disable (false) dynamic mode for the scene. |
|
||||
| `speed` | no | Set the speed (of the dynamic palette) for this scene. |
|
||||
| `brightness` | no | Set the brightnes for this scene. |
|
||||
|
||||
You can use this service for example if you'd like to start/stop Dynamic Mode.
|
||||
|
||||
## Hue remotes and switches
|
||||
|
||||
Hue remotes such as the Dimmer Switch are stateless devices, meaning that they do not have a on/off state like regular entities in Home Assistant. Instead, such devices emit the event `hue_event` when a button is pressed. You can test what events come in using the event {% my developer_events title="developer tools in Home Assistant" %} and subscribe to the `hue_event`. Once you know what the event data looks like, you can use this to create automations.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
At the time of writing, there's a limitation on the Hue API that each device can only send one event per second. This means that button events are rate-limited to 1 per second. This is brought to the attention of Signify and it will hopefully be fixed soon.
|
||||
|
||||
</div>
|
||||
|
||||
## Support for legacy (V1) Hue bridges
|
||||
|
||||
Philips/Signify released a new version of their Hue bridge (square shape) and their legacy/V1 bridge (round shape) is now end of life and no longer supported by them. Home Assistant will continue to support the V1 Hue bridge as long as it is technically possible, although with a few limitations:
|
||||
|
||||
@ -124,6 +124,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -218,8 +218,11 @@ When auto setup is enabled the following products will be found in the IHC proje
|
||||
- Wireless lamp outlet dimmer
|
||||
- Wireless dimmer
|
||||
- Wireless combi dimmer 4 buttons
|
||||
- Wireless combi dimmer 4 buttons touch
|
||||
- Wireless combi dimmer 2 buttons touch
|
||||
- Wireless lamp outlet relay
|
||||
- Wireless combi relay 4 buttons
|
||||
- Wireless combi relay 2 buttons
|
||||
- Wireless mobile dimmer
|
||||
- Dataline lamp outlet
|
||||
|
||||
|
||||
88
source/_integrations/input_button.markdown
Normal file
88
source/_integrations/input_button.markdown
Normal file
@ -0,0 +1,88 @@
|
||||
---
|
||||
title: Input Button
|
||||
description: Instructions on how to use the Input Button helper with Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 2022.2
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: input_button
|
||||
---
|
||||
|
||||
The Input Button helper integration allows you to define buttons that
|
||||
can be pressed via the user interface, and can be used to trigger things,
|
||||
like an automation.
|
||||
|
||||
## Configuration
|
||||
|
||||
The preferred way to configure button helpers is via the user interface.
|
||||
To add one, go to **{% my helpers title="Configuration -> Helpers" %}**
|
||||
and click the add button; next choose the "**Button**" option.
|
||||
|
||||
To be able to add **Helpers** via the user interface you should have
|
||||
`default_config:` in your `configuration.yaml`, it should already be there by
|
||||
default unless you removed it. If you removed `default_config:` from your
|
||||
configuration, you must add `input_button:` to your `configuration.yaml` first,
|
||||
then you can use the UI.
|
||||
|
||||
Input buttons can also be configured via `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
input_button:
|
||||
ring_bell:
|
||||
name: Ring bell
|
||||
icon: mdi:bell
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
input_button:
|
||||
description: Alias for the input. Multiple entries are allowed.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Friendly name of the input.
|
||||
required: false
|
||||
type: string
|
||||
icon:
|
||||
description: Icon to display in front of the input element in the frontend.
|
||||
required: false
|
||||
type: icon
|
||||
{% endconfiguration %}
|
||||
|
||||
## Automation Examples
|
||||
|
||||
The `input_button` entity is stateless, as in, it cannot have a state like the
|
||||
`on` or `off` state that, for example, a normal switch entity has.
|
||||
|
||||
Every input button entity does keep track of the timestamp of when the last time
|
||||
the input button entity has been pressed in the Home Assistant UI or pressed via
|
||||
a service call.
|
||||
|
||||
Because the state of a input button entity in Home Assistant is a timestamp, it
|
||||
means we can use it in our automations. For example:
|
||||
|
||||
```yaml
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: button.my_button
|
||||
action:
|
||||
- service: notify.frenck
|
||||
data:
|
||||
message: "My button has been pressed!"
|
||||
```
|
||||
|
||||
## Services
|
||||
|
||||
The input button entities exposes a single service:
|
||||
{% my developer_call_service service="input_button.press" %}
|
||||
|
||||
This service can be called to trigger a button press for that entity.
|
||||
|
||||
```yaml
|
||||
- service: input_button.press
|
||||
target:
|
||||
entity_id: input_button.my_button
|
||||
```
|
||||
40
source/_integrations/intellifire.markdown
Normal file
40
source/_integrations/intellifire.markdown
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
title: IntelliFire
|
||||
description: Instructions on the IntelliFire Fireplace integration for Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 2022.2
|
||||
ha_codeowners:
|
||||
- '@jeeftor'
|
||||
ha_domain: intellifire
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- sensor
|
||||
---
|
||||
|
||||
IntelliFire Wi-Fi fireplace modules provide app-based and Alexa control to various fireplaces. The modules do expose an unencrypted HTTP endpoint on the network that provides status information. This integration will read that URL and create a set of sensors displaying the current fireplace state.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
### Sensor Types
|
||||
|
||||
|
||||
The following sensors are available as either a **Binary Sensor** when dealing with on/off.
|
||||
|
||||
### Binary Sensors
|
||||
|
||||
- **Power Sensor**: Whether the fire is on.
|
||||
- **Pilot Light Sensor**: Whether the pilot light is turned on.
|
||||
- **Timer Sensor**: Whether the sleep timer is turned on.
|
||||
- **Thermostat Sensor**: Whether the thermostat is turned on.
|
||||
|
||||
### Sensors
|
||||
|
||||
- **Flame Height**: Numerical indicator of flame height, where `0` is the lowest setting.
|
||||
- **Temperature**: Current ambient temperature as read by the fireplace remote.
|
||||
- **Target Temperature**: If the thermostat is engaged this is the target temperature the fireplace will try to reach, as measured by the remote.
|
||||
- **Fan Speed**: Numerical indicator of fan speed.
|
||||
- **Timer End Time**: If the sleep timer is enabled, this is time it will finish.
|
||||
@ -10,6 +10,7 @@ ha_codeowners:
|
||||
- '@bachya'
|
||||
ha_domain: iqvia
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate iZone climate control devices with
|
||||
ha_category:
|
||||
- Climate
|
||||
ha_release: '0.100'
|
||||
ha_iot_class: Local Push
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@Swamp-Ig'
|
||||
|
||||
@ -27,6 +27,7 @@ ha_quality_scale: silver
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- diagnostics
|
||||
- climate
|
||||
- cover
|
||||
- fan
|
||||
@ -178,6 +179,10 @@ payload:
|
||||
type:
|
||||
description: If set, the payload will not be sent as raw bytes, but encoded as given DPT. KNX sensor types are valid values - see table in [KNX Sensor](#sensor).
|
||||
type: [string, integer, float]
|
||||
response:
|
||||
description: If set to `true`, the telegram will be sent as a `GroupValueResponse` instead of a `GroupValueWrite`.
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
### Read
|
||||
|
||||
@ -6,11 +6,10 @@ ha_category:
|
||||
- Binary Sensor
|
||||
- Switch
|
||||
- Sensor
|
||||
ha_iot_class: Local Polling
|
||||
ha_iot_class: Local Push
|
||||
ha_release: '0.70'
|
||||
ha_codeowners:
|
||||
- '@heythisisnate'
|
||||
- '@kit-klein'
|
||||
ha_config_flow: true
|
||||
ha_domain: konnected
|
||||
ha_ssdp: true
|
||||
|
||||
@ -8,6 +8,7 @@ ha_iot_class: Cloud Push
|
||||
ha_release: 0.49
|
||||
ha_codeowners:
|
||||
- '@robbiet480'
|
||||
- '@frenck'
|
||||
ha_domain: lametric
|
||||
ha_platforms:
|
||||
- notify
|
||||
|
||||
@ -7,29 +7,17 @@ ha_iot_class: Cloud Polling
|
||||
ha_release: 0.83
|
||||
ha_codeowners:
|
||||
- '@ludeeus'
|
||||
- '@DurgNomis-drol'
|
||||
ha_domain: launch_library
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The `launch_library` sensor will provide you with information about the next planned space launch.
|
||||
The `launch_library` sensor will provide you with information about the next planned space launch and SpaceX Starship event.
|
||||
|
||||
## Configuration
|
||||
|
||||
Add the data to your `configuration.yaml` file as shown in the example:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: launch_library
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
The data this platform presents comes from [launchlibrary.net][launchlibrary].
|
||||
|
||||
|
||||
@ -42,8 +42,8 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Please note: Besides the implemented platforms, the `lcn` integration offers a variety of [service calls](#services).
|
||||
These service calls cover functionalities of the LCN system, which cannot be represented by the platform implementations.
|
||||
The implemented platforms do not cover the whole functionality of the LCN system.
|
||||
Therefore the `lcn` integration offers a variety of [events](#events), [device triggers](#device-triggers) and [service calls](#services).
|
||||
They are ideal to be used in automation scripts or for the `template` platforms.
|
||||
|
||||
</div>
|
||||
@ -483,8 +483,10 @@ The `lcn` sensor platform allows the monitoring of the following [LCN](https://w
|
||||
The sensor can be used in automation scripts or in conjunction with `template` platforms.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Ensure that the LCN module is configured properly to provide the requested value.
|
||||
Otherwise, the module might show unexpected behavior or return error messages.
|
||||
|
||||
</div>
|
||||
|
||||
### Switch
|
||||
@ -494,12 +496,207 @@ The `lcn` switch platform allows the control of the following [LCN](https://www.
|
||||
- Output ports
|
||||
- Relays
|
||||
|
||||
## Additional Features
|
||||
|
||||
### Transponder and fingerprint sensor
|
||||
|
||||
To use LCN transponders or fingerprint sensors ensure that the corresponding module's I-port property
|
||||
is enabled in the LCN-PRO software and properly configured.
|
||||
LCN transponders and fingerprints are identified by a six value hexadecimal code (e.g. *123abc*).
|
||||
If a code is received a corresponding event ([transponder event](#event-lcn_transponder), [fingerprint event](#event-lcn_fingerprint))
|
||||
is fired and can be used to trigger an automation.
|
||||
Alternatively, you can use the corresponding [device triggers](#device-triggers).
|
||||
|
||||
Example:
|
||||
|
||||
This example shows how the `event_data` can be extracted and used in a condition using Home Assistant's templating engine.
|
||||
Trigger on a transponder event and ensure that the received code is in the given list:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: lcn_transponder
|
||||
condition: "{{ trigger.event.data.code in ['aabbcc', 'ddeeff', '112233'] }}"
|
||||
action:
|
||||
...
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
Further examples can be found in the [event section](#events).
|
||||
|
||||
### Remote control
|
||||
|
||||
To use LCN remote controls (e.g., LCN-RT or LCN-RT16) ensure that the corresponding module's I-port property
|
||||
is enabled in the LCN-PRO software and its behavior is properly configured as "IR access control".
|
||||
With this configuration each remote control is identified by a six value hexadecimal code (e.g. *123abc*).
|
||||
If a command from a remote control is received a corresponding event ([transponder event](#event-lcn_transponder))
|
||||
is fired and can be used to trigger an automation. Along with the transmitted code, the pressed key and the key action
|
||||
are transmitted.
|
||||
Alternatively, you can use the corresponding [device triggers](#device-triggers).
|
||||
|
||||
Examples can be found in the [event section](#events).
|
||||
|
||||
### LCN commands addressed to PCHK host (Home Assistant)
|
||||
|
||||
A LCN module can not only be programmed to send commands to other modules/groups but also to the PCHK host configured
|
||||
in the LCN integration. These commands are directly passed to Home Assistant and can be evaluated. Only the *send keys*
|
||||
(former) command is supported.
|
||||
|
||||
Within LCN-PRO program the *send keys* command (only "A-C former command" is supported) to a key. For the target address
|
||||
manually enter the PCHK host id (default: 4). Select the keys and key actions as desired.
|
||||
|
||||
When a *send keys* command is received, the LCN integration will fire a [send keys event](#event-lcn_send_keys) for each
|
||||
key configured. These events can be used to trigger an automation.
|
||||
Alternatively, you can use the corresponding [device triggers](#device-triggers).
|
||||
|
||||
Examples can be found in the [event section](#events).
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Only commands sent from physical buttons of a module are evaluated. The "Test command" button in the LCN-PRO software
|
||||
is not evaluated and therefore cannot be used for testing purposes.
|
||||
|
||||
</div>
|
||||
|
||||
## Events
|
||||
|
||||
There are several functionalities of the LCN system which are not exposed as regular entities by the integration, but as events.
|
||||
Examples are button presses from remote controls (transmitters), transponder findings, fingerprint sensors and so called *send keys* events.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you find it difficult to deal with events in scripted automations, you can also use [device triggers](#device-triggers)
|
||||
which offer automation design via the UI.
|
||||
|
||||
</div>
|
||||
|
||||
All events have some common attributes in their `event_data` which identify the sending LCN hardware module (e.g., the module the transponder is connected to):
|
||||
|
||||
| Event payload | Description | Values |
|
||||
| ------------- | ----------- | ------ |
|
||||
| `device_id` | Internal device id of LCN module | string |
|
||||
| `segment_id` | Module's segment id | 5..128 |
|
||||
| `module_id` | Module id | 5..254 |
|
||||
|
||||
In addition, every event has its own special attributes which are described below.
|
||||
All special attributes are optional and can be used as supplementary filters.
|
||||
|
||||
### Event: `lcn_transmitter`
|
||||
|
||||
The `lcn_transmitter` event is fired if a LCN remote control command is received.
|
||||
|
||||
| Special payload | Description | Values |
|
||||
| --------------- | ----------- | ------ |
|
||||
| `code` | Transmitter code | string (6 hex values) |
|
||||
| `level` | Key level | 0..4 |
|
||||
| `key` | Key | 0..4 |
|
||||
| `action` | Key action | `hit`, `make`, `break` |
|
||||
|
||||
Example:
|
||||
|
||||
The trigger will fire if any key on the remote control with code *123abc* is `hit` as long as the
|
||||
receiver hardware is connected to module 7 in segment 0.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: lcn_transmitter
|
||||
event_data:
|
||||
segment_id: 0
|
||||
module_id: 7
|
||||
code: 123abc
|
||||
action: hit
|
||||
```
|
||||
|
||||
### Event: `lcn_transponder`
|
||||
|
||||
The `lcn_transponder` event is fired if a LCN transponder command is received.
|
||||
|
||||
| Special payload | Description | Values |
|
||||
| --------------- | ----------- | ------ |
|
||||
| `code` | Transponder code | string (6 hex values) |
|
||||
|
||||
Example:
|
||||
|
||||
The trigger will fire if the transponder with code *123abc* was detected at
|
||||
any hardware module.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: lcn_transponder
|
||||
event_data:
|
||||
code: 123abc
|
||||
```
|
||||
|
||||
### Event: `lcn_fingerprint`
|
||||
|
||||
The `lcn_fingerprint` event is fired if a LCN fingerprint command is received.
|
||||
|
||||
| Special payload | Description | Values |
|
||||
| --------------- | ----------- | ------ |
|
||||
| `code` | Fingerprint code | string (6 hex values) |
|
||||
|
||||
Example:
|
||||
|
||||
The trigger will fire if the fingerprint with code *123abc* was detected at
|
||||
any hardware module.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: lcn_fingerprint
|
||||
event_data:
|
||||
code: 123abc
|
||||
```
|
||||
|
||||
### Event: `lcn_send_keys`
|
||||
|
||||
The `lcn_send_keys` event is fired if the PCHK host receives a *send keys* command.
|
||||
|
||||
| Special payload | Description | Values |
|
||||
| --------------- | ----------- | ------ |
|
||||
| `key` | LCN Key | a1..c8 |
|
||||
| `action` | Key action | `hit`, `make`, `break` |
|
||||
|
||||
Example:
|
||||
|
||||
The trigger will fire if the PCHK host receives a command that issues a `hit` of
|
||||
key `a1`.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: lcn_send_keys
|
||||
event_data:
|
||||
key: a1
|
||||
action: hit
|
||||
```
|
||||
|
||||
## Device triggers
|
||||
|
||||
To simplify using events in automations the LCN integration exposes them as device triggers.
|
||||
Those device triggers can be selected from the automation editor within Home Assistant.
|
||||
|
||||
After creating a new automation select *Device* as trigger type and search for the module which is
|
||||
supposed to cause the event in the device list. You may select the trigger type and configure its
|
||||
attributes. If an attribute is optional it is considered as a supplementary filter for the trigger.
|
||||
For an explanation of the attributes refer to the corresponding [events](#events).
|
||||
|
||||
## Services
|
||||
|
||||
In order to directly interact with the LCN system, and invoke commands which are not covered by the implemented platforms, the following service calls can be used.
|
||||
Refer to the [Services Calls](/docs/scripts/service-calls) page for examples on how to use them.
|
||||
|
||||
### Service `output_abs`
|
||||
### Service: `output_abs`
|
||||
|
||||
Set absolute brightness of output port in percent.
|
||||
|
||||
@ -521,7 +718,7 @@ data:
|
||||
transition: 0
|
||||
```
|
||||
|
||||
### Service `output_rel`
|
||||
### Service: `output_rel`
|
||||
|
||||
Set relative brightness of output port in percent.
|
||||
|
||||
@ -542,7 +739,7 @@ data:
|
||||
brightness: 30
|
||||
```
|
||||
|
||||
### Service `output_toggle`
|
||||
### Service: `output_toggle`
|
||||
|
||||
Toggle output port.
|
||||
|
||||
@ -562,7 +759,7 @@ data:
|
||||
transition: 0
|
||||
```
|
||||
|
||||
### Service `relays`
|
||||
### Service: `relays`
|
||||
|
||||
Set the relays status. The relays states are defined as a string with eight characters.
|
||||
Each character represents the state change of a relay (1=on, 0=off, t=toggle, -=nochange).
|
||||
@ -583,7 +780,7 @@ data:
|
||||
state: t---001-
|
||||
```
|
||||
|
||||
### Service `led`
|
||||
### Service: `led`
|
||||
|
||||
Set the LED status.
|
||||
|
||||
@ -602,7 +799,7 @@ data:
|
||||
state: blink
|
||||
```
|
||||
|
||||
### Service `var_abs`
|
||||
### Service: `var_abs`
|
||||
|
||||
Set the absolute value of a variable or setpoint.
|
||||
If `value` is not defined, it is assumed to be 0.
|
||||
@ -631,7 +828,7 @@ data:
|
||||
Otherwise the module might show unexpected behaviors or return error messages.
|
||||
</div>
|
||||
|
||||
### Service `var_rel`
|
||||
### Service: `var_rel`
|
||||
|
||||
Set the relative value of a variable or setpoint.
|
||||
If `value` is not defined, it is assumed to be 0.
|
||||
@ -660,7 +857,7 @@ data:
|
||||
Otherwise the module might show unexpected behavior or return error messages.
|
||||
</div>
|
||||
|
||||
### Service `var_reset`
|
||||
### Service: `var_reset`
|
||||
|
||||
Reset value of variable or setpoint.
|
||||
|
||||
@ -683,7 +880,7 @@ data:
|
||||
Otherwise the module might show unexpected behavior or return error messages.
|
||||
</div>
|
||||
|
||||
### Service `lock_regulator`
|
||||
### Service: `lock_regulator`
|
||||
|
||||
Locks a regulator setpoint.
|
||||
If `state` is not defined, it is assumed to be `False`.
|
||||
@ -704,7 +901,7 @@ data:
|
||||
state: true
|
||||
```
|
||||
|
||||
### Service `send_keys`
|
||||
### Service: `send_keys`
|
||||
|
||||
Send keys (which executes bound commands).
|
||||
The keys attribute is a string with one or more key identifiers. Example: `a1a5d8`
|
||||
@ -741,7 +938,7 @@ data:
|
||||
time_unit: s
|
||||
```
|
||||
|
||||
### Service `lock_keys`
|
||||
### Service: `lock_keys`
|
||||
|
||||
Locks keys.
|
||||
If the table is not defined, it is assumed to be table `a`.
|
||||
@ -778,7 +975,7 @@ data:
|
||||
time_unit: s
|
||||
```
|
||||
|
||||
### Service `dyn_text`
|
||||
### Service: `dyn_text`
|
||||
|
||||
Send dynamic text to LCN-GTxD displays.
|
||||
The displays support four rows for text messages.
|
||||
@ -801,7 +998,7 @@ data:
|
||||
text: "text in row 1"
|
||||
```
|
||||
|
||||
### Service `pck`
|
||||
### Service: `pck`
|
||||
|
||||
Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the `pck` string.
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ The `mqtt` light platform lets you control your MQTT enabled lights through one
|
||||
| Color temperature | ✔ | ✔ | ✔ |
|
||||
| Effects | ✔ | ✔ | ✔ |
|
||||
| Flashing | ✘ | ✔ | ✔ |
|
||||
| HS Color | ✔ | ✔ | ✘ |
|
||||
| HS Color | ✔ | ✔ | ✔ |
|
||||
| RGB Color | ✔ | ✔ | ✔ |
|
||||
| RGBW Color | ✔ | ✔ | ✘ |
|
||||
| RGBWW Color | ✔ | ✔ | ✘ |
|
||||
@ -177,6 +177,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
@ -559,6 +564,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
@ -799,7 +809,7 @@ light:
|
||||
The `mqtt` light platform with template schema lets you control a MQTT-enabled light that receive commands on a command topic and optionally sends status update on a state topic.
|
||||
It is format-agnostic so you can use any data format you want (i.e., string, JSON), just configure it with templating.
|
||||
|
||||
This schema supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing and effects.
|
||||
This schema supports on/off, brightness, RGB colors, XY colors, HS Color, color temperature, transitions, short/long flashing and effects.
|
||||
|
||||
## Template schema - Configuration
|
||||
|
||||
@ -918,6 +928,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
@ -1019,7 +1034,7 @@ In this section you find some real-life examples of how to use this light.
|
||||
|
||||
### Simple string payload
|
||||
|
||||
For a simple string payload with the format `state,brightness,r-g-b` (e.g., `on,255,255-255-255`), add the following to your `configuration.yaml` file:
|
||||
For a simple string payload with the format `state,brightness,r-g-b,h-s` (e.g., `on,255,255-255-255,360-100`), add the following to your `configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -1030,7 +1045,7 @@ light:
|
||||
schema: template
|
||||
command_topic: "home/rgb1/set"
|
||||
state_topic: "home/rgb1/status"
|
||||
command_on_template: "on,{{ brightness|d }},{{ red|d }}-{{ green|d }}-{{ blue|d }}"
|
||||
command_on_template: "on,{{ brightness|d }},{{ red|d }}-{{ green|d }}-{{ blue|d }},{{ hue|d }}-{{ sat|d }}"
|
||||
command_off_template: "off"
|
||||
state_template: "{{ value.split(',')[0] }}" # must return `on` or `off`
|
||||
brightness_template: "{{ value.split(',')[1] }}"
|
||||
@ -1065,6 +1080,9 @@ light:
|
||||
{%- if red is defined and green is defined and blue is defined -%}
|
||||
, "color": [{{ red }}, {{ green }}, {{ blue }}]
|
||||
{%- endif -%}
|
||||
{%- if hue is defined and sat is defined -%}
|
||||
, "huesat": [{{ hue }}, {{ sat }}]
|
||||
{%- endif -%}
|
||||
{%- if effect is defined -%}
|
||||
, "effect": "{{ effect }}"
|
||||
{%- endif -%}
|
||||
|
||||
@ -116,6 +116,11 @@ enabled_by_default:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
encoding:
|
||||
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
|
||||
required: false
|
||||
type: string
|
||||
default: "utf-8"
|
||||
entity_category:
|
||||
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
|
||||
required: false
|
||||
|
||||
@ -1,17 +1,22 @@
|
||||
---
|
||||
title: LOOKin
|
||||
description: Instructions on how to integrate LookIN devices into Home Assistant.
|
||||
description: Instructions on how to integrate LOOKin devices into Home Assistant.
|
||||
ha_category:
|
||||
- Climate
|
||||
- Light
|
||||
- Media Player
|
||||
- Sensor
|
||||
ha_release: 2021.11
|
||||
ha_iot_class: Local Push
|
||||
ha_codeowners:
|
||||
- '@ANMalko'
|
||||
- '@bdraco'
|
||||
ha_domain: lookin
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- climate
|
||||
- light
|
||||
- media_player
|
||||
- sensor
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Luftdaten
|
||||
description: Instructions on how to setup Luftdaten sensors in Home Assistant.
|
||||
title: Sensor.Community
|
||||
description: Instructions on how to add Sensor.Community sensors to Home Assistant.
|
||||
ha_category:
|
||||
- Health
|
||||
- Sensor
|
||||
@ -10,95 +10,18 @@ ha_config_flow: true
|
||||
ha_quality_scale: gold
|
||||
ha_codeowners:
|
||||
- '@fabaff'
|
||||
- '@frenck'
|
||||
ha_domain: luftdaten
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- sensor
|
||||
---
|
||||
|
||||
The `luftdaten` integration will query the open data API of [luftdaten.info](https://luftdaten.info/) to monitor air quality and other weather data from a specific (self build) sensor station.
|
||||
The Sensor.Communtiy integration will query the open data API of [Sensor.Community](https://sensor.community) to monitor air quality and other weather data from a specific (self build) sensor station.
|
||||
|
||||
## Setup
|
||||
## Prerequisites
|
||||
|
||||
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](https://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
|
||||
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
|
||||
To get the ID of a particle, pressure, noise, temperature, or humidity sensor by selecting it on the [Sensor.Community map](https://maps.sensor.community/).
|
||||
After selecting the sensor, it will show the needed ID in the sidebar with a `#` in front of it.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Manual Configuration
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
luftdaten:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
sensor_id:
|
||||
description: The ID of the sensor.
|
||||
required: true
|
||||
type: string
|
||||
show_on_map:
|
||||
description: Option to show the position of the sensor on the map.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
scan_interval:
|
||||
description: the frequency (in seconds) between data updates.
|
||||
required: false
|
||||
type: integer
|
||||
default: 600
|
||||
sensors:
|
||||
description: The sensor-related configuration options.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
monitored_conditions:
|
||||
description: A list of conditions you want to monitor.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
P1:
|
||||
description: Show the particle sensors (particles 10 microns and below).
|
||||
P2:
|
||||
description: Show the particle sensors (particles 2.5 microns and below).
|
||||
temperature:
|
||||
description: Display the temperature from the sensor.
|
||||
humidity:
|
||||
description: Display the humidity from the sensor.
|
||||
pressure:
|
||||
description: Display the pressure from the sensor.
|
||||
{% endconfiguration %}
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
If you set `show_on_map` to `true` then the location attributes are named `latitude` and `longitude`. The default name of the location attributes is `lat` and `long` to avoid showing them on the map.
|
||||
|
||||
</div>
|
||||
|
||||
Not all sensors provide all conditions. Also, it's possible that the sensor values are not available all the time. To check what a sensor is publishing use `curl`:
|
||||
|
||||
```bash
|
||||
curl https://data.sensor.community/airrohr/v1/sensor/[sensorid]/
|
||||
```
|
||||
|
||||
## Full example
|
||||
|
||||
This example would use the sensor with the ID 155, show it on the `map` and would monitor `temperature` and `humidity`.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
luftdaten:
|
||||
sensor_id: 155
|
||||
show_on_map: true
|
||||
sensors:
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
- humidity
|
||||
```
|
||||
|
||||
## Sensor
|
||||
|
||||
The `luftdaten` sensor platform will query the open data API of [luftdaten.info](https://luftdaten.info/) to monitor air quality and other weather data from a specific (self build) sensor station.
|
||||
|
||||
You must have the `luftdaten` integration (from above) configured to use this platform. After configuring that component, sensors will automatically appear.
|
||||
|
||||
@ -40,9 +40,6 @@ The currently supported Caseta and RA2 Select devices are:
|
||||
- Lutron shades as [covers](#cover)
|
||||
- Lutron smart [fan](#fan) speed control
|
||||
- Lutron Occupancy/Vacancy [sensors](#sensor)
|
||||
|
||||
Additionally RA2 Select Main Repeater (`RR-SEL-REP2-BL`) or Lutron Caséta Smart Bridge PRO (`L-BDGPRO2-WH`) models support:
|
||||
|
||||
- Pico Remotes as [device triggers](/integrations/device_automation/)
|
||||
- Shade Remotes as [device triggers](/integrations/device_automation/)
|
||||
|
||||
@ -164,7 +161,7 @@ For more information on working with binary sensors in Home Assistant, see the [
|
||||
|
||||
## Pico and Shade Remotes
|
||||
|
||||
Pico and Shade remotes require a RA2 Select Main Repeater (`RR-SEL-REP2-BL`) or Lutron Caséta Smart Bridge PRO (`L-BDGPRO2-WH`) with Telnet Support enabled in the Lutron app under `Settings` >> `Advanced` >> `Integration`
|
||||
Pico and Shade remotes are supported on the Smart Bridge (L-BDG2-WH), Smart Bridge PRO (L-BDGPRO2-WH), and RA2 Select (RR-SEL-REP2-BL) models.
|
||||
|
||||
Device Triggers are implemented for `press` and `release` of each button on the remotes via watching for `lutron_caseta_button_event` events in the format:
|
||||
|
||||
|
||||
@ -14,6 +14,7 @@ ha_codeowners:
|
||||
- '@bdr99'
|
||||
ha_domain: mazda
|
||||
ha_platforms:
|
||||
- diagnostics
|
||||
- device_tracker
|
||||
- lock
|
||||
- sensor
|
||||
@ -25,8 +26,9 @@ This integration requires an active Mazda Connected Services subscription and a
|
||||
|
||||
- Mazda3: 2019+
|
||||
- CX-30: 2020+
|
||||
- CX-9: 2021+
|
||||
- CX-5: 2021+
|
||||
- CX-9: 2021+
|
||||
- MX-30: 2020+
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -39,10 +41,12 @@ This integration requires an active Mazda Connected Services subscription and a
|
||||
### Sensor
|
||||
|
||||
The following sensor entities are available:
|
||||
- Fuel remaining
|
||||
- Fuel distance remaining
|
||||
- Fuel remaining (only for gas vehicles)
|
||||
- Fuel distance remaining (only for gas vehicles)
|
||||
- Odometer
|
||||
- Tire pressure (not available for CX-5 and CX-9 models)
|
||||
- Charge level (only for electric vehicles)
|
||||
- Remaining range (only for electric vehicles)
|
||||
|
||||
### Device tracker
|
||||
|
||||
|
||||
@ -15,6 +15,14 @@ ha_platforms:
|
||||
- switch
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The `mcp23017` integration is the base for all related mcp23017 platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections.
|
||||
|
||||
For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017).
|
||||
|
||||
@ -10,6 +10,14 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This integration is deprecated and will be removed in Home Assistant Core 2022.4.
|
||||
|
||||
For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
|
||||
|
||||
</div>
|
||||
|
||||
The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation.
|
||||
|
||||
**Note:** the new version MH-Z19B requires the VIN to be connected to a 5V pin, rather than 3.3V.
|
||||
|
||||
@ -7,7 +7,7 @@ ha_release: 0.89
|
||||
ha_config_flow: true
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@robbiet480'
|
||||
- '@home-assistant/core'
|
||||
ha_domain: mobile_app
|
||||
ha_iot_class: Local Push
|
||||
ha_platforms:
|
||||
|
||||
@ -265,6 +265,10 @@ slave:
|
||||
required: false
|
||||
type: integer
|
||||
default: 0
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Configuring data_type and struct
|
||||
@ -314,6 +318,10 @@ swap:
|
||||
required: false
|
||||
default: none
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Configuring platform binary sensor
|
||||
@ -358,6 +366,10 @@ binary_sensors:
|
||||
required: false
|
||||
default: coil
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Configuring platform climate
|
||||
@ -435,6 +447,10 @@ climates:
|
||||
required: false
|
||||
type: string
|
||||
default: C
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Service `modbus.set-temperature`
|
||||
@ -467,7 +483,6 @@ modbus:
|
||||
device_class: door
|
||||
input_type: coil
|
||||
address: 117
|
||||
device_class: door
|
||||
state_open: 1
|
||||
state_opening: 2
|
||||
state_closed: 0
|
||||
@ -475,7 +490,7 @@ modbus:
|
||||
status_register: 119
|
||||
status_register_type: holding
|
||||
- name: "Door2"
|
||||
address: 117
|
||||
address: 118
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -526,6 +541,10 @@ covers:
|
||||
description: Modbus register type (holding, input), default holding.
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Example: Modbus cover controlled by a coil
|
||||
@ -713,6 +732,10 @@ fans:
|
||||
required: false
|
||||
default: same as command_off
|
||||
type: integer
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Configuring platform light
|
||||
@ -802,6 +825,10 @@ lights:
|
||||
required: false
|
||||
default: same as command_off
|
||||
type: integer
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Configuring platform sensor
|
||||
@ -882,6 +909,10 @@ sensors:
|
||||
description: The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor#available-state-classes) of the sensor.
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<div class='note'>
|
||||
@ -1001,6 +1032,10 @@ switches:
|
||||
required: false
|
||||
default: same as command_off
|
||||
type: integer
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Opening an issue
|
||||
|
||||
@ -11,6 +11,7 @@ ha_codeowners:
|
||||
ha_domain: nam
|
||||
ha_platforms:
|
||||
- button
|
||||
- diagnostics
|
||||
- sensor
|
||||
ha_quality_scale: platinum
|
||||
ha_zeroconf: true
|
||||
|
||||
@ -13,6 +13,7 @@ ha_release: 0.67
|
||||
ha_domain: nanoleaf
|
||||
ha_platforms:
|
||||
- button
|
||||
- diagnostics
|
||||
- light
|
||||
ha_zeroconf: true
|
||||
ha_ssdp: true
|
||||
|
||||
@ -19,6 +19,7 @@ ha_dhcp: true
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- camera
|
||||
- diagnostics
|
||||
- climate
|
||||
- sensor
|
||||
---
|
||||
@ -320,7 +321,7 @@ All cameras have motion and person triggers, however only some support capturing
|
||||
| Nest Cam (indoor, wired)<br>Nest Cam (outdoor, battery) | WebRTC | Motion<br>Person | N/A |
|
||||
| Nest Cam Indoor<br>Nest Cam IQ Indoor<br>Nest Cam IQ Outdoor<br>Nest Cam Outdoor | RTSP<br>Recording | Motion<br>Person<br>Sound | Snapshot (jpg) |
|
||||
| Nest Cam with floodlight | WebRTC | Motion<br>Person | N/A |
|
||||
| Nest Doorbell (battery) | WebRTC | Motion<br>Person<br>Chime | Clip Preview (mp4) |
|
||||
| Nest Doorbell (battery) | WebRTC | Motion<br>Person<br>Chime | Clip Preview (mp4, gif) |
|
||||
| Nest Doorbell (wired) | RTSP<br>Recording | Motion<br>Person<br>Sound<br>Chime | Snapshot (jpg) |
|
||||
| Nest Hub Max | RTSP<br>Recording | Motion<br>Person<br>Sound<br><sub><sup>* [SDM API known issue](https://github.com/home-assistant/core/issues/58482)</sup></sub> | Snapshot (jpg) |
|
||||
|
||||
@ -329,13 +330,35 @@ Given a camera named `Front Yard` then the camera is created with a name such as
|
||||
|
||||
## Automation and Device Triggers
|
||||
|
||||
The Nest integration makes [device triggers](/docs/automation/trigger/#device-triggers) available to enable automation
|
||||
in Home Assistant. You should review the [Automating Home Assistant](/getting-started/automation/) getting started guide on automations or the [Automation](/docs/automation/) documentation for full details.
|
||||
The Nest integration provides [device triggers](/docs/automation/trigger/#device-triggers) to enable automation in Home Assistant. You should review the [Automating Home Assistant](/getting-started/automation/) getting started guide on automations or the [Automation](/docs/automation/) documentation for full details.
|
||||
|
||||
{% my automations badge %}
|
||||
|
||||
|
||||
|
||||
{% details "Example Device Trigger / Event payload %}
|
||||
|
||||
This is an example of what the `nest_event` payload looks like for a Device Trigger that you can use to power automations.
|
||||
|
||||
```json
|
||||
{
|
||||
"event_type": "nest_event",
|
||||
"data": {
|
||||
"device_id": "EXAMPLE_DEVICE_ID",
|
||||
"type": "doorbell_chime",
|
||||
"timestamp": "2022-01-26T04:56:54.031000+00:00",
|
||||
"nest_event_id": "EXAMPLE_EVENT_ID",
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
* `device_id`: The Home Assistant device identifier for the camera
|
||||
* `nest_event_id`: is an opaque identifier that can be used with the Media Source Attachments described below for supported cameras.
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
Continue reading below to *Media Source Attachments* to see how to use media with notification actions.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
This feature is enabled by the following permissions:
|
||||
@ -345,37 +368,85 @@ This feature is enabled by the following permissions:
|
||||
- *Other permissions in the Nest or Google Home apps*.
|
||||
</div>
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
This automation will trigger when a `nest_event` event type with a type of `camera_motion` is received from the specified `device_id`.
|
||||
|
||||
```yaml
|
||||
alias: "motion alert"
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: nest_event
|
||||
event_data:
|
||||
device_id: YOUR_DEVICE_ID
|
||||
type: camera_motion
|
||||
action:
|
||||
- service: notify.mobile_app_pixel_2
|
||||
data:
|
||||
title: motion detected
|
||||
message: front door motion detected
|
||||
data:
|
||||
image: /api/camera_proxy/camera.front_door
|
||||
```
|
||||
|
||||
The action in this section uses the [Android Companion App](https://companion.home-assistant.io/docs/notifications/notifications-basic/) and the camera proxy to send a notification with a snapshot from the camera.
|
||||
|
||||
|
||||
## Media Source
|
||||
|
||||
The Nest [Media Source](/integrations/media_source) platform allows you to browse clips for recent camera events. Home Assistant is not intended to be a Network Video Recorder (NVR) platform, however, basic support for capturing recent events is supported.
|
||||
|
||||
The table above describes which devices support event image snapshots or 10-frame mp4 video clips for recent events.
|
||||
|
||||
### Media Attachments
|
||||
|
||||
The Media Source APIs can be used in [Companion App Attachments](https://companion.home-assistant.io/docs/notifications/notification-attachments) for Notifications as actions for Device Triggers above like *Doorbell Pressed*. You will need to be familiar with both the Media Sources supported for your camera, as well as the media capabilities of the companion apps.
|
||||
|
||||
* `/api/nest/event_media/DEVICE_ID/EVENT_ID`: Media for the event, which supports image snapshots (jpg) or clip previews (mp4) depending on the camera type.
|
||||
|
||||
* `/api/nest/event_media/DEVICE_ID/EVENT_ID/thumbnail`: A thumbnail preview of the media, which supports image snapshots (jpg) or clip previews (gif) depending on the camera type.
|
||||
|
||||
You can use the event payload fields `device_id` and `event_id` in an [automation](/getting-started/automation/) to send a notification from an [actions](/getting-started/automation-action/) as shown in the examples below.
|
||||
|
||||
{% details "Example Action: Clip Preview (mp4) attachment for iOS %}
|
||||
|
||||
Example for cameras that support Clip Previews used with iOS which can render video in notifications.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
service: notify.mobile_app_iphone
|
||||
data:
|
||||
message: Doorbell Pressed
|
||||
title: Someone pressed the doorbell
|
||||
data:
|
||||
image: >-
|
||||
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}/thumbnail
|
||||
video: >-
|
||||
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}
|
||||
mode: single
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Example Action: Clip Preview thumbnail (gif) for Android or iOS %}
|
||||
|
||||
Example for cameras that support Clip Previews, but transcoded to an animated gif (Android does not render video notifications).
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
service: notify.mobile_app_android
|
||||
data:
|
||||
message: Doorbell Pressed
|
||||
title: Someone pressed the doorbell
|
||||
data:
|
||||
image: >-
|
||||
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}/thumbnail
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Example Action: Snapshot (jpg) attachment for Android or iOS %}
|
||||
|
||||
Example for cameras that support Snaphot (jpg) on either Android or iOS.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
service: notify.mobile_app
|
||||
data:
|
||||
message: Doorbell Pressed
|
||||
title: Someone pressed the doorbell
|
||||
data:
|
||||
image: >-
|
||||
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}/thumbnail
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
<div class='note'>
|
||||
|
||||
This feature is enabled by the following permissions:
|
||||
@ -451,12 +522,12 @@ logger:
|
||||
|
||||
- It is recommended to let Home Assistant create the Pub/Sub subscription for you. However, if you would like more control you can enter a `susbcriber_id` in the configuration. See [Subscribe to Events](https://developers.google.com/nest/device-access/subscribe-to-events) for more instructions on how to manually create a subscription and use the full subscription name in the Home Assistant configuration e.g. `projects/gcp-project-name/subscriptions/subscription-id`
|
||||
|
||||
# Legacy Works With Nest API
|
||||
|
||||
This section contains instructions for the Legacy [Works with Nest](https://developers.nest.com/) API.
|
||||
# Works With Nest API (Deprecated)
|
||||
|
||||
<div class='note warning'>
|
||||
New users are not currently able to set up a Works With Nest Developer account. The documentation is preserved here for existing users of the API.
|
||||
|
||||
The [Works with Nest](https://developers.nest.com/) API is deprecated and will be removed in Home Assistant Core 2022.5.
|
||||
|
||||
</div>
|
||||
|
||||
{% details "Legacy Works with Nest Configuration Steps" %}
|
||||
|
||||
@ -18,6 +18,7 @@ ha_domain: netatmo
|
||||
ha_homekit: true
|
||||
ha_platforms:
|
||||
- camera
|
||||
- diagnostics
|
||||
- climate
|
||||
- light
|
||||
- sensor
|
||||
|
||||
@ -6,6 +6,7 @@ ha_category:
|
||||
- Sensor
|
||||
- Climate
|
||||
- Scene
|
||||
- Switch
|
||||
ha_release: 0.108
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
@ -18,6 +19,7 @@ ha_platforms:
|
||||
- climate
|
||||
- scene
|
||||
- sensor
|
||||
- switch
|
||||
---
|
||||
|
||||
The `nexia` integration allows you to integrate your [Nexia](https://mynexia.com/) (Trane) thermostats or [American Standard](https://asairhome.com/) thermostats into Home Assistant.
|
||||
@ -28,6 +30,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [Climate](#climate)
|
||||
- [Sensor](#sensor)
|
||||
- [Scene](#scene)
|
||||
- [Switch](#switch)
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -39,7 +42,7 @@ The following binary sensors are added for each thermostat:
|
||||
|
||||
### Sensor
|
||||
|
||||
The following binary sensors are added for each thermostat:
|
||||
The following sensors are added for each thermostat:
|
||||
|
||||
- Air Cleaner Mode
|
||||
- Current Compressor Speed
|
||||
@ -48,7 +51,7 @@ The following binary sensors are added for each thermostat:
|
||||
- Relative Humidity
|
||||
- System Status
|
||||
|
||||
The following binary sensors are added for each thermostat zone:
|
||||
The following sensors are added for each thermostat zone:
|
||||
|
||||
- Zone Temperature
|
||||
- Zone Setpoint Status
|
||||
@ -56,7 +59,7 @@ The following binary sensors are added for each thermostat zone:
|
||||
|
||||
### Climate
|
||||
|
||||
The `nexia` climate platform lets you control a thermostat.
|
||||
The climate platform lets you control a thermostat.
|
||||
|
||||
The following Trane thermostats are supported: `XL1050`, `XL850`, `XL824`
|
||||
|
||||
@ -68,7 +71,11 @@ Other thermostats may work, but they have not been tested.
|
||||
|
||||
### Scene
|
||||
|
||||
The `nexia` scene platform lets you activate a nexia automation.
|
||||
The scene platform lets you activate a nexia automation.
|
||||
|
||||
### Switch
|
||||
|
||||
The switch platform lets you enable or disable hold mode for each thermostat.
|
||||
|
||||
### Service `nexia.set_aircleaner_mode`
|
||||
|
||||
|
||||
20
source/_integrations/nina.markdown
Normal file
20
source/_integrations/nina.markdown
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
title: NINA
|
||||
description: Instructions on how to set up NINA warnings in Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
ha_release: 2022.2
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@DeerMaximum'
|
||||
ha_domain: nina
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
---
|
||||
|
||||
The [NINA](https://www.bbk.bund.de/DE/Warnung-Vorsorge/Warn-App-NINA/warn-app-nina_node.html) integration displays warnings from the [Bundesamt für Bevölkerungsschutz und Katastrophenhilfe](https://www.bbk.bund.de/) in Germany.
|
||||
|
||||
For each county/city it creates warning slots that change to Unsafe when warnings are present. The text of the warning and the metadata are stored in the attributes of the slots.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
@ -10,6 +10,7 @@ ha_codeowners:
|
||||
ha_domain: nissan_leaf
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- sensor
|
||||
- switch
|
||||
---
|
||||
@ -18,7 +19,8 @@ The `nissan_leaf` integration offers integration with the [NissanConnect EV](htt
|
||||
|
||||
* sensors for the battery status, range and charging status
|
||||
* a switch to start and stop the climate control
|
||||
* services to request updates from the car and to request the car starts charging.
|
||||
* a button to request the car starts charging.
|
||||
* service to request updates from the car.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -31,6 +33,7 @@ nissan_leaf:
|
||||
password: "YOUR_PASSWORD"
|
||||
region: "YOUR_REGION"
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username associated with your NissanConnect EV account. Enclose in quotes.
|
||||
@ -82,12 +85,12 @@ nissan_leaf:
|
||||
|
||||
## Starting a Charge
|
||||
|
||||
You can use the `nissan_leaf.start_charge` service to send a request to the Nissan servers to start a charge. The car must be plugged in! The service requires you to provide the vehicle identification number (VIN) as a parameter. You can see the VIN on the attributes of all the entities created by this component.
|
||||
You can use the `button.press` service to send a request to the Nissan servers to start a charge. The car must be plugged in!
|
||||
|
||||
```yaml
|
||||
- service: nissan_leaf.start_charge
|
||||
data:
|
||||
vin: "1HGBH41JXMN109186" # replace
|
||||
- service: button.press
|
||||
target:
|
||||
entity_id: button.start_NICKNAME_charging # replace
|
||||
```
|
||||
|
||||
## Updating on-demand using Automation
|
||||
@ -114,7 +117,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update
|
||||
## Hints
|
||||
|
||||
* The update interval has a minimum of two minutes.
|
||||
* Requesting updates uses a small amount of power from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._
|
||||
* Requesting updates uses a small amount of energy from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._
|
||||
* This integration communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection.
|
||||
* Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute.
|
||||
* The Nissan APIs do not allow charging to be stopped remotely.
|
||||
@ -129,6 +132,8 @@ logger:
|
||||
default: critical
|
||||
logs:
|
||||
homeassistant.components.nissan_leaf: debug
|
||||
homeassistant.components.binary_sensor.nissan_leaf: debug
|
||||
homeassistant.components.button.nissan_leaf: debug
|
||||
homeassistant.components.sensor.nissan_leaf: debug
|
||||
homeassistant.components.switch.nissan_leaf: debug
|
||||
```
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user