From ebca3218c76caa46c68b98d3d7b1676b0f221fac Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 4 Jul 2019 19:08:27 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A5Removes=20linkable=5Ftitle=20everyw?= =?UTF-8?q?here=20(#9772)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Automatically create linkable headers * Visually improve position of linkable header chain icon * Do not auto link headers on homepage * Remove linkable_title everywhere * :ambulance: Re-instante linkable_title plugin as NOOP --- plugins/linkable_title.rb | 27 +- plugins/no_follow.rb | 33 - plugins/output_modder.rb | 50 ++ sass/custom/_paulus.scss | 2 +- source/_addons/check_config.markdown | 4 +- source/_addons/configurator.markdown | 6 +- source/_addons/duckdns.markdown | 6 +- source/_addons/google_assistant.markdown | 2 +- source/_addons/homematic.markdown | 6 +- source/_addons/lets_encrypt.markdown | 4 +- source/_addons/mariadb.markdown | 2 +- source/_addons/mosquitto.markdown | 10 +- source/_addons/rpc_shutdown.markdown | 2 +- source/_addons/snips.markdown | 8 +- source/_addons/tellstick.markdown | 6 +- source/_components/abode.markdown | 18 +- source/_components/acer_projector.markdown | 2 +- source/_components/adguard.markdown | 18 +- source/_components/ads.markdown | 14 +- source/_components/aftership.markdown | 8 +- source/_components/airvisual.markdown | 8 +- source/_components/aladdin_connect.markdown | 2 +- .../alarm_control_panel.ifttt.markdown | 4 +- .../alarm_control_panel.mqtt.markdown | 2 +- source/_components/alarmdecoder.markdown | 10 +- source/_components/alarmdotcom.markdown | 2 +- source/_components/alert.markdown | 10 +- .../alexa.flash_briefings.markdown | 8 +- source/_components/alexa.intent.markdown | 16 +- source/_components/alexa.markdown | 6 +- source/_components/alexa.smart_home.markdown | 22 +- source/_components/alpha_vantage.markdown | 4 +- source/_components/amazon_polly.markdown | 6 +- source/_components/ambiclimate.markdown | 2 +- source/_components/ambient_station.markdown | 4 +- source/_components/amcrest.markdown | 18 +- source/_components/ampio.markdown | 4 +- source/_components/android_ip_webcam.markdown | 16 +- source/_components/androidtv.markdown | 22 +- source/_components/anthemav.markdown | 2 +- source/_components/apcupsd.markdown | 14 +- source/_components/apns.markdown | 8 +- source/_components/apple_tv.markdown | 18 +- source/_components/aprs.markdown | 2 +- source/_components/aqualogic.markdown | 6 +- source/_components/arduino.markdown | 6 +- source/_components/arest.markdown | 6 +- source/_components/arlo.markdown | 16 +- source/_components/asterisk_mbox.markdown | 2 +- source/_components/asuswrt.markdown | 6 +- source/_components/august.markdown | 6 +- source/_components/aurora.markdown | 4 +- source/_components/automatic.markdown | 4 +- source/_components/avion.markdown | 6 +- source/_components/awair.markdown | 4 +- source/_components/aws.markdown | 16 +- source/_components/axis.markdown | 8 +- source/_components/azure_event_hub.markdown | 6 +- source/_components/baidu.markdown | 2 +- source/_components/bayesian.markdown | 4 +- source/_components/bbb_gpio.markdown | 8 +- source/_components/bbox.markdown | 6 +- source/_components/bh1750.markdown | 8 +- source/_components/binary_sensor.knx.markdown | 4 +- source/_components/binary_sensor.markdown | 2 +- .../_components/binary_sensor.modbus.markdown | 4 +- .../_components/binary_sensor.mqtt.markdown | 10 +- .../binary_sensor.mysensors.markdown | 2 +- .../_components/binary_sensor.rest.markdown | 8 +- .../_components/binary_sensor.rflink.markdown | 6 +- .../_components/binary_sensor.rfxtrx.markdown | 6 +- .../binary_sensor.template.markdown | 18 +- .../binary_sensor.xiaomi_aqara.markdown | 20 +- source/_components/blackbird.markdown | 2 +- source/_components/blink.markdown | 24 +- source/_components/blinksticklight.markdown | 4 +- source/_components/blinkt.markdown | 2 +- source/_components/bloomsky.markdown | 16 +- source/_components/bluesound.markdown | 8 +- .../_components/bluetooth_le_tracker.markdown | 2 +- source/_components/bme280.markdown | 10 +- source/_components/bme680.markdown | 12 +- .../_components/bmw_connected_drive.markdown | 16 +- source/_components/bom.markdown | 16 +- source/_components/braviatv.markdown | 4 +- source/_components/broadcast.markdown | 2 +- source/_components/broadlink.markdown | 26 +- source/_components/brottsplatskartan.markdown | 8 +- source/_components/browser.markdown | 6 +- source/_components/brunt.markdown | 2 +- source/_components/bt_smarthub.markdown | 2 +- source/_components/buienradar.markdown | 4 +- source/_components/caldav.markdown | 10 +- source/_components/calendar.google.markdown | 12 +- source/_components/camera.ffmpeg.markdown | 4 +- source/_components/camera.markdown | 20 +- source/_components/camera.mqtt.markdown | 2 +- source/_components/canary.markdown | 8 +- source/_components/cast.markdown | 2 +- source/_components/cert_expiry.markdown | 2 +- source/_components/channels.markdown | 6 +- source/_components/cisco_webex_teams.markdown | 2 +- source/_components/citybikes.markdown | 4 +- source/_components/clickatell.markdown | 4 +- source/_components/clicksend.markdown | 4 +- source/_components/climate.markdown | 40 +- source/_components/climate.modbus.markdown | 4 +- source/_components/climate.mqtt.markdown | 8 +- source/_components/climate.mysensors.markdown | 4 +- source/_components/cloudflare.markdown | 4 +- source/_components/co2signal.markdown | 6 +- source/_components/coinbase.markdown | 4 +- source/_components/command_line.markdown | 10 +- source/_components/concord232.markdown | 4 +- source/_components/config.markdown | 14 +- source/_components/conversation.markdown | 6 +- source/_components/counter.markdown | 16 +- .../_components/cover.command_line.markdown | 4 +- source/_components/cover.group.markdown | 2 +- source/_components/cover.markdown | 14 +- source/_components/cover.mqtt.markdown | 10 +- source/_components/cover.mysensors.markdown | 2 +- source/_components/cover.rflink.markdown | 6 +- source/_components/cover.rfxtrx.markdown | 8 +- source/_components/cover.template.markdown | 16 +- source/_components/cpuspeed.markdown | 2 +- source/_components/crimereports.markdown | 10 +- source/_components/daikin.markdown | 10 +- source/_components/danfoss_air.markdown | 6 +- source/_components/darksky.markdown | 8 +- source/_components/deconz.markdown | 58 +- source/_components/default_config.markdown | 2 +- source/_components/deluge.markdown | 4 +- source/_components/denon.markdown | 2 +- source/_components/device_tracker.markdown | 8 +- .../_components/device_tracker.mqtt.markdown | 4 +- .../device_tracker.mysensors.markdown | 2 +- .../device_tracker.xiaomi.markdown | 4 +- source/_components/dht.markdown | 4 +- source/_components/dialogflow.markdown | 6 +- source/_components/digital_ocean.markdown | 12 +- source/_components/digitalloggers.markdown | 2 +- source/_components/directv.markdown | 6 +- source/_components/discogs.markdown | 4 +- source/_components/discord.markdown | 6 +- source/_components/discovery.markdown | 14 +- source/_components/dispatcher.markdown | 2 +- source/_components/dlib_face_detect.markdown | 2 +- .../_components/dlib_face_identify.markdown | 2 +- source/_components/dlna_dmr.markdown | 2 +- source/_components/dnsip.markdown | 4 +- source/_components/dominos.markdown | 2 +- source/_components/doorbird.markdown | 22 +- source/_components/dovado.markdown | 6 +- source/_components/downloader.markdown | 4 +- source/_components/dsmr.markdown | 2 +- source/_components/duckdns.markdown | 2 +- source/_components/duke_energy.markdown | 4 +- .../_components/dwd_weather_warnings.markdown | 4 +- source/_components/dweet.markdown | 10 +- source/_components/dyson.markdown | 22 +- source/_components/ebox.markdown | 2 +- source/_components/ebusd.markdown | 2 +- source/_components/ecoal_boiler.markdown | 2 +- source/_components/ecobee.markdown | 64 +- source/_components/econet.markdown | 6 +- source/_components/ecovacs.markdown | 10 +- .../eddystone_temperature.markdown | 2 +- source/_components/edimax.markdown | 2 +- source/_components/edp_redy.markdown | 2 +- source/_components/ee_brightbox.markdown | 2 +- source/_components/efergy.markdown | 4 +- source/_components/egardia.markdown | 6 +- source/_components/eight_sleep.markdown | 6 +- source/_components/elkm1.markdown | 2 +- source/_components/emoncms.markdown | 6 +- source/_components/emulated_hue.markdown | 6 +- source/_components/emulated_roku.markdown | 10 +- source/_components/enocean.markdown | 18 +- source/_components/enphase_envoy.markdown | 2 +- .../entur_public_transport.markdown | 8 +- .../_components/environment_canada.markdown | 8 +- source/_components/envirophat.markdown | 4 +- source/_components/eq3btsmart.markdown | 4 +- source/_components/esphome.markdown | 2 +- source/_components/everlights.markdown | 4 +- source/_components/evohome.markdown | 4 +- source/_components/facebook.markdown | 4 +- source/_components/facebox.markdown | 8 +- source/_components/fail2ban.markdown | 20 +- source/_components/familyhub.markdown | 2 +- source/_components/fan.mqtt.markdown | 6 +- source/_components/fan.xiaomi_miio.markdown | 40 +- source/_components/fastdotcom.markdown | 8 +- source/_components/fedex.markdown | 2 +- source/_components/ffmpeg.markdown | 8 +- source/_components/ffmpeg_motion.markdown | 6 +- source/_components/ffmpeg_noise.markdown | 2 +- source/_components/fibaro.markdown | 4 +- source/_components/fido.markdown | 2 +- source/_components/file.markdown | 8 +- source/_components/filesize.markdown | 2 +- source/_components/filter.markdown | 16 +- source/_components/fints.markdown | 2 +- source/_components/fixer.markdown | 4 +- source/_components/flic.markdown | 12 +- source/_components/flock.markdown | 4 +- source/_components/flunearyou.markdown | 4 +- source/_components/flux_led.markdown | 6 +- source/_components/folder.markdown | 2 +- source/_components/folder_watcher.markdown | 2 +- source/_components/foobot.markdown | 4 +- source/_components/foscam.markdown | 4 +- source/_components/foursquare.markdown | 4 +- source/_components/freebox.markdown | 14 +- source/_components/freedns.markdown | 4 +- source/_components/fritz.markdown | 4 +- source/_components/fritzbox.markdown | 12 +- .../_components/fritzbox_callmonitor.markdown | 12 +- source/_components/frontend.markdown | 10 +- source/_components/frontier_silicon.markdown | 2 +- source/_components/futurenow.markdown | 4 +- source/_components/garadget.markdown | 4 +- source/_components/gc100.markdown | 6 +- source/_components/gearbest.markdown | 2 +- source/_components/geizhals.markdown | 2 +- source/_components/generic.markdown | 14 +- source/_components/geniushub.markdown | 14 +- source/_components/geo_json_events.markdown | 6 +- source/_components/geo_location.markdown | 4 +- source/_components/geo_rss_events.markdown | 4 +- source/_components/geofency.markdown | 4 +- source/_components/github.markdown | 4 +- source/_components/gitlab_ci.markdown | 4 +- source/_components/gitter.markdown | 2 +- source/_components/glances.markdown | 4 +- source/_components/gogogate2.markdown | 2 +- source/_components/google_assistant.markdown | 26 +- source/_components/google_cloud.markdown | 12 +- source/_components/google_domains.markdown | 2 +- source/_components/google_maps.markdown | 2 +- source/_components/google_pubsub.markdown | 6 +- source/_components/google_translate.markdown | 4 +- .../_components/google_travel_time.markdown | 10 +- source/_components/googlehome.markdown | 6 +- source/_components/gpsd.markdown | 4 +- source/_components/gpslogger.markdown | 4 +- source/_components/group.markdown | 8 +- source/_components/gstreamer.markdown | 8 +- source/_components/habitica.markdown | 2 +- source/_components/hangouts.markdown | 26 +- source/_components/harmony.markdown | 16 +- source/_components/haveibeenpwned.markdown | 4 +- source/_components/hdmi_cec.markdown | 32 +- source/_components/heos.markdown | 26 +- source/_components/hikvision.markdown | 6 +- source/_components/hipchat.markdown | 2 +- source/_components/history.markdown | 6 +- source/_components/history_graph.markdown | 2 +- source/_components/history_stats.markdown | 10 +- source/_components/hive.markdown | 10 +- source/_components/homekit.markdown | 66 +- source/_components/homematic.markdown | 28 +- source/_components/homematicip_cloud.markdown | 6 +- source/_components/homeworks.markdown | 2 +- source/_components/honeywell.markdown | 6 +- source/_components/hook.markdown | 2 +- source/_components/horizon.markdown | 2 +- source/_components/hp_ilo.markdown | 8 +- source/_components/html5.markdown | 40 +- source/_components/http.markdown | 18 +- source/_components/htu21d.markdown | 8 +- source/_components/huawei_lte.markdown | 10 +- source/_components/huawei_router.markdown | 2 +- source/_components/hue.markdown | 12 +- source/_components/hydrawise.markdown | 10 +- source/_components/hyperion.markdown | 4 +- source/_components/ialarm.markdown | 2 +- source/_components/idteck_prox.markdown | 2 +- source/_components/ifttt.markdown | 16 +- source/_components/ign_sismologia.markdown | 6 +- source/_components/ihc.markdown | 14 +- source/_components/image_processing.markdown | 6 +- source/_components/imap.markdown | 6 +- .../_components/imap_email_content.markdown | 4 +- source/_components/incomfort.markdown | 2 +- source/_components/influxdb.markdown | 12 +- source/_components/input_boolean.markdown | 4 +- source/_components/input_datetime.markdown | 8 +- source/_components/input_number.markdown | 4 +- source/_components/input_select.markdown | 8 +- source/_components/input_text.markdown | 6 +- source/_components/insteon.markdown | 18 +- source/_components/integration.markdown | 4 +- source/_components/iota.markdown | 2 +- source/_components/iperf3.markdown | 10 +- source/_components/ipma.markdown | 2 +- source/_components/iqvia.markdown | 6 +- .../_components/islamic_prayer_times.markdown | 2 +- source/_components/iss.markdown | 4 +- source/_components/isy994.markdown | 10 +- source/_components/itunes.markdown | 2 +- source/_components/jewish_calendar.markdown | 6 +- source/_components/juicenet.markdown | 6 +- source/_components/kankun.markdown | 2 +- source/_components/keyboard.markdown | 4 +- source/_components/keyboard_remote.markdown | 4 +- source/_components/kira.markdown | 8 +- source/_components/kiwi.markdown | 2 +- source/_components/knx.markdown | 8 +- source/_components/kodi.markdown | 22 +- source/_components/konnected.markdown | 16 +- source/_components/lacrosse.markdown | 8 +- source/_components/lametric.markdown | 12 +- source/_components/lannouncer.markdown | 4 +- source/_components/lastfm.markdown | 4 +- source/_components/launch_library.markdown | 2 +- source/_components/lcn.markdown | 58 +- source/_components/lg_soundbar.markdown | 2 +- source/_components/life360.markdown | 24 +- source/_components/lifx.markdown | 14 +- source/_components/light.group.markdown | 2 +- source/_components/light.knx.markdown | 4 +- source/_components/light.markdown | 8 +- source/_components/light.mqtt.markdown | 46 +- source/_components/light.mysensors.markdown | 4 +- source/_components/light.rflink.markdown | 10 +- source/_components/light.template.markdown | 10 +- source/_components/light.xiaomi_miio.markdown | 18 +- source/_components/limitlessled.markdown | 8 +- source/_components/linksys_ap.markdown | 4 +- source/_components/linksys_smart.markdown | 4 +- source/_components/linky.markdown | 2 +- source/_components/linode.markdown | 8 +- source/_components/lirc.markdown | 8 +- source/_components/liveboxplaytv.markdown | 4 +- source/_components/local_file.markdown | 4 +- source/_components/lock.markdown | 12 +- source/_components/lock.mqtt.markdown | 6 +- source/_components/lock.template.markdown | 12 +- source/_components/lockitron.markdown | 4 +- source/_components/logbook.markdown | 4 +- source/_components/logger.markdown | 8 +- source/_components/logi_circle.markdown | 16 +- source/_components/luftdaten.markdown | 10 +- source/_components/lupusec.markdown | 2 +- source/_components/lutron.markdown | 6 +- source/_components/lutron_caseta.markdown | 8 +- source/_components/lw12wifi.markdown | 2 +- source/_components/magicseaweed.markdown | 4 +- source/_components/mailgun.markdown | 8 +- source/_components/manual.markdown | 8 +- source/_components/manual_mqtt.markdown | 6 +- source/_components/marytts.markdown | 4 +- source/_components/mastodon.markdown | 4 +- source/_components/matrix.markdown | 8 +- source/_components/maxcube.markdown | 4 +- source/_components/mcp23017.markdown | 8 +- source/_components/media_extractor.markdown | 2 +- source/_components/media_player.markdown | 18 +- source/_components/mediaroom.markdown | 8 +- source/_components/melissa.markdown | 2 +- source/_components/meraki.markdown | 4 +- source/_components/message_bird.markdown | 8 +- source/_components/met.markdown | 2 +- source/_components/meteo_france.markdown | 10 +- source/_components/meteoalarm.markdown | 6 +- source/_components/metoffice.markdown | 2 +- source/_components/mfi.markdown | 4 +- source/_components/mhz19.markdown | 6 +- source/_components/microsoft.markdown | 4 +- source/_components/microsoft_face.markdown | 6 +- .../microsoft_face_detect.markdown | 2 +- .../microsoft_face_identify.markdown | 2 +- source/_components/miflora.markdown | 8 +- source/_components/mikrotik.markdown | 8 +- source/_components/mill.markdown | 4 +- source/_components/min_max.markdown | 2 +- source/_components/mitemp_bt.markdown | 6 +- source/_components/mjpeg.markdown | 4 +- source/_components/mobile_app.markdown | 2 +- source/_components/mochad.markdown | 8 +- source/_components/modbus.markdown | 14 +- source/_components/modem_callerid.markdown | 6 +- source/_components/mold_indicator.markdown | 4 +- source/_components/monoprice.markdown | 4 +- source/_components/moon.markdown | 2 +- source/_components/mopar.markdown | 6 +- source/_components/mqtt.markdown | 2 +- source/_components/mqtt_eventstream.markdown | 4 +- source/_components/mqtt_json.markdown | 4 +- source/_components/mqtt_room.markdown | 6 +- source/_components/mqtt_statestream.markdown | 6 +- source/_components/mvglive.markdown | 6 +- source/_components/mychevy.markdown | 4 +- source/_components/mycroft.markdown | 2 +- source/_components/myq.markdown | 2 +- source/_components/mysensors.markdown | 12 +- source/_components/mystrom.markdown | 12 +- source/_components/mythicbeastsdns.markdown | 2 +- source/_components/n26.markdown | 2 +- source/_components/namecheapdns.markdown | 2 +- source/_components/nanoleaf.markdown | 4 +- source/_components/neato.markdown | 12 +- source/_components/nello.markdown | 6 +- source/_components/ness_alarm.markdown | 10 +- source/_components/nest.markdown | 28 +- source/_components/netatmo.markdown | 28 +- source/_components/netdata.markdown | 6 +- source/_components/netgear_lte.markdown | 16 +- source/_components/nfandroidtv.markdown | 2 +- source/_components/niko_home_control.markdown | 2 +- source/_components/nilu.markdown | 16 +- source/_components/nissan_leaf.markdown | 10 +- source/_components/nmap_tracker.markdown | 4 +- source/_components/nmbs.markdown | 2 +- source/_components/noaa_tides.markdown | 4 +- source/_components/notify.group.markdown | 4 +- source/_components/notify.knx.markdown | 2 +- source/_components/notify.markdown | 4 +- source/_components/notify.mysensors.markdown | 4 +- source/_components/nsw_fuel_station.markdown | 4 +- .../nsw_rural_fire_service_feed.markdown | 6 +- source/_components/nuheat.markdown | 30 +- source/_components/nuki.markdown | 6 +- source/_components/nut.markdown | 6 +- source/_components/nx584.markdown | 6 +- source/_components/oasa_telematics.markdown | 4 +- source/_components/octoprint.markdown | 6 +- source/_components/ohmconnect.markdown | 2 +- source/_components/onewire.markdown | 10 +- source/_components/onkyo.markdown | 8 +- source/_components/onvif.markdown | 4 +- source/_components/openalpr_cloud.markdown | 2 +- source/_components/openalpr_local.markdown | 4 +- source/_components/opencv.markdown | 2 +- source/_components/openevse.markdown | 2 +- source/_components/opengarage.markdown | 2 +- .../_components/openhardwaremonitor.markdown | 4 +- source/_components/opensensemap.markdown | 4 +- source/_components/opensky.markdown | 4 +- source/_components/opentherm_gw.markdown | 28 +- source/_components/openuv.markdown | 12 +- source/_components/openweathermap.markdown | 4 +- source/_components/openwrt.markdown | 2 +- source/_components/orangepi_gpio.markdown | 8 +- source/_components/otp.markdown | 2 +- source/_components/owlet.markdown | 6 +- source/_components/owntracks.markdown | 18 +- source/_components/panasonic_bluray.markdown | 2 +- source/_components/panasonic_viera.markdown | 2 +- source/_components/pandora.markdown | 4 +- source/_components/pencom.markdown | 2 +- .../persistent_notification.markdown | 6 +- source/_components/person.markdown | 4 +- source/_components/pi_hole.markdown | 4 +- source/_components/picotts.markdown | 4 +- source/_components/piglow.markdown | 2 +- source/_components/pilight.markdown | 16 +- source/_components/ping.markdown | 6 +- source/_components/pjlink.markdown | 2 +- source/_components/plaato.markdown | 2 +- source/_components/plant.markdown | 4 +- source/_components/plex.markdown | 10 +- source/_components/plum_lightpad.markdown | 2 +- source/_components/pocketcasts.markdown | 2 +- source/_components/point.markdown | 14 +- source/_components/polling.markdown | 2 +- source/_components/postnl.markdown | 2 +- source/_components/prezzibenzina.markdown | 6 +- source/_components/prowl.markdown | 2 +- source/_components/proxy.markdown | 4 +- source/_components/ps4.markdown | 24 +- source/_components/ptvsd.markdown | 10 +- source/_components/push.markdown | 4 +- source/_components/pushbullet.markdown | 20 +- source/_components/pushover.markdown | 2 +- source/_components/pushsafer.markdown | 2 +- source/_components/python_script.markdown | 4 +- source/_components/qbittorrent.markdown | 4 +- source/_components/qld_bushfire.markdown | 6 +- source/_components/qnap.markdown | 6 +- source/_components/qrcode.markdown | 2 +- source/_components/quantum_gateway.markdown | 2 +- source/_components/qwikswitch.markdown | 8 +- source/_components/rachio.markdown | 12 +- source/_components/radarr.markdown | 14 +- source/_components/rainbird.markdown | 6 +- source/_components/raincloud.markdown | 8 +- source/_components/rainmachine.markdown | 30 +- source/_components/random.markdown | 8 +- source/_components/raspihats.markdown | 16 +- source/_components/raspyrfm.markdown | 10 +- source/_components/recollect_waste.markdown | 2 +- source/_components/recorder.markdown | 14 +- source/_components/recswitch.markdown | 2 +- source/_components/reddit.markdown | 4 +- source/_components/rejseplanen.markdown | 8 +- source/_components/remember_the_milk.markdown | 14 +- source/_components/remote.markdown | 2 +- .../_components/remote.xiaomi_miio.markdown | 18 +- source/_components/remote_rpi_gpio.markdown | 4 +- source/_components/repetier.markdown | 4 +- source/_components/rest.markdown | 14 +- source/_components/rest_command.markdown | 2 +- source/_components/rflink.markdown | 18 +- source/_components/ring.markdown | 10 +- source/_components/ritassist.markdown | 6 +- source/_components/rmvtransport.markdown | 8 +- source/_components/rocketchat.markdown | 6 +- source/_components/roku.markdown | 6 +- source/_components/roomba.markdown | 4 +- source/_components/route53.markdown | 4 +- source/_components/rova.markdown | 4 +- source/_components/rpi_camera.markdown | 2 +- source/_components/rpi_gpio.markdown | 16 +- source/_components/rpi_gpio_pwm.markdown | 8 +- source/_components/rpi_pfio.markdown | 6 +- source/_components/rpi_rf.markdown | 2 +- source/_components/sabnzbd.markdown | 8 +- source/_components/samsungtv.markdown | 4 +- source/_components/satel_integra.markdown | 6 +- source/_components/scene.knx.markdown | 2 +- source/_components/scrape.markdown | 16 +- source/_components/script.markdown | 4 +- source/_components/scsgate.markdown | 8 +- source/_components/season.markdown | 2 +- source/_components/sendgrid.markdown | 4 +- source/_components/sense.markdown | 2 +- source/_components/sensehat.markdown | 20 +- source/_components/sensibo.markdown | 4 +- source/_components/sensor.buienradar.markdown | 6 +- .../_components/sensor.command_line.markdown | 20 +- source/_components/sensor.knx.markdown | 4 +- source/_components/sensor.markdown | 2 +- source/_components/sensor.modbus.markdown | 4 +- source/_components/sensor.mqtt.markdown | 14 +- source/_components/sensor.mysensors.markdown | 16 +- source/_components/sensor.rflink.markdown | 10 +- .../_components/sensor.websocket_api.markdown | 4 +- .../_components/sensor.xiaomi_miio.markdown | 2 +- source/_components/serial.markdown | 12 +- source/_components/serial_pm.markdown | 6 +- source/_components/sesame.markdown | 2 +- source/_components/seven_segments.markdown | 2 +- source/_components/seventeentrack.markdown | 2 +- source/_components/shiftr.markdown | 2 +- source/_components/shopping_list.markdown | 6 +- source/_components/sht31.markdown | 2 +- source/_components/sigfox.markdown | 4 +- source/_components/simulated.markdown | 4 +- source/_components/skybeacon.markdown | 2 +- source/_components/skybell.markdown | 14 +- source/_components/slack.markdown | 6 +- source/_components/sleepiq.markdown | 4 +- source/_components/sma.markdown | 2 +- source/_components/smappee.markdown | 2 +- source/_components/smartthings.markdown | 48 +- source/_components/smarty.markdown | 2 +- source/_components/smhi.markdown | 2 +- source/_components/snips.markdown | 36 +- source/_components/snmp.markdown | 12 +- source/_components/socialblade.markdown | 4 +- source/_components/solaredge.markdown | 4 +- source/_components/solaredge_local.markdown | 4 +- source/_components/solax.markdown | 4 +- source/_components/somfy.markdown | 6 +- source/_components/sonarr.markdown | 14 +- source/_components/songpal.markdown | 6 +- source/_components/sonos.markdown | 20 +- source/_components/sony_projector.markdown | 2 +- source/_components/soundtouch.markdown | 10 +- source/_components/spaceapi.markdown | 8 +- source/_components/spc.markdown | 4 +- source/_components/speedtestdotnet.markdown | 14 +- source/_components/spider.markdown | 4 +- source/_components/splunk.markdown | 2 +- source/_components/spotcrime.markdown | 8 +- source/_components/spotify.markdown | 12 +- source/_components/sql.markdown | 14 +- source/_components/squeezebox.markdown | 2 +- source/_components/srp_energy.markdown | 2 +- source/_components/ssdp.markdown | 4 +- source/_components/starlingbank.markdown | 4 +- source/_components/startca.markdown | 4 +- source/_components/statistics.markdown | 2 +- source/_components/steam_online.markdown | 6 +- source/_components/stiebel_eltron.markdown | 6 +- source/_components/stream.markdown | 10 +- source/_components/streamlabswater.markdown | 4 +- source/_components/stride.markdown | 2 +- source/_components/sun.markdown | 6 +- source/_components/supla.markdown | 2 +- .../swiss_hydrological_data.markdown | 4 +- .../_components/switch.command_line.markdown | 10 +- source/_components/switch.knx.markdown | 2 +- source/_components/switch.markdown | 2 +- source/_components/switch.modbus.markdown | 2 +- source/_components/switch.mqtt.markdown | 8 +- source/_components/switch.mysensors.markdown | 16 +- source/_components/switch.pca.markdown | 2 +- source/_components/switch.rest.markdown | 6 +- source/_components/switch.rflink.markdown | 6 +- source/_components/switch.rfxtrx.markdown | 4 +- source/_components/switch.template.markdown | 16 +- .../_components/switch.xiaomi_miio.markdown | 22 +- source/_components/switchbot.markdown | 2 +- source/_components/switcher_kis.markdown | 6 +- source/_components/switchmate.markdown | 2 +- source/_components/synology.markdown | 4 +- source/_components/synology_srm.markdown | 2 +- source/_components/synologydsm.markdown | 4 +- source/_components/system_log.markdown | 18 +- source/_components/systemmonitor.markdown | 4 +- source/_components/sytadin.markdown | 2 +- source/_components/tado.markdown | 6 +- source/_components/tahoma.markdown | 2 +- source/_components/tank_utility.markdown | 8 +- source/_components/tapsaff.markdown | 2 +- source/_components/tautulli.markdown | 6 +- source/_components/tcp.markdown | 10 +- source/_components/teksavvy.markdown | 2 +- source/_components/telegram.markdown | 14 +- source/_components/telegram_bot.markdown | 32 +- source/_components/tellduslive.markdown | 2 +- source/_components/tellstick.markdown | 14 +- source/_components/temper.markdown | 2 +- source/_components/template.markdown | 26 +- source/_components/tensorflow.markdown | 8 +- source/_components/tesla.markdown | 2 +- source/_components/tfiac.markdown | 2 +- source/_components/thermoworks_smoke.markdown | 10 +- source/_components/thethingsnetwork.markdown | 10 +- source/_components/thingspeak.markdown | 2 +- source/_components/thinkingcleaner.markdown | 4 +- source/_components/threshold.markdown | 2 +- source/_components/tibber.markdown | 14 +- source/_components/timer.markdown | 22 +- source/_components/tod.markdown | 4 +- source/_components/todoist.markdown | 10 +- source/_components/tof.markdown | 8 +- source/_components/toon.markdown | 6 +- source/_components/torque.markdown | 6 +- source/_components/totalconnect.markdown | 4 +- source/_components/tplink.markdown | 18 +- source/_components/tplink_lte.markdown | 2 +- source/_components/traccar.markdown | 2 +- source/_components/tradfri.markdown | 10 +- .../trafikverket_weatherstation.markdown | 8 +- source/_components/transmission.markdown | 6 +- source/_components/transport_nsw.markdown | 6 +- source/_components/travisci.markdown | 4 +- source/_components/trend.markdown | 6 +- source/_components/tts.markdown | 16 +- source/_components/tuya.markdown | 4 +- source/_components/twilio.markdown | 4 +- source/_components/twilio_call.markdown | 2 +- source/_components/twilio_sms.markdown | 2 +- source/_components/twitch.markdown | 4 +- source/_components/twitter.markdown | 4 +- source/_components/ubus.markdown | 6 +- source/_components/uk_transport.markdown | 2 +- source/_components/unifi.markdown | 18 +- source/_components/universal.markdown | 6 +- source/_components/upcloud.markdown | 8 +- source/_components/updater.markdown | 4 +- source/_components/upnp.markdown | 4 +- source/_components/ups.markdown | 2 +- source/_components/uptime.markdown | 4 +- source/_components/uptimerobot.markdown | 2 +- source/_components/uscis.markdown | 2 +- .../usgs_earthquakes_feed.markdown | 6 +- source/_components/usps.markdown | 14 +- source/_components/utility_meter.markdown | 16 +- source/_components/uvc.markdown | 4 +- source/_components/vacuum.markdown | 26 +- source/_components/vacuum.mqtt.markdown | 34 +- .../_components/vacuum.xiaomi_miio.markdown | 36 +- source/_components/velbus.markdown | 2 +- source/_components/velux.markdown | 2 +- source/_components/venstar.markdown | 2 +- source/_components/vera.markdown | 8 +- source/_components/verisure.markdown | 4 +- source/_components/version.markdown | 6 +- source/_components/vesync.markdown | 4 +- source/_components/vizio.markdown | 14 +- source/_components/vlc-telnet.markdown | 4 +- source/_components/vlc.markdown | 8 +- source/_components/voicerss.markdown | 4 +- source/_components/volkszaehler.markdown | 4 +- source/_components/volvooncall.markdown | 6 +- source/_components/vultr.markdown | 16 +- source/_components/w800rf32.markdown | 4 +- source/_components/wake_on_lan.markdown | 14 +- source/_components/water_heater.markdown | 16 +- source/_components/waterfurnace.markdown | 4 +- source/_components/watson_iot.markdown | 6 +- source/_components/watson_tts.markdown | 6 +- source/_components/waze_travel_time.markdown | 4 +- source/_components/weather.darksky.markdown | 2 +- source/_components/weather.markdown | 2 +- source/_components/webhooks.markdown | 4 +- source/_components/weblink.markdown | 2 +- source/_components/webostv.markdown | 16 +- source/_components/websocket_api.markdown | 4 +- source/_components/wemo.markdown | 10 +- source/_components/whois.markdown | 2 +- source/_components/wink.markdown | 86 +-- source/_components/wirelesstag.markdown | 8 +- source/_components/workday.markdown | 8 +- source/_components/worldclock.markdown | 2 +- source/_components/worldtidesinfo.markdown | 4 +- source/_components/wsdot.markdown | 4 +- source/_components/wunderground.markdown | 16 +- source/_components/wunderlist.markdown | 6 +- source/_components/xeoma.markdown | 4 +- source/_components/xfinity.markdown | 2 +- source/_components/xiaomi.markdown | 6 +- source/_components/xiaomi_aqara.markdown | 34 +- source/_components/xmpp.markdown | 10 +- source/_components/xs1.markdown | 14 +- source/_components/yale_smart_alarm.markdown | 4 +- source/_components/yamaha.markdown | 10 +- source/_components/yamaha_musiccast.markdown | 4 +- source/_components/yandextts.markdown | 4 +- source/_components/yeelight.markdown | 24 +- source/_components/yi.markdown | 10 +- source/_components/zabbix.markdown | 6 +- source/_components/zamg.markdown | 4 +- source/_components/zengge.markdown | 2 +- source/_components/zeroconf.markdown | 2 +- source/_components/zestimate.markdown | 4 +- source/_components/zha.markdown | 10 +- source/_components/zigbee.markdown | 20 +- source/_components/ziggo_mediabox_xl.markdown | 2 +- source/_components/zone.markdown | 6 +- source/_components/zoneminder.markdown | 16 +- source/_components/zwave.markdown | 12 +- .../_cookbook/automation_first_light.markdown | 6 +- .../automation_flashing_lights.markdown | 2 +- source/_cookbook/automation_sun.markdown | 8 +- ...n_using_timeinterval_inputboolean.markdown | 2 +- .../dim_lights_when_playing_media.markdown | 4 +- source/_cookbook/fail2ban.markdown | 8 +- source/_cookbook/ifttt.manything.markdown | 4 +- source/_cookbook/notify.mqtt.markdown | 6 +- ...ha_if_wemo_switch_is_not_detected.markdown | 2 +- source/_cookbook/sonos_say.markdown | 2 +- source/_cookbook/track_battery_level.markdown | 4 +- ...r_10_minutes_when_motion_detected.markdown | 2 +- source/_docs/asterisk_mbox.markdown | 4 +- source/_docs/authentication.markdown | 24 +- .../authentication/multi-factor-auth.markdown | 12 +- .../_docs/authentication/providers.markdown | 16 +- source/_docs/automation.markdown | 6 +- source/_docs/automation/editor.markdown | 4 +- source/_docs/automation/templating.markdown | 26 +- source/_docs/automation/trigger.markdown | 30 +- source/_docs/autostart/init.d.markdown | 18 +- source/_docs/autostart/systemd.markdown | 8 +- source/_docs/backend/database.markdown | 6 +- source/_docs/configuration.markdown | 4 +- .../customizing-devices.markdown | 14 +- source/_docs/configuration/devices.markdown | 6 +- source/_docs/configuration/events.markdown | 18 +- .../configuration/group_visibility.markdown | 8 +- source/_docs/configuration/packages.markdown | 4 +- .../configuration/platform_options.markdown | 4 +- source/_docs/configuration/secrets.markdown | 6 +- source/_docs/configuration/securing.markdown | 8 +- .../splitting_configuration.markdown | 12 +- .../_docs/configuration/templating.markdown | 34 +- .../configuration/troubleshooting.markdown | 12 +- source/_docs/configuration/yaml.markdown | 10 +- source/_docs/ecosystem/apache.markdown | 6 +- source/_docs/ecosystem/appdaemon/api.markdown | 712 +++++++++--------- .../ecosystem/appdaemon/running.markdown | 6 +- .../ecosystem/appdaemon/tutorial.markdown | 6 +- .../ecosystem/appdaemon/windows.markdown | 2 +- .../ecosystem/backup/backup_dropbox.markdown | 8 +- .../ecosystem/backup/backup_github.markdown | 18 +- .../ecosystem/backup/backup_usb.markdown | 12 +- source/_docs/ecosystem/caddy.markdown | 12 +- .../certificates/lets_encrypt.markdown | 20 +- .../tls_domain_certificate.markdown | 8 +- source/_docs/ecosystem/haproxy.markdown | 12 +- .../ecosystem/hass-configurator.markdown | 14 +- source/_docs/ecosystem/ios.markdown | 8 +- source/_docs/ecosystem/ios/location.markdown | 4 +- .../ios/notifications/actions.markdown | 12 +- .../ios/notifications/basic.markdown | 4 +- .../privacy_security_rate_limits.markdown | 6 +- .../ios/notifications/sounds.markdown | 4 +- source/_docs/ecosystem/nginx.markdown | 24 +- .../_docs/ecosystem/nginx_subdomain.markdown | 6 +- source/_docs/ecosystem/scenegen.markdown | 18 +- source/_docs/ecosystem/synology.markdown | 6 +- source/_docs/ecosystem/tor.markdown | 8 +- source/_docs/frontend/browsers.markdown | 10 +- source/_docs/frontend/mobile.markdown | 4 +- source/_docs/installation.markdown | 10 +- source/_docs/installation/centos.markdown | 6 +- source/_docs/installation/docker.markdown | 22 +- source/_docs/installation/hassbian.markdown | 2 +- .../hassbian/common-tasks.markdown | 16 +- .../hassbian/customization.markdown | 4 +- .../hassbian/installation.markdown | 16 +- .../hassbian/integrations.markdown | 8 +- .../installation/hassbian/upgrading.markdown | 2 +- .../_docs/installation/raspberry-pi.markdown | 10 +- .../installation/troubleshooting.markdown | 14 +- source/_docs/installation/updating.markdown | 8 +- source/_docs/installation/vagrant.markdown | 18 +- source/_docs/installation/virtualenv.markdown | 14 +- source/_docs/installation/windows.markdown | 6 +- source/_docs/mqtt.markdown | 2 +- source/_docs/mqtt/broker.markdown | 12 +- source/_docs/mqtt/discovery.markdown | 4 +- source/_docs/mqtt/service.markdown | 2 +- source/_docs/quality_scale.markdown | 10 +- source/_docs/scripts.markdown | 12 +- source/_docs/scripts/conditions.markdown | 26 +- source/_docs/scripts/editor.markdown | 2 +- source/_docs/scripts/service-calls.markdown | 12 +- source/_docs/security.markdown | 10 +- source/_docs/security/porosity.markdown | 6 +- source/_docs/tools/dev-tools.markdown | 12 +- source/_docs/z-wave.markdown | 10 +- source/_docs/z-wave/adding.markdown | 12 +- source/_docs/z-wave/control-panel.markdown | 20 +- source/_docs/z-wave/controllers.markdown | 10 +- source/_docs/z-wave/device-specific.markdown | 42 +- source/_docs/z-wave/devices.markdown | 18 +- source/_docs/z-wave/entities.markdown | 34 +- source/_docs/z-wave/events.markdown | 14 +- source/_docs/z-wave/installation.markdown | 36 +- source/_layouts/default.html | 7 +- source/_lovelace/alarm-panel.markdown | 2 +- source/_lovelace/conditional.markdown | 2 +- source/_lovelace/entities.markdown | 14 +- source/_lovelace/entity-button.markdown | 2 +- source/_lovelace/entity-filter.markdown | 2 +- source/_lovelace/gauge.markdown | 2 +- source/_lovelace/glance.markdown | 4 +- source/_lovelace/history-graph.markdown | 4 +- source/_lovelace/horizontal-stack.markdown | 2 +- source/_lovelace/iframe.markdown | 2 +- source/_lovelace/light.markdown | 2 +- source/_lovelace/map.markdown | 2 +- source/_lovelace/markdown.markdown | 2 +- source/_lovelace/media-control.markdown | 2 +- source/_lovelace/picture-elements.markdown | 32 +- source/_lovelace/picture-entity.markdown | 2 +- source/_lovelace/picture-glance.markdown | 4 +- source/_lovelace/picture.markdown | 2 +- source/_lovelace/plant-status.markdown | 2 +- source/_lovelace/sensor.markdown | 2 +- source/_lovelace/shopping-list.markdown | 2 +- source/_lovelace/thermostat.markdown | 2 +- source/_lovelace/vertical-stack.markdown | 2 +- source/_lovelace/weather-forecast.markdown | 2 +- ...015-05-09-utc-time-zone-awareness.markdown | 2 +- ...mped-ui-and-improved-distribution.markdown | 4 +- ...s-to-use-mqtt-with-home-assistant.markdown | 6 +- ...-09-13-home-assistant-meets-ifttt.markdown | 10 +- ...e-with-esp8266-and-report-to-mqtt.markdown | 12 +- ...tup-encryption-using-lets-encrypt.markdown | 8 +- ...016-01-19-perfect-home-automation.markdown | 10 +- ...9-insteon-lifx-twitter-and-zigbee.markdown | 2 +- ...lassifying-the-internet-of-things.markdown | 24 +- .../2016-02-20-community-highlights.markdown | 8 +- ...ng-presence-detection-work-better.markdown | 18 +- source/_posts/2016-05-21-release-020.markdown | 2 +- ...hat-cant-track-themselves-part-ii.markdown | 10 +- .../2016-06-01-community-highlights.markdown | 4 +- ...-home-hub-5-and-local-file-camera.markdown | 4 +- ...matic-hdmi-cec-and-sony-bravia-tv.markdown | 6 +- ...16-sqlalchemy-knx-join-simplisafe.markdown | 4 +- ...xploration-with-jupyter-notebooks.markdown | 8 +- ...anels--jupyter-notebooks--directv.markdown | 6 +- ...the-home-assistant-mobile-web-app.markdown | 26 +- ...3-foursquare-fast-com-ffmpeg-gpsd.markdown | 8 +- .../2016-08-16-we-have-apps-now.markdown | 8 +- ...otifications-hue-fake-unification.markdown | 38 +- ...-31-esp8266-and-micropython-part2.markdown | 2 +- ...10-notify-group-reload-api-pihole.markdown | 20 +- ...9-29-async-sleepiq-emoncms-stocks.markdown | 28 +- ...10-01-we-have-raspberry-image-now.markdown | 2 +- ...10-08-hassbian-rest-digital-ocean.markdown | 18 +- ...sh-briefing-updater-hacktoberfest.markdown | 22 +- ...2016-10-24-explaining-the-updater.markdown | 12 +- ...05-hacktoberfest-influxdb-weather.markdown | 24 +- ...ndar--wink-thermostats--cisco-ios.markdown | 14 +- ...16-12-03-remote-websockets-sonarr.markdown | 26 +- ...-text-to-speech-aquostv-flic-zamg.markdown | 18 +- ...17-01-14-iss-usps-images-packages.markdown | 20 +- ...7-01-21-home-assistant-governance.markdown | 28 +- .../2017-01-28-face-coffee-wink.markdown | 26 +- .../2017-02-03-hassbian-toybox.markdown | 6 +- source/_posts/2017-02-04-babyphone.markdown | 6 +- ...02-11-alert-appletv-mqtt-yeelight.markdown | 34 +- ...onfig-panel-and-state-restoration.markdown | 6 +- ...se-any-android-phone-as-ip-camera.markdown | 4 +- .../2017-03-28-http-to-mqtt-bridge.markdown | 8 +- .../2017-04-01-thomas-krenn-award.markdown | 2 +- ...s--lockitron-locks--total-connect.markdown | 8 +- ...fri-internet-of-things-done-right.markdown | 20 +- .../2017-04-22-ikea-tradfri--spotify.markdown | 10 +- ...4-30-hassbian-1.21-its-about-time.markdown | 4 +- .../2017-05-06-zigbee-opencv-dlib.markdown | 14 +- ...automation-editor-zwave-panel-ocr.markdown | 12 +- source/_posts/2017-06-04-release-46.markdown | 12 +- source/_posts/2017-06-17-release-47.markdown | 20 +- source/_posts/2017-07-02-release-48.markdown | 16 +- ...me-assistant-is-moving-to-discord.markdown | 22 +- source/_posts/2017-07-16-release-49.markdown | 16 +- .../2017-07-25-introducing-hassio.markdown | 12 +- source/_posts/2017-07-29-release-50.markdown | 22 +- source/_posts/2017-08-12-release-51.markdown | 20 +- .../_posts/2017-08-26-release-0-52.markdown | 6 +- source/_posts/2017-09-09-release-53.markdown | 20 +- ...6-hassbian-1.3-a-bit-of-a-stretch.markdown | 4 +- source/_posts/2017-09-23-release-54.markdown | 10 +- ...017-09-25-new-hassio-build-system.markdown | 4 +- source/_posts/2017-10-07-release-55.markdown | 22 +- source/_posts/2017-10-21-release-56.markdown | 22 +- source/_posts/2017-10-28-demo.markdown | 6 +- source/_posts/2017-11-04-release-57.markdown | 26 +- .../2017-11-05-frontend-translations.markdown | 2 +- .../_posts/2017-11-10-ttn-with-mqtt.markdown | 8 +- source/_posts/2017-11-12-tor.markdown | 8 +- source/_posts/2017-11-18-release-58.markdown | 18 +- source/_posts/2017-12-03-release-59.markdown | 24 +- ...-introducing-home-assistant-cloud.markdown | 22 +- source/_posts/2017-12-17-release-60.markdown | 20 +- source/_posts/2018-01-14-release-61.markdown | 18 +- source/_posts/2018-01-27-release-62.markdown | 6 +- source/_posts/2018-02-10-release-63.markdown | 20 +- source/_posts/2018-02-26-release-64.markdown | 26 +- source/_posts/2018-03-09-release-65.markdown | 32 +- source/_posts/2018-03-30-release-66.markdown | 6 +- source/_posts/2018-04-14-release-67.markdown | 12 +- source/_posts/2018-04-22-hassio-2018.markdown | 12 +- source/_posts/2018-04-27-release-68.markdown | 16 +- source/_posts/2018-05-11-release-69.markdown | 14 +- source/_posts/2018-05-18-release-70.markdown | 16 +- source/_posts/2018-06-04-esphomelib.markdown | 6 +- source/_posts/2018-06-10-release-71.markdown | 14 +- source/_posts/2018-06-22-release-72.markdown | 14 +- source/_posts/2018-07-06-release-73.markdown | 12 +- .../_posts/2018-07-11-hassio-images.markdown | 6 +- source/_posts/2018-07-21-release-74.markdown | 14 +- source/_posts/2018-08-03-release-75.markdown | 18 +- source/_posts/2018-08-17-release-76.markdown | 18 +- source/_posts/2018-08-29-release-77.markdown | 22 +- source/_posts/2018-09-15-release-78.markdown | 18 +- .../_posts/2018-09-17-thinking-big.markdown | 20 +- .../_posts/2018-09-30-hacktoberfest.markdown | 16 +- source/_posts/2018-10-01-release-79.markdown | 18 +- source/_posts/2018-10-12-release-80.markdown | 20 +- source/_posts/2018-10-29-release-81.markdown | 24 +- source/_posts/2018-11-08-release-82.markdown | 14 +- source/_posts/2018-11-28-release-83.markdown | 18 +- source/_posts/2018-12-12-release-84.markdown | 32 +- ...ogitech-harmony-removes-local-api.markdown | 2 +- source/_posts/2019-01-09-release-85.markdown | 14 +- .../2019-01-23-lovelace-released.markdown | 8 +- source/_posts/2019-01-23-release-86.markdown | 24 +- source/_posts/2019-02-06-release-87.markdown | 16 +- source/_posts/2019-02-20-release-88.markdown | 20 +- source/_posts/2019-03-13-release-89.markdown | 18 +- source/_posts/2019-03-20-release-90.markdown | 26 +- source/_posts/2019-04-03-release-91.markdown | 30 +- .../_posts/2019-04-15-hassio-ingress.markdown | 10 +- source/_posts/2019-04-24-release-92.markdown | 22 +- .../2019-05-03-update-from-the-field.markdown | 4 +- .../2019-05-08-nest-data-bye-bye.markdown | 2 +- source/_posts/2019-05-16-release-93.markdown | 22 +- source/_posts/2019-06-05-release-94.markdown | 30 +- source/_posts/2019-06-26-release-95.markdown | 34 +- source/addons/index.html | 4 +- source/code_of_conduct/index.markdown | 14 +- source/cookbook/index.markdown | 2 +- source/developers/credits.markdown | 4 +- source/faq/index.markdown | 4 +- source/getting-started/configuration.markdown | 2 +- source/getting-started/index.markdown | 6 +- .../presence-detection.markdown | 4 +- source/hassio/commandline.markdown | 12 +- source/hassio/enable_i2c.markdown | 8 +- source/hassio/index.markdown | 2 +- source/hassio/installation.markdown | 14 +- .../installing_third_party_addons.markdown | 2 +- source/hassio/zwave.markdown | 10 +- source/help/index.markdown | 8 +- source/help/reporting_issues.markdown | 16 +- source/help/trivia.markdown | 14 +- source/lovelace/changelog.markdown | 42 +- source/lovelace/index.markdown | 4 +- source/lovelace/views.markdown | 20 +- source/privacy/index.markdown | 20 +- source/tos/index.markdown | 36 +- 1002 files changed, 4820 insertions(+), 4801 deletions(-) delete mode 100644 plugins/no_follow.rb create mode 100644 plugins/output_modder.rb diff --git a/plugins/linkable_title.rb b/plugins/linkable_title.rb index 7a5ba4c2b0f7..06e9c2bbaf91 100644 --- a/plugins/linkable_title.rb +++ b/plugins/linkable_title.rb @@ -1,16 +1,15 @@ -module Jekyll - class LinkableTitleTag < Liquid::Tag - def initialize(tag_name, text, token) - super - @title = text - end +module Jekyll + class LinkableTitleTag < Liquid::Tag + def initialize(tag_name, text, token) + super + @title = text + end - def render(context) - title = Liquid::Template.parse(@title).render context - slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '') - " #{title}" - end - end -end + def render(context) + title = Liquid::Template.parse(@title).render context + "#{title}" + end + end +end -Liquid::Template.register_tag('linkable_title', Jekyll::LinkableTitleTag) + Liquid::Template.register_tag('linkable_title', Jekyll::LinkableTitleTag) \ No newline at end of file diff --git a/plugins/no_follow.rb b/plugins/no_follow.rb deleted file mode 100644 index 27da6c90f25a..000000000000 --- a/plugins/no_follow.rb +++ /dev/null @@ -1,33 +0,0 @@ -# Jekyll Auto Nofollow Plugin -# Automatically adds rel='external nofollow' to outgoing links. - -require 'jekyll' -require 'nokogiri' - -module Jekyll - module NoFollow - def nofollow(content) - dom = Nokogiri::HTML.fragment(content) - - # Find all links - dom.css('a').each do |link| - rel = ['external', 'nofollow'] - - # All external links start with 'http', skip when this one does not - next unless link.get_attribute('href') =~ /\Ahttp/i - - # Play nice with our own links - next if link.get_attribute('href') =~ /\Ahttps?:\/\/\w*.?home-assistant.io/i - - # Play nice with links that already have a rel attribute set - rel.unshift(link.get_attribute('rel')) - - # Add rel attribute to link - link.set_attribute('rel', rel.join(' ').strip) - end - dom.to_s - end - end -end - -Liquid::Template.register_filter(Jekyll::NoFollow) diff --git a/plugins/output_modder.rb b/plugins/output_modder.rb new file mode 100644 index 000000000000..a515f9629f63 --- /dev/null +++ b/plugins/output_modder.rb @@ -0,0 +1,50 @@ +# Jekyll Out Modder - Allows for mangling/modding the HTML output +# +# This is combined in a single plugin/filter to reduce the NokoGiri dom +# parsing to just once per page/content. +# +# - Automatically adds rel='external nofollow' to outgoing links. +# - Automatically make headers linkable +# +require 'jekyll' +require 'nokogiri' + +module Jekyll + module OutputModder + def output_modder(content) + dom = Nokogiri::HTML.fragment(content) + + # Find all links, make all external links rel='external nofollow' + dom.css('a').each do |link| + rel = ['external', 'nofollow'] + + # All external links start with 'http', skip when this one does not + next unless link.get_attribute('href') =~ /\Ahttp/i + + # Play nice with our own links + next if link.get_attribute('href') =~ /\Ahttps?:\/\/\w*.?home-assistant.io/i + + # Play nice with links that already have a rel attribute set + rel.unshift(link.get_attribute('rel')) + + # Add rel attribute to link + link.set_attribute('rel', rel.join(' ').strip) + end + + # Find all headers, make them linkable + dom.css('h2,h3,h4,h5,h6,h7,h8').each do |header| + + # Skip linked headers + next if header.at_css('a') + + title = header.content + slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '') + header.children = " #{title}" + end + + dom.to_s + end + end +end + +Liquid::Template.register_filter(Jekyll::OutputModder) diff --git a/sass/custom/_paulus.scss b/sass/custom/_paulus.scss index af314eff8b9c..1281efeb3f1f 100644 --- a/sass/custom/_paulus.scss +++ b/sass/custom/_paulus.scss @@ -210,7 +210,7 @@ dt:hover a.title-link { &::before { position: absolute; - top: 2px; + top: 5px; left: -25px; padding-right: 40px; font-family: "FontAwesome"; diff --git a/source/_addons/check_config.markdown b/source/_addons/check_config.markdown index 9ae856d22a3f..350c2c4a6f32 100644 --- a/source/_addons/check_config.markdown +++ b/source/_addons/check_config.markdown @@ -11,7 +11,7 @@ footer: true You can use this add-on to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This add-on will help you avoid errors due to breaking changes, resulting in a smooth update. -### {% linkable_title How to use this add-on %} +### How to use this add-on 1. Just start the add-on. 2. Wait (On a Raspberry Pi it can take several minutes). @@ -19,7 +19,7 @@ You can use this add-on to check whether your configuration files are valid agai If you get errors, then you should look for **Breaking Changes** against the version you specified for this add-on and change your configuration accordingly. -### {% linkable_title Add-on configuration %} +### Add-on configuration ```json { diff --git a/source/_addons/configurator.markdown b/source/_addons/configurator.markdown index 42bf968290c5..fbfb8cb1bb55 100644 --- a/source/_addons/configurator.markdown +++ b/source/_addons/configurator.markdown @@ -20,7 +20,7 @@ More information and a standalone version for regular Home Assistant installatio Screenshot of the HASS Configurator.

-### {% linkable_title Feature list %} +### Feature list - Web-based editor to modify your files with syntax highlighting and YAML linting. - Upload and download files. @@ -32,7 +32,7 @@ Screenshot of the HASS Configurator. - Editor settings are saved in your browser. - And much more... -### {% linkable_title Add-on Configuration %} +### Add-on Configuration ```json { @@ -54,6 +54,6 @@ enforce_basepath: default: false {% endconfiguration %} -### {% linkable_title Old port based Access %} +### Old port based Access You can set a network Port and the Add-on listens on that Port with Home Assistant user credential. That is as a backup if you are not able to connect to Home Assistant anymore. Today, you can restart Home Assistant with broken config, but maybe some times usefully. diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index 9a63a87dbd21..3bc8ec8fdcf0 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -49,7 +49,7 @@ seconds: type: integer {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use the generated certificate: @@ -62,7 +62,7 @@ http: If you use a port other than `8123` or an SSL proxy, change the port number accordingly. -## {% linkable_title Router configuration %} +## Router configuration You'll need to forward the port you listed in your configuration (8123 in the example above) on your router to your Home Assistant system. You can find guides on how to do this on [Port Forward](https://portforward.com/). Noting that you'll only need to forward the TCP port. @@ -70,7 +70,7 @@ Ensure that you allocate the Home Assistant system a fixed IP on your network be Restart Home Assistant for the configured changes to take effect. When you access the Home Assistant frontend you will now need to use `https`, even when accessing local instances, for example at `https://192.168.0.1:8123`. -## {% linkable_title Generate Let's Encrypt certificate for Duck DNS sub sub domains %} +## Generate Let's Encrypt certificate for Duck DNS sub sub domains To generate certificates for nr.my-domain.duckdns.org update the domain JSON settings to: diff --git a/source/_addons/google_assistant.markdown b/source/_addons/google_assistant.markdown index 9bb978212feb..367161be274d 100644 --- a/source/_addons/google_assistant.markdown +++ b/source/_addons/google_assistant.markdown @@ -79,7 +79,7 @@ speaker: type: string {% endconfiguration %} -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration Use the Home Assistant [DialogFlow component][comp] to integrate the add-on into Home Assistant. diff --git a/source/_addons/homematic.markdown b/source/_addons/homematic.markdown index b3b23f25d3cd..41bd73522531 100644 --- a/source/_addons/homematic.markdown +++ b/source/_addons/homematic.markdown @@ -103,7 +103,7 @@ hmip: type: string {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use it: @@ -121,7 +121,7 @@ homematic: port: 2010 ``` -## {% linkable_title Raspberry Pi3 %} +## Raspberry Pi3 With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partition: @@ -129,6 +129,6 @@ With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partit dtoverlay=pi3-miniuart-bt ``` -## {% linkable_title HmIP-RFUSB %} +## HmIP-RFUSB HassOS > 1.11 support HmIP-RFUSB default and don't need any configuration. If you run a Linux, you need to follow the installation guide from documentation to set up the UART USB interface on your computer. diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown index ae9cbb36811b..ef3bfd86f5b8 100644 --- a/source/_addons/lets_encrypt.markdown +++ b/source/_addons/lets_encrypt.markdown @@ -45,7 +45,7 @@ keyfile: default: privkey.pem {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use the generated certificate: @@ -58,7 +58,7 @@ http: If you use another port such as `8123` or an SSL proxy, change the port number. -## {% linkable_title Enabling auto-renewals %} +## Enabling auto-renewals Out of the box, the add-on will not automatically renew your certificate. In fact, it only starts, tries to get/renew your certificate, and then stops. It's up to you to manually start it again whenever your certificate comes close to expiry. diff --git a/source/_addons/mariadb.markdown b/source/_addons/mariadb.markdown index 1ff9d87095bc..c53bb4a5dd12 100644 --- a/source/_addons/mariadb.markdown +++ b/source/_addons/mariadb.markdown @@ -77,7 +77,7 @@ rights: type: string {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use the database above: diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index f8cb8748fa51..06ff1adbc5c7 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -47,15 +47,15 @@ customize: type: [boolean, string] {% endconfiguration %} -### {% linkable_title Home Assistant user management %} +### Home Assistant user management This add-on is attached to the Home Assistant user system, so mqtt clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, so these may not be used as user names. -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. If you have old MQTT settings available, remove this old integration and restart Home Assistant to see the new one. -#### {% linkable_title Using Mosquitto with Hass.io %} +#### Using Mosquitto with Hass.io 1. Install the [Mosquitto add-on](/addons/mosquitto/) with the default configuration via 'Hass.io > ADD-ON STORE'. (Don't forget to start the add-on & verify that 'Start on boot' is enabled.) @@ -73,11 +73,11 @@ To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the int Note: .yaml modifications are not required. See [testing your setup](/docs/mqtt/testing/) to verify the steps above. -### {% linkable_title Disable listening on insecure (1883) ports %} +### Disable listening on insecure (1883) ports Remove the ports from the add-on page network card (set them as blank) to disable them. -### {% linkable_title Access Control Lists (ACLs) %} +### Access Control Lists (ACLs) It is possible to restrict access to topics based upon the user logged in to Mosquitto. In this scenario it is recommended to create individual users for each of your clients and create an appropriate ACL. diff --git a/source/_addons/rpc_shutdown.markdown b/source/_addons/rpc_shutdown.markdown index a76476905628..67bcf773cadd 100644 --- a/source/_addons/rpc_shutdown.markdown +++ b/source/_addons/rpc_shutdown.markdown @@ -33,7 +33,7 @@ Allows you to shut down a Windows computer with a service call from Home Assista - **computers/address** (*Required*): IP address or NetBIOS name of the computer for the shutdown. - **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as the delimiter of username and password. -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration Use the following inside Home Assistant service call to use it: diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 08887b5c76b2..3a7d14681ddd 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -33,7 +33,7 @@ Now install and activate the [Samba](/addons/samba/) add-on so you can upload yo Now it's time to start Snips for the first time. You can configure the microphone and sound card using the Add-on interface. Now start the add-on. -### {% linkable_title Add-On configuration %} +### Add-On configuration ```json { @@ -66,7 +66,7 @@ tts_platform: type: string {% endconfiguration %} -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration A simple configuration just requires this. Consult [Snips.ai integration](/components/snips/) for more options. @@ -74,11 +74,11 @@ A simple configuration just requires this. Consult [Snips.ai integration](/compo snips: ``` -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support. -### {% linkable_title Examples %} +### Examples So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba add-on. diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index 42729674b4db..f1e8f19f82c1 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -29,7 +29,7 @@ To add [lights](/components/light.tellstick/), [sensors](/components/sensor.tell The add-on will also enable you to interact with the `tdtool` via a Home Assistant services call, see example below for self-learning device. -## {% linkable_title Examples %} +## Examples Example for adding more devices in the add-on configuration (note the comma separator between devices): @@ -93,7 +93,7 @@ code: For more information about the configuration including protocols, see the [telldus documentation](https://developer.telldus.com/wiki/TellStick_conf). -## {% linkable_title Service calls %} +## Service calls If you wish to teach a self-learning device in your TellStick configuration: @@ -108,7 +108,7 @@ Replace `1` with the corresponding ID of the device in your TellStick configurat You can also use this to list devices or sensors and read the output in the add-on log: `{"addon":"core_tellstick","input":{"function":"list-sensors"}}` -### {% linkable_title Supported service commands %} +### Supported service commands - `"function":"list"`: List currently configured devices with name and device id and all discovered sensors. diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index b52572af4924..89172186e9a6 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: - [**Switch**](/components/abode/#switch): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them. - **Sensor**: Reports on `Temperature`, `Humidity`, and `Light` sensors. -## {% linkable_title Configuration %} +## Configuration To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file: @@ -99,7 +99,7 @@ lights: type: list {% endconfiguration %} -## {% linkable_title Events %} +## Events There are a number of events that can be triggered from Abode. They are grouped into the below events: @@ -128,9 +128,9 @@ Field | Description There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt). -## {% linkable_title Services %} +## Services -### {% linkable_title Service `change_setting` %} +### Service `change_setting` Change settings on your Abode system. For a full list of settings and valid values, consult the @@ -141,7 +141,7 @@ For a full list of settings and valid values, consult the | `setting` | No | The setting you wish to change. | `value` | No | The value you wish to change the setting to. -### {% linkable_title Service `capture_image` %} +### Service `capture_image` Request a new still image from your Abode IR camera. @@ -149,7 +149,7 @@ Request a new still image from your Abode IR camera. | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras. -### {% linkable_title Service `trigger_quick_action` %} +### Service `trigger_quick_action` Trigger a quick action automation on your Abode system. @@ -157,17 +157,17 @@ Trigger a quick action automation on your Abode system. | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions. -### {% linkable_title Binary Sensor %} +### Binary Sensor This integration will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. This integration will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action). -### {% linkable_title Light %} +### Light This integration will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration). -### {% linkable_title Switch %} +### Switch This integration will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration). diff --git a/source/_components/acer_projector.markdown b/source/_components/acer_projector.markdown index f057915f22d8..c791e349ada6 100644 --- a/source/_components/acer_projector.markdown +++ b/source/_components/acer_projector.markdown @@ -18,7 +18,7 @@ redirect_from: The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com). -## {% linkable_title Configuration %} +## Configuration To use your Acer Projector in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/adguard.markdown b/source/_components/adguard.markdown index 298351a35de6..5d17644798d5 100644 --- a/source/_components/adguard.markdown +++ b/source/_components/adguard.markdown @@ -20,7 +20,7 @@ AdGuard Home is a network-wide ad-and-tracker blocking DNS server with parental control (adult content blocking) capabilities. The `adguard` integration allows you to control and monitor your AdGuard Home instance in Home Assistant. -## {% linkable_title Configuration via the frontend %} +## Configuration via the frontend Menu: **Configuration** -> **Integrations**. @@ -28,7 +28,7 @@ Click on the `+` sign to add an integration and click on **AdGuard Home**. Follow the configuration flow, after finishing, the AdGuard Home integration will be available. -## {% linkable_title Sensors %} +## Sensors This integration provides sensors for the following information from AdGuard Home: @@ -41,7 +41,7 @@ This integration provides sensors for the following information from AdGuard Hom - Total number of active filter rules loaded. - Average response time of AdGuard's DNS server in milliseconds. -## {% linkable_title Switches %} +## Switches The integration will create a number of switches: @@ -63,7 +63,7 @@ Turning off Query Log will result in all sensors not receiving updates anymore. AdGuard relies on Query Log to provide stats.

-## {% linkable_title Services %} +## Services These services allow one to manage filter subscriptions in AdGuard Home. Using these services in automations could be helpful to block certain @@ -72,7 +72,7 @@ sites/domains at certain times. For example, you could create a custom filter list blocking social media sites, during the day and release them during the evening, using a simple automation. -### {% linkable_title Service `add_url` %} +### Service `add_url` Add a new filter subscription to AdGuard Home. @@ -81,7 +81,7 @@ Add a new filter subscription to AdGuard Home. | `name` | No | The name of the filter subscription. | | `url` | No | The filter URL to subscribe to, containing the filter rules. | -### {% linkable_title Service `remove_url` %} +### Service `remove_url` Removes a filter subscription from AdGuard Home. @@ -89,7 +89,7 @@ Removes a filter subscription from AdGuard Home. | ---------------------- | -------- | -------------------------------------- | | `url` | No | The filter subscription URL to remove. | -### {% linkable_title Service `enable_url` %} +### Service `enable_url` Enables a filter subscription in AdGuard Home. @@ -97,7 +97,7 @@ Enables a filter subscription in AdGuard Home. | ---------------------- | -------- | -------------------------------------- | | `url` | No | The filter subscription URL to enable. | -### {% linkable_title Service `disable_url` %} +### Service `disable_url` Disables a filter subscription in AdGuard Home. @@ -105,7 +105,7 @@ Disables a filter subscription in AdGuard Home. | ---------------------- | -------- | --------------------------------------- | | `url` | No | The filter subscription URL to disable. | -### {% linkable_title Service `refresh` %} +### Service `refresh` Refresh all filter subscriptions in AdGuard Home. diff --git a/source/_components/ads.markdown b/source/_components/ads.markdown index 7dcbf645f14b..d91b221761f2 100644 --- a/source/_components/ads.markdown +++ b/source/_components/ads.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: - [Switch](#switch) - [Cover](#cover) -## {% linkable_title Configuration %} +## Configuration To enable ADS, add the following lines to your `configuration.yaml` file: @@ -60,7 +60,7 @@ ip_address: type: string {% endconfiguration %} -## {% linkable_title Service %} +## Service The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. @@ -78,7 +78,7 @@ Service parameters: - **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool` - **value**: The value that will be written in the variable. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device. @@ -107,7 +107,7 @@ device_class: type: string {% endconfiguration %} -## {% linkable_title Light %} +## Light The `ads` light platform allows you to control your connecte ADS lights. @@ -137,7 +137,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*. @@ -176,7 +176,7 @@ factor: The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100 if you want to display a fixed decimal value with two decimals. A variable value of `123` will be displayed as `1.23`. -## {% linkable_title Switch %} +## Switch The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name. @@ -201,7 +201,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Cover %} +## Cover The `ads` cover platform allows you to control your connected ADS covers. diff --git a/source/_components/aftership.markdown b/source/_components/aftership.markdown index 5991851acd67..b4a40fd554c6 100644 --- a/source/_components/aftership.markdown +++ b/source/_components/aftership.markdown @@ -20,7 +20,7 @@ The `aftership` platform allows one to track deliveries by [AfterShip](https://w The sensor value shows the number of packages that are not in `Delivered` state. As attributes are the number of packages per status. -## {% linkable_title Setup %} +## Setup To use this sensor, you need an [AfterShip Account](https://accounts.aftership.com/register) and set up an API Key. To set up an API Key go to [AfterShip API](https://secure.aftership.com/#/settings/api) page, and copy existing key or generate a new one. @@ -28,7 +28,7 @@ To use this sensor, you need an [AfterShip Account](https://accounts.aftership.c AfterShip recently started requiring having a credit card on file even if you are only using the free plan. That does not change the functionality of the platform, just something to be aware of.

-## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ api_key: type: string {% endconfiguration %} -## {% linkable_title Service `add_tracking` %} +## Service `add_tracking` You can use the service `aftership.add_tracking` to add trackings to Aftership. @@ -60,7 +60,7 @@ api_key: | `slug` | `False` | string | Carrier e.g. `fedex` | `title` | `False` | string | Friendly name of package -## {% linkable_title Service `remove_tracking` %} +## Service `remove_tracking` You can use the service `aftership.remove_tracking` to remove trackings from Aftership. diff --git a/source/_components/airvisual.markdown b/source/_components/airvisual.markdown index cc23835a5d5b..b8b0eebdf5e3 100644 --- a/source/_components/airvisual.markdown +++ b/source/_components/airvisual.markdown @@ -26,7 +26,7 @@ The Community API key is valid for 12 months after which it will expire. You mus The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.

-## {% linkable_title Configuration %} +## Configuration To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: @@ -80,7 +80,7 @@ country: type: string {% endconfiguration %} -## {% linkable_title Example Configurations %} +## Example Configurations Configuration using custom Latitude and Longitude: @@ -111,7 +111,7 @@ sensor: country: USA ``` -## {% linkable_title Determining the City/State/Country %} +## Determining the City/State/Country To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`. @@ -129,7 +129,7 @@ sensor: country: brazil ``` -## {% linkable_title Sensor Types %} +## Sensor Types When configured, the platform will create three sensors for each configured air quality standard: diff --git a/source/_components/aladdin_connect.markdown b/source/_components/aladdin_connect.markdown index cdf2ecfa3940..e421dca78bbe 100644 --- a/source/_components/aladdin_connect.markdown +++ b/source/_components/aladdin_connect.markdown @@ -22,7 +22,7 @@ The `aladdin_connect` cover platform lets you control Genie Aladdin Connect gara Only doors that are owned by your Aladdin Connect account will be available. Doors that your account has been granted shared access to are not yet supported.

-## {% linkable_title Configuration %} +## Configuration To use your Aladdin Connect cover in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/alarm_control_panel.ifttt.markdown b/source/_components/alarm_control_panel.ifttt.markdown index 3e7d4ebf81f4..445cbb0f5d32 100644 --- a/source/_components/alarm_control_panel.ifttt.markdown +++ b/source/_components/alarm_control_panel.ifttt.markdown @@ -21,7 +21,7 @@ This platform depends on the [IFTTT](/components/ifttt/) Home Assistant integrat It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.

-## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: @@ -80,7 +80,7 @@ optimistic: It is strongly discouraged to use this platform when you don't use encryption; otherwise, your API password will be send unprotected through the IFTTT Webhooks. It is advised to [setup encryption using Let's Encrypt](https://home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/).

-### {% linkable_title Required IFTTT applets %} +### Required IFTTT applets Next, you will need to set up the required IFTTT applets as listed below. diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index b32ef6da3cea..4948f151cdbd 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -27,7 +27,7 @@ The integration will accept the following states from your Alarm Panel (in lower The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml`: diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index d9ed822f0769..d2c9ea1b50e1 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant: This is a fully event-based component. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant. -## {% linkable_title Configuration %} +## Configuration An `alarmdecoder` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -122,7 +122,7 @@ zones: type: integer {% endconfiguration %} -## {% linkable_title Alarm Control Panel %} +## Alarm Control Panel There are several attributes available on the alarm panel to give you more information about your alarm. @@ -136,7 +136,7 @@ There are several attributes available on the alarm panel to give you more infor - `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`. - `zone_bypassed`: Set to `true` if your system is currently bypassing a zone. -## {% linkable_title Services %} +## Services The Alarm Decoder integration gives you access to several services for you to control your alarm with. @@ -150,11 +150,11 @@ The Alarm Decoder integration gives you access to several services for you to co `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform.

-### {% linkable_title Examples %} +### Examples Using a combination of the available services and attributes, you can create switch templates. -### {% linkable_title Chime Status and Control %} +### Chime Status and Control {% raw %} ```yaml diff --git a/source/_components/alarmdotcom.markdown b/source/_components/alarmdotcom.markdown index a7e0cfb2064e..423660da8a02 100644 --- a/source/_components/alarmdotcom.markdown +++ b/source/_components/alarmdotcom.markdown @@ -17,7 +17,7 @@ redirect_from: The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/). -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml`: diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index 6b7eb22d4426..33abf381f066 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -23,7 +23,7 @@ water leak sensors, or any condition that may need your attention. Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved. -### {% linkable_title Basic Example %} +### Basic Example The `alert` integration makes use of any of the `notifications` integrations. To setup the `alert` integration, first, you must setup a `notification` integration. @@ -143,7 +143,7 @@ alert: - john_phone_sms ``` -### {% linkable_title Complex Alert Criteria %} +### Complex Alert Criteria By design, the `alert` integration only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some @@ -177,7 +177,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery` attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend. -### {% linkable_title Dynamic Notification Delay Times %} +### Dynamic Notification Delay Times It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` @@ -208,7 +208,7 @@ following notification. For example, if the garage door opens at 2:00, a notification will be sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes. -### {% linkable_title Message Templates %} +### Message Templates It may be desirable to have the alert notifications include information about the state of the entity. [Templates](/docs/configuration/templating/) @@ -237,7 +237,7 @@ alert: The resulting message could be `Plant Officeplant needs help (moisture low)`. -### {% linkable_title Additional parameters for notifiers %} +### Additional parameters for notifiers Some notifiers support more parameters (e.g., to set text color or action buttons). These can be supplied via the `data` parameter: diff --git a/source/_components/alexa.flash_briefings.markdown b/source/_components/alexa.flash_briefings.markdown index d487946db2d3..d6a158ad0b14 100644 --- a/source/_components/alexa.flash_briefings.markdown +++ b/source/_components/alexa.flash_briefings.markdown @@ -14,11 +14,11 @@ featured: false ha_release: "0.31" --- -## {% linkable_title Flash Briefing Skills %} +## Flash Briefing Skills As of version [0.31][zero-three-one] Home Assistant supports the new [Alexa Flash Briefing Skills API][flash-briefing-api]. A Flash Briefing Skill adds a new Flash Briefing source that is generated by Home Assistant. -### {% linkable_title Requirements %} +### Requirements Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). @@ -30,7 +30,7 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint * [blog-lets-encrypt]: /blog/2015/12/13/setup-encryption-using-lets-encrypt/ -### {% linkable_title Configuring a Flash Briefing skill in Home Assistant %} +### Configuring a Flash Briefing skill in Home Assistant You can use [templates] for the `title`, `audio`, `text` and `display_url` configuration parameters. @@ -56,7 +56,7 @@ You can add multiple items for a feed if you want. The Amazon required UID and t Please refer to the [Amazon documentation][flash-briefing-api-docs] for more information about allowed configuration parameters and formats. -### {% linkable_title Configuring your Flash Briefing skill %} +### Configuring your Flash Briefing skill - Log in to [Amazon developer console][amazon-dev-console] - Click the Alexa navigation tab at the top of the console diff --git a/source/_components/alexa.intent.markdown b/source/_components/alexa.intent.markdown index 925d33f8f53a..5e1dc0db34c0 100644 --- a/source/_components/alexa.intent.markdown +++ b/source/_components/alexa.intent.markdown @@ -14,7 +14,7 @@ featured: false ha_release: "0.10" --- -## {% linkable_title I want to build custom commands to use with Echo %} +## I want to build custom commands to use with Echo The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own. @@ -22,7 +22,7 @@ The built-in Alexa integration allows you to integrate Home Assistant into Alexa -### {% linkable_title Requirements %} +### Requirements Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). @@ -49,7 +49,7 @@ To get started with Alexa skills: You can use this [specially sized Home Assistant logo][large-icon] as the large icon and [this one][small-icon] as the small one. -### {% linkable_title Configuring your Amazon Alexa skill %} +### Configuring your Amazon Alexa skill Alexa works based on intents. Each intent has a name and variable slots. For example, a `LocateIntent` with a slot that contains a `User`. Example intent schema: @@ -88,7 +88,7 @@ This means that we can now ask Alexa things like: - Alexa, ask Home Assistant where Paul is - Alexa, ask Home Assistant where we are -## {% linkable_title Configuring Home Assistant %} +## Configuring Home Assistant When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration. @@ -98,7 +98,7 @@ To enable Alexa, add the following entry to your `configuration.yaml` file: alexa: ``` -### {% linkable_title Working With Scenes %} +### Working With Scenes One of the most useful applications of Alexa integrations is to call scenes directly. This is easily achieved with some simple setup on the Home Assistant side and by letting Alexa know which scenes you want to run. @@ -157,7 +157,7 @@ Here we are using [templates] to take the name we gave to Alexa e.g., `downstair Now say `Alexa ask Home Assistant to activate ` and Alexa will activate that scene for you. -### {% linkable_title Adding Scripts %} +### Adding Scripts We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts: @@ -203,7 +203,7 @@ intent_script: Now say `Alexa ask Home Assistant to run ` and Alexa will run that script for you. -### {% linkable_title Support for Launch Requests %} +### Support for Launch Requests There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!". @@ -227,7 +227,7 @@ intent_script: text: OK ``` -## {% linkable_title Giving Alexa Some Personality %} +## Giving Alexa Some Personality In the examples above, we told Alexa to say `OK` when she successfully completed the task. This is effective but a little dull! We can again use [templates] to spice things up a little. diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index 7a7df1f7a9c5..a46dbe6b2c7c 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -14,13 +14,13 @@ featured: true ha_release: "0.10" --- -## {% linkable_title Automatic setup via Home Assistant Cloud %} +## Automatic setup via Home Assistant Cloud With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Amazon Alexa. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/). -## {% linkable_title Manual setup %} +## Manual setup There are a few ways that you can use Amazon Alexa and Home Assistant together. @@ -29,7 +29,7 @@ There are a few ways that you can use Amazon Alexa and Home Assistant together. - [Use the Smart Home API to control lights, etc](/components/alexa.smart_home/) - Alternative: use the [Emulated Hue integration][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub. -### {% linkable_title Requirements %} +### Requirements Manual setup the integration with Amazon Alexa needs several requirements diff --git a/source/_components/alexa.smart_home.markdown b/source/_components/alexa.smart_home.markdown index d5f3e819b07d..ea7cc328e8d8 100644 --- a/source/_components/alexa.smart_home.markdown +++ b/source/_components/alexa.smart_home.markdown @@ -14,7 +14,7 @@ featured: false ha_release: "0.54" --- -## {% linkable_title Amazon Alexa Smart Home %} +## Amazon Alexa Smart Home While the Skills API described above allows for arbitrary intents, all utterances must begin with "Alexa, tell $invocation_name ..." @@ -38,13 +38,13 @@ With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instan For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).

-### {% linkable_title Requirements %} +### Requirements - Amazon Developer Account. You can sign on [here](https://developer.amazon.com). - An [AWS account](https://aws.amazon.com/free/) is need if you want to use Smart Home Skill API. Part of your Smart Home Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month. - Smart Home API also needs your Home Assistant instance can be accessed from Internet. We strongly suggest you host HTTPS server and use validation certificate. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. -### {% linkable_title Create Your Amazon Alexa Smart Home Skill %} +### Create Your Amazon Alexa Smart Home Skill - Sign in [Alexa Developer Console][alexa-dev-console], you can create your free account on the sign in page. - Go to `Alexa Skills` page if you are not, click `Create Skill` button to start the process. @@ -56,7 +56,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na - In next screen, make sure *v3* is selected in `Payload version`. - Now, you have created a skeleton of Smart Home skill. Next step we will do some "real" developer work. You can keep Alex Developer Console opened, we need change the skill configuration later. -### {% linkable_title Create Your Lambda Function %} +### Create Your Lambda Function Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa. @@ -70,7 +70,7 @@ Amazon also provided a [step-by-step guide](https://developer.amazon.com/docs/sm OK, let's go. You first need sign in your [AWS console](https://console.aws.amazon.com/), if you don't have an AWS account yet, you can create a new user [here](https://aws.amazon.com/free/) with 12-month free tire benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See [Lambda pricing](https://aws.amazon.com/lambda/pricing/) for details. -#### {% linkable_title Create an IAM Role for Lambda %} +#### Create an IAM Role for Lambda First thing you need to do after sing in [AWS console](https://console.aws.amazon.com/) is to create an IAM Role for Lambda execution. AWS has very strict access control, you have to specific define and assign the permissions. @@ -83,7 +83,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo - You can skip `Add tags` page, click `Next: Review`. - Give your new role a name, such as `AWSLambdaBasicExecutionRole-SmartHome`, then click `Create role` button. You should be able to find your new role in the roles list now. -#### {% linkable_title Create a Lambda function and add code %} +#### Create a Lambda function and add code Next you need create a Lambda function. @@ -111,7 +111,7 @@ Next you need create a Lambda function. - Now scroll up to the top, click `Save` button. - You need copy the ARN displayed in the top of the page, which is the identify of this Lambda function. You will need this ARN to continue Alexa Smart Home skill configuration later. -#### {% linkable_title Test the Lambda function %} +#### Test the Lambda function Now, you have created the Lambda function, before you can test it, you have to set up your Home Assistant. Put following minimal configuration to your configuration.yaml, it will exposures all of your supported device and automation to Alexa. Check the [configuration section](#alexa-component-configuration) if you want more control of the exposure. @@ -150,7 +150,7 @@ Now, you can login to your Home Assistant and [generate a long-lived access toke This time, you will get a list of your devices as the response. 🎉 -### {% linkable_title Config the Smart Home Service Endpoint %} +### Config the Smart Home Service Endpoint Now removed the long-lived access token if you want, copied the ARN of your Lambda function, then back to [Alexa Developer Console][alexa-dev-console]. You will finish the configuration of the Smart Home skill. @@ -159,7 +159,7 @@ Now removed the long-lived access token if you want, copied the ARN of your Lamb - Click `SMART HOME` in the left navigation bar of build page. - Fill in `Default endpoint` under `2. Smart Home service endpoint` using the `ARN` you copied from your Lambda function configuration. -### {% linkable_title Account Linking %} +### Account Linking Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa request be able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet. @@ -193,7 +193,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom * You can discovery your devices now. - Now, you can ask your Echo or in Alexa App, *turn on bedroom* 🎉 -### {% linkable_title Alexa Component Configuration %} +### Alexa Component Configuration Example configuration: @@ -226,7 +226,7 @@ The `endpoint`, `client_id` and `client_secret` are optional, and are only requi - If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available." -### {% linkable_title Alexa web-based app %} +### Alexa web-based app The following is a list of regions and the corresponding URL for the web-based Alexa app: diff --git a/source/_components/alpha_vantage.markdown b/source/_components/alpha_vantage.markdown index 65728778d9c8..09e1e7d2fd42 100644 --- a/source/_components/alpha_vantage.markdown +++ b/source/_components/alpha_vantage.markdown @@ -78,11 +78,11 @@ foreign_exchange: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Google and the exchange rate for Bitcoin %} +### Google and the exchange rate for Bitcoin ```yaml sensor: diff --git a/source/_components/amazon_polly.markdown b/source/_components/amazon_polly.markdown index 1f14b27427af..864d52967c86 100644 --- a/source/_components/amazon_polly.markdown +++ b/source/_components/amazon_polly.markdown @@ -18,13 +18,13 @@ redirect_from: The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output. Polly is a paid service via Amazon Web Services. There is a [free tier](https://aws.amazon.com/polly/pricing/) for the first 12 months and then a charge per million characters afterwards. -## {% linkable_title Setup %} +## Setup For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions. Available voices are listed in the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html). -## {% linkable_title Configuration %} +## Configuration To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly): @@ -79,7 +79,7 @@ sample_rate: default: 22050 for MP3 and Ogg Vorbis, 16000 for pcm {% endconfiguration %} -## {% linkable_title Usage %} +## Usage Say to all `media_player` device entities: diff --git a/source/_components/ambiclimate.markdown b/source/_components/ambiclimate.markdown index 03215193451c..ea52e5bf2d50 100644 --- a/source/_components/ambiclimate.markdown +++ b/source/_components/ambiclimate.markdown @@ -42,7 +42,7 @@ client_secret: Note that you have to select manual mode from the Ambiclimate app to be able to control the A/C from Home Assistant. -## {% linkable_title Component services %} +## Component services Enable comfort mode on your AC: diff --git a/source/_components/ambient_station.markdown b/source/_components/ambient_station.markdown index 26b1d44306f4..3be9275f6ddd 100644 --- a/source/_components/ambient_station.markdown +++ b/source/_components/ambient_station.markdown @@ -17,13 +17,13 @@ redirect_from: The `Ambient Weather Station` integration retrieves local weather information via personal weather stations from [Ambient Weather](https://ambientweather.net). -## {% linkable_title Setup %} +## Setup Using this integration requires both an Application Key and an API Key. To generate both, simply utilize the profile section of [your Ambient Weather dashboard](https://dashboard.ambientweather.net). -## {% linkable_title Configuration %} +## Configuration To add your Ambient Weather PWS to your Home Assistant installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index 8496955b831d..a96fa665ab4f 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch (deprecated) -## {% linkable_title Configuration %} +## Configuration To enable your camera in your installation, add the following to your `configuration.yaml` file: @@ -175,7 +175,7 @@ Newer Amcrest firmware may not work, then **rtsp** is recommended instead. make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation to install the `ffmpeg`. -## {% linkable_title Services %} +## Services Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras. @@ -186,7 +186,7 @@ Available services: `goto_preset`, `set_color_bw`, `start_tour` and `stop_tour` -#### {% linkable_title Service `enable_audio`/`disable_audio` %} +#### Service `enable_audio`/`disable_audio` These services enable or disable the camera's audio stream. @@ -194,7 +194,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### {% linkable_title Service `enable_motion_recording`/`disable_motion_recording` %} +#### Service `enable_motion_recording`/`disable_motion_recording` These services enable or disable the camera to record a clip to its configured storage location when motion is detected. @@ -202,7 +202,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### {% linkable_title Service `enable_recording`/`disable_recording` %} +#### Service `enable_recording`/`disable_recording` These services enable or disable the camera to continuously record to its configured storage location. @@ -210,7 +210,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### {% linkable_title Service `goto_preset` %} +#### Service `goto_preset` This service will cause the camera to move to one of the PTZ locations configured within the camera. @@ -219,7 +219,7 @@ Service data attribute | Optional | Description `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. `preset` | no | Preset number, starting from 1. -#### {% linkable_title Service `set_color_bw` %} +#### Service `set_color_bw` This service will set the color mode of the camera. @@ -228,7 +228,7 @@ Service data attribute | Optional | Description `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. `color_bw` | no | One of `auto`, `bw` or `color`. -#### {% linkable_title Service `start_tour`/`stop_tour` %} +#### Service `start_tour`/`stop_tour` These services start or stop the camera's PTZ tour function. @@ -236,7 +236,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -## {% linkable_title Advanced Configuration %} +## Advanced Configuration You can also use this more advanced configuration example: diff --git a/source/_components/ampio.markdown b/source/_components/ampio.markdown index a65646727677..cdd587dec498 100644 --- a/source/_components/ampio.markdown +++ b/source/_components/ampio.markdown @@ -17,11 +17,11 @@ ha_iot_class: "Cloud Polling" The `ampio` air quality platform will query the open data API of [ampio.pl](http://smog1.ampio.pl:3050/) to monitor air quality sensor station. -## {% linkable_title Setup %} +## Setup To get the ID of a station you need to contact Ampio directly. -## {% linkable_title Manual Configuration %} +## Manual Configuration To enable this platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index 82b75d0905ad..04c19a03dac1 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -34,11 +34,11 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -## {% linkable_title Setup %} +## Setup Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen. -## {% linkable_title Configuration %} +## Configuration To set up the component, add the following information to your `configuration.yaml` file: @@ -134,7 +134,7 @@ motion_sensor: You need to enable logging in the Android app (`Data logging` > `Enable data logging`), if you wish to see the sensor states in Home Assistant. The sensor states stays as `unknown`, until it's enabled.

-## {% linkable_title Full example %} +## Full example ```yaml # Example configuration.yaml entry @@ -170,11 +170,11 @@ android_ip_webcam: - torch ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. -## {% linkable_title Examples %} +## Examples You can also setup the binary motion sensor with the following script: @@ -191,11 +191,11 @@ binary_sensor: {% endraw %} -## {% linkable_title Camera %} +## Camera The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used. -## {% linkable_title Configuration %} +## Configuration To enable only the camera in your installation, add the following to your `configuration.yaml` file: @@ -206,7 +206,7 @@ camera: mjpeg_url: http://IP_ADDRESS:8080/video ``` -## {% linkable_title Sensor %} +## Sensor The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. diff --git a/source/_components/androidtv.markdown b/source/_components/androidtv.markdown index c88704769a45..ec7e91393f3c 100644 --- a/source/_components/androidtv.markdown +++ b/source/_components/androidtv.markdown @@ -18,7 +18,7 @@ redirect_from: The `androidtv` platform allows you to control an Android TV device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device. -## {% linkable_title Device preparation %} +## Device preparation To set up your device, you will need to find its IP address and enable ADB debugging. For Android TV devices, please consult the documentation for your device. @@ -32,7 +32,7 @@ For Fire TV devices, the instructions are as follows: - From the main (Launcher) screen, select Settings. - Select System > About > Network. -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -108,7 +108,7 @@ turn_off_command: type: string {% endconfiguration %} -### {% linkable_title Full Configuration %} +### Full Configuration ```yaml # Example configuration.yaml entry @@ -135,23 +135,23 @@ media_player: get_sources: false ``` -## {% linkable_title ADB Setup %} +## ADB Setup This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this: -### {% linkable_title 1. ADB Server %} +### 1. ADB Server You can use an ADB server to connect to your Android TV and Fire TV devices. For Hass.io users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. 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. -### {% linkable_title 2. Python ADB Implementation %} +### 2. Python ADB Implementation The second option is to connect to your device using the `adb` Python package. If your device requires ADB authentication, you will need to follow the instructions in the [ADB Authentication](#adb-authentication) section below. Once you have an authenticated key, this approach does not require any additional setup or addons. However, users with newer devices may find that the ADB connection is unstable. For a Fire TV device, you can try setting the `get_sources` configuration option to `false`. If the problem cannot be resolved, you should use the ADB server option. -#### {% linkable_title ADB Authentication %} +#### ADB Authentication If you get a "Device authentication required, no keys available" error when trying to set up your Android TV or Fire TV, then you'll need to create an adbkey and add its path to your configuration. Follow the instructions on this page to connect to your device from your computer: [Connecting to Fire TV Through adb](https://developer.amazon.com/zh/docs/fire-tv/connecting-adb-to-device.html). @@ -166,7 +166,7 @@ Once you've successfully connected to your Android TV / Fire TV via the command Copy the `adbkey` file to your Home Assistant folder and add the path to the `adbkey` file to your configuration. -## {% linkable_title ADB Troubleshooting %} +## ADB Troubleshooting If you receive the error message `Error while setting up platform androidtv` in your log when trying to set up an Android TV or Fire TV device, then there is probably an issue with your ADB connection. Here are some possible causes. @@ -184,9 +184,9 @@ If you receive the error message `Error while setting up platform androidtv` in 4. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to WiFi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well. -## {% linkable_title Services %} +## Services -### {% linkable_title `media_player.select_source` %} +### `media_player.select_source` For Fire TV devices, you can launch an app using the `media_player.select_source` command. Simply provide the app ID as the `source`. You can also stop an app by prefixing the app ID with a `!`. For example, you could define [scripts](/docs/scripts) to start and stop Netflix as follows: @@ -206,7 +206,7 @@ stop_netflix: source: '!com.netflix.ninja' ``` -### {% linkable_title `androidtv.adb_command` %} +### `androidtv.adb_command` The service `androidtv.adb_command` allows you to send either keys or ADB shell commands to your Android TV / Fire TV device. If there is any output, it will be stored in the `'adb_response'` attribute (i.e., `state_attr('media_player.android_tv_living_room', 'adb_response')` in a template) and logged at the INFO level. diff --git a/source/_components/anthemav.markdown b/source/_components/anthemav.markdown index ca83e56e9fdd..5e3b892f2ccc 100644 --- a/source/_components/anthemav.markdown +++ b/source/_components/anthemav.markdown @@ -18,7 +18,7 @@ redirect_from: Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network. -## {% linkable_title Supported Models %} +## Supported Models * MRX 520, MRX 720, MRX 1120, and AVM 60 * MRX 310, MRX 510, MRX 710 diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 1c0c34eb34ba..911db2cd7f10 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -26,13 +26,13 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Sensor](#sensor) -## {% linkable_title Hass.io Installation %} +## Hass.io Installation Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on. After installation, follow the instructions on the Github page to configure the plugin. Then continue to follow the integration configurations below. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -58,11 +58,11 @@ port: If you get `ConnectionRefusedError: Connection refused` errors in the Home assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.

-## {% linkable_title Binary sensor %} +## Binary sensor In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times. -### {% linkable_title Configuration %} +### Configuration To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file: @@ -80,11 +80,11 @@ name: default: UPS Online Status {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command. -### {% linkable_title Configuration %} +### Configuration To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file: @@ -104,7 +104,7 @@ resources: type: list {% endconfiguration %} -### {% linkable_title Example %} +### Example Given the following output from `apcaccess`: diff --git a/source/_components/apns.markdown b/source/_components/apns.markdown index 038e599e17da..ca29ec3ecf3b 100644 --- a/source/_components/apns.markdown +++ b/source/_components/apns.markdown @@ -17,11 +17,11 @@ redirect_from: The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant. -## {% linkable_title Setup %} +## Setup To use the APNS service you will need an Apple developer account and you will need to create an app to receive push notifications. For more information, see the Apple developer documentation. -## {% linkable_title Configuration %} +## Configuration To enable APNS notifications, add the following lines to your `configuration.yaml`: @@ -56,13 +56,13 @@ sandbox: The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify.apns_NOTIFIER_NAME`. -### {% linkable_title notify.apns_NOTIFIER_NAME %} +### notify.apns_NOTIFIER_NAME This service will register device IDs with Home Assistant. In order to receive a notification a device must be registered. The app on the device can use this service to send an ID to Home Assistant during startup, the ID will be stored in `[NOTIFIER_NAME]_apns.yaml`. See `didRegisterForRemoteNotificationsWithDeviceToken` in the [Apple developer documentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didRegisterForRemoteNotificationsWithDeviceToken:) for more information about how to obtain a device ID. -### {% linkable_title notify.NOTIFIER_NAME %} +### notify.NOTIFIER_NAME This service will send messages to a registered device. The following parameters can be used: diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown index 79da7887cf6c..d7cf830ecb0a 100644 --- a/source/_components/apple_tv.markdown +++ b/source/_components/apple_tv.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.

-## {% linkable_title Configuration %} +## Configuration To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough: @@ -80,9 +80,9 @@ credentials: In order to connect to the device, you need a *login id*. The easiest way to obtain this identifier is to use the `apple_tv_scan` service (described below). Additional information about `start_off` and `credentials` can also be found under the guides section. -## {% linkable_title Guides %} +## Guides -### {% linkable_title Scanning for devices %} +### Scanning for devices Make sure Home Sharing is enabled on the Apple TV. @@ -110,7 +110,7 @@ Note: You must use 'pair' with devices that have home sharing disabled Just copy and paste the `login_id` from the device you want to add. For more details about `atvremote`, see: [this page](http://pyatv.readthedocs.io/en/master/atvremote.html). -### {% linkable_title Setting up device authentication %} +### Setting up device authentication If you, when playing media with `play_url`, get the following error message: @@ -140,7 +140,7 @@ apple_tv: Restart Home Assistant, and you should now be able to use `play_url` as before. -### {% linkable_title My Apple TV turns on when I restart Home Assistant %} +### My Apple TV turns on when I restart Home Assistant The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured. @@ -158,9 +158,9 @@ To put a device into fake standby when starting Home Assistant, add `start_off: Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above.

-## {% linkable_title Services %} +## Services -### {% linkable_title Service `apple_tv_authenticate` %} +### Service `apple_tv_authenticate` To play media on an Apple TV with device authentication enabled (e.g., ATV4 with tvOS 10.2+), Home Assistant must be properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage. @@ -168,11 +168,11 @@ To play media on an Apple TV with device authentication enabled (e.g., ATV4 with | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s of Apple TVs. -### {% linkable_title Service `apple_tv_scan` %} +### Service `apple_tv_scan` Scans the local network for Apple TVs. All found devices are presented as a persistent notification. -## {% linkable_title Remote %} +## Remote The `apple_tv` remote platform allows you to send remote control buttons to an Apple TV. It is automatically setup when an Apple TV is configured. diff --git a/source/_components/aprs.markdown b/source/_components/aprs.markdown index ec90a7bcdee3..25ae43b2be41 100644 --- a/source/_components/aprs.markdown +++ b/source/_components/aprs.markdown @@ -15,7 +15,7 @@ ha_iot_class: Cloud Push The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices. -## {% linkable_title Configuration %} +## Configuration To enable APRS tracking in Home Assistant, add the following section to `configuration.yaml`: diff --git a/source/_components/aqualogic.markdown b/source/_components/aqualogic.markdown index ebfc8d3773a7..b133221bc977 100644 --- a/source/_components/aqualogic.markdown +++ b/source/_components/aqualogic.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file: @@ -48,7 +48,7 @@ port: type: int {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor Once you have enabled the AquaLogic component, add the following to your `configuration.yaml` file: @@ -87,7 +87,7 @@ monitored_conditions: description: The current system status. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch Once you have enabled the AquaLogic component, add the following to your `configuration.yaml` file: diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index f61098f5d30a..8704d81038c7 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## 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. @@ -69,7 +69,7 @@ Add the user who is used to run Home Assistant to the groups to allow access to $ sudo usermod -a -G dialout,lock $USER ``` -## {% linkable_title Sensor %} +## 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. @@ -104,7 +104,7 @@ pins: The 6 analog pins of an Arduino UNO are numbered from A0 to A5. -## {% linkable_title Switch %} +## 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. diff --git a/source/_components/arest.markdown b/source/_components/arest.markdown index 8130a9a4bd41..bb48218c52d8 100644 --- a/source/_components/arest.markdown +++ b/source/_components/arest.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Binary Sensor %} +## Binary Sensor The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. @@ -78,7 +78,7 @@ binary_sensor: This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.

-## {% linkable_title Sensor %} +## Sensor The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. @@ -181,7 +181,7 @@ The root will give you a JSON response that contains all variables and their cur {"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true} ``` -## {% linkable_title Switch %} +## Switch The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index d7316c4a7902..681c09b3a967 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file: @@ -73,9 +73,9 @@ The Arlo integration also provides a camera service to enable/disable the motion entity_id: camera.arlo_frontdoor ``` -## {% linkable_title Alarm %} +## Alarm -### {% linkable_title Configuration %} +### Configuration Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: @@ -102,7 +102,7 @@ night_mode_name: default: "`Armed` mode in Arlo" {% endconfiguration %} -### {% linkable_title Examples %} +### Examples These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`. @@ -140,11 +140,11 @@ You can also completely disarm the Arlo base station by calling the `alarm_contr More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples). -## {% linkable_title Camera %} +## Camera This integration is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture. -### {% linkable_title Configuration %} +### Configuration Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: @@ -164,13 +164,13 @@ ffmpeg_arguments: **Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation. -## {% linkable_title Sensor %} +## Sensor To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo). This platform does not support Arlo Q. -### {% linkable_title Configuration %} +### Configuration Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index ea9796d3b07d..e2ab37d0a113 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -22,7 +22,7 @@ To enable the component, a configuration is required in both Home Assistant as w First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server) -## {% linkable_title Configuration %} +## Configuration Once that is complete, add the following entry `configuration.yaml` file: diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown index f6ef9bcfef92..abd1a385c71e 100644 --- a/source/_components/asuswrt.markdown +++ b/source/_components/asuswrt.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - **Presence Detection** - The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router. - **Sensor** - The asuswrt sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file: @@ -93,7 +93,7 @@ sensors: You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.

-### {% linkable_title Example Sensor Configuration %} +### Example Sensor Configuration To enable ASUSWRT sensors as part of your installation, reference the following example configuration: @@ -118,7 +118,7 @@ The example above, creates the following sensors: - sensor.asuswrt_upload_speed (unit_of_measurement: Mbit/s) -## {% linkable_title Padavan custom firmware (The rt-n56u project) %} +## Padavan custom firmware (The rt-n56u project) The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router. diff --git a/source/_components/august.markdown b/source/_components/august.markdown index fb641c641c16..8400ab48eae6 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.

-## {% linkable_title Configuration %} +## Configuration You will need your August login information (username (either phone# or email), and password) to use this module. @@ -70,7 +70,7 @@ timeout: Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email. -### {% linkable_title Binary Sensor %} +### Binary Sensor If you have August Doorbell, once you have enabled the August component, you should see following sensors: @@ -82,6 +82,6 @@ If you have August Smart Lock with DoorSense, once you have enabled the August c - Door sensor -### {% linkable_title Camera %} +### Camera The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant. diff --git a/source/_components/aurora.markdown b/source/_components/aurora.markdown index e8a4185a6638..dd0f5539c2b0 100644 --- a/source/_components/aurora.markdown +++ b/source/_components/aurora.markdown @@ -21,7 +21,7 @@ This service gives a number 0-100 representing the current likelihood of visible You can check the attributes of the sensor to see your exact forecast. -## {% linkable_title Configuration %} +## Configuration To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file: @@ -44,7 +44,7 @@ name: default: Aurora Visibility {% endconfiguration %} -## {% linkable_title Full example %} +## Full example ```yaml binary_sensor: diff --git a/source/_components/automatic.markdown b/source/_components/automatic.markdown index cc3608be1c6b..26bb173fe964 100644 --- a/source/_components/automatic.markdown +++ b/source/_components/automatic.markdown @@ -19,13 +19,13 @@ redirect_from: The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service. -## {% linkable_title Setup %} +## Setup To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication. Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml. -## {% linkable_title Configuration %} +## Configuration Once your developer account is created, add the following to your `configuration.yaml` file: diff --git a/source/_components/avion.markdown b/source/_components/avion.markdown index d8d82e8245f9..4607e0213b0f 100644 --- a/source/_components/avion.markdown +++ b/source/_components/avion.markdown @@ -18,7 +18,7 @@ redirect_from: Support for the Avi-on Bluetooth dimmer switch [Avi-On](http://avi-on.com/). -## {% linkable_title Setup %} +## Setup If you want to add your devices manually (like in the example below) then you need to get the API key. The API key can be obtained by executing the following command: @@ -30,7 +30,7 @@ $ curl -X POST -H "Content-Type: application/json" \ with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration. -## {% linkable_title Configuration %} +## Configuration To enable these lights, add the following lines to your `configuration.yaml` file: @@ -70,7 +70,7 @@ devices: type: string {% endconfiguration %} -## {% linkable_title Full example %} +## Full example If username and password are not supplied, devices must be configured manually like so: diff --git a/source/_components/awair.markdown b/source/_components/awair.markdown index f21d41eb2579..e5b3c70d9ddd 100644 --- a/source/_components/awair.markdown +++ b/source/_components/awair.markdown @@ -20,7 +20,7 @@ The `awair` sensor platform will fetch data from your [Awair device(s)](https:// You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To enable these sensors, add the following lines to your `configuration.yaml` file: @@ -58,7 +58,7 @@ devices: type: string {% endconfiguration %} -## {% linkable_title Available Sensors %} +## Available Sensors The platform will fetch all available sensors from each Awair device linked to your account. Supported sensors: diff --git a/source/_components/aws.markdown b/source/_components/aws.markdown index 42d8a5cff76d..307bea1572ea 100644 --- a/source/_components/aws.markdown +++ b/source/_components/aws.markdown @@ -15,7 +15,7 @@ ha_release: "0.91" The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions. -## {% linkable_title Setup %} +## Setup You have to have an AWS account to use Amazon Web Services, create one [here](https://aws.amazon.com/free/) with a 12 months free tier benefit. Please note, even in the first 12-months, you may still be billed if you use more resources than offered in the free tier. We advise you to monitor your costs in the [AWS Billing Console](https://console.aws.amazon.com/billing/) closely. You can read the [Control your AWS costs](https://aws.amazon.com/getting-started/tutorials/control-your-costs-free-tier-budgets/) guide for more information. @@ -23,7 +23,7 @@ The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely. -## {% linkable_title Configuration %} +## Configuration To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file: @@ -40,7 +40,7 @@ aws: region_name: us-east-1 ``` -### {% linkable_title Configuration for credentials %} +### Configuration for credentials {% configuration %} name: @@ -66,7 +66,7 @@ validate: type: boolean {% endconfiguration %} -### {% linkable_title Configuration for notify %} +### Configuration for notify {% configuration %} service: @@ -104,7 +104,7 @@ context: type: string {% endconfiguration %} -## {% linkable_title Lambda Notify Usage %} +## Lambda Notify Usage AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke). @@ -132,13 +132,13 @@ The context will look like this: } ``` -## {% linkable_title SNS Notify Usage %} +## SNS Notify Usage AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish). If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes. -### {% linkable_title Setting up SNS within AWS %} +### Setting up SNS within AWS - Log into your AWS console and under "Security and Identity", select "Identity & Access Management". - On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create". @@ -158,7 +158,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the - Repeat for additional numbers. - Back in the "Users" section you will see a long alphanumeric line that starts with "arn:" and ends with the Topic Name you choose previously. This is what your "target" in Home Assistant will be. -## {% linkable_title SQS Notify Usage %} +## SQS Notify Usage AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message) diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown index b1f99ee480c1..f1694d780ba1 100644 --- a/source/_components/axis.markdown +++ b/source/_components/axis.markdown @@ -24,7 +24,7 @@ redirect_from: Home Assistant will automatically discover their presence on your network. -## {% linkable_title Configuration %} +## Configuration For configuration go to the `Integrations pane` on your Home Assistant instance. @@ -32,11 +32,11 @@ For configuration go to the `Integrations pane` on your Home Assistant instance. It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.

-## {% linkable_title Troubleshooting discovery %} +## Troubleshooting discovery If your device is not discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`. -## {% linkable_title Binary Sensor %} +## Binary Sensor The following sensor types are supported: @@ -46,7 +46,7 @@ The following sensor types are supported: - Day/night mode - Inputs and Supervised Inputs -## {% linkable_title Switch %} +## Switch The following controllable port types are supported: diff --git a/source/_components/azure_event_hub.markdown b/source/_components/azure_event_hub.markdown index 7a000e4b5b49..802c77f8f982 100644 --- a/source/_components/azure_event_hub.markdown +++ b/source/_components/azure_event_hub.markdown @@ -15,7 +15,7 @@ ha_release: 0.94 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 a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). -## {% linkable_title First time setup %} +## First time setup This assumes you already have a Azure account. Otherwise create a Free account [here](https://azure.microsoft.com/en-us/free/). @@ -25,7 +25,7 @@ You must then create a Shared Access Policy for the Event Hub with 'Send' claims Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the integration itself. -## {% linkable_title Configuration %} +## Configuration Add the following lines to your `configuration.yaml` file: @@ -92,7 +92,7 @@ filter: 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.

-### {% linkable_title Using the data in Azure %} +### 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). diff --git a/source/_components/baidu.markdown b/source/_components/baidu.markdown index 0bc6c21bf657..43f3cb97911d 100644 --- a/source/_components/baidu.markdown +++ b/source/_components/baidu.markdown @@ -17,7 +17,7 @@ redirect_from: The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices. -## {% linkable_title Configuration %} +## Configuration To get started, add the following lines to your `configuration.yaml`: diff --git a/source/_components/bayesian.markdown b/source/_components/bayesian.markdown index 8b62aa14653f..13bc25c6b9cc 100644 --- a/source/_components/bayesian.markdown +++ b/source/_components/bayesian.markdown @@ -21,7 +21,7 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence. -## {% linkable_title Configuration %} +## Configuration To enable the Bayesian sensor, add the following lines to your `configuration.yaml`: @@ -90,7 +90,7 @@ observations: type: string {% endconfiguration %} -## {% linkable_title Full examples %} +## Full examples The following is an example for the `state` observation platform. diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index 41456239c962..825f7e94611c 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -22,11 +22,11 @@ redirect_from: 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. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). -## {% linkable_title Configuration %} +## Configuration To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -75,11 +75,11 @@ pins: For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. -## {% linkable_title Switch %} +## Switch The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). -## {% linkable_title Configuration %} +## Configuration To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/bbox.markdown b/source/_components/bbox.markdown index 6cea270f5295..639f102092ad 100644 --- a/source/_components/bbox.markdown +++ b/source/_components/bbox.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.

-## {% linkable_title Presence Detection %} +## Presence Detection The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://fr.wikipedia.org/wiki/Bbox) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France. @@ -38,7 +38,7 @@ Bbox is a generic name for different hardware routers. The platform has been tes - Sagem F@st 5330b -### {% linkable_title Configuration %} +### Configuration To use an Bbox router in your installation, add the following to your `configuration.yaml` file: @@ -63,7 +63,7 @@ For now and due to third party limitation, the Bbox must be on the same local ne See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. -## {% linkable_title Sensor %} +## Sensor To add Bbox sensors to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/bh1750.markdown b/source/_components/bh1750.markdown index 4bd83fa5ce46..4a99008a3757 100644 --- a/source/_components/bh1750.markdown +++ b/source/_components/bh1750.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ multiplier: type: integer {% endconfiguration %} -## {% linkable_title Full Examples %} +## Full Examples If you want to specify the resolution mode of the digital sensor or need to change the default I2c address (which is 0x23), add more details to the `configuration.yaml` file. @@ -88,7 +88,7 @@ sensor: scan_interval: 25 ``` -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -112,7 +112,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index b89ee64f261d..6f9e15a22e8a 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors. -## {% linkable_title Configuration %} +## Configuration The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). @@ -51,7 +51,7 @@ reset_after: type: integer {% endconfiguration %} -### {% linkable_title Automation actions %} +### Automation actions You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time. diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index 7b93b7dc7571..650e5770aedb 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -16,7 +16,7 @@ ha_release: 0.9 Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality. -### {% linkable_title Device Class %} +### Device Class The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors: diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown index 4fd3dd2ffca1..f5ecf118eeaa 100644 --- a/source/_components/binary_sensor.modbus.markdown +++ b/source/_components/binary_sensor.modbus.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils. -## {% linkable_title Configuration %} +## Configuration To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file: @@ -62,7 +62,7 @@ coils: It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation. -## {% linkable_title Full example %} +## Full example Example a sensor with a 10 seconds scan interval: diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 3aec89fc4916..4fa2ad249e9d 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -20,7 +20,7 @@ The binary sensor state will be updated only after a new message is published on the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`. -## {% linkable_title Configuration %} +## Configuration The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` is defined, Home Assistant will consider the MQTT device to be available. @@ -134,11 +134,11 @@ device: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section, you will find some real-life examples of how to use this sensor. -### {% linkable_title Full configuration %} +### Full configuration To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. @@ -168,7 +168,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Toggle the binary sensor each time a message is received on state_topic %} +### Toggle the binary sensor each time a message is received on state_topic {% raw %} ```yaml # Example configuration.yaml entry @@ -179,7 +179,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Get the state of a device with ESPEasy %} +### Get the state of a device with ESPEasy Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example, the topics are prefixed with "home". Also, add a "Switch Input" in the "Devices" tap with the name "switch" and "button" as value. diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 34c2559af8a5..26bd943d7076 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -39,7 +39,7 @@ S_MOISTURE | V_TRIPPED For more information, visit the [serial api] of MySensors. -### {% linkable_title Example sketch %} +### Example sketch ```cpp /** diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index b35c6ba008a8..c551709bef91 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -34,7 +34,7 @@ The JSON messages can contain different values like `1`, `"1"`, } ``` -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: @@ -118,11 +118,11 @@ headers: Make sure that the URL exactly matches your endpoint or resource.

-## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title aREST sensor %} +### aREST sensor Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor, you could retrieve the value of a device supporting @@ -138,7 +138,7 @@ binary_sensor: value_template: {% raw %}'{{ value_json.return_value }}'{% endraw %} ``` -### {% linkable_title Accessing an HTTP authentication protected endpoint %} +### Accessing an HTTP authentication protected endpoint The REST sensor supports HTTP authentication and customized headers. diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown index af278eaac7ca..005e11030665 100644 --- a/source/_components/binary_sensor.rflink.markdown +++ b/source/_components/binary_sensor.rflink.markdown @@ -69,15 +69,15 @@ devices: default: false {% endconfiguration %} -### {% linkable_title Sensor state %} +### Sensor state Initially, the state of a binary sensor is unknown. When a sensor update is received, the state is known and will be shown in the frontend. -### {% linkable_title Device support %} +### Device support See [device support](/components/rflink/#device-support) -### {% linkable_title Additional configuration examples %} +### Additional configuration examples Multiple sensors with custom name and device class and set off_delay diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index 2770ffc60a3a..dc0c63f22013 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -23,7 +23,7 @@ them may be recognized under the X10 protocol but most of them are recognized under the *Lighting4* protocol. The rfxtrx binary sensor integration provides some special options for them, while other rfxtrx protocols should work too. -## {% linkable_title Setting up your devices %} +## Setting up your devices Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way to find your binary sensors is to add this to your `configuration.yaml`: @@ -133,7 +133,7 @@ binary_sensor: seconds: 5 ``` -### {% linkable_title Options for PT-2262 devices under the Lighting4 protocol %} +### Options for PT-2262 devices under the Lighting4 protocol When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the @@ -203,7 +203,7 @@ This automatic guess should work most of the time but there is no guarantee on that. You should activate it only when you want to configure your new devices and leave it off otherwise. -### {% linkable_title Known working devices %} +### Known working devices The following devices are known to work with the rfxtrx binary sensor component. There are too many other to list. diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 8212202166ad..48b55320fa03 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -19,7 +19,7 @@ The `template` platform supports binary sensors which get their values from other entities. The state of a Template Binary Sensor can only be `on` or `off`. -## {% linkable_title Configuration %} +## Configuration Here is an example of adding a Template Binary Sensor to the `configuration.yaml` file: @@ -82,7 +82,7 @@ sensors: type: time {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations ### Startup @@ -104,11 +104,11 @@ the contents of a group. In this case you can use `entity_id` to provide a list of entity IDs that will cause the sensor to update or you can run the service `homeassistant.update_entity` to update the sensor at will. -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Sensor Threshold %} +### Sensor Threshold This example indicates true if a sensor is above a given threshold. Assuming a sensor of `furnace` that provides a current reading for the fan motor, we can @@ -126,7 +126,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Switch as Sensor %} +### Switch as Sensor Some movement sensors and door/window sensors will appear as a switch. By using a Template Binary Sensor, the switch can be displayed as a binary sensors. The @@ -147,7 +147,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Combining Multiple Sensors %} +### Combining Multiple Sensors This example combines multiple CO sensors into a single overall status. When using templates with binary sensors, you need to return @@ -168,7 +168,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Washing Machine Running %} +### Washing Machine Running This example creates a washing machine "load running" sensor by monitoring an energy meter connected to the washer. During the washer's operation, the energy @@ -191,7 +191,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Is Anyone Home? %} +### Is Anyone Home? This example is determining if anyone is home based on the combination of device tracking and motion sensors. It's extremely useful if you have kids/baby sitter/ @@ -216,7 +216,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Change the icon when state changes %} +### Change the icon when state changes This example demonstrates how to use `icon_template` to change the entity's icon as its state changes, it evaluates the state of its own sensor and uses a diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index 4aae23f5a9cd..f998800dda5a 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -18,7 +18,7 @@ The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiao The requirement is that you have setup the [`xiaomi aqara` integration](/components/xiaomi_aqara/). -### {% linkable_title Type of sensors supported %} +### Type of sensors supported | Name | Zigbee entity | Model no. | States | Event | Event key | Event values | | ---- | ------------- | --------- | ------ | ----- | --------- | ------------ | @@ -39,9 +39,9 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone | Cube | cube | MFKZQ01LM | off (always) | `xiaomi_aqara.cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) | | Vibration Sensor | vibration | DJT11LM | off (always) | `xiaomi_aqara.movement` | `movement_type` | `vibrate`, `tilt`, `free_fall` | -### {% linkable_title Automation examples %} +### Automation examples -#### {% linkable_title Motion %} +#### Motion ```yaml - alias: If there is motion and its dark turn on the gateway light @@ -78,7 +78,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone entity_id: automation.Motion_off ``` -#### {% linkable_title Door and/or Window %} +#### Door and/or Window ```yaml - alias: If the window is open turn off the radiator @@ -107,7 +107,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone operation_mode: 'Smart schedule' ``` -#### {% linkable_title Smoke %} +#### Smoke ```yaml - alias: Send notification on fire alarm @@ -128,7 +128,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone ringtone_vol: 100 ``` -#### {% linkable_title Gas %} +#### Gas ```yaml - alias: Send notification on gas alarm @@ -144,7 +144,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone message: 'Gas with a density of {% raw %}{{ state_attr('binary_sensor.natgas_sensor_158dxxxxxxxxxx', 'density') }}{% endraw %} detected.' ``` -#### {% linkable_title Xiaomi Wireless Button %} +#### Xiaomi Wireless Button As indicated in the table on top of this page there are 3 versions of the button. For the round shaped button the available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. Aqara branded buttons are square shaped. Model WXKG11LM only supports `single` and `double` events. WXKG12LM supports `single`, `double`, `long_click_press` and `shake` events. For the Aqara versions the delay between two clicks to generate a double click must be larger than with the round button. Clicking too quickly generates a single click event. @@ -184,7 +184,7 @@ As indicated in the table on top of this page there are 3 versions of the button ringtone_vol: 8 ``` -#### {% linkable_title Xiaomi Cube %} +#### Xiaomi Cube Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The integration stores the last action as the attribute `last_action`. @@ -251,7 +251,7 @@ Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swi color_name: "blue" ``` -#### {% linkable_title Aqara Wireless Switch %} +#### Aqara Wireless Switch The Aqara Wireless Switch is available as single-key and double-key version. Each key behaves like the Wireless Button limited to the click event `single`. The double key version adds a third device called `binary_sensor.wall_switch_both_158xxxxxxxxx12` which reports a click event called `both` if both keys are pressed. @@ -312,7 +312,7 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac entity_id: light.gateway_light_34xxxxxxxx13 ``` -#### {% linkable_title Vibration Sensor %} +#### Vibration Sensor This automation toggles the living room lamp on vibration/tilt. diff --git a/source/_components/blackbird.markdown b/source/_components/blackbird.markdown index aaca513c055a..daf32ef63fb0 100644 --- a/source/_components/blackbird.markdown +++ b/source/_components/blackbird.markdown @@ -58,7 +58,7 @@ sources: description: The name of the source. {% endconfiguration %} -### {% linkable_title Service `media_player.blackbird_set_all_zones` %} +### Service `media_player.blackbird_set_all_zones` Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated. diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index aa87420e6476..465f2753dee6 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -25,11 +25,11 @@ redirect_from: The `blink` integration lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. -## {% linkable_title Setup %} +## Setup You will need your Blink login information (username, which is usually your email address, and password) to use this module. -## {% linkable_title Configuration %} +## Configuration To enable devices linked in your [Blink](https://blinkforhome.com) account, add the following to your `configuration.yaml` file: @@ -115,15 +115,15 @@ blink: - wifi_strength ``` -## {% linkable_title Services %} +## Services Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls fro being throttled and ignored. -### {% linkable_title `blink.blink_update` %} +### `blink.blink_update` Force a refresh of the Blink system. -### {% linkable_title `blink.trigger_camera` %} +### `blink.trigger_camera` Trigger a camera to take a new still image. @@ -131,7 +131,7 @@ Trigger a camera to take a new still image. |------------------------|----------|----------------------------------------| | `name` | no | Name of camera to take new image with. | -### {% linkable_title `blink.save_video` %} +### `blink.save_video` Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `whitelist_external_dirs` in your `configuration.yaml` file (see example below). @@ -149,16 +149,16 @@ homeassistant: - '/path/to/whitelist' ``` -### {% linkable_title Other Services %} +### Other Services In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. -## {% linkable_title Examples %} +## Examples The following are some examples showing how to correctly make service calls using Blink: -### {% linkable_title Snap Picture and Save Locally %} +### Snap Picture and Save Locally This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](https://www.home-assistant.io/components/camera#service-snapshot) @@ -176,7 +176,7 @@ sequence: filename: /tmp/my_image.jpg ``` -### {% linkable_title Arm Blink When Away %} +### Arm Blink When Away This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](https://www.home-assistant.io/components/camera#service-enable_motion_detection) but pelase note that motion will only be captured if the sync module is armed. @@ -194,7 +194,7 @@ Here, this example assumes your blink module is named `My Sync Module` and that entity_id: alarm_control_panel.blink_my_sync_module ``` -### {% linkable_title Disarm Blink When Home %} +### Disarm Blink When Home Similar to the previous example, this automation will disarm blink when arriving home. @@ -210,7 +210,7 @@ Similar to the previous example, this automation will disarm blink when arriving entity_id: alarm_control_panel.blink_my_sync_module ``` -### {% linkable_title Save Video Locally When Motion Detected %} +### Save Video Locally When Motion Detected When motion is detected, you can use the Blink Home-Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data. diff --git a/source/_components/blinksticklight.markdown b/source/_components/blinksticklight.markdown index 84549b1edc1c..f0af6ec55def 100644 --- a/source/_components/blinksticklight.markdown +++ b/source/_components/blinksticklight.markdown @@ -19,7 +19,7 @@ redirect_from: The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. -## {% linkable_title Setup %} +## Setup To use your Blinkstick, you need to allow the access to the device for [non-root users](https://github.com/arvydas/blinkstick-python#permission-problems-in-linux-and-mac-os-x). @@ -27,7 +27,7 @@ To use your Blinkstick, you need to allow the access to the device for [non-root $ sudo blinkstick --add-udev-rule ``` -## {% linkable_title Configuration %} +## Configuration To add a Blinkstick to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/blinkt.markdown b/source/_components/blinkt.markdown index 82e8c0899b89..320c456c96c5 100644 --- a/source/_components/blinkt.markdown +++ b/source/_components/blinkt.markdown @@ -18,7 +18,7 @@ redirect_from: The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs. -## {% linkable_title Configuration %} +## Configuration To enable `blinkt` in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index fb698d76d57e..6f10f46ef47e 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -27,11 +27,11 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Setup %} +## Setup Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen. -## {% linkable_title Configuration %} +## Configuration To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: @@ -48,13 +48,13 @@ api_key: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `bloomsky` binary sensor platform allows you to get data from your BloomSky device. To get your BloomSky binary sensors working with Home Assistant, follow the instructions above first. -### {% linkable_title Configuration %} +### Configuration To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -79,11 +79,11 @@ monitored_conditions: description: Rain {% endconfiguration %} -## {% linkable_title Camera %} +## Camera The `bloomsky` camera integration allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](#sensor). -### {% linkable_title Configuration %} +### Configuration To enable this camera in your installation, set up the BloomSky integration with your API key and add the following to your `configuration.yaml` file: @@ -93,11 +93,11 @@ camera: - platform: bloomsky ``` -## {% linkable_title Sensor %} +## Sensor The `bloomsky` sensor integration allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](#camera). -### {% linkable_title Configuration %} +### Configuration To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your `configuration.yaml` file: diff --git a/source/_components/bluesound.markdown b/source/_components/bluesound.markdown index e52956fde090..370c7a4ec399 100644 --- a/source/_components/bluesound.markdown +++ b/source/_components/bluesound.markdown @@ -63,7 +63,7 @@ media_player: - host: 192.168.1.131 ``` -### {% linkable_title Service `bluesound_join` %} +### Service `bluesound_join` Group players together under a single master speaker. That will make a new group or join an existing group. @@ -72,7 +72,7 @@ Group players together under a single master speaker. That will make a new group | `master` | no | A single `entity_id` that will become/hold the master speaker. | `entity_id` | no | String or list of a single `entity_id` that will group to master speaker. -### {% linkable_title Service `bluesound_unjoin` %} +### Service `bluesound_unjoin` Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined. @@ -80,7 +80,7 @@ Remove one or more speakers from a group of speakers. If no `entity_id` is provi | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker. -### {% linkable_title Service `bluesound_set_sleep_timer` %} +### Service `bluesound_set_sleep_timer` Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0. If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0). @@ -89,7 +89,7 @@ If you increase an ongoing timer of for example 13 minutes, it will increase it | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of `entity_id`s that will have their timers set. -### {% linkable_title Service `bluesound_clear_sleep_timer` %} +### Service `bluesound_clear_sleep_timer` Clear the sleep timer on a speaker, if one is set. diff --git a/source/_components/bluetooth_le_tracker.markdown b/source/_components/bluetooth_le_tracker.markdown index c02b89fc1009..aeb85d856921 100644 --- a/source/_components/bluetooth_le_tracker.markdown +++ b/source/_components/bluetooth_le_tracker.markdown @@ -55,7 +55,7 @@ interval_seconds: As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times. Some BTLE devices (e.g., fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device. -## {% linkable_title Rootless Setup %} +## Rootless Setup Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 and hcitool the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). diff --git a/source/_components/bme280.markdown b/source/_components/bme280.markdown index 097b46240f58..501fca6feff3 100644 --- a/source/_components/bme280.markdown +++ b/source/_components/bme280.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file: @@ -90,7 +90,7 @@ monitored_conditions: type: list {% endconfiguration %} -## {% linkable_title Full Examples %} +## Full Examples If you want to specify the working mode of the digital sensor or need to change the default I2c address (which is 0x76), add more details to the `configuration.yaml` file: @@ -115,7 +115,7 @@ sensor: This sensor is somehow famous for generating relatively high temperature measurements compared to other sensors (it looks like self-heating does not feel good for some encapsulations). If you experience this problem, you can define an absolute delta of temperature correction using a negative number. -## {% linkable_title Customizing the sensor data %} +## Customizing the sensor data Give the values friendly names and icons, add the following to your `customize:` section. @@ -146,7 +146,7 @@ group: - sensor.ambient_pressure ``` -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -170,7 +170,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown index a2cd6ce52a1c..b4b997932689 100644 --- a/source/_components/bme680.markdown +++ b/source/_components/bme680.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your BME680 sensor in your installation, add the following to your `configuration.yaml` file: @@ -120,7 +120,7 @@ temp_offset: type: float {% endconfiguration %} -## {% linkable_title Full Examples %} +## Full Examples If you want to specify the working mode of the digital sensor or need to change the default I2C address (which is 0x77), add more details to the `configuration.yaml` file: @@ -149,7 +149,7 @@ sensor: temp_offset: -5.5 ``` -## {% linkable_title Customizing the sensor data %} +## Customizing the sensor data Give the values friendly names and icons, add the following to your `customize:` section. @@ -188,11 +188,11 @@ group: - sensor.bme680_sensor_air_quality ``` -## {% linkable_title Directions for enabling I2C interface on Hass.io %} +## Directions for enabling I2C interface on Hass.io Follow the instructions here to [enable I2C on Hass.io.](/hassio/enable_i2c/). -## {% linkable_title Directions for installing SMBus support on Raspberry Pi %} +## Directions for installing SMBus support on Raspberry Pi Enable I2C interface with the Raspberry Pi configuration utility: @@ -216,7 +216,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the I2C address of the sensor %} +### Check the I2C address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index f3b96b9aa519..0adea3cfc35c 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -36,7 +36,7 @@ This integration provides the following platforms: - Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars). - Services: Turn on air condition, sound the horn, flash the lights and update the state. More details can be found [here](/components/bmw_connected_drive/#services). -## {% linkable_title Configuration %} +## Configuration To enable this integration in your installation, add the following to your `configuration.yaml` file: @@ -79,17 +79,17 @@ bmw_connected_drive: default: false {% endconfiguration %} -## {% linkable_title Services %} +## Services 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 in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. Using these services will impact the state of your vehicle. So use these services with care! -### {% linkable_title Locking and unlocking %} +### Locking and unlocking 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. -### {% linkable_title Air condition %} +### Air condition The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`. @@ -97,20 +97,20 @@ What exactly is started here depends on the type of vehicle. It might range from The vehicle is identified via the parameter `vin`. -### {% linkable_title Sound the horn %} +### 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`. -### {% linkable_title Flash the lights %} +### Flash the lights The service `bmw_connected_drive.light_flash` flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`. -### {% linkable_title Update the state %} +### Update the state 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. -## {% linkable_title Disclaimer %} +## Disclaimer This software is not affiliated with or endorsed by BMW Group. diff --git a/source/_components/bom.markdown b/source/_components/bom.markdown index dd1fbfcd7cd4..ec69cbff90a1 100644 --- a/source/_components/bom.markdown +++ b/source/_components/bom.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To add the BOM weather platform to your installation, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ This platform is an alternative to the [`bom`](#sensor) sensor. The weather platform is easier to configure but less customizable.

-## {% linkable_title Camera %} +## Camera The `bom` camera platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) [radar web service](http://www.bom.gov.au/australia/radar/) as a source to generate an animated radar image. @@ -95,7 +95,7 @@ filename: type: string {% endconfiguration %} -### {% linkable_title Valid `location` values %} +### Valid `location` values ``` Adelaide Albany AliceSprings Bairnsdale Bowen @@ -112,9 +112,9 @@ Weipa WillisIs Wollongong Woomera Wyndham Yarrawonga ``` -### {% linkable_title Examples %} +### Examples -#### {% linkable_title Using `location` and `name` %} +#### Using `location` and `name` Example `configuration.yaml` entry to display the `Townsville` radar with a camera named `mytowsvilleradar`: @@ -125,7 +125,7 @@ camera: location: Townsville ``` -#### {% linkable_title Using `id`, `delta` and `frames` %} +#### Using `id`, `delta` and `frames` In the event BOM creates a new radar, or a radar's ID changes, you may define a custom `id` along with corresponding `delta` and `frames` values. You may also specify custom `delta` and `frames` values, along with a valid `location`, to override the default values for an existing radar. You may not define `location` and `id` in the same entity; you must specify one or the other. If `id` is specified, then `delta` and `frames` values _must_ be provided. If `location` is specified, `delta` and `frames` _may_ be provided to override the default values. @@ -148,7 +148,7 @@ camera: name: 'Carnarvon' ``` -#### {% linkable_title Using `filename` %} +#### Using `filename` This option can be specified to save the animated radar-imagery GIF to the given filesystem path. @@ -163,7 +163,7 @@ camera: The file will be updated every `delta` seconds when the camera regenerates the animation. -## {% linkable_title Sensor %} +## Sensor The `bom` sensor platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data. diff --git a/source/_components/braviatv.markdown b/source/_components/braviatv.markdown index 15ca122bfdfb..4e87c7362fdb 100644 --- a/source/_components/braviatv.markdown +++ b/source/_components/braviatv.markdown @@ -49,11 +49,11 @@ You are also able to configure the TV manually by placing a `bravia.conf` file i {"192.168.0.10": {"pin": "7745", "mac": "ac:1e:0a:e1:0c:01"}} ``` -## {% linkable_title For TVs older than 2013 %} +## For TVs older than 2013 Users of TVs older than 2013 have another option for controlling their TV via Home Assistant. -### {% linkable_title Using HDMI-CEC %} +### Using HDMI-CEC If you have a Raspberry Pi connected to your TV: diff --git a/source/_components/broadcast.markdown b/source/_components/broadcast.markdown index 5c865eeac304..806ee3253aaa 100644 --- a/source/_components/broadcast.markdown +++ b/source/_components/broadcast.markdown @@ -17,7 +17,7 @@ redirect_from: Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot. -## {% linkable_title Configuration %} +## Configuration To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/broadlink.markdown b/source/_components/broadlink.markdown index 55efe41007bd..cefa1cd990e5 100644 --- a/source/_components/broadlink.markdown +++ b/source/_components/broadlink.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Sensor %} +## Sensor The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air. There is currently no support for the cloud API. @@ -110,7 +110,7 @@ sensor: - temperature ``` -### {% linkable_title Microsoft Windows installation %} +### Microsoft Windows installation

The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first. @@ -124,11 +124,11 @@ Be sure to get the correct 64 or 32-bit binary for your system, the full command pip install --use-wheel --no-index --find-links=https://github.com/sfbahr/PyCrypto-Wheels/raw/master/pycrypto-2.6.1-cp35-none-win_amd64.whl pycrypto ``` -## {% linkable_title Switch %} +## Switch This `Broadlink` switch platform allow to you control Broadlink [devices](http://www.ibroadlink.com/). -### {% linkable_title Configuration %} +### Configuration To enable it, add the following lines to your `configuration.yaml`: @@ -208,7 +208,7 @@ slots: Information about how to install on Windows can be found [here](/components/sensor.broadlink/#microsoft-windows-installation). -### {% linkable_title How to obtain IR/RF packets? %} +### How to obtain IR/RF packets? Choose Call Service from the Developer Tools. Choose the service `broadlink.learn` from the list of **Available services:**, write in "Service Data" JSON with 1 field "host":"your_broadlink_IP" and hit **CALL SERVICE**. Press the button on your remote with in 20 seconds. The packet will be printed as a persistent notification in the States page of the web interface. @@ -288,7 +288,7 @@ switch: slot_4: 'Speaker slot' ``` -### {% linkable_title Service `broadlink.send` %} +### Service `broadlink.send` You can use the service `broadlink.send` to directly send IR packets without the need to assign a switch entity for each command. @@ -311,7 +311,7 @@ script: - "JgBGAJSTFDUUNhM2ExITEhMSExITEhM2EzYTNhQRFBEUERQRFBEUNRQ2ExITNhMSExITNhMSExITEhM2ExITNhQ1FBEUNhMADQUAAA==" ``` -### {% linkable_title Using E-Control remotes %} +### Using E-Control remotes If you already have your remotes learned on E-Control app you can use this method to "copy" them to Home Assistant. @@ -359,7 +359,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 8. Convert the HEX codes to base64. Use [this](http://tomeko.net/online_tools/hex_to_base64.php?lang=en1) tool to convert the hex codes to base64 for use with Home Assistant. -### {% linkable_title Using iOS and Windows to obtain codes %} +### Using iOS and Windows to obtain codes 1. Use the E-Control app to learn the codes from all of your suitable remotes. Depending on the remote, try to add useful names for the buttons and/or the remotes. This will mean that you should only have to run this process once and will help with getting them quickly into Home Assistant. Dump the files in the app by navigating to the hamburger icon, select `share and select`, then choose `Share to other phones on WLAN`. @@ -407,7 +407,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your config.yaml file (or wherever you have your switches). -### {% linkable_title Using Windows to obtain codes with Broadlink Manager %} +### Using Windows to obtain codes with Broadlink Manager 1. Install Broadlink Manager from this SourceForge link [here](https://sourceforge.net/projects/broadlink-manager/). 2. Open the application and hit "scan" to activate your broadlink device. @@ -415,7 +415,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 4. The "OnRawData Base64" is the value to be used with Home Assistant. -### {% linkable_title Using Node-RED to obtain codes %} +### Using Node-RED to obtain codes 1. Install the Broadlink Control palette in Node-RED (click the Hamburger menu at top right corner> Settings> Palette> Install and type Broadlink. Click install on the node-red-contrib-broadlink-control. 2. Once installed, verify that the new palette titled broadlink is available in the nodes menu. @@ -452,7 +452,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro ``` This is the code we need to transmit again to replicate the same remote function. -### {% linkable_title Using Node red to Transmit Codes %} +### Using Node red to Transmit Codes 1. Drag another RM node on the same flow we created earlier. The RM node should be configured to the RM device created earlier by default. 2. In the Action field, select - Set from msg.payload -. @@ -479,11 +479,11 @@ The "status" : "OK" at the end is a feedback that the Broadlink RM device is con Now you can add as many template nodes, each having a specific code, and add any type of input nodes to activate the template and transmit the code. -### {% linkable_title Using broadlink_cli to obtain codes %} +### Using broadlink_cli to obtain codes It is also possible to obtain codes using `broadlink_cli` from [python-broadlink](https://github.com/mjg59/python-broadlink) project. -### {% linkable_title Conversion of codes from other projects %} +### Conversion of codes from other projects For old/awkward devices another possibility is to try to get codes by using data gathered by the LIRC project. diff --git a/source/_components/brottsplatskartan.markdown b/source/_components/brottsplatskartan.markdown index 9844385f1d86..008a2d906da6 100644 --- a/source/_components/brottsplatskartan.markdown +++ b/source/_components/brottsplatskartan.markdown @@ -18,7 +18,7 @@ redirect_from: The `brottsplatskartan` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Brottsplatskartan](https://brottsplatskartan.se). The sensor only counts incidents from the current day. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`. @@ -48,12 +48,12 @@ longitude: {% endconfiguration %} -## {% linkable_title Notes %} +## Notes -### {% linkable_title Area %} +### Area Brottsplatskartan captures all incidents in a region, e.g Stockholms län. If area parameter is defined, any latitude and longitude parameters are ignored. -### {% linkable_title Latitude and Longitude %} +### Latitude and Longitude The radius is set to 5 km when using latitude and longitude to monitor an area. It's not possible to explicitly set radius to another value. diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index be89e2b0fc59..b33e41d1c475 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -16,7 +16,7 @@ ha_release: pre 0.7 The `browser` integration provides a service to open URLs in the default browser on the host machine. -## {% linkable_title Configuration %} +## Configuration To load this component, add the following lines to your `configuration.yaml`: @@ -25,14 +25,14 @@ To load this component, add the following lines to your `configuration.yaml`: browser: ``` -#### {% linkable_title Service `browser/browse_url` %} +#### Service `browser/browse_url` | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `url` | no | The URL to open. -### {% linkable_title Usage %} +### Usage To use this service, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/brunt.markdown b/source/_components/brunt.markdown index 3077d4388f8b..20bbf768da09 100644 --- a/source/_components/brunt.markdown +++ b/source/_components/brunt.markdown @@ -18,7 +18,7 @@ redirect_from: The `brunt` platform allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use this sensor, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app. -## {% linkable_title Configuration %} +## Configuration To enable this integration, add the following lines to your `configuration.yaml`: diff --git a/source/_components/bt_smarthub.markdown b/source/_components/bt_smarthub.markdown index e78c068af055..b550004018da 100644 --- a/source/_components/bt_smarthub.markdown +++ b/source/_components/bt_smarthub.markdown @@ -19,7 +19,7 @@ redirect_from: This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router. This router is sometimes referred to as the BT Home Hub 6. -## {% linkable_title Configuration %} +## Configuration To use a BT Smart Hub router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown index 88d54720c6e4..2931cd336f8d 100644 --- a/source/_components/buienradar.markdown +++ b/source/_components/buienradar.markdown @@ -20,7 +20,7 @@ The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a sourc The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). -## {% linkable_title Configuration %} +## Configuration To add the Buienradar weather to your installation, add the following to your `configuration.yaml` file: @@ -50,7 +50,7 @@ forecast: default: true {% endconfiguration %} -### {% linkable_title Full configuration %} +### Full configuration A full configuration example: diff --git a/source/_components/caldav.markdown b/source/_components/caldav.markdown index 62d911f705ae..64bf40cd27d5 100644 --- a/source/_components/caldav.markdown +++ b/source/_components/caldav.markdown @@ -22,7 +22,7 @@ that below). These sensors will be `on` if you have an on going event in that calendar or `off` if the event is later in time, or if there is no event at all. The WebDav calendar get updated roughly every 15 minutes. -### {% linkable_title Prerequisites %} +### Prerequisites You need to have a CalDav server and credentials for it. This integration was tested against [Baikal](http://sabre.io/baikal/) but any integration complying @@ -36,7 +36,7 @@ Python caldav library. On a Debian based system, install them by: $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev ``` -### {% linkable_title Basic Setup %} +### Basic Setup To integrate a WebDav calendar in Home Assistant, add the following section to your `configuration.yaml` file: @@ -65,7 +65,7 @@ your account. Those calendars will be `on` when there is an ongoing event and You have to setup custom calendars in order to take them into account or for advanced event filtering. -### {% linkable_title Custom calendars %} +### Custom calendars You have the possibility to create multiple binary sensors for events that match certain conditions. @@ -134,7 +134,7 @@ custom_calendars: type: string {% endconfiguration %} -### {% linkable_title Sensor attributes %} +### Sensor attributes - **offset_reached**: If set in the event title and parsed out will be on/off once the offset in the title in minutes is reached. So the title Very important meeting !!-10 would trigger this attribute to be on 10 minutes before the event starts. - **all_day**: `True/False` if this is an all day event. Will be `False` if there is no event found. @@ -144,7 +144,7 @@ custom_calendars: - **start_time**: Start time of event. - **end_time**: End time of event. -### {% linkable_title Examples %} +### Examples All events of the calendars "private" and "holidays". Note that all day events are not included. ```yaml diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index b5fcc8477045..9ee52b731e1b 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -22,7 +22,7 @@ configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see. It also exposes a service to add an event to one of your Google Calendars. -## {% linkable_title Prerequisites %} +## Prerequisites Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). @@ -39,7 +39,7 @@ Generate a Client ID and Client Secret on If you are adding more Google API scopes later to the OAuth than just "Google Calendar API" then you need to delete your token file. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google. -## {% linkable_title Configuration %} +## Configuration To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file: @@ -77,7 +77,7 @@ It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars. -## {% linkable_title Calendar Configuration %} +## Calendar Configuration Editing the `google_calendars.yaml` file. @@ -165,7 +165,7 @@ If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.

-### {% linkable_title Sensor attributes %} +### Sensor attributes - **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts. - **all_day**: `true`/`false` if this is an all day event. Will be `false` if there is no event found. @@ -175,7 +175,7 @@ Otherwise everything following the hash sign would be considered a YAML comment. - **start_time**: Start time of event. - **end_time**: End time of event. -### {% linkable_title Service `google.add_event` %} +### Service `google.add_event` You can use the service `google.add_event` to create a new calendar event in a calendar. Calendar id's can be found in the file `google_calendars.yaml`. All dates and times are in your local time, the integration gets your time zone from your `configuration.yaml` file. @@ -194,7 +194,7 @@ You can use the service `google.add_event` to create a new calendar event in a c You either use `start_date_time` and `end_date_time`, or `start_date` and `end_date`, or `in`.

-## {% linkable_title Using calendar in automations %} +## Using calendar in automations A calendar can be used as an external scheduler for special events or reoccurring events instead of hardcoding them in automations. diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown index 57e93d7d9f30..3240f027f2e6 100644 --- a/source/_components/camera.ffmpeg.markdown +++ b/source/_components/camera.ffmpeg.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](http://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem. -## {% linkable_title Configuration %} +## Configuration To enable your FFmpeg feed in your installation you must first configure the [ffmpeg integration](/components/ffmpeg/), then add the following to your `configuration.yaml` file: @@ -43,7 +43,7 @@ extra_arguments: default: "-pred 1" {% endconfiguration %} -### {% linkable_title Image quality %} +### Image quality You can control the image quality with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`. Default is lossless. diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index 8df12502fddf..22eba9e3fbfe 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -16,7 +16,7 @@ ha_release: 0.7 The camera integration allows you to use IP cameras with Home Assistant. -### {% linkable_title Streaming Video %} +### Streaming Video If your camera supports it, and the [`stream`](/components/stream) integration is setup, you will be able to stream your cameras in the frontend and on supported media players. @@ -28,13 +28,13 @@ This option will keep the stream alive, and preload the feed on Home Assistant s

-### {% linkable_title Services %} +### Services Once loaded, the `camera` platform will expose services that can be called to perform various actions. Available services: `turn_on`, `turn_off`, `enable_motion_detection`, `disable_motion_detection`, `snapshot`, and `play_stream`. -#### {% linkable_title Service `play_stream` %} +#### Service `play_stream` Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) integration to be set up. @@ -54,7 +54,7 @@ action: media_player: media_player.chromecast ``` -#### {% linkable_title Service `turn_on` %} +#### Service `turn_on` Turn on camera. Not all camera models support this service, please consult individual camera page. @@ -62,7 +62,7 @@ Turn on camera. Not all camera models support this service, please consult indiv | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `turn_off` %} +#### Service `turn_off` Turn off camera. Not all camera models support this service, please consult individual camera page. @@ -70,7 +70,7 @@ Turn off camera. Not all camera models support this service, please consult indi | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `enable_motion_detection` %} +#### Service `enable_motion_detection` Enable the motion detection in a camera. @@ -78,7 +78,7 @@ Enable the motion detection in a camera. | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `disable_motion_detection` %} +#### Service `disable_motion_detection` Disable the motion detection in a camera. @@ -86,7 +86,7 @@ Disable the motion detection in a camera. | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `snapshot` %} +#### Service `snapshot` Take a snapshot from a camera. @@ -109,7 +109,7 @@ action: ``` {% endraw %} -#### {% linkable_title Service `record` %} +#### Service `record` Make a `.mp4` recording from a camera stream. Requires `stream` integration to be set up. @@ -136,7 +136,7 @@ action: ``` {% endraw %} -### {% linkable_title Test if it works %} +### Test if it works A simple way to test if you have set up your `camera` platform correctly, is to use service developer tool icon **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 54d3a965af53..b3574c644e8e 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -18,7 +18,7 @@ The `mqtt` camera platform allows you to integrate the content of an image file This can be used with an application or a service capable of sending images through MQTT, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito). -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index c115703c1e57..3ecdd85df5ab 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration You will need your Canary login information (username, usually your email address, and password) to use this module. @@ -65,13 +65,13 @@ Once loaded, your front end will have the following integrations: - A sensor per camera that reports humidity. - A sensor per camera that reports air quality. -## {% linkable_title Camera %} +## Camera The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` integration](/components/ffmpeg/) to be already configured. Once you have [Canary integration](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically. -## {% linkable_title Configuration %} +## Configuration You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings: @@ -87,7 +87,7 @@ ffmpeg_arguments: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant. diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 09529e9567b8..02d31753b959 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -21,7 +21,7 @@ discovered if you enable [the discovery integration(/components/discovery/). If you don't have the discovery integration enabled, you can enable the Cast integration by going to the Integrations page inside the config panel. -## {% linkable_title Advanced use %} +## Advanced use The Cast integration has some extra configuration options available for advanced users. You will still need to create a config entry to initialize the Cast diff --git a/source/_components/cert_expiry.markdown b/source/_components/cert_expiry.markdown index a4dc3144eb07..e6719b83b4fb 100644 --- a/source/_components/cert_expiry.markdown +++ b/source/_components/cert_expiry.markdown @@ -18,7 +18,7 @@ redirect_from: The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. -## {% linkable_title Configuration %} +## Configuration To add the Certificate Expiry sensor to your installation, add these options to `configuration.yaml` file: diff --git a/source/_components/channels.markdown b/source/_components/channels.markdown index f5a79bdb99aa..9ab1f12dc0d4 100644 --- a/source/_components/channels.markdown +++ b/source/_components/channels.markdown @@ -48,7 +48,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Service `channels_seek_forward` %} +### Service `channels_seek_forward` Seek forward by the number of seconds currently set in settings on the instance of Channels. @@ -57,7 +57,7 @@ Seek forward by the number of seconds currently set in settings on the instance | `entity_id` | no | String that points at `entity_id` of Channels app. -### {% linkable_title Service `channels_seek_backward` %} +### Service `channels_seek_backward` Seek backward by the number of seconds currently set in settings on the instance of Channels. @@ -65,7 +65,7 @@ Seek backward by the number of seconds currently set in settings on the instance | ---------------------- | -------- | ----------- | | `entity_id` | no | String that points at `entity_id` of Channels app. -### {% linkable_title Service `channels_seek_by` %} +### Service `channels_seek_by` Seek forward or backward by a provided number of seconds. diff --git a/source/_components/cisco_webex_teams.markdown b/source/_components/cisco_webex_teams.markdown index a2d49717d66e..149fbea8f536 100644 --- a/source/_components/cisco_webex_teams.markdown +++ b/source/_components/cisco_webex_teams.markdown @@ -38,7 +38,7 @@ notify: room_id: CISCO_WEBEX_TEAMS_ROOMID ``` -## {% linkable_title Rich Text Formatting %} +## Rich Text Formatting Webex Teams clients can render rich text via a whitelisted set of html tags. diff --git a/source/_components/citybikes.markdown b/source/_components/citybikes.markdown index ef003ed52d81..aa904d950919 100644 --- a/source/_components/citybikes.markdown +++ b/source/_components/citybikes.markdown @@ -18,7 +18,7 @@ redirect_from: The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. -## {% linkable_title Configuration %} +## Configuration To enable it, add the following lines to your `configuration.yaml`: @@ -59,7 +59,7 @@ stations: {% endconfiguration %} -## {% linkable_title Example %} +## Example Additional configuration samples: diff --git a/source/_components/clickatell.markdown b/source/_components/clickatell.markdown index 15718dab4b3f..0c2ccc317d30 100644 --- a/source/_components/clickatell.markdown +++ b/source/_components/clickatell.markdown @@ -17,7 +17,7 @@ redirect_from: The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. -## {% linkable_title Setup %} +## Setup Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following: @@ -28,7 +28,7 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se 5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide. 6. Once you have completed entering your details an API key is generated. Copy the API key. -## {% linkable_title Configuration %} +## Configuration To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file: diff --git a/source/_components/clicksend.markdown b/source/_components/clicksend.markdown index 406de2dd0600..e83092f98446 100644 --- a/source/_components/clicksend.markdown +++ b/source/_components/clicksend.markdown @@ -18,11 +18,11 @@ redirect_from: The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant. -## {% linkable_title Prerequisites %} +## Prerequisites Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`. -## {% linkable_title Configuration %} +## Configuration To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index d19d54f49c6d..8b6bd73bc9ad 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -16,16 +16,16 @@ ha_release: 0.19 The `climate` integration is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices. -## {% linkable_title Services %} +## Services -### {% linkable_title Climate control services %} +### Climate control services Available services: `climate.set_aux_heat`, `climate.set_away_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_operation_mode`, `climate.set_swing_mode`, `climate.set_hold_mode`, `climate.turn_on`, `climate.turn_off`

Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking service developer tool icon **Services**.

-### {% linkable_title Service `climate.set_aux_heat` %} +### Service `climate.set_aux_heat` Turn auxiliary heater on/off for climate device @@ -34,7 +34,7 @@ Turn auxiliary heater on/off for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `aux_heat` | no | New value of auxiliary heater. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -48,7 +48,7 @@ automation: aux_heat: true ``` -### {% linkable_title Service `climate.set_away_mode` %} +### Service `climate.set_away_mode` Set away mode for climate device. The away mode changes the target temperature permanently to a temperature reflecting a situation where the climate device is set to save energy. This may be used to emulate a @@ -59,7 +59,7 @@ reflecting a situation where the climate device is set to save energy. This may | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `away_mode` | no | New value of away mode. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -74,7 +74,7 @@ automation: ``` -### {% linkable_title Service `climate.set_hold_mode` %} +### Service `climate.set_hold_mode` Set hold mode for climate device. The hold mode changes the target temperature of the client device temporarily to a different temperature. Typical hold modes provided by a climate device are "away" or "home", where the hold temperature @@ -86,7 +86,7 @@ temporary target temperature. The particular modes available depend on the clima | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `hold_mode` | no | New value of hold mode. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -100,7 +100,7 @@ automation: hold_mode: 'away' ``` -### {% linkable_title Service `climate.set_temperature` %} +### Service `climate.set_temperature` Set target temperature of climate device @@ -112,7 +112,7 @@ Set target temperature of climate device | `target_temp_low` | yes | New target low temperature for hvac | `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -127,7 +127,7 @@ automation: operation_mode: Heat ``` -### {% linkable_title Service `climate.set_humidity` %} +### Service `climate.set_humidity` Set target humidity of climate device @@ -136,7 +136,7 @@ Set target humidity of climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `humidity` | no | New target humidity for climate device -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -150,7 +150,7 @@ automation: humidity: 60 ``` -### {% linkable_title Service `climate.set_fan_mode` %} +### Service `climate.set_fan_mode` Set fan operation for climate device @@ -159,7 +159,7 @@ Set fan operation for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `fan_mode` | no | New value of fan mode -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -173,7 +173,7 @@ automation: fan_mode: 'On Low' ``` -### {% linkable_title Service `climate.set_operation_mode` %} +### Service `climate.set_operation_mode` Set operation mode for climate device @@ -182,7 +182,7 @@ Set operation mode for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `operation_mode` | no | New value of operation mode -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -196,7 +196,7 @@ automation: operation_mode: Heat ``` -### {% linkable_title Service `climate.set_swing_mode` %} +### Service `climate.set_swing_mode` Set operation mode for climate device @@ -205,7 +205,7 @@ Set operation mode for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `swing_mode` | no | New value of swing mode -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -218,7 +218,7 @@ automation: entity_id: climate.kitchen swing_mode: 1 ``` -### {% linkable_title Service `climate.turn_on` %} +### Service `climate.turn_on` Turn climate device on @@ -226,7 +226,7 @@ Turn climate device on | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Targets all when omitted. -### {% linkable_title Service `climate.turn_off` %} +### Service `climate.turn_off` Turn climate device off diff --git a/source/_components/climate.modbus.markdown b/source/_components/climate.modbus.markdown index 74838e0d4204..aa6a702ba7a8 100644 --- a/source/_components/climate.modbus.markdown +++ b/source/_components/climate.modbus.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `modbus` thermostat allows you to use a sensor value (current temperature) and target value (target temperature) from [Modbus](http://www.modbus.org/) registers. -## {% linkable_title Configuration %} +## Configuration To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ precision: {% endconfiguration %} -### {% linkable_title Services %} +### Services | Service | Description | | ------- | ----------- | diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index bc4204808be2..6e083ba1fd10 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -20,7 +20,7 @@ The platform currently works in optimistic mode, which means it does not obtain It uses a sensor under the hood to obtain the current temperature. -## {% linkable_title Configuration %} +## Configuration To enable this climate platform in your installation, first add the following to your `configuration.yaml` file: @@ -267,11 +267,11 @@ device: type: string {% endconfiguration %} -#### {% linkable_title Optimistic mode %} +#### Optimistic mode If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. -#### {% linkable_title Using Templates %} +#### Using Templates For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topis can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting. @@ -295,7 +295,7 @@ climate: This will parse the incoming `"auto"` as JSON, resulting in `auto`. Obviously, in this case you could also just set `value_template: {% raw %}"{{ value_json }}"{% endraw %}`. -### {% linkable_title Example %} +### Example A full configuration example looks like the one below. diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index a2979394e0ba..d53c2a89f472 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -44,7 +44,7 @@ You can use V_TEMP to send the current temperature from the node to Home Assista For more information, visit the [serial api] of MySensors. -### {% linkable_title Example sketch for MySensors 2.x %} +### Example sketch for MySensors 2.x ```cpp @@ -190,7 +190,7 @@ void sendHeatpumpCommand() { } ``` -### {% linkable_title Example sketch for MySensors 1.x %} +### Example sketch for MySensors 1.x ```cpp /* diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index 5334b6a996a0..a2105b84750e 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -17,11 +17,11 @@ With the `cloudflare` integration can you keep your Cloudflare records up to dat The integration will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. -## {% linkable_title Setup %} +## Setup You will find your global API key in your Cloudflare account settings. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/co2signal.markdown b/source/_components/co2signal.markdown index 4c283286897b..bd31a054c30d 100644 --- a/source/_components/co2signal.markdown +++ b/source/_components/co2signal.markdown @@ -26,7 +26,7 @@ At the moment, the free CO2Signal API only supports the average carbon intensity The "free" API key is limited to a limited number of calls. Too many requests can result in data loss.

-## {% linkable_title Configuration %} +## Configuration To set up this platform, get your [API key](https://www.co2signal.com/) and add the following lines to your `configuration.yaml` file: @@ -78,7 +78,7 @@ sensor: country_code: YOUR_COUNTRY_CODE ``` -## {% linkable_title Example Configurations %} +## Example Configurations Configuration using custom latitude and longitude: @@ -99,7 +99,7 @@ sensor: country_code: BE ``` -## {% linkable_title Sensor Types %} +## Sensor Types When configured, the platform will create one sensor for each configured location. diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index 18bd47eb6564..22854c1ca445 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -21,7 +21,7 @@ The `coinbase` integration lets you access account balances and exchange rates f You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the integration to access relevant data. -## {% linkable_title Configuration %} +## Configuration To set it up, add the following information to your `configuration.yaml` file: @@ -54,7 +54,7 @@ exchange_rate_currencies: Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g. BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies). -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/command_line.markdown b/source/_components/command_line.markdown index 76fd3b8e9c46..7c182c757bc6 100644 --- a/source/_components/command_line.markdown +++ b/source/_components/command_line.markdown @@ -18,7 +18,7 @@ redirect_from: The `command_line` binary sensor platform issues specific commands to get data. -## {% linkable_title Configuration %} +## Configuration To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -72,11 +72,11 @@ command_timeout: default: 15 {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title SickRage %} +### SickRage Check the state of an [SickRage](https://github.com/sickragetv/sickrage) instance. @@ -91,7 +91,7 @@ binary_sensor: payload_off: "Not running" ``` -### {% linkable_title Check RasPlex %} +### Check RasPlex Check if [RasPlex](http://www.rasplex.com/) is `online`. @@ -119,7 +119,7 @@ binary_sensor: Consider to use the [`ping` sensor ](/components/binary_sensor.ping/) as an alternative to the samples above. -### {% linkable_title Check if a system service is running %} +### Check if a system service is running The services running is listed in `/etc/systemd/system` and can be checked with the `systemctl` command: diff --git a/source/_components/concord232.markdown b/source/_components/concord232.markdown index d5e4f5f4f12e..9c9a051fdb8d 100644 --- a/source/_components/concord232.markdown +++ b/source/_components/concord232.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Alarm](#alarm-control-panel) - [Binary Sensor](#binary-sensor) -## {% linkable_title Alarm Control Panel %} +## Alarm Control Panel To enable the alarm control panel platform, add the following lines to your `configuration.yaml`: @@ -58,7 +58,7 @@ mode: default: audible {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor To enable the binary sensor platform, add the following lines to your `configuration.yaml`: diff --git a/source/_components/config.markdown b/source/_components/config.markdown index bee75a2f332d..d11115d85194 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -23,15 +23,15 @@ To enable the configuration panel, add the following to your `configuration.yaml config: ``` -### {% linkable_title Integrations %} +### Integrations This section enables you to manage integrations for devices such as Philips Hue and Sonos from within Home Assistant. -### {% linkable_title Users %} +### Users This section enables you to manage your Home Assistant users. -### {% linkable_title General %} +### General This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, scripts, automations, and the Home Assistant process itself with a single mouse click. @@ -39,18 +39,18 @@ This section enables you to control Home Assistant from within Home Assistant. C

-### {% linkable_title Customization %} +### Customization This section enables you to customize entities within Home Assistant. Use this to set friendly names, change icons, hide entities, and modify other attributes. -### {% linkable_title Automation %} +### Automation This section enables you to create and modify automations from within Home Assistant, without needing to write out the yaml code. -### {% linkable_title Script %} +### Script Similar to the automation editor, this section enables you to create and modify scripts from within Home Assistant, without needing to write out the yaml code. -### {% linkable_title Z-Wave %} +### Z-Wave This section enables you to control your Z-Wave network and devices from within Home Assistant. You can add and remove devices, as well as change device specific configuration variables. diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index 4aae2f49683c..dd8a5fcb2de9 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -38,7 +38,7 @@ intents: type: list {% endconfiguration %} -## {% linkable_title Adding custom sentences %} +## Adding custom sentences By default, it will support turning devices on and off. You can say things like "turn on kitchen lights" or "turn the living room lights off". You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the [intent script integration](/components/intent_script/) to handle these intents. @@ -57,7 +57,7 @@ intent_script: text: It is currently {% raw %}{{ states.sensor.temperature }}{% endraw %} degrees in the living room. ``` -## {% linkable_title Adding advanced custom sentences %} +## Adding advanced custom sentences Sentences can contain slots (marked with curly braces: `{name}`) and optional words (marked with square brackets: `[the]`). The values of slots will be passed on to the intent and are available inside the templates. @@ -91,7 +91,7 @@ intent_script: {% endraw %} ``` -#### {% linkable_title Service `conversation.process` %} +#### Service `conversation.process` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index 2ecc7ea4a318..1c4a493efcdd 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -16,7 +16,7 @@ ha_qa_scale: internal The `counter` integration allows one to count occurrences fired by automations. -## {% linkable_title Configuration %} +## Configuration To add a counter to your installation, add the following to your `configuration.yaml` file: @@ -70,17 +70,17 @@ counter: Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance` or `mdi:motorbike`. -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`. If `restore` is set to `false`, the `initial` value will only be used when no previous state is found or when the counter is reset. -## {% linkable_title Services %} +## Services Available services: `increment`, `decrement`, and `reset`. -#### {% linkable_title Service `counter.increment` %} +#### Service `counter.increment` Increments the counter with 1 or the given value for the steps. @@ -88,7 +88,7 @@ Increments the counter with 1 or the given value for the steps. | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | -#### {% linkable_title Service `counter.decrement` %} +#### Service `counter.decrement` Decrements the counter with 1 or the given value for the steps. @@ -96,7 +96,7 @@ Decrements the counter with 1 or the given value for the steps. | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | -#### {% linkable_title Service `counter.reset` %} +#### Service `counter.reset` With this service the counter is reset to its initial value. @@ -104,7 +104,7 @@ With this service the counter is reset to its initial value. | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | -#### {% linkable_title Service `counter.configure` %} +#### Service `counter.configure` With this service the properties of the counter can be changed while running. @@ -117,7 +117,7 @@ With this service the properties of the counter can be changed while running. -### {% linkable_title Use the service %} +### Use the service Select service developer tool icon **Services** from the **Developer Tools**. Choose **counter** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown index 3ebb35ddc3ff..8326fc6ea048 100644 --- a/source/_components/cover.command_line.markdown +++ b/source/_components/cover.command_line.markdown @@ -70,11 +70,11 @@ covers: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Full configuration %} +### Full configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown index 5512be8fefbf..824ab062413c 100644 --- a/source/_components/cover.group.markdown +++ b/source/_components/cover.group.markdown @@ -40,6 +40,6 @@ cover: type: [string | list] {% endconfiguration %} -## {% linkable_title Functionality %} +## Functionality It works best if you group covers with the same supported features together (like support for `open`/`close`/`stop`/`position`/`tilt controls`), but is not limited to it. In case you have bundled covers with different features together, the controls will only affect those covers that support the actions. diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown index 99c934289e7e..a4fa15639e35 100644 --- a/source/_components/cover.markdown +++ b/source/_components/cover.markdown @@ -16,7 +16,7 @@ ha_release: 0.27 Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors. -## {% linkable_title Device Class %} +## Device Class The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers: @@ -31,9 +31,9 @@ The way these sensors are displayed in the frontend can be modified in the [cust - **shutter**: Control of shutters, which are linked slats that swing out/in to covering an opening or may be tilted to partially cover an opening, such as indoor or exterior window shutters. - **window**: Control of a physical window that opens and closes or may tilt. -## {% linkable_title Services %} +## Services -### {% linkable_title Cover control services %} +### Cover control services Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, `cover.toggle`, `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt` @@ -41,7 +41,7 @@ Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Else targets all. -### {% linkable_title Service `cover.set_cover_position` %} +### Service `cover.set_cover_position` Set cover position of one or multiple covers. @@ -50,7 +50,7 @@ Set cover position of one or multiple covers. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Else targets all. | `position` | no | Integer between 0 and 100. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -64,7 +64,7 @@ automation: position: 50 ``` -### {% linkable_title Service `cover.set_cover_tilt_position` %} +### Service `cover.set_cover_tilt_position` Set cover tilt position of one or multiple covers. @@ -73,7 +73,7 @@ Set cover tilt position of one or multiple covers. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Else targets all. | `tilt_position` | no | Integer between 0 and 100. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 72b3dca8660d..360e72847515 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -16,7 +16,7 @@ ha_release: 0.18 The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter or a garage door). -## {% linkable_title Configuration %} +## Configuration The device state (`open` or `closed`) will be updated only after a new message is published on `state_topic` matching `state_open` or `state_closed`. If these messages are published with the `retain` flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`. `state_topic` can only manage `state_open` and `state_closed`. No percentage positons etc. @@ -225,11 +225,11 @@ device: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this platform. -### {% linkable_title Full configuration state topic without tilt %} +### Full configuration state topic without tilt The example below shows a full configuration for a cover without tilt with state topic only. @@ -256,7 +256,7 @@ cover: ``` {% endraw %} -### {% linkable_title Full configuration position topic without tilt %} +### Full configuration position topic without tilt The example below shows a full configuration for a cover without tilt with position topic. @@ -284,7 +284,7 @@ cover: ``` {% endraw %} -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a cover. diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown index 4e0fb43fa011..02bf53334439 100644 --- a/source/_components/cover.mysensors.markdown +++ b/source/_components/cover.mysensors.markdown @@ -35,7 +35,7 @@ All V_TYPES above are required. Use V_PERCENTAGE (or V_DIMMER) if you know the e For more information, visit the [serial api] of MySensors. -### {% linkable_title Example sketch %} +### Example sketch ```cpp /* diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 06fd87054b0b..91148dd676d4 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -20,7 +20,7 @@ First, you have to set up your [RFLink hub](/components/rflink/). After configuring the RFLink hub, covers will be automatically discovered and added. Except the Somfy RTS devices. -### {% linkable_title Setting up a Somfy RTS device %} +### Setting up a Somfy RTS device You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows only). @@ -132,11 +132,11 @@ devices: type: [list, string] {% endconfiguration %} -### {% linkable_title Device support %} +### Device support See [device support](/components/rflink/#device-support). -### {% linkable_title Additional configuration examples %} +### Additional configuration examples Multiple covers with custom names and aliases diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown index c098a1d9bf90..29bd87625491 100644 --- a/source/_components/cover.rfxtrx.markdown +++ b/source/_components/cover.rfxtrx.markdown @@ -17,9 +17,9 @@ The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that First you have to set up your [rfxtrx hub](/components/rfxtrx/). -### {% linkable_title Configuration %} +### Configuration -##### {% linkable_title Siemens/LightwaveRF %} +##### Siemens/LightwaveRF The easiest way to find your roller shutters is to add this to your `configuration.yaml`: @@ -41,11 +41,11 @@ cover: name: device_name ``` -##### {% linkable_title RFY %} +##### RFY The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`. -##### {% linkable_title Common %} +##### Common Example configuration: diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 7f93b55e9820..a363bd9cc490 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -19,7 +19,7 @@ The `template` platform can create covers that combine integrations and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover. -## {% linkable_title Configuration %} +## Configuration To enable Template Covers in your installation, add the following to your `configuration.yaml` file: @@ -108,7 +108,7 @@ cover: type: template {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations If you are using the state of a platform that takes extra time to load, the Template Cover may get an `unknown` state during startup. This results in error @@ -120,7 +120,7 @@ with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} -## {% linkable_title Optimistic Mode %} +## Optimistic Mode In optimistic mode, the cover position state is maintained internally. This mode is automatically enabled if neither [`value_template`](#value_template) or @@ -132,11 +132,11 @@ There is an equivalent mode for `tilt_position` that is enabled when [`tilt_template`](#tilt_template) is not specified or when the [`tilt_optimistic`](#tilt_optimistic) attribute is used. -## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this cover. -### {% linkable_title Garage Door %} +### Garage Door This example converts a garage door with a controllable switch and position sensor into a cover. @@ -170,7 +170,7 @@ cover: ``` {% endraw %} -### {% linkable_title Multiple Covers %} +### Multiple Covers This example allows you to control two or more covers at once. @@ -257,7 +257,7 @@ automation: ``` {% endraw %} -### {% linkable_title Change The Icon %} +### Change The Icon This example shows how to change the icon based on the cover state. @@ -290,7 +290,7 @@ cover: ``` {% endraw %} -### {% linkable_title Change The Entity Picture %} +### Change The Entity Picture This example shows how to change the entity picture based on the cover state. diff --git a/source/_components/cpuspeed.markdown b/source/_components/cpuspeed.markdown index af09719b0dfa..acd55e0bc844 100644 --- a/source/_components/cpuspeed.markdown +++ b/source/_components/cpuspeed.markdown @@ -24,7 +24,7 @@ The `cpuspeed` sensor platform to allow you to monitor the current CPU speed. You can't use this sensor in a Container (like Hass.io) as it requires access to the physical CPU. Also, not all [ARM CPUs](https://github.com/workhorsy/py-cpuinfo/#cpu-support) are supported.

-## {% linkable_title Configuration %} +## Configuration To add this platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/crimereports.markdown b/source/_components/crimereports.markdown index da79b5880274..84f66326c880 100644 --- a/source/_components/crimereports.markdown +++ b/source/_components/crimereports.markdown @@ -18,7 +18,7 @@ redirect_from: The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](https://www.crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. @@ -57,13 +57,13 @@ exclude: {% endconfiguration %} -## {% linkable_title Notes %} +## Notes -### {% linkable_title Area %} +### Area Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone. -### {% linkable_title Incident Types %} +### Incident Types You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified. @@ -104,6 +104,6 @@ These incident types are available: - Vehicle Stop - Weapons Offense -### {% linkable_title Events %} +### Events The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, description, time, location, and coordinates of the incident. diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 110c245418f5..bebcb82cf42b 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -28,13 +28,13 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Supported hardware %} +## Supported hardware - The European versions of the Wifi Controller Unit (BRP069A41, 42, 43, 45), which is powered by the [Daikin Online Controller](https://play.google.com/store/apps/details?id=eu.daikin.remoapp) application. - The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [DAIKIN Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) ([Android version](https://play.google.com/store/apps/details?id=eu.daikin.remoapp)) application. - The Australian version of the Daikin Wifi Controller for **AirBase** units (BRP15B61), which is powered by the [Daikin Airbase](https://play.google.com/store/apps/details?id=au.com.daikin.airbase) application. -## {% linkable_title Configuration %} +## Configuration The Daikin integration can be configured in three ways. @@ -57,7 +57,7 @@ hosts: type: list {% endconfiguration %} -## {% linkable_title Climate %} +## Climate The `daikin` climate platform integrates Daikin air conditioning systems into Home Assistant, enabling control of setting the following parameters: @@ -74,7 +74,7 @@ Current inside temperature is displayed. Some models do not support setting of **fan speed** or **swing mode**.

-## {% linkable_title Sensor %} +## Sensor The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters: @@ -85,7 +85,7 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom Some models only report outside temperature when they are turned on.

-## {% linkable_title Switch %} +## Switch Daikin AirBase units exposes zones (typically rooms) that can be switched on/off individually. diff --git a/source/_components/danfoss_air.markdown b/source/_components/danfoss_air.markdown index 4c0949d006b4..2baa37ef1112 100644 --- a/source/_components/danfoss_air.markdown +++ b/source/_components/danfoss_air.markdown @@ -44,13 +44,13 @@ host: type: string {% endconfiguration %} -## {% linkable_title Binary sensor %} +## Binary sensor The following binary sensor is supported. - **Bypass active:** Indicator if heat recovery is currrently bypassed. -## {% linkable_title Sensor %} +## Sensor The following sensors are supported. @@ -60,7 +60,7 @@ The following sensors are supported. - **Exhaust temperature:** Exhausted air temperature. - **Remaining filter lifetime:** Reamining filter lifetime measured in percent. -## {% linkable_title Switch %} +## Switch The following switches are supported. diff --git a/source/_components/darksky.markdown b/source/_components/darksky.markdown index 33757a911796..896f5d3717fb 100644 --- a/source/_components/darksky.markdown +++ b/source/_components/darksky.markdown @@ -19,7 +19,7 @@ redirect_from: The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](http://www.openstreetmap.org/). -## {% linkable_title Setup %} +## Setup You need an API key which is free but requires [registration](https://darksky.net/dev/register). You can make up to 1000 calls per day for free which means that you could make one approximately every 86 seconds. @@ -27,7 +27,7 @@ You need an API key which is free but requires [registration](https://darksky.ne [Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.

-## {% linkable_title Configuration %} +## Configuration To add Dark Sky to your installation, add the following to your `configuration.yaml` file: @@ -163,7 +163,7 @@ scan_interval: Please note that some monitored conditions, such as `temperature_high` or `temperature_low`, may only work when setting the `forecast` attribute to at least `0` (current day).

-#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -175,7 +175,7 @@ scan_interval: milliseconds: 0 ``` -#### {% linkable_title Language options %} +#### Language options All language options are described in this table that you can use for the dark sky sensor. diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index faa9093bc22d..89c7a7a14c46 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -44,16 +44,16 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Recommended way of running deCONZ %} +## Recommended way of running deCONZ If you are running Hass.io, an official add-on for Deconz is available in the add-on store. Otherwise, use [community container](https://hub.docker.com/r/marthoc/deconz/) by Marthoc for your deCONZ needs. -### {% linkable_title Supported devices %} +### Supported devices See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices) for a list of supported devices. -## {% linkable_title Configuration %} +## Configuration Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file. @@ -61,7 +61,7 @@ If you don't have the API key, you can generate an API key for deCONZ by using t You can manually add deCONZ by going to the integrations page. -## {% linkable_title Debugging integration %} +## Debugging integration If you have problems with deCONZ or the integration you can add debug prints to the log. @@ -73,11 +73,11 @@ logger:    homeassistant.components.deconz: debug ``` -## {% linkable_title Device services %} +## Device services Available services: `configure` and `deconz.device_refresh`. -### {% linkable_title Service `deconz.configure` %} +### Service `deconz.configure` Set attribute of device in deCONZ using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/). @@ -97,13 +97,13 @@ Either `entity` or `field` must be provided. If both are present, `field` will b { "field": "/config", "data": {"permitjoin": 60} } -#### {% linkable_title Service `deconz.device_refresh` %} +#### Service `deconz.device_refresh` Refresh with devices added to deCONZ after Home Assistants latest restart. Note: deCONZ automatically signals Home Assistant when new sensors are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant. -## {% linkable_title Remote control devices %} +## Remote control devices Remote controls (ZHASwitch category) will not be exposed as regular entities, but as events named `deconz_event` with a payload of `id` and `event`. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level. @@ -120,11 +120,11 @@ Where for example on a Philips Hue Dimmer, 2001 would be holding the dim up butt For the IKEA Tradfri remote the first digit equals, 1 for the middle button, 2 for up, 3 for down, 4 for left, and 5 for right (e.g., "event: 1002" for middle button short release). -## {% linkable_title Examples %} +## Examples -### {% linkable_title YAML %} +### YAML -#### {% linkable_title Step up and step down input number with wireless dimmer %} +#### Step up and step down input number with wireless dimmer {% raw %} @@ -177,9 +177,9 @@ automation: {% endraw %} -### {% linkable_title Appdaemon %} +### Appdaemon -#### {% linkable_title Appdaemon event helper %} +#### Appdaemon event helper Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data. @@ -216,7 +216,7 @@ class DeconzHelper(hass.Hass): Note: the event will not be visible before one event gets sent. -#### {% linkable_title Appdaemon remote template %} +#### Appdaemon remote template {% raw %} @@ -252,7 +252,7 @@ class RemoteControl(hass.Hass): {% endraw %} -#### {% linkable_title Appdaemon remote template %} +#### Appdaemon remote template Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track. @@ -306,7 +306,7 @@ class SonosRemote(hass.Hass): {% endraw %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The following sensor types are supported: @@ -317,7 +317,7 @@ The following sensor types are supported: The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ. -### {% linkable_title Verified supported binary sensors %} +### Verified supported binary sensors - Open/Close Detection - Xiaomi Smart Home Security Door & Window Contact Sensor @@ -327,7 +327,7 @@ The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is - Xiaomi Motion Sensor - Xiaomi Smart Home Aqara Human Body Sensor -## {% linkable_title Climate %} +## Climate See the [deCONZ main integration](/components/deconz/) for configuration instructions. @@ -337,12 +337,12 @@ Note that devices in the climate platform identify as sensors, so there is a man The `entity_id` name will be `climate.device_name`, where `device_name` is defined in deCONZ. -#### {% linkable_title Verified supported climate devices %} +#### Verified supported climate devices - Bitron Thermostat 902010/32 - Eurotronic SPZB0001 -## {% linkable_title Cover %} +## Cover Covers are devices like ventilation dampers or smart window covers. @@ -350,16 +350,16 @@ Note that devices in the cover platform identify as lights, so there is a manual The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ. -### {% linkable_title Verified supported covers %} +### Verified supported covers - Keen vents - Xiaomi Aqara Curtain controller -## {% linkable_title Light %} +## Light The `entity_id` names will be `light.device_name`, where `device_name` is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named `light.group_name_in_deconz`, allowing the user to control groups of lights with only a single API call to deCONZ. -### {% linkable_title Verified supported lights %} +### Verified supported lights - IKEA Trådfri bulb E14 WS opal 400lm - IKEA Trådfri Bulb E27 WS Opal 980lm @@ -372,11 +372,11 @@ The `entity_id` names will be `light.device_name`, where `device_name` is define - Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013 - Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84 -## {% linkable_title Scene %} +## Scene The `entity_id` name will be `scene.group_scene_name`, where `group` is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ. -## {% linkable_title Sensor %} +## Sensor The following sensor types are supported: @@ -388,7 +388,7 @@ The following sensor types are supported: The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main integration](/components/deconz/) for more details. -### {% linkable_title Verified to be supported sensors %} +### Verified to be supported sensors - Humidity Sensor - Xiaomi Aqara Humidity/Temperature Sensor @@ -407,7 +407,7 @@ The `entity_id` name will be `sensor.device_name`, where `device_name` is define - Temperature Sensor - Xiaomi Temperature/Humidity Sensor -### {% linkable_title deCONZ Daylight Sensor %} +### deCONZ Daylight Sensor The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based): @@ -432,7 +432,7 @@ The sensor also has an attribute called "daylight" that has the value `true` whe These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight). -## {% linkable_title Switch %} +## Switch Switches are devices like power plugs and sirens. @@ -440,7 +440,7 @@ Note that devices in the switch platform identify as lights, so there is a manua The `entity_id` name will be `switch.device_name`, where `device_name` is defined in deCONZ. -### {% linkable_title Verified supported switches %} +### Verified supported switches - Innr SP120 - Osram Outdoor plug diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 00edddfe221a..490065939ec4 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -31,7 +31,7 @@ This integration is a meta-component and configures a default set of integration - [updater](/components/updater/) - [zeroconf](/components/zeroconf/) -## {% linkable_title Configuration %} +## Configuration To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/deluge.markdown b/source/_components/deluge.markdown index ef80b12ce96b..15b7879d98d4 100644 --- a/source/_components/deluge.markdown +++ b/source/_components/deluge.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Sensor %} +## Sensor The `deluge` platform allows you to monitor your downloads with [Deluge](http://deluge-torrent.org/) from within Home Assistant and setup automation based on the information. @@ -79,7 +79,7 @@ monitored_variables: description: The current upload speed. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `deluge` switch platform allows you to control your [Deluge](http://deluge-torrent.org/) client from within Home Assistant. The platform enables you switch all your torrents in pause, and then unpause them all. diff --git a/source/_components/denon.markdown b/source/_components/denon.markdown index 41d886f922bb..5adf62188d7e 100644 --- a/source/_components/denon.markdown +++ b/source/_components/denon.markdown @@ -27,7 +27,7 @@ Supported devices: To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file: -## {% linkable_title Telnet platform %} +## Telnet platform ```yaml # Example configuration.yaml entry diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index fce0e65460e6..b91a5ab8ce21 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -16,7 +16,7 @@ ha_release: 0.7 The device tracker allows you to track devices in Home Assistant. This can happen by querying your wireless router or by having applications push location info. -## {% linkable_title Configuring a `device_tracker` platform %} +## Configuring a `device_tracker` platform To get started add the following lines to your `configuration.yaml` (example for Netgear): @@ -64,7 +64,7 @@ device_tracker: Multiple device trackers can be used in parallel, such as [Owntracks](/components/owntracks/#using-owntracks-with-other-device-trackers) and [Nmap](/components/nmap_tracker/). The state of the device will be determined by the source that reported last. -## {% linkable_title `known_devices.yaml` %} +## `known_devices.yaml`

As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the integration you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative. @@ -98,11 +98,11 @@ devicename: | `hide_if_away` | false | If `yes`/`on`/`true` then the device will be hidden if it is not at home. | | `consider_home` | [uses platform setting] | Seconds to wait till marking someone as not home after not being seen. Allows you to override the global `consider_home` setting from the platform configuration on a per device level. | -## {% linkable_title Device states %} +## Device states The state of your tracked device will be `'home'` if it is in the [home zone](/components/zone#home-zone), detected by your network or Bluetooth based presence detection. If you're using a presence detection method that includes coordinates then when it's in a zone the state will be the name of the zone (case sensitive). When a device isn't at home and isn't in any zone, the state will be `'not_home'`. -## {% linkable_title `device_tracker.see` service %} +## `device_tracker.see` service The `device_tracker.see` service can be used to manually update the state of a device tracker: diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index 459ea2e3a484..91e67c845b5b 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -17,7 +17,7 @@ ha_release: 0.7.3 The `mqtt` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -41,7 +41,7 @@ qos: type: integer {% endconfiguration %} -## {% linkable_title Usage %} +## Usage Example JSON you can publish to the topic (e.g., via mqtt.publish service): diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index 4f8fb3b92d89..7c5cbd25242e 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -27,7 +27,7 @@ S_GPS | V_POSITION For more information, visit the [serial api] of MySensors. -### {% linkable_title MySensors 2.x example sketch %} +### MySensors 2.x example sketch ```cpp /** diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index f38e0b2ca4b7..db783f15b6d4 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -15,7 +15,7 @@ ha_release: 0.36 The `xiaomi` platform offers presence detection by looking at connected devices to a [Xiaomi](http://miwifi.com) router. -## {% linkable_title Setup %} +## Setup To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file: @@ -45,7 +45,7 @@ password: See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. -### {% linkable_title Compatibility test %} +### Compatibility test To ensure that your router is compatible, navigate to `http://YOUR_ROUTER_IP/api/misystem/devicelist`. You should see a listing of the device currently connected to your router. diff --git a/source/_components/dht.markdown b/source/_components/dht.markdown index 153956e12341..a882343ac93f 100644 --- a/source/_components/dht.markdown +++ b/source/_components/dht.markdown @@ -19,7 +19,7 @@ redirect_from: The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22 or AM2302 device. -## {% linkable_title Configuration %} +## Configuration To use your DHTxx sensor in your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ humidity_offset: The name of the pin to which the sensor is connected has different names on different platforms. 'P8_11' for Beaglebone, '23' for Raspberry Pi. -### {% linkable_title Example %} +### Example An example for a Raspberry Pi 3 with a DHT22 sensor connected to GPIO4 (pin 7): diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index 1126bd5d99f9..c96d607b1e53 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -37,7 +37,7 @@ Using Dialogflow will be easy to create conversations like: To use this integration, you should define a conversation (intent) in Dialogflow, configure Home Assistant with the speech to return and, optionally, the action to execute. -### {% linkable_title Configuring your Dialogflow account %} +### Configuring your Dialogflow account To get the webhook URL, go to the integrations page in the configuration screen and find "Dialogflow". Click on "configure". Follow the instructions on the screen. @@ -61,11 +61,11 @@ To get the webhook URL, go to the integrations page in the configuration screen Take a look to "Integrations", in the left menu, to configure third parties. -### {% linkable_title Configuring Home Assistant %} +### Configuring Home Assistant When activated, the [`alexa` integration](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration. -## {% linkable_title Examples %} +## Examples Download [this zip](https://github.com/home-assistant/home-assistant.github.io/blob/next/source/assets/HomeAssistant_APIAI.zip) and load it in your Dialogflow agent (**Settings** -> **Export and Import**) for examples intents to use with this configuration: diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 2745b8d82a4e..22005a23422d 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -26,11 +26,11 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](/components/digital_ocean/#binary-sensor) - [Switch](/components/digital_ocean/#switch) -## {% linkable_title Setup %} +## Setup Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). -## {% linkable_title Configuration %} +## Configuration To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: @@ -47,11 +47,11 @@ access_token: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets. -### {% linkable_title Configuration %} +### Configuration To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: @@ -71,11 +71,11 @@ droplets: type: list {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `digital_ocean` switch platform allows you to control (start/stop) your Digital Ocean droplets. -### {% linkable_title Configuration %} +### Configuration To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: diff --git a/source/_components/digitalloggers.markdown b/source/_components/digitalloggers.markdown index 67076e7f7f80..e8566551384a 100644 --- a/source/_components/digitalloggers.markdown +++ b/source/_components/digitalloggers.markdown @@ -18,7 +18,7 @@ redirect_from: The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. -## {% linkable_title Configuration %} +## Configuration To use your digitalloggers switch in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/directv.markdown b/source/_components/directv.markdown index a13e1adadc7e..a3a1235c78ea 100644 --- a/source/_components/directv.markdown +++ b/source/_components/directv.markdown @@ -91,13 +91,13 @@ media_player: It is important to notice that the host and port variables for slave/Genie receivers are the same as the master receiver. -## {% linkable_title Services %} +## Services -### {% linkable_title Media control services %} +### Media control services Available services: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media -#### {% linkable_title Service `media_player.play_media` %} +#### Service `media_player.play_media` | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/source/_components/discogs.markdown b/source/_components/discogs.markdown index 1fed3dfb5bf6..bdaf1147af0d 100644 --- a/source/_components/discogs.markdown +++ b/source/_components/discogs.markdown @@ -18,12 +18,12 @@ redirect_from: The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection. -## {% linkable_title Setup %} +## Setup First, you'll need to get a personal access token from your Discogs account. You can generate a token from your profile's [Developer settings](https://www.discogs.com/settings/developers). -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/discord.markdown b/source/_components/discord.markdown index a331a67935fc..be9ba27b241d 100644 --- a/source/_components/discord.markdown +++ b/source/_components/discord.markdown @@ -44,7 +44,7 @@ token: type: string {% endconfiguration %} -### {% linkable_title Setting up the bot %} +### Setting up the bot Bots can only send messages to servers or attach local available images. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me). @@ -72,7 +72,7 @@ Right click channel name and copy the channel ID (**Copy ID**). This channel ID has to be used as the target when calling the notification service. Multiple channel IDs can be specified, across multiple servers. -#### {% linkable_title Example service payload %} +#### Example service payload ```json { @@ -89,7 +89,7 @@ This channel ID has to be used as the target when calling the notification servi } ``` -### {% linkable_title Notes %} +### Notes You can tag any user inside a channel by using their user ID in the message like so: `<@userid>` replacing `userid` with the ID you copied. To get the user ID right click on the user name to copy the ID like you did for the channel ID up above. diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 0de9a0c918c2..3e8708f576fd 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -110,26 +110,26 @@ Valid values for enable are: * `dlna_dmr`: DLNA DMR enabled devices -## {% linkable_title Troubleshooting %} +## Troubleshooting -### {% linkable_title UPnP %} +### UPnP Home Assistant must be on the same network as the devices for uPnP discovery to work. If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network. -### {% linkable_title Windows %} +### Windows -#### {% linkable_title 64-bit Python %} +#### 64-bit Python There is currently a known issue with running this integration on a 64-bit version of Python and Windows. -#### {% linkable_title Python 3.5 %} +#### Python 3.5 If you are on Windows and you're using Python 3.5, download the [Netifaces](http://www.lfd.uci.edu/~gohlke/pythonlibs/#netifaces) dependency. -### {% linkable_title could not install dependency netdisco %} +### could not install dependency netdisco If you see `Not initializing discovery because could not install dependency netdisco==0.6.1` in the logs, you will need to install the `python3-dev` or `python3-devel` package on your system manually (eg. `sudo apt-get install python3-dev` or `sudo dnf -y install python3-devel`). On the next restart of Home Assistant, the discovery should work. If you still get an error, check if you have a compiler (`gcc`) available on your system. -### {% linkable_title DSM and Synology %} +### DSM and Synology For DSM/Synology, install via debian-chroot [see this forum post](https://community.home-assistant.io/t/error-starting-home-assistant-on-synology-for-first-time/917/15). diff --git a/source/_components/dispatcher.markdown b/source/_components/dispatcher.markdown index e901f747ea2c..7f3e2b51f0b0 100644 --- a/source/_components/dispatcher.markdown +++ b/source/_components/dispatcher.markdown @@ -22,7 +22,7 @@ This platform is meant for developers only. The `dispatcher` camera platform allows developers to create virtual camera's. -## {% linkable_title Configuration %} +## Configuration You would normally not add this camera to your configuration directly but have it be discovered by one of the integrations that uses it. diff --git a/source/_components/dlib_face_detect.markdown b/source/_components/dlib_face_detect.markdown index 273bd3240f10..69c07a31098d 100644 --- a/source/_components/dlib_face_detect.markdown +++ b/source/_components/dlib_face_detect.markdown @@ -19,7 +19,7 @@ The `dlib_face_detect` image processing platform allows you to use the [Dlib](ht This can be used to trigger an automation rule. Further info is on the [integration](/components/image_processing/) page. -### {% linkable_title Configuration Home Assistant %} +### Configuration Home Assistant ```yaml # Example configuration.yaml entry diff --git a/source/_components/dlib_face_identify.markdown b/source/_components/dlib_face_identify.markdown index 186b9f812421..eaa13e089db2 100644 --- a/source/_components/dlib_face_identify.markdown +++ b/source/_components/dlib_face_identify.markdown @@ -19,7 +19,7 @@ The `dlib_face_identify` image processing platform allows you to use the [Dlib]( For using the result inside an automation rule, take a look at the [integration](/components/image_processing/) page. -### {% linkable_title Configuration Home Assistant %} +### Configuration Home Assistant ```yaml # Example configuration.yaml entry diff --git a/source/_components/dlna_dmr.markdown b/source/_components/dlna_dmr.markdown index 16b29ef8f031..315c28a84c2b 100644 --- a/source/_components/dlna_dmr.markdown +++ b/source/_components/dlna_dmr.markdown @@ -20,7 +20,7 @@ The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](ht Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)). -## {% linkable_title Configuration %} +## Configuration To add a DLNA DMR device to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/dnsip.markdown b/source/_components/dnsip.markdown index 117e5910e036..11283754964d 100644 --- a/source/_components/dnsip.markdown +++ b/source/_components/dnsip.markdown @@ -23,7 +23,7 @@ The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -66,7 +66,7 @@ scan_interval: type: integer {% endconfiguration %} -## {% linkable_title Extended example %} +## Extended example ```yaml # Example configuration.yaml entry diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index f5d001a15067..7a116e5a6a09 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -18,7 +18,7 @@ The `dominos` integration allows you to order Dominos Pizza from within your Hom At present, this integration only supports ordering within Canada and the US. -## {% linkable_title Configuration %} +## Configuration To enable the component, you need to set up your customer information and define some orders. diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index 05805997bb72..5c2b16266a9f 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -26,11 +26,11 @@ 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. -## {% linkable_title Setup %} +## Setup The user, which you are going to use with Home Assistant, needs the "API-Operator" permission enabled. -## {% linkable_title Configuration %} +## Configuration To connect your device, add the following to your `configuration.yaml` file: @@ -82,7 +82,7 @@ devices: {% endconfiguration %} -## {% linkable_title Full example %} +## Full example ```yaml doorbird: @@ -106,7 +106,7 @@ doorbird: - rfid_card_scanned ``` -## {% linkable_title Events %} +## Events Events can be defined for each configured DoorBird device independently. These events will be registered on the device and can be attached to a schedule via the DoorBird app. @@ -120,7 +120,7 @@ See [Automation Example](#automation_example) section below for details on how t Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.

-#### {% linkable_title Clearing Registered Events %} +#### Clearing Registered Events Events can be cleared from DoorBird devices by visiting a special URL. Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorbird/clear?token={DEVICE_TOKEN}`. Replace `{Home Assistant URL}` with the full path to your running instance, such as `http://localhost:8123`. Replace `{DEVICE_TOKEN}` with the token specified in your configuration for the device you would like to clear. @@ -128,7 +128,7 @@ Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorb Please note that clearing device events will require configuration steps above to be taken again. It could also affect other third-party applications you may use with your DoorBird device. It will not break the official mobile app in any way, so mobile push notifications will still work. -#### {% linkable_title Event Data %} +#### Event Data Each event will include live image and video URLs for the Doorbird device that triggered the event. These URLs can be found on the event data and can be useful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation. @@ -144,7 +144,7 @@ The following keys are available on `event_data`: The URLs on the event will be based on the configuration used to connect to your Doorbird device. Ability to connect from outside your network will depend on your configuration.

-#### {% linkable_title Schedules %} +#### Schedules Once events have been registered on the DoorBird device, they must be attached to a schedule using the official DoorBird app on Android or iOS. Currently there are schedules available for doorbell, motion, relay, and RFID events (on supported devices). @@ -161,7 +161,7 @@ On the desired event, you should be able to specify blocks of time for when you Remember to complete the schedule assignment steps above for each event type that you registered. -### {% linkable_title Automation Example %} +### Automation Example ```yaml - alias: Doorbird Ring @@ -173,11 +173,11 @@ Remember to complete the schedule assignment steps above for each event type tha entity_id: light.side_entry_porch ``` -## {% linkable_title Camera %} +## Camera The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](http://www.doorbird.com/) device in Home Assistant. -### {% linkable_title Configuration %} +### Configuration To enable the camera, add the following to your `configuration.yaml` file: @@ -187,7 +187,7 @@ camera: - platform: doorbird ``` -## {% linkable_title Switch %} +## Switch The `doorbird` switch platform allows you to power connected relays and trigger the IR array in your [DoorBird](http://www.doorbird.com/) video doorbell device. diff --git a/source/_components/dovado.markdown b/source/_components/dovado.markdown index b751f3090eda..b274d61eeb1f 100644 --- a/source/_components/dovado.markdown +++ b/source/_components/dovado.markdown @@ -56,7 +56,7 @@ port: default: 6435 {% endconfiguration %} -## {% linkable_title Notifications %} +## Notifications The `dovado` notify platform allows you to send SMS from your [Dovado](http://www.dovado.com/) router, if it supports it. @@ -68,7 +68,7 @@ notify: - platform: dovado ``` -### {% linkable_title Usage %} +### Usage This is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send an SMS notification to a single phone number in the notification **target**. @@ -86,7 +86,7 @@ automation: target: '+14151234567' ``` -## {% linkable_title Sensor %} +## Sensor The `dovado` sensor platform let you monitor your [Dovado](http://www.dovado.com/) router. diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index e68266d7b586..c756cae308f7 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -31,7 +31,7 @@ download_dir: type: string {% endconfiguration %} -### {% linkable_title Use the service %} +### Use the service Go to the "Developer Tools", then to "Call Service", and choose `downloader/download_file` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE". @@ -48,7 +48,7 @@ This will download the file from the given URL. | `filename` | yes | Determine the filename. | | `overwrite` | yes | Whether to overwrite the file or not, defaults to `false`. | -### {% linkable_title Download Status Events %} +### Download Status Events When a download finished successfully, Home Assistant will emit a 'downloader_download_completed' event to the event bus which you can use to write automations against. In case download failed another event 'downloader_download_failed' is emitted to indicate that the download did not complete successfully. diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown index 4140cebb3e5f..0bb9981df913 100644 --- a/source/_components/dsmr.markdown +++ b/source/_components/dsmr.markdown @@ -147,7 +147,7 @@ Docker users have to allow Docker access to the device by adding `--device /dev/ $ docker run --device /dev/ttyUSB0:/dev/ttyUSB0 -d --name="home-assistant" -v /home/USERNAME/hass:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant ``` -### {% linkable_title Technical overview %} +### Technical overview DSMR is a standard to which Dutch smartmeters must comply. It specifies that the smartmeter must send out a 'telegram' every 10 seconds (every second for DSMR 5.0 devices) over a serial port. diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 0b17ab99db3c..225a81f45891 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -15,7 +15,7 @@ ha_release: 0.55 With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/duke_energy.markdown b/source/_components/duke_energy.markdown index 27621e1a8977..94550a9c0791 100644 --- a/source/_components/duke_energy.markdown +++ b/source/_components/duke_energy.markdown @@ -18,13 +18,13 @@ redirect_from: The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters. -## {% linkable_title Setup %} +## Setup You will only have access to meters listed in your account at [Duke Energy Usage](https://www.duke-energy.com/my-account/usage-analysis). This supports both electric and gas meters. Along with previous days usage, each sensor will have attributes for the previous bills total usage and average usage. -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/dwd_weather_warnings.markdown b/source/_components/dwd_weather_warnings.markdown index d9a77bc1ecb2..87b1f0918f2b 100644 --- a/source/_components/dwd_weather_warnings.markdown +++ b/source/_components/dwd_weather_warnings.markdown @@ -21,7 +21,7 @@ The `dwd_weather_warnings` sensor platform uses the [Deutsche Wetter Dienst (DWD - A name is optional but if multiple regions are used a name will be required. - The sensor checks for new data every 15 minutes. -## {% linkable_title Configuration %} +## Configuration To add the DWD WarnApp sensor to your installation, add the following to your `configuration.yaml` file: @@ -54,7 +54,7 @@ name: default: DWD-Weather-Warnings {% endconfiguration %} -### {% linkable_title Attributes %} +### Attributes | Attribute | Description | | ------------ | -------------------------------------- | diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown index 3ce577fe423b..88f86a7a94b0 100644 --- a/source/_components/dweet.markdown +++ b/source/_components/dweet.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To use the `dweet` integration in your installation, add the following to your `configuration.yaml` file: @@ -57,11 +57,11 @@ whitelist: type: list {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). -### {% linkable_title Configuration %} +### Configuration To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file: @@ -95,7 +95,7 @@ unit_of_measurement: type: string {% endconfiguration %} -### {% linkable_title Full configuration sample %} +### Full configuration sample A full configuration entry could look like the sample below. @@ -111,7 +111,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Interacting with Dweet.io %} +### Interacting with Dweet.io You can easily send dweets from the command-line to test your sensor with `curl`. diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index 6e8f9ebccf44..324690730cf2 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - Vacuum - Air Quality -## {% linkable_title Configuration %} +## Configuration To enable this component, add the following lines to your `configuration.yaml`: @@ -101,11 +101,11 @@ For example: $ nmap -p 1883 192.168.0.0/24 -- open ``` -## {% linkable_title Vacuum %} +## Vacuum The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuum. -### {% linkable_title Component services %} +### Component services This integration support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)): @@ -118,11 +118,11 @@ This integration support the following services (see [Vacuum Cleaner Robots](/co - `Quiet` - `Max` -## {% linkable_title Climate %} +## Climate The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan thermal control. For controlling the fan functionality, see the Dyson fan part on this page. -### {% linkable_title Component services %} +### Component services This integration supports the following services (see [Climate](/components/climate/)): @@ -132,17 +132,17 @@ This integration supports the following services (see [Climate](/components/clim - [`set_fan_mode`](/components/climate/#service-climateset_fan_mode) - [`set_operation_mode`](/components/climate/#service-climateset_operation_mode) -## {% linkable_title Fan %} +## Fan The `dyson` fan platform allows you to control your Dyson Purifier fans. -### {% linkable_title Supported fan devices %} +### Supported fan devices - Pure Cool link (desk and tower) - Pure Hot+cool link (see climate part) for thermal control - Pure Cool 2018 (DP04 and TP04) -### {% linkable_title Attributes %} +### Attributes There are several attributes which can be used for automations and templates. @@ -157,11 +157,11 @@ There are several attributes which can be used for automations and templates. | `hepa filter` | State of the fan's HEPA filter in % (only for DP04 and TP04).| | `carbon filter` | State of the fan's carbon filter in % (only for DP04 and TP04).| -## {% linkable_title Sensor %} +## Sensor The `dyson` sensor platform provides temperature and humidity sensors. -## {% linkable_title Air Quality %} +## Air Quality The `dyson` air quality platform provides the following levels: @@ -173,7 +173,7 @@ The `dyson` air quality platform provides the following levels: Note: currently only the 2018 dyson fans are supported(TP04 and DP04). -### {% linkable_title Supported fan devices %} +### Supported fan devices - Pure Cool link (desk and tower) - Pure Hot+cool link (see climate part) for thermal control diff --git a/source/_components/ebox.markdown b/source/_components/ebox.markdown index 130a7ef7a67b..494393c937ef 100644 --- a/source/_components/ebox.markdown +++ b/source/_components/ebox.markdown @@ -18,7 +18,7 @@ redirect_from: Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use your EBox sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown index 81ae63aba755..c8d0b2019d26 100644 --- a/source/_components/ebusd.markdown +++ b/source/_components/ebusd.markdown @@ -17,7 +17,7 @@ redirect_from: Integration between [ebusd](https://github.com/john30/ebusd/) daemon for communication with eBUS heating systems, and Home Assistant using sensor component. -## {% linkable_title Configuration %} +## Configuration Enable the sensor by adding the following to your `configuration.yaml` file: diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown index f9fb1c13b611..06d4b9033333 100644 --- a/source/_components/ecoal_boiler.markdown +++ b/source/_components/ecoal_boiler.markdown @@ -19,7 +19,7 @@ redirect_from: The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal). -## {% linkable_title Configuration %} +## Configuration To use your eCoal pumps or sensors in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index fb4338e3bb5e..23bca332038c 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -27,7 +27,7 @@ redirect_from: The `ecobee` integration lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. -## {% linkable_title Configuration %} +## Configuration You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps. @@ -85,7 +85,7 @@ hold_temp: If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file. -## {% linkable_title Notifications %} +## Notifications To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee integration loaded and running. Once you have that configured, you can setup this integration to send messages to your Ecobee device. @@ -108,9 +108,9 @@ name: To use notifications, please see the [getting started with automation page](/getting-started/automation/). -## {% linkable_title Thermostat %} +## Thermostat -### {% linkable_title Concepts %} +### Concepts The Ecobee Thermostat supports the following key concepts. @@ -146,7 +146,7 @@ The _operation mode_ of the device is the currently active operational modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool, auto, and off. -## {% linkable_title Attributes %} +## Attributes The following attributes are provided by the Ecobee Thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, @@ -156,7 +156,7 @@ The following attributes are provided by the Ecobee Thermostat: `is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`. The attributes `min_temp` and `max_temp` are meaningless constant values. -### {% linkable_title Attribute `name` %} +### Attribute `name` Returns the name of the Ecobee Thermostat. @@ -164,7 +164,7 @@ Returns the name of the Ecobee Thermostat. | ---------------| ----------- | | String | Name of the Ecobee Thermostat -### {% linkable_title Attribute `temperature_unit` %} +### Attribute `temperature_unit` Returns the unit of measurement used for temperature by the thermostat. @@ -172,7 +172,7 @@ Returns the unit of measurement used for temperature by the thermostat. | ---------------| ----------- | | String | Name of the temperature unit -### {% linkable_title Attribute `current_temperature` %} +### Attribute `current_temperature` Returns the current temperature measured by the thermostat. @@ -180,7 +180,7 @@ Returns the current temperature measured by the thermostat. | ---------------| ----------- | | Integer | Currently measured temperature -### {% linkable_title Attribute `target_temperature` %} +### Attribute `target_temperature` Returns the target temperature of the thermostat, when the thermostat is not in auto operation mode. @@ -189,7 +189,7 @@ not in auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `target_temperature_low` %} +### Attribute `target_temperature_low` Returns the desired heating temperature set in the thermostat when in auto operation mode. @@ -198,7 +198,7 @@ auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `target_temperature_high` %} +### Attribute `target_temperature_high` Returns the desired cooling temperature set in the thermostat when in auto operation mode. @@ -207,7 +207,7 @@ auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `desired_fan_mode` %} +### Attribute `desired_fan_mode` Returns the desired fan mode of the current operation. @@ -215,7 +215,7 @@ Returns the desired fan mode of the current operation. | ---------------| ----------- | | String | 'on', 'off' -### {% linkable_title Attribute `fan` %} +### Attribute `fan` Returns the current fan state. @@ -223,7 +223,7 @@ Returns the current fan state. | ---------------| ----------- | | String | 'on', 'off' -### {% linkable_title Attribute `current_hold_mode` %} +### Attribute `current_hold_mode` Returns the current temperature hold, if any. @@ -231,7 +231,7 @@ Returns the current temperature hold, if any. | ---------------| ----------- | | String | 'temp', 'vacation', 'home', 'away', etc., None -### {% linkable_title Attribute `operation` %} +### Attribute `operation` Returns the current operation of the thermostat. @@ -239,7 +239,7 @@ Returns the current operation of the thermostat. | ---------------| ----------- | | String | 'auto', 'cool', 'heat', 'off' -### {% linkable_title Attribute `operation_list` %} +### Attribute `operation_list` Returns the list of available operation modes. @@ -247,7 +247,7 @@ Returns the list of available operation modes. | ---------------| ----------- | | List of String | Available operation modes -### {% linkable_title Attribute `operation_mode` %} +### Attribute `operation_mode` Returns the current operation mode of the thermostat. @@ -255,7 +255,7 @@ Returns the current operation mode of the thermostat. | ---------------| ----------- | | String | Currently active operation mode -### {% linkable_title Attribute `equipment_running` %} +### Attribute `equipment_running` Returns the list of equipment that is currently operating from the thermostat. @@ -263,12 +263,12 @@ Returns the list of equipment that is currently operating from the thermostat. | ---------------| ----------- | | String | If no equipment is currently running empty string is returned. Possible values are a comma separated list of any of the following: heatPump, heatPump2, heatPump3, compCool1, compCool2, auxHeat1, auxHeat2, auxHeat3, fan, humidifier, dehumidifier, ventilator, economizer, compHotWater, auxHotWater. -### {% linkable_title Attribute `mode` %} +### Attribute `mode` Returns the climate currently active on the thermostat. The mode is returned as the user-visible name (rather than the internally used name). -### {% linkable_title Attribute `fan_min_on_time` %} +### Attribute `fan_min_on_time` Returns the current fan minimum on time. @@ -276,12 +276,12 @@ Returns the current fan minimum on time. | ---------------| ----------- | | Integer | Current fan minimum on time in minutes -### {% linkable_title Attribute `is_away_mode_on` %} +### Attribute `is_away_mode_on` Returns whether the thermostat is in away mode (see the corresponding service for more detail). -### {% linkable_title Attribute `actual humidity` %} +### Attribute `actual humidity` Returns the humidity as measured by the thermostat. @@ -289,7 +289,7 @@ Returns the humidity as measured by the thermostat. | ---------------| ----------- | | Integer | Current humidity -### {% linkable_title Attribute `vacation` %} +### Attribute `vacation` Returns the currently active vacation or `None`. @@ -297,11 +297,11 @@ Returns the currently active vacation or `None`. | ---------------| ----------- | | String | Name of currently active vacation | -### {% linkable_title Attribute `climate_list` %} +### Attribute `climate_list` Returns the list of climates defined in the thermostat. -### {% linkable_title Attribute `aux_heat` %} +### Attribute `aux_heat` Returns the current auxiliary heat state. @@ -309,7 +309,7 @@ Returns the current auxiliary heat state. | ---------------| ----------- | | String | 'on', 'off' -## {% linkable_title Services %} +## Services The following services are provided by the Ecobee Thermostat: `set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`, @@ -318,7 +318,7 @@ The services `set_aux_heat`, `set_humidity`, `set_fan_mode`, and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat. -### {% linkable_title Service `set_away_mode` %} +### Service `set_away_mode` Turns Away Mode on or off, ignoring the next scheduled activity. This setting will override the thermostat Hold Duration setting, even if you set the hold duration to "Until the next scheduled activity" within thermostat preferences. @@ -327,7 +327,7 @@ Turns Away Mode on or off, ignoring the next scheduled activity. This setting wi | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `away_mode` | no | 'on' or 'off' -### {% linkable_title Service `set_hold_mode` %} +### Service `set_hold_mode` Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep', and any other hold based on a comfort setting, the @@ -345,7 +345,7 @@ canceled. NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app *may not match* the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct `smartX` hold_mode IDs. -### {% linkable_title Service `set_temperature` %} +### Service `set_temperature` Puts the thermostat into a temporary hold at the given temperature. @@ -359,7 +359,7 @@ Puts the thermostat into a temporary hold at the given temperature. Only the target temperatures relevant for the current operation mode need to be provided. -### {% linkable_title Service `set_operation_mode` %} +### Service `set_operation_mode` Sets the current operation mode of the thermostat. @@ -368,7 +368,7 @@ Sets the current operation mode of the thermostat. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `operation_mode` | no | 'auto', 'auxHeatOnly', 'cool', 'heat', 'off' -### {% linkable_title Service `fan_min_on_time` %} +### Service `fan_min_on_time` Sets the fan minimum on time. @@ -377,7 +377,7 @@ Sets the fan minimum on time. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `fan_min_on_time` | no | Desired fan minimum on time -### {% linkable_title Service `resume_program` %} +### Service `resume_program` Resumes the currently active schedule. diff --git a/source/_components/econet.markdown b/source/_components/econet.markdown index 9753313bd3d2..369f696c6c19 100644 --- a/source/_components/econet.markdown +++ b/source/_components/econet.markdown @@ -19,7 +19,7 @@ redirect_from: The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vacation mode. -## {% linkable_title Configuration %} +## Configuration To enable the `econet` water heater platform, add the following information to your `configuration.yaml` file: @@ -42,7 +42,7 @@ password: type: string {% endconfiguration %} -### {% linkable_title Service `econet.add_vacation` %} +### Service `econet.add_vacation` You can use the service `econet.add_vacation` to create a new vacation for your EcoNet water heaters. @@ -56,7 +56,7 @@ You can use the service `econet.add_vacation` to create a new vacation for your The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.

-### {% linkable_title Service `econet.delete_vacation` %} +### Service `econet.delete_vacation` You can use the service `econet.delete_vacation` to remove all vacations from an EcoNet water heater. diff --git a/source/_components/ecovacs.markdown b/source/_components/ecovacs.markdown index d9a2d423b092..b5fd46c5626f 100644 --- a/source/_components/ecovacs.markdown +++ b/source/_components/ecovacs.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - [Vacuum](#vacuum) -## {% linkable_title Configuration %} +## Configuration To add your Ecovacs devices into your Home Assistant installation, add the following to your `configuration.yaml` file: @@ -56,7 +56,7 @@ continent: Note: For some countries, you will need to set `continent` to `ww` (meaning worldwide.) There is unfortunately no way to know the correct settings other than guessing and checking. See the [sucks library protocol documentation](https://github.com/wpietri/sucks/blob/master/protocol.md) for more information about what has been figured out about the Ecovacs servers. -### {% linkable_title Stability and Reporting Bugs %} +### Stability and Reporting Bugs The library that talks to the Ecovacs servers is in a very early state and still under development. As such, it is likely that not all regions and devices will work at the current time. @@ -75,11 +75,11 @@ logger: Warning: doing this will cause your authentication token to visible in your log files. Be sure to remove any tokens and other authentication details from your log before posting them in an issue. -## {% linkable_title Vacuum %} +## Vacuum The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums. -### {% linkable_title Component Lifespans %} +### Component Lifespans The remaining lifespan of components on your Deebot vacuum will be reported as attributes on the vacuum entity. The value will be a whole number representing the percentage of life remaining. @@ -113,7 +113,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Handling Errors %} +### Handling Errors The vacuum entity has an `error` attribute that will contain the _most recent_ error message that came from the vacuum. There is not a comprehensive list of all error messages, so you may need to do some experimentation to determine the error messages that your vacuum can send. diff --git a/source/_components/eddystone_temperature.markdown b/source/_components/eddystone_temperature.markdown index 5fd1384f143a..95ec4ab33844 100644 --- a/source/_components/eddystone_temperature.markdown +++ b/source/_components/eddystone_temperature.markdown @@ -19,7 +19,7 @@ redirect_from: The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature). All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this platform. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](http://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google. -## {% linkable_title Requirements %} +## Requirements As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed: diff --git a/source/_components/edimax.markdown b/source/_components/edimax.markdown index fa82a66b07b2..9768ce73f8e2 100644 --- a/source/_components/edimax.markdown +++ b/source/_components/edimax.markdown @@ -48,7 +48,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Power consumption sensor %} +## Power consumption sensor Starting with [version 2 of the firmware](https://www.edimax.com/edimax/download/download/data/edimax/global/download/), the Edimax switches can also report the current and accumulated daily power consumption in their state objects. Use a [template sensor](/components/sensor.template/) to extract their values: diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown index 58da62a3a9a2..02eeca1e50b7 100644 --- a/source/_components/edp_redy.markdown +++ b/source/_components/edp_redy.markdown @@ -21,7 +21,7 @@ redirect_from: [EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This integration allows integrating EDP re:dy into Home Assistant. -## {% linkable_title Configuration %} +## Configuration You will need your re:dy login information (username and password) to use this component. diff --git a/source/_components/ee_brightbox.markdown b/source/_components/ee_brightbox.markdown index ad878df41dd0..c19e57ee00be 100644 --- a/source/_components/ee_brightbox.markdown +++ b/source/_components/ee_brightbox.markdown @@ -18,7 +18,7 @@ redirect_from: 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. -## {% linkable_title Configuration %} +## Configuration To use a EE Bright Box router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/efergy.markdown b/source/_components/efergy.markdown index e2ebb91456ab..cceca5dd0316 100644 --- a/source/_components/efergy.markdown +++ b/source/_components/efergy.markdown @@ -18,7 +18,7 @@ redirect_from: Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. -## {% linkable_title Setup %} +## Setup To get an app token: @@ -27,7 +27,7 @@ To get an app token: 3. Click on App tokens 4. Click "Add token" -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 0052d25a0b8f..ab7fe2b47f06 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -23,7 +23,7 @@ The `egardia` platform enables the ability to control an [Egardia](http://egardi You will need to know the IP of your alarm panel on your local network. Test if you can login to the panel by browsing to the IP address and log in using your Egardia/Woonveilig account. -## {% linkable_title Basic configuration %} +## Basic configuration To enable the integration with your alarm panel, add the following lines to your `configuration.yaml` file: @@ -102,7 +102,7 @@ You can change this, however, using the following procedure. This is a more adva There seem to be multiple versions of software running on GATE-02 devices; we have received reports from GATE-02 users who successfully run this package in GATE-02 mode. Others have reported they needed to specify GATE-03 as their version to integrate their GATE-02.

-## {% linkable_title Advanced configuration %} +## Advanced configuration 1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. @@ -126,7 +126,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia integration will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur. 5. Test your setup and enjoy. The integration will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl). -## {% linkable_title Binary Sensor %} +## Binary Sensor The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant. Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported. diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 82f4bedaa6fd..cd6b58f37a5d 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor - lets observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant. - Sensor - This includes bed state and results of the current and previous sleep sessions. -## {% linkable_title Configuration %} +## Configuration It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. @@ -57,7 +57,7 @@ partner: default: false {% endconfiguration %} -### {% linkable_title Supported features %} +### Supported features Sensors: @@ -72,7 +72,7 @@ Binary Sensors: - eight_left/right_bed_presence -### {% linkable_title Service `heat_set` %} +### Service `heat_set` You can use the service eight_sleep/heat_set to adjust the target heating level and heating duration of your bed. diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown index 61dc2e45acb8..727da614faf3 100644 --- a/source/_components/elkm1.markdown +++ b/source/_components/elkm1.markdown @@ -40,7 +40,7 @@ There is currently support for the following device types within Home Assistant: - **Sensor** - Elk-M1 counters, keypads, panel, settings, and zones are represented as `sensor` entities. - **Switch** - Elk-M1 outputs are represented as `switch` entities. -## {% linkable_title Configuration %} +## Configuration To integrate Elk-M1 controller with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/emoncms.markdown b/source/_components/emoncms.markdown index 10d2482bcd58..b03d4cdcc1fe 100644 --- a/source/_components/emoncms.markdown +++ b/source/_components/emoncms.markdown @@ -30,7 +30,7 @@ sensor: id: 1 ``` -## {% linkable_title Configuration variables %} +## Configuration variables - **api_key** (*Required*): The read API key for your Emoncms user. - **url** (*Required*): The base URL of Emoncms, use "https://emoncms.org" for the cloud based version. @@ -42,7 +42,7 @@ sensor: - **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. - **unit_of_measurement** (*Optional*): Defines the unit of measurement of for all the sensors. default is "W". -## {% linkable_title Default naming scheme %} +## Default naming scheme The names of the sensors created by this integration will use the feed names defined in EmonCMS if available, or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g., "EmonCMS Total Power" or "EmonCMS Feed 5". @@ -50,7 +50,7 @@ If the `id` property is anything but `1`, the ID will be shown as well, e.g., "E If `sensor_names` is used, any feeds with defined names will get those names exactly, with no prefix. -### {% linkable_title Examples %} +### Examples In this section you find some more examples of how this sensor can be used. diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index e910eb6d0a83..2667e8db0cc5 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -35,7 +35,7 @@ It is recommended to assign a static IP address to the computer running Home Ass Both Google Home and Alexa use the device they were initially set up with for communication with `emulated_hue`. In other words: if you remove/replace this device you will also break `emulated_hue`. To recover your `emulated_hue` functionality, backup your `config/emulated_hue_ids.json` file, delete the original one and reboot your Home Assistant instance.

-### {% linkable_title Configuration %} +### Configuration To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file: @@ -134,7 +134,7 @@ The following are attributes that can be applied in the `entities` section: These attributes used to be found under the `customize` section of `homeassistant`, however, they have now been moved to `entities`. Emulated Hue configuration under `homeassistant.customize` will be deprecated in the near future.

-### {% linkable_title Troubleshooting %} +### Troubleshooting You can verify that the `emulated_hue` integration has been loaded and is responding by pointing a local browser to the following URL: @@ -150,6 +150,6 @@ sudo setcap 'cap_net_bind_service=+ep' /srv/homeassistant/homeassistant_venv/bin ``` Please note that your path may be different depending on your installation method. For example, if you followed the [Virtualenv instructions](/docs/installation/virtualenv/), your path will be `/srv/homeassistant/bin/python3`. -### {% linkable_title License %} +### License Much of this code is based on work done by Bruce Locke on his [ha-local-echo](https://github.com/blocke/ha-local-echo) project, originally released under the MIT License. The license is located [here](https://github.com/blocke/ha-local-echo/blob/b9bf5dcaae6d8e305e2283179ffba64bde9ed29e/LICENSE). diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown index ddc0b0560697..520e5a922b61 100644 --- a/source/_components/emulated_roku.markdown +++ b/source/_components/emulated_roku.markdown @@ -29,7 +29,7 @@ your Home Assistant instance through the automations you create with emulated Ro Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)

-## {% linkable_title Configuration %} +## Configuration The integration is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**) @@ -73,9 +73,9 @@ upnp_bind_multicast: After starting up, you can check if the emulated Roku is reachable at the specified ports on your Home Assistant instance (eg.: `http://192.168.1.101:8060/`). -## {% linkable_title Events %} +## Events -### {% linkable_title Event `roku_command` %} +### Event `roku_command` All Roku commands are sent as `roku_command` events. @@ -89,7 +89,7 @@ Field | Description The available keys are listed here: [Roku key codes](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues) -## {% linkable_title Automations %} +## Automations The following is an example implementation of an automation: ```yaml @@ -108,7 +108,7 @@ The following is an example implementation of an automation: entity_id: media_player.amplifier ``` -## {% linkable_title Troubleshooting %} +## Troubleshooting If you change your advertised IP or ports, you will have to re-add the emulated Roku in your app. When using Harmony, the app should auto-discover any changes via UPnP discovery (if `name` is unchanged) once it detects that the device is unreachable. diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown index 7d6a89692c13..72210ac63110 100644 --- a/source/_components/enocean.markdown +++ b/source/_components/enocean.markdown @@ -51,7 +51,7 @@ The available profiles are usually listed somewhere in the device manual. Support for tech-in messages is not implemented. -## {% linkable_title Hub %} +## Hub To integrate an EnOcean controller with Home Assistant, add the following section to your `configuration.yaml` file: @@ -68,7 +68,7 @@ device: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor This can typically be one of those batteryless wall switches. Tested with: @@ -114,7 +114,7 @@ EnOcean binary sensors have no state, they only generate 'button_pressed' events - **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch. - **onoff**: `0` or `1` for either side of the rocket. -## {% linkable_title Automation example %} +## Automation example Sample automation to switch lights on and off: @@ -134,7 +134,7 @@ automation: entity_id: "{% raw %}{% if trigger.event.data.which == 1 %} light.hall_left {% else %} light.hall_right {%endif %}{% endraw %}" ``` -## {% linkable_title Light %} +## Light An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer. @@ -164,7 +164,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The EnOcean sensor platform currently supports the following device types: @@ -200,7 +200,7 @@ device_class: {% endconfiguration %} -### {% linkable_title Power sensor %} +### Power sensor This has been tested with a Permundo PSC234 switch, but any device sending EEP **A5-12-01** messages will work. @@ -216,7 +216,7 @@ sensor: ``` -### {% linkable_title Humidity sensor %} +### Humidity sensor The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/what-is-enocean/specifications/) are supported: @@ -236,7 +236,7 @@ sensor: device_class: humidity ``` -### {% linkable_title Temperature sensor %} +### Temperature sensor This sensor has been tested with a generic STM-330 sensor, which is used in most indoor temperature sensor devices. @@ -309,7 +309,7 @@ sensor: range_max: 250 ``` -## {% linkable_title Switch %} +## Switch An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01. diff --git a/source/_components/enphase_envoy.markdown b/source/_components/enphase_envoy.markdown index e34f48b633b6..26409c14ff6f 100644 --- a/source/_components/enphase_envoy.markdown +++ b/source/_components/enphase_envoy.markdown @@ -18,7 +18,7 @@ redirect_from: A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). -### {% linkable_title Configuration %} +### Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/entur_public_transport.markdown b/source/_components/entur_public_transport.markdown index 1f618f855246..dd6516c325dd 100644 --- a/source/_components/entur_public_transport.markdown +++ b/source/_components/entur_public_transport.markdown @@ -25,7 +25,7 @@ Real-time data is fetched from [Entur](https://www.entur.org). Entur is a servic

Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information every 45 seconds. It's recommended to not schedule updates more often than this.

-## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -72,7 +72,7 @@ number_of_departures: default: 2 {% endconfiguration %} -## {% linkable_title Example usage %} +## Example usage Example of multiple stop places, with expanded sensors for each platform under the station, and with the platforms added to the map. @@ -108,7 +108,7 @@ sensor: - 'NSB:Line:59' ``` -## {% linkable_title Obtaining a stop id %} +## Obtaining a stop id [Entur's travel planer](https://en-tur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. @@ -118,7 +118,7 @@ Now the web browser should contain an URL with the id in it. Such as this: The stop id is the content after `id=` parameter in the url. Copy paste this into the configuration. -## {% linkable_title FAQ - Troubleshooting %} +## FAQ - Troubleshooting **Q:** I have multiple stop ids and have added whitelisting of a line. Now some of the stop places are showing `unknown`. diff --git a/source/_components/environment_canada.markdown b/source/_components/environment_canada.markdown index e1eab1a79b61..40c74f709f73 100644 --- a/source/_components/environment_canada.markdown +++ b/source/_components/environment_canada.markdown @@ -24,7 +24,7 @@ The following device types and data are supported: - [Sensor](#sensor) - Current conditions and alerts - [Camera](#camera) - Radar imagery -## {% linkable_title Location Selection %} +## Location Selection Each platform automatically determines which weather station's data to use. However, as station coordinates provided by Environment Canada are somewhat imprecise, in some cases you may need to override the automatic selection to use the desired station. @@ -34,7 +34,7 @@ For each platform, the location to use is determined according to the following - Closest station to latitude/longitude specified in platform configuration (optional - Closest station to latitude/longitude specified in Home Assistant core configuration -## {% linkable_title Weather %} +## Weather The `environment_canada` weather platform populates a weather card with Environment Canada current conditions and forecast [data](https://weather.gc.ca/canada_e.html). @@ -76,7 +76,7 @@ forecast: default: daily {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `environment_canada` sensor platform creates sensors based on Environment Canada [current conditions](https://weather.gc.ca/canada_e.html) and [alerts](https://weather.gc.ca/warnings/index_e.html). @@ -159,7 +159,7 @@ monitored_conditions: description: Alerts that have recently ended. {% endconfiguration %} -## {% linkable_title Camera %} +## Camera The `environment_canada` camera platform displays Environment Canada meteorological [radar imagery](https://weather.gc.ca/radar/index_e.html). diff --git a/source/_components/envirophat.markdown b/source/_components/envirophat.markdown index 72c0c11bcc1e..72354900f5c9 100644 --- a/source/_components/envirophat.markdown +++ b/source/_components/envirophat.markdown @@ -96,7 +96,7 @@ use_led: type: boolean {% endconfiguration %} -### {% linkable_title Notes %} +### Notes #### X, Y, Z axes @@ -108,7 +108,7 @@ use_led: - voltage readings are done in the 0-3.3V range, please do not connect higher voltages than that! See the [Enviro pHAT's getting started guide](https://learn.pimoroni.com/tutorial/sandyj/getting-started-with-enviro-phat) regarding how to make a voltage divider -### {% linkable_title Give the values friendly names & icons %} +### Give the values friendly names & icons Add something like the following to your [customize section](/docs/configuration/customizing-devices/): diff --git a/source/_components/eq3btsmart.markdown b/source/_components/eq3btsmart.markdown index 3f80f7cb217e..d855781b4a2b 100644 --- a/source/_components/eq3btsmart.markdown +++ b/source/_components/eq3btsmart.markdown @@ -22,7 +22,7 @@ The current functionality allows setting the temperature as well as controlling As the device doesn't contain a temperature sensor ([read more](https://forum.fhem.de/index.php/topic,39308.15.html)), we report target temperature also as current one. -### {% linkable_title Testing the connectivity %} +### Testing the connectivity Before configuring Home Assistant you should check that connectivity with the thermostat is working, which can be done with the eq3cli tool: @@ -39,7 +39,7 @@ Current mode: auto dst Valve: 0 ``` -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown index 18f76a055283..14cc080732b6 100644 --- a/source/_components/esphome.markdown +++ b/source/_components/esphome.markdown @@ -23,7 +23,7 @@ redirect_from: This integration allows you to connect your [ESPHome](https://esphome.io) devices directly into Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html). -## {% linkable_title Setup the integration via the integrations screen %} +## Setup the integration via the integrations screen Menu: *Configuration* -> *Integrations* diff --git a/source/_components/everlights.markdown b/source/_components/everlights.markdown index 849a042a8a6b..09d33ec971f8 100644 --- a/source/_components/everlights.markdown +++ b/source/_components/everlights.markdown @@ -18,7 +18,7 @@ redirect_from: [EverLights](https://myeverlights.com/) are permanent Christmas lights installed on a home's gutters or flashing. This integration can change all LEDs in a zone to a single color or activate a pattern that was previously saved to the control box. -### {% linkable_title Configuration Details %} +### Configuration Details To enable EverLights, add the following lines to your `configuration.yaml` file: @@ -38,7 +38,7 @@ hosts: type: list {% endconfiguration %} -### {% linkable_title Effects %} +### Effects EverLights patterns saved to the control box can be activated using the effect parameter to the `light.turn_on` service. If an effect is specified, then the color and brightness are ignored. diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index 00cc88b33712..8596939630f6 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Climate](#climate) -## {% linkable_title Configuration %} +## Configuration To use this integration in your installation, add the following to your `configuration.yaml` file: @@ -61,7 +61,7 @@ scan_interval: This is an IoT cloud-polling device, and the recommended minimum `scan_interval` is 300 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell. -## {% linkable_title Climate %} +## Climate It is distinct from - but related to - the [`honeywell`](/components/climate.honeywell/) climate platform, which also allows (limited) integration with Honeywell Connected thermostats; these two integrations may well be usable side-by-side, but YMMV. diff --git a/source/_components/facebook.markdown b/source/_components/facebook.markdown index c051fbc3fc7d..2ae65844614f 100644 --- a/source/_components/facebook.markdown +++ b/source/_components/facebook.markdown @@ -39,7 +39,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage With Facebook notify service, you can send your notifications to your Facebook messenger with help of your Facebook page. You have to create a [Facebook Page and App](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) for this service. You can control it by calling the notify service [as described here](/components/notify/). It will send a message on messenger to user specified by **target** on behalf of your page. See the [quick start](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) guide for more information. The phone number used in **target** should be registered with Facebook messenger. Phone number of the recipient should be in +1(212)555-2368 format. If your app is not approved by Facebook then the recipient should by either admin, developer or tester for your Facebook app. [More information](https://developers.facebook.com/docs/messenger-platform/send-api-reference#phone_number) about the phone number. @@ -105,7 +105,7 @@ if (preg_match('/get my id/', strtolower($message))) { ``` -### {% linkable_title Rich messages %} +### Rich messages You could also send rich messing (cards, buttons, images, videos, etc). [Info](https://developers.facebook.com/docs/messenger-platform/send-api-reference) to which types of messages and how to build them. ```yaml diff --git a/source/_components/facebox.markdown b/source/_components/facebox.markdown index b408196d4677..e77f812d9121 100644 --- a/source/_components/facebox.markdown +++ b/source/_components/facebox.markdown @@ -17,7 +17,7 @@ redirect_from: The `facebox` image processing platform allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on. -## {% linkable_title Setup %} +## Setup Facebox runs in a Docker container and it is recommended that you run this container on a machine with a minimum of 2 GB RAM. On your machine with Docker, run the Facebox container with: @@ -30,7 +30,7 @@ You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USE If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` to the `docker run` command. -## {% linkable_title Configuration %} +## Configuration To enable this platform in your installation, add the following to your `configuration.yaml` file: @@ -77,7 +77,7 @@ source: type: string {% endconfiguration %} -## {% linkable_title Automations %} +## Automations Use the `image_processing.detect_face` events to trigger automations, and breakout the `trigger.event.data` using a [data_template](/docs/automation/templating/). The following example automation sends a notification when Ringo Star is recognized: @@ -98,7 +98,7 @@ Use the `image_processing.detect_face` events to trigger automations, and breako ``` {% endraw %} -## {% linkable_title Service `facebox_teach_face` %} +## Service `facebox_teach_face` The service `facebox_teach_face` can be used to teach Facebox faces. diff --git a/source/_components/fail2ban.markdown b/source/_components/fail2ban.markdown index 8488a5fe6eaf..ceefb1c8769f 100644 --- a/source/_components/fail2ban.markdown +++ b/source/_components/fail2ban.markdown @@ -23,7 +23,7 @@ The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.o Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file.

-## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -53,11 +53,11 @@ file_path: default: /var/log/fail2ban.log {% endconfiguration %} -### {% linkable_title Set up Fail2Ban %} +### Set up Fail2Ban For most setups, you can follow [this tutorial](/cookbook/fail2ban/) to set up `fail2ban` on your system. It will walk you through creating jails and filters, allowing you to monitor IP addresses that have been banned for too many failed SSH login attempts, as well as too many failed Home Assistant login attempts. -### {% linkable_title Fail2Ban with Docker %} +### Fail2Ban with Docker

These steps assume you already have the Home Assistant docker running behind NGINX and that it is externally accessible. It also assumes the docker is running with the `--net='host'` flag. @@ -65,7 +65,7 @@ These steps assume you already have the Home Assistant docker running behind NGI For those of us using Docker, the above tutorial may not be sufficient. The following steps specifically outline how to set up `fail2ban` and Home Assistant when running Home Assistant within a Docker behind NGINX. The setup this was tested on was an unRAID server using the [let's encrypt docker](https://github.com/linuxserver/docker-letsencrypt) from linuxserver.io. -#### {% linkable_title Set http logger %} +#### Set http logger In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. @@ -75,7 +75,7 @@ logger: homeassistant.components.http.ban: warning ``` -#### {% linkable_title Edit the `jail.local` file %} +#### Edit the `jail.local` file Next, we need to edit the `jail.local` file that is included with the Let's Encrypt docker linked above. Note, for this tutorial, we'll only be implementing the `[hass-iptables]` jail from the [previously linked tutorial](/cookbook/fail2ban/). @@ -90,7 +90,7 @@ logpath = /hass/home-assistant.log maxretry = 5 ``` -#### {% linkable_title Create a filter for the Home Assistant jail %} +#### Create a filter for the Home Assistant jail Now we need to create a filter for `fail2ban` so that it can properly parse the log. This is done with a `failregex`. Create a file called `hass.local` within the `filter.d` directory in `/mnt/user/appdata/letsencrypt/fail2ban` and add the following: @@ -107,7 +107,7 @@ ignoreregex = datepattern = ^%%Y-%%m-%%d %%H:%%M:%%S ``` -#### {% linkable_title Map log file directories %} +#### Map log file directories First, we need to make sure that fail2ban log can be passed to Home Assistant and that the Home Assistant log can be passed to fail2ban. When starting the Let's Encrypt docker, you need to add the following argument (adjust paths based on your setup): @@ -124,7 +124,7 @@ Now do the same for the Home Assistant docker, but this time we'll be mapping th ``` -#### {% linkable_title Send client IP to Home Assistant %} +#### Send client IP to Home Assistant By default, the IP address that Home Assistant sees will be that of the container (something like `172.17.0.16`). What this means is that for any failed login attempt, assuming you have correctly configured `fail2ban`, the Docker IP will be logged as banned, but the originating IP is still allowed to make attempts. We need `fail2ban` to recognize the originating IP to properly ban it. @@ -172,7 +172,7 @@ http: At this point, once the Let's Encrypt and Home Assistant dockers are restarted, Home Assistant should be correctly logging the originating IP of any failed login attempt. Once that's done and verified, we can move onto the final step. -#### {% linkable_title Add the fail2ban sensor %} +#### Add the fail2ban sensor Now that we've correctly set everything up for Docker, we can add our sensors to `configuration.yaml` with the following: @@ -186,7 +186,7 @@ sensor: Assuming you've followed all of the steps, you should have one fail2ban sensor, `sensor.fail2ban_hassiptables`, within your front-end. -### {% linkable_title Other debug tips %} +### Other debug tips If, after following these steps, you're unable to get the `fail2ban` sensor working, here are some other steps you can take that may help: diff --git a/source/_components/familyhub.markdown b/source/_components/familyhub.markdown index fb5ba25d73ad..8976e766cd87 100644 --- a/source/_components/familyhub.markdown +++ b/source/_components/familyhub.markdown @@ -18,7 +18,7 @@ redirect_from: The `familyhub` platform allows you to get images of the inside of your [Samsung Family Hub refrigerator](https://www.samsung.com/us/explore/family-hub-refrigerator/connected-hub/) in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable your Family Hub camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 189b31397582..bdb177d36630 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt` fan platform lets you control your MQTT enabled fans. -## {% linkable_title Configuration %} +## Configuration In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`. @@ -190,11 +190,11 @@ device: Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

-## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this fan. -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a MQTT fan. diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown index 7e1bcf92b686..910a88b0d707 100644 --- a/source/_components/fan.xiaomi_miio.markdown +++ b/source/_components/fan.xiaomi_miio.markdown @@ -309,9 +309,9 @@ model: type: string {% endconfiguration %} -## {% linkable_title Platform Services %} +## Platform Services -### {% linkable_title Service `fan.set_speed` %} +### Service `fan.set_speed` Set the fan speed/operation mode. @@ -320,7 +320,7 @@ Set the fan speed/operation mode. | `entity_id` | yes | Only act on a specific air purifier. Else targets all. | | `speed` | no | Fan speed. Valid values are 'Auto', 'Silent', 'Favorite' and 'Idle' | -### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_on` %} (Air Purifier Pro excluded) +### Service `fan.xiaomi_miio_set_buzzer_on` (Air Purifier Pro excluded) Turn the buzzer on. @@ -328,7 +328,7 @@ Turn the buzzer on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_off` %} (Air Purifier Pro excluded) +### Service `fan.xiaomi_miio_set_buzzer_off` (Air Purifier Pro excluded) Turn the buzzer off. @@ -336,7 +336,7 @@ Turn the buzzer off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_on` %} (Air Purifiers only) +### Service `fan.xiaomi_miio_set_led_on` (Air Purifiers only) Turn the led on. @@ -344,7 +344,7 @@ Turn the led on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_off` %} (Air Purifiers only) +### Service `fan.xiaomi_miio_set_led_off` (Air Purifiers only) Turn the led off. @@ -352,7 +352,7 @@ Turn the led off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_on` %} +### Service `fan.xiaomi_miio_set_child_lock_on` Turn the child lock on. @@ -360,7 +360,7 @@ Turn the child lock on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_off` %} +### Service `fan.xiaomi_miio_set_child_lock_off` Turn the child lock off. @@ -368,7 +368,7 @@ Turn the child lock off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_brightness` %} (Air Purifier 2S and Air Purifier Pro excluded) +### Service `fan.xiaomi_miio_set_led_brightness` (Air Purifier 2S and Air Purifier Pro excluded) Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). @@ -377,7 +377,7 @@ Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `brightness` | no | Brightness, between 0 and 2. | -### {% linkable_title Service `fan.xiaomi_miio_set_favorite_level` %} (Air Purifiers only) +### Service `fan.xiaomi_miio_set_favorite_level` (Air Purifiers only) Set the favorite level of the operation mode "favorite". @@ -386,7 +386,7 @@ Set the favorite level of the operation mode "favorite". | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `level` | no | Level, between 0 and 16. | -### {% linkable_title Service `fan.xiaomi_miio_set_auto_detect_on` %} (Air Purifier 2S and Air Purifier Pro only) +### Service `fan.xiaomi_miio_set_auto_detect_on` (Air Purifier 2S and Air Purifier Pro only) Turn the auto detect on. @@ -394,7 +394,7 @@ Turn the auto detect on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_auto_detect_off` %} (Air Purifier 2S and Air Purifier Pro only) +### Service `fan.xiaomi_miio_set_auto_detect_off` (Air Purifier 2S and Air Purifier Pro only) Turn the auto detect off. @@ -402,7 +402,7 @@ Turn the auto detect off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_learn_mode_on` %} (Air Purifier 2 only) +### Service `fan.xiaomi_miio_set_learn_mode_on` (Air Purifier 2 only) Turn the learn mode on. @@ -410,7 +410,7 @@ Turn the learn mode on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_learn_mode_off` %} (Air Purifier 2 only) +### Service `fan.xiaomi_miio_set_learn_mode_off` (Air Purifier 2 only) Turn the learn mode off. @@ -418,7 +418,7 @@ Turn the learn mode off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_volume` %} (Air Purifier Pro only) +### Service `fan.xiaomi_miio_set_volume` (Air Purifier Pro only) Set the sound volume. @@ -427,7 +427,7 @@ Set the sound volume. | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `volume` | no | Volume, between 0 and 100. | -### {% linkable_title Service `fan.xiaomi_miio_reset_filter` %} (Air Purifier 2 only) +### Service `fan.xiaomi_miio_reset_filter` (Air Purifier 2 only) Reset the filter lifetime and usage. @@ -435,7 +435,7 @@ Reset the filter lifetime and usage. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_extra_features` %} (Air Purifier only) +### Service `fan.xiaomi_miio_set_extra_features` (Air Purifier only) Set the extra features. @@ -444,7 +444,7 @@ Set the extra features. | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `features` | no | Integer, known values are 0 and 1. | -### {% linkable_title Service `fan.xiaomi_miio_set_target_humidity` %} (Air Humidifier only) +### Service `fan.xiaomi_miio_set_target_humidity` (Air Humidifier only) Set the target humidity. @@ -453,7 +453,7 @@ Set the target humidity. | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `humidity` | no | Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80 | -### {% linkable_title Service `fan.xiaomi_miio_set_dry_on` %} (Air Humidifier CA only) +### Service `fan.xiaomi_miio_set_dry_on` (Air Humidifier CA only) Turn the dry mode on. @@ -461,7 +461,7 @@ Turn the dry mode on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_dry_off` %} (Air Humidifier CA only) +### Service `fan.xiaomi_miio_set_dry_off` (Air Humidifier CA only) Turn the dry mode off. diff --git a/source/_components/fastdotcom.markdown b/source/_components/fastdotcom.markdown index d095e5681e86..562fd9400bf5 100644 --- a/source/_components/fastdotcom.markdown +++ b/source/_components/fastdotcom.markdown @@ -27,7 +27,7 @@ Enabling this integration will automatically create the Fast.com Sensor. By default, a speed test will be run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a speed test to run. -## {% linkable_title Configuration %} +## Configuration To add Fast.com to your installation, add the following to your `configuration.yaml` file: @@ -58,7 +58,7 @@ manual: type: boolean {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -70,7 +70,7 @@ scan_interval: milliseconds: 0 ``` -### {% linkable_title Service %} +### Service Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. @@ -79,7 +79,7 @@ action: service: fastdotcom.speedtest ``` -## {% linkable_title Notes %} +## Notes - When running on Raspberry Pi, the maximum speed is limited by its 100 Mbit/s LAN adapter. - The sensor will return the maximum measured speed during a 15-second test. diff --git a/source/_components/fedex.markdown b/source/_components/fedex.markdown index 182a0df191b3..9673ee4eed45 100644 --- a/source/_components/fedex.markdown +++ b/source/_components/fedex.markdown @@ -18,7 +18,7 @@ redirect_from: The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index 44630cc5aee1..be586c9c01dd 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -23,7 +23,7 @@ You need the `ffmpeg` binary in your system path. On Hassbian you will need to l If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

-## {% linkable_title Configuration %} +## Configuration To set it up, add the following information to your `configuration.yaml` file: @@ -39,7 +39,7 @@ ffmpeg_bin: type: string {% endconfiguration %} -### {% linkable_title Raspbian Debian Jessie Lite Installations %} +### Raspbian Debian Jessie Lite Installations To get the binary on Raspbian Debian Jessie Lite on a RPi you need to perform the following: ```bash @@ -55,7 +55,7 @@ ffmpeg: ffmpeg_bin: /usr/bin/ffmpeg ``` -### {% linkable_title Troubleshooting %} +### Troubleshooting In most cases, `ffmpeg` automatically detects all needed options to read a video or audio stream or file. But it is possible in rare cases that you will need to set options to help `ffmpeg` out. @@ -70,7 +70,7 @@ Now you should be able to see what is going wrong. The following list contains s - `[rtsp @ ...] UDP timeout, retrying with TCP`: You need to set an RTSP transport in the configuration with: `input: -rtsp_transport tcp -i INPUT` - `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg needs more data or time for autodetection (the default is 5 seconds). You can set the `analyzeduration` and/or `probesize` options to experiment with giving FFmpeg more leeway. If you find the needed value, you can set it with: `input: -analyzeduration xy -probesize xy -i INPUT`. More information about this can be found [here](https://www.ffmpeg.org/ffmpeg-formats.html#Description). -#### {% linkable_title USB cameras %} +#### USB cameras For `INPUT` a valid source is needed. A USB camera is an easy way to test your video setup. To get all available USB cameras connected to the system, e.g., use the v4l2 tools on a Linux machine. diff --git a/source/_components/ffmpeg_motion.markdown b/source/_components/ffmpeg_motion.markdown index 2e35be038baa..104a1c3610de 100644 --- a/source/_components/ffmpeg_motion.markdown +++ b/source/_components/ffmpeg_motion.markdown @@ -22,11 +22,11 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-## {% linkable_title Motion %} +## Motion FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter. -## {% linkable_title Configuration %} +## Configuration To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file: @@ -85,7 +85,7 @@ $ ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 - If you are running into trouble with this sensor, please refer to the [troubleshooting section](/components/ffmpeg/#troubleshooting). -#### {% linkable_title Tips %} +#### Tips - Use motion only in a custom area with [crop filter](https://ffmpeg.org/ffmpeg-filters.html#crop): diff --git a/source/_components/ffmpeg_noise.markdown b/source/_components/ffmpeg_noise.markdown index 3dd7870c378c..24792aad04f0 100644 --- a/source/_components/ffmpeg_noise.markdown +++ b/source/_components/ffmpeg_noise.markdown @@ -21,7 +21,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-## {% linkable_title Configuration %} +## Configuration To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fibaro.markdown b/source/_components/fibaro.markdown index ea1384335d5e..efafc31d291b 100644 --- a/source/_components/fibaro.markdown +++ b/source/_components/fibaro.markdown @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: They will be automatically added when the `fibaro` hub is connected to Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use Fibaro devices in your installation, add the following to your `configuration.yaml` file using the IP and port number of your Fibaro controller: @@ -95,6 +95,6 @@ device_config: It is recommended to assign a static IP address to your Fibaro controller. This ensures that it won't change its IP address, so you won't have to change the `url` if the controller reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Fibaro, check the label on the bottom.

-### {% linkable_title Using Z-Wave devices in automation %} +### Using Z-Wave devices in automation If you want to use a Z-Wave device from the Fibaro controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under the service developer tool icon icon of the Developer Tools section. Look for entities that contain 'fibaro_id' in their attributes, and you'll find the entity id on the left. diff --git a/source/_components/fido.markdown b/source/_components/fido.markdown index b4de25d306db..96d7bfca41b7 100644 --- a/source/_components/fido.markdown +++ b/source/_components/fido.markdown @@ -18,7 +18,7 @@ redirect_from: Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/file.markdown b/source/_components/file.markdown index 56a35c24e9ec..35f0a3a0ad9d 100644 --- a/source/_components/file.markdown +++ b/source/_components/file.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) - [Sensor](#sensor) -## {% linkable_title Notifications %} +## Notifications The `file` platform allows you to store notifications from Home Assistant as a file. @@ -57,7 +57,7 @@ timestamp: To use notifications, please see the [getting started with automation page](/getting-started/automation/). -## {% linkable_title Sensor %} +## Sensor The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). @@ -90,11 +90,11 @@ value_template: type: template {% endconfiguration %} -### {% linkable_title Examples %} +### Examples In this section you find some real-life examples of how to use this sensor. -#### {% linkable_title Entries as JSON %} +#### Entries as JSON Assuming that the log file contains multiple values formatted as JSON like shown below: diff --git a/source/_components/filesize.markdown b/source/_components/filesize.markdown index a50862e11f20..3f6d8fde2dbe 100644 --- a/source/_components/filesize.markdown +++ b/source/_components/filesize.markdown @@ -18,7 +18,7 @@ redirect_from: The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). -## {% linkable_title Configuration %} +## Configuration To enable the `filesize` sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/filter.markdown b/source/_components/filter.markdown index 6f75c5cc6e59..65678b318074 100644 --- a/source/_components/filter.markdown +++ b/source/_components/filter.markdown @@ -25,7 +25,7 @@ The `filter` platform enables sensors that process the states of other entities.

-## {% linkable_title Configuration %} +## Configuration To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file: @@ -113,9 +113,9 @@ filters: default: positive infinity {% endconfiguration %} -## {% linkable_title Filters %} +## Filters -### {% linkable_title Low-pass %} +### Low-pass The Low-pass filter (`lowpass`) is one of signal processing most common filters, as it smooths data by shortcutting peaks and valleys. @@ -129,7 +129,7 @@ LowPass(state) = A * previous_state + B * state The returned value is rounded to the number of decimals defined in (`precision`). -### {% linkable_title Outlier %} +### Outlier The Outlier filter (`outlier`) is a basic Band-pass filter, as it cuts out any value outside a specific range. @@ -144,7 +144,7 @@ else: state ``` -### {% linkable_title Throttle %} +### Throttle The Throttle filter (`throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values. @@ -152,7 +152,7 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes. -### {% linkable_title Time Throttle %} +### Time Throttle The Time Throttle filter (`time_throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values. @@ -160,7 +160,7 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to This filter is relevant when you have a sensor which produces states at a very high inconstant rate, which you might want to throttle down to some constant rate for storing or visualization purposes. -### {% linkable_title Time Simple Moving Average %} +### Time Simple Moving Average The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algorithms for Unevenly Spaced Time Series: Moving Averages and Other Rolling Operators](http://www.eckner.com/papers/Algorithms%20for%20Unevenly%20Spaced%20Time%20Series.pdf) by Andreas Eckner. @@ -168,7 +168,7 @@ The paper defines three types/versions of the Simple Moving Average (SMA): *last Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., 00:05 for a five minutes time window). -### {% linkable_title Range %} +### Range The Range filter (`range`) restricts incoming data to a range specified by a lower and upper bound. diff --git a/source/_components/fints.markdown b/source/_components/fints.markdown index 84aeff38ab6b..6a5247ab1e4b 100644 --- a/source/_components/fints.markdown +++ b/source/_components/fints.markdown @@ -17,7 +17,7 @@ redirect_from: With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline. -## {% linkable_title Configuration %} +## Configuration To find out the configuration for your bank, check their website or call their hotline. Do not use random information you find on the Internet! As you're storing your bank account information in the Home Assistant configuration: Make sure that this configuration is not accessible to anyone. diff --git a/source/_components/fixer.markdown b/source/_components/fixer.markdown index 08779752fdf1..1d11848b626c 100644 --- a/source/_components/fixer.markdown +++ b/source/_components/fixer.markdown @@ -21,11 +21,11 @@ The `fixer` sensor will show you the current exchange rate from [Fixer.io](http: To get an overview about the available [currencies](https://fixer.io/symbols). -## {% linkable_title Setup %} +## Setup You need to create an [API key](https://fixer.io/product). There is a rate limit of 1000 calls per month. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/flic.markdown b/source/_components/flic.markdown index 35082555af23..6379ec0408f1 100644 --- a/source/_components/flic.markdown +++ b/source/_components/flic.markdown @@ -20,13 +20,13 @@ The `flic` platform allows you to receive click events from [flic](https://flic. The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine. -#### {% linkable_title Service setup %} +#### Service setup If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons). On a Hass.io installation that's not yet based on HassOS, you also need to install the [bluetooth add-on](/addons/bluetooth_bcm43xx/). For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows). -#### {% linkable_title Configuration %} +#### Configuration To use your flic buttons in your installation, add the following to your `configuration.yaml` file: @@ -63,15 +63,15 @@ timeout: default: 3 {% endconfiguration %} -#### {% linkable_title Discovery %} +#### Discovery If discovery is enabled, you can add a new button by pressing it for at least 7 seconds. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired. -#### {% linkable_title Timeout %} +#### Timeout When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant. -#### {% linkable_title Events %} +#### Events The flic integration fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this: @@ -113,6 +113,6 @@ automation: message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %} ``` -##### {% linkable_title Ignoring Click Types %} +##### Ignoring Click Types For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast. diff --git a/source/_components/flock.markdown b/source/_components/flock.markdown index f136a27578ba..e82290757c7c 100644 --- a/source/_components/flock.markdown +++ b/source/_components/flock.markdown @@ -18,7 +18,7 @@ redirect_from: The `flock` platform uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant. -## {% linkable_title Setup %} +## Setup Go to the [Flock.com Admin website](https://admin.flock.com/#!/webhooks) and create a new "Incoming Webhooks". Choose a channel to send the notifications from Home Assistant to, specify a name and press *Save and Generate URL*. @@ -32,7 +32,7 @@ You will need the last part of the URL which is the `access_token` for your room

-## {% linkable_title Configuration %} +## Configuration To add Flock notifications to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/flunearyou.markdown b/source/_components/flunearyou.markdown index f51b98556be2..cb16b130615d 100644 --- a/source/_components/flunearyou.markdown +++ b/source/_components/flunearyou.markdown @@ -21,7 +21,7 @@ territories to get information regarding reported flu symptoms from Flu Near You. The platform can return user-reported information as well reports from the Center for Disease Control (CDC). -## {% linkable_title Configuration %} +## Configuration To enable the platform, add the following lines to your `configuration.yaml` file: @@ -49,7 +49,7 @@ longitude: default: The longitude defined under the `homeassistant` key in `configuration.yaml`. {% endconfiguration %} -## {% linkable_title Sensor Types %} +## Sensor Types ### User Report diff --git a/source/_components/flux_led.markdown b/source/_components/flux_led.markdown index 16b015ea1749..d2aed2bdfbd5 100644 --- a/source/_components/flux_led.markdown +++ b/source/_components/flux_led.markdown @@ -31,7 +31,7 @@ Examples of controllers: - [SUPERNIGHT WiFi Wireless LED Smart Controller](https://amzn.to/2WURx7w) -### {% linkable_title Configuration Details %} +### Configuration Details To enable those lights, add the following lines to your `configuration.yaml` file: @@ -93,7 +93,7 @@ The integration defaults to rgbw. If your device has a separate white channel, y

-### {% linkable_title Example configuration %} +### Example configuration Will automatically search and add all lights on start up: @@ -163,7 +163,7 @@ light: protocol: 'ledenet' ``` -### {% linkable_title Effects %} +### 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. diff --git a/source/_components/folder.markdown b/source/_components/folder.markdown index bdd09519a1cf..1041e990e72f 100644 --- a/source/_components/folder.markdown +++ b/source/_components/folder.markdown @@ -18,7 +18,7 @@ redirect_from: Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes. -## {% linkable_title Configuration %} +## Configuration To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index 245a4ba1cc79..551a934246ae 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -24,7 +24,7 @@ This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored. -## {% linkable_title Configuration %} +## Configuration To enable the Folder Watcher integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/foobot.markdown b/source/_components/foobot.markdown index b4a06b50c311..5a10d9ca0ced 100644 --- a/source/_components/foobot.markdown +++ b/source/_components/foobot.markdown @@ -20,7 +20,7 @@ The `foobot` sensor platform will fetch air quality data from your or yours [Foo This sensor requires an API token. Please obtain one at [Foobot API site](https://api.foobot.io/apidoc/index.html). -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -42,7 +42,7 @@ sensor: type: string {% endconfiguration %} -## {% linkable_title Available Metrics %} +## Available Metrics Every ten minutes, it'll fetch the last ten minutes average of the following measurements: diff --git a/source/_components/foscam.markdown b/source/_components/foscam.markdown index 2c1ee27945d9..7cf9451dcc46 100644 --- a/source/_components/foscam.markdown +++ b/source/_components/foscam.markdown @@ -18,7 +18,7 @@ redirect_from: The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable your Foscam IP camera in your installation, add the following to your `configuration.yaml` file: @@ -64,6 +64,6 @@ name: There seems to be some issues within Foscam with lengthy passwords and passwords containing certain symbols. Be sure to check your camera's documentation.

-### {% linkable_title Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away %} +### Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away Foscam Webcams which support CGI Commands can be controlled by Home Assistant ([Source](http://www.ipcamcontrol.net/files/Foscam%20IPCamera%20CGI%20User%20Guide-V1.0.4.pdf)). For an example of how this can be done, see the [Foscam IP Camera Pan, Tilt, Zoom Control](/cookbook/foscam_away_mode_PTZ/) Cookbook entry. diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index 02cf7f75117f..d5dc45dce43d 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -48,7 +48,7 @@ and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual val You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`. -### {% linkable_title Real-Time API %} +### Real-Time API The integration accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. @@ -65,7 +65,7 @@ automation: entity_id: script.my_action ``` -### {% linkable_title Check ins %} +### Check ins To check a user in, use the `foursquare/checkin` service. diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown index 4c95a8d3551f..d50c2e34c1c4 100644 --- a/source/_components/freebox.markdown +++ b/source/_components/freebox.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: * [Device tracker](#presence-detection) for connected devices * [Switch](#switch) to control WiFi -## {% linkable_title Configuration %} +## Configuration If you have enabled the [discovery component](/components/discovery/), your Freebox should be detected automatically. Otherwise, you can set it @@ -55,7 +55,7 @@ You can find out your Freebox host and port by opening [this address](http://mafreebox.freebox.fr/api_version) in your browser. The returned json should contain an api_domain (`host`) and a https_port (`port`). -### {% linkable_title Initial setup %} +### Initial setup

You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes". @@ -68,7 +68,7 @@ prompted to do so. To make the WiFi switch working you will have to add "Modification des réglages de la Freebox " permission to Home Assitant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". -### {% linkable_title Supported routers %} +### Supported routers Only the routers with Freebox OS are supported: @@ -76,12 +76,12 @@ Only the routers with Freebox OS are supported: * Freebox V6 also known as Freebox Revolution * Freebox mini 4k -## {% linkable_title Presence Detection %} +## Presence Detection This platform offers presence detection by keeping track of the devices connected to a [Freebox](http://www.free.fr/) router. -### {% linkable_title Notes %} +### Notes Note that the Freebox waits for some time before marking a device as inactive, meaning that there will be a small delay (1 or 2 minutes) @@ -92,11 +92,11 @@ On the contrary, the Freebox immediately reports devices newly connected, so they should appear as "home" almost instantly, as soon as Home Assistant refreshes the devices states. -## {% linkable_title Sensor %} +## Sensor This platform offers you sensors to monitor a Freebox router. The monitored conditions are instant upload and download rates in KB/s. -## {% linkable_title Switch %} +## Switch This platform offers you a switch to toggle the Wifi on or off. This will toggle all WiFi interfaces of the router (all SSID and all bands). diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown index 48d73fbec601..251844f64c6a 100644 --- a/source/_components/freedns.markdown +++ b/source/_components/freedns.markdown @@ -15,7 +15,7 @@ ha_release: 0.67 With the `freedns` integration you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. -## {% linkable_title Setup %} +## Setup You need to determine your update URL or your access token. @@ -26,7 +26,7 @@ You need to determine your update URL or your access token. 5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN` 6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fritz.markdown b/source/_components/fritz.markdown index 2dbd28a29541..c92dad1bd0a7 100644 --- a/source/_components/fritz.markdown +++ b/source/_components/fritz.markdown @@ -18,13 +18,13 @@ redirect_from: The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router. -## {% linkable_title Setup %} +## Setup

It might be necessary to install additional packages: $ sudo apt-get install python3-lxml libxslt-dev libxml2-dev zlib1g-dev If you installed Home Assistant in a virtualenv, run the following commands inside it: $ pip3 install lxml; be patient this will take a while.

-## {% linkable_title Configuration %} +## Configuration To use an Fritz!Box router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index ca460641e13e..4afc8b1eb061 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - Switch -#### {% linkable_title Tested Devices %} +#### Tested Devices - [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/) - [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/) @@ -40,7 +40,7 @@ There is currently support for the following device types within Home Assistant: - [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/) - [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/) -## {% linkable_title Setup %} +## Setup ```yaml # Example configuration.yaml entry @@ -71,11 +71,11 @@ devices: type: string {% endconfiguration %} -## {% linkable_title Switch & Thermostat %} +## Switch & Thermostat To get AVM Fritzbox switch and thermostat follow the instructions above. -### {% linkable_title Attributes %} +### Attributes The are several attributes that can be useful for automations and templates. @@ -93,11 +93,11 @@ The are several attributes that can be useful for automations and templates. | `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function). | `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function). -## {% linkable_title Sensor %} +## Sensor To get AVM Fritzbox temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [Fritzbox component](#setup). -### {% linkable_title Attributes %} +### Attributes The are several attributes that can be useful for automations and templates. diff --git a/source/_components/fritzbox_callmonitor.markdown b/source/_components/fritzbox_callmonitor.markdown index a1f36c15eb4a..674d745d81e2 100644 --- a/source/_components/fritzbox_callmonitor.markdown +++ b/source/_components/fritzbox_callmonitor.markdown @@ -19,7 +19,7 @@ redirect_from: The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes. -## {% linkable_title Prerequisites %} +## Prerequisites To build the package you have to install some dependencies first. @@ -35,11 +35,11 @@ Be patient this will take a while. pip3 install lxml ``` -## {% linkable_title Setup%} +## Setup To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it. -## {% linkable_title Configuration %} +## Configuration To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file: @@ -84,9 +84,9 @@ prefixes: type: list {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a call monitor with phone book support. @@ -104,7 +104,7 @@ sensor: - '089' ``` -### {% linkable_title Send notifications on state change %} +### Send notifications on state change This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed. diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index 965fc3f11cd4..7b3d7e5a2c72 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -60,7 +60,7 @@ frontend: {% endconfiguration %} -## {% linkable_title Defining Themes %} +## Defining Themes Starting with version 0.49 you can define themes: @@ -78,7 +78,7 @@ The example above defined two themes named `happy` and `sad`. For each theme you Check our [community forums](https://community.home-assistant.io/c/projects/themes) to find themes to use. -### {% linkable_title Theme automation %} +### Theme automation There are 2 themes-related services: @@ -117,7 +117,7 @@ automation: name: darkred ``` -### {% linkable_title Manual Theme Selection %} +### Manual Theme Selection When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (accessed by clicking your user account initials at the top of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. @@ -126,7 +126,7 @@ When themes are enabled in the `configuration.yaml` file, a new option will show Set a theme

-## {% linkable_title Loading extra HTML %} +## Loading extra HTML Starting with version 0.53 you can specify extra HTML files to load, and starting with version 0.95 extra JS modules. @@ -144,7 +144,7 @@ frontend: HTML will be loaded via `` on any page (states and panels), and modules via ``. -### {% linkable_title Manual Language Selection %} +### Manual Language Selection The browser language is automatically detected. To use a different language, go to the user profile menu (accessed by clicking your user account initials at the top of the sidebar) and select one. It will be applied immediately. diff --git a/source/_components/frontier_silicon.markdown b/source/_components/frontier_silicon.markdown index 02c79c90b893..7558b7e03e62 100644 --- a/source/_components/frontier_silicon.markdown +++ b/source/_components/frontier_silicon.markdown @@ -17,7 +17,7 @@ redirect_from: This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the [UNDOK] app. -## {% linkable_title Supported Models %} +## Supported Models * Hama: [IR110], [DIR3110] * Medion: [Medion Radios] * Silvercrest: [SIRD 14 C2] diff --git a/source/_components/futurenow.markdown b/source/_components/futurenow.markdown index db9c75268429..647d56b7f4bc 100644 --- a/source/_components/futurenow.markdown +++ b/source/_components/futurenow.markdown @@ -19,7 +19,7 @@ The `futurenow` light platform allows you to use [P5](http://www.p5.hu) FutureNo * [FutureNow FNIP-6x2AD](http://www.p5.hu/index.php/products/ethernet-modules/265-fnip-6x2ad) dimmer unit (outputs only) * [FutureNow FNIP-8x10A](http://www.p5.hu/index.php/products/ethernet-modules/263-fnip-8x10a) relay unit (outputs only) -### {% linkable_title Configuration Sample %} +### Configuration Sample To use your FutureNow units, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ devices: default: false {% endconfiguration %} -### {% linkable_title Extended Configuration Sample %} +### Extended Configuration Sample The following example `configuration.yaml` has two different FutureNow units with multiple channels: diff --git a/source/_components/garadget.markdown b/source/_components/garadget.markdown index 252b0d369e2f..2767f7d8de89 100644 --- a/source/_components/garadget.markdown +++ b/source/_components/garadget.markdown @@ -19,7 +19,7 @@ redirect_from: The `garadget` cover platform lets you control [Garadget](http://www.garadget.com/) garage door futurizers through Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file: @@ -73,7 +73,7 @@ covers: If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time. -## {% linkable_title Example %} +## Example

diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown index 91d92fd3c32f..7edb21fefd9f 100644 --- a/source/_components/gc100.markdown +++ b/source/_components/gc100.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the [iTach remote platform](/components/remote.itach/), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché. -## {% linkable_title Configuration %} +## Configuration To enable this device, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ port: type: integer {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file: @@ -72,7 +72,7 @@ ports: type: list {% endconfiguration %} -## {% linkable_title Switch %} +## Switch This allows you to control and monitor the relay state on your GC100. diff --git a/source/_components/gearbest.markdown b/source/_components/gearbest.markdown index 1b1cb38c5cd2..1503ad714ec1 100644 --- a/source/_components/gearbest.markdown +++ b/source/_components/gearbest.markdown @@ -58,7 +58,7 @@ items: type: string {% endconfiguration %} -### {% linkable_title Extended example %} +### Extended example ```yaml # Example configuration.yaml entry diff --git a/source/_components/geizhals.markdown b/source/_components/geizhals.markdown index f38675845afd..7f27e62e3e20 100644 --- a/source/_components/geizhals.markdown +++ b/source/_components/geizhals.markdown @@ -49,7 +49,7 @@ locale: type: string {% endconfiguration %} -#### {% linkable_title Extended example %} +#### Extended example ```yaml # Example configuration.yaml entry diff --git a/source/_components/generic.markdown b/source/_components/generic.markdown index b3d0aa213d66..9295eae9bd7b 100644 --- a/source/_components/generic.markdown +++ b/source/_components/generic.markdown @@ -20,7 +20,7 @@ The `generic` camera platform allows you to integrate any IP camera or other URL Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -85,11 +85,11 @@ verify_ssl:

-## {% linkable_title Examples %} +## Examples In this section, you find some real-life examples of how to use this camera platform. -### {% linkable_title Weather graph from yr.no %} +### Weather graph from yr.no ```yaml camera: @@ -99,7 +99,7 @@ camera: content_type: 'image/svg+xml' ``` -### {% linkable_title Local image with Hass.io %} +### Local image with Hass.io You can show a static image with this platform. Just place the image here: `/config/www/your_image.png` @@ -111,7 +111,7 @@ camera: verify_ssl: false ``` -### {% linkable_title Sharing a camera feed from one Home Assistant instance to another %} +### Sharing a camera feed from one Home Assistant instance to another If you are running more than one Home Assistant instance (let's call them the 'host' and 'receiver' instances) you may wish to display the camera feed from the host instance on the receiver instance. You can use the [REST API](/developers/rest_api/#get-apicamera_proxycameraltentity_id) to access the camera feed on the host (IP address 127.0.0.5) and display it on the receiver instance by configuring the receiver with the following: @@ -121,7 +121,7 @@ camera: name: Host instance camera feed still_image_url: https://127.0.0.5:8123/api/camera_proxy/camera.live_view ``` -### {% linkable_title Image from HTTP only camera %} +### Image from HTTP only camera To access a camera which is only available via HTTP, you must turn off SSL verification. @@ -133,7 +133,7 @@ camera: verify_ssl: false ``` -### {% linkable_title Live stream %} +### Live stream To access a camera that has both a snapshot and live stream URL, utilizing the [stream](/components/stream/) component. diff --git a/source/_components/geniushub.markdown b/source/_components/geniushub.markdown index 2a007514e5be..8d3433d1ff9e 100644 --- a/source/_components/geniushub.markdown +++ b/source/_components/geniushub.markdown @@ -21,7 +21,7 @@ The `geniushub` integration links Home Assistant with your Genius Hub for contro It uses the [geniushub-client](https://pypi.org/project/geniushub-client/) library. -### {% linkable_title Zones %} +### Zones Each Zone controlled by your Genius hub will be exposed as either a: @@ -34,7 +34,7 @@ Each such entity will report back its mode, state, setpoint and current temperat In addition, the entity's mode and setpoint can be changed. The entity's `operating_mode` can be set to one of `off`, `timer`, `on` (i.e. **Override** mode) or `eco`. The `eco` mode is a proxy for the **Footprint** mode and so is only available to **Radiator** Zones that have room sensors. -### {% linkable_title Devices %} +### Devices If the Hub is directly polled using the v3 API (see below), then each Device controlled by your Genius hub will be exposed as either a: @@ -43,7 +43,7 @@ If the Hub is directly polled using the v3 API (see below), then each Device con Each such entity will report back its primary state; in addition, `assigned_zone` and `last_comms` (last communications time) are available via the entity's attributes. -### {% linkable_title Issues %} +### Issues There are three `Sensor` entities that will indicate the number of **Errors**, **Warnings** and **Information** issues. @@ -66,7 +66,7 @@ Each such entity has a state attribute that will contain a list of any such issu ``` {% endraw %} -### {% linkable_title State Attributes %} +### State Attributes Other properties are available via each entity's state attributes. For example, in the case of **Radiator** Zones/`Climate` devices: @@ -100,11 +100,11 @@ value_template: "{{ state_attr('climate.main_room', 'status').occupied }}" ``` {% endraw %} -## {% linkable_title Configuration %} +## Configuration To add your Genius Hub into your Home Assistant installation, add one of the following to your `configuration.yaml` file. -### {% linkable_title Option 1: hub token only %} +### Option 1: hub token only - requires a **hub token** obtained from [my.geniushub.co.uk/tokens](https://my.geniushub.co.uk/tokens) - uses the v1 API - which is well-documented @@ -116,7 +116,7 @@ geniushub: token: GENIUS_HUB_TOKEN ``` -### {% linkable_title Option 2: hub hostname/address with user credentials %} +### Option 2: hub hostname/address with user credentials - requires your **username** & **password**, as used with [www.geniushub.co.uk/app](https://www.geniushub.co.uk/app) - uses the v3 API - unofficial, but there are additional features (e.g., battery levels) diff --git a/source/_components/geo_json_events.markdown b/source/_components/geo_json_events.markdown index 828a406e2769..f7856098e984 100644 --- a/source/_components/geo_json_events.markdown +++ b/source/_components/geo_json_events.markdown @@ -23,7 +23,7 @@ Entities are generated, updated and removed automatically with each update from The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To integrate a GeoJSON feed, add the following lines to your `configuration.yaml`. This is an example configuration showing [earthquake data provided by the U.S. Geological Survey](https://earthquake.usgs.gov/earthquakes/feed/v1.0/geojson.php). @@ -56,7 +56,7 @@ longitude: default: Longitude defined in your `configuration.yaml` {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -67,7 +67,7 @@ The following state attributes are available for each entity in addition to the | source | `geo_json_events` to be used in conjunction with `geo_location` automation trigger. | | external_id | The external ID used in the feed to identify the event in the feed. | -## {% linkable_title Advanced Configuration Example %} +## Advanced Configuration Example When integrating several GeoJSON feeds, it may be useful to distinguish the entities of different feeds. The easiest way to do that is by defining an [`entity_namespace`](/docs/configuration/platform_options/#entity-namespace/) for each platform which will prefix each entity ID with the defined value. diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown index 3155b55100c1..8b6600e24440 100644 --- a/source/_components/geo_location.markdown +++ b/source/_components/geo_location.markdown @@ -15,7 +15,7 @@ Geolocation aware entities are typically related to events in the real world in Entities can have associated geolocation coordinates (latitude and longitude) so that they are displayed on the map. The distance from the entity's coordinates to Home Assistant's location can be used for filtering. -## {% linkable_title Geolocation trigger %} +## Geolocation trigger The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be used in automations triggered by Geolocation entities appearing in or disappearing from zones. The following value must be used as `source` of the trigger depending on which platform is managing the entities: @@ -29,7 +29,7 @@ The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be Conditions can be used to further filter entities, for example by inspecting their state attributes. -## {% linkable_title Geolocation notification example %} +## Geolocation notification example The following example automation creates a notification on the screen when a fire classified as 'Bush Fire' is reported within a predefined bush fire alert zone: diff --git a/source/_components/geo_rss_events.markdown b/source/_components/geo_rss_events.markdown index f20cea15d50e..a03fcc390a4d 100644 --- a/source/_components/geo_rss_events.markdown +++ b/source/_components/geo_rss_events.markdown @@ -30,7 +30,7 @@ Only entries of the feed are considered that define a location as `point` or `po The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To enable the GeoRSS events sensor, add the following lines to your `configuration.yaml`. This is an example configuration showing bush fire incidents from the NSW Rural Fire Service. @@ -84,7 +84,7 @@ unit_of_measurement: default: Events {% endconfiguration %} -## {% linkable_title Example Feeds %} +## Example Feeds **Bush Fire Alerts** diff --git a/source/_components/geofency.markdown b/source/_components/geofency.markdown index 0383f42f051a..58043c8fb367 100644 --- a/source/_components/geofency.markdown +++ b/source/_components/geofency.markdown @@ -18,7 +18,7 @@ redirect_from: This integration sets up integration with [Geofency](http://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location. -## {% linkable_title Configuration %} +## Configuration To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant server at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the 'Update Geo-Position' functionality for mobile beacons. @@ -43,7 +43,7 @@ geofency: - keys ``` -### {% linkable_title Zones %} +### Zones When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to `not home`. For mobile beacons, the location name will be `not_home` whenever the beacon is entered or exited outside of a [zone](/components/zone/), otherwise, it will be set to the name of the zone. diff --git a/source/_components/github.markdown b/source/_components/github.markdown index d8f8fe50440f..8ff1b4f3f8c3 100644 --- a/source/_components/github.markdown +++ b/source/_components/github.markdown @@ -18,11 +18,11 @@ redirect_from: The GitHub sensor integrates data from [GitHub](https://github.com/) to monitor your favorite repositories. -## {% linkable_title Setup %} +## Setup To set up this sensor you will need a [personal access token](https://github.com/settings/tokens). You will need to check the `repo` scope for the sensor to function. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following to your `configuration.yaml` file: diff --git a/source/_components/gitlab_ci.markdown b/source/_components/gitlab_ci.markdown index e3e2cccc40c9..ebdf7770fa42 100644 --- a/source/_components/gitlab_ci.markdown +++ b/source/_components/gitlab_ci.markdown @@ -18,7 +18,7 @@ redirect_from: The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/). -## {% linkable_title Setup %} +## Setup You will need a GitLab repository ID. On the **Details** page for your GitLab repo, just below the project name is **Project ID:**. @@ -26,7 +26,7 @@ Alternatively, you can use `GitLab_Username/GitLab_RepositoryName`, e.g., `MyCoo A GitLab token with at least the API permission scope is needed, which can be created on the [GitLab Personal Access Tokens](https://gitlab.com/profile/personal_access_tokens) page of your GitLab User Settings. -## {% linkable_title Configuration %} +## Configuration To enable this platform, please add the following to your `configuration.yaml` file: diff --git a/source/_components/gitter.markdown b/source/_components/gitter.markdown index e6c638da1408..fa9b0c16208a 100644 --- a/source/_components/gitter.markdown +++ b/source/_components/gitter.markdown @@ -18,7 +18,7 @@ redirect_from: This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages. -## {% linkable_title Configuration %} +## Configuration Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token". diff --git a/source/_components/glances.markdown b/source/_components/glances.markdown index 8fb45cbc0beb..f3b54a526664 100644 --- a/source/_components/glances.markdown +++ b/source/_components/glances.markdown @@ -19,7 +19,7 @@ redirect_from: The `glances` sensor platform is consuming the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant. -## {% linkable_title Setup %} +## Setup This sensors needs a running instance of `glances` on the host. The minimal supported version of `glances` is 2.3. To start a Glances RESTful API server on its default port 61208, the a test the following command can be used: @@ -42,7 +42,7 @@ If this doesn't work, try changing the `2` for `3`, if you have installed the la For details about auto-starting `glances`, please refer to [Start Glances through Systemd](https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd). -## {% linkable_title Configuration %} +## Configuration To enable the Glances sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/gogogate2.markdown b/source/_components/gogogate2.markdown index 26656bf7d98a..756be2750cc4 100644 --- a/source/_components/gogogate2.markdown +++ b/source/_components/gogogate2.markdown @@ -18,7 +18,7 @@ redirect_from: The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Gogogate2 mobile app. -## {% linkable_title Configuration %} +## Configuration To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index b87d9a13c380..df1726c4b12f 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -16,13 +16,13 @@ ha_release: 0.56 The `google_assistant` integration allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. -## {% linkable_title Automatic setup via Home Assistant Cloud %} +## Automatic setup via Home Assistant Cloud With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/google_assistant/). -## {% linkable_title Manual setup %} +## Manual setup The Google Assistant integration requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. @@ -30,7 +30,7 @@ The Google Assistant integration requires a bit more setup than most due to the To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing.

-## {% linkable_title Migrate to release 0.80 and above %} +## Migrate to release 0.80 and above

If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [manual setup instructions](#first-time-setup) below.

@@ -58,7 +58,7 @@ If you've added Home Assistant to the home screen, you have to first remove it f If you're still having trouble, make sure that you're not connected to the same network Home Assistant is running on, e.g., use 4G/LTE instead.

-## {% linkable_title First time setup %} +## First time setup You need to create an API Key with the [Google Cloud API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting-the-request_sync-service)). If you don't provide one, the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration. @@ -100,7 +100,7 @@ If you've added Home Assistant to the home screen, you have to first remove it f 3. Go to Credentials, which you can find on the left navigation bar under the key icon, and select API Key from Create Credentials. 4. Note down the generated API Key and use this in the configuration. -## {% linkable_title Configuration %} +## Configuration Now add the following lines to your `configuration.yaml` file: @@ -176,7 +176,7 @@ entity_config: type: string {% endconfiguration %} -### {% linkable_title Available domains %} +### Available domains Currently, the following domains are available to be used with Google Assistant, listed with their default types: @@ -199,13 +199,13 @@ Currently, the following domains are available to be used with Google Assistant, The domain groups contains groups containing all items, by example group.all_automations. When telling Google Assistant to shut down everything, this will lead in this example to disabling all automations

-### {% linkable_title Secure Devices %} +### Secure Devices Certain devices are considered secure, including anything in the `lock` domain, and `covers` with device types `garage` and `door`. By default these cannot be opened by Google Assistant unless a `secure_devices_pin` is set up. To allow opening, set the `secure_devices_pin` to something and you will be prompted to speak the pin when opening the device. Closing and locking these devices does not require a pin. -### {% linkable_title Media Player Sources %} +### Media Player Sources Media Player sources are sent via the Modes trait in Google Assistant. There is currently a limitation with this feature that requires a hard-coded set of settings. Because of this, the only sources that will be usable by this feature are listed here: @@ -215,11 +215,11 @@ https://developers.google.com/actions/reference/smarthome/traits/modes "Hey Google, change input source to TV on Living Room Receiver" -### {% linkable_title Room/Area support %} +### Room/Area support Entities that have not got rooms explicitly set and that have been placed in Home Assistant areas will return room hints to Google with the devices in those areas. -### {% linkable_title Climate Operation Modes %} +### Climate Operation Modes There is not an exact 1-1 match between Home Assistant and Google Assistant for the available operation modes. Here are the modes that are currently available: @@ -232,7 +232,7 @@ Here are the modes that are currently available: - dry - eco -### {% linkable_title Troubleshooting the request_sync service %} +### Troubleshooting the request_sync service The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlehome/answer/7506443) from Home Control and relink. @@ -246,12 +246,12 @@ The request_sync service may fail with a 404 if the project_id of the Homegraph Syncing may also fail after a period of time, likely around 30 days, due to the fact that your Actions on Google app is techincally in testing mode and has never been published. Eventually, it seems that the test expires. Control of devices will continue to work but syncing may not. If you say "Ok Google, sync my devices" and get the response "Unable to sync Home Assistant", this can usually be resolved by going back to your test app in the [Actions on Google console](https://console.actions.google.com/) and clicking `Simulator` under `TEST`. Regenerate the draft version Test App and try asking Google to sync your devices again. -### {% linkable_title Troubleshooting with NGINX %} +### Troubleshooting with NGINX When using NGINX, ensure that your `proxy_pass` line *does not* have a trailing `/`, as this will result in errors. Your line should look like: proxy_pass http://localhost:8123; -### {% linkable_title Unlink and relink %} +### Unlink and relink If you're having trouble with *Account linking failed* after you unlinked your service, try clearing the browser history and cache. diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index fc2309bb5cdb..6a6382f001d8 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -14,7 +14,7 @@ ha_release: 0.95 The `google_cloud` platform allows you to use [Google Cloud Platform](https://cloud.google.com/) API and integrate them into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in `configuration.yaml`: @@ -25,7 +25,7 @@ tts: key_file: googlecloud.json ``` -## {% linkable_title Obtaining an API key %} +## Obtaining an API key API key obtaining process described in corresponding documentation: @@ -57,11 +57,11 @@ Basic instruction for all APIs: 5. Click `Create`. A note appears, warning that this service account has no role. 6. Click `Create without role`. A JSON file that contains your `API key` downloads to your computer. -## {% linkable_title Google Cloud Text-to-Speech %} +## Google Cloud Text-to-Speech [Google Cloud Text-to-Speech](https://cloud.google.com/text-to-speech/) converts text into human-like speech in more than 100 voices across 20+ languages and variants. It applies groundbreaking research in speech synthesis (WaveNet) and Google's powerful neural networks to deliver high-fidelity audio. With this easy-to-use API, you can create lifelike interactions with your users that transform customer service, device interaction, and other applications. -### {% linkable_title Pricing %} +### Pricing The Cloud Text-to-Speech API is priced monthly based on the amount of characters to synthesize into audio sent to the service. @@ -70,7 +70,7 @@ The Cloud Text-to-Speech API is priced monthly based on the amount of characters | Standard (non-WaveNet) voices | 0 to 4 million characters | $4.00 USD / 1 million characters | | WaveNet voices | 0 to 1 million characters | $16.00 USD / 1 million characters | -### {% linkable_title Text-to-Speech configuration %} +### Text-to-Speech configuration {% configuration %} key_file: @@ -118,7 +118,7 @@ profiles: default: "[]" {% endconfiguration %} -### {% linkable_title Full configuration example %} +### Full configuration example The Google Cloud Text-to-Speech configuration can look like: diff --git a/source/_components/google_domains.markdown b/source/_components/google_domains.markdown index 9c8928665af2..f19649e4409a 100644 --- a/source/_components/google_domains.markdown +++ b/source/_components/google_domains.markdown @@ -15,7 +15,7 @@ ha_release: 0.57 With the Google Domains integration you can keep your Google Domains record up to date. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/google_maps.markdown b/source/_components/google_maps.markdown index e99833dd5eb7..9f81b0c1a916 100644 --- a/source/_components/google_maps.markdown +++ b/source/_components/google_maps.markdown @@ -18,7 +18,7 @@ redirect_from: The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). -## {% linkable_title Configuration %} +## Configuration You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s). You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing). diff --git a/source/_components/google_pubsub.markdown b/source/_components/google_pubsub.markdown index 43458397e7ef..490909b2555b 100644 --- a/source/_components/google_pubsub.markdown +++ b/source/_components/google_pubsub.markdown @@ -15,7 +15,7 @@ ha_release: 0.88 The `google_pubsub` integration allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month). -## {% linkable_title First time setup %} +## First time setup This assumes you already have a Google Cloud project. If you don't, please create one in the [Google Cloud Console](https://console.cloud.google.com/projectcreate) @@ -28,7 +28,7 @@ This will download the Service Account JSON key to your machine. Do NOT share th Next, create a Google Pub/Sub topic in the [Google Cloud API Console](https://console.cloud.google.com/cloudpubsub/topicList). The topic name will become something like `projects/project-198373/topics/topic-name`. Note the last part only (the name you chose): `topic-name`. -## {% linkable_title Configuration %} +## Configuration Add the following lines to your `configuration.yaml` file: @@ -80,7 +80,7 @@ filter: Not filtering domains or entities will send every event to Google PubSub, thus hitting the free tier limit very fast. Be sure to fill in this configuration parameter or have a paid subscription for Google Cloud.

-### {% linkable_title Saving the data using a Google Cloud Function %} +### Saving the data using a Google Cloud Function To save your data automatically to BigQuery, follow the [instructions here](https://github.com/timvancann/home-assistant-pubsub-cloud-function). The current [free tier](https://cloud.google.com/free/) of GCP should allow to store up to 10GB of data. diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown index eb670a404130..7a01d4dc5e7d 100644 --- a/source/_components/google_translate.markdown +++ b/source/_components/google_translate.markdown @@ -22,7 +22,7 @@ The `google_translate` text-to-speech platform uses unofficial [Google Translate This platform renamed to `google_translate` from `google` since release 0.92.

-## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with Google, add the following lines to your `configuration.yaml`: @@ -43,7 +43,7 @@ language: Check the [complete list of supported languages](https://translate.google.com/intl/en_ALL/about/languages/) (languages where "Talk" feature is enabled in Google Translate) for allowed values. Use the 2 digit language code which you can find at the end of URL when you click on Language name. -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/google_travel_time.markdown b/source/_components/google_travel_time.markdown index 56838a2b52af..22a6ba23c8da 100644 --- a/source/_components/google_travel_time.markdown +++ b/source/_components/google_travel_time.markdown @@ -18,7 +18,7 @@ redirect_from: The `google_travel_time` sensor provides travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/). -## {% linkable_title Setup %} +## Setup You need to register for an API key by following the instructions [here](https://github.com/googlemaps/google-maps-services-python#api-keys). You only need to turn on the Distance Matrix API. @@ -26,7 +26,7 @@ You need to register for an API key by following the instructions [here](https:/ A quota can be set against the API to avoid exceeding the free credit amount. Set the 'Elements per day' to a limit of 645 or less. Details on how to configure a quota can be found [here](https://developers.google.com/maps/documentation/distance-matrix/usage-and-billing#set-caps) -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml` file: @@ -98,7 +98,7 @@ options: type: string {% endconfiguration %} -## {% linkable_title Dynamic Configuration %} +## Dynamic Configuration Tracking can be setup to track entities of type `device_tracker`, `zone`, `sensor` and `person`. If an entity is placed in the origin or destination then every 5 minutes when the platform updates it will use the latest location of that entity. @@ -127,7 +127,7 @@ sensor: units: imperial # 'metric' for Metric, 'imperial' for Imperial ``` -## {% linkable_title Entity Tracking %} +## Entity Tracking - **device_tracker** - If state is a zone then the zone location will be used @@ -140,7 +140,7 @@ sensor: - All other states will be passed directly into the Google API - This includes all valid locations listed in the *Configuration Variables* -## {% linkable_title Updating sensors on-demand using Automation %} +## Updating sensors on-demand using Automation You can also use the `homeassistant.update_entity` service to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation: diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown index 5347dc7f12e2..5d4cb29f40c2 100644 --- a/source/_components/googlehome.markdown +++ b/source/_components/googlehome.markdown @@ -24,7 +24,7 @@ This integration will provide: - [device_tracker](/components/device_tracker/) platform to track nearby bluetooth devices; - [sensor](/components/sensor/) platform to track the alarms and the timers. -## {% linkable_title Configuration %} +## Configuration To integrate the `googlehome` integration in Home Assistant, add the following section to your `configuration.yaml` file: @@ -66,7 +66,7 @@ devices: default: true {% endconfiguration %} -## {% linkable_title Device types %} +## Device types Device type | Description -- | -- @@ -74,7 +74,7 @@ Device type | Description 2 | Low Energy - LE-only 3 | Dual Mode - BR/EDR/LE -## {% linkable_title Notes %} +## Notes Devices will appear in the format `device_tracker._`. Note that dots are removed from the IP and BT MAC addresses. diff --git a/source/_components/gpsd.markdown b/source/_components/gpsd.markdown index cfb4796d4d4b..64af59c6b1ba 100644 --- a/source/_components/gpsd.markdown +++ b/source/_components/gpsd.markdown @@ -18,7 +18,7 @@ redirect_from: The `gpsd` integration is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. -## {% linkable_title Setup %} +## Setup A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested. @@ -45,7 +45,7 @@ Escape character is '^]'. {"class":"VERSION","release":"3.15","rev":"3.15-2.fc23","proto_major":3,"proto_minor":11} ``` -## {% linkable_title Configuration %} +## Configuration To setup a GPSD sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/gpslogger.markdown b/source/_components/gpslogger.markdown index 1d2308e837e1..d8acd113ba59 100644 --- a/source/_components/gpslogger.markdown +++ b/source/_components/gpslogger.markdown @@ -18,11 +18,11 @@ redirect_from: This integration sets up integration with [GPSLogger](https://gpslogger.app/). GPSLogger is an open source app for Android that allows users to update your location in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To configure GPSLogger, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration (below). -## {% linkable_title Setup on your smartphone %} +## Setup on your smartphone Install [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) on your device. diff --git a/source/_components/group.markdown b/source/_components/group.markdown index cb183fd77b21..db00da888020 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -64,7 +64,7 @@ control: type: string {% endconfiguration %} -## {% linkable_title Default groups %} +## Default groups Some integrations automatically create special groups containing integration entities. These groups are named like `group.all_...`, for example: @@ -76,13 +76,13 @@ Some integrations automatically create special groups containing integration ent You can see list of these groups in **State** page of the **Developer Tools**. -## {% linkable_title Group behavior %} +## Group behavior By default when any member of a group is `on` then the group will also be `on`. Similarly with a device tracker, when any member of the group is `home` then the group is `home`. If you set the `all` option to `true` though, this behavior is inverted and all members of the group have to be `on` for the group to turn on as well. --- -## {% linkable_title Old user interface %} +## Old user interface This section only applies if you've not moved off the deprecated `/states` user interface. @@ -171,7 +171,7 @@ group: - group.all_scripts ``` -## {% linkable_title Customize group order %} +## Customize group order You can also order your groups using [customize](/docs/configuration/customizing-devices/) with `order: ` if they don't show up in the order you want them in. ```yaml diff --git a/source/_components/gstreamer.markdown b/source/_components/gstreamer.markdown index 6221cd61178b..6f711de1a24a 100644 --- a/source/_components/gstreamer.markdown +++ b/source/_components/gstreamer.markdown @@ -39,7 +39,7 @@ pipeline: Only the `music` media type is supported. -## {% linkable_title Setup %} +## Setup And then install the following system dependencies: @@ -73,9 +73,9 @@ On a Raspberry Pi, you may need to add the Home Assistant user to the `audio` gr sudo usermod -a -G audio ``` -## {% linkable_title Example Usage %} +## Example Usage -### {% linkable_title Using with TTS %} +### Using with TTS To play TTS on your local computer (for example, if you have speakers attached to your Raspberry Pi: @@ -92,7 +92,7 @@ script: message: "example text-to-speech message" ``` -### {% linkable_title Using with Snapcast %} +### Using with Snapcast To play to a named pipe for consumption by Snapcast: diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown index 2e8ddb968940..7082fd5bcfde 100644 --- a/source/_components/habitica.markdown +++ b/source/_components/habitica.markdown @@ -65,7 +65,7 @@ sensors: default: all (`name`, `hp`, `maxHealth`, `mp`, `maxMP`, `exp`, `toNextLevel`, `lvl`, `gp`, `class`) {% endconfiguration %} -### {% linkable_title API Service Parameters %} +### API Service Parameters The API is exposed to Home Assistant as a service called `habitica.api_call`. To call it you should specify this keys in service data: diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown index e9cffa0816db..e117fafc7b53 100644 --- a/source/_components/hangouts.markdown +++ b/source/_components/hangouts.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) -## {% linkable_title Setup the integration via the frontend %} +## Setup the integration via the frontend Menu: *Configuration* -> *Integrations* @@ -31,7 +31,7 @@ Configure the integration: * In the authentication form there is an Optional Field: **Authorization Code** which should only be used if you get an invalid login error with email and password (see note below for details). * If you secured your account with 2-factor authentication you will be asked for a 2-factor authentication token. -## {% linkable_title Manual Authentication %} +## Manual Authentication If you are sure your email and password are correct, but the integration says the login is invalid then you would need to use the manual authentication method. @@ -39,7 +39,7 @@ To use the manual method, first you would need to obtain an authorization code ( Once the code is obtained fill in the form with your email, password and the authorization code to complete authentication. -### {% linkable_title Steps to obtain Authorization Code %}: +### Steps to obtain Authorization Code: 1. To obtain your authorization code, open [this URL](https://accounts.google.com/o/oauth2/programmatic_auth?scope=https%3A%2F%2Fwww.google.com%2Faccounts%2FOAuthLogin+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email&client_id=936475272427.apps.googleusercontent.com&device_name=hangups) in your browser. 2. Log into your Google account normally. @@ -133,7 +133,7 @@ The conversations has to be precreated, the conversation id can be obtained from The intent `HangoutsHelp` is part of the integration and return a list of all sentences the integration unterstand in this conversation. -## {% linkable_title Adding sentences %} +## Adding sentences {% raw %} @@ -165,7 +165,7 @@ This configuration will: - Toggle the light in the given location in a specific conversation. - Return the conversations the bot know. -## {% linkable_title Adding advanced custom sentences %} +## Adding advanced custom sentences Sentences can contain slots (marked with curly braces: `{name}`) and optional words (marked with square brackets: `[the]`). The values of slots will be passed on to the intent and are available inside the templates. @@ -203,9 +203,9 @@ intent_script: {% endraw %} -## {% linkable_title Services %} +## Services -### {% linkable_title Service `hangouts.update` %} +### Service `hangouts.update` Updates the list of conversations. @@ -213,7 +213,7 @@ Updates the list of conversations. |------------------------|----------|--------------------------------------------------| | | | | -### {% linkable_title Service `hangouts.send_message` %} +### Service `hangouts.send_message` Sends a message to the given conversations. @@ -223,7 +223,7 @@ Sends a message to the given conversations. | message | List of message segments, only the "text" field is required in every segment. [Required] | [{"text":"test", "is_bold": false, "is_italic": false, "is_strikethrough": false, "is_underline": false, "parse_str": false, "link_target": "http://google.com"}, ...] | | data | Extra options | {"image_file": "path"} / {"image_url": "url"} | -### {% linkable_title Service `hangouts.reconnect` %} +### Service `hangouts.reconnect` Reconnects the hangouts bot. @@ -231,9 +231,9 @@ Reconnects the hangouts bot. |------------------------|----------|--------------------------------------------------| | | | | -## {% linkable_title Advanced %} +## Advanced -### {% linkable_title Automatic reconnect after ip change %} +### Automatic reconnect after ip change The hangouts integration can't detect if your ip address changes, so it can't automatic reconnect to the Google servers. This is a workaround for this problem. @@ -263,7 +263,7 @@ automation: {% endraw %} -## {% linkable_title Notifications %} +## Notifications The `hangouts` platform allows you to deliver notifications from Home Assistant to [Google Hangouts](http://hangouts.google.com) conversations. Conversations can be both direct as well as group chats. @@ -295,7 +295,7 @@ default_conversations: type: string {% endconfiguration %} -### {% linkable_title Finding the conversation ID %} +### Finding the conversation ID The conversations has to be precreated, the conversation id can be obtained from the `hangouts.conversations` entity, this can be found in with the states developer tool that is shown as this icon in the side bar. Using your web browsers search tool to find the `hangouts.conversations` entity. You will find something like below. diff --git a/source/_components/harmony.markdown b/source/_components/harmony.markdown index 270140faec74..dbcf68641c26 100644 --- a/source/_components/harmony.markdown +++ b/source/_components/harmony.markdown @@ -75,7 +75,7 @@ hold_secs: default: 0 {% endconfiguration %} -### {% linkable_title Configuration file %} +### Configuration file Upon startup one file will be written to your Home Assistant configuration directory per device in the following format: `harmony_REMOTENAME.conf`. The file will contain: @@ -85,7 +85,7 @@ Upon startup one file will be written to your Home Assistant configuration direc This file will be overwritten whenever the Harmony HUB has a new configuration, there is no need to restart Home Assistant. -### {% linkable_title Service `remote.turn_off` %} +### Service `remote.turn_off` Turn off all devices that were switched on from the start of the current activity. @@ -93,7 +93,7 @@ Turn off all devices that were switched on from the start of the current activit | ---------------------- | -------- | ----------- | | `entity_id` | no | Entity ID to target. -### {% linkable_title Service `remote.turn_on` %} +### Service `remote.turn_on` Start an activity. Will start the default `activity` from configuration.yaml if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). @@ -102,7 +102,7 @@ Start an activity. Will start the default `activity` from configuration.yaml if | `entity_id` | no | Entity ID to target. | `activity` | yes | Activity ID or Activity Name to start. -##### {% linkable_title Example %} +##### Example In the file 'harmony_REMOTENAME.conf' you can find the available activities, for example: @@ -127,7 +127,7 @@ action: activity: "Watch TV" ``` -### {% linkable_title Service `remote.send_command` %} +### Service `remote.send_command` Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s). @@ -189,7 +189,7 @@ data: delay_secs: 0.6 ``` -### {% linkable_title Service `remote.harmony_change_channel` %} +### Service `remote.harmony_change_channel` Sends the change channel command to the Harmony HUB @@ -207,7 +207,7 @@ data: channel: 200 ``` -### {% linkable_title Service `remote.harmony_sync` %} +### Service `remote.harmony_sync` Force synchronization between the Harmony device and the Harmony cloud. @@ -215,7 +215,7 @@ Force synchronization between the Harmony device and the Harmony cloud. | ---------------------- | -------- | ----------- | | `entity_id` | no | Entity ID to target. -### {% linkable_title Examples %} +### Examples Template sensors can be utilized to display current activity in the frontend. diff --git a/source/_components/haveibeenpwned.markdown b/source/_components/haveibeenpwned.markdown index cf7326d03ac5..3d6feb54adb5 100644 --- a/source/_components/haveibeenpwned.markdown +++ b/source/_components/haveibeenpwned.markdown @@ -18,7 +18,7 @@ redirect_from: The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com). -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`, it will list every specified email address as a sensor showing the number of breaches on that email account. @@ -39,7 +39,7 @@ email: type: list {% endconfiguration %} -## {% linkable_title Breach meta data %} +## Breach meta data If one of your email accounts is breached the sensor will display breach meta data. It will list the title of the site where your email account has been breached as well as the added date of the breach data. This data is displayed in descending order so that the state attribute diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 3576095a136b..391a35e344cc 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -19,13 +19,13 @@ redirect_from: The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. -## {% linkable_title CEC Setup %} +## CEC Setup -### {% linkable_title Adapter %} +### Adapter The computer running Home Assistant must support CEC, and of course be connected via HDMI to a device also supporting CEC. You can purchase a [USB CEC adapter](https://www.pulse-eight.com/p/104/usb-hdmi-cec-adapter) to add support if necessary. Note that all Raspberry Pi models support CEC natively. -### {% linkable_title libcec %} +### libcec [libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag. @@ -33,7 +33,7 @@ The computer running Home Assistant must support CEC, and of course be connected If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

-#### {% linkable_title Symlinking into virtual environment %} +#### Symlinking into virtual environment Create a symlink to the `cec` installation including the _cec.so file. Keep in mind different installation methods will result in different locations of cec. @@ -43,7 +43,7 @@ $ ln -s /path/to/your/installation/of/_cec.so /path/to/your/venv/lib/python*/sit ``` -##### {% linkable_title Symlinking examples: %} +##### Symlinking examples: For the default virtual environment of a [HASSbian Image for Raspberry Pi](/docs/installation/raspberry-pi/) the command would be as follows. @@ -57,7 +57,7 @@ $ ln -s /usr/local/lib/python*/dist-packages/_cec.so /srv/homeassistant/lib/pyth `* failed to open vchiq instance` you will also need to add the user account Home Assistant runs under, to the `video` group. To add the Home Assistant user account to the `video` group, run the following command. `$ usermod -a -G video `

-## {% linkable_title Testing your installation %} +## Testing your installation * Login to Raspberry Pi @@ -92,7 +92,7 @@ language: ???

`address:` entry above this will be used to configure Home Assistant, this address is represented below as 3: BlueRay player.

-## {% linkable_title Configuration Example %} +## Configuration Example In the following example, a Pi Zero running Home Assistant is on a TV's HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3. @@ -147,9 +147,9 @@ hdmi_cec: ``` -## {% linkable_title Services %} +## Services -### {% linkable_title Select Device %} +### Select Device Call the `hdmi_cec.select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: @@ -174,7 +174,7 @@ action: device: Chromecast ``` -### {% linkable_title Power On %} +### Power On Call the `hdmi_cec.power_on` service (no arguments) to power on any devices that support this function. @@ -185,7 +185,7 @@ action: service: hdmi_cec.power_on ``` -### {% linkable_title Standby %} +### Standby Call the `hdmi_cec.standby` service (no arguments) to place in standby any devices that support this function. @@ -196,11 +196,11 @@ action: service: hdmi_cec.standby ``` -### {% linkable_title Change volume level %} +### Change volume level Call the `hdmi_cec.volume` service with one of following commands: -#### {% linkable_title Volume up %} +#### Volume up Increase volume three times: ```json @@ -219,7 +219,7 @@ Stop increasing volume: {"up": "release"} ``` -#### {% linkable_title Volume down %} +#### Volume down Decrease volume three times: ```json @@ -238,7 +238,7 @@ Stop decreasing volume: {"down": "release"} ``` -#### {% linkable_title Volume mute %} +#### Volume mute Toggle mute: ```json @@ -248,7 +248,7 @@ Toggle mute: value is ignored. -## {% linkable_title Useful References %} +## Useful References * [CEC overview](http://wiki.kwikwai.com/index.php?title=The_HDMI-CEC_bus) * [CEC-o-matic](http://www.cec-o-matic.com/) diff --git a/source/_components/heos.markdown b/source/_components/heos.markdown index 44e9a75690fe..d3462afa07e3 100644 --- a/source/_components/heos.markdown +++ b/source/_components/heos.markdown @@ -22,7 +22,7 @@ The HEOS integration adds support for [HEOS](http://heosbydenon.denon.com) capab - Clear playlist - Select source from device physical inputs and HEOS favorites -## {% linkable_title Configuration %} +## Configuration HEOS devices are discovered and setup automatically when the [discovery](/components/discovery) integration is enabled. Alternatively, the integration can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file: @@ -43,9 +43,9 @@ host: A connection to a single device enables control for all devices on the network. If you have multiple HEOS devices, enter the host of one that is connected to the LAN via wire or has the strongest wireless signal.

-## {% linkable_title Services %} +## Services -### {% linkable_title Service `heos.sign_in` %} +### Service `heos.sign_in` Use the sign-in service to sign the connected controller into a HEOS account so that it can retreive and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload: @@ -61,13 +61,13 @@ Use the sign-in service to sign the connected controller into a HEOS account so | `username` | The username or email of the HEOS account. [Required] | `password` | The password of the HEOS account. [Required] -### {% linkable_title Service `heos.sign_out` %} +### Service `heos.sign_out` Use the sign-out service to sign the connected controller out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this service. -### {% linkable_title Service `media_player.play_media` %} +### Service `media_player.play_media` -#### {% linkable_title Play Favorite %} +#### Play Favorite You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload: @@ -85,7 +85,7 @@ You can play a HEOS favorite by number or name with the `media_player.play_media | `media_content_type` | Set to the value `playlist` | `media_content_id` | The nubmer (i.e. `1`) or name (i.e. `Thumbprint Radio`) of the HEOS favorite -#### {% linkable_title Play Playlist %} +#### Play Playlist You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload: @@ -103,7 +103,7 @@ You can play a HEOS playlist with the `media_player.play_media` service. Example | `media_content_type` | Set to the value `playlist` | `media_content_id` | The name of the HEOS playlist -#### {% linkable_title Play Quick Select %} +#### Play Quick Select You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload: @@ -121,7 +121,7 @@ You can play a HEOS Quick Select by nubmer or name with the `media_player.play_m | `media_content_type` | Set to the value `quick_select` | `media_content_id` | The quick select number (i.e. `1`) or name (i.e. `Quick Select 1`) -#### {% linkable_title Play Url %} +#### Play Url You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: @@ -139,14 +139,14 @@ You can play a URL through a HEOS media player using the `media_player.play_medi | `media_content_type` | Set to the value `url` | `media_content_id` | The full URL to the stream -## {% linkable_title Notes %} +## Notes - HEOS groups are not currently supported. - Receivers with multiple zones are represented as a single media player. They will be turned on when playback is started, but cannot be turned off by the integration at this time. -## {% linkable_title Troubleshooing %} +## Troubleshooing -### {% linkable_title Debugging %} +### Debugging The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml` to enable debug logging: @@ -158,7 +158,7 @@ logger: pyheos: debug ``` -### {% linkable_title Missing Favorites %} +### Missing Favorites If the HEOS controller is not signed in to a HEOS account, HEOS favorites will not be populated in the media player source selection and the service `media_player.play_media` for `favorite` and `playlist` will fail. Additionally, the following warning will be logged at startup: > IP_ADDRESS is not logged in to a HEOS account and will be unable to retrieve HEOS favorites: Use the 'heos.sign_in' service to sign-in to a HEOS account diff --git a/source/_components/hikvision.markdown b/source/_components/hikvision.markdown index b59068d45173..15d91c1014a5 100644 --- a/source/_components/hikvision.markdown +++ b/source/_components/hikvision.markdown @@ -64,7 +64,7 @@ and has been confirmed to work with the following models: - DS-2CD2142FWD-I - DS-2CD2155FWD-IS -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines are required in your `configuration.yaml` file: @@ -128,7 +128,7 @@ customize: default: 5 {% endconfiguration %} -### {% linkable_title Supported types %} +### Supported types Supported sensor/event types are: @@ -149,7 +149,7 @@ Supported sensor/event types are: - Face Detection - Scene Change Detection -## {% linkable_title Examples %} +## Examples Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera: diff --git a/source/_components/hipchat.markdown b/source/_components/hipchat.markdown index e06733ebd7dd..97cac0dceb06 100644 --- a/source/_components/hipchat.markdown +++ b/source/_components/hipchat.markdown @@ -73,7 +73,7 @@ host: type: string {% endconfiguration %} -### {% linkable_title HipChat service data %} +### HipChat service data The following attributes can be placed `data` for extended functionality. diff --git a/source/_components/history.markdown b/source/_components/history.markdown index 3bb947defd42..56839afa3b39 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -142,7 +142,7 @@ history: - light.front_porch ``` -#### {% linkable_title Implementation details %} +#### Implementation details The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory unless the `recorder` integration is set up differently. @@ -160,7 +160,7 @@ configuration directory unless the `recorder` integration is set up differently. When the `history` integration queries the states table it only selects states where the state has changed: `WHERE last_changed=last_updated` -#### {% linkable_title On dates %} +#### On dates SQLite databases do not support native dates. That's why all the dates are saved in seconds since the UNIX epoch. Convert them manually using @@ -171,7 +171,7 @@ from datetime import datetime datetime.fromtimestamp(1422830502) ``` -#### {% linkable_title API %} +#### API The history information is also available through the [RESTful API](/developers/rest_api/#get-apihistory). diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index e7d5ca6d87f6..c4d89a29d409 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -53,7 +53,7 @@ refresh: type: integer {% endconfiguration %} -### {% linkable_title Full Example %} +### Full Example ```yaml # Full configuration.yaml entry diff --git a/source/_components/history_stats.markdown b/source/_components/history_stats.markdown index 9d2fa83b8a06..9e0ded8b066a 100644 --- a/source/_components/history_stats.markdown +++ b/source/_components/history_stats.markdown @@ -27,7 +27,7 @@ Examples of what you can track: - How long the lights were ON yesterday - How long you watched TV today -## {% linkable_title Configuration %} +## Configuration To enable the history statistics sensor, add the following lines to your `configuration.yaml`: @@ -84,7 +84,7 @@ duration: You can use [template extensions](/topics/templating/#home-assistant-template-extensions) such as `now()` or `as_timestamp()` to handle dynamic dates, as shown in the examples below.

-## {% linkable_title Sensor type %} +## Sensor type Depending on the sensor type you choose, the `history_stats` integration can show different values: @@ -92,7 +92,7 @@ Depending on the sensor type you choose, the `history_stats` integration can sho - **ratio**: The tracked time divided by the length of your period, as a percentage - **count**: How many times the integration you track was changed to the state you track -## {% linkable_title Time periods %} +## Time periods The `history_stats` integration will execute a measure within a precise time period. You should always provide 2 of the following : - When the period starts (`start` variable) @@ -101,7 +101,7 @@ The `history_stats` integration will execute a measure within a precise time per As `start` and `end` variables can be either datetimes or timestamps, you can configure almost any period you want. -### {% linkable_title Duration %} +### Duration The duration variable is used when the time period is fixed. Different syntaxes for the duration are supported, as shown below. @@ -123,7 +123,7 @@ duration: minutes: 30 ``` -### {% linkable_title Examples %} +### Examples Here are some examples of periods you could work with, and what to write in your `configuration.yaml`: diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index a32aaaeafc11..1085481707ec 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -62,7 +62,7 @@ scan_interval: default: 2 {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `hive` binary sensor integration integrates your Hive sensors into Home Assistant. @@ -71,7 +71,7 @@ The platform supports the following Hive products: - Hive Window or Door Sensor - Hive Motion Sensor -## {% linkable_title Climate %} +## Climate The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**. @@ -83,7 +83,7 @@ The platform supports the following Hive products: - Hive Multizone - Hot water control -## {% linkable_title Light %} +## Light The `hive` light platform integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light. @@ -93,7 +93,7 @@ The platform supports the following Hive products: - Hive Active Light Cool to Warm White - Hive Active Light Color Changing -## {% linkable_title Sensor %} +## Sensor The `hive` sensor integration exposes Hive data as a sensor. @@ -102,7 +102,7 @@ The platform exposes the following sensors: - Hive Hub Online Status - Hive Outside Temperature -## {% linkable_title Switch %} +## Switch The `hive` switch platform integrates your Hive plugs into Home Assistant, enabling control of your devices. diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index bcbc32d73580..fea03fdaa120 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -150,7 +150,7 @@ homekit: {% endconfiguration %} -## {% linkable_title Setup %} +## Setup To enable the HomeKit integration in Home Assistant, add the following to your configuration file: @@ -171,29 +171,29 @@ After Home Assistant has started, the entities specified by the filter are expos After the setup is completed, you should be able to control your Home Assistant integrations through Apple's Home and Siri. -## {% linkable_title Move Home Assistant install %} +## Move Home Assistant install If you like to retain your HomeKit pairing through a move to a new Home Assistant device or installation, besides copying the configurations files you need to copy the `.homekit.state` file inside your configurations directory. Keep in mind though that the file is usually hidden by default, depending on your operating system. Before you copy it, make sure to stop the old and new Home Assistant instances first entirely, otherwise it won't work. -## {% linkable_title Considerations %} +## Considerations -### {% linkable_title Accessory ID %} +### Accessory ID Currently, this integration uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This, however, means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. -### {% linkable_title Device Limit %} +### Device Limit The HomeKit guidelines only allow a maximum of 100 unique accessories (`aid`) per bridge. Be mindful of this when configuring the filter(s). -### {% linkable_title Persistence Storage %} +### Persistence Storage Unfortunately `HomeKit` doesn't support any persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems, it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not set up, their config will be deleted. (State unknown or similar will not cause any issues.) A common situation might be if you decide to disable parts of the configuration for testing. Please make sure to disable `auto start` and `turn off` the `Start HomeKit` automation (if you have one). -## {% linkable_title Disable Auto Start %} +## Disable Auto Start Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` integration is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`. @@ -271,7 +271,7 @@ automation: ``` {% endraw %} -## {% linkable_title Configure Filter %} +## 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. @@ -305,7 +305,7 @@ Filters are applied as follows: - if entity is included, pass (as #2 above) - if entity include and exclude, the entity exclude is ignored -## {% linkable_title Safe Mode %} +## Safe Mode The `safe_mode` option should only be used (and only works) if you encounter issues during the pairing. ([Paring hangs - zeroconf error](#pairing-hangs---zeroconf-error)). @@ -322,7 +322,7 @@ Restart your Home Assistant instance. If you don't see a `pincode`, follow the [ To avoid any errors, after you have successfully paired your Home Assistant Bridge, remove the `safe_mode` option from your config and restart Home Assistant.

-## {% linkable_title Supported Components %} +## Supported Components The following integrations are currently supported: @@ -352,9 +352,9 @@ The following integrations are currently supported: | switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. | | water_heater | WaterHeater | All water_heater devices. | -## {% linkable_title Troubleshooting %} +## Troubleshooting -### {% linkable_title Deleting the `.homekit.state` file %} +### Deleting the `.homekit.state` file The `.homekit.state` file can be found in the configurations directory. You might need to enable `view hidden files` to see it. @@ -362,7 +362,7 @@ The `.homekit.state` file can be found in the configurations directory. You migh 2. Delete the `.homekit.state` file 3. **Start** Home Assistant -### {% linkable_title Errors during pairing %} +### Errors during pairing If you encounter any issues during pairing, make sure to: @@ -384,11 +384,11 @@ homekit: - demo.demo ``` -#### {% linkable_title PIN doesn't appear as persistent status %} +#### PIN doesn't appear as persistent status You might have paired the `Home Assistant Bridge` already. If not, delete the `.homekit.state` file ([guide](#deleting-the-homekitstate-file)). -#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) %} +#### `Home Assistant Bridge` doesn't appear in the Home App (for pairing) This is often setup and network related. Make sure to check the other issues below as well, but things that might work include: - Check your router configuration @@ -397,73 +397,73 @@ This is often setup and network related. Make sure to check the other issues bel Remember that the iOS device needs to be in the same local network as the Home Assistant device for paring. -#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - Docker %} +#### `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - Docker Set `network_mode: host`. If you have further problems this [issue](https://github.com/home-assistant/home-assistant/issues/15692) might help. -#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - VirtualBox %} +#### `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - VirtualBox Configure the network mode as `networkbridge`. Otherwise the Home Assistant Bridge won't be exposed to the network. -#### {% linkable_title Pairing hangs - zeroconf error %} +#### Pairing hangs - zeroconf error Pairing eventually fails, you might see and an error message `NonUniqueNameException`. Add the `safe_mode` option to your config, see [safe_mode](#safe-mode). -#### {% linkable_title Pairing hangs - only works with debug config %} +#### Pairing hangs - only works with debug config Pairing works fine when the filter is set to only include `demo.demo`, but fails with normal config. See [specific entity doesn't work](#specific-entity-doesnt-work) -#### {% linkable_title Pairing hangs - no error %} +#### Pairing hangs - no error 1. Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it. 2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge hook ups to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable. -#### {% linkable_title Duplicate AID found when attempting to add accessory %} +#### Duplicate AID found when attempting to add accessory Two of your entities share the same `entity_id`. Either resolve this or configure the [filter](#configure-filter) to exclude them. -### {% linkable_title Issues during normal use %} +### Issues during normal use -#### {% linkable_title Some of my devices don't show up - Z-Wave / Discovery %} +#### Some of my devices don't show up - Z-Wave / Discovery See [disable auto start](#disable-auto-start) -#### {% linkable_title My entity doesn't show up %} +#### My entity doesn't show up Check if the domain of your entity is [supported](#supported-components). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`. -#### {% linkable_title HomeKit doesn't work on second Home Assistant instance %} +#### HomeKit doesn't work on second Home Assistant instance To use the HomeKit integration with to different Home Assistant instances on the same local network, you need to set a custom name for at least one of them. [config/name](#name) -#### {% linkable_title Specific entity doesn't work %} +#### Specific entity doesn't work Although we try our best, some entities don't work with the HomeKit integration yet. The result will be that either pairing fails completely or all Home Assistant accessories will stop working. Use the filter to identify which entity is causing the issue. It's best to try pairing and step by step including more entities. If it works unpair and repeat until you find the one that is causing the issues. To help others and the developers, please open a new issue here: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) -#### {% linkable_title Accessories are all listed as not responding %} +#### Accessories are all listed as not responding See [specific entity doesn't work](#specific-entity-doesnt-work) -#### {% linkable_title Accessory not responding - after restart or update %} +#### Accessory not responding - after restart or update See [device limit](#device-limit) -#### {% linkable_title Accessory not responding - randomly %} +#### Accessory not responding - randomly Unfortunately, that sometimes happens at the moment. It might help to close the `Home` App and delete it from the cache. Usually, the accessory should get back to responding after a few minutes at most. -#### {% linkable_title Accessories not responding / behaving unusual - Upgrade from `0.65.x` %} +#### Accessories not responding / behaving unusual - Upgrade from `0.65.x` To fix this, you need to unpair the `Home Assistant Bridge`, delete the `.homekit.state` file ([guide](#deleting-the-homekitstate-file)) and pair it again. This should only be an issue if you're upgrading from `0.65.x` or below. -#### {% linkable_title The linked battery sensor isn't recognized %} +#### The linked battery sensor isn't recognized Try removing the entity from HomeKit and then adding it again. If you are adding this config option to an existing entity in HomeKit, any changes you make to this entity's config options won't appear until the accessory is removed from HomeKit and then re-added. -#### {% linkable_title My media player is not showing up as a television accessory %} +#### My media player is not showing up as a television accessory Media Player entities with `device_class: tv` will show up as Television accessories on devices running iOS 12.2/macOS 10.14.4 or later. If needed, try removing the entity from HomeKit and then adding it again, especially if the `media_player` was previously exposed as a series of switches. Any changes, including changed supported features, made to an existing accessory won't appear until the accessory is removed from HomeKit and then re-added. -#### {% linkable_title Can't control volume of your TV media player? %} +#### Can't control volume of your TV media player? The volume and play/pause controls will show up on the Remote app or Control Center. If your TV supports volume control through Home Assistant, you will be able to control the volume using the side volume buttons on the device while having the remote selected on screen. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index f8d422859399..d336247b126b 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -185,7 +185,7 @@ homematic: ``` -### {% linkable_title The `resolvenames` option %} +### The `resolvenames` option We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names. @@ -195,13 +195,13 @@ We use three approaches to fetch the names of devices. Each assumes you have pro Resolving names can take some time. So when you start Home Assistant you won't see you devices at first. For a setup with 20+ devices it can take up to a minute until all devices show up in the UI. -### {% linkable_title Multiple hosts %} +### Multiple hosts In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters. Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host. This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected. -### {% linkable_title Reading attributes of entities %} +### Reading attributes of entities Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/components/sensor.template/) component. Here's an example of a template sensor that exposes the valve state of a thermostat. @@ -215,20 +215,20 @@ sensor: friendly_name: 'Bedroom valve' ``` -### {% linkable_title Variables %} +### Variables It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables. With the CCU a user with Admin-access is required. The states of the variables are available through the attributes of your hub entity (e.g., `homematic.ccu2`). Use templates (as mentioned above) to make your variables available to automations or as entities. The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed. -### {% linkable_title Events %} +### Events When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available: - **homematic.keypress**: For devices with buttons, see information below - **homematic.impulse**: For impulse sensors -#### {% linkable_title Devices with buttons %} +#### Devices with buttons Devices with buttons (e.g., HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don't serve any value here and all they do is trigger events. As an example: @@ -263,7 +263,7 @@ You can test whether your button works within Home Assistant if you look at the It may happen that "your_nice_name" is not resolved correctly; the according message (#2 in the above example) will be missing. This might be due to secure communication between your HM interface and the HM device. You can change the communication from "secure" to "standard" within your HM-interface to solve that issue (in "Einstellungen" - "Geräte" find your device and change "Übertragungsmodus" from secure to standard) - not recommended for devices that should have secure communication. -#### {% linkable_title `homematic.keypress` events for HomeMatic IP devices %} +#### `homematic.keypress` events for HomeMatic IP devices To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / WRC6 (wall switch) or SPDR (passage sensor) or the KRC4 (key ring remote control) you have to temporary create an empty program for each channel in the CCU: @@ -277,7 +277,7 @@ To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / 8. When your channel is working now, you can edit it to select the other channels one by one 9. At the end, you can delete this program from the CCU -### {% linkable_title Services %} +### Services - *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys. - *homematic.reconnect*: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted) @@ -285,7 +285,7 @@ To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / - *homematic.set_device_value*: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC. - *homematic.put_paramset*: Manually change a device's paramset (even devices without support). Equivalent to putParamset-method from XML-RPC. -#### {% linkable_title Examples %} +#### Examples Simulate a button being pressed: @@ -323,7 +323,7 @@ action: value: true ``` -#### {% linkable_title Advanced examples %} +#### Advanced examples If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented. Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above `rf`, `wired` and `ip` would be valid values. @@ -400,7 +400,7 @@ action: entity_id: lock.leq1234567 ``` -#### {% linkable_title Detecting lost connections %} +#### Detecting lost connections When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your HomeMatic integrations are still updated properly, in order to detect connection losses. This can be done in several ways through an automation: @@ -470,13 +470,13 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi service: homematic.reconnect ``` -## {% linkable_title Notifications %} +## Notifications The `homematic` notification platform enables invoking Homematic devices. To use this notification platform in your installation, add the following to your `configuration.yaml` file: -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -512,7 +512,7 @@ value: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage `homematic` is a notify platform and can be controlled by calling the notify service [as described here](/components/notify/). diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 800872f7269a..23920f15f443 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: * Switch * Weather -## {% linkable_title Setup the integration via the frontend %} +## Setup the integration via the frontend Menu: *Configuration* -> *Integrations* @@ -53,7 +53,7 @@ Fill the form: The authentification token will be generated and stored internally. -## {% linkable_title Setup the integration using the configuration files %} +## Setup the integration using the configuration files Generate the authentication token: @@ -85,7 +85,7 @@ authtoken: type: string {% endconfiguration %} -## {% linkable_title Implemented and tested devices %} +## Implemented and tested devices * homematicip_cloud.alarm_control_panel * Combined Alarm Control Panal with INTERNAL and EXTERNAL Security zones (*HmIP-SecurityZone*) diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown index 8ac001abbff3..b2b2ce3c420a 100644 --- a/source/_components/homeworks.markdown +++ b/source/_components/homeworks.markdown @@ -26,7 +26,7 @@ Lutron has created many systems over the years, each with their own unique inter Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1). -## {% linkable_title Configuration %} +## Configuration The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` integration must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/honeywell.markdown b/source/_components/honeywell.markdown index 3c50ddaefe59..6a738563fd4b 100644 --- a/source/_components/honeywell.markdown +++ b/source/_components/honeywell.markdown @@ -24,13 +24,13 @@ There is some potential confusion over this integration because it is currently These two regions are _not_ interchangeable, so you must be clear which applies to your climate system.

-## {% linkable_title US-based Systems %} +## US-based Systems These systems are based in North America, and temperatures are usually in Fahrenheit. They would likely be HVAC systems. They always use the [somecomfort](https://github.com/kk7ds/somecomfort) client library. In this integration, this is called the `us` region. If your system is US-based, then you can access your system via [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/) (note the `/portal/`). -## {% linkable_title EU-based Systems %} +## EU-based Systems These systems are based in Europe (including the UK & Ireland), and temperatures are usually in Celsius. They would likely be heating-only systems. They always use the [evohome-client](https://github.com/watchforstock/evohome-client) client library. In this integration, this is called the `eu` region. @@ -38,7 +38,7 @@ If your system is US-based, then you can access it via [https://international.my The `eu` region is soon to be deprecated, and ongoing support for such systems is available via the [evohome](/components/evohome/) integration. -## {% linkable_title Configuration %} +## Configuration To set up this integration, first confirm your region, then add the following information to your **configuration.yaml** file (the below example is for US-based systems): diff --git a/source/_components/hook.markdown b/source/_components/hook.markdown index 2b23bf0bed11..a7fe81ed0d1a 100644 --- a/source/_components/hook.markdown +++ b/source/_components/hook.markdown @@ -23,7 +23,7 @@ In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive comman Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant integration reads in devices that have been set up in the official app. -## {% linkable_title Configuration %} +## Configuration Configure with either your username/password or your API token for the official app. diff --git a/source/_components/horizon.markdown b/source/_components/horizon.markdown index fea3cf69fb4e..5839379b7bc1 100644 --- a/source/_components/horizon.markdown +++ b/source/_components/horizon.markdown @@ -43,6 +43,6 @@ media_player: {% endconfiguration %} -#### {% linkable_title Preparation of the Horizon HD Recorder %} +#### Preparation of the Horizon HD Recorder The Home Networking ("Heimnetzwerk") service needs to be enabled at the settings menu of the Horizon receiver. Once you have set up the Media Library ("Medienbibliothek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start. diff --git a/source/_components/hp_ilo.markdown b/source/_components/hp_ilo.markdown index fdd982b7fe28..0300a457a52e 100644 --- a/source/_components/hp_ilo.markdown +++ b/source/_components/hp_ilo.markdown @@ -26,7 +26,7 @@ Some more details about what can be retrieved from these sensors is available in

-## {% linkable_title Configuration %} +## Configuration To use this integration in your installation, add the following to your `configuration.yaml` file: @@ -97,7 +97,7 @@ Valid sensor_types: - **server_health**: Get server health information. - **network_settings**: Get the iLO network settings. -## {% linkable_title Example %} +## Example In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your `configuration.yaml` file @@ -125,13 +125,13 @@ sensor:

-## {% linkable_title Hardware specifics %} +## Hardware specifics

Not every hardware supports all values.

-### {% linkable_title HP Microserver Gen8 %} +### HP Microserver Gen8 On this hardware you should avoid using the following sensor_types as `monitored_variables:` to prevent errors. diff --git a/source/_components/html5.markdown b/source/_components/html5.markdown index 6e9035f00ce9..7e1e63c2c149 100644 --- a/source/_components/html5.markdown +++ b/source/_components/html5.markdown @@ -25,7 +25,7 @@ HTML5 push notifications **do not** work on iOS. The GCM configuration option is deprecated and will stop working in April 2019, see [https://developers.google.com/cloud-messaging/faq](https://developers.google.com/cloud-messaging/faq). If you are installing this platform for the first time, follow the VAPID configuration steps. To migrate your current installation from GCM to VAPID configuration, follow the instructions below. You can skip the first 3 steps and continue in step 4 with your existing project. You will also need to delete `html5_push_registrations.conf` and [re-enable the notifications in your browser](#setting-up-your-browser).

-## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml` file: @@ -79,7 +79,7 @@ gcm_sender_id: type: string {% endconfiguration %} -### {% linkable_title Requirements %} +### Requirements The `html5` platform can only function if all of the following requirements are met: @@ -90,7 +90,7 @@ The `html5` platform can only function if all of the following requirements are * You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running [NGINX](/ecosystem/nginx/) in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e. not self signed). * You are willing to accept the notification permission in your browser. -### {% linkable_title Configuring the platform %} +### Configuring the platform 1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see docs](/docs/configuration/remote/)). 2. Create a new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard). @@ -100,7 +100,7 @@ The `html5` platform can only function if all of the following requirements are 6. Select 'Cloud Messaging' tab. 7. Generate a new key pair under the Web configuration listing at the bottom of the page. To view the private key click the three dots to the right and 'Show private key'. -### {% linkable_title Setting up your browser %} +### Setting up your browser Assuming you have already configured the platform: @@ -113,7 +113,7 @@ Assuming you have already configured the platform: **Note:** If you aren't prompted for a device name when enabling notifications, open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file. -### {% linkable_title Testing %} +### Testing Assuming the previous test completed successfully and your browser was registered, you can test the notification as follows: @@ -123,12 +123,12 @@ Assuming the previous test completed successfully and your browser was registere 4. In the Service Data text box enter: `{"message":"hello world"}`, then press the CALL SERVICE button. 5. If everything worked you should see a popup notification. -### {% linkable_title Usage %} +### Usage The `html5` platform accepts a standard notify payload. However, there are also some special features built in which you can control in the payload. -#### {% linkable_title Actions %} +#### Actions Chrome supports notification actions, which are configurable buttons that arrive with the notification and can cause actions on Home Assistant to happen when pressed. You can send up to 2 actions. @@ -143,7 +143,7 @@ data: title: Open door ``` -#### {% linkable_title Data %} +#### Data Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`) will be sent back to you in the [callback events](#automating-notification-events). @@ -154,7 +154,7 @@ data: my-custom-parameter: front-door-open ``` -#### {% linkable_title Tag %} +#### Tag By default, every notification sent has a randomly generated UUID (v4) set as its _tag_ or unique identifier. The tag is unique to the notification, _not_ to a specific target. If you pass your own tag in the notify payload you can replace the notification by sending another notification with the same tag. You can provide a `tag` like so: @@ -183,7 +183,7 @@ Example of adding a tag to your notification. This won't create new notification ``` {% endraw %} -#### {% linkable_title Targets %} +#### Targets If you do not provide a `target` parameter in the notify payload a notification will be sent to all registered targets as listed in `html5_push_registrations.conf`. You can provide a `target` parameter like so: @@ -203,11 +203,11 @@ target: - unnamed device 2 ``` -#### {% linkable_title Overrides %} +#### Overrides You can pass any of the parameters listed [here](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#Parameters) in the `data` dictionary. Please note, Chrome specifies that the maximum size for an icon is 320px by 320px, the maximum `badge` size is 96px by 96px and the maximum icon size for an action button is 128px by 128px. -#### {% linkable_title URL %} +#### URL You can provide a URL to open when the notification is clicked by putting `url` in the data dictionary like so: @@ -220,7 +220,7 @@ data: If no URL or actions are provided, interacting with a notification will open your Home Assistant in the browser. You can use relative URLs to refer to Home Assistant, i.e. `/map` would turn into `https://192.168.1.2:8123/map`. -#### {% linkable_title TTL and Priority %} +#### TTL and Priority Newer Android versions introduced stronger battery optimization, so notifications by default are delivered only when phone is awake. Options TTL and priority tries to help users solve those problems. Default value of TTL is `86400s` and priority is `normal`. @@ -234,7 +234,7 @@ data: priority: high ``` -### {% linkable_title Dismiss %} +### Dismiss You can dismiss notifications by using service notify.html5_dismiss like so: @@ -250,7 +250,7 @@ You can dismiss notifications by using service notify.html5_dismiss like so: If no target is provided, it dismisses for all. If no tag is provided, it dismisses all notifications. -### {% linkable_title Automating notification events %} +### Automating notification events During the lifespan of a single push notification, Home Assistant will emit a few different events to the event bus which you can use to write automations against. @@ -266,7 +266,7 @@ Common event payload parameters are: You can use the `target` parameter to write automations against a single `target`. For more granularity, use `action` and `target` together to write automations which will do specific things based on what target clicked an action. -#### {% linkable_title received event %} +#### received event You will receive an event named `html5_notification.received` when the notification is received on the device. @@ -278,7 +278,7 @@ notification is received on the device. event_type: html5_notification.received ``` -#### {% linkable_title clicked event %} +#### clicked event You will receive an event named `html5_notification.clicked` when the notification or a notification action button is clicked. The action button clicked is available as `action` in the `event_data`. @@ -300,7 +300,7 @@ or action: open_door ``` -#### {% linkable_title closed event %} +#### closed event You will receive an event named `html5_notification.closed` when the notification is closed. @@ -311,7 +311,7 @@ You will receive an event named `html5_notification.closed` when the notificatio event_type: html5_notification.closed ``` -### {% linkable_title Making notifications work with NGINX proxy %} +### Making notifications work with NGINX proxy If you use [NGINX](/ecosystem/nginx/) as a proxy with authentication in front of your Home Assistant instance, you may have trouble with receiving events back to Home Assistant. It's because of authentication token that cannot be passed through the proxy. @@ -336,7 +336,7 @@ If you still have the problem, even with mentioned rule, try to add this code: proxy_pass_header Authorization; ``` -#### {% linkable_title Verify your domain %} +#### Verify your domain If you need to verify domain ownership with Google Webmaster Central/Search Console while configuring this component, follow these steps: diff --git a/source/_components/http.markdown b/source/_components/http.markdown index eeb7c4952b9a..904de87d5db4 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -128,13 +128,13 @@ The [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-us Or use a self signed certificate following the instructions here [Self-signed certificate for SSL/TLS](/docs/ecosystem/certificates/tls_self_signed_certificate/). -## {% linkable_title APIs %} +## APIs On top of the `http` integration is a [REST API](/developers/rest_api/), [Python API](/developers/python_api/) and [WebSocket API](/developers/websocket_api/) available. There is also support for [Server-sent events](/developers/server_sent_events/). The `http` platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) sends and receives messages over HTTP. -## {% linkable_title HTTP sensors %} +## HTTP sensors To use those kind of [sensors](#sensor) or [binary sensors](#binary-sensor) in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived. @@ -142,7 +142,7 @@ Create a [Long-Lived Access Tokens](https://developers.home-assistant.io/docs/en All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent to the endpoint of the device and must be **POST**. -## {% linkable_title IP filtering and banning %} +## IP filtering and banning If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `true` and the maximum number of attempts. After the first ban, an `ip_bans.yaml` file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added: @@ -157,7 +157,7 @@ After a ban is added a Persistent Notification is populated to the Home Assistan Please note, that sources from `trusted_networks` won't be banned automatically.

-## {% linkable_title Hosting files %} +## Hosting files If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elsewhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`. @@ -165,7 +165,7 @@ If you want to use Home Assistant to host or serve static files then create a di If you've had to create the `www/` folder for the first time, you'll need to restart Home Assistant.

-## {% linkable_title Binary Sensor %} +## Binary Sensor The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. @@ -213,11 +213,11 @@ $ curl -X GET -H "Authorization: Bearer LONG_LIVED_ACCESS_TOKEN" \ } ``` -### {% linkable_title Examples %} +### Examples In this section you'll find some real-life examples of how to use this sensor, besides `curl`, which was shown earlier. -#### {% linkable_title Using Python request module %} +#### Using Python request module As already shown on the [API](/developers/rest_api/) page, it's very simple to use Python and the [Requests](http://docs.python-requests.org/en/latest/) module for the interaction with Home Assistant. @@ -229,7 +229,7 @@ response = requests.post( print(response.text) ``` -#### {% linkable_title Using `httpie` %} +#### Using `httpie` [`httpie`](https://github.com/jkbrzt/httpie) is a user-friendly CLI HTTP client. @@ -239,7 +239,7 @@ $ http -v POST http://localhost:8123/api/states/binary_sensor.radio \ attributes:='{"friendly_name": "Radio"}' ``` -## {% linkable_title Sensor %} +## Sensor The HTTP sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. diff --git a/source/_components/htu21d.markdown b/source/_components/htu21d.markdown index a7ffd731ea33..11ad7267d315 100644 --- a/source/_components/htu21d.markdown +++ b/source/_components/htu21d.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file: @@ -45,7 +45,7 @@ i2c_bus: type: integer {% endconfiguration %} -## {% linkable_title Customizing the sensor data %} +## Customizing the sensor data Give the values friendly names and icons, add the following to your `customize:` section. @@ -72,7 +72,7 @@ group: - sensor.htu21d_sensor_humidity ``` -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -96,7 +96,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown index 9a1133cc6588..8df7f452a917 100644 --- a/source/_components/huawei_lte.markdown +++ b/source/_components/huawei_lte.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: All platform requires you to have set up the [Huawei LTE component](#configuration). -## {% linkable_title Configuration %} +## Configuration To enable the component, add the following lines to your `configuration.yaml` file: @@ -59,7 +59,7 @@ password: type: string {% endconfiguration %} -### {% linkable_title Tested routers %} +### Tested routers Routers we know to be working with this integration based on the documentation of used libraries and reports by users: @@ -70,7 +70,7 @@ Routers we know to be working with this integration based on the documentation o This is not a complete list. The integration can probably connect to other Huawei LTE routers running similar firmware. -## {% linkable_title Presence Detection %} +## Presence Detection This platform offers presence detection by looking at connected devices to a [Huawei LTE router](https://consumer.huawei.com/en/smart-home/). @@ -84,7 +84,7 @@ device_tracker: See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. -## {% linkable_title Notifications %} +## Notifications The `huawei_lte` platform allows you to use a Huawei LTE router for notifications from Home Assistant. The messages will be sent as SMS text messages. @@ -113,7 +113,7 @@ url: To use notifications, please see the [getting started with automation page](/getting-started/automation/). -## {% linkable_title Sensor %} +## Sensor The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers. diff --git a/source/_components/huawei_router.markdown b/source/_components/huawei_router.markdown index eee20dcff204..36f5f8fa8b65 100644 --- a/source/_components/huawei_router.markdown +++ b/source/_components/huawei_router.markdown @@ -19,7 +19,7 @@ The `huawei` device tracker platform offers presence detection by looking at con Currently, this was only tested with the Huawei HG8247H and HG8247Q Smart Router (used by Vodafone Portugal). -## {% linkable_title Configuration %} +## Configuration To use a Huawei router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 8fbb22e7cd7d..6c3c272fd8ee 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -60,7 +60,7 @@ allow_hue_groups: type: boolean {% endconfiguration %} -## {% linkable_title Examples %} +## Examples ```yaml # Example configuration.yaml entry specifying optional parameters @@ -71,7 +71,7 @@ hue: allow_hue_groups: true ``` -### {% linkable_title Multiple Hue bridges %} +### Multiple Hue bridges Multiple Hue bridges work transparently with discovery, you don't have to do anything. If you prefer to configure them manually and use multiple Hue bridges then it's needed that you provide a configuration file for every bridge. The bridges can't share a single configuration file. @@ -87,7 +87,7 @@ hue: filename: phue2.conf ``` -### {% linkable_title Using Hue Groups in Home Assistant %} +### Using Hue Groups in Home Assistant The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be useful to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaneously. @@ -119,7 +119,7 @@ Home Assistant will automatically detect your new `LightGroup` and add it to the More information can be found on the [Philips Hue API documentation](https://www.developers.meethue.com/documentation/groups-api#22_create_group) website. -### {% linkable_title Using Hue Scenes in Home Assistant %} +### Using Hue Scenes in Home Assistant The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them, many that you've never used, almost all very poorly named. @@ -145,7 +145,7 @@ script: *Note*: `group_name` is not linked to Home Assistant group name. -### {% linkable_title Finding Group and Scene Names %} +### Finding Group and Scene Names How do you find these names? @@ -153,7 +153,7 @@ The easiest way to do this is only use the scenes from the 2nd generation Hue ap Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together but it's sufficient to get values that you can test in the `dev-service` console. -### {% linkable_title Caveats %} +### Caveats The Hue API doesn't activate scenes directly, only on a Hue Group (typically rooms, especially if using the 2nd gen app). But Hue Scenes don't actually reference their group. So heuristic matching is used. diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index 3ec24f8dc7e1..f44eebb6cf8a 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To enable it, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ scan_interval: To get your API access token log into your [Hydrawise account](https://app.hydrawise.com/config/account) and in the 'My Account Details' section under Account Settings click 'Generate API Key'. Enter that key in your configuration file as the `API_KEY`. -## {% linkable_title Binary Sensor %} +## Binary Sensor Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: @@ -78,7 +78,7 @@ monitored_conditions: description: This will indicate `on` when there is a connection to the Hydrawise cloud. It is not an indication of whether the irrigation controller hardware is online. {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: @@ -101,7 +101,7 @@ monitored_conditions: description: The day and time when the next scheduled automatic watering cycle will start. If the zone is suspended then the value will be `NS` to indicate Not Scheduled. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: @@ -129,7 +129,7 @@ monitored_conditions: description: Enables the manual watering control for this zone. {% endconfiguration %} -### {% linkable_title Switch Operation %} +### Switch Operation When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year. diff --git a/source/_components/hyperion.markdown b/source/_components/hyperion.markdown index a5142049d84b..779b3c33b6af 100644 --- a/source/_components/hyperion.markdown +++ b/source/_components/hyperion.markdown @@ -18,7 +18,7 @@ redirect_from: The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms. -## {% linkable_title Configuration %} +## Configuration To use your Hyperion light in your installation, add the following to your `configuration.yaml` file: @@ -65,7 +65,7 @@ light: default: "['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']" {% endconfiguration %} -## {% linkable_title Examples %} +## Examples To start Hyperion with an effect, use the following automation: diff --git a/source/_components/ialarm.markdown b/source/_components/ialarm.markdown index 446f65cadcc5..54b95ab3755e 100644 --- a/source/_components/ialarm.markdown +++ b/source/_components/ialarm.markdown @@ -19,7 +19,7 @@ The `ialarm` platform provides connectivity with the [Antifurto365](https://www. This platform supports the following services: `alarm_arm_away`, `alarm_arm_home` and `alarm_disarm`. -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/idteck_prox.markdown b/source/_components/idteck_prox.markdown index cbd04ba75b04..b9200304c43d 100644 --- a/source/_components/idteck_prox.markdown +++ b/source/_components/idteck_prox.markdown @@ -18,7 +18,7 @@ ha_iot_class: Local Push An `idteck_prox_keycard` event is fired whenever a card or key sequence has been entered. The event contains 'card' - the card/key sequence, and the 'name' of the card reader. Checking 'card' against known card numbers can be used as the basis of an entry control system, or as part of a check-in/check-out system. -## {% linkable_title Configuration %} +## Configuration ``` yaml # Example configuration.yaml entry diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index f020b557c2eb..50c837c1ea8a 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -17,15 +17,15 @@ ha_release: 0.80 [IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel). -## {% linkable_title Sending events from IFTTT to Home Assistant %} +## Sending events from IFTTT to Home Assistant To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). -### {% linkable_title Setting up the integration %} +### Setting up the integration To set it up, go to the integrations page in the configuration screen and find IFTTT. Click on configure. Follow the instructions on the screen to configure IFTTT. -### {% linkable_title Using the incoming data %} +### Using the incoming data Events coming in from IFTTT will be available as events in Home Assistant and are fired as `ifttt_webhook_received`. The data specified in IFTTT will be available as the event data. You can use this event to trigger automations. @@ -50,7 +50,7 @@ automation: entity_id: '{% raw %}{{ trigger.event.data.entity_id }}{% endraw %}' ``` -## {% linkable_title Sending events to IFTTT %} +## Sending events to IFTTT ```yaml # Example configuration.yaml entry @@ -72,7 +72,7 @@ Once you have added your key to your `configuration.yaml` file, restart your Hom After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow.

-### {% linkable_title Multiple IFTTT keys %} +### Multiple IFTTT keys If you have multiple IFTTT users you can specify multiple IFTTT keys with: @@ -85,7 +85,7 @@ ifttt: ``` -### {% linkable_title Testing your trigger %} +### Testing your trigger You can use the **Developer tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant frontend, open the sidebar, click on the first icon in the developer tools. This should get you to the **Call Service** screen. Fill in the following values: @@ -111,7 +111,7 @@ Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_ The `target` field can contain a single key name or a list of key names. -### {% linkable_title Setting up a recipe %} +### Setting up a recipe Press the *New applet* button and search for *Webhooks*. @@ -168,7 +168,7 @@ ifttt_notify: ``` {% endraw %} -### {% linkable_title Additional Channel Examples %} +### Additional Channel Examples Additional examples of using IFTTT channels can be found below. diff --git a/source/_components/ign_sismologia.markdown b/source/_components/ign_sismologia.markdown index dab953366342..374998754348 100644 --- a/source/_components/ign_sismologia.markdown +++ b/source/_components/ign_sismologia.markdown @@ -32,7 +32,7 @@ of each entity. The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To integrate the IGN Sismología feed, add the following lines to your `configuration.yaml`. @@ -66,7 +66,7 @@ longitude: {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -84,7 +84,7 @@ the standard ones: | image_url | URL to a map supplied in the feed marking the location of the event. This could for example be used in notifications. | -## {% linkable_title Full Configuration %} +## Full Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown index 8ead80d665c7..70927c5deb21 100644 --- a/source/_components/ihc.markdown +++ b/source/_components/ihc.markdown @@ -69,13 +69,13 @@ info: type: boolean {% endconfiguration %} -## {% linkable_title Auto setup of IHC products %} +## Auto setup of IHC products If the auto setup is enabled, the `ihc` integration will automatically find IHC products and insert these as devices in Home Assistant. To disable this set auto_setup to false. See the individual device types for a list of IHC products to be recognized automatically. Components will get a default name that is a combination of the IHC group and IHC resource id. If you want to change the display names use the [Customizing entities](/docs/configuration/customizing-devices/). -## {% linkable_title Manual setup %} +## Manual setup Each device is associated with an IHC resource id. To manually setup integrations you specify resource ids from the IHC project. The IHC project is the file you edit/upload to the IHC Controller using LK IHC Visual - or similar program if your controller is not the LK brand. @@ -87,7 +87,7 @@ If you want an easier way to get the IHC resource ids, you can download the [Alt See the manual of each device type for configuration options. -## {% linkable_title Binary Sensor %} +## Binary Sensor Before you can use the IHC Binary Sensor platform, you must setup the IHC Component. @@ -101,7 +101,7 @@ When auto setup is enabled the following products will be found in the IHC proje - Dataline gas detector - Dataline light sensor -## {% linkable_title Manual configuration %} +## Manual configuration To manually configure IHC Binary Sensors insert the "binary_sensor" section in your IHC configuration: @@ -156,7 +156,7 @@ binary_sensor: The resource id should be an id of a boolean IHC resource. For more information about IHC resource ids see [Manual Setup](#manual-setup). -## {% linkable_title Sensor %} +## Sensor Before you can use the IHC Sensor platform, you must setup the IHC Component. @@ -214,7 +214,7 @@ sensor: The resource id should be a IHC float resource. For more information about IHC resource ids see [Manual Setup](#manual-setup). -## {% linkable_title Light %} +## Light Before you can use the IHC Light platform, you must setup the IHC Component. @@ -281,7 +281,7 @@ light: In the example above 12345 is ihc resource id and "tablelight" is the name. The IHC resource id can be a light level for dimmers or a boolean output of a relay. For more information about IHC resource ids see [Manual Setup](#manual-setup). -## {% linkable_title Switch %} +## Switch Before you can use the IHC Switch platform, you must setup the IHC Component. diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index 3311c7556045..9a0f64a30505 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -16,7 +16,7 @@ Image processing enables Home Assistant to process images from [cameras](/compon If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/components/http/).

-## {% linkable_title ALPR %} +## ALPR ALPR entities have a vehicle counter attribute `vehicles` and all found plates are stored in the `plates` attribute. @@ -37,7 +37,7 @@ automation: The following event attributes will be present (platform-dependent): `entity_id`, `plate`, `confidence` -## {% linkable_title Face %} +## Face Face entities have a face counter attribute `total_faces` and all face data is stored in the `faces` attribute. @@ -58,7 +58,7 @@ automation: The following event attributes will be present (platform-dependent): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses` -## {% linkable_title scan_interval and Optimising Resources %} +## scan_interval and Optimising Resources Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. diff --git a/source/_components/imap.markdown b/source/_components/imap.markdown index e7aa43b15ba0..d32547a4f51f 100644 --- a/source/_components/imap.markdown +++ b/source/_components/imap.markdown @@ -18,7 +18,7 @@ redirect_from: The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -65,7 +65,7 @@ search: type: string {% endconfiguration %} -### {% linkable_title Configuring IMAP Searches %} +### Configuring IMAP Searches By default, this integration will count unread emails. By configuring the search string, you can count other results, for example: @@ -73,7 +73,7 @@ By default, this integration will count unread emails. By configuring the search * `FROM`, `TO`, `SUBJECT` to find emails in a folder (see [IMAP RFC for all standard options](https://tools.ietf.org/html/rfc3501#section-6.4.4)) * [Gmail's IMAP extensions](https://developers.google.com/gmail/imap/imap-extensions) allow raw Gmail searches, like `X-GM-RAW "in: inbox older_than:7d"` to show emails older than one week in your inbox. Note that raw Gmail searches will ignore your folder configuration and search all emails in your account! -#### {% linkable_title Full configuration sample with search %} +#### Full configuration sample with search ```yaml # Example configuration.yaml entry diff --git a/source/_components/imap_email_content.markdown b/source/_components/imap_email_content.markdown index 8e2888bfe32e..6e7e198c0ade 100644 --- a/source/_components/imap_email_content.markdown +++ b/source/_components/imap_email_content.markdown @@ -18,7 +18,7 @@ redirect_from: The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -81,7 +81,7 @@ value_template: description: The date and time the email was sent. {% endconfiguration %} -## {% linkable_title Example %} +## Example The following example shows the usage of the IMAP email content sensor to scan the subject of an email for text, in this case, an email from the APC SmartConnect service which tells whether the UPS is running on battery or not. diff --git a/source/_components/incomfort.markdown b/source/_components/incomfort.markdown index a9dc603b53e9..41b9fd4bcbc0 100644 --- a/source/_components/incomfort.markdown +++ b/source/_components/incomfort.markdown @@ -48,7 +48,7 @@ To send an alert if the CV pressure is too low or too high, consider the followi Other properties are available via each device's attributes. -### {% linkable_title Configuration %} +### Configuration To add your Lan2RF gateway into your Home Assistant installation, add one of the following to your `configuration.yaml` file. diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 9aa71bbb39ef..0b12fbee44bd 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: The `influxdb` database integration runs parallel to the Home Assistant database. It does not replace it.

-## {% linkable_title Configuration %} +## Configuration The default InfluxDB configuration doesn't enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven't made any configuration changes, add the following to your `configuration.yaml` file: @@ -150,9 +150,9 @@ component_config_glob: required: false {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration ```yaml influxdb: @@ -180,7 +180,7 @@ influxdb: source: hass ``` -## {% linkable_title Sensor %} +## Sensor The `influxdb` sensor allows you to use values from an [InfluxDB](https://influxdb.com/) database to populate a sensor state. This can be use to present statistic about home_assistant sensors if used with the `influxdb` history component. It can also be used with an external data source. @@ -267,9 +267,9 @@ queries: default: value {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example configuration entry below create two request to your local InfluxDB instance, one to the database `db1`, the other to `db2`: diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 0273a07bbb46..74d7d45bd902 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -48,11 +48,11 @@ input_boolean: type: icon {% endconfiguration %} -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -## {% linkable_title Automation Examples %} +## Automation Examples Here's an example of an automation using the above `input_boolean`. This action will only occur if the switch is on. diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 32144ead5ecb..08fca8244343 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -66,7 +66,7 @@ input_datetime: default: 1970-01-01 00:00 | 1970-01-01 | 00:00 {% endconfiguration %} -### {% linkable_title Attributes %} +### Attributes A datetime input entity's state exports several attributes that can be useful in automations and templates. @@ -79,13 +79,13 @@ automations and templates. | `hour`
`minute`
`second` | The hour, minute and second of the time.
(only available if `has_time: true`) | `timestamp` | A timestamp representing the time held in the input.
If `has_date: true`, this is the UNIX timestamp of the date / time held by the input. Otherwise if only `has_time: true`, this is the number of seconds since midnight representing the time held by the input. -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -### {% linkable_title Services %} +### Services This integration provides a service to modify the state of the `input_datetime`. @@ -94,7 +94,7 @@ This integration provides a service to modify the state of the `input_datetime`. | `set_datetime` | `time` | This can be used to dynamically set the time. | `set_datetime` | `date` | This can be used to dynamically set the date. -## {% linkable_title Automation Examples %} +## Automation Examples The following example shows the usage of the `input_datetime` as a trigger in an automation (note that you will need a diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 2a64b74fbc8e..8c8440d6674d 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -84,11 +84,11 @@ input_number: type: icon {% endconfiguration %} -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -## {% linkable_title Automation Examples %} +## Automation Examples Here's an example of `input_number` being used as a trigger in an automation. diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index e5218340884f..9dede4b40d9a 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -64,11 +64,11 @@ input_select: Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, any variations of 'On', 'Yes', 'Y', 'Off', 'No', or 'N' (regardless of case) used as option names will be replaced by True and False unless they are defined in quotation marks.

-### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -### {% linkable_title Services %} +### Services This integrations provide three services to modify the state of the `input_select`. @@ -79,7 +79,7 @@ This integrations provide three services to modify the state of the `input_selec | `select_previous` | | Select the previous option. | `select_next` | | Select the next option. -### {% linkable_title Scenes %} +### Scenes To specify a target option in a [Scene](/components/scene/) you have to specify the target as `option` attribute: @@ -92,7 +92,7 @@ scene: option: Paulus ``` -## {% linkable_title Automation Examples %} +## Automation Examples The following example shows the usage of the `input_select.select_option` service in an automation: diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 1ec62c4528db..5fa1dddb288c 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -71,7 +71,7 @@ input_text: default: text {% endconfiguration %} -### {% linkable_title Services %} +### Services This integrations provide three services to modify the state of the `input_text`. @@ -79,11 +79,11 @@ This integrations provide three services to modify the state of the `input_text` | ------- | ---- | ----------- | | `set_value` | `value`
`entity_id(s)` | Set the value for specific `input_text` entities. -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -## {% linkable_title Automation Examples %} +## Automation Examples Here's an example using `input_text` in an action in an automation. diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown index 2d6c7df3676c..fb95eff7d122 100644 --- a/source/_components/insteon.markdown +++ b/source/_components/insteon.markdown @@ -47,7 +47,7 @@ Device support is provided by the underlying [insteonplm] package. It is known t [2245]: https://www.insteon.com/insteon-hub/ [2242]: https://www.insteon.com/support-knowledgebase/2014/9/26/insteon-hub-owners-manual -### {% linkable_title INSTEON Modem configuration %} +### INSTEON Modem configuration To set up an INSTEON Powerline Modem (PLM) device such as the [2413U], use the following configuration: @@ -186,13 +186,13 @@ x10_all_lights_off: type: string {% endconfiguration %} -### {% linkable_title Autodiscovery %} +### Autodiscovery The first time autodiscovery runs, the duration may require up to 20 seconds per device. Subsequent startups will occur much quicker using cached device information. If a device is not recognized during autodiscovery, you can add the device to the **device_override** configuration. In order for a device to be discovered, it must be linked to the INSTEON Modem as either a responder or a controller. -### {% linkable_title Linking Devices to the INSTEON Modem %} +### Linking Devices to the INSTEON Modem In order for any two Insteon devices to talk with one another, they must be linked. For an overview of device linking, please read the Insteon page on [understanding linking]. The Insteon Modem module supports All-Linking through [Development Tools] service calls. The following services are available: @@ -210,7 +210,7 @@ If you are looking for more advanced options, you can use the [insteonplm_intera [Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal [insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface -### {% linkable_title Customization %} +### Customization The only configuration item that is necessary is the PLM port or Hub IP address, username and password so that Home Assistant can connect to the INSTEON Modem. This will expose all the supported INSTEON devices which exist in the modem’s ALL-Link database. However, devices will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, they’ll be added and removed from Home Assistant automatically. @@ -218,7 +218,7 @@ You can use the normal Home Assistant [device customization] section of your con [device customization]: /getting-started/customizing-devices/ -### {% linkable_title Device Overrides %} +### Device Overrides INSTEON devices are added to Home Assistant using the platform(s) that make the most sense given the model and features of the hardware. The features of the INSTEON devices are built into the Home Assistant platform. Changing the platform is not recommended. @@ -227,7 +227,7 @@ There are two primary uses for the **device_override** feature: - Devices that do not respond during autodiscovery. This is common for battery operated devices. - Devices that have not been fully developed. This allows an unknown device to be mapped to a device that operates similarly to another device. -### {% linkable_title Example Configuration with Options%} +### Example Configuration with Options ```yaml # Full example of Insteon configuration with customizations and overrides @@ -248,7 +248,7 @@ insteon: subcat: 0x11 ``` -### {% linkable_title What NOT to do %} +### What NOT to do Insteon Modem is a top-level integration and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration will NOT work: @@ -258,7 +258,7 @@ light: address: 1a2b3c ``` -### {% linkable_title Events and Mini-Remotes %} +### Events and Mini-Remotes Mini-Remote devices do not appear as Home Assistant entities, they generate events. The following events are available: @@ -303,7 +303,7 @@ automation: entity_id: light.some_light ``` -### {% linkable_title Known Issues with the INSTEON Hub %} +### Known Issues with the INSTEON Hub The INSTEON Hub has three known issues that are inherent to the design of the Hub: diff --git a/source/_components/integration.markdown b/source/_components/integration.markdown index 892421583fae..4ac9c85a8dbf 100644 --- a/source/_components/integration.markdown +++ b/source/_components/integration.markdown @@ -20,7 +20,7 @@ redirect_from: The `integration` platform provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum) of the values provided by a source sensor. The Riemann sum is an approximation of an **integral** by a finite sum. The integration sensors is updated upon changes of the the **source**. Fast sampling source sensors provide better results. In this implementation, the default is the Trapezoidal method, but Left and Right methods can optionally be used. -## {% linkable_title Configuration %} +## Configuration To enable Integration Sensor in your installation, add the following to your `configuration.yaml` file: @@ -68,7 +68,7 @@ method: If 'unit' is set then 'unit_prefix' and 'unit_time' are ignored. -## {% linkable_title Energy %} +## Energy An `integration` sensor is quite useful in energy billing scenarios since energy is generally billed in kWh and many sensors provide power in W (Watts). diff --git a/source/_components/iota.markdown b/source/_components/iota.markdown index 17e1ac972f56..c93a7eb75ff1 100644 --- a/source/_components/iota.markdown +++ b/source/_components/iota.markdown @@ -65,7 +65,7 @@ iota: seed: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` -## {% linkable_title Sensor %} +## Sensor The sensors are automatically created if the IOTA integration is present. diff --git a/source/_components/iperf3.markdown b/source/_components/iperf3.markdown index 44b6aa3b0141..26a4af07ff6d 100644 --- a/source/_components/iperf3.markdown +++ b/source/_components/iperf3.markdown @@ -21,11 +21,11 @@ The `iperf3` sensor integration allows you to measure network bandwidth performa Enabling this integration will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run. -## {% linkable_title Setup %} +## Setup This integration requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions. -## {% linkable_title Configuration %} +## Configuration To add the `iperf3` sensor to your installation, add the following to your `configuration.yaml` file: @@ -92,7 +92,7 @@ Configuration variables (host): type: string {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -112,7 +112,7 @@ Parallel streams can help in some situations. As TCP attempts to be fair and con You can use the service `sensor.iperf3_update` to trigger a manual speed test for all sensors. Iperf3 has its own service call that allow to perform a speed test on a particular entity. -### {% linkable_title Service %} +### Service Once loaded, the `iperf3` integration will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode. @@ -125,6 +125,6 @@ Example Service data: {"host": "192.168.0.121"} ``` -## {% linkable_title Notes %} +## Notes - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. diff --git a/source/_components/ipma.markdown b/source/_components/ipma.markdown index dfb2a64f7055..2c9c3a65c79a 100644 --- a/source/_components/ipma.markdown +++ b/source/_components/ipma.markdown @@ -18,7 +18,7 @@ redirect_from: The `ipma` weather platform uses the [Instituto Português do Mar e Atmosfera](http://www.ipma.pt) as a source for current and forecast meteorological data. -## {% linkable_title Configuration %} +## Configuration To add the IPMA weather platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/iqvia.markdown b/source/_components/iqvia.markdown index 12969ba0c898..3480b70eeddd 100644 --- a/source/_components/iqvia.markdown +++ b/source/_components/iqvia.markdown @@ -26,7 +26,7 @@ Data measured includes: * Current outlook * more! -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To integrate `iqvia` into Home Assistant, add the following section to your `configuration.yaml` file (adjusting the `monitored_conditions` list to your @@ -79,7 +79,7 @@ It is important to ensure the ZIP code is quoted if it starts with a 0. Unquoted ZIP codes that start with 0 will cause errors.

-## {% linkable_title Understanding the Indices %} +## Understanding the Indices Any index-related sensor will have a value between 0.0 and 12.0. The values map to the following human-friendly ratings: @@ -92,7 +92,7 @@ Range | Rating 7.3 - 9.6 | Medium/High 9.7 - 12.0 | High -## {% linkable_title Understanding Asthma Allergens %} +## Understanding Asthma Allergens Several asthma-related sensors carry information regarding the top three "asthma allergens" (i.e., irritants that may exacerbate asthma symptoms). diff --git a/source/_components/islamic_prayer_times.markdown b/source/_components/islamic_prayer_times.markdown index c66dde38efc1..3b4f377372d2 100644 --- a/source/_components/islamic_prayer_times.markdown +++ b/source/_components/islamic_prayer_times.markdown @@ -24,7 +24,7 @@ This platform calculates prayer times using the following calculation methods: - Muslim World League - Umm Al-Qura University in Makkah -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/iss.markdown b/source/_components/iss.markdown index d5b9854355f4..f3bc3d1133b7 100644 --- a/source/_components/iss.markdown +++ b/source/_components/iss.markdown @@ -24,7 +24,7 @@ This means that ISS is 10° above the horizon of your home. You can check in the attributes of the sensor to see the timestamp for the next rise of the station, its current coordinates, and the number of people in space. -## {% linkable_title Configuration %} +## Configuration To add ISS binary sensor to your installation, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ If you set `show_on_map: true` then the location attributes are named `latitude` The default name of the location attributes is `lat` and `long` to avoid showing them on the map.

-### {% linkable_title Show position on map with camera platform %} +### Show position on map with camera platform The [generic camera platform](/components/camera.mjpeg/) offers the possibility to show the location of the ISS on OpenStreetMap. diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown index b6783c2b7735..2c054715ea53 100644 --- a/source/_components/isy994.markdown +++ b/source/_components/isy994.markdown @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -### {% linkable_title Basic Configuration %} +### Basic Configuration Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created. @@ -92,7 +92,7 @@ tls: Once the ISY controller is configured, it will automatically import any binary sensors, covers, fans, lights, locks, sensors and switches it can locate. -### {% linkable_title Sensors %} +### Sensors An Insteon door/window sensor will show up as a single Binary Sensor rather than two discrete devices like it does in the ISY994 admin panel. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel. @@ -100,7 +100,7 @@ Each Insteon leak sensor will also show up as a single Binary Sensor as opposed If your leak or door/window sensor supports heartbeats, a new binary_sensor device will be added to Home Assistant to represent the battery state. The sensor will stay "Off" so long as the daily heartbeats occur. If a heartbeat is missed, the sensor will flip to "On". The name of this device will be based on the heartbeat node in the ISY. -### {% linkable_title Handling Insteon Control Events %} +### Handling Insteon Control Events A Home Assistant `isy994_control` event is emitted for every "control" event in the Insteon network. This allows you to write automations that trigger based on Insteon button presses. You can also trigger off of the unique Insteon events, such as double-presses, long-holds etc. @@ -130,11 +130,11 @@ All `isy994_control` events will have an `entity_id` and `control` parameter in - `BRT`: "Brighten", from controllers that issue a single command to slightly brighten a light. - `DIM`: "Dim", from controllers that issue a single command to slightly dim a light. -### {% linkable_title Insteon Scenes %} +### Insteon Scenes All Insteon scenes configured in the ISY994 will show up as switches in Home Assistant. -### {% linkable_title Creating Custom Devices %} +### Creating Custom Devices Using the Programs tab in the controller's Administrative Console, custom devices can be created that will appear natively inside of Home Assistant. Home Assistant will scan the following folders and build the device to the associated domains: diff --git a/source/_components/itunes.markdown b/source/_components/itunes.markdown index 5a1c5fddbeb8..f1b88555eb51 100644 --- a/source/_components/itunes.markdown +++ b/source/_components/itunes.markdown @@ -21,7 +21,7 @@ The `itunes` media player platform allows you to control [iTunes](http://apple.c In addition to controlling iTunes, your available AirPlay endpoints will be added as media players as well. You can then individually address them and turn them on, turn them off or adjust their volume. -## {% linkable_title Configuration %} +## Configuration To add iTunes to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/jewish_calendar.markdown b/source/_components/jewish_calendar.markdown index ae53869a0102..ddd9e221aeb3 100644 --- a/source/_components/jewish_calendar.markdown +++ b/source/_components/jewish_calendar.markdown @@ -17,7 +17,7 @@ redirect_from: The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors. -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: @@ -94,7 +94,7 @@ sensors: {% endconfiguration %} -### {% linkable_title Holyness levels %} +### Holyness levels 1. Mido'rayta - by Torah ordination (Rosh Hashana, Yom Kippur, Pesach, Shavuot, Sukkot) 2. Erev Yom Tov @@ -106,7 +106,7 @@ sensors: 8. Memorial days: yom hazikaron and yom hashoah 9. Days mentioned by the Israeli parliament: Rabin memorial day, Ze'ev Zhabotinsky day, etc. -## {% linkable_title Full configuration sample %} +## Full configuration sample ```yaml # Example configuration.yaml entry diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index b2dd405fcdbf..edfcb9e3559f 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -18,7 +18,7 @@ redirect_from: The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account. -## {% linkable_title Configuration %} +## Configuration To enable the platform in your installation, add the following to your `configuration.yaml` file: @@ -35,11 +35,11 @@ access_token: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `juicenet` sensor platform allows you to get data from your [JuiceNet](https://emotorwerks.com/products/juicenet/) sensors. -### {% linkable_title Added sensors %} +### Added sensors These sensors will be added for each juicenet device in your account: diff --git a/source/_components/kankun.markdown b/source/_components/kankun.markdown index 57c9e938b082..f9d73200a9b7 100644 --- a/source/_components/kankun.markdown +++ b/source/_components/kankun.markdown @@ -21,7 +21,7 @@ script to provide an HTTP API. Details of the necessary modifications can be fou [here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version of the script as linked above). -## {% linkable_title Configuration %} +## Configuration To enable it, add the following lines to your `configuration.yaml`: diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index eaf70a627da2..740f3ee601bb 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -28,7 +28,7 @@ To load this component, add the following lines to your `configuration.yaml`: keyboard: ``` -## {% linkable_title Dependencies %} +## Dependencies You may need to install platform-specific [dependencies for PyUserInput](https://github.com/PyUserInput/PyUserInput#dependencies) in order to use the keyboard component. In most cases this can be done by running: @@ -36,7 +36,7 @@ You may need to install platform-specific [dependencies for PyUserInput](https:/ pip3 install [package name] ``` -### {% linkable_title Windows %} +### Windows x64 Windows users may have trouble installing pywin through pip. Using an [executable installer](http://sourceforge.net/projects/pywin32/files/pywin32/) should work around this issue. diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index 02fc97db18d4..c766cdf88c51 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -82,7 +82,7 @@ automation: `device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes. -## {% linkable_title Disconnections %} +## Disconnections This integration manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery. @@ -118,7 +118,7 @@ automation: media_content_type: music ``` -## {% linkable_title Permissions %} +## Permissions There might be permissions problems with the event input device file. If this is the case, the user that Home Assistant runs as must be allowed read and write permissions with: diff --git a/source/_components/kira.markdown b/source/_components/kira.markdown index b75a784cdec5..9f73d031bc24 100644 --- a/source/_components/kira.markdown +++ b/source/_components/kira.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: - Remote - Sensor -### {% linkable_title Example Configuration %} +### Example Configuration ```yaml # Example configuration.yaml entry @@ -34,7 +34,7 @@ kira: Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. Documentation for this can be found on the manufacturer's website [Here](https://www.keene.co.uk/pages/iranywhere/index.html). -### {% linkable_title Configuration Options %} +### Configuration Options ```yaml # Example configuration.yaml entry @@ -91,7 +91,7 @@ remotes: If no sensors or remotes are specified, a sensor with default values will be added. -### {% linkable_title Code Configuration %} +### Code Configuration The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory. @@ -137,7 +137,7 @@ repeat: Some manufacturers (e.g., Samsung) require an IR code to be sent a number of times in a row in rapid succession (usually 3). This doesn't apply to the vast majority of devices, but it can be helpful if needed. -### {% linkable_title Code Types %} +### Code Types When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used. diff --git a/source/_components/kiwi.markdown b/source/_components/kiwi.markdown index 701baab7a955..78edc656e6fe 100644 --- a/source/_components/kiwi.markdown +++ b/source/_components/kiwi.markdown @@ -19,7 +19,7 @@ redirect_from: The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices. All you need to get started is a KIWI account. Register at [the KIWI website](https://kiwi.ki/login/). -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index cf505449c263..0749dc101f99 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: - [Notify](/components/notify.knx) - [Scene](/components/scene.knx) -## {% linkable_title Configuration %} +## Configuration To use your KNX in your installation, add the following lines to your `configuration.yaml` file: @@ -119,7 +119,7 @@ state_updater: type: boolean {% endconfiguration %} -### {% linkable_title Services %} +### Services In order to directly interact with the KNX bus, you can now use the following service: @@ -138,7 +138,7 @@ payload: type: [integer, list] {% endconfiguration %} -### {% linkable_title Exposing sensor values or time to knx bus %} +### Exposing sensor values or time to knx bus KNX integration is able to expose time or sensor values to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address: @@ -167,6 +167,6 @@ address: type: string {% endconfiguration %} -### {% linkable_title Known issues %} +### Known issues Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5. diff --git a/source/_components/kodi.markdown b/source/_components/kodi.markdown index 827545a0e24f..552dac04e152 100644 --- a/source/_components/kodi.markdown +++ b/source/_components/kodi.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Media Player](#configuration) - [Notifications](#notifications) -## {% linkable_title Configuration %} +## Configuration In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file: @@ -90,9 +90,9 @@ timeout: default: 5 {% endconfiguration %} -### {% linkable_title Services %} +### Services -#### {% linkable_title Service `kodi_add_to_playlist` %} +#### Service `kodi_add_to_playlist` Add music to the default playlist (i.e. playlistid=0). @@ -104,14 +104,14 @@ Add music to the default playlist (i.e. playlistid=0). | `media_name` | no| Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. | | `artist_name` | no | Optional artist name for filtering media. | -#### {% linkable_title Service `media_player/kodi_set_shuffle` %} +#### Service `media_player/kodi_set_shuffle` | Service data attribute | Optional | Description | |------------------------|----------|-------------| | `entity_id` | yes | Target a specific media player. It must be of type kodi. | | `shuffle_on` | no | True/false for shuffle on/off. | -#### {% linkable_title Service `kodi_call_method` %} +#### Service `kodi_call_method` Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`. @@ -121,7 +121,7 @@ Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with opti | `method` | yes | Name of the Kodi JSONRPC API method to be called. | | any other parameter | no | Optional parameters for the Kodi API call. | -### {% linkable_title Event triggering %} +### Event triggering When calling the `kodi_call_method` service, if the Kodi JSONRPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`: @@ -132,7 +132,7 @@ input: result: ``` -### {% linkable_title Kodi turn on/off samples %} +### Kodi turn on/off samples With the `turn_on_action` and `turn_off_action` parameters you can run any combination of Home Assistant actions to turn on/off your Kodi instance. Here are a few examples of this usage, including the **migration instructions for the old `turn_off_action` list of options**. @@ -253,7 +253,7 @@ media_player: This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your kodi player. It'll also expose the endpoints standby, toggle and activate without authentication on your kodi player. Use this with caution.

-### {% linkable_title Kodi services samples %} +### Kodi services samples #### Simple script to turn on the PVR in some channel as a time function @@ -305,7 +305,7 @@ script: For a more complex usage of the `kodi_call_method` service, with event triggering of Kodi API results, you can have a look at this [example](/cookbook/automation_kodi_dynamic_input_select/) -## {% linkable_title Notifications %} +## Notifications The `kodi` notifications platform allows you to send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant. @@ -348,7 +348,7 @@ password: type: string {% endconfiguration %} -### {% linkable_title Script example %} +### Script example ```yaml kodi_notification: @@ -362,7 +362,7 @@ kodi_notification: icon: "warning" ``` -#### {% linkable_title Message variables %} +#### Message variables {% configuration %} title: diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index 931228013964..00d1b166dd33 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -35,7 +35,7 @@ This integration uses the [`discovery`](/components/discovery) component, which Konnected devices communicate with Home Assistant over your local LAN -- there is no cloud component! For best performance we recommend allowing unsecured HTTP API traffic between Konnected devices and Home Assistant on your LAN. This means that you should not use the `http` integration to serve SSL/TLS certificates. Instead, use a proxy like Nginx or Caddy to serve SSL/TLS. [Read more.](https://help.konnected.io/support/solutions/articles/32000023964-set-up-hass-io-with-secure-remote-access-using-duckdns-and-nginx-proxy)

-### {% linkable_title Configuration %} +### Configuration A `konnected` section must be present in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them: @@ -172,12 +172,12 @@ devices: {% endconfiguration%} -#### {% linkable_title Configuration Notes %} +#### Configuration Notes - Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition. - Pin `D8` or the `out` zone will only work when activation is set to high (the default). -### {% linkable_title Extended Configuration %} +### Extended Configuration ```yaml # Example configuration.yaml entry @@ -231,7 +231,7 @@ konnected: ``` -### {% linkable_title Unique IDs and the Entity Registry %} +### Unique IDs and the Entity Registry Beginning in Home Assistant release 0.90, unique IDs are generated for each sensor or switch entity. This enables end users to modify the entity names and entity IDs through the Home Assistant UI on the _Entity Registry_ page (under _Configuration_). @@ -247,7 +247,7 @@ Unique IDs are internally generated as follows: \* Switches are identified by a unique hash including the pin number, `momentary`, `pause`, and `repeat` values. If these values are modified, a new entity will be created and the old entity must be removed manually from the _Entity Registry_. -### {% linkable_title Pin Mapping %} +### Pin Mapping Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly used with the NodeMCU dev kit WiFi module and optionally Konnected's Alarm Panel hardware. The following table shows the pin mapping between the Konnected hardware labeled zones, the NodeMCU labeled pins and the ESP8266 GPIO pins. @@ -261,7 +261,7 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use | 6 | RX | 9 | GPIO3 | | ALARM or OUT | D8 | 8 | GPIO15 | -### {% linkable_title Revision History %} +### Revision History #### 0.91 @@ -295,12 +295,12 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use - Initial release -### {% linkable_title Binary Sensor %} +### Binary Sensor The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security). This integration supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component. -### {% linkable_title Switch %} +### Switch The `konnected` switch platform allows you to actuate an alarm system siren, strobe light, buzzer or any other wired device using a [Konnected Alarm Panel board](https://konnected.io) or relay module and a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security). \ No newline at end of file diff --git a/source/_components/lacrosse.markdown b/source/_components/lacrosse.markdown index 63a6885d3692..6d0d49549892 100644 --- a/source/_components/lacrosse.markdown +++ b/source/_components/lacrosse.markdown @@ -18,12 +18,12 @@ redirect_from: The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip). -## {% linkable_title Tested Devices %} +## Tested Devices - Technoline TX 29 IT (temperature only) - Technoline TX 29 DTH-IT (including humidity) -## {% linkable_title Setup %} +## Setup Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are available by using the command-line tool `pylacrosse` from the pylacrosse package. @@ -31,7 +31,7 @@ Since the sensor change their ID after each powercycle/battery change you can ch sudo pylacrosse -d /dev/ttyUSB0 scan ``` -## {% linkable_title Configuration %} +## Configuration To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file: @@ -95,7 +95,7 @@ sensor: type: integer {% endconfiguration %} -## {% linkable_title Examples %} +## Examples To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file: diff --git a/source/_components/lametric.markdown b/source/_components/lametric.markdown index 02c1f46c7e94..80517890ea3e 100644 --- a/source/_components/lametric.markdown +++ b/source/_components/lametric.markdown @@ -31,7 +31,7 @@ lametric: client_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` -## {% linkable_title Setup Steps %} +## Setup Steps LaMetric needs an OAuth2 `client_id` and `client_secret` from the LaMetric developer portal to use it with Home Assistant. These are the steps to take: @@ -48,7 +48,7 @@ These are the steps to take: 5. Set up some notifications in Home Assistant by following the instructions on the [Lametric Notify](/components/notify.lametric) page. 6. Save all configuration files and restart Home Assistant. -## {% linkable_title Notifications %} +## Notifications The `lametric` notification platform allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first. @@ -90,9 +90,9 @@ priority: Check out the list of all icons at [https://developer.lametric.com/icons](https://developer.lametric.com/icons). Note that icons always begin with "i" while animations begin with "a". This is part of the name, you can't just use the number! -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration example %} +### Full configuration example ```yaml # Example configuration.yaml entry @@ -105,7 +105,7 @@ notify: priority: info ``` -### {% linkable_title Changing sounds and icons %} +### Changing sounds and icons To add a notification sound, icon, cycles, or priority override, it has to be done via service data. @@ -127,7 +127,7 @@ To add a notification sound, icon, cycles, or priority override, it has to be do priority: 'critical' ``` -### {% linkable_title Only notify specific device %} +### Only notify specific device If you have more than one La Metric device, you can specify which will receive the message by adding `target:` to the service data: diff --git a/source/_components/lannouncer.markdown b/source/_components/lannouncer.markdown index b67ff08ed1c3..cb1aed42f6ee 100644 --- a/source/_components/lannouncer.markdown +++ b/source/_components/lannouncer.markdown @@ -44,7 +44,7 @@ port: type: integer {% endconfiguration %} -### {% linkable_title Installation %} +### Installation You need to install the Lannouncer app and enable the *Network (TCP) Listener* and *Auto-Start Network Listener*. You can disable the *GCM (Google Cloud) and WAN Messaging* and *SMS Listener* since this integration doesn't use them. @@ -52,7 +52,7 @@ Lannouncer uses the default Android TTS voice. You can tweak that in the Android More information can be found [here](http://www.keybounce.com/lannouncer/configuring-lannouncer/). -### {% linkable_title Sending messages %} +### Sending messages Lannouncer supports two types of messages. diff --git a/source/_components/lastfm.markdown b/source/_components/lastfm.markdown index 10657b58fc53..f8f4a54e5865 100644 --- a/source/_components/lastfm.markdown +++ b/source/_components/lastfm.markdown @@ -18,11 +18,11 @@ redirect_from: The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](http://www.last.fm). -## {% linkable_title Setup %} +## Setup To get an API key you need to create an [API account](http://www.last.fm/api/account/create). -## {% linkable_title Configuration %} +## Configuration To use Last.fm sensor with your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/launch_library.markdown b/source/_components/launch_library.markdown index 9d1d8a38c489..1cd6706cb750 100644 --- a/source/_components/launch_library.markdown +++ b/source/_components/launch_library.markdown @@ -18,7 +18,7 @@ redirect_from: The `launch_library` sensor will provide you with information about the next planned space launch. -## {% linkable_title Configuration %} +## Configuration Add the data to your `configuration.yaml` file as shown in the example: diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index 865a7662d0d0..479ca0d3c4f8 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: They are ideal to be used in automation scripts or for the `template` platforms.

-## {% linkable_title Configuration %} +## Configuration To use your LCN system in your installation, add the following lines to your `configuration.yaml` file. You have to specify at least one ip/port with login credentials for a PCHK host. @@ -325,7 +325,7 @@ switches: type: string {% endconfiguration %} -## {% linkable_title LCN Addresses %} +## LCN Addresses LCN hardware devices connected to the LCN bus are called _modules_. LCN modules are addressed by their numeric id in the range (5..254). @@ -357,11 +357,11 @@ s0.g7 Leading zeroes in the segment id or module/group id can be omitted. If the `connection_id` is omitted, the first connection defined in the [configuration](#configuration) will be used. -## {% linkable_title LCN Constants %} +## LCN Constants The platforms and service calls use several predefined constants as parameters. -### {% linkable_title Ports %} +### Ports | Constant | Values | | -------- | ------ | @@ -381,7 +381,7 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | `motor3` | `relay5` | `relay6` | | `motor4` | `relay7` | `relay8` | -### {% linkable_title Variables and Units %} +### Variables and Units | Constant | Values | | -------- | ------ | @@ -393,7 +393,7 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | TIME_UNIT | `seconds`, `minutes`, `hours`, `days` | | RELVARREF | `current`, `prog` | -### {% linkable_title States %}: +### States: | Constant | Values | | -------- | ------ | @@ -401,14 +401,14 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | LOGICOP_STATE | `not`, `or`, `and` | | KEY_STATE | `hit`, `make`, `break`, `dontsend` | -### {% linkable_title Keys %}: +### Keys: Whenever a key has to be provided, it is defined by a joint string consisting of the table identifier (`a`, `b`, `c`, `d`) and the corresponding key number. Examples: `a1`, `a5`, `d8`. -## {% linkable_title Platforms %} +## Platforms -### {% linkable_title Binary Sensor %} +### Binary Sensor The `lcn` binary sensor platform allows the monitoring of the following [LCN](http://www.lcn.eu) binary data sources: @@ -418,7 +418,7 @@ The `lcn` binary sensor platform allows the monitoring of the following [LCN](ht The binary sensor can be used in automation scripts or in conjunction with `template` platforms. -### {% linkable_title Climate %} +### Climate The `lcn` climate platform allows the control of the [LCN](http://www.lcn.eu) climate regulators. This platform depends on the correct configuration of the module's regulators which has to be done in the LCN-PRO programming software. @@ -429,22 +429,22 @@ If the control is set lockable, the regulator can be turned on/off. If you intend to leave the regulation to home assistant, you should consider using the [Generic Thermostat](climate.generic_thermostat) in conjuction with [LCN Sensor](#sensor) and [LCN Switch](#switch).

-### {% linkable_title Cover %} +### Cover The `lcn` cover platform allows the control of [LCN](http://www.lcn.eu) relays which have been configured as motor controllers. -### {% linkable_title Light %} +### Light The `lcn` light platform allows the control of the following [LCN](http://www.lcn.eu) ports: - (Dimmable) output ports - Relays -### {% linkable_title Scene %} +### Scene The `lcn` scene platform allows the activation of previously programmed [LCN](http://www.lcn.eu) scenes. -### {% linkable_title Sensor %} +### Sensor The `lcn` sensor platform allows the monitoring of the following [LCN](http://www.lcn.eu) data sources: @@ -462,19 +462,19 @@ The sensor can be used in automation scripts or in conjunction with `template` p Otherwise the module might show unexpected behavior or return error messages.

-### {% linkable_title Switch %} +### Switch The `lcn` switch platform allows the control of the following [LCN](http://www.lcn.eu) ports: - Output ports - Relays -## {% linkable_title Services %} +## 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. -### {% linkable_title Service `output_abs` %} +### Service `output_abs` Set absolute brightness of output port in percent. @@ -496,7 +496,7 @@ data: transition: 0 ``` -### {% linkable_title Service `output_rel` %} +### Service `output_rel` Set relative brightness of output port in percent. @@ -517,7 +517,7 @@ data: brightness: 30 ``` -### {% linkable_title Service `output_toggle` %} +### Service `output_toggle` Toggle output port. @@ -537,7 +537,7 @@ data: transition: 0 ``` -### {% linkable_title 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). @@ -558,7 +558,7 @@ data: state: t---001- ``` -### {% linkable_title Service `led` %} +### Service `led` Set the led status. @@ -577,7 +577,7 @@ data: state: blink ``` -### {% linkable_title 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. @@ -606,7 +606,7 @@ data: Otherwise the module might show unexpected behaviors or return error messages.

-### {% linkable_title 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. @@ -635,7 +635,7 @@ data: Otherwise the module might show unexpected behavior or return error messages.

-### {% linkable_title Service `var_reset` %} +### Service `var_reset` Reset value of variable or setpoint. @@ -658,7 +658,7 @@ data: Otherwise the module might show unexpected behavior or return error messages.

-### {% linkable_title Service `lock_regulator` %} +### Service `lock_regulator` Locks a regulator setpoint. If `state` is not defined, it is assumed to be `False`. @@ -679,7 +679,7 @@ data: state: true ``` -### {% linkable_title 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` @@ -716,7 +716,7 @@ data: time_unit: s ``` -### {% linkable_title Service `lock_keys` %} +### Service `lock_keys` Locks keys. If table is not defined, it is assumend to be table `a`. @@ -753,7 +753,7 @@ data: time_unit: s ``` -### {% linkable_title Service `dyn_text` %} +### Service `dyn_text` Send dynamic text to LCN-GTxD displays. The displays support four rows for text messages. @@ -776,7 +776,7 @@ data: text: "text in row 1" ``` -### {% linkable_title Service `pck` %} +### Service `pck` Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the `pck` string. diff --git a/source/_components/lg_soundbar.markdown b/source/_components/lg_soundbar.markdown index 0bf1c27c2439..c3a027d5a01d 100644 --- a/source/_components/lg_soundbar.markdown +++ b/source/_components/lg_soundbar.markdown @@ -24,6 +24,6 @@ Supported devices: Compatible devices will be automatically added if the [`discovery`](/components/discovery/) integration is enabled. -### {% linkable_title Supported operations %} +### Supported operations - These devices support mute, volume control, source selection and mode selection. diff --git a/source/_components/life360.markdown b/source/_components/life360.markdown index 7037636417a8..a1cbf5778494 100644 --- a/source/_components/life360.markdown +++ b/source/_components/life360.markdown @@ -16,7 +16,7 @@ ha_iot_class: Cloud Polling The `life360` integration allows you to detect presence using the [unofficial API](#disclaimer) of [Life360](https://www.life360.com/). -## {% linkable_title Life360 Account %} +## Life360 Account You must first [create a Life360 account](https://www.life360.com/websignup). @@ -104,7 +104,7 @@ warning_threshold: type: integer {% endconfiguration %} -## {% linkable_title Additional attributes %} +## Additional attributes Attribute | Description -|- @@ -119,7 +119,7 @@ raw_speed | "Raw" speed value provided by Life360 server. (Units unknown.) speed | Estimated speed of device (in MPH or KPH depending on Home Assistant's unit system configuration.) wifi_on | Device WiFi is turned on (`true`/`false`.) -## {% linkable_title Filtering %} +## Filtering For most users, filtering is not needed, and in such cases, the corresponding configuration variables should not be used. @@ -133,11 +133,11 @@ For a particular Member to be tracked, they must be included (or at least not ex Note that Life360's app and website typically only show Members' first names. However, you must use their _full_ names here. If you're not sure what a Member's full name (i.e., first and last) is in Life360, ask them. Alternatively, you can set the [`logger`](https://www.home-assistant.io/components/logger/) to `debug` and look in `home-assistant.log`. The full names of all Life360 Circles & Members will be logged. -## {% linkable_title Home - Home Assistant vs. Life360 %} +## Home - Home Assistant vs. Life360 Normally Home Assistant device trackers are "Home" when they enter `zone.home`. Also, Life360 normally considers your device "Home" when it enters the Place that coincides with your home. Since the definitions of these areas can be different, this can lead to a disagreement between Home Assistant and Life360 as to whether or not you're "Home." To avoid this, make sure these two areas are defined the same -- i.e., same location and radius. (See next section.) -## {% linkable_title Home Assistant Zones & Life360 Places %} +## Home Assistant Zones & Life360 Places See [Zone documentation](https://www.home-assistant.io/components/zone/#home-zone) for details about how HA zones are defined. If you'd like to create HA zones from Life360 Places (e.g., to make HA's `zone.home` be identical to Life360's "Home Place"), make sure `logger` is set to `debug`. Then when HA starts the details of all the Places defined in the included Circles will be written to `home-assistant.log` in a format that can be copied into your configuration under `zone:`. E.g., you would see something like this: @@ -150,15 +150,15 @@ See [Zone documentation](https://www.home-assistant.io/components/zone/#home-zon radius: ZZZ ``` -## {% linkable_title Communication Errors %} +## Communication Errors It is not uncommon for communication errors to occur between Home Assistant and the Life360 server. This can happen for many reasons, including Internet connection issues, Life360 server load, etc. However, in most cases, they are temporary and do not significantly affect the ability to keep device_tracker entities up to date. Therefore, an optional filtering mechanism has been implemented to prevent inconsequential communication errors from filling the log, while still logging unusual error activity. Two thresholds are defined: [**warning_threshold**](#warning_threshold) and [**error_threshold**](#error_threshold). When a particular type of communication error happens on consecutive update cycles, it will not be logged until the number of occurrences reaches these thresholds. When the number reaches **warning_threshold** (but does not exceed **error_threshold**, and only if **warning_threshold** is defined), it will be logged as a WARNING. Once the number reaches **error_threshold**, it will be logged as an ERROR. Only two consecutive communication errors of a particular type will be logged as an ERROR, after which it will no longer be logged until it stops occurring and then happens again. -## {% linkable_title Examples %} +## Examples -### {% linkable_title Typical configuration %} +### Typical configuration {% raw %} ```yaml @@ -181,7 +181,7 @@ life360: ``` {% endraw %} -### {% linkable_title Circle and Member Filtering Example %} +### Circle and Member Filtering Example {% raw %} ```yaml @@ -195,7 +195,7 @@ life360: ``` {% endraw %} -### {% linkable_title Entering accounts in configuration %} +### Entering accounts in configuration {% raw %} ```yaml @@ -206,7 +206,7 @@ life360: ``` {% endraw %} -### {% linkable_title Example overdue update automations %} +### Example overdue update automations {% raw %} ```yaml @@ -241,6 +241,6 @@ automation: ``` {% endraw %} -## {% linkable_title Disclaimer %} +## Disclaimer It does not appear that Life360 officially supports its REST API for use with other than its own apps. This integration is based on reverse engineering that has been done by the open source community, and an API token that was somehow discovered by the same community. At any time Life360 could disable that token or otherwise change its REST API such that this integration would no longer work. diff --git a/source/_components/lifx.markdown b/source/_components/lifx.markdown index ce77866a3d64..7cab06739f83 100644 --- a/source/_components/lifx.markdown +++ b/source/_components/lifx.markdown @@ -21,13 +21,13 @@ _Please note, the `lifx` integration does not support Windows. The `lifx_legacy` You can configure the LIFX integration by going to the integrations page inside the config panel. -## {% linkable_title Set state %} +## Set state The LIFX bulbs allow a change of color and brightness even when they are turned off. This way you can control the light during the day so its settings are correct when events for turning on are received, for example from motion detectors or external buttons. The normal `light.turn_on` call cannot be used for this because it always turns the power on. Thus, LIFX has its own service call that allows color changes without affecting the current power state. -### {% linkable_title Service `light.lifx_set_state` %} +### Service `light.lifx_set_state` Change the light to a new state. @@ -40,7 +40,7 @@ Change the light to a new state. | `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is. | `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) to specify the new state. -## {% linkable_title Light effects %} +## Light effects The LIFX platform supports several light effects. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) service, for example like this: ```yaml @@ -72,7 +72,7 @@ script: The available light effects and their options are listed below. -### {% linkable_title Service `light.lifx_effect_pulse` %} +### Service `light.lifx_effect_pulse` Run a flash effect by changing to a color and then back. @@ -87,7 +87,7 @@ Run a flash effect by changing to a color and then back. | `mode` | The way to change between colors. Valid modes: `blink` (default - direct transition to new color for 'period' time with original color between cycles), `breathe` (color fade transition to new color and back to original), `ping` (short pulse of new color), `strobe` (light turns off between color changes), `solid`(light does not return to original color between cycles). | `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). -### {% linkable_title Service `light.lifx_effect_colorloop` %} +### Service `light.lifx_effect_colorloop` Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors. @@ -101,7 +101,7 @@ Run an effect with colors looping around the color wheel. All participating ligh | `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359). | `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). -### {% linkable_title Service `light.lifx_effect_stop` %} +### Service `light.lifx_effect_stop` Run an effect that does nothing, thereby stopping any other effect that might be running. @@ -110,7 +110,7 @@ Run an effect that does nothing, thereby stopping any other effect that might be | `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. -## {% linkable_title Advanced configuration %} +## Advanced configuration There are some manual configuration options available. These are only needed with unusual network setups where automatic configuration does not find your LIFX devices. diff --git a/source/_components/light.group.markdown b/source/_components/light.group.markdown index 1af62ea6f99a..574a556df2b7 100644 --- a/source/_components/light.group.markdown +++ b/source/_components/light.group.markdown @@ -49,7 +49,7 @@ Example of the light group "Kitchen Lights". The supported features of all lights will be added together. For example, if you have one RGB light in a group of otherwise brightness-only lights, the light group will be shown with a color picker. -## {% linkable_title Script Example %} +## Script Example Here's an example of a script using the above light group. diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 80149d6185d9..c47374bfb917 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -23,7 +23,7 @@ The `knx light` integration is used as an interface to control knx actuators for The `knx` integration must be configured correctly to use this component, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: @@ -99,7 +99,7 @@ For switching/light actuators that are only controlled by a single group address *Note on tunable white:* Home-Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home-Assistant may not align with ones of KNX visualizations. This is the expected behavior. -## {% linkable_title Extended configuration example %} +## Extended configuration example ```yaml light: diff --git a/source/_components/light.markdown b/source/_components/light.markdown index d2b5c8f9041e..caaa824f5c44 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -16,13 +16,13 @@ ha_release: pre 0.7 This integration allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it. -### {% linkable_title Default turn-on values %} +### Default turn-on values To set the default color and brightness values when the light is turned on, create a custom `light_profiles.csv` (as described below in the `profile` attribute of `light.turn_on`). The `.default` suffix should be added to the entity identifier of each light to define a default value, e.g., for `light.ceiling_2` the `id` field is `light.ceiling_2.default`. To define a default for all lights, the identifier `group.all_lights.default` can be used. Individual settings always supercede the `all_lights` default setting. -### {% linkable_title Service `light.turn_on` %} +### Service `light.turn_on` Turns one light on or multiple lights on using [groups]({{site_root}}/components/group/). @@ -80,7 +80,7 @@ automation: rgb_color: [255,0,0] ``` -### {% linkable_title Service `light.turn_off` %} +### Service `light.turn_off` Turns one or multiple lights off. @@ -89,7 +89,7 @@ Turns one or multiple lights off. | `entity_id` | yes | String or list of strings that point at `entity_id`s of lights. Else targets all. | `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. -### {% linkable_title Service `light.toggle` %} +### Service `light.toggle` Toggles the state of one or multiple lights using [groups]({{site_root}}/components/group/). Takes the same arguments as [`turn_on`](#service-lightturn_on) service. diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 084a8f13e7ef..35bbbdda8908 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -19,7 +19,7 @@ ha_release: 0.8 The `mqtt` light platform with lets you control your MQTT enabled lights through one of the supported message schemas. -## {% linkable_title Comparison of light MQTT schemas %} +## Comparison of light MQTT schemas | Function | [`default`](#default-schema) | [`json`](#json-schema) | [`template`](#template-schema) | |-------------------|------------------------------------------------------------|----------------------------------------------------------------------|------------------------------------------------------------------------------| @@ -34,11 +34,11 @@ The `mqtt` light platform with lets you control your MQTT enabled lights through | White Value | ✔ | ✔ | ✔ | -## {% linkable_title Default schema %} +## Default schema The `mqtt` light platform with default schema lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values. -## {% linkable_title Default schema - Configuration %} +## Default schema - Configuration In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. @@ -274,11 +274,11 @@ device: XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.

-## {% linkable_title Default schema - Examples %} +## Default schema - Examples In this section you will find some real-life examples of how to use this sensor. -### {% linkable_title Brightness and RGB support %} +### Brightness and RGB support To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: @@ -304,7 +304,7 @@ light: ``` {% endraw %} -### {% linkable_title Brightness and no RGB support %} +### Brightness and no RGB support To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file: @@ -323,7 +323,7 @@ light: optimistic: false ``` -### {% linkable_title Brightness without on commands %} +### Brightness without on commands To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case: @@ -340,13 +340,13 @@ light: on_command_type: 'brightness' ``` -## {% linkable_title Default schema - Implementations %} +## Default schema - Implementations - A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off). - Another [example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light) to control a RGB LED (on/off, brightness, and colors). - [Integration guide](https://github.com/xoseperez/espurna/wiki/HomeAssistant) for the ESPUrna firmware (ESP8285/ESP8266). -## {% linkable_title JSON schema %} +## JSON schema The `mqtt` light platform with JSON schema lets you control a MQTT-enabled light that can receive [JSON](https://en.wikipedia.org/wiki/JSON) messages. @@ -372,7 +372,7 @@ This schema supports on/off, brightness, RGB colors, XY colors, color temperatur } ``` -## {% linkable_title JSON schema - Configuration %} +## JSON schema - Configuration In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be off. @@ -536,11 +536,11 @@ device: RGB, XY and HSV can not be used at the same time in `state_topic` messages. Make sure that only one of the color models is in the "color" section of the state MQTT payload.

-## {% linkable_title JSON schema - Examples %} +## JSON schema - Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Brightness and RGB support %} +### Brightness and RGB support To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: @@ -556,7 +556,7 @@ light: rgb: true ``` -### {% linkable_title Brightness and no RGB support %} +### Brightness and no RGB support To enable a light with brightness (but no color support) in your installation, add the following to your `configuration.yaml` file: @@ -571,7 +571,7 @@ light: brightness: true ``` -### {% linkable_title Brightness Scaled %} +### Brightness Scaled To enable a light using a brightness scale other than 8bit the `brightness_scale` option may be added to denote the "fully on" value: ```yaml @@ -595,7 +595,7 @@ Home Assistant will then convert its 8bit value in the message to and from the d } ``` -### {% linkable_title HS Color %} +### HS Color To use a light with hue+saturation as the color model, set `hs` to `true` in the platform configuration: @@ -621,7 +621,7 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura } ``` -### {% linkable_title Brightness and RGBW support %} +### Brightness and RGBW support To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your `configuration.yaml` file: @@ -639,7 +639,7 @@ light: ``` -## {% linkable_title Implementations %} +## Implementations - A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing. @@ -653,14 +653,14 @@ light: - [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. -## {% linkable_title Template schema %} +## Template schema 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, effects and white values. -## {% linkable_title Template schema - Configuration %} +## Template schema - Configuration In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be off. @@ -806,11 +806,11 @@ device: Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.

-## {% linkable_title Template schema - Examples %} +## Template schema - Examples In this section you find some real-life examples of how to use this light. -### {% linkable_title Simple string payload %} +### 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: @@ -830,7 +830,7 @@ light: blue_template: "{% raw %}{{ value.split(',')[2].split('-')[2] }}{% endraw %}" ``` -### {% linkable_title JSON payload %} +### JSON payload For a JSON payload with the format `{"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}`, add the following to your `configuration.yaml` file: @@ -865,6 +865,6 @@ light: effect_template: '{% raw %}{{ value_json.effect }}{% endraw %}' ``` -### {% linkable_title Template schema - No brightness or color support %} +### Template schema - No brightness or color support If you don't want brightness, color or effect support, just omit the corresponding configuration sections. diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index b5c8cae29f72..150d4ca21a93 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -39,7 +39,7 @@ Sketch should acknowledge a command sent from controller with the same type. If For more information, visit the [serial api] of MySensors. -### {% linkable_title MySensors 1.x example sketch %} +### MySensors 1.x example sketch ```cpp /* @@ -114,7 +114,7 @@ void incomingMessage(const MyMessage &message) { } ``` -### {% linkable_title MySensors 2.x example sketch %} +### MySensors 2.x example sketch ```cpp /* diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index f1a0024a4a18..5a16281dc38c 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -119,7 +119,7 @@ devices: type: [list, string] {% endconfiguration %} -### {% linkable_title Light state %} +### Light state Initially the state of a light is unknown. When the light is turned on or off (via frontend or remote) the state is known and will be shown in the frontend. @@ -138,7 +138,7 @@ light: Any on/off command from any alias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used. -### {% linkable_title Light types %} +### Light types Light devices can come in different forms. Some only switch on and off, other support dimming. Dimmable devices might not always respond nicely to repeated `on` command as they turn into a pulsating state until `on` is pressed again (for example KlikAanKlikUit). The RFLink integration support three types of lights to make things work in every situation: @@ -149,7 +149,7 @@ Light devices can come in different forms. Some only switch on and off, other su By default new lights are assigned the `switchable` type. Protocol supporting dimming are assigned the `hybrid` type. Currently only `newkaku` protocol is detected as dimmable. Please refer to Device Support to get your dimmers supported. -### {% linkable_title Hiding/ignoring lights %} +### Hiding/ignoring lights Lights are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods: @@ -157,11 +157,11 @@ Lights are added automatically when the RFLink gateway intercepts a wireless com - Hide unwanted devices using [customizations](/getting-started/customizing-devices/) - [Ignore devices on a platform level](/components/rflink/#ignoring-devices) -### {% linkable_title Device support %} +### Device support See [device support](/components/rflink/#device-support) -### {% linkable_title Additional configuration examples %} +### Additional configuration examples Multiple lights with `signal_repetitions` and custom names diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index e38f011e1bd6..54f1f79cd38b 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -85,7 +85,7 @@ light: type: action {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations If you are using the state of a platform that takes extra time to load, the Template Light may get an `unknown` state during startup. This results @@ -97,11 +97,11 @@ with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} -## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this light. -### {% linkable_title Theater Volume Control %} +### Theater Volume Control This example shows a light that is actually a home theater's volume. This component gives you the flexibility to provide whatever you'd like to send as @@ -150,7 +150,7 @@ light: ``` {% endraw %} -### {% linkable_title Change The Icon %} +### Change The Icon This example shows how to change the icon based on the light state. @@ -194,7 +194,7 @@ light: ``` {% endraw %} -### {% linkable_title Change The Entity Picture %} +### Change The Entity Picture This example shows how to change the entity picture based on the light state. diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index 7b03b3f3c126..ab2f1cd46ac9 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -136,9 +136,9 @@ model: type: string {% endconfiguration %} -## {% linkable_title Platform Services %} +## Platform Services -### {% linkable_title Service `light.xiaomi_miio_set_scene` %} +### Service `light.xiaomi_miio_set_scene` Set one of the 4 available fixed scenes. @@ -147,7 +147,7 @@ Set one of the 4 available fixed scenes. | `entity_id` | yes | Only act on a specific light. Else targets all. | | `scene` | no | Scene, between 1 and 4. | -### {% linkable_title Service `light.xiaomi_miio_set_delayed_turn_off` %} +### Service `light.xiaomi_miio_set_delayed_turn_off` Delayed turn off. @@ -156,7 +156,7 @@ Delayed turn off. | `entity_id` | yes | Only act on a specific light. Else targets all. | | `time_period` | no | Time period for the delayed turn off. | -### {% linkable_title Service `light.xiaomi_miio_reminder_on` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_reminder_on` (Eyecare Smart Lamp 2 only) Enable the eye fatigue reminder/notification. @@ -164,7 +164,7 @@ Enable the eye fatigue reminder/notification. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_reminder_off` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_reminder_off` (Eyecare Smart Lamp 2 only) Disable the eye fatigue reminder/notification. @@ -172,7 +172,7 @@ Disable the eye fatigue reminder/notification. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_night_light_mode_on` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_night_light_mode_on` (Eyecare Smart Lamp 2 only) Turn the smart night light mode on. @@ -180,7 +180,7 @@ Turn the smart night light mode on. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_night_light_mode_off` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_night_light_mode_off` (Eyecare Smart Lamp 2 only) Turn the smart night light mode off. @@ -188,7 +188,7 @@ Turn the smart night light mode off. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_eyecare_mode_on` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_eyecare_mode_on` (Eyecare Smart Lamp 2 only) Turn the eyecare mode on. @@ -196,7 +196,7 @@ Turn the eyecare mode on. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_eyecare_mode_off` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_eyecare_mode_off` (Eyecare Smart Lamp 2 only) Turn the eyecare mode off. diff --git a/source/_components/limitlessled.markdown b/source/_components/limitlessled.markdown index f5853c4d0830..1bd989a41eef 100644 --- a/source/_components/limitlessled.markdown +++ b/source/_components/limitlessled.markdown @@ -24,7 +24,7 @@ Note: you can assign an `rgbw`, `rgbww`, `white` and `dimmer` group to the same An archive of the extensive API can be found [here](https://github.com/Fantasmos/LimitlessLED-DevAPI). -### {% linkable_title Setup %} +### Setup Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). @@ -103,7 +103,7 @@ bridges: type: boolean {% endconfiguration %} -### {% linkable_title Night Effect %} +### Night Effect LimitlessLED has a `night` effect that can be used to dim the lights below `brightness: 1`. This night mode is meant to temporarily turn the lights into a nightlight. This mode can be especially helpful when wall switches are also being used. For example, when a light is using the `night` effect one way to return it to its previous brightness level (other than using Home Assistant) is to switch the lights off and then back on from the wall switch. @@ -121,7 +121,7 @@ automation: effect: night ``` -### {% linkable_title Properties %} +### Properties Refer to the [light]({{site_root}}/components/light/) documentation for general property usage, but keep in mind the following notes specific to LimitlessLED. @@ -142,7 +142,7 @@ Refer to the [light]({{site_root}}/components/light/) documentation for general - **Transitions** - If a transition time is set, the group will transition between the current settings and the target settings for the duration specified. Transitions from or to white are not possible - the color will change immediately. -### {% linkable_title Initialization & Synchronization %} +### Initialization & Synchronization When starting Home Assistant, the last recorded state will be shown. This might no longer match the actual state of the bulbs. diff --git a/source/_components/linksys_ap.markdown b/source/_components/linksys_ap.markdown index 3cc93ad60b35..e4bf531c8f3d 100644 --- a/source/_components/linksys_ap.markdown +++ b/source/_components/linksys_ap.markdown @@ -19,7 +19,7 @@ The `linksys_ap` platform offers presence detection by looking at connected devi It was tested with a LAPAC1750 AC1750 Dual Band Access Point. -## {% linkable_title Configuration %} +## Configuration To use a Linksys Access Point in your installation, add the following to your `configuration.yaml` file: @@ -52,7 +52,7 @@ verify_ssl: type: boolean {% endconfiguration %} -## {% linkable_title Example %} +## Example Example for all configuration options: diff --git a/source/_components/linksys_smart.markdown b/source/_components/linksys_smart.markdown index de5c03ff4bec..f0132a9ad643 100644 --- a/source/_components/linksys_smart.markdown +++ b/source/_components/linksys_smart.markdown @@ -22,11 +22,11 @@ Tested routers: - Linksys WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router - Linksys WRT1900ACS Dual-band Wi-Fi Router -## {% linkable_title Setup %} +## Setup For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password. -## {% linkable_title Configuration %} +## Configuration To use a Linksys Smart Wifi Router in your Home Assistant installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/linky.markdown b/source/_components/linky.markdown index fe8b21894501..e4f1fd52164d 100644 --- a/source/_components/linky.markdown +++ b/source/_components/linky.markdown @@ -19,7 +19,7 @@ redirect_from: The `linky` sensor platform is retrieving the consumption of your home from the [Linky electric meter](https://www.enedis.fr/linky-compteur-communicant). -## {% linkable_title Configuration %} +## Configuration First, you need to create an Enedis account [here](https://espace-client-connexion.enedis.fr/auth/UI/Login?realm=particuliers), if you don't have already one. diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index 758879c2c9ff..fe02e625b87e 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Switch](#switch) -## {% linkable_title Setup %} +## Setup Obtain your oAuth2 Access Token from Linode account. @@ -36,7 +36,7 @@ Obtain your oAuth2 Access Token from Linode account. - Create a Personal Access Token, - Assigned scope (Please choose the least possible access required.) -## {% linkable_title Configuration %} +## Configuration To integrate Linode with Home Assistant, add the following section to your `configuration.yaml` file: @@ -53,7 +53,7 @@ linode: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `linode` binary sensor platform allows you to monitor your Linode nodes. @@ -74,7 +74,7 @@ nodes: type: string {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `linode` switch platform allows you to turn your Linode nodes on and off. diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 310218957736..71d386d78fc6 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -18,7 +18,7 @@ ha_iot_class: Local Push Sending IR commands is not supported in this integration (yet), but can be accomplished using the [shell_command component](/components/shell_command/) in conjunction with the `irsend` command. -### {% linkable_title Installation %} +### Installation To allow Home Assistant to talk to your IR receiver, you need to first make sure you have the correct dependencies installed: @@ -37,7 +37,7 @@ The configuration is slightly different : For more information have a look at `/usr/share/doc/lirc/README.Debian.gz` where the update process is explained when you have updated from jessie to stretch.

-### {% linkable_title Configuring LIRC %} +### Configuring LIRC Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](http://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g., for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. @@ -73,14 +73,14 @@ $ ircat home-assistant and pressing some buttons on the remote. You should see them register on the screen if LIRC is properly configured. -### {% linkable_title Configuration Home Assistant %} +### Configuration Home Assistant ```yaml # Example configuration.yaml entry lirc: ``` -#### {% linkable_title Events %} +#### Events The LIRC integration fires `ir_command_received` events on the bus. You can capture the events and respond to them in automation scripts like this: diff --git a/source/_components/liveboxplaytv.markdown b/source/_components/liveboxplaytv.markdown index 796f25f8bc22..dc4e1815fed7 100644 --- a/source/_components/liveboxplaytv.markdown +++ b/source/_components/liveboxplaytv.markdown @@ -18,7 +18,7 @@ redirect_from: The `liveboxplaytv` platform allows you to control [Orange Livebox Play TV appliances](https://boutique.orange.fr/internet/decodeur-tv-livebox). -## {% linkable_title Configuration %} +## Configuration To add an Orange Livebox Play TV to your installation, add the following to your `configuration.yaml` file: @@ -46,7 +46,7 @@ port: type: integer {% endconfiguration %} -## {% linkable_title Full configuration %} +## Full configuration A full configuration example for an Orange TV appliance can look like this: diff --git a/source/_components/local_file.markdown b/source/_components/local_file.markdown index 84ac707ae031..218b9cd142f6 100644 --- a/source/_components/local_file.markdown +++ b/source/_components/local_file.markdown @@ -20,7 +20,7 @@ The `local_file` camera platform allows you to integrate an image file from disk The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -42,7 +42,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Service `camera.local_file_update_file_path` %} +### Service `camera.local_file_update_file_path` Use this service to change the file displayed by the camera. diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index bc08dc77371c..b5e7ad675d9d 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -19,11 +19,11 @@ Keeps track which locks are in your environment, their state and allows you to c * Maintains a state per lock and a combined state `all_locks`. * Registers services `lock.lock`, `lock.unlock` and `lock.open` (unlatch) to control locks. -### {% linkable_title Services %} +### Services A lock integration provides the following services: -#### {% linkable_title Service `lock.lock` %} +#### Service `lock.lock` Lock your door, the attribute should appear under a 'data' attribute for the service. @@ -31,7 +31,7 @@ Lock your door, the attribute should appear under a 'data' attribute for the ser |---------------------------|----------|-------------------------------------------------------| | `entity_id` | no | Entity of the relevant lock. | -##### {% linkable_title Example %} +##### Example ```yaml action: @@ -40,7 +40,7 @@ action: entity_id: lock.my_place ``` -#### {% linkable_title Service `lock.unlock` %} +#### Service `lock.unlock` Unlock your door, the attribute should appear under a 'data' attribute for the service. @@ -48,7 +48,7 @@ Unlock your door, the attribute should appear under a 'data' attribute for the s |---------------------------|----------|-------------------------------------------------------| | `entity_id` | no | Entity of the relevant lock. | -##### {% linkable_title Example %} +##### Example ```yaml action: @@ -57,7 +57,7 @@ action: entity_id: lock.my_place ``` -### {% linkable_title Use the services %} +### Use the services Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock.lock`, `lock.unlock` or `lock.open` from the list of available services (**Services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index b35d237aa9ca..fb4d2ebffc78 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt` lock platform lets you control your MQTT enabled locks. -## {% linkable_title Configuration %} +## Configuration In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be `false` / unlocked. @@ -137,11 +137,11 @@ device: Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

-## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this lock. -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a MQTT lock. diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown index c138f82247fe..dda6caa7207e 100644 --- a/source/_components/lock.template.markdown +++ b/source/_components/lock.template.markdown @@ -23,7 +23,7 @@ This can simplify the GUI and make it easier to write automations. You can mark In optimistic mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the template. Try to enable it, if experiencing incorrect lock operation. -## {% linkable_title Configuration %} +## Configuration To enable Template Locks in your installation, add the following to your `configuration.yaml` file: @@ -70,15 +70,15 @@ lock: default: false {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations If you are using the state of a platform that takes extra time to load, the Template Lock may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} -## {% linkable_title Examples %} +## Examples In this section, you find some real-life examples of how to use this lock. -### {% linkable_title Lock from Switch %} +### Lock from Switch This example shows a lock that copies data from a switch. @@ -99,7 +99,7 @@ lock: ``` {% endraw %} -### {% linkable_title Optimistic Mode %} +### Optimistic Mode This example shows a lock in optimistic mode. This lock will immediately change state after command and will not wait for state update from the sensor. @@ -121,7 +121,7 @@ lock: ``` {% endraw %} -### {% linkable_title Sensor and Two Switches %} +### Sensor and Two Switches This example shows a lock that takes its state from a sensor, and uses two momentary switches to control a device. diff --git a/source/_components/lockitron.markdown b/source/_components/lockitron.markdown index ac7875556cdc..663a1aa2f403 100644 --- a/source/_components/lockitron.markdown +++ b/source/_components/lockitron.markdown @@ -18,11 +18,11 @@ redirect_from: The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant. -## {% linkable_title Setup %} +## Setup In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you. Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you). -## {% linkable_title Configuration %} +## Configuration To enable the lock, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index 5ed22180c9c5..051ce219e7bd 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -106,7 +106,7 @@ logbook: - sensor.date ``` -### {% linkable_title Exclude Events %} +### Exclude Events Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. @@ -120,7 +120,7 @@ list. For instance you use the `sun` domain only to trigger automations on the `azimuth` attribute, then you possible are not interested in the logbook entries for sun rise and sun set. -### {% linkable_title Custom Entries %} +### Custom Entries It is possible to add custom entries to the logbook by using the script component to fire an event. diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 8e3ec41f2c52..009601811c58 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -77,7 +77,7 @@ logger: type: '[log_level](#log-levels)' {% endconfiguration %} -### {% linkable_title Log Levels %} +### Log Levels Possible log severity levels, listed in order from most severe to least severe, are: @@ -90,9 +90,9 @@ Possible log severity levels, listed in order from most severe to least severe, - debug - notset -## {% linkable_title Services %} +## Services -### {% linkable_title Service `set_default_level` %} +### Service `set_default_level` You can alter the default log level (for integrations without a specified log level) using the service `logger.set_default_level`. @@ -105,7 +105,7 @@ data: level: info ``` -### {% linkable_title Service `set_level` %} +### Service `set_level` You can alter log level for one or several integrations using the service `logger.set_level`. It accepts the same format as `logs` in the configuration. diff --git a/source/_components/logi_circle.markdown b/source/_components/logi_circle.markdown index 812551821696..71bbfd151d7f 100644 --- a/source/_components/logi_circle.markdown +++ b/source/_components/logi_circle.markdown @@ -20,7 +20,7 @@ redirect_from: The `logi_circle` implementation allows you to integrate your [Logi Circle](https://circle.logi.com/) cameras in Home Assistant. To connect Logi Circle, you will have to [sign up for API access](#requesting-api-access) and get a `client_id`, `client_secret` and `api_key`. -## {% linkable_title Requesting API access %} +## Requesting API access 1. Navigate to the [Circle OAuth2 Client Request Form](https://docs.google.com/forms/d/184FUILJ10rVxotyOQR5DAiu6GcCbK31AZszUdzT1ybs). 2. Fill out your contact name and e-mail address. @@ -40,7 +40,7 @@ The `logi_circle` implementation allows you to integrate your [Logi Circle](http Please note that the turn-around time for API access takes a few business days after which you will be contacted by Logitech using the email address you provided in the form. -## {% linkable_title Configuration %} +## Configuration To integrate cameras linked with your [Logi Circle](https://circle.logi.com/) account, add the following to your `configuration.yaml` file: @@ -75,13 +75,13 @@ redirect_uri: type: string {% endconfiguration %} -### {% linkable_title Camera %} +### Camera The `logi_circle` camera platform allows you to view still frames from your [Logi Circle](https://circle.logi.com/) camera's live stream in Home Assistant. Logi Circle cameras support the `camera.turn_on` and `camera.turn_off` services. This will set the streaming mode property of your camera accordingly, controlling whether the live stream is available and activity recordings are captured. -### {% linkable_title Sensor %} +### Sensor The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant. @@ -128,11 +128,11 @@ sensor: description: The soft on/off status of the camera. {% endconfiguration %} -## {% linkable_title Services %} +## Services The `logi_circle` platform exposes 3 services for interacting with your Logi Circle device. When calling a service with one or more entity IDs, please ensure you target the camera entity (eg. `camera.living_room_camera`). -### {% linkable_title Service `logi_circle.livestream_record` %} +### Service `logi_circle.livestream_record` Initiates a recording of the camera's live stream. @@ -144,7 +144,7 @@ Initiates a recording of the camera's live stream. The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. -### {% linkable_title Service `logi_circle.livestream_snapshot` %} +### Service `logi_circle.livestream_snapshot` Take a snapshot from a camera's live stream. This differs from the generic [snapshot](/components/camera/#service-snapshot) service in that explicitly requests a fresh image from Logi Circle's API. This will force cameras in a deep sleep state to wake. @@ -157,7 +157,7 @@ Please note that new snapshots will only be generated if the cached snapshot is The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. -### {% linkable_title Service `logi_circle.set_config` %} +### Service `logi_circle.set_config` Sets a configuration property for your camera. diff --git a/source/_components/luftdaten.markdown b/source/_components/luftdaten.markdown index aa8e259f80fa..bd1a91f1c491 100644 --- a/source/_components/luftdaten.markdown +++ b/source/_components/luftdaten.markdown @@ -20,12 +20,12 @@ redirect_from: The `luftdaten` integration will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. -## {% linkable_title Setup %} +## Setup - To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://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/). -## {% linkable_title Configuration via the frontend %} +## Configuration via the frontend Menu: **Configuration** -> **Integrations** @@ -34,7 +34,7 @@ Configure the integration: - Enter the **Sensor ID** - Choose if you want to show the sensor's location on the map. -## {% linkable_title Manual Configuration %} +## Manual Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -90,7 +90,7 @@ Not all sensors provide all conditions. Also, it's possible that the sensor valu $ curl https://api.luftdaten.info/v1/sensor/[sensorid]/ ``` -## {% linkable_title Full example %} +## Full example This example would use the sensor with the ID 155, show it on the `map` and would monitor `temperature` and `humidity`. @@ -105,7 +105,7 @@ luftdaten: - humidity ``` -## {% linkable_title Sensor %} +## Sensor The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown index adbf025d5b16..629121651fad 100644 --- a/source/_components/lupusec.markdown +++ b/source/_components/lupusec.markdown @@ -33,7 +33,7 @@ The following devices are supported by the underlying `lupupy` Python library an - **Binary Sensor**: Displays the status of binary sensors. Currently only Door and window sensors are supported. - **Switch**: Turn off and on your Lupus power switches. -## {% linkable_title Configuration %} +## Configuration To use Lupusec devices in your installation, add the following `lupusec` section to your `configuration.yaml` file: diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index 753c58008af0..a7f5459a6025 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -27,7 +27,7 @@ redirect_from: Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches, dimmers, and seeTouch keypad scenes. -## {% linkable_title Configuration %} +## Configuration When configured, the `lutron` integration will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group. @@ -60,7 +60,7 @@ password: It is recommended to assign a static IP address to your main repeater. This ensures that it won't change IP addresses, so you won't have to change the `host` if it reboots and comes up with a different IP address.

-## {% linkable_title Keypad buttons %} +## Keypad buttons Individual buttons on keypads are not represented as entities. Instead, they fire events called `lutron_event` whose payloads include `id` and `action` attributes. @@ -72,7 +72,7 @@ For raise/lower buttons (dimmer buttons, shade controls, etc.) there will be two For single-action buttons (scene selection, etc.), `action` will be `single`, and there will only be one event fired. This is a limitation of the Lutron controller which doesn't give Home Assistant any way of knowing when a single-action button is released. -## {% linkable_title Scene %} +## Scene This integration uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads. The Lutron scene platform allows you to control scenes programmed into your SeeTouch keypads. diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index ec5aeb37fb25..4e9e436cc6a1 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -76,7 +76,7 @@ Use a DHCP reservation on your router to reserve the address or in the PRO model To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta integration above. -## {% linkable_title Cover %} +## Cover After setup, shades will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as `cover.living_room_window`. @@ -84,7 +84,7 @@ For more information on working with shades in Home Assistant, see the [Covers c Available services: `cover.open_cover`, `cover.close_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open. -## {% linkable_title Light %} +## Light After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as `light.bedroom_lamp`. @@ -94,7 +94,7 @@ For more information on working with lights in Home Assistant, see the [Lights c Available services: `light.turn_on`, `light.turn_off` and `light.toggle`. The `light.turn_on` service supports attributes `brightness` and `brightness_pct`. -## {% linkable_title Scene %} +## Scene The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes that are created in the Lutron mobile app. @@ -104,7 +104,7 @@ For more information on working with scenes in Home Assistant, see the [Scenes c Available services: `scene.turn_on`. -## {% linkable_title Switch %} +## Switch After setup, switches will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as `switch.master_bathroom_vanity`. diff --git a/source/_components/lw12wifi.markdown b/source/_components/lw12wifi.markdown index 6177029aafe8..72115c2994d6 100644 --- a/source/_components/lw12wifi.markdown +++ b/source/_components/lw12wifi.markdown @@ -18,7 +18,7 @@ redirect_from: The `lw12wifi` light platform supports Lagute LW-12 Wifi LED controller. -## {% linkable_title Configuration %} +## Configuration To enable these lights, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/magicseaweed.markdown b/source/_components/magicseaweed.markdown index 6aa596a13237..91a41655be80 100644 --- a/source/_components/magicseaweed.markdown +++ b/source/_components/magicseaweed.markdown @@ -18,11 +18,11 @@ redirect_from: The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. -## {% linkable_title Setup %} +## Setup You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 1 spot for the free plan. -## {% linkable_title Configuration %} +## Configuration To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index 904b883ed401..29e4c17f0f95 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications). -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -66,11 +66,11 @@ automation: entity_id: light.office ``` -## {% linkable_title Notifications %} +## Notifications The Mailgun notification service allows you to send emails via Mailgun's REST API. It requires the [Mailgun component](#configuration) to be set up. -### {% linkable_title Notifications configuration %} +### Notifications configuration ```yaml # Example configuration.yaml entry @@ -105,7 +105,7 @@ sender: type: string {% endconfiguration %} -### {% linkable_title Example automation %} +### Example automation The following automation reacts to an event by sending out an email with two attachments. diff --git a/source/_components/manual.markdown b/source/_components/manual.markdown index 611f755a4d35..6f87545eb8c5 100644 --- a/source/_components/manual.markdown +++ b/source/_components/manual.markdown @@ -18,7 +18,7 @@ redirect_from: The `manual` alarm control panel platform enables you to set manual alarms in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: @@ -90,7 +90,7 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered: type: integer {% endconfiguration %} -## {% linkable_title State machine %} +## State machine The state machine of the manual alarm integration is complex but powerful. The transitions are timed according to three values, **delay_time**, **pending_time** @@ -129,7 +129,7 @@ garage door opens, but not for the "armed home" state. **trigger_time** is useful to disable the alarm when disarmed, but it can also be used for example to sound the siren for a shorter time during the night. -## {% linkable_title Examples %} +## Examples In the config example below: @@ -155,7 +155,7 @@ alarm_control_panel: In the rest of this section, you find some real-life examples on how to use this panel. -### {% linkable_title Sensors %} +### Sensors Using sensors to trigger the alarm. diff --git a/source/_components/manual_mqtt.markdown b/source/_components/manual_mqtt.markdown index ecf2e39821a3..4b912bb6de1b 100644 --- a/source/_components/manual_mqtt.markdown +++ b/source/_components/manual_mqtt.markdown @@ -35,7 +35,7 @@ When the state of the manual alarm changes, Home Assistant will publish one of t - 'pending' - 'triggered' -## {% linkable_title Configuration %} +## Configuration To use your panel in your installation, add the following to your `configuration.yaml` file: @@ -153,7 +153,7 @@ payload_arm_night: default: ARM_NIGHT {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In the configuration example below: @@ -182,7 +182,7 @@ alarm_control_panel: Refer to the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples) for more real-life examples on how to use this panel. -## {% linkable_title MQTT Control %} +## MQTT Control The state of this alarm can be controlled using [MQTT](/components/mqtt/). Ensure you've configured that before adding this component. diff --git a/source/_components/marytts.markdown b/source/_components/marytts.markdown index c55f7a86f849..aba32454a4b0 100644 --- a/source/_components/marytts.markdown +++ b/source/_components/marytts.markdown @@ -17,7 +17,7 @@ redirect_from: The `marytts` text-to-speech platform uses [MaryTTS](http://mary.dfki.de/) Text-to-Speech engine to read a text with natural sounding voices. -## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with MaryTTS, add the following lines to your `configuration.yaml`: @@ -57,7 +57,7 @@ language: See [documentation](http://mary.dfki.de/documentation/index.html) for details. -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/mastodon.markdown b/source/_components/mastodon.markdown index dafa44fbbaaf..df074b1e606b 100644 --- a/source/_components/mastodon.markdown +++ b/source/_components/mastodon.markdown @@ -17,11 +17,11 @@ redirect_from: The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to deliver notifications from Home Assistant. -### {% linkable_title Setup %} +### Setup Go to **Preferences** in the Mastodon web interface, then to **Development** and create a new application. -### {% linkable_title Configuration %} +### Configuration To add Mastodon to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown index 2f362d092dbd..e0fb914dcbf4 100644 --- a/source/_components/matrix.markdown +++ b/source/_components/matrix.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -85,13 +85,13 @@ commands: default: empty {% endconfiguration %} -### {% linkable_title Event Data %} +### Event Data If a command is triggered, a `matrix_command` event is fired. The event contains the name of the command in the `name` field. If the command is a word command, the `data` field contains a list of the command's arguments, i.e., everything that stood behind the word, split at spaces. If the command is an expression command, the `data` field contains the [group dictionary](https://docs.python.org/3.6/library/re.html?highlight=re#re.match.groupdict) of the regular expression that matched the message. -### {% linkable_title Comprehensive Configuration Example %} +### Comprehensive Configuration Example This example also uses the [matrix `notify` platform](#notifications). @@ -147,7 +147,7 @@ This configuration will: - Listen for "!testword" in the room "#someothertest:matrix.org" (and *only*) there. If such a message is encountered, it will answer with "It looks like you wrote !testword" into the "#hasstest:matrix.org" channel. - Listen in both rooms for any message matching "My name is " and answer with "Hello " into "#hasstest:matrix.org". -## {% linkable_title Notifications %} +## Notifications The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](http://matrix.org) room. Rooms can be both direct as well as group chats. diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index a8ec3c954029..caf4f987340d 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -37,7 +37,7 @@ Supported Devices: - MAX! Window Sensor (tested) - MAX! Wall Thermostat (tested) -### {% linkable_title One Gateway %} +### One Gateway A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -48,7 +48,7 @@ maxcube: - host: 192.168.0.20 ``` -### {% linkable_title Multiple Gateways %} +### Multiple Gateways ```yaml # Example configuration.yaml entry diff --git a/source/_components/mcp23017.markdown b/source/_components/mcp23017.markdown index 8725d9f9439b..e906d4114ede 100644 --- a/source/_components/mcp23017.markdown +++ b/source/_components/mcp23017.markdown @@ -20,13 +20,13 @@ The `mcp23017` integration is the base for all related mcp23017 platforms in Hom 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). -## {% linkable_title Binary Sensor %} +## Binary Sensor The `mcp23017` binary sensor platform allows you to read sensor values from the I/O pins of your [MCP23017 I2C I/O expander](https://www.adafruit.com/product/732). The pin numbers are from 0 to 15 where: 0-7 correspond to port A (A1-A8) and 8-15 to port B (B1-B8). -### {% linkable_title Configuration %} +### Configuration To use the I/O pins of an mcp23017 connected to an I2C bus of your Raspberry Pi as binary sensors, add the following to your `configuration.yaml` file: @@ -78,13 +78,13 @@ pull_mode: MCP23017 only has internal pull-up resistors, if you want to use pull-down you will have to wire your own pull-down resistors.

-## {% linkable_title Switch %} +## Switch The `mcp23017` switch platform allows you to write to the I/O pins of your [MCP23017 I2C I/O expander](https://www.adafruit.com/product/732). The pin numbers are from 0 to 15 where: 0-7 correspond to port A (A1-A8) and 8-15 to port B (B1-B8). -### {% linkable_title Configuration %} +### Configuration To use the I/O pins of an mcp23017 connected to an I2C bus of your Raspberry Pi as switches, add the following to your `configuration.yaml` file: diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown index d853f0c31bb8..0aeb880cbd0a 100644 --- a/source/_components/media_extractor.markdown +++ b/source/_components/media_extractor.markdown @@ -69,7 +69,7 @@ Query examples with explanations: More info about queries [here](https://github.com/rg3/youtube-dl#format-selection) -### {% linkable_title Use the service %} +### Use the service Use service developer tool icon **Services** from the **Developer Tools**. Choose `media_extractor` from the dropdown menu **Domain** and `play_media` from **Service**, enter something like the JSON sample from above into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index cbce37a2b089..65b1fc276528 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -16,37 +16,37 @@ ha_release: 0.7 Interacts with media players on your network. -## {% linkable_title Services %} +## Services -### {% linkable_title Media control services %} +### Media control services Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set` | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------ | | `entity_id` | yes | Target a specific media player. Defaults to all. | -#### {% linkable_title Service `media_player.volume_mute` %} +#### Service `media_player.volume_mute` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| | `entity_id` | yes | Target a specific media player. Defaults to all. | | `is_volume_muted` | no | True/false for mute/unmute | -#### {% linkable_title Service `media_player.volume_set` %} +#### Service `media_player.volume_set` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| | `entity_id` | yes | Target a specific media player. Defaults to all. | | `volume_level` | no | Float for volume level. Range 0..1 | -#### {% linkable_title Service `media_player.media_seek` %} +#### Service `media_player.media_seek` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| | `entity_id` | yes | Target a specific media player. Defaults to all. | | `seek_position` | no | Position to seek to. The format is platform dependent. | -#### {% linkable_title Service `media_player.play_media` %} +#### Service `media_player.play_media` | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -54,14 +54,14 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | `media_content_id` | no | A media identifier. The format of this is integration dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. | | `media_content_type` | no | A media type. Must be one of `music`, `tvshow`, `video`, `episode`, `channel` or `playlist`. For example, to play music you would set `media_content_type` to `music`. | -#### {% linkable_title Service `media_player.select_source` %} +#### Service `media_player.select_source` | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------- | | `entity_id` | yes | Target a specific media player. Defaults to all. | | `source` | no | Name of the source to switch to. Platform dependent. | -#### {% linkable_title Service `media_player.select_sound_mode` %} +#### Service `media_player.select_sound_mode` Currently only supported on [Denon AVR](/components/media_player.denonavr/) and [Songpal](/components/media_player.songpal/). @@ -70,7 +70,7 @@ Currently only supported on [Denon AVR](/components/media_player.denonavr/) and | `entity_id` | no | Target a specific media player. For example `media_player.marantz`| | `sound_mode` | no | Name of the sound mode to switch to. Platform dependent.| -#### {% linkable_title Service `media_player.shuffle_set` %} +#### Service `media_player.shuffle_set` Currently only supported on [Spotify](/components/media_player.spotify/), [MPD](/components/media_player.mpd/), [Kodi](/components/media_player.kodi/), [Squeezebox](/components/media_player.squeezebox/) and [Universal](/components/media_player.universal/). diff --git a/source/_components/mediaroom.markdown b/source/_components/mediaroom.markdown index 5409e1d1d6c0..1bf9dd3d4f6c 100644 --- a/source/_components/mediaroom.markdown +++ b/source/_components/mediaroom.markdown @@ -46,7 +46,7 @@ media_player: Notice that all parameters are optional, and discovery should configure everything for you. -#### {% linkable_title Using the Mediaroom integration %} +#### Using the Mediaroom integration The integration has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. @@ -54,9 +54,9 @@ In most cases (single STB) you just need to setup the *platform* and discovery w If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the integration will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. -## {% linkable_title Examples %} +## Examples -### {% linkable_title Example `press_button` script %} +### Example `press_button` script The `play_media` function can be used in scripts to change channels and emulate button pressing from a remote control. @@ -74,7 +74,7 @@ press_button: ``` {% endraw %} -### {% linkable_title Example configuration with 2 STB %} +### Example configuration with 2 STB ```yaml # Example configuration.yaml entry for 2 STB diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index f49f6c291a93..1225eb380860 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: The climate platform will be automatically configured if Melissa integration is configured. -## {% linkable_title Configuration %} +## Configuration To set the Melissa integration up, add the following information to your `configuration.yaml` file: diff --git a/source/_components/meraki.markdown b/source/_components/meraki.markdown index f83aad46993e..d3d82a14a522 100644 --- a/source/_components/meraki.markdown +++ b/source/_components/meraki.markdown @@ -17,7 +17,7 @@ redirect_from: Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network. -### {% linkable_title Prerequisites %} +### Prerequisites 1. Go to Network-wide/General page, and find the Location and scanning section. 1. Make sure analytics and Scanning API are both enabled. @@ -28,7 +28,7 @@ Use your Meraki AP as device tracker. Note that Meraki will see all devices, not 1. Make sure the API Version is set to `2.0`. 1. Hit **Save** in the bottom right of the page. -## {% linkable_title Configuration %} +## Configuration After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file: diff --git a/source/_components/message_bird.markdown b/source/_components/message_bird.markdown index aa32b1b98b43..d71a9a36c735 100644 --- a/source/_components/message_bird.markdown +++ b/source/_components/message_bird.markdown @@ -17,11 +17,11 @@ redirect_from: The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone. -## {% linkable_title Setup %} +## Setup Go to https://www.messagebird.com/ to retrieve your API key. -## {% linkable_title Configuration %} +## Configuration To enable MessageBird notifications in your installation, add the following to your `configuration.yaml` file: @@ -50,11 +50,11 @@ sender: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage MessageBird is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to the specified mobile phone number(s). -#### {% linkable_title Example service payload %} +#### Example service payload ```json { diff --git a/source/_components/met.markdown b/source/_components/met.markdown index a1df12a9f8f3..a656578fed7c 100644 --- a/source/_components/met.markdown +++ b/source/_components/met.markdown @@ -22,7 +22,7 @@ The `met` platform uses the [Met.no](https://met.no/) web service as a source fo Configuration of the Met.no platform via configuration.yaml is deprecated from version 0.95

-## {% linkable_title Configuration %} +## Configuration To add Met.no to your installation, go to Configuration >> Integrations in the UI and enable the Met.no integration. By default the values will be taken from the Home Assistant configuration. diff --git a/source/_components/meteo_france.markdown b/source/_components/meteo_france.markdown index 9abd6cf37628..e041a5b94ce3 100644 --- a/source/_components/meteo_france.markdown +++ b/source/_components/meteo_france.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: It displays the current weather along with a 4 days forecast and can create sensors based on the `monitored_conditions` set in your `configuration.yaml` file, including weather alerts from [Vigilance Météo-France](http://vigilance.meteofrance.com) -## {% linkable_title Configuration %} +## Configuration To add Météo-France to your installation, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ meteo_france: description: Weather alert status. {% endconfiguration %} -### {% linkable_title About `city` configuration %} +### About `city` configuration This integration use the Météo-France search API to get the first city from the results returned. @@ -87,7 +87,7 @@ meteo_france: - city: 'montreal,amerique' ``` -### {% linkable_title About `next_rain` condition sensor %} +### About `next_rain` condition sensor

The 1 hour rain forecast is supported for more than 75 % of metropolitan France.
@@ -105,7 +105,7 @@ Possible value for each intervals attributes are: - 3 Moderate rain - 4 Heavy rain -### {% linkable_title About `weather_alert` sensor %} +### About `weather_alert` sensor

The weather alert is available for the metropolitan France. @@ -115,7 +115,7 @@ The `weather_alert` sensor value give the current weather alert status for the d The sensor attributes give access to each type of alerts and date of the bulletin emitted by Météo-France. -### {% linkable_title Complete example %} +### Complete example This is an example for 3 cities forecast with different monitored conditions: diff --git a/source/_components/meteoalarm.markdown b/source/_components/meteoalarm.markdown index f57b9b51217c..07ee8f8c4a45 100644 --- a/source/_components/meteoalarm.markdown +++ b/source/_components/meteoalarm.markdown @@ -17,7 +17,7 @@ The `MeteoAlarm` platform allows one to watch for weather alerts in europe from The binary sensor state shows if applicable the warning message. The details are available as attribute. -## {% linkable_title Configuration %} +## Configuration To enable this binary sensor, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ language: {% endconfiguration %} -{% linkable_title Example output %} +Example output You will find an example below when the state is "on". @@ -84,7 +84,7 @@ There are a few awareness levels: * 3; orange; Severe * 4; red; High -{% linkable_title Example automation %} +Example automation Below you find an example of an automation. diff --git a/source/_components/metoffice.markdown b/source/_components/metoffice.markdown index de6704a30990..1410c4477172 100644 --- a/source/_components/metoffice.markdown +++ b/source/_components/metoffice.markdown @@ -18,7 +18,7 @@ redirect_from: The `metoffice` weather platform uses the Met Office's [DataPoint API](http://www.metoffice.gov.uk/datapoint) for weather data. -## {% linkable_title Configuration %} +## Configuration To add the Met Office weather platform to your installation, you'll need to register for a free API key at the link above and then add the following to your `configuration.yaml` file: diff --git a/source/_components/mfi.markdown b/source/_components/mfi.markdown index 14f568bafa6f..04af0134ac1f 100644 --- a/source/_components/mfi.markdown +++ b/source/_components/mfi.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Sensor %} +## Sensor The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). @@ -69,7 +69,7 @@ verify_ssl: type: boolean {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). diff --git a/source/_components/mhz19.markdown b/source/_components/mhz19.markdown index 866dc57a9c66..5a5dfed9e7b1 100644 --- a/source/_components/mhz19.markdown +++ b/source/_components/mhz19.markdown @@ -22,7 +22,7 @@ Check out the [Open Home Automation web site](https://www.open-homeautomation.co **Note:** the new version MH-Z19B requires the VIN to be connected to a 5V pin, rather than 3.3V. -## {% linkable_title Configuration %} +## Configuration To use this sensor in your installation, add the following to your `configuration.yaml` file: @@ -50,7 +50,7 @@ sensor: - temperature ``` -## {% linkable_title Raspberry Pi 3(+) GPIO UART and Hass.io %} +## Raspberry Pi 3(+) GPIO UART and Hass.io To directly connect the sensor on the GPIO pins of a RPi, first append the following to `config.txt` in the boot directory: @@ -64,6 +64,6 @@ Then (after a reboot): you can setup the sensor using: serial_device: /dev/tty.S0 ``` -## {% linkable_title Calibration %} +## Calibration The MH-Z19B version of the sensor has Automatic Baseline Calibration enabled by default, which will calibrate the 400PPM level to the lowest measured PPM in the last 24h cycle. Currently the integration does not allow turning this functionaly off. diff --git a/source/_components/microsoft.markdown b/source/_components/microsoft.markdown index 300befd307b6..25c9bfb07e33 100644 --- a/source/_components/microsoft.markdown +++ b/source/_components/microsoft.markdown @@ -18,7 +18,7 @@ redirect_from: The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/). -## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`: @@ -71,7 +71,7 @@ contour: {% endconfiguration %} -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index aae2a39cc023..9ddf62c6d6ce 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -18,7 +18,7 @@ Azure Cognitive service [Face](https://azure.microsoft.com/en-us/services/cognitive-services/face/). All data are stored in your own private instance in the Azure cloud. -## {% linkable_title Setup %} +## Setup You need an API key, which is free, but requires an [Azure registration](https://azure.microsoft.com/en-us/free/) using your @@ -28,7 +28,7 @@ get an API key by registering with [cognitive-services](https://azure.microsoft.com/en-us/try/cognitive-services/). Please note that all keys on cognitive services must be recreated every 90 days. -## {% linkable_title Configuration %} +## Configuration To enable the Microsoft Face component, add the following to your `configuration.yaml` file: @@ -56,7 +56,7 @@ timeout: default: 10s {% endconfiguration %} -### {% linkable_title Person and Groups %} +### Person and Groups For most services, you need to set up a group or a person. This limits the processing and detection to elements provided by the group. diff --git a/source/_components/microsoft_face_detect.markdown b/source/_components/microsoft_face_detect.markdown index 0391fb387b49..354d65254c86 100644 --- a/source/_components/microsoft_face_detect.markdown +++ b/source/_components/microsoft_face_detect.markdown @@ -30,7 +30,7 @@ take a look at the [Image Processing component](/components/image_processing/) p The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page.

-### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/microsoft_face_identify.markdown b/source/_components/microsoft_face_identify.markdown index f3408dbb8f5d..ebd4b2547689 100644 --- a/source/_components/microsoft_face_identify.markdown +++ b/source/_components/microsoft_face_identify.markdown @@ -30,7 +30,7 @@ take a look at the [Image Processing component](/components/image_processing/) p The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page.

-### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/miflora.markdown b/source/_components/miflora.markdown index 72d157dee8af..ebf011be9fa8 100644 --- a/source/_components/miflora.markdown +++ b/source/_components/miflora.markdown @@ -20,7 +20,7 @@ The `miflora` sensor platform allows one to monitor plant soil and air condition There are "Chinese" and "International" versions available and there is a [report](https://community.home-assistant.io/t/miflora-showing-data-unknown/19550/8) that only the "International" works. -## {% linkable_title Install a Bluetooth Backend %} +## Install a Bluetooth Backend Before configuring Home Assistant you need a Bluetooth backend and the MAC address of your sensor. Depending on your operating system, you may have to configure the proper Bluetooth backend for your system: @@ -31,7 +31,7 @@ Before configuring Home Assistant you need a Bluetooth backend and the MAC addre  - Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated` - On Windows and MacOS there is currently no support for the [miflora library](https://github.com/open-homeautomation/miflora/). -## {% linkable_title Scan for devices %} +## Scan for devices Start a scan to determine the MAC addresses of the sensor (you can identify your sensor by looking for `Flower care` or `Flower mate` entries) using this command: @@ -55,7 +55,7 @@ $ bluetoothctl If you can't use `hcitool` or `bluetoothctl` but have access to an Android phone you can try `BLE Scanner` or similar scanner applications from the Play Store to easily find your sensor MAC address. If you are using Windows 10, try the `Microsoft Bluetooth LE Explorer` app from the Windows Store. -## {% linkable_title Configuration %} +## Configuration To use your Mi Flora plant sensor in your installation, add the following to your `configuration.yaml` file: @@ -112,7 +112,7 @@ adapter: By default the sensor is only polled once every 20 minutes (`scan_interval` is 1200 seconds by default). On a Home Assistant restart sensor will report initial value. If you set `median: 3`, it will take _at least_ 40 minutes before the sensor will report an average value. Keep in mind though that reducing polling intervals will have a negative effect on the battery life.

-## {% linkable_title Full example %} +## Full example A full configuration example could look like the one below: diff --git a/source/_components/mikrotik.markdown b/source/_components/mikrotik.markdown index 472015bccea6..9614e40ce4da 100644 --- a/source/_components/mikrotik.markdown +++ b/source/_components/mikrotik.markdown @@ -17,7 +17,7 @@ redirect_from: The `mikrotik` platform offers presence detection by looking at connected devices to a [MikroTik RouterOS](http://mikrotik.com) based router. -## {% linkable_title Configuring `mikrotik` device tracker %} +## Configuring `mikrotik` device tracker You have to enable accessing the RouterOS API on your router to use this platform. @@ -75,7 +75,7 @@ method: type: string {% endconfiguration %} -## {% linkable_title Use a certificate %} +## Use a certificate To use SSL to connect to the API (via `api-ssl` instead of `api` service) further configuration is required at RouterOS side. You have to upload or generate a certificate and configure `api-ssl` service to use it. Here is an example of a self-signed certificate: @@ -94,7 +94,7 @@ If everything is working fine you can disable the pure `api` service in RouterOS /ip service disable api ``` -## {% linkable_title The user privileges in RouterOS %} +## The user privileges in RouterOS To use this device tracker you need restricted privileges only. To enhance the security of your MikroTik device create a "read only" user who is able to connect to API only: @@ -104,7 +104,7 @@ To use this device tracker you need restricted privileges only. To enhance the s /user set password="YOUR_PASSWORD" homeassistant ``` -## {% linkable_title Using the additional configuration to the `mikrotik` device tracker entry in your `configuration.yaml` file: %} +## Using the additional configuration to the `mikrotik` device tracker entry in your `configuration.yaml` file: ```yaml device_tracker: diff --git a/source/_components/mill.markdown b/source/_components/mill.markdown index b5efbaf47410..093bf7e2ee2f 100644 --- a/source/_components/mill.markdown +++ b/source/_components/mill.markdown @@ -18,7 +18,7 @@ redirect_from: Integrates Mill heater into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml` file: @@ -40,7 +40,7 @@ password: type: string {% endconfiguration %} -## {% linkable_title Component services %} +## Component services This platform supports a service to set the temperature for the room connected to heater in the Mill app: diff --git a/source/_components/min_max.markdown b/source/_components/min_max.markdown index 209765f8173f..fbcf66d44d7d 100644 --- a/source/_components/min_max.markdown +++ b/source/_components/min_max.markdown @@ -32,7 +32,7 @@ This sensor is an alternative to the [template sensor](/components/sensor.templa Sensors with an unknown state will be ignored in the calculation. If the unit of measurement of the sensors differs, the `min_max` sensor will go to an error state where the value is `UNKNOWN` and unit of measurement is `ERR`. -## {% linkable_title Configuration %} +## Configuration To enable the `min_max` sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/mitemp_bt.markdown b/source/_components/mitemp_bt.markdown index 93c8ead2496e..35954e7e7751 100644 --- a/source/_components/mitemp_bt.markdown +++ b/source/_components/mitemp_bt.markdown @@ -18,7 +18,7 @@ redirect_from: The `mitemp_bt` sensor platform allows one to monitor room temperature and humidity. The [Xiaomi Mijia BLE Temperature and Humidity sensor with LCD](https://www.amazon.com/Temperature-Humidity-Xiaomi-Bluetooth-Screen-Remote/dp/B079L6N6PC) is a small Bluetooth Low Energy device that monitors the room temperature and humidity. As only a single BLE device can be polled at the same time, the library employs locking to make sure this is the case. -## {% linkable_title Installation %} +## Installation Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: @@ -29,7 +29,7 @@ Depending on the operating system you're running, you have to configure the prop - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. - Windows and MacOS are currently not supported by the `btlewrap` library. -## {% linkable_title Configuration %} +## Configuration Start a scan to determine the MAC addresses of the sensor: @@ -117,7 +117,7 @@ adapter: Note that by default the sensor is only polled once every 5 minutes. This means with the `median: 3` setting will take as least 15 minutes before the sensor will report a value after a Home Assistant restart. Even though the hardware is able to provide new values every second, room temperatures don't change that quickly. Reducing polling intervals will have a negative effect on the battery life. -## {% linkable_title Full example %} +## Full example A full configuration example could look like the one below: diff --git a/source/_components/mjpeg.markdown b/source/_components/mjpeg.markdown index 428b710f2b75..3f1ce4400b3f 100644 --- a/source/_components/mjpeg.markdown +++ b/source/_components/mjpeg.markdown @@ -19,7 +19,7 @@ redirect_from: The `mjpeg` camera platform allows you to integrate IP cameras which are capable to stream their video with MJPEG into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -64,7 +64,7 @@ verify_ssl: default: true {% endconfiguration %} -## {% linkable_title Examples %} +## Examples Example of using a DCS-930L Wireless N Network Camera from D-Link: diff --git a/source/_components/mobile_app.markdown b/source/_components/mobile_app.markdown index f84a40bef455..fd28efdff3e7 100644 --- a/source/_components/mobile_app.markdown +++ b/source/_components/mobile_app.markdown @@ -20,7 +20,7 @@ If you are planning to use a mobile application that integrates with Home Assist If you are a mobile app developer, see the [developer documentation](https://developers.home-assistant.io/docs/en/app_integration_index.html) for instructions on how to build your app on top of the mobile app component. -## {% linkable_title Configuration %} +## Configuration This integration is by default enabled, unless you've disabled or removed the `default_config:` line from your configuration. If that is the case, the following example shows you how to enable this integration manually: diff --git a/source/_components/mochad.markdown b/source/_components/mochad.markdown index 692c3c907387..d4207ffe5bbe 100644 --- a/source/_components/mochad.markdown +++ b/source/_components/mochad.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Light](#light) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file: @@ -46,7 +46,7 @@ port: default: 1099 {% endconfiguration %} -## {% linkable_title Example %} +## Example A full configuration sample could look like the one below: @@ -57,7 +57,7 @@ mochad: port: 1099 ``` -## {% linkable_title Light %} +## Light The `mochad` light platform lets you control an X10 enabled dimmer/light device. @@ -94,7 +94,7 @@ brightness_levels: type: integer {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `mochad` switch platform lets you control an X10 enabled switch device. diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index c62832b0e0fb..98cbb20da3ff 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -18,11 +18,11 @@ ha_iot_class: Local Push [Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections. -## {% linkable_title Configuration %} +## Configuration The configuration for adding modbus to your installation depends on the connection type, either a network or serial connection. -### {% linkable_title Network connection %} +### Network connection For a network connection, add the following to your `configuration.yaml` file: @@ -60,7 +60,7 @@ timeout: type: integer {% endconfiguration %} -### {% linkable_title Serial connection %} +### Serial connection For a serial connection, add the following to your `configuration.yaml` file: @@ -118,7 +118,7 @@ timeout: type: integer {% endconfiguration %} -### {% linkable_title Multiple connections %} +### Multiple connections Multiple connections are possible, add something like the following to your `configuration.yaml` file: @@ -136,14 +136,14 @@ modbus: name: hub2 ``` -### {% linkable_title Services %} +### Services | Service | Description | | ------- | ----------- | | write_register | Write register. Requires `hub`, `unit`, `address` and `value` fields. `value` can be either single value or an array | -#### {% linkable_title Service Data Attributes %} +#### Service Data Attributes | Attribute | Description | | --------- | ----------- | @@ -152,7 +152,7 @@ modbus: | address | Address of the Register (e.g., 138) | | value | A single value or an array of 16-bit values. Single value will call modbus function code 6. Array will call modbus function code 16. Array might need reverse ordering. E.g., to set 0x0004 you might need to set `[4,0]` | -## {% linkable_title Building on top of Modbus %} +## Building on top of Modbus - [Modbus Binary Sensor](/components/binary_sensor.modbus/) - [Modbus Sensor](/components/sensor.modbus/) diff --git a/source/_components/modem_callerid.markdown b/source/_components/modem_callerid.markdown index cf6965fa18e5..51ef586329fe 100644 --- a/source/_components/modem_callerid.markdown +++ b/source/_components/modem_callerid.markdown @@ -19,7 +19,7 @@ The `modem_callerid` sensor platform uses an available modem for collecting call When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number. -## {% linkable_title Setup %} +## Setup To find the path of your USB modem, run: @@ -35,7 +35,7 @@ sudo usermod -a -G dialout homeassistant Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml`: @@ -68,7 +68,7 @@ If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hass Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). -## {% linkable_title Examples %} +## Examples Some example automations: diff --git a/source/_components/mold_indicator.markdown b/source/_components/mold_indicator.markdown index 73981cc1d40c..ec8c3722058f 100644 --- a/source/_components/mold_indicator.markdown +++ b/source/_components/mold_indicator.markdown @@ -21,7 +21,7 @@ The Mold Indicator sensor integration consumes information of two temperature se The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. -## {% linkable_title Configuration %} +## Configuration To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: @@ -60,7 +60,7 @@ calibration_factor: In this case, the weather forecast temperature sensor is used for the outside temperature. -## {% linkable_title Calibration %} +## Calibration The Mold Indicator sensor integration needs to be calibrated in order to estimate the temperature at the critical point from the outdoor and indoor temperature. First find the coldest surface in the room (critical point), which is typically near the window frames, but depends on the insulation of your home. For calibration you need to measure the temperature at this critical point and simultaneously write down the values for the indoor- and outdoor temperature sensors used for the Mold Indicator. Be sure that there is a significant indoor to outdoor temperature difference to get the best calibration results. With the three measured temperatures (in Celsius or Fahrenheit), the calibration_factor for your configuration file is given by: diff --git a/source/_components/monoprice.markdown b/source/_components/monoprice.markdown index 5fe57db0fc9a..8f5fa9cce8fe 100644 --- a/source/_components/monoprice.markdown +++ b/source/_components/monoprice.markdown @@ -60,7 +60,7 @@ sources: type: integer {% endconfiguration %} -### {% linkable_title Service `snapshot` %} +### Service `snapshot` Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If no `entity_id` is provided, all zones are snapshotted. @@ -74,7 +74,7 @@ The following attributes are stored in a snapshot: | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s of zones. -### {% linkable_title Service `restore` %} +### Service `restore` Restore a previously taken snapshot of one or more speakers. If no `entity_id` is provided, all zones are restored. diff --git a/source/_components/moon.markdown b/source/_components/moon.markdown index fc14c92ca137..7254e672d69a 100644 --- a/source/_components/moon.markdown +++ b/source/_components/moon.markdown @@ -19,7 +19,7 @@ redirect_from: The `moon` sensor platform is tracking the moon phases. -## {% linkable_title Configuration %} +## Configuration To enable the moon sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/mopar.markdown b/source/_components/mopar.markdown index 82f4fa7a81b4..74993eaa6937 100644 --- a/source/_components/mopar.markdown +++ b/source/_components/mopar.markdown @@ -26,11 +26,11 @@ The `mopar` integration provides the following for owners of FCA vehicles with a - Switch per vehicle allowing to turn the engine on and off - A service for running the horn & lights -## {% linkable_title Setup %} +## Setup Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. -## {% linkable_title Configuration %} +## Configuration To enable this component, add the following lines to your `configuration.yaml`. All platforms will be automatically loaded. @@ -57,7 +57,7 @@ pin: type: string {% endconfiguration %} -## {% linkable_title Service %} +## Service Call the `mopar.sound_horn` service to sound the horn and flash the lights on your vehicle. diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 7897167ccf39..b26b6f7163fe 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -43,7 +43,7 @@ mqtt: This allows you to connect to the MQTT broker with user `homeassistant` and password `hello`. -## {% linkable_title Additional features %} +## Additional features - [Certificate](/docs/mqtt/certificate/) - [Discovery](/docs/mqtt/discovery/) diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index 557312d2e077..feb0354ff446 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT. -## {% linkable_title Configuration %} +## Configuration To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file: @@ -42,7 +42,7 @@ ignore_event: type: list {% endconfiguration %} -## {% linkable_title Multiple Instances %} +## Multiple Instances Events from multiple instances can be aggregated to a single master instance by subscribing to a wildcard topic from the master instance. diff --git a/source/_components/mqtt_json.markdown b/source/_components/mqtt_json.markdown index 9d4494d5b8ac..2daf308fcfea 100644 --- a/source/_components/mqtt_json.markdown +++ b/source/_components/mqtt_json.markdown @@ -18,7 +18,7 @@ redirect_from: The `mqtt_json` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -42,7 +42,7 @@ qos: type: string {% endconfiguration %} -## {% linkable_title Usage %} +## Usage This platform receives JSON formatted payloads containing GPS information, for example: diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index eb9bcd1205d7..f3d24bdc9e76 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -18,7 +18,7 @@ redirect_from: The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -55,7 +55,7 @@ away_timeout: type: integer {% endconfiguration %} -## {% linkable_title Usage %} +## Usage Example JSON that should be published to the room topics: @@ -67,7 +67,7 @@ Example JSON that should be published to the room topics: } ``` -### {% linkable_title Setting up clients %} +### Setting up clients This integration works with any software that is sending data in the given format. Each client should post the discovered devices in its own subtopic of the configured topic. Instead of developing your own application, you can also use any of these already existing clients: diff --git a/source/_components/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index b98d78ab0713..891d882df61c 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. -## {% linkable_title Configuration %} +## Configuration To enable MQTT Statestream in Home Assistant, add the following section to your `configuration.yaml` file: @@ -71,7 +71,7 @@ include: type: list {% endconfiguration %} -## {% linkable_title Operation %} +## Operation When any Home Assistant entity changes, this integration will publish that change to MQTT. @@ -86,7 +86,7 @@ All states and attributes are passed through JSON serialization before publishin The last_updated and last_changed values for the entity will be published to `homeassistant/light/master_bedroom_dimmer/last_updated` and `homeassistant/light/master_bedroom_dimmer/last_changed`, respectively. The timestamps are in ISO 8601 format - for example, `2017-10-01T23:20:30.920969+00:00`. -## {% linkable_title Include/exclude %} +## Include/exclude The **exclude** and **include** configuration variables can be used to filter the items that are published to MQTT. diff --git a/source/_components/mvglive.markdown b/source/_components/mvglive.markdown index 4d3d11ed901a..95b51353fa1d 100644 --- a/source/_components/mvglive.markdown +++ b/source/_components/mvglive.markdown @@ -18,7 +18,7 @@ redirect_from: The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -68,9 +68,9 @@ name: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration with three sensors that showcase the various configuration options. diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index b56b7b1a500f..a4bc25370e00 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -24,7 +24,7 @@ This integration provides the following platforms: - Binary sensors: if the car is plugged in - Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled -## {% linkable_title Configuration %} +## Configuration To use MyChevy in your installation, add the following to your `configuration.yaml` file: @@ -51,7 +51,7 @@ country: type: string {% endconfiguration %} -### {% linkable_title Limitations %} +### Limitations The architecture of the GM automotive networking imposes some limitations on the functionality of the component. diff --git a/source/_components/mycroft.markdown b/source/_components/mycroft.markdown index 67d4bdca4aaf..7d06ea10ac09 100644 --- a/source/_components/mycroft.markdown +++ b/source/_components/mycroft.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - **Notifications** - Allows to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). -## {% linkable_title Configuration %} +## Configuration To use Mycroft in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/myq.markdown b/source/_components/myq.markdown index 4eba68ac8037..31f02870e0d8 100644 --- a/source/_components/myq.markdown +++ b/source/_components/myq.markdown @@ -18,7 +18,7 @@ redirect_from: The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app. -## {% linkable_title Configuration %} +## Configuration To use your MyQ cover in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 4ae4e38e7490..ffb975624fcf 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -16,7 +16,7 @@ ha_release: 0.73 The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This integration will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified. -### {% linkable_title Configuration %} +### Configuration Integrate your Serial, Ethernet (LAN) or MQTT MySensors Gateway by adding the following to your `configuration.yaml` file: @@ -114,7 +114,7 @@ mqtt: The MQTT gateway requires MySensors version 2.0+ and only the MQTT client gateway is supported.

-### {% linkable_title Extended configuration example %} +### Extended configuration example ```yaml # Example configuration.yaml entry @@ -144,7 +144,7 @@ mysensors: version: '2.0' ``` -### {% linkable_title Presentation %} +### Presentation Present a MySensors sensor or actuator, by following these steps: @@ -237,13 +237,13 @@ void receive(const MyMessage &message) { } ``` -### {% linkable_title SmartSleep %} +### SmartSleep Sending a heartbeat, `I_HEARTBEAT_RESPONSE`, from the MySensors device to Home Assistant, using MySensors version 2.0 - 2.1, activates the SmartSleep functionality in Home Assistant. This means that messages are buffered and only sent to the device upon receiving a heartbeat from the device. State changes are stored so that only the last requested state change is sent to the device. Other types of messages are queued in a FIFO queue. SmartSleep is useful for battery powered actuators that are waiting for commands. See the MySensors library API for information on how to send heartbeats and sleep the device. In MySensors version 2.2 the serial API changed from using `I_HEARTBEAT_RESPONSE` to signal SmartSleep, to using `I_PRE_SLEEP_NOTIFICATION` and `I_POST_SLEEP_NOTIFICATION`. Home Assistant has been upgraded to support the new message types and will activate SmartSleep when receiving a message of type `I_PRE_SLEEP_NOTIFICATION`, if using MySensors version 2.2.x or higher. If Home Assistant is configured to use MySensors version 2.0 - 2.1 the old SmartSleep behavior is retained. -### {% linkable_title Message validation %} +### Message validation Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch. @@ -251,7 +251,7 @@ The log should warn you of messages that failed validation or if a child value i Message validation was introduced in version 0.52 of Home Assistant. -### {% linkable_title Debug logging %} +### Debug logging If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our github issue tracker. ```yaml diff --git a/source/_components/mystrom.markdown b/source/_components/mystrom.markdown index 67d32ea6f823..050cfe5fbe30 100644 --- a/source/_components/mystrom.markdown +++ b/source/_components/mystrom.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: - [Light](#light) - [Switch](#switch) -## {% linkable_title Light %} +## Light To use your myStrom WiFi Bulb in your installation, add the following to your `configuration.yaml` file: @@ -77,7 +77,7 @@ $ curl http://[IP_ADDRESS]/api/v1/device/[MAC_ADDRESS] } ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern: @@ -105,7 +105,7 @@ binary_sensor: The firmware version 2.56 doesn't support TLS/SSL. This means that you are only able to use the WiFi Buttons if you are using plain-text communication between Home Assistant and the clients/entities.

-### {% linkable_title Setup of myStrom Buttons %} +### Setup of myStrom Buttons You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Once a button is connected you have three minutes to set the actions for the push patterns if the button is not charging. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above). @@ -156,11 +156,11 @@ The command-line tool [`mystrom`](https://github.com/fabaff/python-mystrom) is a If you have set [`login_attempts_threshold`](/components/http/) and forget to include the `api_password` for an action and that action is triggered then after the threshold is reached will the button no longer work because it is banned. See [IP filtering and banning](/components/http/#ip-filtering-and-banning) about how to revert the banning. -## {% linkable_title Switch %} +## Switch The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on. -### {% linkable_title Setup %} +### Setup Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch. @@ -205,7 +205,7 @@ or change its state: curl -G -X GET http://IP_ADDRESS/relay -d 'state=1' ``` -### {% linkable_title Get the current power consumption %} +### Get the current power consumption The switch is measuring the current power consumption. To expose this as a sensor use a [`template` sensor](/components/sensor.template/). diff --git a/source/_components/mythicbeastsdns.markdown b/source/_components/mythicbeastsdns.markdown index 67ae36f5a908..1b721ffe0127 100644 --- a/source/_components/mythicbeastsdns.markdown +++ b/source/_components/mythicbeastsdns.markdown @@ -16,7 +16,7 @@ logo: mythic_beasts.png With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/n26.markdown b/source/_components/n26.markdown index a5430f2cff1b..a9e7d5c2ee1a 100644 --- a/source/_components/n26.markdown +++ b/source/_components/n26.markdown @@ -21,7 +21,7 @@ The [N26](https://n26.com) integration for Home Assistant allows you to track yo N26 is a bank from germany that launched as a start up. It is an "online only" bank in that it has no local "stores" to retrieve or deposit money and account management is done only through their web interface and mobile apps. The sensor allows to show account info including balance, spaces (sub-accounts within an account) and bank card status. The switch allows to change the "Blocked/Unblocked" status of an N26 bank card. -## {% linkable_title Configuration %} +## Configuration Add the following entry to the `configuration.yaml` file: diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index 72884063846b..6189ac0aea0a 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -19,7 +19,7 @@ With the `namecheapdns` integration you can automatically update your dynamic DN Namecheap only supports IPv4 addresses to update.

-## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/nanoleaf.markdown b/source/_components/nanoleaf.markdown index 2a404a0e2678..1a14a5744a96 100644 --- a/source/_components/nanoleaf.markdown +++ b/source/_components/nanoleaf.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/light.nanoleaf/ --- -### {% linkable_title Configuration Sample %} +### Configuration Sample The `nanoleaf` platform allows you to control [Nanoleaf Light Panels](https://nanoleaf.me) from Home Assistant. @@ -48,7 +48,7 @@ name: default: Nanoleaf {% endconfiguration %} -### {% linkable_title Getting The Auth Token %} +### Getting The Auth Token 1. Make sure that your Nanoleaf Light Panel is fully patched (as of the time of writing the latest version was 3.0.8 for Aurora and 1.2.0 for Canvas) 2. Hold down the *ON* button on the Panel for 5 seconds; the LED will start flashing diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index ad19520fe74a..73b76c84d672 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -45,7 +45,7 @@ password: After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. More information on how to update can be found [here](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).

-## {% linkable_title Vacuum %} +## Vacuum The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). The status will contain attributes on the robots last clean session. @@ -54,7 +54,7 @@ The status will contain attributes on the robots last clean session. If you notice the robot stops responding to commands check the state to see if the robot is "unavailable". If you see "unavailable" first try to restart the vacuum and wait about 5 minutes to see if it is no longer "unavailable". If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant.

-### {% linkable_title Services %} +### Services Currently supported services are: @@ -69,9 +69,9 @@ And a specific Platform Service: - `vacuum.neato_custom_cleaning` -### {% linkable_title Platform Services %} +### Platform Services -#### {% linkable_title Service `vacuum.neato_custom_cleaning` %} +#### Service `vacuum.neato_custom_cleaning` Starts a custom cleaning of your house. You can set the various options like in the mobile application (mode, map usage, navigation mode, zone). @@ -89,11 +89,11 @@ Some information about the capabilities might be found on the [Neato Developer P | `zone` | yes | Only supported on the Botvac D7. Name of the zone to clean from the Neato app. Use unique names for the zones to avoid the wrong zone from running. Defaults to no zone i.e. complete house cleanup. | -## {% linkable_title Camera %} +## Camera The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). -## {% linkable_title Switch %} +## Switch The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). diff --git a/source/_components/nello.markdown b/source/_components/nello.markdown index 4dc7c326c53b..022b6cbb4302 100644 --- a/source/_components/nello.markdown +++ b/source/_components/nello.markdown @@ -25,7 +25,7 @@ To get started you need to create a secondary Nello account and authorize it to Be aware that if you use your main account for Home Assistant you may not be able to use it with the App.

-## {% linkable_title Configuration %} +## Configuration To add your Nello locks to your installation, add the following to your `configuration.yaml` file: @@ -48,9 +48,9 @@ password: type: string {% endconfiguration %} -## {% linkable_title Events %} +## Events -### {% linkable_title Event `nello_bell_ring` %} +### Event `nello_bell_ring` Every time someone rings the bell, a `nello_bell_ring` event will be fired. diff --git a/source/_components/ness_alarm.markdown b/source/_components/ness_alarm.markdown index 6e54e59c29f6..02bf59f53db0 100644 --- a/source/_components/ness_alarm.markdown +++ b/source/_components/ness_alarm.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: The module communicates via the [Ness D8x/D16x ASCII protocol](http://www.nesscorporation.com/Software/Ness_D8-D16_ASCII_protocol.pdf). -## {% linkable_title Configuration %} +## Configuration A `ness_alarm` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -89,7 +89,7 @@ zones: type: string {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -101,9 +101,9 @@ scan_interval: milliseconds: 0 ``` -## {% linkable_title Services %} +## Services -### {% linkable_title Service `aux` %} +### Service `aux` Trigger an aux output. This requires PCB version 7.8 or higher. @@ -112,7 +112,7 @@ Trigger an aux output. This requires PCB version 7.8 or higher. | `output_id` | No | The aux output you wish to change. A number from 1-4. | `state` | Yes | The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. -### {% linkable_title Service `panic` %} +### Service `panic` Trigger a panic diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 7c8067cb8a67..5512645fc80e 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Climate](#climate) - [Sensor](#sensor) -### {% linkable_title Setting up developer account %} +### Setting up developer account 1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already. 2. Fill in account details: @@ -54,7 +54,7 @@ There is currently support for the following device types within Home Assistant: Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible. -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry @@ -88,7 +88,7 @@ structure: type: list {% endconfiguration %} -### {% linkable_title Service `set_away_mode` %} +### Service `set_away_mode` You can use the service `nest/set_away_mode` to set the structure(s) to "Home" or "Away". @@ -121,7 +121,7 @@ script: - Apartment ``` -### {% linkable_title Service `set_eta` %} +### Service `set_eta` You can use the service `nest/set_eta` to set or update the estimated time of arrival window. Calling this service will automatically set the structure(s) to "Away". Structures must have an associated Nest thermostat in order to use ETA function. @@ -159,7 +159,7 @@ script: - Apartment ``` -### {% linkable_title Service `cancel_eta` %} +### Service `cancel_eta` You can use the service `nest/cancel_eta` to cancel an existing estimated time of arrival window. Structures must have an associated Nest thermostat in order to use ETA function. @@ -192,17 +192,17 @@ script: - Apartment ``` -### {% linkable_title Troubleshooting %} +### Troubleshooting - If you're getting [rickrolled](https://www.youtube.com/watch?v=dQw4w9WgXcQ) instead of being able to see your Nest cameras, you may not have set up your developer account's permissions correctly. Go back through and make sure you've selected read/write under every category that it's an option. -## {% linkable_title Platforms %} +## Platforms

You must have the [Nest component](/components/nest/) configured to use the platforms below.

-## {% linkable_title Binary Sensor %} +## Binary Sensor The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices. @@ -210,7 +210,7 @@ The `nest` binary sensor platform lets you monitor various states of your [Nest] You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` integration is configured and the required configuration for the `nest binary sensor` is set.

-## {% linkable_title Configuration %} +## Configuration To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings: @@ -250,7 +250,7 @@ The following conditions are available by device: - person\_detected - sound\_detected -## {% linkable_title Camera %} +## Camera The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant. @@ -260,7 +260,7 @@ The `nest` camera will automatically be setup when you do. Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release. -## {% linkable_title Climate %} +## Climate The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com). @@ -272,7 +272,7 @@ Please note due to limitations with the European Nest Thermostat E, integration

-## {% linkable_title Sensor %} +## Sensor The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices. @@ -280,7 +280,7 @@ The `nest` sensor platform lets you monitor sensors connected to your [Nest](htt The sensors will be setup if the `nest` integration is configured and the required configuration for the `nest sensor` is set.

-## {% linkable_title Configuration %} +## Configuration To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings: @@ -320,7 +320,7 @@ The following conditions are available by device: - color\_status: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app. - Nest Camera: none -## {% linkable_title Security State %} +## Security State

This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You for damages, diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 44b496ffa24a..fdb8a0ffbb43 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -35,7 +35,7 @@ There is currently support for the following device types within Home Assistant: - [Climate](#climate) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To enable the Netatmo component, add the following lines to your `configuration.yaml`: @@ -77,7 +77,7 @@ webhooks: default: false {% endconfiguration %} -### {% linkable_title Get API and Secret Key %} +### Get API and Secret Key To get your API credentials, you have to declare a new application in the [Netatmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular Netatmo account. Click on 'Create an App' at the top of the page. @@ -97,7 +97,7 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo

-### {% linkable_title Webhooks %} +### Webhooks The Welcome and Presence cameras can send instant events to Home Assistant by using webhooks. There are different types of events, each with slightly different data attached. To enable the webhooks add `webhooks: true` to your configuration. It is also required to have your camera enabled in Home Assistant. You can do this either by manually setting up the [platform](https://www.home-assistant.io/components/camera.netatmo/) or by enabeling [discovery](https://www.home-assistant.io/components/netatmo/#discovery). @@ -105,7 +105,7 @@ To be able to receive events from Netatmo, your Home Assistant instance needs to Events coming in from Netatmo will be available as events in Home Assistant and are fired as netatmo_*, along with their data. You can use this event to trigger automations. -#### {% linkable_title Events %} +#### Events The following events are available: @@ -143,7 +143,7 @@ The Welcome camera additionally has these attributes for `netatmo_person` events The `netatmo_other` event passes all the webhook data through for all webhook events that don't match any of the above. Set the [level of logging](https://www.home-assistant.io/components/logger/) for the `netatmo` integration to `debug` to view the data in the Home Assistant logs. -### {% linkable_title Services (only for webhooks) %} +### Services (only for webhooks) There are two services to manually add and drop the webhooks. This might be useful if your webhook has been banned and you want to readd the webhook without restarting Home Assistant. @@ -152,11 +152,11 @@ There are two services to manually add and drop the webhooks. This might be usef | addwebhook | Subscribe to webhooks. By default the automatically generated URL will be used. But you can pass `{"url": "https://yourdomain.com/yourwebhook/"}` as service data to the service call if you want to use a manually created [webhook trigger](https://www.home-assistant.io/docs/automation/trigger/#webhook-trigger). In this case you have to manually process the data that is sent by Netatmo. | dropwebhook | Unsubscribe existing webhooks. -## {% linkable_title Binary Sensor %} +## Binary Sensor This integration allows you to get the latest event seen by the camera. -### {% linkable_title Binary Sensor Advanced configuration %} +### Binary Sensor Advanced configuration If you want to select a specific sensor, set discovery to `false` for [netatmo](/components/netatmo/) @@ -215,11 +215,11 @@ If **home** and **cameras** is not provided, all cameras will be used. If multiple cameras are available then each monitored conditions will create a specific sensor for each camera -## {% linkable_title Camera %} +## Camera The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This integration allows you to view the current photo created by the Camera. -### {% linkable_title Camera Advanced configuration %} +### Camera Advanced configuration If you want to select a specific camera, set discovery to `false` for [netatmo](/components/netatmo/) @@ -263,11 +263,11 @@ camera: - camera_name2 ``` -## {% linkable_title Climate %} +## Climate The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This integration allows you to view the current temperature and setpoint. -### {% linkable_title Camera Advanced configuration %} +### Camera Advanced configuration If you want to select specific homes or specific rooms, set discovery to `false` for [netatmo](/components/netatmo/) @@ -313,7 +313,7 @@ climate: - room5_name ``` -## {% linkable_title Sensor %} +## Sensor The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation), a [Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) device or the public sensors of others available via the [Netatmo API](https://weathermap.netatmo.com/) even if you don't own a Netatmo device. @@ -327,7 +327,7 @@ Public sensors have to be set up manually. Currently the following conditions ar * windstrength * guststrength -## {% linkable_title Advanced sensor configuration %} +## Advanced sensor configuration If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: @@ -450,7 +450,7 @@ areas: default: avg {% endconfiguration %} -## {% linkable_title Find your modules name %} +## Find your modules name You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file. diff --git a/source/_components/netdata.markdown b/source/_components/netdata.markdown index 6246eb756f27..d69d9dc4e2f8 100644 --- a/source/_components/netdata.markdown +++ b/source/_components/netdata.markdown @@ -18,7 +18,7 @@ redirect_from: The `netdata` sensor platform allows you to display information collected by [Netdata](http://my-netdata.io/). -## {% linkable_title Setup %} +## Setup Getting the details to configure the sensors is a bit tricky as Netdata uses different name for the `element:` value that is required. To get the value for the `data_group:` use Netdata's web interface. `1.` marks the name for the `data_group:`. `2.` are the names for the element to show in Home Assistant. The name that is shown can be different than the name under which the metrics are available. @@ -70,7 +70,7 @@ Alternatively you can browse to the built in Netdata API in your browser `http:/ Once the `data_group` "system.load" and the `element` "load15" have been identified from the JSON it can be configured in your configuration.yaml like the example below. -## {% linkable_title Configuration %} +## Configuration Add the following to your `configuration.yaml`. @@ -130,7 +130,7 @@ resources: default: false {% endconfiguration %} -### {% linkable_title Full Example %} +### Full Example ```yaml # Example configuration.yaml entry diff --git a/source/_components/netgear_lte.markdown b/source/_components/netgear_lte.markdown index 56a195073cf2..d728a6c2dc46 100644 --- a/source/_components/netgear_lte.markdown +++ b/source/_components/netgear_lte.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: The integration supports sending notifications with SMS, reporting incoming SMS with events and reporting the modem and connection state in a number of sensors and binary sensors. -## {% linkable_title Configuration %} +## Configuration To enable the integration, add the following lines to your `configuration.yaml` file: @@ -131,9 +131,9 @@ binary_sensor: description: The current roaming state. {% endconfiguration %} -## {% linkable_title Events %} +## Events -### {% linkable_title Event `netgear_lte_sms` %} +### Event `netgear_lte_sms` Messages arriving in the modem inbox are sent as events of type `netgear_lte_sms` with the following content. @@ -144,9 +144,9 @@ Messages arriving in the modem inbox are sent as events of type `netgear_lte_sms | `from` | The sender of the message. | `message` | The SMS message content. -## {% linkable_title Services %} +## Services -### {% linkable_title Service `netgear_lte.connect_lte` %} +### Service `netgear_lte.connect_lte` This service asks the modem to establish its LTE connection, useful if the modem does not autoconnect. @@ -154,7 +154,7 @@ This service asks the modem to establish its LTE connection, useful if the modem | ---------------------- | -------- | ----------- | | `host` | yes | The modem that should connect (optional when just one modem is configured). -### {% linkable_title Service `netgear_lte.delete_sms` %} +### Service `netgear_lte.delete_sms` The integration makes a service available to delete messages from the modem inbox. This can be used to clean up after incoming SMS events. @@ -163,7 +163,7 @@ The integration makes a service available to delete messages from the modem inbo | `host` | yes | The modem that should have a message deleted (optional when just one modem is configured). | `sms_id` | no | Integer or list of integers with inbox IDs of messages to delete. -### {% linkable_title Service `netgear_lte.set_option` %} +### Service `netgear_lte.set_option` This service can set modem configuration options (otherwise available in the modem web UI). @@ -173,7 +173,7 @@ This service can set modem configuration options (otherwise available in the mod | `autoconnect` | yes | Autoconnect value: `never`/`home`/`always`, with `home` meaning "not roaming". | `failover` | yes | Failover mode: `wire` (wired connection only), `mobile` (mobile connection only), `auto` (wired connection with failover to mobile connection). -## {% linkable_title Examples %} +## Examples The following automation example processes incoming SMS messages with the [Conversation](/components/conversation/) integration and then deletes the message from the inbox. diff --git a/source/_components/nfandroidtv.markdown b/source/_components/nfandroidtv.markdown index dfd81f0853f3..fa396171800d 100644 --- a/source/_components/nfandroidtv.markdown +++ b/source/_components/nfandroidtv.markdown @@ -96,7 +96,7 @@ This is a fully customized JSON you can use to test how the final notification w } ``` -### {% linkable_title Service data for sending images %} +### Service data for sending images The following attributes can be placed inside `data` to send images. diff --git a/source/_components/niko_home_control.markdown b/source/_components/niko_home_control.markdown index 20a688fb88c4..3e5ea6913277 100644 --- a/source/_components/niko_home_control.markdown +++ b/source/_components/niko_home_control.markdown @@ -17,7 +17,7 @@ redirect_from: The `niko_home_control` platform allows you to integrate your [Niko Home Control](https://www.niko.eu/enus/products/niko-home-control) into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this lights, add the following lines to your `configuration.yaml`: diff --git a/source/_components/nilu.markdown b/source/_components/nilu.markdown index 001c590ff43d..65969efc2a20 100644 --- a/source/_components/nilu.markdown +++ b/source/_components/nilu.markdown @@ -18,7 +18,7 @@ redirect_from: The `nilu` air quality platform shows measurements of current air quality from NILU (Norsk Institutt for luftforskning/Norwegian Institute for Air Research) sensor stations within Norway. Makes data from the open API at [luftkvalitet.info](http://luftkvalitet.info/) and [nilu.no](https://nilu.no/) available in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml` file: @@ -59,29 +59,29 @@ air_quality: type: boolean {% endconfiguration %} -## {% linkable_title Health risk index explainations %} +## Health risk index explainations Under the attributes from a NILU station, there will be a `nilu pollution index`. This indicates how polluted the air is in the area around the sensor station. Following is a longer explanation of what the indexes mean. -### {% linkable_title Low %} +### Low Low or no health risk linked to measured air pollution. Outdoor activites are recommended. -### {% linkable_title Moderate %} +### Moderate Health effects may occur in some asthmatics and people with other respiratory diseases, as well as serious cardiovascular diseases. Outdoor activity can be recommended for the vast majority, but some should consider their activity in areas with high traffic or high emissions. -### {% linkable_title High %} +### High Health effects may occur in asthmatics and people with other respiratory diseases, as well as serious cardiovascular disease. Children with respiratory distress (asthma, bronchitis) and adults with severe cardiac or respiratory distress should reduce outdoor activity and not stay in the most polluted areas. -### {% linkable_title Extremely high %} +### Extremely high Sensitive groups in the population can have health effects. Respiratory irritation and discomfort may occur in healthy subjects. People with heart or respiratory distress should reduce outdoor activity and not stay in the most polluted areas. Source: [Explainations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx) -## {% linkable_title Available areas %} +## Available areas The `area` configuration is restricted to the areas NILU has defined. Here is the list of available areas: @@ -121,7 +121,7 @@ The `area` configuration is restricted to the areas NILU has defined. Here is th - `Zeppelinfjellet` - `Ålesund` -## {% linkable_title Configuration examples %} +## Configuration examples Example of adding health risk monitoring from sensor stations around the Home Assistant location. diff --git a/source/_components/nissan_leaf.markdown b/source/_components/nissan_leaf.markdown index c291d89c3830..250e22e8a9dc 100644 --- a/source/_components/nissan_leaf.markdown +++ b/source/_components/nissan_leaf.markdown @@ -25,7 +25,7 @@ The `nissan_leaf` integration offers integration with the [NissanConnect EV](htt * a device tracker to locate the car (only on later Leaf models) * services to request updates from the car and to request the car starts charging. -## {% linkable_title Configuration %} +## Configuration To use Nissan Leaf in your installation, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ update_interval_climate: type: time {% endconfiguration %} -## {% linkable_title Full configuration sample %} +## Full configuration sample A more advanced example for setting the update interval: @@ -90,7 +90,7 @@ nissan_leaf: force_miles: true ``` -## {% linkable_title Starting a Charge %} +## 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, except the device_tracker. @@ -100,7 +100,7 @@ You can use the `nissan_leaf.start_charge` service to send a request to the Niss vin: '1HGBH41JXMN109186' # replace ``` -## {% linkable_title Updating on-demand using Automation %} +## Updating on-demand using Automation You can also use the `nissan_leaf.update` service to request an on-demand update. To update almost exclusively via the service set the `update_interval` to a high value in the integration configuration. The service requests the VIN number as described above. @@ -121,7 +121,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update vin: '1HGBH41JXMN109186' # replace ``` -## {% linkable_title Hints %} +## 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._ diff --git a/source/_components/nmap_tracker.markdown b/source/_components/nmap_tracker.markdown index 84aafaa55fcb..3ac31cf5e751 100644 --- a/source/_components/nmap_tracker.markdown +++ b/source/_components/nmap_tracker.markdown @@ -59,7 +59,7 @@ scan_options: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples A full example for the `nmap` tracker could look like the following sample: @@ -90,7 +90,7 @@ In the above example, Nmap will be call with the process: An example of how the Nmap scanner can be customized: -### {% linkable_title Linux capabilities %} +### Linux capabilities On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap: diff --git a/source/_components/nmbs.markdown b/source/_components/nmbs.markdown index 061e6d332d26..06ba7603c29a 100644 --- a/source/_components/nmbs.markdown +++ b/source/_components/nmbs.markdown @@ -18,7 +18,7 @@ redirect_from: The `nmbs` platform will create sensors for monitoring travel time and information between 2 stations. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/noaa_tides.markdown b/source/_components/noaa_tides.markdown index 7ccddd4bbe61..2f6ca17d99ac 100644 --- a/source/_components/noaa_tides.markdown +++ b/source/_components/noaa_tides.markdown @@ -17,11 +17,11 @@ redirect_from: The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. -## {% linkable_title Setup %} +## Setup This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164` -## {% linkable_title Configuration %} +## Configuration To use this sensor, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.group.markdown b/source/_components/notify.group.markdown index d0b8d247d2bc..afda9b6f25b5 100644 --- a/source/_components/notify.group.markdown +++ b/source/_components/notify.group.markdown @@ -16,7 +16,7 @@ ha_qa_scale: internal The `group` notification platform allows you to combine multiple `notify` platforms into a single service. -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -50,7 +50,7 @@ services: type: string {% endconfiguration %} -## {% linkable_title Example %} +## Example An example on how to use it in an automation: diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 78877b65559e..5c5db2438714 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -18,7 +18,7 @@ The `knx` notify platform allows you to send notifications to [KNX](http://www.k The `knx` integration must be configured correctly, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index e0677d806cd6..5255e2482d5e 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -18,7 +18,7 @@ The `notify` integration makes it possible to send notifications to a wide varie If you want to send notifications to the Home Assistant Web Interface you may use the [Persistent Notification Component](/components/persistent_notification/). -## {% linkable_title Service %} +## Service Once loaded, the `notify` platform will expose a service that can be called to send notifications. @@ -41,7 +41,7 @@ action: title: "Custom subject" ``` -### {% linkable_title Test if it works %} +### Test if it works A simple way to test if you have set up your notify platform correctly, is to use service developer tool icon **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown index 0fe8e8318ab5..1a0f71e78752 100644 --- a/source/_components/notify.mysensors.markdown +++ b/source/_components/notify.mysensors.markdown @@ -19,7 +19,7 @@ Integrates MySensors notifications into Home Assistant. See the [main component] Setting the `target` key in the service call will target the name of the MySensors device in Home Assistant. MySensors device names follow the notation: "[Sketch name] [Node id] [Child id]". -### {% linkable_title Automation example %} +### Automation example ```yaml ... @@ -40,7 +40,7 @@ S_INFO | V_TEXT For more information, visit the [api] page of MySensors. -### {% linkable_title Example sketch %} +### Example sketch ```cpp /* diff --git a/source/_components/nsw_fuel_station.markdown b/source/_components/nsw_fuel_station.markdown index 96eb596d703e..cf6dd6193861 100644 --- a/source/_components/nsw_fuel_station.markdown +++ b/source/_components/nsw_fuel_station.markdown @@ -18,7 +18,7 @@ redirect_from: The `nsw_fuel_station` sensor platform uses the [NSW Fuel Check App](https://www.fuelcheck.nsw.gov.au/app) data as a source for current fuel price data. -## {% linkable_title Setup %} +## Setup To get the station ID for any NSW fuel station you will need to: @@ -27,7 +27,7 @@ To get the station ID for any NSW fuel station you will need to: - In the Fuel Check App, search for your postcode or click "Fuel Near Me". - In the developer console, you should see a request to `/FuelCheckApp/v1/fuel/prices/bylocation`. Open this request and preview the response. Find the station you wish to add, and copy down the `ServiceStationID` field. -## {% linkable_title Configuration %} +## Configuration To add the NSW fuel station price sensor to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/nsw_rural_fire_service_feed.markdown b/source/_components/nsw_rural_fire_service_feed.markdown index 264208357a3b..e14053f7c130 100644 --- a/source/_components/nsw_rural_fire_service_feed.markdown +++ b/source/_components/nsw_rural_fire_service_feed.markdown @@ -32,7 +32,7 @@ The entity's information can be used for example if a bush fire that produces sm The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your `configuration.yaml`. @@ -65,7 +65,7 @@ longitude: default: Longitude defined in your `configuration.yaml` {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -85,7 +85,7 @@ The following state attributes are available for each entity in addition to the | size | Size in hectare | | responsible_agency | Agency responsible for this incident. | -## {% linkable_title Advanced Configuration Example %} +## Advanced Configuration Example Depending on your personal circumstances with regards to bush fire risk you may want to adjust the radius and define the categories of fire warnings you are actually interested in. diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown index a6f6d25a2151..cee7f13126c8 100644 --- a/source/_components/nuheat.markdown +++ b/source/_components/nuheat.markdown @@ -57,19 +57,19 @@ devices: type: [string, int] {% endconfiguration %} -## {% linkable_title Concepts %} +## Concepts The NuHeat Thermostat supports the following key concepts. The `target temperature` is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (`auto mode`) or may be overridden. When the target temperature is set by Home Assistant, the thermostat will hold this temperature until the schedule is resumed. -## {% linkable_title Attributes %} +## Attributes The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `current_hold_mode`, `current_operation`, `operation_list`, `min_temp` and `max_temp`. -### {% linkable_title Attribute `name` %} +### Attribute `name` Returns the name of the NuHeat Thermostat. @@ -77,7 +77,7 @@ Returns the name of the NuHeat Thermostat. | ---------------| ----------- | | String | Name of the thermostat -### {% linkable_title Attribute `temperature_unit` %} +### Attribute `temperature_unit` Returns the unit of measurement used for temperature by the thermostat. @@ -85,7 +85,7 @@ Returns the unit of measurement used for temperature by the thermostat. | ---------------| ----------- | | String | Name of the temperature unit -### {% linkable_title Attribute `current_temperature` %} +### Attribute `current_temperature` Returns the current temperature measured by the thermostat. @@ -93,7 +93,7 @@ Returns the current temperature measured by the thermostat. | ---------------| ----------- | | Integer | Currently measured temperature -### {% linkable_title Attribute `target_temperature` %} +### Attribute `target_temperature` Returns the target temperature of the thermostat, when the thermostat is not in auto operation mode. @@ -102,7 +102,7 @@ not in auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `current_hold_mode` %} +### Attribute `current_hold_mode` Returns the current temperature hold, if any. @@ -110,7 +110,7 @@ Returns the current temperature hold, if any. | ---------------| ----------- | | String | 'temperature', 'temporary_temperature', 'auto', etc. -### {% linkable_title Attribute `current_operation` %} +### Attribute `current_operation` Returns the current operation of the thermostat. @@ -118,7 +118,7 @@ Returns the current operation of the thermostat. | ---------------| ----------- | | String | 'heat', 'idle' -### {% linkable_title Attribute `operation_list` %} +### Attribute `operation_list` Returns the list of available operation modes. @@ -126,7 +126,7 @@ Returns the list of available operation modes. | ---------------| ----------- | | List of String | Available operation modes -### {% linkable_title Attribute `min_temp` %} +### Attribute `min_temp` Returns the minimum supported temperature by the thermostat @@ -134,7 +134,7 @@ Returns the minimum supported temperature by the thermostat | ---------------| ----------- | | Integer | Minimum supported temperature -### {% linkable_title Attribute `max_temp` %} +### Attribute `max_temp` Returns the maximum supported temperature by the thermostat @@ -143,13 +143,13 @@ Returns the maximum supported temperature by the thermostat | Integer | Maximum supported temperature -## {% linkable_title Services %} +## Services The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hold_mode`, `nuheat_resume_program`. The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, `set_operation_mode` and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat. -### {% linkable_title Service `set_temperature` %} +### Service `set_temperature` Puts the thermostat into an indefinite hold at the given temperature. @@ -161,7 +161,7 @@ Puts the thermostat into an indefinite hold at the given temperature. Only the target temperatures relevant for the current operation mode need to be provided. -### {% linkable_title Service `set_hold_mode` %} +### Service `set_hold_mode` Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run the thermostat's programmed schedule), "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event). @@ -170,7 +170,7 @@ Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run t | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `hold_mode` | no | New value of hold mode. -### {% linkable_title Service `nuheat_resume_program` %} +### Service `nuheat_resume_program` Resumes the currently active schedule. diff --git a/source/_components/nuki.markdown b/source/_components/nuki.markdown index 0b862989f82c..1706f3635791 100644 --- a/source/_components/nuki.markdown +++ b/source/_components/nuki.markdown @@ -45,9 +45,9 @@ token: type: string {% endconfiguration %} -## {% linkable_title Services %} +## Services -### {% linkable_title Service `nuki_unlatch` %} +### Service `nuki_unlatch` This will unlatch the door, ie. open it (provided this works with your type of door). @@ -55,7 +55,7 @@ This will unlatch the door, ie. open it (provided this works with your type of d | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s Nuki Locks. -### {% linkable_title Service `nuki_lock_n_go` %} +### Service `nuki_lock_n_go` This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app. See the [Nuki Website](https://nuki.io/en/support/smart-lock/sl-features/locking-with-the-smart-lock/) for more details about this feature. diff --git a/source/_components/nut.markdown b/source/_components/nut.markdown index ebb70c5d2e18..b0863ba2a337 100644 --- a/source/_components/nut.markdown +++ b/source/_components/nut.markdown @@ -18,7 +18,7 @@ redirect_from: The `nut` sensor platform allows you to monitor a UPS (battery backup) by using data from a [NUT](http://networkupstools.org/) (Network UPS Tools) server. -## {% linkable_title Configuration %} +## Configuration To use this sensor platform, you need to add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ sensor: type: list {% endconfiguration %} -## {% linkable_title Example %} +## Example Given the following example output from NUT (your variables may differ): @@ -132,7 +132,7 @@ sensor: - battery.runtime ``` -## {% linkable_title UPS Status - human-readable version %} +## UPS Status - human-readable version An additional virtual sensor type `ups.status.display` is available translating the UPS status value retrieved from `ups.status` into a human-readable version. diff --git a/source/_components/nx584.markdown b/source/_components/nx584.markdown index 8d4d42816f5c..73c489f466f2 100644 --- a/source/_components/nx584.markdown +++ b/source/_components/nx584.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml`: @@ -52,7 +52,7 @@ port: default: 5007 {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor Enabling this binary sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger. @@ -98,7 +98,7 @@ zone_types: description: Safety {% endconfiguration %} -## {% linkable_title Full example %} +## Full example An extended configuration entry could look like this: diff --git a/source/_components/oasa_telematics.markdown b/source/_components/oasa_telematics.markdown index a00c9d38bd81..36cb1e3a18cb 100644 --- a/source/_components/oasa_telematics.markdown +++ b/source/_components/oasa_telematics.markdown @@ -17,7 +17,7 @@ ha_release: 0.92 The `oasa_telematics` sensor will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/). -## {% linkable_title Configuration %} +## Configuration Add a sensor to your `configuration.yaml` file as shown in the example: @@ -59,7 +59,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples A more extensive example on how to use this sensor: diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index e08c2fe09f26..95efbbdbd5ed 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: You must have the OctoPrint component configured (below) to use the sensor and binary sensor. After configuring that component, the sensors and binary sensors automatically appear.

-## {% linkable_title Configuration %} +## Configuration To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your `configuration.yaml`. @@ -151,7 +151,7 @@ camera: mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `octoprint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error. @@ -182,6 +182,6 @@ name: default: OctoPrint {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs. diff --git a/source/_components/ohmconnect.markdown b/source/_components/ohmconnect.markdown index 8ddfdbec2cca..065138acd8e9 100644 --- a/source/_components/ohmconnect.markdown +++ b/source/_components/ohmconnect.markdown @@ -20,7 +20,7 @@ The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmco OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that. -## {% linkable_title Configuration %} +## Configuration You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. diff --git a/source/_components/onewire.markdown b/source/_components/onewire.markdown index f571786b3231..cb2d92857ad4 100644 --- a/source/_components/onewire.markdown +++ b/source/_components/onewire.markdown @@ -30,18 +30,18 @@ Supported devices: The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g [DS9490R](https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf)). -## {% linkable_title Raspberry Pi setup %} +## Raspberry Pi setup In order to setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire). To edit `/boot/config.txt` on Hass.io use [this documentation](https://developers.home-assistant.io/docs/en/hassio_debugging.html) to enable SSH and edit `/mnt/boot/config.txt` via `vi`. -## {% linkable_title Interface adapter setup %} +## Interface adapter setup -### {% linkable_title owfs %} +### owfs When an interface adapter is used, sensors can be accessed on Linux hosts via [owfs 1-Wire file system](http://owfs.org/). When using an interface adapter and the owfs, the `mount_dir` option must be configured to correspond a directory, where owfs device tree has been mounted. -### {% linkable_title Units with multiple sensors %} +### Units with multiple sensors This platform works with devices with multiple sensors which will cause a discontinuity in recorded values. Existing devices will receive a new ID and therefore show up as new devices. If you wish to maintain continuity it can be resolved in the database by renaming the old devices to the new names. @@ -61,7 +61,7 @@ UPDATE states SET entity_id='sensor._humidity' WHERE entity_id LIKE Remember to replace `` with the actual name of the sensor as seen in the `SELECT` query. -## {% linkable_title Configuration %} +## Configuration To enable One wire sensors in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/onkyo.markdown b/source/_components/onkyo.markdown index 3f0d8dfe4628..822717cb5048 100644 --- a/source/_components/onkyo.markdown +++ b/source/_components/onkyo.markdown @@ -19,7 +19,7 @@ redirect_from: The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this integration to work in your Hardware. -## {% linkable_title Configuration %} +## Configuration To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file: @@ -83,7 +83,7 @@ List of source names: - xm - sirius -### {% linkable_title Service `onkyo_select_hdmi_output` %} +### Service `onkyo_select_hdmi_output` Changes HDMI output of your receiver @@ -97,7 +97,7 @@ Accepted values are: which one to use seems to vary depending on model so you will have to try them out. ( For model TX-NR676E it seems to be 'out' for main, 'out-sub' for sub, and 'sub' for both ) -### {% linkable_title Example `play_media` script %} +### Example `play_media` script The `play_media` function can be used in script to play radio station by preset number. Not working for NET radio. @@ -120,7 +120,7 @@ script: ``` -### {% linkable_title Example `onkyo_select_hdmi_output` script %} +### Example `onkyo_select_hdmi_output` script ```yaml # Example onkyo_select_hdmi_output script diff --git a/source/_components/onvif.markdown b/source/_components/onvif.markdown index e33e21c72871..f6721103f536 100644 --- a/source/_components/onvif.markdown +++ b/source/_components/onvif.markdown @@ -17,7 +17,7 @@ redirect_from: The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured. -## {% linkable_title Configuration %} +## Configuration To enable your ONVIF camera in your installation, add the following to your `configuration.yaml` file: @@ -67,7 +67,7 @@ extra_arguments: Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in config `profile` variable. -### {% linkable_title Service `camera.onvif_ptz` %} +### Service `camera.onvif_ptz` If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera. diff --git a/source/_components/openalpr_cloud.markdown b/source/_components/openalpr_cloud.markdown index 1c86ceeedc51..8ba6284898bf 100644 --- a/source/_components/openalpr_cloud.markdown +++ b/source/_components/openalpr_cloud.markdown @@ -22,7 +22,7 @@ or trigger any other [automation](/components/automation/). For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/openalpr_local.markdown b/source/_components/openalpr_local.markdown index 920d293d5c4e..6206c7feaefd 100644 --- a/source/_components/openalpr_local.markdown +++ b/source/_components/openalpr_local.markdown @@ -23,7 +23,7 @@ or trigger any other [automation](/components/automation/). For using the result inside an automation rule, take a look at the [component](/components/image_processing) page. -### {% linkable_title Local installation %} +### Local installation If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool. @@ -49,7 +49,7 @@ Verify your `alpr` installation with: $ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr - ``` -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/opencv.markdown b/source/_components/opencv.markdown index 97f5dd71cabb..e9047b10432a 100644 --- a/source/_components/opencv.markdown +++ b/source/_components/opencv.markdown @@ -19,7 +19,7 @@ redirect_from: Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data). -## {% linkable_title Configuration %} +## Configuration To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/openevse.markdown b/source/_components/openevse.markdown index a2b33f9467ff..dd5e1dd4bd9d 100644 --- a/source/_components/openevse.markdown +++ b/source/_components/openevse.markdown @@ -18,7 +18,7 @@ redirect_from: This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/opengarage.markdown b/source/_components/opengarage.markdown index b2c93df3c1ed..fc433c1d2e07 100644 --- a/source/_components/opengarage.markdown +++ b/source/_components/opengarage.markdown @@ -17,7 +17,7 @@ redirect_from: The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/openhardwaremonitor.markdown b/source/_components/openhardwaremonitor.markdown index eff34caca5ab..6abc3fafc861 100644 --- a/source/_components/openhardwaremonitor.markdown +++ b/source/_components/openhardwaremonitor.markdown @@ -18,7 +18,7 @@ redirect_from: The `openhardwaremonitor` platform uses your [Open Hardware Monitor](http://openhardwaremonitor.org/) installation as a source for sensors that will display system information. -## {% linkable_title Setup %} +## Setup OpenHardwareMonitor must be running on the host, with "Remote web server" active. You also need to open inbound port (TCP 8085) on the host.. @@ -40,7 +40,7 @@ sudo firewall-cmd --permanent --add-port=8085/tcp sudo firewall-cmd --reload ``` -## {% linkable_title Configuration %} +## Configuration To add Open Hardware Monitor to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/opensensemap.markdown b/source/_components/opensensemap.markdown index de1687f07da9..ff26c8b9d3fb 100644 --- a/source/_components/opensensemap.markdown +++ b/source/_components/opensensemap.markdown @@ -19,11 +19,11 @@ redirect_from: The `opensensemap` air quality platform will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station. -## {% linkable_title Setup %} +## Setup To get the ID of a station you need to select it on the [openSense map](https://opensensemap.org/) and find it in the addressbar of your browser. It's the last part of the URL, e.g., `5b450e565dc1ec001bf7cd1d` [https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d](https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d). -## {% linkable_title Manual Configuration %} +## Manual Configuration To enable this platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/opensky.markdown b/source/_components/opensky.markdown index 50643203c778..13613a87df42 100644 --- a/source/_components/opensky.markdown +++ b/source/_components/opensky.markdown @@ -18,7 +18,7 @@ redirect_from: The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -36,7 +36,7 @@ Configuration options for the OpenSky Network sensor: - **altitude** (*Optional*): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0). - **name** (*Optional*): Sensor name. Defaults to opensky. -## {% linkable_title Events %} +## Events - **opensky_entry**: Fired when a flight enters the region. - **opensky_exit**: Fired when a flight exits the region. diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index c478bca543d6..0320bdddc63b 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -35,7 +35,7 @@ When enabled, this integration will automatically add its [`climate` entity](/co The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.

-# {% linkable_title Configuration %} +# Configuration ```yaml # Example configuration.yaml entry @@ -271,19 +271,19 @@ monitored_variables: description: Solar storage unit temperature. {% endconfiguration %} -## {% linkable_title Supported Variables %} +## Supported Variables The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` integration and look for the status updates. -# {% linkable_title Services %} +# Services -### {% linkable_title Service `opentherm_gw.reset_gateway` %} +### Service `opentherm_gw.reset_gateway` Reset the OpenTherm Gateway. This service takes no parameters. -### {% linkable_title Service `opentherm_gw.set_clock` %} +### Service `opentherm_gw.set_clock` Provide the time and day of week to the OpenTherm Gateway. The value provided here will be forwarded to the thermostat on the next date/time request from the thermostat. The OpenTherm Gateway does not have the ability to accurately keep track of time, so it will only retain the information provided here for a maximum of about 61 seconds. @@ -292,7 +292,7 @@ Provide the time and day of week to the OpenTherm Gateway. The value provided he | `date` | yes | Today's date | Date from which the day of week will be extracted. Format: `YYYY-MM-DD`. | `time` | yes | Current time | Time in 24h format. -### {% linkable_title Service `opentherm_gw.set_control_setpoint` %} +### Service `opentherm_gw.set_control_setpoint`

Improper use of this service may continuously keep your central heating system active, resulting in an overheated house and a significant increase in gas and/or electricity consumption. @@ -310,7 +310,7 @@ In a normal situation, the thermostat will calculate and control the central hea Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.

-### {% linkable_title Service `opentherm_gw.set_gpio_mode` %} +### Service `opentherm_gw.set_gpio_mode` Configure the GPIO behavior on the OpenTherm Gateway. For an explanation of the possible modes, see [GPIO modes](#gpio-modes) @@ -320,7 +320,7 @@ For an explanation of the possible modes, see [GPIO modes](#gpio-modes) | `id` | no | The GPIO ID, `A` or `B`. | `mode` | no | The GPIO mode to be set. -### {% linkable_title Service `opentherm_gw.set_led_mode` %} +### Service `opentherm_gw.set_led_mode` Configure the function of the LEDs on the OpenTherm Gateway. For a list of possible modes with explanation, see [LED modes](#led-modes) @@ -330,7 +330,7 @@ For a list of possible modes with explanation, see [LED modes](#led-modes) | `id` | no | The LED ID, accepted values are `A` through `F`. | `mode` | no | The LED mode to be set. -### {% linkable_title Service `opentherm_gw.set_max_modulation` %} +### Service `opentherm_gw.set_max_modulation`

Improper use of this service may impair the performance of your central heating system. @@ -348,7 +348,7 @@ In a normal situation, the thermostat will control the maximum modulation level Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.

-### {% linkable_title Service `opentherm_gw.set_outside_temperature` %} +### Service `opentherm_gw.set_outside_temperature` Provide the outside temperature to the thermostat. If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect. Note that not all thermostats are able to display the full supported range. @@ -357,7 +357,7 @@ If your thermostat is unable to display an outside temperature and does not supp | ---------------------- | -------- | ----------- | | `temperature` | no | The outside temperature to provide to the thermostat. Accepted values are `-40.0` through `64.0`. Any value above `64.0` will clear a previously configured value (suggestion: `99`). -### {% linkable_title Service `opentherm_gw.set_setback_temperature` %} +### Service `opentherm_gw.set_setback_temperature` Configure the setback temperature on the OpenTherm Gateway. The value you provide here will be used with the GPIO `home` (5) and `away` (6) modes. @@ -366,7 +366,7 @@ The value you provide here will be used with the GPIO `home` (5) and `away` (6) | ---------------------- | -------- | ----------- | | `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`. -## {% linkable_title GPIO modes %} +## GPIO modes Possible modes and their meaning for the GPIO pins are listed here: {% comment %} @@ -382,7 +382,7 @@ Possible modes and their meaning for the GPIO pins are listed here: * 7\. Away - Set thermostat to setback temperature when pulled high. * 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc. -## {% linkable_title LED modes %} +## LED modes Possible LED modes and their meaning are listed here: @@ -403,7 +403,7 @@ Possible LED modes and their meaning are listed here: The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.

-# {% linkable_title Example %} +# Example A full configuration example with the OpenTherm Gateway connected to a remote host running `ser2net` looks like the one below. diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index 472c1d065252..7c83aa13f27e 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -22,7 +22,7 @@ redirect_from: The `openuv` integration displays UV and Ozone data from [openuv.io](http://openuv.io). -## {% linkable_title Generating an API Key %} +## Generating an API Key To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google). @@ -52,7 +52,7 @@ Ensure that you understand these specifications when calling the `update_data` service.

-## {% linkable_title Configuration %} +## Configuration To retrieve data from OpenUV, add the following to your `configuration.yaml` file: @@ -117,7 +117,7 @@ The approximate number of minutes of a particular skin type can be exposed to the sun before burning/tanning starts is based on the [Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale). -## {% linkable_title Full Configuration Example %} +## Full Configuration Example To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of the @@ -149,13 +149,13 @@ decision making. They should not replace analysis, advice or diagnosis from a trained medical professional.

-## {% linkable_title Services %} +## Services -### {% linkable_title `openuv.update_data` %} +### `openuv.update_data` Perform an on-demand update of OpenUV data. -## {% linkable_title Examples of Updating Data %} +## Examples of Updating Data One method to retrieve data every 30 minutes and still leave plenty of API key usage is to only retrieve data during the daytime: diff --git a/source/_components/openweathermap.markdown b/source/_components/openweathermap.markdown index dbbd87b16eea..4581bfe0c782 100644 --- a/source/_components/openweathermap.markdown +++ b/source/_components/openweathermap.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up). -## {% linkable_title Weather %} +## Weather To add OpenWeatherMap to your installation, add the following to your `configuration.yaml` file: @@ -69,7 +69,7 @@ longitude: This platform is an alternative to the [`openweathermap`](/components/sensor.openweathermap/) sensor.

-## {% linkable_title Sensor %} +## Sensor The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3h. diff --git a/source/_components/openwrt.markdown b/source/_components/openwrt.markdown index 4ac10e29a27b..81df537190d6 100644 --- a/source/_components/openwrt.markdown +++ b/source/_components/openwrt.markdown @@ -38,7 +38,7 @@ There are _multiple_ ways of integrating an OpenWRT router for presence detectio * [openwrt_hass_devicetracker](https://github.com/mueslo/openwrt_hass_devicetracker) * your own custom script -### {% linkable_title Event-based device tracker %} +### Event-based device tracker This can be achieved by running a simple shell script on the OpenWRT router which calls the appropriate Home Assistant service. An OpenWRT package which does this is listed above. As this method directly calls the [service API](/developers/rest_api.markdown#post-apiservicesltdomainltservice), no special configuration is necessary on the Home Assistant side, except for ensuring the device_tracker API is running, which is achieved by adding the following to your `configuration.yaml` file: diff --git a/source/_components/orangepi_gpio.markdown b/source/_components/orangepi_gpio.markdown index 168e16ff7562..8a3c0c0684b5 100644 --- a/source/_components/orangepi_gpio.markdown +++ b/source/_components/orangepi_gpio.markdown @@ -16,11 +16,11 @@ ha_iot_class: Local Push The `orangepi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `orangepi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi. -## {% linkable_title Configuration %} +## Configuration To use your Orange Pi's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -57,7 +57,7 @@ invert_logic: Compared to the [Raspberry Pi GPIO](/components/rpi_gpio/) component, this integration does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing. -## {% linkable_title Pin_mode %} +## Pin_mode As this platform supports different types of GPIO pinouts for difference Orange Pi or Nano Pi devices, we use the `pin_mode` value to specify which one to use. Enabled values are: @@ -69,7 +69,7 @@ As this platform supports different types of GPIO pinouts for difference Orange | `duo` | Supports the NanoPi Duo | | `neocore2` | Supports the NanoPi Neocore 2 | -## {% linkable_title Additional steps %} +## Additional steps This integration uses the `SYSFS` filesystem to get control of the GPIOs. Therefore an operatings system with `CONFIG_GPIO_SYSFS` is required. As far as I know, most out-of-the-box distributions still enable this by default. As of Linux 4.8 sysfs-gpio is marked as obsolete. However as of today, the alternative GPIO character device is not widely used. Therefore we will use this until the new character device is more widely supported. diff --git a/source/_components/otp.markdown b/source/_components/otp.markdown index 204925a2a2b1..41e4a27980d6 100644 --- a/source/_components/otp.markdown +++ b/source/_components/otp.markdown @@ -19,7 +19,7 @@ redirect_from: The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. -## {% linkable_title Configuration %} +## Configuration To enable the OTP sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/owlet.markdown b/source/_components/owlet.markdown index 94ae8376a92e..e822dfcfc850 100644 --- a/source/_components/owlet.markdown +++ b/source/_components/owlet.markdown @@ -22,17 +22,17 @@ Configuring this integration will enable tracking of heart rate, oxygen level, m This integration enables the following platforms automatically: -#### {% linkable_title Binary Sensors %} +#### Binary Sensors - Base Station Status - Motion -#### {% linkable_title Sensors %} +#### Sensors - Heart rate - Oxygen level -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/owntracks.markdown b/source/_components/owntracks.markdown index fafb7ab95738..244e72fea58b 100644 --- a/source/_components/owntracks.markdown +++ b/source/_components/owntracks.markdown @@ -24,11 +24,11 @@ By default the integration will listen for incoming messages from OwnTracks via -## {% linkable_title Configuration %} +## Configuration To configure OwnTracks, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration (below). -### {% linkable_title Configuring the app - Android %} +### Configuring the app - Android [Install the OwnTracks application for Android.](https://play.google.com/store/apps/details?id=org.owntracks.android) @@ -44,7 +44,7 @@ In the OwnTracks app, open sidebar and click on preferences, then on connection. Your tracker device will be known in home assistant as `_`. If you entered a Tracker ID the tid attribute will be set to that ID. -### {% linkable_title Configuring the app - iOS %} +### Configuring the app - iOS [Install the OwnTracks application for iOS.](https://itunes.apple.com/us/app/owntracks/id692424691?mt=8) @@ -55,7 +55,7 @@ In the OwnTracks app, tap the (i) in the top left and click on settings. Change - Turn on authentication - User ID: `` -## {% linkable_title Advanced configuration %} +## Advanced configuration OwnTracks allows the user to set advanced configuration by adding a section to your `configuration.yaml`. @@ -115,7 +115,7 @@ owntracks: office: work ``` -## {% linkable_title Using Owntracks regions %} +## Using Owntracks regions Owntracks can track regions, and send region entry and exit information to Home Assistant. You set up a region in the Owntracks app which you should name the same as your Home Assistant Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/). @@ -123,7 +123,7 @@ Home Assistant will use the enter and leave messages to set your zone location. When you exit a zone, Home Assistant will start using location updates to track you again. To make sure that Home Assistant correctly exits a zone (which it calculates based on your GPS coordinates), you may want to set your Zone radius in HA to be slightly smaller that the Owntracks region radius. -## {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %} +## Using Owntracks regions - forcing Owntracks to update using iBeacons

Owntracks v2.0.0 removes support for iBeacons on Android. @@ -139,7 +139,7 @@ When you exit an iBeacon region HA will switch back to using GPS to determine yo Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection. -## {% linkable_title Using Owntracks iBeacons to track devices %} +## Using Owntracks iBeacons to track devices iBeacons don't need to be stationary. You could put one on your key ring, or in your car. @@ -149,11 +149,11 @@ To use mobile iBeacons with HA, you just set up a region that doesn't match your This allows you to write zone automations for devices that can't track themselves (for example *alert me if I leave the house and my keys are still at home*). Another example would be *open the gates if my car arrives home*. -## {% linkable_title Using mobile and fixed iBeacons together %} +## Using mobile and fixed iBeacons together You can use iBeacons of both types together, so if you have a Zone `drive` with an iBeacon region called `-drive` and you arrive home with a mobile iBeacon called `-car`, then `device_tracker.beacon_car` will be set to a state of `drive`. -## {% linkable_title Importing Owntracks waypoints as zones %} +## Importing Owntracks waypoints as zones By default, any Owntracks user connected to Home Assistant can export their waypoint definitions (from the *Export - Export to Endpoint* menu item) which will then be translated to zone definitions in Home Assistant. The zones will be named `- - `. This functionality can be controlled in 2 ways: diff --git a/source/_components/panasonic_bluray.markdown b/source/_components/panasonic_bluray.markdown index 16d043a95187..9120ea72a6a6 100644 --- a/source/_components/panasonic_bluray.markdown +++ b/source/_components/panasonic_bluray.markdown @@ -49,6 +49,6 @@ name: type: string {% endconfiguration %} -### {% linkable_title Supported operations %} +### Supported operations - These devices support play, pause, stop and power on/off operations. They will also report the current status, title duration and current playing position. diff --git a/source/_components/panasonic_viera.markdown b/source/_components/panasonic_viera.markdown index 359356075ea1..c6a8761dba1f 100644 --- a/source/_components/panasonic_viera.markdown +++ b/source/_components/panasonic_viera.markdown @@ -74,7 +74,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Example `play_media` script %} +### Example `play_media` script The `play_media` function can be used to open web pages and other media types (images, movies) in the TV web browser. diff --git a/source/_components/pandora.markdown b/source/_components/pandora.markdown index 7d8849a67b25..fbb8664e2614 100644 --- a/source/_components/pandora.markdown +++ b/source/_components/pandora.markdown @@ -19,7 +19,7 @@ redirect_from: If you have a Pandora account, you can control it from Home Assistant with this media player. -### {% linkable_title Installation of Pianobar %} +### Installation of Pianobar This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2/3 with Raspbian Jessie as follows . _(Note: Other platforms may have different installation processes)_ @@ -53,7 +53,7 @@ user = you@youraccount.com Test it out by running `pianobar` in the command line. You should be able to listen to your Pandora stations. -### {% linkable_title Configuration in Home Assistant %} +### Configuration in Home Assistant The Pandora player can be loaded by adding the following lines to your `configuration.yaml`: diff --git a/source/_components/pencom.markdown b/source/_components/pencom.markdown index fb1cb2da5072..300fef6149b1 100644 --- a/source/_components/pencom.markdown +++ b/source/_components/pencom.markdown @@ -18,7 +18,7 @@ redirect_from: [Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read. -## {% linkable_title Configuration %} +## Configuration The Pencom relays can be daisy-chained to allow for up to 8 boards. diff --git a/source/_components/persistent_notification.markdown b/source/_components/persistent_notification.markdown index e13a48dbe6a6..4138fef8711d 100644 --- a/source/_components/persistent_notification.markdown +++ b/source/_components/persistent_notification.markdown @@ -20,7 +20,7 @@ The `persistent_notification` can be used to show a message on the frontend that

-### {% linkable_title Service %} +### Service The service `persistent_notification/create` takes in `message`, `title`, and `notification_id`. @@ -81,7 +81,7 @@ This automation example shows a notification when the Z-Wave network is starting notification_id: zwave ``` -### {% linkable_title Markdown support %} +### Markdown support The message attribute supports the [Markdown formatting syntax](https://daringfireball.net/projects/markdown/syntax). Some examples are: @@ -100,7 +100,7 @@ The message attribute supports the [Markdown formatting syntax](https://daringfi

-### {% linkable_title Create a persistent notification %} +### Create a persistent notification Choose service developer tool icon **Services** from the **Developer Tools** to call the `persistent_notification` service. Select `persistent_notification/create` from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/person.markdown b/source/_components/person.markdown index 6b0ca02a1f80..0d240eb73518 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -36,7 +36,7 @@ TL;DR: When you're at home, your position is determined first by stationary trac You can manage persons via the UI from the person page inside the configuration panel or via `YAML` in your `configuration.yaml` file. -## {% linkable_title Configuring the `person` integration via the Home Assistant configuration panel %} +## Configuring the `person` integration via the Home Assistant configuration panel If you prefer to use the configuration panel to configure the `person` integration simply add one line to your `configuration.yaml` file and restart Home Assistant. @@ -44,7 +44,7 @@ If you prefer to use the configuration panel to configure the `person` integrati person: ``` -## {% linkable_title Configuring the `person` integration via YAML %} +## Configuring the `person` integration via YAML If you prefer YAML, you can also configure your persons via `configuration.yaml`: diff --git a/source/_components/pi_hole.markdown b/source/_components/pi_hole.markdown index 82d8aa32231c..9fc4c447797a 100644 --- a/source/_components/pi_hole.markdown +++ b/source/_components/pi_hole.markdown @@ -18,7 +18,7 @@ redirect_from: The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: @@ -75,7 +75,7 @@ monitored_conditions: description: Total number of seen clients. {% endconfiguration %} -### {% linkable_title Full example %} +### Full example ```yaml # Example configuration.yaml entry diff --git a/source/_components/picotts.markdown b/source/_components/picotts.markdown index 2dee48aaa6db..72bd863e746f 100644 --- a/source/_components/picotts.markdown +++ b/source/_components/picotts.markdown @@ -19,7 +19,7 @@ The `picotts` text-to-speech platform uses offline pico Text-to-Speech engine to This requires to install the pico tts library on the system, typically on debian just do `sudo apt-get install libttspico-utils` On some Raspbian release, this package is missing but you can just copy the arm deb package from debian. -## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with Pico, add the following lines to your `configuration.yaml`: @@ -37,7 +37,7 @@ language: default: "`en-US`" {% endconfiguration %} -## {% linkable_title Full configuration example %} +## Full configuration example The configuration sample below shows how an entry can look like: diff --git a/source/_components/piglow.markdown b/source/_components/piglow.markdown index e9dfb6c52fe3..2f239c948a58 100644 --- a/source/_components/piglow.markdown +++ b/source/_components/piglow.markdown @@ -19,7 +19,7 @@ redirect_from: The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant. -## {% linkable_title Configuration %} +## Configuration To add piglow to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 4e1df44ff2f5..f8b9ba414b40 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file: @@ -82,7 +82,7 @@ pilight: - 42 ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `pilight` binary sensor platform implement the [pilight hub](#configuration) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). @@ -131,7 +131,7 @@ reset_delay_sec: default: 30 {% endconfiguration %} -### {% linkable_title Full example %} +### Full example A full configuration example could look like this: @@ -148,7 +148,7 @@ binary_sensor: reset_delay_sec: 30 ``` -## {% linkable_title Sensor %} +## Sensor This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. @@ -183,7 +183,7 @@ unit_of_measurement: type: string {% endconfiguration %} -### {% linkable_title Example: Weather station %} +### Example: Weather station This section shows a real life example how to use values of a weather station. @@ -210,7 +210,7 @@ sensor: unit_of_measurement: '%' ``` -## {% linkable_title Switch %} +## Switch The `pilight` switch platform is issuing 433 MHz commands using [pilight](https://www.pilight.org/) to turn a 433 MHz device on or off. The Pilight Home Assistant hub has to be set up. @@ -282,7 +282,7 @@ Variables for the different receive codes (`on_code_receive` and `off_code_recei This is useful if you have paired your sender directly with the receiver to prevent sending the signal twice. -### {% linkable_title Examples %} +### Examples ```yaml switch: @@ -313,7 +313,7 @@ switch: state: 'off' ``` -## {% linkable_title Troubleshooting %} +## Troubleshooting - A list of tested RF transceiver hardware is available [here](https://manual.pilight.org/electronics/index.html). This might be useful before buying. - Sending commands is simple when the protocol is known by pilight, but receiving commands can be rather difficult. It can happen that the code is not correctly recognized due to different timings in the sending hardware or the RF receiver. If this happens follow these steps: diff --git a/source/_components/ping.markdown b/source/_components/ping.markdown index b74dbe40d37c..9d843846aa3b 100644 --- a/source/_components/ping.markdown +++ b/source/_components/ping.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Presence Detection](#presence-detection) -## {% linkable_title Binary Sensor %} +## Binary Sensor The `ping` binary sensor platform allows you to use `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system. @@ -76,7 +76,7 @@ binary_sensor: When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.

-## {% linkable_title Presence Detection %} +## Presence Detection The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work. @@ -84,7 +84,7 @@ The `ping` device tracker platform offers presence detection by using `ping` to Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.

-### {% linkable_title Configuration %} +### Configuration To use this presence detection in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/pjlink.markdown b/source/_components/pjlink.markdown index 7e434f164b4a..f597e9c2b307 100644 --- a/source/_components/pjlink.markdown +++ b/source/_components/pjlink.markdown @@ -18,7 +18,7 @@ redirect_from: The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](http://pjlink.jbmia.or.jp/english/index.html). -## {% linkable_title Configuration %} +## Configuration To add a PJLink projector to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/plaato.markdown b/source/_components/plaato.markdown index 7fab3e8bd764..e2a310a85f66 100644 --- a/source/_components/plaato.markdown +++ b/source/_components/plaato.markdown @@ -18,7 +18,7 @@ This integration sets up integration with [Plaato Airlock](https://www.plaato.io Plaato Airlock is a tool for beer brewers that wants a unique insight into the fermentation process. With this integration, you get all your fermentation data available in Home Assistant! -## {% linkable_title Configuration %} +## Configuration To configure Plaato Airlock, you must set it up via the integrations panel in the Home Assistant frontend. diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 488aa2be4a53..c694c3b8c8f6 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -16,7 +16,7 @@ ha_qa_scale: internal This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. -## {% linkable_title Configuration %} +## Configuration To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file: @@ -112,7 +112,7 @@ entity_id: type: integer {% endconfiguration %} -## {% linkable_title Examples %} +## Examples ### Using plain MQTT sensor to get the data This is a practical example that uses a multiple of `MQTT sensors` to supply the readings used by the `plant` sensor. Another good source of this data would be the [Mi Flora](/components/sensor.miflora/) component. diff --git a/source/_components/plex.markdown b/source/_components/plex.markdown index 2533f91807b0..0e551978e04d 100644 --- a/source/_components/plex.markdown +++ b/source/_components/plex.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Media Player](#setup---media-player) - [Sensor](#sensor) -## {% linkable_title Setup - Media Player %} +## Setup - Media Player The preferred way to setup the Plex platform is by enabling the [discovery component](/components/discovery/) which requires GDM enabled on your Plex server. This can be found on your Plex Web App under Settings > (server Name) > settings > Network and choose "Enable local network discovery (GDM)". @@ -85,7 +85,7 @@ verify: type: boolean {% endconfiguration %} -### {% linkable_title Customization %} +### Customization You can customize the Plex integration by adding any of the variables below to your configuration: @@ -122,7 +122,7 @@ client_remove_interval: type: integer {% endconfiguration %} -### {% linkable_title Service `play_media` %} +### Service `play_media` Plays a song, playlist, TV episode, or video on a connected client. @@ -171,7 +171,7 @@ Plays a song, playlist, TV episode, or video on a connected client. | Plex Web | None | | Tivo Plex App | Only play, pause, stop/off controls enabled | -### {% linkable_title Notes %} +### Notes * At this moment, the Plex platform only supports one Plex Media Server. * It is possible to get errors that look like the following. @@ -184,7 +184,7 @@ Plays a song, playlist, TV episode, or video on a connected client. If this occurs, check the setting `Server`>`Network`>`Secure connections` on your Plex Media Server: if it is set to `Preferred` or `Required`, you may need to manually set the `ssl` and `verify` booleans in the `plex.conf` file to, respectively, `true` and `false`. See the **"Setup"** section above for details. * Movies must be located under 'Movies' section in the Plex library to properly get 'playing' state. -## {% linkable_title Sensor %} +## Sensor The `plex` sensor platform will monitor activity on a given [Plex Media Server](https://plex.tv/). It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details it will show you who is watching what. diff --git a/source/_components/plum_lightpad.markdown b/source/_components/plum_lightpad.markdown index 59b3314b18d4..f8c501c1abb7 100644 --- a/source/_components/plum_lightpad.markdown +++ b/source/_components/plum_lightpad.markdown @@ -26,7 +26,7 @@ Configurable/Dimmable WiFi Lightswitch - Wifi & Bluetooth connectivity - Phone Apps for iOS & Android -## {% linkable_title Configuration %} +## Configuration To enable Plum Lightpad support, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/pocketcasts.markdown b/source/_components/pocketcasts.markdown index b39cae4a8558..64ad0a07c3af 100644 --- a/source/_components/pocketcasts.markdown +++ b/source/_components/pocketcasts.markdown @@ -18,7 +18,7 @@ redirect_from: The `pocketcasts` sensor platform lets one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/). -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 1b2778127039..9882b0b518f7 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Sensor](#sensor) -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry @@ -52,7 +52,7 @@ client_secret: type: string {% endconfiguration %} -# {% linkable_title Device types %} +# Device types The integration supports the following device types within Home Assistant: - [Alarm](#alarm) @@ -63,7 +63,7 @@ The integration supports the following device types within Home Assistant: The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.

-## {% linkable_title Alarm %} +## Alarm Each home configured in the Point mobile application will show up as a separate alarm control panel. The panels allow **arming** and **disarming** of the Point home alarm system. @@ -71,7 +71,7 @@ Each home configured in the Point mobile application will show up as a separate The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is implememented.

-## {% linkable_title Binary Sensor %} +## Binary Sensor Each Point exposes the following binary sensors: @@ -90,7 +90,7 @@ Each Point exposes the following binary sensors: The binary sensors **button_press**, **sound** and **tamper** are switched `On` for a breif moment and are then switched back to `Off`.

-### {% linkable_title Automation example %} +### Automation example The following example show how to implement an automation for the **button_press** binary sensor. @@ -111,7 +111,7 @@ automation: ``` {% endraw %} -### {% linkable_title Webhook events %} +### Webhook events The events shown as [binary sensors](#binary-sensor) are sent to Home Assistant as webhooks with the `event_type` set to `point_webhook_received`. Below is an example of how to use such a webhook do note the `trigger.event.data.event.device_id` which translates to the id of the Point device that sent the event. @@ -135,7 +135,7 @@ automation: ``` {% endraw %} -## {% linkable_title Sensor %} +## Sensor Each Point exposes the following sensors: diff --git a/source/_components/polling.markdown b/source/_components/polling.markdown index 0108a7bf825f..f4e4b23aa93a 100644 --- a/source/_components/polling.markdown +++ b/source/_components/polling.markdown @@ -19,7 +19,7 @@ Telegram chatbot polling implementation. One of two bot implementations supported by Telegram. Your Home Assistant does not have to be exposed to the internet. -## {% linkable_title Configuration %} +## Configuration To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/postnl.markdown b/source/_components/postnl.markdown index e39a79ae3901..0ff4c3c6ee81 100644 --- a/source/_components/postnl.markdown +++ b/source/_components/postnl.markdown @@ -20,7 +20,7 @@ The `postnl` platform allows one to track deliveries by [PostNL](https://www.pos The sensor value shows the number of packages to be delivered. The packages are available in the shipments attribute. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/prezzibenzina.markdown b/source/_components/prezzibenzina.markdown index fa5affd3061e..bde2995dbada 100644 --- a/source/_components/prezzibenzina.markdown +++ b/source/_components/prezzibenzina.markdown @@ -18,7 +18,7 @@ redirect_from: The `prezzibenzina` platform allows you to monitor the fuel prices with [PrezziBenzina.it](https://www.prezzibenzina.it/) from within Home Assistant and setup automations based on the information. -## {% linkable_title Setup %} +## Setup To use this sensor you need the station ID. To get this information go to [PrezziBenzina.it](https://www.prezzibenzina.it/) with your browser and find your station. Then copy the ID from the URL bar. @@ -26,7 +26,7 @@ To use this sensor you need the station ID. To get this information go to [Prezz https://www.prezzibenzina.it/distributori/STATION_ID/ ``` -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -52,7 +52,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Full example %} +## Full example This is a full example of the sensor: diff --git a/source/_components/prowl.markdown b/source/_components/prowl.markdown index 59d427b5446a..a3b86309372f 100644 --- a/source/_components/prowl.markdown +++ b/source/_components/prowl.markdown @@ -41,7 +41,7 @@ api_key: type: string {% endconfiguration %} -### {% linkable_title Prowl service data %} +### Prowl service data The following attributes can be placed `data` for extended functionality. diff --git a/source/_components/proxy.markdown b/source/_components/proxy.markdown index 1b958e342bc6..e2d46e7abffc 100644 --- a/source/_components/proxy.markdown +++ b/source/_components/proxy.markdown @@ -20,7 +20,7 @@ The current post-processing supports resizing and/or cropping the image/MJPEG as The current proxy capabilities are intended to reduce the camera bandwidth for slower internet connections. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, you must first have an existing working camera configured in Home Assistant. Next, add the following to your `configuration.yaml` file: @@ -97,7 +97,7 @@ cache_images: type: boolean {% endconfiguration %} -## {% linkable_title Examples %} +## Examples Example of using two Camera proxies along with a Foscam camera: diff --git a/source/_components/ps4.markdown b/source/_components/ps4.markdown index 764a1aff2a6c..62b9f110f403 100644 --- a/source/_components/ps4.markdown +++ b/source/_components/ps4.markdown @@ -19,12 +19,12 @@ The `ps4` integration allows you to control a - This integration supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release. -## {% linkable_title Requirements %} +## Requirements - Android or iOS device - PS4 Second Screen App for [Android](https://play.google.com/store/apps/details?id=com.playstation.mobile2ndscreen&hl=en_US) or [iOS](https://itunes.apple.com/us/app/ps4-second-screen/id1201372796?mt=8) installed on device. -## {% linkable_title Set up %} +## Set up 1. Download the Second Screen App and make sure that you can find and control your PlayStation 4 normally. @@ -39,7 +39,7 @@ The `ps4` integration allows you to control a 4. Pair Home Assistant to your PlayStation 4 by filling in the fields. - **Note:** To find your correct region refer to the section [Regions](#regions) -## {% linkable_title Granting Port Access %} +## Granting Port Access The PlayStation 4 integration requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance you may need to allow usage of privileged ports manually. @@ -53,7 +53,7 @@ There are varying methods to perform this, dependent on your OS that is running If your Home Assistant device is running Hass.io on HassOS, it does not require additional configuration.

-### {% linkable_title Debian-based %} +### Debian-based Home Assistant installed on a Debian-type OS may require configuration. This section is applicable but not limited to the following operating systems: - Debian @@ -104,17 +104,17 @@ To find your system Python path: The output will be your system Python path. -### {% linkable_title Docker %} +### Docker When running Home Assistant using Docker, make sure that the Home Assistant container is discoverable by the PS4. This can be achieved by ensuring that the Home Assistant container uses the `host` network driver (by passing `--net=host` to the container when creating, or adding `network_mode: "host"` to your compose file when using `docker-compose`). -## {% linkable_title Configuration %} +## Configuration

The PlayStation 4 integration does not use entries from `configuration.yaml`. You must configure this integration by using `Integrations`

-## {% linkable_title Regions %} +## Regions Some titles will have different SKUs in the PlayStation Store database depending on your region. You must select your specific region in the setup in order to retrieve the cover art for such titles correctly. The integration will attempt to search other databases for the correct title if it cannot be found, although it will take longer to do so and may fetch an incorrect cover. @@ -135,9 +135,9 @@ Some titles will have different SKUs in the PlayStation Store database depending The regions which are unavailable have no database or have formatting in the database which can not be used by the component.

-## {% linkable_title Services %} +## Services -### {% linkable_title Service `send_command` %} +### Service `send_command` Emulate button press on PlayStation 4. This emulates the commands available for the PS4 Second Screen App. This is not to be confused with DualShock 4 controller buttons. @@ -146,7 +146,7 @@ Emulate button press on PlayStation 4. This emulates the commands available for | `entity_id` | No | `media_player.playstation_4` | The entity id for your PlayStation 4. | | `command` | No | `ps` | The command you want to send. | -#### {% linkable_title Available Commands %} +#### Available Commands Full list of supported commands. @@ -161,9 +161,9 @@ Full list of supported commands. | `left` | Swipe Left | | `right` | Swipe Right | -## {% linkable_title Troubleshooting %} +## Troubleshooting -### {% linkable_title Cover Art Issues %} +### Cover Art Issues If you are running a game/title on your PS4 that does not display a cover or displays the incorrect cover, post an issue [here](https://github.com/ktnrg45/pyps4-homeassistant/issues). Be sure to include the following information: diff --git a/source/_components/ptvsd.markdown b/source/_components/ptvsd.markdown index b80b5f693e72..6ec01abb8815 100644 --- a/source/_components/ptvsd.markdown +++ b/source/_components/ptvsd.markdown @@ -44,7 +44,7 @@ wait: type: boolean {% endconfiguration %} -### {% linkable_title Security %} +### Security Ensure if this is a public-facing server, that the port is secured. Anyone who is able to access the debugger port can *execute arbitary code* on the home assistant server, which is very unsafe. @@ -52,11 +52,11 @@ If the home assistant server is behind your firewall with only the http(s) port Another way of securing the port is to set `host` to localhost and have a secured SSH TCP tunnel with a client certificate for access from the outside internet. -### {% linkable_title Memory Use %} +### Memory Use There have been reports of continually increasing memory use while the debugger is running, although this doesn't seem to appear on all systems. Only configure the debugger on a persistent server when it's actually required. -### {% linkable_title Waiting at startup %} +### Waiting at startup If you want to debug something in the boot-up sequence, configure the integration to wait for a connection first: @@ -68,7 +68,7 @@ ptvsd: The ptvsd debugger is loaded quite early on in the boot-up sequence, before any other components. This will allow you to set breakpoints in `async_setup` or similar and debug the loading of the component. -### {% linkable_title Alternate host and port %} +### Alternate host and port You can also listen on a different server address or port: @@ -81,7 +81,7 @@ ptvsd: This is useful for multi-homed servers, or for localhost only access -### {% linkable_title Example Visual Studio Code configuration %} +### Example Visual Studio Code configuration This can be copied into your `launch.json` in the `.vscode` subdirectory in your Visual Studio Code project to connect to the debugger. diff --git a/source/_components/push.markdown b/source/_components/push.markdown index fe5596fe4d66..d085c9c317da 100644 --- a/source/_components/push.markdown +++ b/source/_components/push.markdown @@ -22,7 +22,7 @@ Optionally the Push Camera can **buffer** a given number of images, creating an Images are cleared on new events, and events are separated by a soft (configurable) **timeout**. -## {% linkable_title Integration with motionEye %} +## Integration with motionEye The `push` camera can as an example be used with [motionEye](https://github.com/ccrisan/motioneye/wiki) a web frontend for the motion daemon. motionEye is usually configured to save/record files ***only*** when motion is detected. It provides a hook to run a command whenever an image is saved, which can be used together with cURL to send the motion detected images to the `push` camera, as shown in this example: @@ -45,7 +45,7 @@ camera: webhook_id: my_custom_webhook_id ``` -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/pushbullet.markdown b/source/_components/pushbullet.markdown index 98f67c883052..5082a2a31782 100644 --- a/source/_components/pushbullet.markdown +++ b/source/_components/pushbullet.markdown @@ -27,17 +27,17 @@ There is currently support for the following device types within Home Assistant: The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushes per month.

-### {% linkable_title Sensor %} +### Sensor The `pushbullet` sensor platform reads messages from [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. This sensor platform provides sensors that show the properties of the latest received Pushbullet notification mirror. -### {% linkable_title Setup %} +### Setup Notification Mirroring allows users to see their Android device's notifications on their computer. It must be first enabled in the app and is currently only available on the Android platform. For more information, please see [this announcement](https://blog.pushbullet.com/2013/11/12/real-time-notification-mirroring-from-android-to-your-computer/) on the Pushbullet Blog. Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token. -### {% linkable_title Configuration %} +### Configuration To enable the Pushbullet sensor in your installation, add the following to your `configuration.yaml` file: @@ -85,7 +85,7 @@ monitored_conditions: All properties will be displayed as attributes. The properties array are just for logging the sensor readings for multiple properties. -## {% linkable_title Notifications %} +## Notifications The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushes per month. @@ -111,7 +111,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels. @@ -123,7 +123,7 @@ Email | `email/` | Contact's email address | `email/email@example.com` If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email. -#### {% linkable_title Example service payload %} +#### Example service payload ```json { @@ -138,7 +138,7 @@ If using targets, your own account's email address functions as 'send to all dev To use notifications, please see the [getting started with automation page](/getting-started/automation/). -### {% linkable_title URL support %} +### URL support ```yaml action: @@ -152,7 +152,7 @@ action: - **url** (*Required*): Page URL to send with Pushbullet. -### {% linkable_title File support %} +### File support ```yaml action: @@ -166,7 +166,7 @@ action: - **file** (*Required*): File to send with Pushbullet. -### {% linkable_title File URL support %} +### File URL support ```yaml action: @@ -180,7 +180,7 @@ action: - **file_url** (*Required*): File to send with Pushbullet. -### {% linkable_title Single target %} +### Single target ```yaml action: diff --git a/source/_components/pushover.markdown b/source/_components/pushover.markdown index a25e7a4f2b60..bd28231695d5 100644 --- a/source/_components/pushover.markdown +++ b/source/_components/pushover.markdown @@ -17,7 +17,7 @@ redirect_from: The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows integrations to send messages to the user using Pushover. -## {% linkable_title Configuration %} +## Configuration In order to get an API key you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard). diff --git a/source/_components/pushsafer.markdown b/source/_components/pushsafer.markdown index 426ebc631a7c..84f3e4dc0228 100644 --- a/source/_components/pushsafer.markdown +++ b/source/_components/pushsafer.markdown @@ -41,7 +41,7 @@ private_key: type: string {% endconfiguration %} -### {% linkable_title Examples %} +### Examples Message to two devices with formatted text. diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index d60955d5a203..feb29f8d6efa 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -25,7 +25,7 @@ This integration allows you to write Python scripts that are exposed as services [hass-api]: /developers/development_hass_object/ [logger-api]: https://docs.python.org/3.4/library/logging.html#logger-objects -## {% linkable_title Writing your first script %} +## Writing your first script - Add to `configuration.yaml`: `python_script:` - Create folder `/python_scripts` @@ -46,7 +46,7 @@ hass.bus.fire(name, { "wow": "from a Python script!" }) } ``` -## {% linkable_title Calling Services %} +## Calling Services The following example shows how to call a service from `python_script`. This script takes two parameters: `entity_id` (required), `rgb_color` (optional) and calls `light.turn_on` service by setting the brightness value to `255`. diff --git a/source/_components/qbittorrent.markdown b/source/_components/qbittorrent.markdown index d25d73eba575..730a7d56d138 100644 --- a/source/_components/qbittorrent.markdown +++ b/source/_components/qbittorrent.markdown @@ -18,11 +18,11 @@ redirect_from: The `qbittorrent` platform allows you to monitor your downloads with [qBittorrent](https://www.qbittorrent.org/) from within Home Assistant and setup automations based on the information. -## {% linkable_title Setup %} +## Setup This sensor requires the qBittorrent Web UI enabled. The [official reference](https://github.com/qbittorrent/qBittorrent/wiki#webui-related) describes how to set up the Web UI. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/qld_bushfire.markdown b/source/_components/qld_bushfire.markdown index 8cdf9868ce91..9596e67d97a5 100644 --- a/source/_components/qld_bushfire.markdown +++ b/source/_components/qld_bushfire.markdown @@ -37,7 +37,7 @@ It has only been modified for the purpose of presenting the material in Home Ass Please refer to the [creator's copyright notice](https://www.qfes.qld.gov.au/Pages/copyright.aspx) for more information.

-## {% linkable_title Configuration %} +## Configuration To integrate the Queensland Bushfire Alert feed, add the following lines to your `configuration.yaml`. @@ -71,7 +71,7 @@ longitude: {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -87,7 +87,7 @@ the standard ones: | updated_date | Date and time when this alert was last updated. | | status | Status of the alert, for example, "Patrolled", "Going", "Contained" | -## {% linkable_title Full Configuration %} +## Full Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/qnap.markdown b/source/_components/qnap.markdown index 95c6472996c7..e818b35d6a95 100644 --- a/source/_components/qnap.markdown +++ b/source/_components/qnap.markdown @@ -18,7 +18,7 @@ redirect_from: This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). -## {% linkable_title Configuration %} +## Configuration To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file: @@ -122,11 +122,11 @@ monitored_conditions: description: Displays the used space of the volume as a percentage (creates a new entry for each volume). {% endconfiguration %} -### {% linkable_title Self-signed certificates %} +### Self-signed certificates If your QNAP device uses self-signed certificates, set the `verify_ssl` option to `false`. -### {% linkable_title QNAP device support: %} +### QNAP device support: This integration has been tested on the following devices: diff --git a/source/_components/qrcode.markdown b/source/_components/qrcode.markdown index b19a820cd4fa..f9e5adef3052 100644 --- a/source/_components/qrcode.markdown +++ b/source/_components/qrcode.markdown @@ -19,7 +19,7 @@ The `qrcode` image processing platform enables QR code recognition from cameras. To get this running, please install `zbar-tools` (Ubuntu 18.04) -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/quantum_gateway.markdown b/source/_components/quantum_gateway.markdown index 8d2ec7e7396f..df4bf1247f19 100644 --- a/source/_components/quantum_gateway.markdown +++ b/source/_components/quantum_gateway.markdown @@ -19,7 +19,7 @@ The `quantum_gateway` device tracker platform offers presence detection by looki It was tested with a Verizon Fios-G1100 Quantum Gateway. -## {% linkable_title Configuration %} +## Configuration To use a Verizon Fios Quantum Gateway in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index 9b87c0a52093..07302d20fd10 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: The `qwikswitch` integration discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are [lights](/components/light.qwikswitch/) by default, and can be configured as [switches](/components/switch.qwikswitch/). -{% linkable_title Configuration %} +Configuration ```yaml # Example configuration.yaml entry @@ -97,7 +97,7 @@ sensors: type: string {% endconfiguration %} -### {% linkable_title QwikSwitch Events %} +### QwikSwitch Events QwikSwitch devices (i.e., transmitter buttons) will fire events on the Home Assistant bus. These events can then be used as triggers for any `automation` action, as follows: @@ -123,7 +123,7 @@ The list of recognized commands can be extended for Keyfobs, door sensors, and P On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API -### {% linkable_title Qwikswitch Sensors %} +### Qwikswitch Sensors The sensor configuration is a list of sensors. Depending on the type of sensor, it will be a sensor or binary_sensor. @@ -146,7 +146,7 @@ qwikswitch: type: imod ``` -### {% linkable_title Switch %} +### Switch The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant. diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index b62b336addcb..ba3192d2e94b 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -28,14 +28,14 @@ There is currently support for the following device types within Home Assistant: They will be automatically added if the Rachio integration integration is loaded. -## {% linkable_title Getting your Rachio API Key %} +## Getting your Rachio API Key 1. Log in at [https://app.rach.io/](https://app.rach.io/). 2. Click the "Account Settings" menu item at the bottom of the left sidebar 3. Click "Get API Key" 4. Copy the API key from the dialog that opens. -## {% linkable_title Configuration %} +## Configuration To add this platform to your installation, add the following to your `configuration.yaml` file: @@ -66,7 +66,7 @@ manual_run_mins: Set `manual_run_mins` to a high maximum failsafe value when using scripts to control zones. If something goes wrong with your script, Home Assistant, or you hit the Rachio API rate limit of 1700 calls per day, the controller will still turn off the zone after this amount of time.

-### {% linkable_title iFrame %} +### iFrame If you would like to see and control more detailed zone information, create an [iFrame](/components/panel_iframe/) that renders the Rachio web app. @@ -78,17 +78,17 @@ panel_iframe: icon: mdi:water-pump ``` -## {% linkable_title Switch %} +## Switch The `rachio` switch platform allows you to toggle zones connected to your [Rachio irrigation system](http://rachio.com/) on and off. Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch to toggle each controller's standby mode. -## {% linkable_title Examples %} +## Examples In this section, you find some real-life examples of how to use this switch. -### {% linkable_title `groups.yaml` example %} +### `groups.yaml` example ```yaml irrigation: diff --git a/source/_components/radarr.markdown b/source/_components/radarr.markdown index 877bb163ceb8..0cb895345a50 100644 --- a/source/_components/radarr.markdown +++ b/source/_components/radarr.markdown @@ -17,7 +17,7 @@ redirect_from: This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. -## {% linkable_title Configuration %} +## Configuration To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file: @@ -84,11 +84,11 @@ ssl: default: false {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Get Episodes airing in next 2 days %} +### Get Episodes airing in next 2 days ```yaml # Example configuration.yaml entry @@ -101,7 +101,7 @@ sensor: days: 2 ``` -### {% linkable_title Enable SSL %} +### Enable SSL SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the config here (unless it is changed to 7878). @@ -118,7 +118,7 @@ sensor: ssl: true ``` -### {% linkable_title Get disk space for all storage locations %} +### Get disk space for all storage locations ```yaml # Example configuration.yaml entry @@ -130,7 +130,7 @@ sensor: - diskspace ``` -### {% linkable_title Get disk space for listed storage locations %} +### Get disk space for listed storage locations The storage locations Radarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor. @@ -146,7 +146,7 @@ sensor: - /tank/plex ``` -### {% linkable_title Get disk space in different unit %} +### Get disk space in different unit The Radarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported. diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 18ddecf21c7a..463751fe9afc 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To enable it, add the following to your `configuration.yaml` file: @@ -52,7 +52,7 @@ password: Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).

-## {% linkable_title Sensor %} +## Sensor This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. @@ -74,7 +74,7 @@ monitored_conditions: description: Returns the sensor level. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index 9a1f49a24f25..bd4937e35a4d 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To enable it, add the following to your `configuration.yaml` file: @@ -51,7 +51,7 @@ password: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file: @@ -74,7 +74,7 @@ monitored_conditions: description: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet. {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file: @@ -101,7 +101,7 @@ monitored_conditions: description: Return the watering remaining minutes per zone. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file: diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index dcfc0bf45c58..4650f896f0eb 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - [Switch](#switch) -## {% linkable_title Base Configuration %} +## Base Configuration To connect to your RainMachine device, add the following to your `configuration.yaml` file: @@ -111,9 +111,9 @@ switches: default: 600 {% endconfiguration %} -## {% linkable_title Services %} +## Services -### {% linkable_title `rainmachine.disable_program` %} +### `rainmachine.disable_program` Disable a RainMachine program. This will mark the program switch as `Unavailable` in the UI. @@ -122,7 +122,7 @@ Disable a RainMachine program. This will mark the program switch as |---------------------------|----------|-------------------------| | `program_id` | no | The program to disable | -### {% linkable_title `rainmachine.disable_zone` %} +### `rainmachine.disable_zone` Disable a RainMachine zone. This will mark the zone switch as `Unavailable` in the UI. @@ -131,7 +131,7 @@ Disable a RainMachine zone. This will mark the zone switch as |---------------------------|----------|-------------------------| | `zone_id` | no | The zone to disable | -### {% linkable_title `rainmachine.enable_program` %} +### `rainmachine.enable_program` Enable a RainMachine program. @@ -139,7 +139,7 @@ Enable a RainMachine program. |---------------------------|----------|-------------------------| | `program_id` | no | The program to enable | -### {% linkable_title `rainmachine.enable_zone` %} +### `rainmachine.enable_zone` Enable a RainMachine zone. @@ -147,7 +147,7 @@ Enable a RainMachine zone. |---------------------------|----------|-------------------------| | `zone_id` | no | The zone to enable | -### {% linkable_title `rainmachine.pause_watering` %} +### `rainmachine.pause_watering` Pause all watering activities for a number of seconds. @@ -155,7 +155,7 @@ Pause all watering activities for a number of seconds. |---------------------------|----------|--------------------------------| | `seconds` | no | The number of seconds to pause | -### {% linkable_title `rainmachine.start_program` %} +### `rainmachine.start_program` Start a RainMachine program. @@ -163,7 +163,7 @@ Start a RainMachine program. |---------------------------|----------|----------------------| | `program_id` | no | The program to start | -### {% linkable_title `rainmachine.start_zone` %} +### `rainmachine.start_zone` Start a RainMachine zone for a set number of seconds. @@ -172,11 +172,11 @@ Start a RainMachine zone for a set number of seconds. | `zone_id` | no | The zone to start | | `zone_run_time` | yes | The number of seconds to run; defaults to 60 seconds | -### {% linkable_title `rainmachine.stop_all` %} +### `rainmachine.stop_all` Stop all watering activities. -### {% linkable_title `rainmachine.stop_program` %} +### `rainmachine.stop_program` Stop a RainMachine program. @@ -184,7 +184,7 @@ Stop a RainMachine program. |---------------------------|----------|----------------------| | `program_id` | no | The program to stop | -### {% linkable_title `rainmachine.stop_zone` %} +### `rainmachine.stop_zone` Stop a RainMachine zone. @@ -192,15 +192,15 @@ Stop a RainMachine zone. |---------------------------|----------|----------------------| | `zone_id` | no | The zone to stop | -### {% linkable_title `rainmachine.unpause_watering` %} +### `rainmachine.unpause_watering` Unpause all watering activities. -## {% linkable_title Switch %} +## Switch The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/). -### {% linkable_title Controlling Your Device %} +### Controlling Your Device After Home Assistant loads, new switches will be added for every enabled program and zone. These work as expected: diff --git a/source/_components/random.markdown b/source/_components/random.markdown index 764623cac643..d4345a519879 100644 --- a/source/_components/random.markdown +++ b/source/_components/random.markdown @@ -22,11 +22,11 @@ redirect_from: The `random` integration simply creates random values or state. This can be useful if you want to test automation rules or run an interactive demo. It generates a new state every time it is polled. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `random` binary sensor platform is creating random states (`true`, 1, `on` or `false`, 0, `off`). -### {% linkable_title Configuration %} +### Configuration To enable the random binary sensor, add the following lines to your `configuration.yaml` file: @@ -44,11 +44,11 @@ name: default: Random Binary Sensor {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. -### {% linkable_title Configuration %} +### Configuration To enable the random sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/raspihats.markdown b/source/_components/raspihats.markdown index df5b21c7e2bf..63a95ddaa3bb 100644 --- a/source/_components/raspihats.markdown +++ b/source/_components/raspihats.markdown @@ -21,11 +21,11 @@ redirect_from: The `raspihats` integration is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the integration itself. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards. -## {% linkable_title Configuration %} +## Configuration To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file: @@ -84,7 +84,7 @@ i2c_hats: type: string {% endconfiguration %} -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -105,7 +105,7 @@ $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-de $ sudo usermod -a -G i2c homeassistant ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address: @@ -129,11 +129,11 @@ It will output a table like this: For more details about the `raspihats` add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/). -## {% linkable_title Switch %} +## Switch The `raspihats` switch platform allows you to control the digital outputs of your [Raspihats](http://www.raspihats.com/) boards. -## {% linkable_title Configuration %} +## Configuration To use your Raspihats boards in your installation, add the following to your `configuration.yaml` file: @@ -192,7 +192,7 @@ i2c_hats: type: boolean {% endconfiguration %} -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -213,7 +213,7 @@ $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-de $ sudo usermod -a -G i2c homeassistant ``` -## {% linkable_title Check the i2c address of the sensor %} +## Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address: diff --git a/source/_components/raspyrfm.markdown b/source/_components/raspyrfm.markdown index 6aa2a81910f3..bd20d3fced00 100644 --- a/source/_components/raspyrfm.markdown +++ b/source/_components/raspyrfm.markdown @@ -22,7 +22,7 @@ Initially, this integration was created to support the Simple Solutions `ConnAir Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this integration like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html). -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -81,15 +81,15 @@ switches: type: dict {% endconfiguration %} -## {% linkable_title Device support %} +## Device support Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to check what gateways and control units (outlets) are supported. -## {% linkable_title Channel configuration %} +## Channel configuration Depending on the control unit the channel config can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model. -## {% linkable_title Switch state %} +## Switch state Initially, the state of a switch is unknown. When the switch is turned on or off (via frontend) the state is known and will be shown in the frontend. @@ -97,7 +97,7 @@ Initially, the state of a switch is unknown. When the switch is turned on or off Note that due to the way those cheap RC units work it is **not possible to query their current state**. Therefore the only way to preserve a consistent state within Home Assistant is to only use Home Assistant as the controller.

-## {% linkable_title Full example %} +## Full example ```yaml switch: diff --git a/source/_components/recollect_waste.markdown b/source/_components/recollect_waste.markdown index 0b75a4cdf98d..efd433f3eb57 100644 --- a/source/_components/recollect_waste.markdown +++ b/source/_components/recollect_waste.markdown @@ -27,7 +27,7 @@ The `Recollect Waste` platform allows you to track the next scheduled waste pick 5. Use the place_id and service_id when configuring the sensor. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 609d9b721f85..5801f9bd61d1 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -123,7 +123,7 @@ recorder: If you only want to hide events from your history, take a look at the [`history` component](/components/history/). The same goes for the [logbook](/components/logbook/). But if you have privacy concerns about certain events or want them in neither the history or logbook, you should use the `exclude`/`include` options of the `recorder` component. That way they aren't even in your database, you can reduce storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). -### {% linkable_title Service `purge` %} +### Service `purge` Call the service `recorder.purge` to start a purge task which deletes events and states older than x days, according to `keep_days` service data. @@ -132,7 +132,7 @@ Call the service `recorder.purge` to start a purge task which deletes events and | `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) | `repack` | yes | Rewrite the entire database, possibly saving some disk space. Only supported for SQLite and requires at least as much disk space free as the database currently uses. -## {% linkable_title Custom database engines %} +## Custom database engines | Database engine | `db_url` | | :---------------|:---------------------------------------------------------| @@ -160,7 +160,7 @@ If you want to use Unix Sockets for PostgreSQL you need to modify the `pg_hba.co If you are using the default `FULL` recovery model for MS SQL Server you will need to manually backup your log file to prevent your transaction log from growing too large. It is recommended you change the recovery model to `SIMPLE` unless you are worried about data loss between backups.

-### {% linkable_title Database startup %} +### Database startup If you are running a database server instance on the same server as Home Assistant then you must ensure that this service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the service file. @@ -182,11 +182,11 @@ Save the file then reload `systemctl`: $ sudo systemctl daemon-reload ``` -## {% linkable_title Installation notes %} +## Installation notes Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details that should help you to get it working. -### {% linkable_title MariaDB and MySQL %} +### MariaDB and MySQL If you are in a virtual environment, don't forget to activate it before installing the `mysqlclient` Python package described below. @@ -216,7 +216,7 @@ After installing the dependencies, it is required to create the database manuall Once Home Assistant finds the database, with the right level of permissions, all the required tables will then be automatically created and the data will be populated accordingly. -### {% linkable_title PostgreSQL %} +### PostgreSQL For PostgreSQL you may have to install a few dependencies: @@ -241,7 +241,7 @@ $ sudo -i -u postgres psql -c "SELECT pg_reload_conf();" ``` A service restart will work as well. -### {% linkable_title MS SQL Server %} +### MS SQL Server For MS SQL Server you may have to install a few dependencies: diff --git a/source/_components/recswitch.markdown b/source/_components/recswitch.markdown index f6bc3102354a..50bfc818a59c 100644 --- a/source/_components/recswitch.markdown +++ b/source/_components/recswitch.markdown @@ -24,7 +24,7 @@ Supported devices (tested): - Lumitek CSW201 NEO WiFi - MALMBERGS CSW201 -## {% linkable_title Configuration %} +## Configuration To enable this switch, add the following lines to your `configuration.yaml`: diff --git a/source/_components/reddit.markdown b/source/_components/reddit.markdown index 608f1b1d4a7a..51727cc8d503 100644 --- a/source/_components/reddit.markdown +++ b/source/_components/reddit.markdown @@ -18,11 +18,11 @@ redirect_from: The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor your favorite subreddits. -## {% linkable_title Setup %} +## Setup To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example). -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following to your `configuration.yaml` file: diff --git a/source/_components/rejseplanen.markdown b/source/_components/rejseplanen.markdown index c25a921d1ac5..e5b05d7839a4 100644 --- a/source/_components/rejseplanen.markdown +++ b/source/_components/rejseplanen.markdown @@ -18,7 +18,7 @@ redirect_from: The `rejseplanen` sensor will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/). -## {% linkable_title Setup %} +## Setup The `stop_id` can be obtained through the following steps: @@ -43,7 +43,7 @@ You will se a output like this: Find the name of your stop in the list and the "id" is the one you are looking for to us as value for `stop_id:`. -## {% linkable_title Configuration %} +## Configuration Add a sensor to your `configuration.yaml` file as shown in the example: @@ -73,7 +73,7 @@ departure_type: type: string|list {% endconfiguration %} -## {% linkable_title Direction %} +## Direction If you use the `direction` filter it's important to put correct destination or else the sensor will not work at all. The direction has to be the destination(s) for the transport type(s) for the departure stop destination, and NOT the stop where you want to get off. Check [http://rejseplanen.dk](http://rejseplanen.dk), make a search and use the destinations from there in your configuration. Make sure you use the exact name as the destination(s). @@ -103,7 +103,7 @@ sensor: It fails because the destination from the departure is NOT København H, but 'CPH Lufthavn', 'Helsingør St.' and others. -## {% linkable_title Examples %} +## Examples A more extensive example on how to use this sensor: diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index 49eaafd508ed..e15ba2071280 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -15,11 +15,11 @@ ha_release: 0.57 The `Remember The Milk` (RTM) integration allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel. -## {% linkable_title Setup %} +## Setup The setup consists of two steps: getting an API key and registering your account -### {% linkable_title Step 1: API key %} +### Step 1: API key To be able to use this component, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal `shared secret`. Both of them need to be stored in your Home Assistant configuration: @@ -48,7 +48,7 @@ remember_the_milk: type: string {% endconfiguration %} -### {% linkable_title Step 2: registering your account %} +### Step 2: registering your account After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account. @@ -58,7 +58,7 @@ If the registration was successful, the Configuration panel will disappear from In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server. -## {% linkable_title Creating/updating tasks with service ```create_task```%} +## Creating/updating tasks with service ```create_task``` This integration offers a new service domain ```remember_the_milk``` with the services ```_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations. @@ -74,7 +74,7 @@ At the moment, smart syntax is *not* supported when updating tasks. All smart sy | name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" | | id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" | -## {% linkable_title Completing tasks with service ```complete_task```%} +## Completing tasks with service ```complete_task``` Complete a tasks that was privously created from Home Assistant. You can not complete tasks that were created outside of Home Assistant. @@ -84,7 +84,7 @@ If you have created your task with an ```id```, calling ```_complete_ta |-----------------------|----------|-------------|---------| | id | no | Identifier that was defined when creating the task | "myid" | -## {% linkable_title Automation example %} +## Automation example Here's an example for an automation that creates a new task whenever ```sensor.mysensor``` is ```on``` and completes it when the sensor reports ```off```. This way it reminds you to switch it off. By using the ```entity_id``` as id for the task, you can use the same rule also for multiple sensors. @@ -111,6 +111,6 @@ Here's an example for an automation that creates a new task whenever ```sensor.m ``` -## {% linkable_title Disclaimer %} +## Disclaimer This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk. diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown index 004b1d9feb85..41d34ace16be 100644 --- a/source/_components/remote.markdown +++ b/source/_components/remote.markdown @@ -15,7 +15,7 @@ Keeps track which remotes are in your environment, their state and allows you to * Maintains a state per remote and a combined state `all_remotes`. * Registers services `remote/turn_on`, `remote/turn_off`, `remote/toggle`, and `remote/send_command` to control remotes. -### {% linkable_title Use the services %} +### Use the services Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `remote/turn_on`, `remote/turn_off`, or `remote/toggle` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **Call Service**. diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown index 8f46fce2d061..15431804943a 100644 --- a/source/_components/remote.xiaomi_miio.markdown +++ b/source/_components/remote.xiaomi_miio.markdown @@ -18,7 +18,7 @@ The `xiaomi miio` remote platform allows you to send IR commands from your Xiaom Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To add a Xiaomi IR Remote to your installation, add the following to your configuration.yaml file: ```yaml @@ -67,7 +67,7 @@ commands: {% endconfiguration %} -## {% linkable_title Full Configuration %} +## Full Configuration ```yaml remote: @@ -88,7 +88,7 @@ remote: - pronto:pronto_hex:[optional_repeat] ``` -## {% linkable_title Use named commands to create UI buttons %} +## Use named commands to create UI buttons ```yaml script: @@ -108,11 +108,11 @@ script: - 'read_bad_poem' ``` -## {% linkable_title Command Types %} +## Command Types The Xiaomi IR Remote Platform currently supports two different formats for IR codes. -### {% linkable_title Raw %} +### Raw A raw command is a command learned from [`remote.xiaomi_miio_learn_command`](/components/remote.xiaomi_miio/#remotexiaomi_miio_learn_command). @@ -121,7 +121,7 @@ A raw command is defined as in the following example: with an optional last parameter of frequency: `raw:Z6UFANEAAAAjAQAAAwkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQIAE=:38400` -### {% linkable_title Pronto Hex Code %} +### Pronto Hex Code A pronto hex code is a hex code often supplied by the device manufacturer. @@ -130,15 +130,15 @@ A pronto hex code is defined as in the following example: with an optional last parameter of repeats (required by some devices): `pronto:0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0623 015B 0057 0016 0E6E:2` -## {% linkable_title Platform Services %} +## Platform Services The Xiaomi IR Remote Platform registers two services. -### {% linkable_title `remote.send_command` %} +### `remote.send_command` Allows sending either named commands using an identifier or sending commands as one of the two types defined in [Command Types](/components/remote.xiaomi_miio/#command-types). -### {% linkable_title `remote.xiaomi_miio_learn_command` %} +### `remote.xiaomi_miio_learn_command` Used to learn new commands. diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index f5ef991b05f5..e88e072a0fbe 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -18,7 +18,7 @@ ha_iot_class: Local Push The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). @@ -65,7 +65,7 @@ pull_mode: For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. -## {% linkable_title Switch %} +## Switch The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). diff --git a/source/_components/repetier.markdown b/source/_components/repetier.markdown index 03fb8adb5e84..3728707405f7 100644 --- a/source/_components/repetier.markdown +++ b/source/_components/repetier.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - Sensor -## {% linkable_title Configuration %} +## Configuration ```yaml repetier: @@ -100,7 +100,7 @@ camera: mjpeg_url: http://YOUR_REPETIER_HOST_IP:8080/?action=stream ``` -### {% linkable_title Retrieve API-key %} +### Retrieve API-key To generate the needed API-key do the following: diff --git a/source/_components/rest.markdown b/source/_components/rest.markdown index 7e191542a059..9d9ac3eaf66f 100644 --- a/source/_components/rest.markdown +++ b/source/_components/rest.markdown @@ -118,11 +118,11 @@ $ curl -X GET http://192.168.1.31/temperature/ {"temperature": 77, "id": "sensor02", "name": "livingroom", "connected": true} ``` -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title External IP address %} +### External IP address You can find your external IP address using the service [JSON Test](http://www.jsontest.com) at their [http://ip.jsontest.com/](http://ip.jsontest.com/) URL. @@ -134,7 +134,7 @@ sensor: value_template: '{% raw %}{{ value_json.ip }}{% endraw %}' ``` -### {% linkable_title Single value from a local Glances instance %} +### Single value from a local Glances instance The [glances](/components/sensor.glances/) sensor is doing the exact same thing for all exposed values. @@ -147,7 +147,7 @@ sensor: unit_of_measurement: MB ``` -### {% linkable_title Value from another Home Assistant instance %} +### Value from another Home Assistant instance The Home Assistant [API](/developers/rest_api/) exposes the data from your attached sensors. If you are running multiple Home Assistant instances which are not [connected](/developers/architecture/#multiple-connected-instances) you can still get information from them. @@ -162,7 +162,7 @@ sensor: unit_of_measurement: "°C" ``` -### {% linkable_title Accessing an HTTP authentication protected endpoint %} +### Accessing an HTTP authentication protected endpoint The REST sensor supports HTTP authentication and customized headers. @@ -205,7 +205,7 @@ Example entry for the `secrets.yaml` file: my_sensor_secret_token: Bearer gh_DHQIXKVf6Pr4H8Yqz8uhApk_mnV6Zje6Pr4H8Yqz8A8nCxz6SBghQdS51 ``` -### {% linkable_title Use GitHub to get the latest release of Home Assistant %} +### Use GitHub to get the latest release of Home Assistant This sample is very similar to the [`updater`](/components/updater/) integration but the information is received from GitHub. @@ -223,7 +223,7 @@ sensor: User-Agent: Home Assistant REST sensor ``` -### {% linkable_title Fetch multiple JSON values and present them as attributes %} +### Fetch multiple JSON values and present them as attributes [JSON Test](http://www.jsontest.com) returns the current time, date and milliseconds since epoch from [http://date.jsontest.com/](http://date.jsontest.com/). diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index 2a77a1691711..0a1f932f5274 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -75,7 +75,7 @@ service_name: default: true {% endconfiguration %} -## {% linkable_title Examples %} +## Examples The commands can be dynamic, using templates to insert values of other entities. Service call support variables for doing things with templates. diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 9ff0b8a4f91a..5825413ec290 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -29,7 +29,7 @@ This integration is tested with the following hardware/software: - Nodo RFLink Gateway V1.4/RFLink R46 -## {% linkable_title Configuration %} +## Configuration To enable RFLink in your installation, add the following to your `configuration.yaml` file: @@ -64,7 +64,7 @@ reconnect_interval: type: integer {% endconfiguration %} -### {% linkable_title Full example %} +### Full example ```yaml # Example configuration.yaml entry rflink: @@ -75,7 +75,7 @@ rflink: - digitech_* ``` -### {% linkable_title TCP mode %} +### TCP mode TCP mode allows you to connect to an RFLink device over a TCP/IP network. This is useful if placing the RFLink device next to the HA server is not optimal or desired (eg: bad reception). @@ -104,7 +104,7 @@ rflink: port: 1234 ``` -### {% linkable_title Adding devices Automatically %} +### Adding devices Automatically In order to have your devices discovered automatically, you need to add the following to the configuration. When pressing the button on the physical remote, RFLink detects the signal and the device should be added automatically to Home Assistant. @@ -122,7 +122,7 @@ sensor: The RFLink integration does not know the difference between a binary sensor, a switch and a light. Therefore all switchable devices are automatically added as light by default. However, once the ID of a switch is known, it can be used to configure it as a switch or a binary sensor type in Home Assistant, for example, to add it to a different group, hide it or configure a nice name. -### {% linkable_title Ignoring devices %} +### Ignoring devices The RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology. @@ -145,22 +145,22 @@ This configuration will ignore the button `1` of the `newkaku` device with ID `0 Wildcards only work at the end of the ID, not in the middle or front!

-### {% linkable_title Device support %} +### Device support Even though a lot of devices are supported by RFLink, not all have been tested/implemented. If you have a device supported by RFLink but not by this integration please consider testing and adding support yourself. -### {% linkable_title Device Incorrectly Identified %} +### Device Incorrectly Identified If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFLink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.rflink.nl/blog2/faq#RFFind) -### {% linkable_title Technical Overview %} +### Technical Overview - The`rflink` Python module is an asyncio transport/protocol which is setup to fire a callback for every (valid/supported) packet received by the RFLink gateway. - This integration uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](/docs/configuration/events/) which can be subscribed to by entities/platform implementations. - The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet ID's. - Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component. -### {% linkable_title Debug Logging %} +### Debug Logging For debugging purposes or context when investigating issues you can enable debug logging for RFLink with the following config snippet: diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 30921308775f..709352b2f327 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: Currently only doorbells are supported by this sensor. -## {% linkable_title Configuration %} +## Configuration To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ password: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor Once you have enabled the [Ring component](/components/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file: @@ -77,7 +77,7 @@ monitored_conditions: Currently it supports doorbell, external chimes and stickup cameras. -## {% linkable_title Camera %} +## Camera

Please note that downloading and playing Ring video will require a Ring Protect plan. @@ -107,7 +107,7 @@ scan_interval: Currently it supports doorbell and stickup cameras. -## {% linkable_title Saving the videos captured by your Ring Door Bell %} +## Saving the videos captured by your Ring Door Bell You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) integration in your configuration by adding the following to your `configuration.yaml`. @@ -155,7 +155,7 @@ data = { hass.services.call('downloader', 'download_file', data) ``` -## {% linkable_title Sensor %} +## Sensor Once you have enabled the [Ring component](/components/ring), you can start using the sensor platform. Add the following to your `configuration.yaml` file: diff --git a/source/_components/ritassist.markdown b/source/_components/ritassist.markdown index 33e4d7e11bcb..897bcaee5582 100644 --- a/source/_components/ritassist.markdown +++ b/source/_components/ritassist.markdown @@ -18,11 +18,11 @@ redirect_from: The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. -## {% linkable_title Setup %} +## Setup To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key). -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -63,7 +63,7 @@ include: See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. -## {% linkable_title Available attributes %} +## Available attributes | Attribute | Description | |---|---| diff --git a/source/_components/rmvtransport.markdown b/source/_components/rmvtransport.markdown index 62be7f2e6bc9..d2817cf695be 100644 --- a/source/_components/rmvtransport.markdown +++ b/source/_components/rmvtransport.markdown @@ -18,11 +18,11 @@ redirect_from: The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes. -## {% linkable_title Setup %} +## Setup Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of valid station IDs. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -83,9 +83,9 @@ next_departure: type: integer {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration with three sensors that showcase the various configuration options. diff --git a/source/_components/rocketchat.markdown b/source/_components/rocketchat.markdown index 19c07d7e10a2..39ce0259f5cf 100644 --- a/source/_components/rocketchat.markdown +++ b/source/_components/rocketchat.markdown @@ -18,7 +18,7 @@ redirect_from: The `rocketchat` notify platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant. -## {% linkable_title Configuration %} +## Configuration To add Rocket.Chat to your installation, add the following to your `configuration.yaml` file: @@ -39,7 +39,7 @@ notify: - **password** (*Required*): The Rocker.Chat password. - **room** (*Required*): The chat room name to send messages to. -### {% linkable_title script.yaml example %} +### script.yaml example ```yaml rocketchat_notification: @@ -51,7 +51,7 @@ rocketchat_notification: emoji: ":smirk:" ``` -#### {% linkable_title Message variables %} +#### Message variables - **message** (*Required*): Message to be displayed. - **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown index 7d2a95611e1c..c4b4e7e3d463 100644 --- a/source/_components/roku.markdown +++ b/source/_components/roku.markdown @@ -41,13 +41,13 @@ host: type: string {% endconfiguration %} -## {% linkable_title Services %} +## Services -### {% linkable_title Service `roku_scan` %} +### Service `roku_scan` Scans the local network for Rokus. All found devices are presented as a persistent notification. -## {% linkable_title Remote %} +## Remote The `roku` remote platform allows you to send remote control buttons to a Roku device. It is automatically set up when a Roku is configured. diff --git a/source/_components/roomba.markdown b/source/_components/roomba.markdown index 1b7dc688825c..b18b0a64e149 100644 --- a/source/_components/roomba.markdown +++ b/source/_components/roomba.markdown @@ -21,7 +21,7 @@ The `roomba` integration allows you to control your [iRobot Roomba](http://www.i This platform has only been tested with an iRobot Roomba 980 but should work fine with any Wi-Fi enabled Roomba like the 690, 890 or the 960.

-## {% linkable_title Configuration %} +## Configuration To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file: @@ -68,6 +68,6 @@ continuous: The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)

-### {% linkable_title Retrieving your credentials %} +### Retrieving your credentials Please refer to [here](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [here](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to retrieve both the BLID (username) and the password. diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown index 45b635e93dd5..bdf2140d036c 100644 --- a/source/_components/route53.markdown +++ b/source/_components/route53.markdown @@ -19,7 +19,7 @@ The integration will run every hour, but can also be started manually by using t Please note that this platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address. -## {% linkable_title Setup %} +## Setup You will need to configure your AWS Account with a suitable IAM policy and API keys for this to function. @@ -63,7 +63,7 @@ Here is an IAM Policy sample, don't forget to update your Zone ID on the Resourc 5. Under the security credentials tab for the `homeassistant` user, create a set of access keys for placement in the integration definition YAML. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/rova.markdown b/source/_components/rova.markdown index 1229162f7010..4eb1a5dfc167 100644 --- a/source/_components/rova.markdown +++ b/source/_components/rova.markdown @@ -18,7 +18,7 @@ redirect_from: [ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. The `rova` platform uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this in your Home Assistant installation. -## {% linkable_title Configuration %} +## Configuration To use the ROVA sensor in your installation, add the following to your configuration.yaml file: @@ -65,7 +65,7 @@ monitored_conditions: If no **monitored_conditions** are specified, only **bio** will be enabled. -### {% linkable_title Full configuration sample %} +### Full configuration sample A full configuration entry would look like the sample below. diff --git a/source/_components/rpi_camera.markdown b/source/_components/rpi_camera.markdown index 5cedd54b3e59..09fcbbe266a4 100644 --- a/source/_components/rpi_camera.markdown +++ b/source/_components/rpi_camera.markdown @@ -18,7 +18,7 @@ redirect_from: The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index b93ef5ac8adb..a2d38b51761e 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -23,11 +23,11 @@ redirect_from: The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). -## {% linkable_title Configuration %} +## Configuration To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ pull_mode: For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. -## {% linkable_title Cover %} +## Cover The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors. @@ -82,7 +82,7 @@ It uses two pins on the Raspberry Pi. Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup). -## {% linkable_title Configuration %} +## Configuration To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: @@ -135,7 +135,7 @@ covers: type: string {% endconfiguration %} -## {% linkable_title Full example %} +## Full example ```yaml # Example configuration.yaml entry @@ -153,15 +153,15 @@ cover: name: 'Right door' ``` -## {% linkable_title Remote Raspberry Pi Cover %} +## Remote Raspberry Pi Cover If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/components/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover. -## {% linkable_title Switch %} +## Switch The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). -## {% linkable_title Configuration %} +## Configuration To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/rpi_gpio_pwm.markdown b/source/_components/rpi_gpio_pwm.markdown index d84a84c54feb..803c6c02e0a9 100644 --- a/source/_components/rpi_gpio_pwm.markdown +++ b/source/_components/rpi_gpio_pwm.markdown @@ -20,7 +20,7 @@ The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml`: @@ -69,11 +69,11 @@ leds: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title RGB LED connected to PCA9685 controller %} +### RGB LED connected to PCA9685 controller This example uses a [PCA9685 controller](http://www.nxp.com/products/interfaces/ic-bus-portfolio/ic-led-display-control/16-channel-12-bit-pwm-fm-plus-ic-bus-led-controller:PCA9685) to control a RGB LED. @@ -88,7 +88,7 @@ light: type: rgb ``` -### {% linkable_title RGBW LED connected to PCA9685 controller %} +### RGBW LED connected to PCA9685 controller This example uses a [PCA9685 controller](http://www.nxp.com/products/interfaces/ic-bus-portfolio/ic-led-display-control/16-channel-12-bit-pwm-fm-plus-ic-bus-led-controller:PCA9685) to interact with a RGBW LED. diff --git a/source/_components/rpi_pfio.markdown b/source/_components/rpi_pfio.markdown index c56ca851dfaf..895822a85bb3 100644 --- a/source/_components/rpi_pfio.markdown +++ b/source/_components/rpi_pfio.markdown @@ -28,11 +28,11 @@ There is currently support for the following device types within Home Assistant: Set the jumpers on the PiFace board for address 0 (JP1: 1-2, JP2: 1-2). -## {% linkable_title Use with HassOS %} +## Use with HassOS Note that the PiFace Digital 2 uses the Raspberry Pi SPI port, which is disabled by default when using [HassOS](https://github.com/home-assistant/hassos). When using HassOS, you must mount the SD card on another computer and access the boot partition on the card. Edit the `config.txt` file and add the line `dtparam=spi=on` to the end. This should enable SPI when HassOS is booted and allow Home Assistant to access the PiFace Digital 2 board. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) . @@ -78,7 +78,7 @@ ports: default: "`false` (ACTIVE HIGH)" {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `rpi_pfio` switch platform allows you to control the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) module. diff --git a/source/_components/rpi_rf.markdown b/source/_components/rpi_rf.markdown index 09873b3b4fe9..c5e4841c1dc8 100644 --- a/source/_components/rpi_rf.markdown +++ b/source/_components/rpi_rf.markdown @@ -21,7 +21,7 @@ The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/S Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch). For more info see the PyPi module description: [rpi-rf](https://pypi.python.org/pypi/rpi-rf). -## {% linkable_title Configuration %} +## Configuration To enable, add the following to your `configuration.yaml`: diff --git a/source/_components/sabnzbd.markdown b/source/_components/sabnzbd.markdown index f78a3fea200d..f94a2c827c16 100644 --- a/source/_components/sabnzbd.markdown +++ b/source/_components/sabnzbd.markdown @@ -80,7 +80,7 @@ Available sensors are: - `month_size`: GB downloaded this month - `total_size`: Total GB downloaded -## {% linkable_title Full examples %} +## Full examples ```yaml # Example configuration.yaml entry @@ -107,13 +107,13 @@ sabnzbd: This will attempt to access your SABnzbd instance at https://192.168.1.32:9090 and will create sensors named `sensor.sab_status`, `sensor.sab_speed`, etc. -## {% linkable_title Services %} +## Services -### {% linkable_title Media control services %} +### Media control services Available services: `pause`, `resume`, `set_speed`. -#### {% linkable_title Service `sabnzbd/set_speed` %} +#### Service `sabnzbd/set_speed` | Service data attribute | Optional | Description | |------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/source/_components/samsungtv.markdown b/source/_components/samsungtv.markdown index d7fa1015f2c7..7b816363e0bb 100644 --- a/source/_components/samsungtv.markdown +++ b/source/_components/samsungtv.markdown @@ -18,11 +18,11 @@ redirect_from: The `samsungtv` platform allows you to control a [Samsung Smart TV](http://www.samsung.com/uk/consumer/tv-audio-video/televisions/). -### {% linkable_title Setup %} +### Setup When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. -### {% linkable_title Configuration %} +### Configuration To add a TV to your installation without relying on the [discovery component](/components/discovery/), add the following to your `configuration.yaml` file: diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 85a067b0a386..e5b006dabc84 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately. -## {% linkable_title Setup %} +## Setup Please note that **ETHM-1 module is currently not supported**: it does not provide functionality used by this extension. At the moment only ETHM-1 Plus module is supported. That might change in the future, but no promisses are given. @@ -40,7 +40,7 @@ A list of all partition, zone and output IDs can be acquired by running DloadX p For the Binary Sensor check the [type/class](/components/binary_sensor/) list for a possible visualization of your zones. Note: If no zones or outputs are specified, Home Assistant will not load any binary_sensor components." -## {% linkable_title Configuration %} +## Configuration A `satel_integra` section must be present in the `configuration.yaml` file: @@ -114,7 +114,7 @@ switchable_outputs: type: string {% endconfiguration %} -## {% linkable_title Full examples %} +## Full examples ```yaml # Example configuration.yaml entry diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index c700914335e2..e1703a23f6ff 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -17,7 +17,7 @@ The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes The `knx` integration must be configured correctly, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX scence in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/scrape.markdown b/source/_components/scrape.markdown index e4e88648cb10..686a955077da 100644 --- a/source/_components/scrape.markdown +++ b/source/_components/scrape.markdown @@ -73,11 +73,11 @@ headers: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. There is also a [Jupyter notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/web-scraping.ipynb) available for this example to give you a bit more insight. -### {% linkable_title Home Assistant %} +### Home Assistant The current release Home Assistant is published on [https://www.home-assistant.io/](/) @@ -93,7 +93,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Available implementations %} +### Available implementations Get the counter for all our implementations from the [Component overview](/components/) page. @@ -109,7 +109,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Get a value out of a tag %} +### Get a value out of a tag The German [Federal Office for Radiation protection (Bundesamt für Strahlenschutz)](http://www.bfs.de/) is publishing various details about optical radiation including an UV index. This example is getting the index for a region in Germany. @@ -124,7 +124,7 @@ sensor: unit_of_measurement: 'UV Index' ``` -### {% linkable_title IFTTT status %} +### IFTTT status If you make heavy use of the [IFTTT](/components/ifttt/) web service for your automations and are curious about the [status of IFTTT](http://status.ifttt.com/) then you can display the current state of IFTTT in your frontend. @@ -137,7 +137,7 @@ sensor: select: '.component-status' ``` -### {% linkable_title Get the latest podcast episode file URL %} +### Get the latest podcast episode file URL If you want to get the file URL for the latest episode of your [favorite podcast](https://hasspodcast.io/), so you can pass it on to a compatible media player. @@ -152,7 +152,7 @@ sensor: attribute: url ``` -### {% linkable_title Energy price %} +### Energy price This example tries to retrieve the price for electricity. @@ -169,7 +169,7 @@ sensor: ``` {% endraw %} -### {% linkable_title BOM Weather %} +### BOM Weather The Australian Bureau of Meterology website returns an error if the User Agent header is not sent. diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 7a1af47d4b05..8be598b5c60a 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -59,7 +59,7 @@ script:  entity_id: group.living_room ``` -### {% linkable_title Passing variables to scripts %} +### Passing variables to scripts As part of the service, variables can be passed along to a script so they become available within templates in that script. @@ -115,7 +115,7 @@ script: message: "{% raw %}{{ message }}{% endraw %}" ``` -### {% linkable_title In the Overview %} +### In the Overview Scripts in the Overview panel will be displayed with an **EXECUTE** button if the device has no `delay:` or `wait:` statement, and as a toggle switch if it has either of those. diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index fa97b0f1b4a9..a880234bbb8a 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -44,7 +44,7 @@ device: type: string {% endconfiguration %} -### {% linkable_title How to find the scs_id for your devices %} +### How to find the scs_id for your devices The SCSGate integration relies on the [scsgate](https://github.com/flavio/scsgate) Python module. @@ -52,7 +52,7 @@ This module provides also a command line tool called `scs-monitor`. This program For more information checkout [this](http://scsgate.readthedocs.org/en/latest/?badge=latest#creation-of-a-home-assistant-configuration-file) section of `scsgate`'s documentation. -### {% linkable_title Cover %} +### Cover The SCSGate devices can control motorized covers connected to the BTicino MyHome system. @@ -93,7 +93,7 @@ devices: **Known limitation:** It is not possible to know the current state of the cover.

-### {% linkable_title Light %} +### Light The SCSGate device can control lights of the BTicino MyHome system. @@ -116,7 +116,7 @@ devices: type: list {% endconfiguration %} -### {% linkable_title Switch %} +### Switch The SCSGate device can control switches of the BTicino MyHome system. diff --git a/source/_components/season.markdown b/source/_components/season.markdown index 8a9ed712437b..9d1ed40a7ba6 100644 --- a/source/_components/season.markdown +++ b/source/_components/season.markdown @@ -29,7 +29,7 @@ All information about how the seasons work was taken from Wikipedia: - [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox) - [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice) -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/sendgrid.markdown b/source/_components/sendgrid.markdown index 93d4a98bbf26..893db9b4c3f3 100644 --- a/source/_components/sendgrid.markdown +++ b/source/_components/sendgrid.markdown @@ -17,11 +17,11 @@ redirect_from: The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform. -## {% linkable_title Setup %} +## Setup You need an [API key](https://app.sendgrid.com/settings/api_keys) from SendGrid. -## {% linkable_title Configuration %} +## Configuration To enable notification emails via SendGrid in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sense.markdown b/source/_components/sense.markdown index ea1f4e3b4952..02034a662258 100644 --- a/source/_components/sense.markdown +++ b/source/_components/sense.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor - Sensor -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensehat.markdown b/source/_components/sensehat.markdown index 6a7f2cf99e9d..7a25530ed657 100644 --- a/source/_components/sensehat.markdown +++ b/source/_components/sensehat.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Light](#light) - [Sensor](#sensor) -## {% linkable_title Light %} +## Light The `sensehat` light platform lets you control the [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) board's 8x8 RGB LED matrix on your Raspberry Pi from within Home Assistant. @@ -36,7 +36,7 @@ light: - platform: sensehat ``` -## {% linkable_title Sensor %} +## Sensor The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi. @@ -76,9 +76,9 @@ is_hat_attached: type: boolean {% endconfiguration %} -### {% linkable_title Customizing the Sense HAT data %} +### Customizing the Sense HAT data -#### {% linkable_title Format the sensor values %} +#### Format the sensor values Add the following to your `sensor`: @@ -108,7 +108,7 @@ sensor: {% endraw %} -#### {% linkable_title Give the values friendly names & icons %} +#### Give the values friendly names & icons Add the following to your `customize`: @@ -126,7 +126,7 @@ customize: friendly_name: "Pressure" ``` -#### {% linkable_title Create a group %} +#### Create a group Add the following to your `groups`: @@ -150,11 +150,11 @@ group: - group.sense_hat ``` -### {% linkable_title Directions for installing on Raspberry Pi All-In-One installer and HASSbian: %} +### Directions for installing on Raspberry Pi All-In-One installer and HASSbian: Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions. -#### {% linkable_title Install SenseHAT package to _homeassistant_venv_ %} +#### Install SenseHAT package to _homeassistant_venv_ ```bash # switch to the homeassistant_venv environment @@ -166,13 +166,13 @@ pip3 install sense-hat # be patient, this will take a long while ``` -#### {% linkable_title Return to `pi` %} +#### Return to `pi` Type `exit` to quit out of the _homeassistant_venv_ back to your `pi` environment. As all of the following steps should be under the `pi` user environment. -#### {% linkable_title Install _RTIMU_ %} +#### Install _RTIMU_ ```bash # pi user environment: Install RTIMU diff --git a/source/_components/sensibo.markdown b/source/_components/sensibo.markdown index 3a91fafc7770..3c5b0d2418c2 100644 --- a/source/_components/sensibo.markdown +++ b/source/_components/sensibo.markdown @@ -44,7 +44,7 @@ then in the Sensibo app log you will be able to distinguish between actions done in the app and actions done by Home Assistant.

-### {% linkable_title Full config example %} +### Full config example ```yaml climate: - platform: sensibo @@ -54,7 +54,7 @@ climate: - id2 ``` -### {% linkable_title Adding a quick switch example %} +### Adding a quick switch example If you want a "Quick Switch" to turn your AC On / Off, you can do that using the following `Switch Template`: diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index fe0abde93227..d3a043a6bd5b 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -121,7 +121,7 @@ monitored_conditions: description: Symbol and full expected condition (in Dutch). {% endconfiguration %} -## {% linkable_title The `Name` Variable %} +## The `Name` Variable If you specify a name, the sensors will get an entity name of `sensor.[name]_[default sensor display name]`, for example: @@ -133,12 +133,12 @@ If no name is specified the sensors will be called `sensor.br_[default sensor di - `sensor.br_wind_speed`, since no name has been set for the sensor and the default display name for monitored condition `windspeed` is `Wind speed`. - `sensor.br_ground_temperature`, since no name has been set for the sensor and the default display name for monitored condition `groundtemperature` is `Ground Temperature`. -## {% linkable_title Daily forecasts %} +## Daily forecasts Conditions above marked with `1d` are daily forecasts. To get forecast for different day, replace the number in `_1d` part of the sensor name. Valid values are from `1` to `5`. -## {% linkable_title Configuration examples %} +## Configuration examples Full configuration example (excluding forecasted conditions) where location is manually specified: diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 7c3fc82d51b0..d8dcd0f897e7 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `command_line` sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line. -## {% linkable_title Configuration %} +## Configuration To enable it, add the following lines to your `configuration.yaml`: @@ -61,11 +61,11 @@ json_attributes: type: string, list {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Hard drive temperature %} +### Hard drive temperature There are several ways to get the temperature of your hard drive. A simple solution is to use [hddtemp](https://savannah.nongnu.org/projects/hddtemp/). @@ -85,7 +85,7 @@ sensor: unit_of_measurement: "°C" ``` -### {% linkable_title CPU temperature %} +### CPU temperature Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file: @@ -102,7 +102,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Monitoring failed login attempts on Home Assistant %} +### Monitoring failed login attempts on Home Assistant If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your `configuration.yaml` file: @@ -124,7 +124,7 @@ logger: homeassistant.components.http: warning ``` -### {% linkable_title Details about the upstream Home Assistant release %} +### Details about the upstream Home Assistant release You can see directly in the frontend (**Developer tools** -> **About**) what release of Home Assistant you are running. The Home Assistant releases are available on the [Python Package Index](https://pypi.python.org/pypi). This makes it possible to get the current release. @@ -135,7 +135,7 @@ sensor: name: HA release ``` -### {% linkable_title Read value out of a remote text file %} +### Read value out of a remote text file If you own a devices which are storing values in text files which are accessible over HTTP then you can use the same approach as shown in the previous section. Instead of looking at the JSON response we directly grab the sensor's value. @@ -146,7 +146,7 @@ sensor: name: File value ``` -### {% linkable_title Use an external script %} +### Use an external script The example is doing the same as the [aREST sensor](/components/sensor.arest/) but with an external Python script. It should give you an idea about interfacing with devices which are exposing a RESTful API. @@ -175,7 +175,7 @@ sensor: command: "python3 /path/to/script/arest-value.py" ``` -### {% linkable_title Usage of templating in `command:` %} +### Usage of templating in `command:` [Templates](/docs/configuration/templating/) are supported in the `command:` configuration variable. This could be used if you want to include the state of a specific sensor as an argument to your external script. @@ -191,7 +191,7 @@ sensor: {% endraw %} -### {% linkable_title Usage of JSON attributes in command output %} +### Usage of JSON attributes in command output The example shows how you can retrieve multiple values with one sensor (where the additional are attributes) by using `value_json` and `json_attributes`. diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index 509091b5efa1..294b6de47418 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor The `knx` integration must be configured correctly, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file: @@ -78,7 +78,7 @@ type: | DPT-14 | | 14.* | | 4byte_float | | 14.* | -## {% linkable_title Full example %} +## Full example ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.markdown b/source/_components/sensor.markdown index e7b677297c39..8817df1e5c3d 100644 --- a/source/_components/sensor.markdown +++ b/source/_components/sensor.markdown @@ -18,7 +18,7 @@ Sensors are gathering information about states and conditions. Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. -## {% linkable_title Device Class %} +## Device Class The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors: diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index e0218005bdda..e5c0ad26785b 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. -## {% linkable_title Configuration %} +## Configuration To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file: @@ -116,7 +116,7 @@ registers: It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation. -### {% linkable_title Full example %} +### Full example Example a temperature sensor with a 10 seconds scan interval: diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index f9a79d23cce1..1eadc5db55fe 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. -## {% linkable_title Configuration %} +## Configuration To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file: @@ -129,11 +129,11 @@ device: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title JSON attributes topic configuration %} +### JSON attributes topic configuration The example sensor below shows a configuration example which uses a JSON dict: `{"ClientName": , "IP": , "MAC": , "RSSI": , "HostName": , "ConnectedSSID": }` in a separate topic `home/sensor1/attributes` to add extra attributes. It also makes use of the `availability` topic. Extra attributes will be displayed in the frontend and can also be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. @@ -153,7 +153,7 @@ sensor: ``` {% endraw %} -### {% linkable_title JSON attributes template configuration %} +### JSON attributes template configuration The example sensor below shows a configuration example which uses a JSON dict: `{"Timer1":{"Arm": , "Time":