From 4369499e8935bf8184f9e79a0180a6d2641afa1e Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 28 Jun 2019 05:10:56 +0200 Subject: [PATCH] Component(s) -> Integration(s) (#9705) --- source/_components/abode.markdown | 16 +++++++------- source/_components/actiontec.markdown | 2 +- source/_components/ads.markdown | 2 +- source/_components/aftership.markdown | 2 +- .../alarm_control_panel.mqtt.markdown | 4 ++-- source/_components/alarmdecoder.markdown | 4 ++-- source/_components/alert.markdown | 10 ++++----- source/_components/alexa.intent.markdown | 4 ++-- source/_components/alexa.smart_home.markdown | 2 +- source/_components/ambient_station.markdown | 4 ++-- source/_components/amcrest.markdown | 2 +- source/_components/android_ip_webcam.markdown | 4 ++-- source/_components/androidtv.markdown | 4 ++-- source/_components/apcupsd.markdown | 4 ++-- source/_components/api.markdown | 2 +- source/_components/aprs.markdown | 2 +- source/_components/aqualogic.markdown | 4 ++-- source/_components/arduino.markdown | 2 +- source/_components/arlo.markdown | 4 ++-- source/_components/aruba.markdown | 2 +- source/_components/asterisk_mbox.markdown | 4 ++-- source/_components/asuswrt.markdown | 4 ++-- source/_components/august.markdown | 2 +- source/_components/auth.markdown | 6 ++--- source/_components/automatic.markdown | 2 +- source/_components/aws.markdown | 6 ++--- source/_components/azure_event_hub.markdown | 4 ++-- source/_components/bbb_gpio.markdown | 4 ++-- source/_components/bbox.markdown | 2 +- source/_components/binary_sensor.knx.markdown | 2 +- .../_components/binary_sensor.rflink.markdown | 4 ++-- .../_components/binary_sensor.rfxtrx.markdown | 8 +++---- .../binary_sensor.xiaomi_aqara.markdown | 2 +- source/_components/blink.markdown | 4 ++-- source/_components/bloomsky.markdown | 10 ++++----- source/_components/bluesound.markdown | 2 +- source/_components/bme680.markdown | 2 +- .../_components/bmw_connected_drive.markdown | 12 +++++----- source/_components/browser.markdown | 4 ++-- source/_components/brunt.markdown | 2 +- source/_components/bt_home_hub_5.markdown | 2 +- source/_components/bt_smarthub.markdown | 2 +- source/_components/buienradar.markdown | 6 ++--- source/_components/caldav.markdown | 4 ++-- source/_components/calendar.google.markdown | 4 ++-- source/_components/calendar.markdown | 2 +- source/_components/camera.markdown | 10 ++++----- source/_components/canary.markdown | 2 +- source/_components/cast.markdown | 4 ++-- source/_components/cisco_ios.markdown | 2 +- .../cisco_mobility_express.markdown | 2 +- source/_components/clementine.markdown | 2 +- source/_components/climate.knx.markdown | 2 +- source/_components/climate.markdown | 2 +- source/_components/climate.mysensors.markdown | 2 +- source/_components/cloudflare.markdown | 6 ++--- source/_components/coinbase.markdown | 4 ++-- source/_components/comfoconnect.markdown | 6 ++--- source/_components/config.markdown | 2 +- source/_components/configurator.markdown | 6 ++--- source/_components/conversation.markdown | 4 ++-- source/_components/counter.markdown | 4 ++-- source/_components/cover.knx.markdown | 2 +- source/_components/cover.rflink.markdown | 2 +- source/_components/cover.template.markdown | 2 +- source/_components/cppm.markdown | 2 +- source/_components/daikin.markdown | 4 ++-- source/_components/danfoss_air.markdown | 4 ++-- source/_components/datadog.markdown | 6 ++--- source/_components/ddwrt.markdown | 2 +- source/_components/deconz.markdown | 4 ++-- source/_components/default_config.markdown | 4 ++-- source/_components/demo.markdown | 4 ++-- .../device_sun_light_trigger.markdown | 4 ++-- source/_components/device_tracker.markdown | 2 +- .../device_tracker.xiaomi.markdown | 2 +- source/_components/dialogflow.markdown | 4 ++-- source/_components/digital_ocean.markdown | 2 +- source/_components/digitalloggers.markdown | 2 +- source/_components/discord.markdown | 2 +- source/_components/discovery.markdown | 4 ++-- source/_components/dispatcher.markdown | 2 +- source/_components/dominos.markdown | 6 ++--- source/_components/dovado.markdown | 4 ++-- source/_components/downloader.markdown | 4 ++-- source/_components/dsmr.markdown | 4 ++-- source/_components/duckdns.markdown | 6 ++--- source/_components/dweet.markdown | 4 ++-- source/_components/dyson.markdown | 6 ++--- source/_components/ebusd.markdown | 2 +- source/_components/ecoal_boiler.markdown | 2 +- source/_components/ecobee.markdown | 10 ++++----- source/_components/ecovacs.markdown | 4 ++-- source/_components/edp_redy.markdown | 2 +- source/_components/ee_brightbox.markdown | 2 +- source/_components/egardia.markdown | 6 ++--- source/_components/eight_sleep.markdown | 2 +- source/_components/emoncms.markdown | 2 +- source/_components/emoncms_history.markdown | 4 ++-- source/_components/emulated_hue.markdown | 6 ++--- source/_components/emulated_roku.markdown | 8 +++---- source/_components/enocean.markdown | 2 +- source/_components/envisalink.markdown | 8 +++---- source/_components/esphome.markdown | 4 ++-- source/_components/eufy.markdown | 4 ++-- source/_components/evohome.markdown | 6 ++--- source/_components/facebox.markdown | 2 +- source/_components/fail2ban.markdown | 2 +- source/_components/fan.markdown | 2 +- source/_components/fan.template.markdown | 2 +- source/_components/fastdotcom.markdown | 6 ++--- source/_components/feedreader.markdown | 2 +- source/_components/ffmpeg.markdown | 2 +- source/_components/flexit.markdown | 2 +- source/_components/flic.markdown | 6 ++--- source/_components/flux.markdown | 2 +- source/_components/flux_led.markdown | 2 +- source/_components/folder_watcher.markdown | 4 ++-- source/_components/foursquare.markdown | 4 ++-- source/_components/freebox.markdown | 2 +- source/_components/freedns.markdown | 4 ++-- source/_components/fritz.markdown | 2 +- source/_components/fritzbox.markdown | 2 +- .../_components/fritzbox_netmonitor.markdown | 2 +- source/_components/fritzdect.markdown | 2 +- source/_components/frontier_silicon.markdown | 8 +++---- .../_components/generic_thermostat.markdown | 2 +- source/_components/geofency.markdown | 4 ++-- source/_components/goalfeed.markdown | 2 +- source/_components/google_assistant.markdown | 6 ++--- source/_components/google_domains.markdown | 4 ++-- source/_components/google_pubsub.markdown | 2 +- source/_components/google_translate.markdown | 2 +- source/_components/googlehome.markdown | 10 ++++----- source/_components/gpsd.markdown | 2 +- source/_components/gpslogger.markdown | 2 +- source/_components/graphite.markdown | 2 +- source/_components/greeneye_monitor.markdown | 2 +- source/_components/greenwave.markdown | 4 ++-- source/_components/group.markdown | 2 +- source/_components/habitica.markdown | 4 ++-- source/_components/hangouts.markdown | 12 +++++----- source/_components/hdmi_cec.markdown | 4 ++-- source/_components/heos.markdown | 4 ++-- source/_components/hipchat.markdown | 2 +- source/_components/history.markdown | 12 +++++----- source/_components/history_graph.markdown | 4 ++-- source/_components/history_stats.markdown | 10 ++++----- source/_components/hitron_coda.markdown | 4 ++-- source/_components/hive.markdown | 8 +++---- source/_components/homekit.markdown | 22 +++++++++---------- .../_components/homekit_controller.markdown | 4 ++-- source/_components/homematic.markdown | 6 ++--- source/_components/homematicip_cloud.markdown | 6 ++--- source/_components/homeworks.markdown | 6 ++--- source/_components/hook.markdown | 4 ++-- source/_components/horizon.markdown | 4 ++-- source/_components/hp_ilo.markdown | 2 +- source/_components/http.markdown | 6 ++--- source/_components/huawei_lte.markdown | 6 ++--- source/_components/huawei_router.markdown | 2 +- source/_components/hue.markdown | 4 ++-- source/_components/hydrawise.markdown | 2 +- source/_components/icloud.markdown | 4 ++-- source/_components/idteck_prox.markdown | 2 +- source/_components/ifttt.markdown | 4 ++-- source/_components/ihc.markdown | 6 ++--- source/_components/image_processing.markdown | 2 +- source/_components/imap.markdown | 2 +- source/_components/influxdb.markdown | 12 +++++----- source/_components/input_boolean.markdown | 6 ++--- source/_components/input_datetime.markdown | 8 +++---- source/_components/input_number.markdown | 8 +++---- source/_components/input_select.markdown | 8 +++---- source/_components/input_text.markdown | 8 +++---- source/_components/insteon.markdown | 4 ++-- source/_components/intent_script.markdown | 2 +- source/_components/introduction.markdown | 4 ++-- source/_components/ios.markdown | 2 +- source/_components/iota.markdown | 4 ++-- source/_components/iperf3.markdown | 8 +++---- source/_components/itach.markdown | 4 ++-- source/_components/joaoapps_join.markdown | 4 ++-- source/_components/keenetic_ndms2.markdown | 4 ++-- source/_components/keyboard.markdown | 2 +- source/_components/keyboard_remote.markdown | 6 ++--- source/_components/kira.markdown | 4 ++-- source/_components/knx.markdown | 8 +++---- source/_components/kodi.markdown | 2 +- source/_components/konnected.markdown | 10 ++++----- source/_components/kwb.markdown | 2 +- source/_components/lannouncer.markdown | 2 +- source/_components/lcn.markdown | 6 ++--- source/_components/lg_netcast.markdown | 2 +- source/_components/lg_soundbar.markdown | 2 +- source/_components/life360.markdown | 2 +- source/_components/lifx.markdown | 6 ++--- source/_components/light.knx.markdown | 4 ++-- source/_components/light.markdown | 2 +- source/_components/light.rflink.markdown | 4 ++-- source/_components/light.template.markdown | 2 +- .../_components/light.xiaomi_aqara.markdown | 2 +- source/_components/lightwave.markdown | 6 ++--- source/_components/linksys_ap.markdown | 2 +- source/_components/linksys_smart.markdown | 2 +- source/_components/linode.markdown | 2 +- source/_components/lirc.markdown | 4 ++-- source/_components/lock.markdown | 2 +- source/_components/lock.template.markdown | 2 +- source/_components/logbook.markdown | 14 ++++++------ source/_components/logentries.markdown | 4 ++-- source/_components/logger.markdown | 12 +++++----- source/_components/logi_circle.markdown | 2 +- source/_components/london_air.markdown | 2 +- source/_components/luci.markdown | 4 ++-- source/_components/luftdaten.markdown | 4 ++-- source/_components/lupusec.markdown | 2 +- source/_components/lutron.markdown | 6 ++--- source/_components/lutron_caseta.markdown | 8 +++---- source/_components/mailgun.markdown | 2 +- source/_components/manual.markdown | 2 +- source/_components/manual_mqtt.markdown | 2 +- source/_components/matrix.markdown | 2 +- source/_components/maxcube.markdown | 2 +- source/_components/mcp23017.markdown | 2 +- source/_components/media_extractor.markdown | 2 +- source/_components/media_player.markdown | 2 +- source/_components/mediaroom.markdown | 10 ++++----- source/_components/melissa.markdown | 6 ++--- source/_components/mercedesme.markdown | 8 +++---- source/_components/meteo_france.markdown | 4 ++-- source/_components/meteoalarm.markdown | 2 +- source/_components/metoffice.markdown | 2 +- source/_components/mhz19.markdown | 2 +- source/_components/microsoft.markdown | 2 +- source/_components/microsoft_face.markdown | 4 ++-- source/_components/mikrotik.markdown | 2 +- source/_components/mobile_app.markdown | 10 ++++----- source/_components/mochad.markdown | 2 +- source/_components/mold_indicator.markdown | 6 ++--- source/_components/mopar.markdown | 2 +- source/_components/mpchc.markdown | 2 +- source/_components/mqtt_eventstream.markdown | 2 +- source/_components/mqtt_room.markdown | 2 +- source/_components/mqtt_statestream.markdown | 12 +++++----- source/_components/mychevy.markdown | 6 ++--- source/_components/mysensors.markdown | 6 ++--- source/_components/mythicbeastsdns.markdown | 4 ++-- source/_components/n26.markdown | 2 +- source/_components/namecheapdns.markdown | 4 ++-- source/_components/neato.markdown | 2 +- source/_components/ness_alarm.markdown | 2 +- source/_components/nest.markdown | 8 +++---- source/_components/netatmo.markdown | 14 ++++++------ source/_components/netgear.markdown | 4 ++-- source/_components/nissan_leaf.markdown | 6 ++--- source/_components/nmap_tracker.markdown | 2 +- source/_components/nmbs.markdown | 2 +- source/_components/no_ip.markdown | 4 ++-- source/_components/norway_air.markdown | 2 +- source/_components/notify.knx.markdown | 2 +- source/_components/notify.markdown | 4 ++-- source/_components/nuheat.markdown | 2 +- source/_components/nuimo_controller.markdown | 2 +- source/_components/octoprint.markdown | 2 +- source/_components/onboarding.markdown | 4 ++-- source/_components/onkyo.markdown | 2 +- source/_components/opentherm_gw.markdown | 6 ++--- source/_components/openuv.markdown | 6 ++--- source/_components/openwrt.markdown | 2 +- source/_components/orangepi_gpio.markdown | 6 ++--- source/_components/owlet.markdown | 6 ++--- source/_components/panel_custom.markdown | 2 +- .../persistent_notification.markdown | 2 +- source/_components/person.markdown | 8 +++---- source/_components/pilight.markdown | 6 ++--- source/_components/ping.markdown | 4 ++-- source/_components/plaato.markdown | 2 +- source/_components/plant.markdown | 2 +- source/_components/plex.markdown | 2 +- source/_components/postnl.markdown | 2 +- source/_components/prometheus.markdown | 6 ++--- source/_components/proximity.markdown | 8 +++---- source/_components/ps4.markdown | 12 +++++----- source/_components/ptvsd.markdown | 6 ++--- .../_components/pulseaudio_loopback.markdown | 4 ++-- source/_components/pushover.markdown | 4 ++-- source/_components/python_script.markdown | 2 +- source/_components/qnap.markdown | 2 +- source/_components/quantum_gateway.markdown | 2 +- source/_components/qwikswitch.markdown | 4 ++-- source/_components/rachio.markdown | 2 +- source/_components/rainbird.markdown | 2 +- source/_components/raincloud.markdown | 2 +- source/_components/rainmachine.markdown | 2 +- source/_components/raspihats.markdown | 2 +- source/_components/raspyrfm.markdown | 6 ++--- source/_components/recorder.markdown | 10 ++++----- source/_components/remember_the_milk.markdown | 4 ++-- source/_components/remote_rpi_gpio.markdown | 2 +- source/_components/repetier.markdown | 2 +- source/_components/rest.markdown | 2 +- source/_components/rest_command.markdown | 2 +- source/_components/rflink.markdown | 10 ++++----- source/_components/rfxtrx.markdown | 2 +- source/_components/ring.markdown | 4 ++-- source/_components/ritassist.markdown | 2 +- source/_components/roku.markdown | 4 ++-- source/_components/roomba.markdown | 2 +- source/_components/route53.markdown | 8 +++---- source/_components/rova.markdown | 2 +- source/_components/rpi_camera.markdown | 2 +- source/_components/rpi_gpio.markdown | 2 +- source/_components/rpi_pfio.markdown | 2 +- source/_components/rss_feed_template.markdown | 4 ++-- source/_components/sabnzbd.markdown | 2 +- source/_components/satel_integra.markdown | 2 +- source/_components/scene.knx.markdown | 2 +- source/_components/scene.markdown | 2 +- source/_components/script.markdown | 2 +- source/_components/scsgate.markdown | 4 ++-- source/_components/sensehat.markdown | 2 +- source/_components/sensor.buienradar.markdown | 4 ++-- source/_components/sensor.knx.markdown | 2 +- source/_components/sensor.rflink.markdown | 2 +- source/_components/shell_command.markdown | 2 +- source/_components/shiftr.markdown | 4 ++-- source/_components/shopping_list.markdown | 2 +- source/_components/sigfox.markdown | 2 +- source/_components/simplisafe.markdown | 2 +- source/_components/sisyphus.markdown | 2 +- source/_components/sky_hub.markdown | 2 +- source/_components/smappee.markdown | 6 ++--- source/_components/smarthab.markdown | 4 ++-- source/_components/smartthings.markdown | 20 ++++++++--------- source/_components/smarty.markdown | 4 ++-- source/_components/smhi.markdown | 2 +- source/_components/snips.markdown | 4 ++-- source/_components/snmp.markdown | 4 ++-- source/_components/solax.markdown | 2 +- source/_components/somfy.markdown | 4 ++-- source/_components/sonos.markdown | 4 ++-- source/_components/spaceapi.markdown | 4 ++-- source/_components/speedtestdotnet.markdown | 14 ++++++------ source/_components/spider.markdown | 6 ++--- source/_components/splunk.markdown | 4 ++-- source/_components/spotify.markdown | 2 +- source/_components/sql.markdown | 2 +- source/_components/srp_energy.markdown | 2 +- source/_components/statistics.markdown | 4 ++-- source/_components/statsd.markdown | 4 ++-- source/_components/stiebel_eltron.markdown | 4 ++-- source/_components/stream.markdown | 2 +- source/_components/streamlabswater.markdown | 4 ++-- source/_components/sun.markdown | 2 +- source/_components/swisscom.markdown | 2 +- source/_components/switch.knx.markdown | 4 ++-- source/_components/switch.rflink.markdown | 4 ++-- source/_components/switch.rfxtrx.markdown | 2 +- source/_components/switch.template.markdown | 2 +- source/_components/switcher_kis.markdown | 4 ++-- source/_components/switchmate.markdown | 2 +- source/_components/synology.markdown | 2 +- source/_components/synology_srm.markdown | 2 +- source/_components/system_health.markdown | 6 ++--- source/_components/system_log.markdown | 8 +++---- source/_components/systemmonitor.markdown | 2 +- source/_components/tado.markdown | 4 ++-- source/_components/tahoma.markdown | 2 +- source/_components/tcp.markdown | 2 +- source/_components/telegram_bot.markdown | 4 ++-- source/_components/tellduslive.markdown | 6 ++--- source/_components/tellstick.markdown | 2 +- source/_components/tensorflow.markdown | 6 ++--- source/_components/tesla.markdown | 4 ++-- source/_components/tfiac.markdown | 2 +- source/_components/thethingsnetwork.markdown | 2 +- source/_components/thingspeak.markdown | 4 ++-- source/_components/thomson.markdown | 2 +- source/_components/tibber.markdown | 2 +- source/_components/timer.markdown | 4 ++-- source/_components/tod.markdown | 2 +- source/_components/todoist.markdown | 2 +- source/_components/tomato.markdown | 2 +- source/_components/toon.markdown | 6 ++--- source/_components/tplink.markdown | 8 +++---- source/_components/tradfri.markdown | 2 +- source/_components/transmission.markdown | 4 ++-- source/_components/tts.markdown | 4 ++-- source/_components/tuya.markdown | 2 +- source/_components/twilio.markdown | 8 +++---- source/_components/ubee.markdown | 4 ++-- source/_components/ubus.markdown | 4 ++-- source/_components/unifi.markdown | 8 +++---- source/_components/unifi_direct.markdown | 2 +- source/_components/upc_connect.markdown | 2 +- source/_components/upcloud.markdown | 2 +- source/_components/updater.markdown | 10 ++++----- source/_components/upnp.markdown | 8 +++---- source/_components/uscis.markdown | 2 +- source/_components/usps.markdown | 12 +++++----- source/_components/utility_meter.markdown | 4 ++-- source/_components/vacuum.markdown | 4 ++-- source/_components/vacuum.mqtt.markdown | 10 ++++----- .../_components/vacuum.xiaomi_miio.markdown | 2 +- source/_components/velbus.markdown | 2 +- source/_components/velux.markdown | 2 +- source/_components/vizio.markdown | 2 +- source/_components/volvooncall.markdown | 2 +- source/_components/vultr.markdown | 2 +- source/_components/w800rf32.markdown | 2 +- source/_components/wake_on_lan.markdown | 6 ++--- source/_components/water_heater.markdown | 2 +- source/_components/waterfurnace.markdown | 2 +- source/_components/watson_iot.markdown | 6 ++--- source/_components/waze_travel_time.markdown | 2 +- source/_components/webhooks.markdown | 2 +- source/_components/weblink.markdown | 4 ++-- source/_components/websocket_api.markdown | 2 +- source/_components/wemo.markdown | 6 ++--- source/_components/wink.markdown | 2 +- source/_components/wunderlist.markdown | 4 ++-- source/_components/xbox_live.markdown | 2 +- source/_components/xfinity.markdown | 2 +- source/_components/xiaomi_aqara.markdown | 2 +- source/_components/xs1.markdown | 4 ++-- source/_components/yamaha.markdown | 2 +- source/_components/yamaha_musiccast.markdown | 2 +- source/_components/yeelight.markdown | 6 ++--- source/_components/zabbix.markdown | 4 ++-- source/_components/zestimate.markdown | 2 +- source/_components/zha.markdown | 2 +- source/_components/zigbee.markdown | 2 +- source/_components/ziggo_mediabox_xl.markdown | 4 ++-- source/_components/zone.markdown | 4 ++-- source/_components/zoneminder.markdown | 4 ++-- source/_components/zwave.markdown | 2 +- .../python_component_automation.markdown | 2 +- 438 files changed, 862 insertions(+), 862 deletions(-) diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index 23f0002f664..b52572af492 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -31,7 +31,7 @@ redirect_from: - /components/sensor.abode/ --- -The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes. +The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes. Please visit the [Abode website](https://goabode.com/) for further information about Abode Security. @@ -88,13 +88,13 @@ polling: exclude: description: > A list of devices to exclude from Home Assistant by their Abode `device_id` - or `automation_id`, found within the component attributes. + or `automation_id`, found within the integration attributes. required: false type: list lights: description: > A list of switch devices that Home Assistant should treat as lights by the - switches Abode `device_id`, found within the component attributes. + switches Abode `device_id`, found within the integration attributes. required: false type: list {% endconfiguration %} @@ -159,16 +159,16 @@ Trigger a quick action automation on your Abode system. ### {% linkable_title Binary Sensor %} -This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. +This integration will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. -This component 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). +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 %} -This component 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). +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 %} -This component 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). +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). -This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. +This integration will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. diff --git a/source/_components/actiontec.markdown b/source/_components/actiontec.markdown index 837918b1b6d..9d90d557179 100644 --- a/source/_components/actiontec.markdown +++ b/source/_components/actiontec.markdown @@ -52,4 +52,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/ads.markdown b/source/_components/ads.markdown index 96adb3de43d..7dcbf645f14 100644 --- a/source/_components/ads.markdown +++ b/source/_components/ads.markdown @@ -62,7 +62,7 @@ ip_address: ## {% linkable_title Service %} -The ADS component will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. +The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. ```json { diff --git a/source/_components/aftership.markdown b/source/_components/aftership.markdown index 7ba102d0134..5991851acd6 100644 --- a/source/_components/aftership.markdown +++ b/source/_components/aftership.markdown @@ -70,5 +70,5 @@ api_key: | `slug` | `True` | string | Carrier e.g. `fedex`

-This component retrieves data from AfterShip public REST API, but the component is not affiliated with AfterShip. +This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.

diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index 4b698510c49..b32ef6da3ce 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`. -The component will accept the following states from your Alarm Panel (in lower case): +The integration will accept the following states from your Alarm Panel (in lower case): - `disarmed` - `armed_home` @@ -25,7 +25,7 @@ The component will accept the following states from your Alarm Panel (in lower c - `pending` - `triggered` -The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend. +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 %} diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index 1ca8c276b12..0bde582eaa7 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.alarmdecoder/ --- -The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. +The `alarmdecoder` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices. @@ -138,7 +138,7 @@ There are several attributes available on the alarm panel to give you more infor ## {% linkable_title Services %} -The Alarm Decoder component gives you access to several services for you to control your alarm with. +The Alarm Decoder integration gives you access to several services for you to control your alarm with. - `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm. - `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm. diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index e1d74c78cc0..0819c986319 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -14,8 +14,8 @@ ha_release: 0.38 ha_qa_scale: internal --- -The `alert` component is designed to notify you when problematic issues arise. -For example, if the garage door is left open, the `alert` component can be used +The `alert` integration is designed to notify you when problematic issues arise. +For example, if the garage door is left open, the `alert` integration can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention. @@ -25,7 +25,7 @@ This entity allows you to silence an alert until it is resolved. ### {% linkable_title Basic Example %} -The `alert` component makes use of any of the `notifications` components. To +The `alert` integration makes use of any of the `notifications` components. To setup the `alert` component, first, you must setup a `notification` component. Then, add the following to your configuration file: @@ -97,7 +97,7 @@ done_message: required: false type: template notifiers: - description: "List of `notification` components to use for alerts." + description: "List of `notification` integrations to use for alerts." required: true type: list data: @@ -145,7 +145,7 @@ alert: ### {% linkable_title Complex Alert Criteria %} -By design, the `alert` component only handles very simple criteria for firing. +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 point, it may be desirable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to diff --git a/source/_components/alexa.intent.markdown b/source/_components/alexa.intent.markdown index cb31bb9acb9..7c2c9552c4e 100644 --- a/source/_components/alexa.intent.markdown +++ b/source/_components/alexa.intent.markdown @@ -16,7 +16,7 @@ ha_release: "0.10" ## {% linkable_title I want to build custom commands to use with Echo %} -The built-in Alexa component allows you to integrate Home Assistant into Alexa/Amazon Echo. This component 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. +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.
@@ -90,7 +90,7 @@ This means that we can now ask Alexa things like: ## {% linkable_title Configuring Home Assistant %} -When activated, the Alexa component 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) component. +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) component. To enable Alexa, add the following entry to your `configuration.yaml` file: diff --git a/source/_components/alexa.smart_home.markdown b/source/_components/alexa.smart_home.markdown index 6a1bf1d8ed0..6aa184a6010 100644 --- a/source/_components/alexa.smart_home.markdown +++ b/source/_components/alexa.smart_home.markdown @@ -58,7 +58,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na ### {% linkable_title 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 component in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa. +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.

There already are some great tutorials and solutions in our community to achieve same goal "Create your Alexa Smart Home Skill to connect Home Assistant", for example: [Haaska](https://github.com/mike-grant/haaska/wiki). diff --git a/source/_components/ambient_station.markdown b/source/_components/ambient_station.markdown index 25b8e2dfb09..26b1d44306f 100644 --- a/source/_components/ambient_station.markdown +++ b/source/_components/ambient_station.markdown @@ -14,12 +14,12 @@ redirect_from: - /components/sensor.ambient_station/ --- -The `Ambient Weather Station` component retrieves local weather information +The `Ambient Weather Station` integration retrieves local weather information via personal weather stations from [Ambient Weather](https://ambientweather.net). ## {% linkable_title Setup %} -Using this component requires both an Application Key and an API Key. To +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). diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index b117f5f0157..8496955b831 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -177,7 +177,7 @@ documentation to install the `ffmpeg`. ## {% linkable_title Services %} -Once loaded, the `amcrest` component 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. +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. Available services: `enable_audio`, `disable_audio`, diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index 23db722ce76..82b75d0905a 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.android_ip_webcam/ --- -The `android_ip_webcam` component turns any Android phone or tablet into a network camera with multiple viewing options. +The `android_ip_webcam` integration turns any Android phone or tablet into a network camera with multiple viewing options. It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list. @@ -193,7 +193,7 @@ binary_sensor: ## {% linkable_title Camera %} -The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used. +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 %} diff --git a/source/_components/androidtv.markdown b/source/_components/androidtv.markdown index 5a86571d339..c88704769a4 100644 --- a/source/_components/androidtv.markdown +++ b/source/_components/androidtv.markdown @@ -137,7 +137,7 @@ media_player: ## {% linkable_title ADB Setup %} -This component works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this: +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 %} @@ -180,7 +180,7 @@ If you receive the error message `Error while setting up platform androidtv` in * Your key is not pre-authenticated. Before using the `adbkey` in Home Assistant, you _**must**_ connect to your device using the ADB binary and tell it to always allow connections from this computer. For more information, see the section [ADB Authentication](#adb-authentication) above. - * Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the component should work. + * Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the integration should work. 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. diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 24ba1f4e0fb..1c0c34eb34b 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -64,7 +64,7 @@ In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a devi ### {% linkable_title Configuration %} -To enable this sensor, you first have to set up apcupsd component (above), and add the following lines to your `configuration.yaml` file: +To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -86,7 +86,7 @@ name: ### {% linkable_title Configuration %} -To use this sensor platform, you first have to set up apcupsd component (above), and add the following to your `configuration.yaml` file: +To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/api.markdown b/source/_components/api.markdown index 5a52ecaadc1..8f6415bbe0b 100644 --- a/source/_components/api.markdown +++ b/source/_components/api.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). +The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/).

It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet. diff --git a/source/_components/aprs.markdown b/source/_components/aprs.markdown index c01cfb3519b..ec90a7bcdee 100644 --- a/source/_components/aprs.markdown +++ b/source/_components/aprs.markdown @@ -13,7 +13,7 @@ ha_category: Presence Detection ha_iot_class: Cloud Push --- -The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker component connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices. +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 %} diff --git a/source/_components/aqualogic.markdown b/source/_components/aqualogic.markdown index dcfb0dc2814..ebfc8d3773a 100644 --- a/source/_components/aqualogic.markdown +++ b/source/_components/aqualogic.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.aqualogic/ --- -The AquaLogic component provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required. +The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required. There is currently support for the following device types within Home Assistant: @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To add the AquaLogic component to your installation, add the following to your `configuration.yaml` file: +To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index 99730e999c1..f61098f5d30 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -25,7 +25,7 @@ The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards. -The `arduino` component is designed to let you use a directly attached board to your Home Assistant host over USB. +The `arduino` integration is designed to let you use a directly attached board to your Home Assistant host over USB. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index 7093ead44b1..d7316c4a790 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -59,7 +59,7 @@ It is recommended to create a dedicated user on Arlo website to be used within H Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/). Arlo also has a service call `arlo.update` that can be manually called to force an update prior to the regular scheduled interval. -The Arlo component also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts. +The Arlo integration also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts. ```yaml #automation.yaml @@ -142,7 +142,7 @@ More examples and configuration options can be found on the [Manual Alarm Contro ## {% linkable_title Camera %} -This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture. +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 %} diff --git a/source/_components/aruba.markdown b/source/_components/aruba.markdown index b2c9c179cf4..ab1b1ebacb9 100644 --- a/source/_components/aruba.markdown +++ b/source/_components/aruba.markdown @@ -52,4 +52,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index d3c39d744b4..ea9796d3b07 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/mailbox.asterisk_mbox/ --- -The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. +The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The integration includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server. @@ -52,5 +52,5 @@ port: {% endconfiguration %}

-Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network. +Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this integration when communication is contained within a local area network.

diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown index b887ca33fdf..f6ef9bcfef9 100644 --- a/source/_components/asuswrt.markdown +++ b/source/_components/asuswrt.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.asuswrt/ --- -The `asuswrt` component is the main component to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router. +The `asuswrt` integration is the main integration to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router. There is currently support for the following device types within Home Assistant: @@ -120,7 +120,7 @@ The example above, creates the following sensors: ## {% linkable_title 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 component can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router. +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. Follow these steps to setup the link. diff --git a/source/_components/august.markdown b/source/_components/august.markdown index e0465ae7c87..fb641c641c1 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/lock.august/ --- -The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. +The `august` integration allows you to integrate your [August](http://august.com) devices in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/auth.markdown b/source/_components/auth.markdown index f824be4c2e3..044caa74c1e 100644 --- a/source/_components/auth.markdown +++ b/source/_components/auth.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Auth" -description: "This component is responsible for providing the authentication endpoints." +description: "This integration is responsible for providing the authentication endpoints." date: 2018-03-19 21:04 sidebar: true comments: false @@ -14,5 +14,5 @@ ha_release: 0.73 ha_qa_scale: internal --- -This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. -There are no configuration options for this component directly as it relies on the auth system in the core. +This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. +There are no configuration options for this integration directly as it relies on the auth system in the core. diff --git a/source/_components/automatic.markdown b/source/_components/automatic.markdown index d61633029fe..cc3608be1c6 100644 --- a/source/_components/automatic.markdown +++ b/source/_components/automatic.markdown @@ -80,4 +80,4 @@ automation: You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.

-See the [device tracker component page](/components/device_tracker/) for instructions how to configure the cars to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the cars to be tracked. diff --git a/source/_components/aws.markdown b/source/_components/aws.markdown index 3ae8e046576..42d8a5cff76 100644 --- a/source/_components/aws.markdown +++ b/source/_components/aws.markdown @@ -21,11 +21,11 @@ You have to have an AWS account to use Amazon Web Services, create one [here](ht The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide an **Always Free** tier for all users even after the 12-month period. The general usage in Home Automation will most likely not reach the free tier limit. Please read [Lambda Pricing](https://aws.amazon.com/lambda/pricing/), [SNS Pricing](https://aws.amazon.com/sns/pricing/) and [SQS Pricing](https://aws.amazon.com/sqs/pricing/) for more details. -The `aws` component 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. +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 %} -To use the `aws` component and the `notify` platform in your installation, add the following to your `configuration.yaml` file: +To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -35,7 +35,7 @@ aws: aws_access_key_id: AWS_ID aws_secret_access_key: AWS_SECRET notify: - # use the first credential defined in aws component by default + # use the first credential defined in aws integration by default - service: lambda region_name: us-east-1 ``` diff --git a/source/_components/azure_event_hub.markdown b/source/_components/azure_event_hub.markdown index 63c0219676e..7a000e4b5b4 100644 --- a/source/_components/azure_event_hub.markdown +++ b/source/_components/azure_event_hub.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.94 --- -The `Azure Event Hub` component 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). +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 %} @@ -23,7 +23,7 @@ You need to create a Event Hub namespace and a Event Hub in that namespace, you You must then create a Shared Access Policy for the Event Hub with 'Send' claims or use the RootManageAccessKey from your namespace (this key has additional claims, including managing the event hub and listening, which are not needed for this purpose), for more details on the security of Event Hubs [go here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-authentication-and-security-model-overview). -Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the component itself. +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 %} diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index 9fcfe4b5169..41456239c96 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -19,8 +19,8 @@ redirect_from: - /components/switch.bbb_gpio/ --- -The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. -There is no setup needed for the component itself. +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 %} diff --git a/source/_components/bbox.markdown b/source/_components/bbox.markdown index 402228e8cc7..6cea270f529 100644 --- a/source/_components/bbox.markdown +++ b/source/_components/bbox.markdown @@ -61,7 +61,7 @@ host: For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation.

-See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Sensor %} diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index c0351d17788..6e5f40cde95 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary ## {% linkable_title Configuration %} -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ```yaml # Example configuration.yaml entry diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown index 11426bff5e6..af278eaac7c 100644 --- a/source/_components/binary_sensor.rflink.markdown +++ b/source/_components/binary_sensor.rflink.markdown @@ -14,11 +14,11 @@ ha_iot_class: Local Push ha_release: 0.81 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). -The RFLink component 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. +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. RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`. diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index 1049752bb7c..2770ffc60a3 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -15,12 +15,12 @@ ha_release: 0.48 The `rfxtrx` platform support binary sensors that communicate in the frequency range of 433.92 MHz. -The rfxtrx binary sensor component provides support for them. +The rfxtrx binary sensor integration provides support for them. Many cheap sensors available on the web today are based on a particular RF chip called *PT-2262*. Depending on the running firmware on the RFXcom box, some of them may be recognized under the X10 protocol but most of them are recognized -under the *Lighting4* protocol. The rfxtrx binary sensor component provides +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 %} @@ -95,7 +95,7 @@ automatic_add: {% endconfiguration %}

-This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. +This integration and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.

@@ -188,7 +188,7 @@ devices: command_off: 0x7 ``` -The *automatic_add* option makes the rfxtrx binary sensor component calculate +The *automatic_add* option makes the rfxtrx binary sensor integration calculate and display the configuration options for you in the Home Assistant logs: ```text diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index 30ee1d358cd..0933d4e0fab 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -186,7 +186,7 @@ As indicated in the table on top of this page there are 3 versions of the button #### {% linkable_title Xiaomi Cube %} -Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The component stores the last action as the attribute `last_action`. +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`. ```yaml - alias: Cube event flip90 diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 483831ff3c7..72f1dc651ab 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/sensor.blink/ --- -The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. +The `blink` integration lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. ## {% linkable_title Setup %} @@ -85,7 +85,7 @@ mode: default: not set {% endconfiguration %} -Once Home Assistant starts, the `blink` component will create the following platforms: +Once Home Assistant starts, the `blink` integration will create the following platforms: - An `alarm_control_panel` to arm/disarm the whole blink system (note, `alarm_arm_home` is not implemented and will not actually do anything, despite it being an option in the GUI). - A `camera` for each camera linked to your Blink sync module. diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index 6f99dce63d5..fb698d76d57 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/binary_sensor.bloomsky/ --- -The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. +The `bloomsky` integration allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. There is currently support for the following device types within Home Assistant: @@ -81,11 +81,11 @@ monitored_conditions: ## {% linkable_title Camera %} -The `bloomsky` camera component 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). +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 %} -To enable this camera in your installation, set up the BloomSky component with your API key and add the following to your `configuration.yaml` file: +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: ```yaml # Example configuration.yaml entry @@ -95,11 +95,11 @@ camera: ## {% linkable_title Sensor %} -The `bloomsky` sensor component 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). +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 %} -To enable these sensors in your installation, set up the BloomSky component with your API key add the following to your `configuration.yaml` file: +To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/bluesound.markdown b/source/_components/bluesound.markdown index 8e1b4f1b972..e52956fde09 100644 --- a/source/_components/bluesound.markdown +++ b/source/_components/bluesound.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.bluesound/ --- -The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio components from Home Assistant. +The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant. If you want to automatically discover new devices, just make sure you have discovery: in your configuration.yaml file. To manually add a Bluesound device to your installation, add the following to your configuration.yaml file: diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown index 579da0493fa..ada45594307 100644 --- a/source/_components/bme680.markdown +++ b/source/_components/bme680.markdown @@ -99,7 +99,7 @@ gas_heater_duration: default: 150 type: integer aq_burn_in_time: - description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor component is first initialized. + description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor integration is first initialized. required: false default: 300 type: integer diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index b3d8f82384b..f3b96b9aa51 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -22,13 +22,13 @@ redirect_from: - /components/sensor.bmw_connected_drive/ --- -The `bmw_connected_drive` component lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. +The `bmw_connected_drive` integration lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. -The `bmw_connected_drive` component also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work. +The `bmw_connected_drive` integration also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work. For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github. -This component provides the following platforms: +This integration provides the following platforms: - Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars). - Device tracker: The location of your car. @@ -38,7 +38,7 @@ This component provides the following platforms: ## {% linkable_title Configuration %} -To enable this component in your installation, add the following to your +To enable this integration in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -81,13 +81,13 @@ bmw_connected_drive: ## {% linkable_title Services %} -The `bmw_connected_drive` component 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`. +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 %} -The vehicle can be locked and unlocked via the lock component 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. +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 %} diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index c0a1501a0f6..be89e2b0fc5 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Browser" -description: "Instructions on how to setup the browser component with Home Assistant." +description: "Instructions on how to setup the browser integration with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -The `browser` component provides a service to open URLs in the default browser on the host machine. +The `browser` integration provides a service to open URLs in the default browser on the host machine. ## {% linkable_title Configuration %} diff --git a/source/_components/brunt.markdown b/source/_components/brunt.markdown index f1b62530d9d..3077d4388f8 100644 --- a/source/_components/brunt.markdown +++ b/source/_components/brunt.markdown @@ -46,5 +46,5 @@ password: {% endconfiguration %}

-This component is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk. +This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.

diff --git a/source/_components/bt_home_hub_5.markdown b/source/_components/bt_home_hub_5.markdown index 3b18f59ce59..ec1326906fa 100644 --- a/source/_components/bt_home_hub_5.markdown +++ b/source/_components/bt_home_hub_5.markdown @@ -34,4 +34,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/bt_smarthub.markdown b/source/_components/bt_smarthub.markdown index 4c60da14f48..e78c068af05 100644 --- a/source/_components/bt_smarthub.markdown +++ b/source/_components/bt_smarthub.markdown @@ -37,4 +37,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown index 67056c84e15..88d54720c6e 100644 --- a/source/_components/buienradar.markdown +++ b/source/_components/buienradar.markdown @@ -32,15 +32,15 @@ weather: {% configuration %} name: - description: "You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains." + description: "You can specify a name of the component, but do not have to. If you specify a name, the weather integration will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains." required: false type: string latitude: - description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. + description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar. required: false type: float longitude: - description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. + description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar. required: false type: float forecast: diff --git a/source/_components/caldav.markdown b/source/_components/caldav.markdown index 4116c6122a7..62d911f705a 100644 --- a/source/_components/caldav.markdown +++ b/source/_components/caldav.markdown @@ -24,8 +24,8 @@ The WebDav calendar get updated roughly every 15 minutes. ### {% linkable_title Prerequisites %} -You need to have a CalDav server and credentials for it. This component was -tested against [Baikal](http://sabre.io/baikal/) but any component complying +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 with the RFC4791 should work. [Nextcloud](https://nextcloud.com/) and [Owncloud](https://owncloud.org/) work fine. diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 41405af7e3a..680dd184974 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -17,7 +17,7 @@ ha_release: 0.33 The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for -matching events. When you first setup this component it will generate a new +matching events. When you first setup this integration it will generate a new 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. @@ -177,7 +177,7 @@ Otherwise everything following the hash sign would be considered a YAML comment. ### {% linkable_title 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 component gets your time zone from your `configuration.yaml` file. +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. | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| diff --git a/source/_components/calendar.markdown b/source/_components/calendar.markdown index 8c44c4c68e0..921aadb1d48 100644 --- a/source/_components/calendar.markdown +++ b/source/_components/calendar.markdown @@ -10,4 +10,4 @@ footer: true ha_release: 0.33 --- -The calendar component allows you to integrate your calendars into Home Assistant. +The calendar integration allows you to integrate your calendars into Home Assistant. diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index a8a4b967042..8df12502fdd 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -14,11 +14,11 @@ ha_qa_scale: internal ha_release: 0.7 --- -The camera component allows you to use IP cameras with Home Assistant. +The camera integration allows you to use IP cameras with Home Assistant. ### {% linkable_title Streaming Video %} -If your camera supports it, and the [`stream`](/components/stream) component is setup, you will be able to stream your cameras in the frontend and on supported media players. +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. This option will keep the stream alive, and preload the feed on Home Assistant startup. This will result in reduced latency when opening the stream in the frontend, as well as when using the `play_stream` service or Google Assistant integration. It does, however, utilize more resources on your machine, so it is recommended to check CPU usage if you plan to use this feature. @@ -36,13 +36,13 @@ Available services: `turn_on`, `turn_off`, `enable_motion_detection`, `disable_m #### {% linkable_title Service `play_stream` %} -Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) component to be set up. +Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) integration to be set up. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. | | `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. | -| `format` | yes | Stream format supported by `stream` component and selected `media_player`. Default: `hls` | +| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` | For example, the following action in an automation would send an `hls` live stream to your chromecast. @@ -111,7 +111,7 @@ action: #### {% linkable_title Service `record` %} -Make a `.mp4` recording from a camera stream. Requires `stream` component to be set up. +Make a `.mp4` recording from a camera stream. Requires `stream` integration to be set up. Both `duration` and `lookback` options are suggestions, but should be consistent per camera. The actual length of the recording may vary. It is suggested that you tweak these settings to fit your needs. diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 18ec9e71c7e..2ead4902559 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.canary/ --- -The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. +The `canary` integration allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 8bec9f32f5b..8fac5fb601c 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -18,12 +18,12 @@ redirect_from: /components/media_player.cast/ Google Cast devices like Android TVs and Chromecasts will be automatically discovered if you enable [the discovery component](/components/discovery/). If -you don't have the discovery component enabled, you can enable the Cast +you don't have the discovery integration enabled, you can enable the Cast component by going to the Integrations page inside the config panel. ## {% linkable_title Advanced use %} -The Cast component has some extra configuration options available for advanced +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 component. diff --git a/source/_components/cisco_ios.markdown b/source/_components/cisco_ios.markdown index a51701b2de4..9a33ccc101a 100644 --- a/source/_components/cisco_ios.markdown +++ b/source/_components/cisco_ios.markdown @@ -75,4 +75,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/cisco_mobility_express.markdown b/source/_components/cisco_mobility_express.markdown index 8260e3d26c5..f5878c778d4 100644 --- a/source/_components/cisco_mobility_express.markdown +++ b/source/_components/cisco_mobility_express.markdown @@ -51,4 +51,4 @@ verify_ssl: type: boolean {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/clementine.markdown b/source/_components/clementine.markdown index 2d5f57bd85d..3152d3859ac 100644 --- a/source/_components/clementine.markdown +++ b/source/_components/clementine.markdown @@ -52,4 +52,4 @@ Remember that Clementine must be configured to accept connections through its ne You can configure this through Clementine `Tools > Preferences > Network remote control` configuration menu. Enable `Use network remote control` and configure the other options for your use case. -This component does not implement the `play_media` service so you cannot add tracks to the playlist. +This integration does not implement the `play_media` service so you cannot add tracks to the playlist. diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index f99b2b3bd38..f7f7ba2063d 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `knx` climate platform is used as in interface with KNX thermostats. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index 131d13309b4..d19d54f49c6 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.19 --- -The `climate` component is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices. +The `climate` integration is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices. ## {% linkable_title Services %} diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index 31259de0e55..a2979394e0b 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -25,7 +25,7 @@ S_TYPE | V_TYPE -------|----------------------------------------------------------------------------- S_HVAC | V_HVAC_FLOW_STATE*, V_HVAC_SETPOINT_HEAT, V_HVAC_SETPOINT_COOL, V_HVAC_SPEED, V_TEMP -V_HVAC_FLOW_STATE is mapped to the state of the Climate component in Home Assistant as follows: +V_HVAC_FLOW_STATE is mapped to the state of the Climate integration in Home Assistant as follows: Home Assistant State | MySensors State ---------------------|---------------- diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index 548db436602..5334b6a996a 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.74 --- -With the `cloudflare` component can you keep your Cloudflare records up to date. +With the `cloudflare` integration can you keep your Cloudflare records up to date. -The component will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. +The integration will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. ## {% linkable_title Setup %} @@ -23,7 +23,7 @@ You will find your global API key in your Cloudflare account settings. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index 42a289aadc4..18bd47eb656 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -17,9 +17,9 @@ redirect_from: - /components/sensor.coinbase/ --- -The `coinbase` component lets you access account balances and exchange rates from [coinbase](https://coinbase.com). +The `coinbase` integration lets you access account balances and exchange rates from [coinbase](https://coinbase.com). -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 component to access relevant data. +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 %} diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown index 7fe631538dc..da74d90b9d7 100644 --- a/source/_components/comfoconnect.markdown +++ b/source/_components/comfoconnect.markdown @@ -17,14 +17,14 @@ redirect_from: - /components/sensor.comfoconnect/ --- -The `comfoconnect` component lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st) +The `comfoconnect` integration lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st) ventilation units from Home Assistant. You need a [ComfoConnect LAN C](http://www.zehnder.co.uk/products-and-systems/comfortable-indoor-ventilation/ms-comfoair-q/ideal-control#node-21233) bridge to connect the unit to your local network. There is an official iPhone and Android app to configure and control your unit. This platform connects with the help of the unofficial [pycomfoconnect](https://github.com/michaelarnauts/comfoconnect) library. -The component has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour). +The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour). To set it up, add the following information to your `configuration.yaml` file: @@ -75,5 +75,5 @@ sensor: ```

-Note that it's not possible to have multiple connection to the bridge at the same time. This component will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically. +Note that it's not possible to have multiple connection to the bridge at the same time. This integration will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically.

diff --git a/source/_components/config.markdown b/source/_components/config.markdown index 46613b40517..bee75a2f332 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -14,7 +14,7 @@ ha_release: 0.39 ha_qa_scale: internal --- -The `config` component is designed to display panels in the frontend to configure and manage parts of Home Assistant. +The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant. To enable the configuration panel, add the following to your `configuration.yaml` file: diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index 1778daa4ee7..cba5fe0f76f 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -15,15 +15,15 @@ ha_release: 0.7 ---

-This component is intended for developers. +This integration is intended for developers.

-The configurator component allows components to request information from the user. It is currently implemented as the minimum viable product: +The configurator integration allows integrations to request information from the user. It is currently implemented as the minimum viable product: - It supports showing a text, image and button to the user - Input fields can be defined with a description, and optional type - It will trigger a callback when the button is pressed -The Hue component in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. +The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator component. diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index 511a5de5aae..48817f6d338 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text. +The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.

@@ -28,7 +28,7 @@ conversation: {% configuration %} intents: - description: Intents that the conversation component should understand. + description: Intents that the conversation integration should understand. required: false type: map keys: diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index db9702990c4..2ecc7ea4a31 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -14,7 +14,7 @@ ha_release: 0.53 ha_qa_scale: internal --- -The `counter` component allows one to count occurrences fired by automations. +The `counter` integration allows one to count occurrences fired by automations. ## {% linkable_title Configuration %} @@ -72,7 +72,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi ### {% linkable_title Restore State %} -This component 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`. +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. diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index 77c17dd6d3d..0c93ae37070 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `knx` cover platform is used as in interface with KNX covers. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). To use your KNX covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 5ad0066782a..06fd87054b0 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -14,7 +14,7 @@ ha_release: 0.55 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 5f1188e5493..3c0cfc690d6 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -15,7 +15,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform can create covers that combine components and provides +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. diff --git a/source/_components/cppm.markdown b/source/_components/cppm.markdown index db74e277978..bdfb9c5b6b2 100644 --- a/source/_components/cppm.markdown +++ b/source/_components/cppm.markdown @@ -50,4 +50,4 @@ api_key: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 55079e1a5cf..4da14c4ff84 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.daikin/ --- -The `daikin` component integrates Daikin air conditioning systems into Home Assistant. +The `daikin` integration integrates Daikin air conditioning systems into Home Assistant. There is currently support for the following device types within Home Assistant: @@ -36,7 +36,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -The Daikin component can be configured in three ways. +The Daikin integration can be configured in three ways. - Automatically via the [discovery]({{site_root}}/components/discovery/) component. - Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC. diff --git a/source/_components/danfoss_air.markdown b/source/_components/danfoss_air.markdown index 5b8ab36e70a..4c0949d006b 100644 --- a/source/_components/danfoss_air.markdown +++ b/source/_components/danfoss_air.markdown @@ -21,9 +21,9 @@ redirect_from: - /components/switch.danfoss_air/ --- -The `danfoss_air` component allows you to access information from your Danfoss Air HRV unit. +The `danfoss_air` integration allows you to access information from your Danfoss Air HRV unit. -*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the component will not work while you have the HRV PC-Tool open. +*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the integration will not work while you have the HRV PC-Tool open. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/datadog.markdown b/source/_components/datadog.markdown index e2e5eaed0a6..b9cb8acc1e4 100644 --- a/source/_components/datadog.markdown +++ b/source/_components/datadog.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.45 --- -The `datadog` component sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](http://docs.datadoghq.com/guides/basic_agent_usage/). +The `datadog` integration sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](http://docs.datadoghq.com/guides/basic_agent_usage/). Datadog allows you to analyze, monitor, cross-reference and alert upon your data. You can use it to detect statistical anomalies, see graphs across multiple sources in real-time, send critical alerts to Slack, etc. @@ -21,13 +21,13 @@ Datadog allows you to analyze, monitor, cross-reference and alert upon your data

-The component also sends events from the logbook into Datadog, allowing you to correlate these events with your data. +The integration also sends events from the logbook into Datadog, allowing you to correlate these events with your data.

-To use the `datadog` component in your installation, add the following to your `configuration.yaml` file: +To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/ddwrt.markdown b/source/_components/ddwrt.markdown index 037c37f0647..9be10b84028 100644 --- a/source/_components/ddwrt.markdown +++ b/source/_components/ddwrt.markdown @@ -59,4 +59,4 @@ wireless_only: {% endconfiguration %} By default Home Assistant pulls information about connected devices from DD-WRT every 5 seconds. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 68037c57594..da5893b492a 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -61,9 +61,9 @@ 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 component %} +## {% linkable_title Debugging integration %} -If you have problems with deCONZ or the component you can add debug prints to the log. +If you have problems with deCONZ or the integration you can add debug prints to the log. ```yaml logger: diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 94da14c0739..4682e540076 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Default Config" -description: "The default config component will initate a default configuration for Home Assistant." +description: "The default config integration will initate a default configuration for Home Assistant." date: 2019-02-15 20:00 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_category: ha_release: 0.88 --- -This component is a meta-component and configures a default set of components for Home Assistant to load. The components that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json). +This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json). ## {% linkable_title Configuration %} diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index ed6d3f8844c..91f62e8cf49 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -15,7 +15,7 @@ ha_release: 0.7 --- -The `demo` platform allows you to use components which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. +The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. Available demo platforms: @@ -50,7 +50,7 @@ To integrate a demo platform in Home Assistant, add the following section to you {% configuration %} "[component]": - description: The name of the component as stated in the listing above the configuration example. + description: The name of the integration as stated in the listing above the configuration example. required: true type: string {% endconfiguration %} diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index 71e98fc27fc..d2e4a7724a7 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -14,13 +14,13 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -Home Assistant has a built-in component called `device_sun_light_trigger` to help you automate your lights. The component will: +Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will: * Fade in the lights when the sun is setting and there are people home * Turn on the lights when people get home after the sun has set * Turn off the lights when all people leave the house -This component requires the components [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled. +This integration requires the integrations [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled. To enable this component, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index dc671bfc810..fce0e65460e 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -67,7 +67,7 @@ Multiple device trackers can be used in parallel, such as [Owntracks](/component ## {% linkable_title `known_devices.yaml` %}

-As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the component you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative. +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.

Once `device_tracker` is enabled, a file will be created in your config dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked. diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index 5bf0ab35e72..f38e0b2ca4b 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -43,7 +43,7 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ### {% linkable_title Compatibility test %} diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index b3596b1f561..658f2002e9c 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -14,9 +14,9 @@ ha_release: 0.56 redirect_from: /components/apiai/ --- -The `dialogflow` component is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. +The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. -To be able to receive messages from DialogFlow, 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 component ([docs](/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). +To be able to receive messages from DialogFlow, 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)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms. diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 7449ceb98f0..2745b8d82a4 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.digital_ocean/ --- -The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. +The `digital_ocean` integration allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/digitalloggers.markdown b/source/_components/digitalloggers.markdown index 8270bef0e13..67076e7f7f8 100644 --- a/source/_components/digitalloggers.markdown +++ b/source/_components/digitalloggers.markdown @@ -63,4 +63,4 @@ cycletime: Your relays will be available in the form `switch.fantasticrelaydevice_individualrelayname` -**Note:** There is currently a limitation of the [dlipower library](https://github.com/dwighthubbard/python-dlipower) used by the `digitalloggers` component that communication is only available over port 80. +**Note:** There is currently a limitation of the [dlipower library](https://github.com/dwighthubbard/python-dlipower) used by the `digitalloggers` integration that communication is only available over port 80. diff --git a/source/_components/discord.markdown b/source/_components/discord.markdown index 1cd00bab30e..a331a67935f 100644 --- a/source/_components/discord.markdown +++ b/source/_components/discord.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/notify.discord/ --- -The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows components to send messages to the user using Discord. +The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows integrations to send messages to the user using Discord. In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a [bot](https://discordapp.com/developers/docs/topics/oauth2#bots) user (**Create a Bot User**). diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 040dd844878..0de9a0c918c 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect: +Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` integration can detect: * [Apple TV](/components/apple_tv/) * [Belkin WeMo switches](/components/wemo/) @@ -120,7 +120,7 @@ If running Home Assistant in a [Docker container](/docs/installation/docker/) us ### {% linkable_title Windows %} #### {% linkable_title 64-bit Python %} -There is currently a known issue with running this component on a 64-bit version of Python and Windows. +There is currently a known issue with running this integration on a 64-bit version of Python and Windows. #### {% linkable_title Python 3.5 %} diff --git a/source/_components/dispatcher.markdown b/source/_components/dispatcher.markdown index 8b961db7b03..e901f747ea2 100644 --- a/source/_components/dispatcher.markdown +++ b/source/_components/dispatcher.markdown @@ -24,7 +24,7 @@ The `dispatcher` camera platform allows developers to create virtual camera's. ## {% linkable_title Configuration %} -You would normally not add this camera to your configuration directly but have it be discovered by one of the components that uses it. +You would normally not add this camera to your configuration directly but have it be discovered by one of the integrations that uses it. ```yaml # Example configuration.yaml entry diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index 4fdd41e3bc3..f5d001a1506 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -14,9 +14,9 @@ ha_iot_class: Cloud Polling ha_release: 0.59 --- -The `dominos` component allows you to order Dominos Pizza from within your Home Assistant scripts and automations. +The `dominos` integration allows you to order Dominos Pizza from within your Home Assistant scripts and automations. -At present, this component only supports ordering within Canada and the US. +At present, this integration only supports ordering within Canada and the US. ## {% linkable_title Configuration %} @@ -24,7 +24,7 @@ To enable the component, you need to set up your customer information and define Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/wardcraigj/hass-dominos-panel) to see the available product codes in a separate panel in your install. -Currently, there is no support in this component for toppings, coupons or order tracking. +Currently, there is no support in this integration for toppings, coupons or order tracking. ```yaml dominos: diff --git a/source/_components/dovado.markdown b/source/_components/dovado.markdown index 10d73bc62b0..b751f3090ed 100644 --- a/source/_components/dovado.markdown +++ b/source/_components/dovado.markdown @@ -19,14 +19,14 @@ redirect_from: - /components/sensor.dovado/ --- -The `dovado` component manages communication with the [Dovado](http://www.dovado.com/) router. +The `dovado` integration manages communication with the [Dovado](http://www.dovado.com/) router. There is currently support for the following device types within Home Assistant: - [Notifications](/components/dovado/#notifications) - [Sensor](/components/dovado/#sensor) -To add a Dovado component to your installation, add the following to your `configuration.yaml` file: +To add a Dovado integration to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index 37844a8da15..e68266d7b58 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Downloader" -description: "Instructions on how to setup the downloader component with Home Assistant." +description: "Instructions on how to setup the downloader integration with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: pre 0.7 ha_qa_scale: internal --- -The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant. +The `downloader` integration provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant. To enable it, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown index b5ab05cf326..5b70e83d324 100644 --- a/source/_components/dsmr.markdown +++ b/source/_components/dsmr.markdown @@ -27,7 +27,7 @@ A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter

-This component is known to work for: +This integration is known to work for: - Iskra ME382 / MT382 (DSMR 2.2) - ISKRA AM550 (DSMR 5.0) @@ -149,6 +149,6 @@ DSMR is a standard to which Dutch smartmeters must comply. It specifies that the The contents of this telegram differ between version but they generally consist of lines with 'obis' (Object Identification System, a numerical ID for a value) followed with the value and unit. -This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this component are create during bootstrap. +This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this integration are create during bootstrap. Another loop (DSMR class) is setup which reads the telegram queue, stores/caches the latest telegram and notifies the Entities that the telegram has been updated. diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 9e34593fdfc..0b17ab99db3 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.55 --- -With the DuckDNS component 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. +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 %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -38,5 +38,5 @@ duckdns: {% endconfiguration %}

-If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this component is not required. The add-on will keep your IP updated with DuckDNS. +If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this integration is not required. The add-on will keep your IP updated with DuckDNS.

diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown index 26235c2997d..3ce577fe423 100644 --- a/source/_components/dweet.markdown +++ b/source/_components/dweet.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.dweet/ --- -The `dweet` component makes it possible to transfer details collected with Home Assistant to [Dweet.io](http://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public! +The `dweet` integration makes it possible to transfer details collected with Home Assistant to [Dweet.io](http://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public!

@@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use the `dweet` component in your installation, add the following to your `configuration.yaml` file: +To use the `dweet` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index 88a56255fac..6e8f9ebccf4 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/sensor.dyson/ --- -The `dyson` component is the main component to integrate all [Dyson](https://www.dyson.com) related platforms. +The `dyson` integration is the main integration to integrate all [Dyson](https://www.dyson.com) related platforms. There is currently support for the following device types within Home Assistant: @@ -107,7 +107,7 @@ The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuu ### {% linkable_title Component services %} -This component support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)): +This integration support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)): - [`turn_on`](/components/vacuum/#service-vacuumturn_on) - [`turn_off`](/components/vacuum/#service-vacuumturn_off) @@ -124,7 +124,7 @@ The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan ### {% linkable_title Component services %} -This component supports the following services (see [Climate](/components/climate/)): +This integration supports the following services (see [Climate](/components/climate/)): - [`turn_on`](/components/climate/#service-climateturn_on) - [`turn_off`](/components/climate/#service-climateturn_off) diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown index 7b33fd61eb8..81ae63aba75 100644 --- a/source/_components/ebusd.markdown +++ b/source/_components/ebusd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ebusd" -description: "The ebusd component allows the integration between eBUS heating system and Home Assistant." +description: "The ebusd integration allows the integration between eBUS heating system and Home Assistant." date: 2018-12-27 15:00 sidebar: true comments: false diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown index 1d963a80c02..f9fb1c13b61 100644 --- a/source/_components/ecoal_boiler.markdown +++ b/source/_components/ecoal_boiler.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/switch.ecoal_boiler/ --- -The `ecoal_boiler` component is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal). +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 %} diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index fc20a8e1730..fb4338e3bb5 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -25,7 +25,7 @@ redirect_from: - /components/weather.ecobee/ --- -The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. +The `ecobee` integration lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. ## {% linkable_title Configuration %} @@ -48,7 +48,7 @@ Now login to the regular consumer portal, and in the hamburger menu there will b Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section. -To add the Ecobee component to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file: +To add the Ecobee integration to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file: ```yaml # Example configuration.yaml entry @@ -58,11 +58,11 @@ ecobee: [Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-changes) for the changes to take effect. -The first time you (re)run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. +The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal. -- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. +- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` integration to your `default_view` and restart Home Assistant. Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. @@ -87,7 +87,7 @@ If for whatever reason you delete and re-create your ecobee app at ecobee.com su ## {% linkable_title Notifications %} -To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee component loaded and running. Once you have that configured, you can setup this component to send messages to your Ecobee device. +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. To use this notification platform in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ecovacs.markdown b/source/_components/ecovacs.markdown index 9caf28ea1fd..d9a2d423b09 100644 --- a/source/_components/ecovacs.markdown +++ b/source/_components/ecovacs.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/vacuum.ecovacs/ --- -The `ecovacs` component is the main component to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account. +The `ecovacs` integration is the main integration to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account. There is currently support for the following device types within Home Assistant: @@ -62,7 +62,7 @@ The library that talks to the Ecovacs servers is in a very early state and still Please see the [sucks library documentation](https://github.com/wpietri/sucks) for some more information about what has been tested, and check out the GitHub issues to see if the issue you're having is known or being worked on. -If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs component and the underlying `sucks` library, place this in your `configuration.yaml` file: +If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs integration and the underlying `sucks` library, place this in your `configuration.yaml` file: ```yaml logger: diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown index 7f64aed9867..58da62a3a9a 100644 --- a/source/_components/edp_redy.markdown +++ b/source/_components/edp_redy.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.edp_redy/ --- -[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 component allows integrating EDP re:dy into Home Assistant. +[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 %} diff --git a/source/_components/ee_brightbox.markdown b/source/_components/ee_brightbox.markdown index 3af7fe694df..ad878df41dd 100644 --- a/source/_components/ee_brightbox.markdown +++ b/source/_components/ee_brightbox.markdown @@ -51,4 +51,4 @@ version: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 39d7a66a367..0052d25a0b8 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -106,7 +106,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha 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'. -3. The Egardia component relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia component to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** +3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** 4. Once you have the codes, update your `configuration.yaml`: ```yaml # Example configuration.yaml entry @@ -123,8 +123,8 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX ignore: XXXXXXXXXXXXXXXX ``` -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 component 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 component 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). +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 %} diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 485925d994a..82f4bedaa6f 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.eight_sleep/ --- -The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. +The `eight_sleep` integration allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/emoncms.markdown b/source/_components/emoncms.markdown index d25b2ae9740..10d2482bcd5 100644 --- a/source/_components/emoncms.markdown +++ b/source/_components/emoncms.markdown @@ -44,7 +44,7 @@ sensor: ## {% linkable_title Default naming scheme %} -The names of the sensors created by this component will use the feed names defined in EmonCMS if available, +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". If the `id` property is anything but `1`, the ID will be shown as well, e.g., "EmonCMS 2 Feed 5". diff --git a/source/_components/emoncms_history.markdown b/source/_components/emoncms_history.markdown index aed353c14c9..b6fbae26a28 100644 --- a/source/_components/emoncms_history.markdown +++ b/source/_components/emoncms_history.markdown @@ -14,9 +14,9 @@ ha_release: 0.31 --- -The `emoncms_history` component makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data. +The `emoncms_history` integration makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data. -To use the `emoncms_history` component in your installation, add the following to your `configuration.yaml` file: +To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index 348f81cc9be..e910eb6d0a8 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -19,7 +19,7 @@ ha_qa_scale: internal Be aware that `emulated_hue` doesn't work for new users of **Google Home** with `emulated_hue`. If you've not previously set this up and had it working, use the [Google Assistant component](/components/google_assistant/) or [Nabu Casa cloud](https://www.home-assistant.io/components/cloud) component.

-The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant +The `emulated_hue` integration provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant entities. The driving use case behind for functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no setup cost outside of configuration changes. The virtual bridge can turn entities on/off or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness. @@ -61,7 +61,7 @@ type: type: string default: google_home host_ip: - description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own. + description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the integration will attempt to determine the IP address on its own. required: false type: string listen_port: @@ -136,7 +136,7 @@ These attributes used to be found under the `customize` section of `homeassistan ### {% linkable_title Troubleshooting %} -You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL: +You can verify that the `emulated_hue` integration has been loaded and is responding by pointing a local browser to the following URL: - `http://:8300/description.xml` - This URL should return a descriptor file in the form of an XML file. - `http://:8300/api/pi/lights` - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa. diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown index ce3a6b14a85..ddc0b056069 100644 --- a/source/_components/emulated_roku.markdown +++ b/source/_components/emulated_roku.markdown @@ -14,7 +14,7 @@ ha_release: 0.86 ha_iot_class: Local Push --- -This component integrates an emulated Roku API into Home Assistant, +This integration integrates an emulated Roku API into Home Assistant, so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player. Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations. Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries. @@ -24,14 +24,14 @@ Windows is not supported because Home Assistant uses `ProactorEventLoop` which d

-This component opens an unauthenticated API on the host, allowing anything on the local network to access +This integration opens an unauthenticated API on the host, allowing anything on the local network to access your Home Assistant instance through the automations you create with emulated Roku as the trigger. Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)

## {% linkable_title Configuration %} -The component is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**) +The integration is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**) If you wish to configure advanced options, you can add the following entry in `configuration.yaml`. @@ -53,7 +53,7 @@ listen_port: required: true type: integer host_ip: - description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own. + description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the integration will attempt to determine the IP address on its own. required: false type: string advertise_ip: diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown index ada39a33b6e..7d6a89692c1 100644 --- a/source/_components/enocean.markdown +++ b/source/_components/enocean.markdown @@ -25,7 +25,7 @@ redirect_from: The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary. -The `enocean` component adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work. +The `enocean` integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/envisalink.markdown b/source/_components/envisalink.markdown index 3cd6efeb54c..d6af76afa04 100644 --- a/source/_components/envisalink.markdown +++ b/source/_components/envisalink.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.envisalink/ --- -The `envisalink` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this component is built. Currently, the Envisalink version 4 is the latest model. This component supports both the evl3 and the evl4. +The `envisalink` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this integration is built. Currently, the Envisalink version 4 is the latest model. This integration supports both the evl3 and the evl4. Please visit the [eyezon website](http://www.eyezon.com/) for further information about the evl3 and evl4 boards. @@ -80,7 +80,7 @@ password: required: true type: string code: - description: Your alarm panel's code, for authenticating user input during arm/disarm. If you do not provide this value, the component will prompt the user to enter the code at runtime. + description: Your alarm panel's code, for authenticating user input during arm/disarm. If you do not provide this value, the integration will prompt the user to enter the code at runtime. required: false type: string port: @@ -104,7 +104,7 @@ zonedump_interval: default: 30 type: integer timeout: - description: A network connectivity timeout when communicating with the envisalink. If connection is not obtained by this time (in seconds) the component will stop trying to connect. + description: A network connectivity timeout when communicating with the envisalink. If connection is not obtained by this time (in seconds) the integration will stop trying to connect. required: false default: 10 type: integer @@ -128,7 +128,7 @@ zones: default: opening type: string partitions: - description: Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded. + description: Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor integrations are loaded. required: false type: integer keys: diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown index 49f54e9f7ec..18f76a05528 100644 --- a/source/_components/esphome.markdown +++ b/source/_components/esphome.markdown @@ -21,9 +21,9 @@ redirect_from: - /components/switch.esphome/ --- -This component 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). +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 component via the integrations screen %} +## {% linkable_title Setup the integration via the integrations screen %} Menu: *Configuration* -> *Integrations* diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown index 1a979bceaa9..ca386741ef7 100644 --- a/source/_components/eufy.markdown +++ b/source/_components/eufy.markdown @@ -19,14 +19,14 @@ redirect_from: - /components/switch.eufy/ --- -The `eufy` component is the main component to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. +The `eufy` integration is the main integration to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. There is currently support for the following device types within Home Assistant: - Light - Switch -Supported devices will be discovered after the `eufy` component is configured: +Supported devices will be discovered after the `eufy` integration is configured: ```yaml # Example configuration.yaml entry diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index b8ea759a062..00cc88b3371 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/climate.evohome/ --- -The `evohome` component is the main component to set up and integrate all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, primarily the Honeywell evohome multi-zone CH/DHW system. It does not support the home security functionality of TCC. +The `evohome` integration is the main integration to set up and integrate all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, primarily the Honeywell evohome multi-zone CH/DHW system. It does not support the home security functionality of TCC. It uses v2 of the [evohome-client](https://github.com/watchforstock/evohome-client) client library and so will let you control (only) EU/international systems. It _does not_ leverage the [somecomfort](https://github.com/kk7ds/somecomfort) client library as used by US-based systems; for those, you may find what you need at the [honeywell climate platform](/components/climate.honeywell/). @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -63,7 +63,7 @@ This is an IoT cloud-polling device, and the recommended minimum `scan_interval` ## {% linkable_title 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 components may well be usable side-by-side, but YMMV. +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. The evohome evotouch Controller supports seven distict operating modes: Auto, AutoWithEco, Away, DayOff, HeatingOff, and Custom; AutoWithReset is a 7th, hidden, mode. diff --git a/source/_components/facebox.markdown b/source/_components/facebox.markdown index 21a818b2bb4..b408196d467 100644 --- a/source/_components/facebox.markdown +++ b/source/_components/facebox.markdown @@ -26,7 +26,7 @@ MB_KEY="INSERT-YOUR-KEY-HERE" sudo docker run --name=facebox --restart=always -p 8080:8080 -e "MB_KEY=$MB_KEY" machinebox/facebox ``` -You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network. +You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the integration does not encrypt these credentials and this approach does not guarantee security on an unsecured network. 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. diff --git a/source/_components/fail2ban.markdown b/source/_components/fail2ban.markdown index 9249e71ca79..8488a5fe6ea 100644 --- a/source/_components/fail2ban.markdown +++ b/source/_components/fail2ban.markdown @@ -67,7 +67,7 @@ For those of us using Docker, the above tutorial may not be sufficient. The foll #### {% linkable_title Set http logger %} -In your `configuration.yaml` file, add the following to the `logger` component to ensure that Home Assistant prints failed login attempts to the log. +In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. ```yaml logger: diff --git a/source/_components/fan.markdown b/source/_components/fan.markdown index 37631338b93..837749a1101 100644 --- a/source/_components/fan.markdown +++ b/source/_components/fan.markdown @@ -14,4 +14,4 @@ ha_qa_scale: internal ha_release: 0.27 --- -The `fan` component is built for the controlling of fan devices. +The `fan` integration is built for the controlling of fan devices. diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown index 49e6dd81df6..7309eec950f 100644 --- a/source/_components/fan.template.markdown +++ b/source/_components/fan.template.markdown @@ -15,7 +15,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform creates fans that combine components and provides the +The `template` platform creates fans that combine integrations and provides the ability to run scripts or invoke services for each of the turn_on, turn_off, set_speed, set_oscillating, and set_direction commands of a fan. diff --git a/source/_components/fastdotcom.markdown b/source/_components/fastdotcom.markdown index 9c1f730bda4..d095e5681e8 100644 --- a/source/_components/fastdotcom.markdown +++ b/source/_components/fastdotcom.markdown @@ -17,13 +17,13 @@ redirect_from: - /components/sensor.fastdotcom/ --- -The `fastdotcom` component uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance. +The `fastdotcom` integration uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.

Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [speedtest](/components/sensor.speedtest) component.

-Enabling this component will automatically create the Fast.com Sensor. +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. @@ -72,7 +72,7 @@ scan_interval: ### {% linkable_title Service %} -Once loaded, the `fastdotcom` component 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. +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. ```yaml action: diff --git a/source/_components/feedreader.markdown b/source/_components/feedreader.markdown index cebea072cd9..d79437e2a7e 100644 --- a/source/_components/feedreader.markdown +++ b/source/_components/feedreader.markdown @@ -86,7 +86,7 @@ automation: Any field under the `` tag in the feed can be used for example `trigger.event.data.content` will get the body of the feed entry. -For more advanced use cases, a custom component registering to the `feedreader` event type could be used instead: +For more advanced use cases, a custom integration registering to the `feedreader` event type could be used instead: ```python EVENT_FEEDREADER = "feedreader" diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index a051d575f55..44630cc5aee 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.29 --- -The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update. +The `ffmpeg` integration allows other Home Assistant integrations to process video and audio streams. This integration supports all FFmpeg versions since 3.0.0; if you have an older version, please update.

You need the `ffmpeg` binary in your system path. On Hassbian you will need to login as the `pi` user and `sudo apt install ffmpeg`. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website. diff --git a/source/_components/flexit.markdown b/source/_components/flexit.markdown index 1b08eb41014..44af442acc6 100644 --- a/source/_components/flexit.markdown +++ b/source/_components/flexit.markdown @@ -46,7 +46,7 @@ hub: {% endconfiguration %}

-This component requires the [Modbus](/components/modbus/) component to be set up to work +This integration requires the [Modbus](/components/modbus/) integration to be set up to work

Full configuration example including modbus setup shown below: diff --git a/source/_components/flic.markdown b/source/_components/flic.markdown index 0601178647b..35082555af2 100644 --- a/source/_components/flic.markdown +++ b/source/_components/flic.markdown @@ -48,7 +48,7 @@ port: type: integer default: 5551 discovery: - description: If `true` then the component is configured to constantly scan for new buttons. + description: If `true` then the integration is configured to constantly scan for new buttons. required: false type: boolean default: true @@ -73,7 +73,7 @@ If discovery is enabled, you can add a new button by pressing it for at least 7 #### {% linkable_title Events %} -The flic component fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this: +The flic integration fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this: ```yaml # Example configuration.yaml automation entry @@ -97,7 +97,7 @@ Event data: - **click_type**: The type of click. Possible values are `single`, `double` and `hold`. - **queued_time**: The amount of time this event was queued on the button, in seconds. -To help detect and debug flic button clicks, you can use this automation that send a notification on very click type of every button. This example uses the [HTML5 push notification platform](/components/notify.html5/). Visit the [notification component page](/components/notify/) for more information on setting up notifications. +To help detect and debug flic button clicks, you can use this automation that send a notification on very click type of every button. This example uses the [HTML5 push notification platform](/components/notify.html5/). Visit the [notification integration page](/components/notify/) for more information on setting up notifications. ```yaml automation: diff --git a/source/_components/flux.markdown b/source/_components/flux.markdown index 955d2ff9ee8..b0cd5a095a2 100644 --- a/source/_components/flux.markdown +++ b/source/_components/flux.markdown @@ -18,7 +18,7 @@ redirect_from: The `flux` switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night. -The component will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration. +The integration will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration. During the day (in between `start time` and `sunset time`), it will fade the lights from the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time` and `stop_time`), the lights will fade from the `sunset_colortemp` to the `stop_colortemp`. If the lights are still on after the `stop_time` it will continue to change the light to the `stop_colortemp` until the light is turned off. The fade effect is created by updating the lights periodically. diff --git a/source/_components/flux_led.markdown b/source/_components/flux_led.markdown index 115b1492a3f..16b015ea174 100644 --- a/source/_components/flux_led.markdown +++ b/source/_components/flux_led.markdown @@ -89,7 +89,7 @@ devices:

Depending on your controller or bulb type, there are two ways to configure brightness. -The component defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color. +The integration defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color.

diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index b6d4112e92d..245a4ba1cc7 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -15,7 +15,7 @@ ha_release: 0.67 ha_qa_scale: internal --- -This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are: +This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are: * `created` * `deleted` @@ -26,7 +26,7 @@ Configured folders must be added to [whitelist_external_dirs](/docs/configuratio ## {% linkable_title Configuration %} -To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file: +To enable the Folder Watcher integration in your installation, add the following to your `configuration.yaml` file: {% raw %} ```yaml diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index a08d86d7120..02cf7f75117 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -14,7 +14,7 @@ ha_release: 0.26 ha_iot_class: Cloud Polling and Cloud Push --- -The `foursquare` component accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. +The `foursquare` integration accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. ```yaml # Example configuration.yaml entry @@ -50,7 +50,7 @@ After that, you will get redirected to your `REDIRECT_URL` with the `access_toke ### {% linkable_title Real-Time API %} -The component accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. +The integration accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. Foursquare check-in events can be used out of the box to trigger automation actions, e.g.: diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown index 9fc7f1c2f6c..4c95a8d3551 100644 --- a/source/_components/freebox.markdown +++ b/source/_components/freebox.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.freebox/ --- -The `freebox` component allows you to observe and control [Freebox router](http://www.free.fr/). +The `freebox` integration allows you to observe and control [Freebox router](http://www.free.fr/). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown index c31040e44a5..48d73fbec60 100644 --- a/source/_components/freedns.markdown +++ b/source/_components/freedns.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.67 --- -With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. +With the `freedns` integration you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. ## {% linkable_title Setup %} @@ -28,7 +28,7 @@ You need to determine your update URL or your access token. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/fritz.markdown b/source/_components/fritz.markdown index 9572f1068f1..2dbd28a2954 100644 --- a/source/_components/fritz.markdown +++ b/source/_components/fritz.markdown @@ -53,4 +53,4 @@ password: It seems that it is not necessary to use the password in current generation Fritz!Box routers because the necessary data can be retrieved anonymously.

-See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index 4f887451f9a..ca460641e13 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/sensor.fritzbox/ --- -The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices. +The [AVM](https://en.avm.de) Fritzbox integration for Home Assistant allows you to integrate the switch and climate devices. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/fritzbox_netmonitor.markdown b/source/_components/fritzbox_netmonitor.markdown index 078db2dead6..fced5ad5c9f 100644 --- a/source/_components/fritzbox_netmonitor.markdown +++ b/source/_components/fritzbox_netmonitor.markdown @@ -63,5 +63,5 @@ The following statistics will be exposed as attributes. The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost).

-This component does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed. +This integration does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed.

diff --git a/source/_components/fritzdect.markdown b/source/_components/fritzdect.markdown index e5ece61a230..1b568645d31 100644 --- a/source/_components/fritzdect.markdown +++ b/source/_components/fritzdect.markdown @@ -57,5 +57,5 @@ host: It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".

-If this component throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors. +If this integration throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors.

diff --git a/source/_components/frontier_silicon.markdown b/source/_components/frontier_silicon.markdown index aa34ceca451..02c79c90b89 100644 --- a/source/_components/frontier_silicon.markdown +++ b/source/_components/frontier_silicon.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/media_player.frontier_silicon/ --- -This component 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. +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 %} * Hama: [IR110], [DIR3110] @@ -23,7 +23,7 @@ This component provides support for Internet Radios based on the [Frontier Silic * Silvercrest: [SIRD 14 C2] * Some models from: Auna, Technisat, Revo, Pinell -This component was developed and tested with a Hama [DIR3110] and a Medion [MD 87466]. +This integration was developed and tested with a Hama [DIR3110] and a Medion [MD 87466]. ## Configuration @@ -90,12 +90,12 @@ Overview of the info dialog: ## Development Support is provided through the Python [fsapi] module. The Python module was developed by using the documentation provided by [flammy] and -is based on [tiwillam]'s fsapi project. Special thanks to both developers, this component would have not been possible without their work. +is based on [tiwillam]'s fsapi project. Special thanks to both developers, this integration would have not been possible without their work. ## Notes and Limitations

-The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant component polls the device state every 30 seconds or issues a command by creating a new session. +The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant integration polls the device state every 30 seconds or issues a command by creating a new session. *If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*

diff --git a/source/_components/generic_thermostat.markdown b/source/_components/generic_thermostat.markdown index 73ebdecab89..3a2f6dda052 100644 --- a/source/_components/generic_thermostat.markdown +++ b/source/_components/generic_thermostat.markdown @@ -74,7 +74,7 @@ hot_tolerance: default: 0.3 type: float keep_alive: - description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate component state (either on or off). + description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate integration state (either on or off). required: false type: [time, integer] initial_operation_mode: diff --git a/source/_components/geofency.markdown b/source/_components/geofency.markdown index 70abf05f026..0383f42f051 100644 --- a/source/_components/geofency.markdown +++ b/source/_components/geofency.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/device_tracker.geofency/ --- -This component 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. +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 %} @@ -33,7 +33,7 @@ mobile_beacons: type: list {% endconfiguration %} -A sample configuration for the `geofency` component when using mobile beacons is shown below: +A sample configuration for the `geofency` integration when using mobile beacons is shown below: ```yaml # Example configuration.yaml entry diff --git a/source/_components/goalfeed.markdown b/source/_components/goalfeed.markdown index 9874df36e4a..284c1b238f6 100644 --- a/source/_components/goalfeed.markdown +++ b/source/_components/goalfeed.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.63 --- -The `goalfeed` component lets you use your Goalfeed account to trigger events in Home Assistant whenever a NHL or MLB team scores. +The `goalfeed` integration lets you use your Goalfeed account to trigger events in Home Assistant whenever a NHL or MLB team scores. To use this component, enter your email address and password from your goalfeed.ca account in your `configuration.yaml` file: diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 498a9910ae3..b87d9a13c38 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -14,7 +14,7 @@ featured: true ha_release: 0.56 --- -The `google_assistant` component allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. +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 %} @@ -24,7 +24,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na ## {% linkable_title Manual setup %} -The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. +The Google Assistant integration requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.

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. @@ -81,7 +81,7 @@ You need to create an API Key with the [Google Cloud API Console](https://consol Screenshot: Account linking 3. Back on the overview page. Click `Simulator` under `TEST`. It will create a new draft version Test App. You don't have to actually test, but you need to generate this draft version Test App. -4. Add the `google_assistant` component configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. +4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. 5. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`. 6. Click the `+` sign, and near the bottom, you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices.

diff --git a/source/_components/google_domains.markdown b/source/_components/google_domains.markdown index bbbf3a95f13..9c8928665af 100644 --- a/source/_components/google_domains.markdown +++ b/source/_components/google_domains.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.57 --- -With the Google Domains component you can keep your Google Domains record up to date. +With the Google Domains integration you can keep your Google Domains record up to date. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/google_pubsub.markdown b/source/_components/google_pubsub.markdown index 52413354f72..43458397e7e 100644 --- a/source/_components/google_pubsub.markdown +++ b/source/_components/google_pubsub.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.88 --- -The `google_pubsub` component 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). +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 %} diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown index e7978829b57..eb670a40413 100644 --- a/source/_components/google_translate.markdown +++ b/source/_components/google_translate.markdown @@ -54,7 +54,7 @@ tts: language: 'de' ``` -If you are using SSL certificate or Docker, you may need to add the `base_url` configuration variable to your `http` component as follows: +If you are using SSL certificate or Docker, you may need to add the `base_url` configuration variable to your `http` integration as follows: ```yaml #Example configuration.yaml entry diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown index f1aa57feb75..5347dc7f12e 100644 --- a/source/_components/googlehome.markdown +++ b/source/_components/googlehome.markdown @@ -18,15 +18,15 @@ redirect_from: - /components/device_tracker.googlehome/ --- -The `googlehome` component allows you to connect to your Google Home device using an [unofficial Google Home API][googlehomeapi]. +The `googlehome` integration allows you to connect to your Google Home device using an [unofficial Google Home API][googlehomeapi]. -This component will provide: +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 %} -To integrate the `googlehome` component in Home Assistant, add the following section to your `configuration.yaml` file: +To integrate the `googlehome` integration in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -55,12 +55,12 @@ devices: required: false type: list track_alarms: - description: Setting to tell the component to track the alarms of the device. + description: Setting to tell the integration to track the alarms of the device. required: false type: boolean default: false track_devices: - description: Setting to tell the component to track nearby devices. + description: Setting to tell the integration to track nearby devices. required: false type: boolean default: true diff --git a/source/_components/gpsd.markdown b/source/_components/gpsd.markdown index 4e51ca7adac..cfb4796d4d4 100644 --- a/source/_components/gpsd.markdown +++ b/source/_components/gpsd.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.gpsd/ --- -The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. +The `gpsd` integration is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. ## {% linkable_title Setup %} diff --git a/source/_components/gpslogger.markdown b/source/_components/gpslogger.markdown index 3174e7b7892..1d2308e837e 100644 --- a/source/_components/gpslogger.markdown +++ b/source/_components/gpslogger.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/device_tracker.gpslogger/ --- -This component 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. +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 %} diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown index 15dfbc74b05..902bb85fa71 100644 --- a/source/_components/graphite.markdown +++ b/source/_components/graphite.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.13 --- -The `graphite` component records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. +The `graphite` integration records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. To enable this component, add the following lines to your `configuration.yaml`: diff --git a/source/_components/greeneye_monitor.markdown b/source/_components/greeneye_monitor.markdown index 0c0bd4cb7b9..84b8afdbd12 100644 --- a/source/_components/greeneye_monitor.markdown +++ b/source/_components/greeneye_monitor.markdown @@ -44,7 +44,7 @@ greeneye_monitor: name: back_porch_temperature ``` -By default, GEM will send updates every 5 seconds. That's a lot of data, and the databases used by the [`recorder`](/components/recorder) component for history don't do well with that much data, so it is recommended to configure the [`influxdb`](/components/influxdb) component and exclude the GEM sensors from `recorder`. +By default, GEM will send updates every 5 seconds. That's a lot of data, and the databases used by the [`recorder`](/components/recorder) integration for history don't do well with that much data, so it is recommended to configure the [`influxdb`](/components/influxdb) integration and exclude the GEM sensors from `recorder`. {% configuration %} port: diff --git a/source/_components/greenwave.markdown b/source/_components/greenwave.markdown index 23f123b69fe..6e19678ab47 100644 --- a/source/_components/greenwave.markdown +++ b/source/_components/greenwave.markdown @@ -16,9 +16,9 @@ redirect_from: - /components/light.greenwave/ --- -This component communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS. +This integration communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS. -This component has been tested on firmware revisions: +This integration has been tested on firmware revisions: - 2.0.105 diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 830f5de89d5..cb183fd77b2 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -66,7 +66,7 @@ control: ## {% linkable_title Default groups %} -Some components automatically create special groups containing component entities. These groups are named like `group.all_...`, for example: +Some integrations automatically create special groups containing integration entities. These groups are named like `group.all_...`, for example: - `group.all_switches` - `group.all_lights` diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown index f6d5ecbfeef..2e8ddb96894 100644 --- a/source/_components/habitica.markdown +++ b/source/_components/habitica.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.habitica/ --- -This component allows you to monitor and manage your Habitica profile. This component exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant. +This integration allows you to monitor and manage your Habitica profile. This integration exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant. There is currently support for the following device types within Home Assistant: @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: The sensors will automatically appear, after setup the Habitica component. -To use the component you should use this example configuration: +To use the integration you should use this example configuration: ```yaml # Minimum viable configuration.yaml entry diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown index 377c3d7164b..0df9b7db699 100644 --- a/source/_components/hangouts.markdown +++ b/source/_components/hangouts.markdown @@ -16,13 +16,13 @@ redirect_from: - /components/notify.hangouts/ --- -This component allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. Home Assistant will impersonate a Smartisan YQ603 phone which will then show up in your Google devices. +This integration allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. Home Assistant will impersonate a Smartisan YQ603 phone which will then show up in your Google devices. There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) -## {% linkable_title Setup the component via the frontend %} +## {% linkable_title Setup the integration via the frontend %} Menu: *Configuration* -> *Integrations* @@ -33,7 +33,7 @@ Configure the integration: ## {% linkable_title Manual Authentication %} -If you are sure your email and password are correct, but the component says the login is invalid then you would need to use the manual authentication method. +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. To use the manual method, first you would need to obtain an authorization code (see instructions below for details). @@ -83,7 +83,7 @@ hangouts: {% configuration %} intents: - description: "Intents that the hangouts component should understand." + description: "Intents that the hangouts integration should understand." required: false type: map default: empty @@ -131,7 +131,7 @@ error_suppressed_conversations: The conversations has to be precreated, the conversation id can be obtained from the `hangouts.conversations` entity. Make sure to use quotes around the conversation id or alias to escape special characters (`!`, and `#`) in YAML. -The intent `HangoutsHelp` is part of the component and return a list of all sentences the component unterstand in this conversation. +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 %} @@ -235,7 +235,7 @@ Reconnects the hangouts bot. ### {% linkable_title Automatic reconnect after ip change %} -The hangouts component 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. +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. {% raw %} diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 4cb56e11a41..3576095a136 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/switch.hdmi_cec/ --- -The `hdmi_cec` component 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. +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 %} @@ -27,7 +27,7 @@ The computer running Home Assistant must support CEC, and of course be connected ### {% linkable_title libcec %} -[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this component 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. +[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.

If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. diff --git a/source/_components/heos.markdown b/source/_components/heos.markdown index ec870a19d39..44e9a75690f 100644 --- a/source/_components/heos.markdown +++ b/source/_components/heos.markdown @@ -24,7 +24,7 @@ The HEOS integration adds support for [HEOS](http://heosbydenon.denon.com) capab ## {% linkable_title Configuration %} -HEOS devices are discovered and setup automatically when the [discovery](/components/discovery) component is enabled. Alternatively, the component can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file: +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: ```yaml # Example configuration.yaml entry @@ -148,7 +148,7 @@ You can play a URL through a HEOS media player using the `media_player.play_medi ### {% linkable_title Debugging %} -The HEOS component 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: +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: ```yaml logger: diff --git a/source/_components/hipchat.markdown b/source/_components/hipchat.markdown index 7caba355984..e06733ebd7d 100644 --- a/source/_components/hipchat.markdown +++ b/source/_components/hipchat.markdown @@ -16,7 +16,7 @@ redirect_from: ---

-This component will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: announcement. +This integration will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: announcement.

Hipchat will be discontinued after February 15th, 2019. This to give customers the opportunity to make a switch. diff --git a/source/_components/history.markdown b/source/_components/history.markdown index 52bfedae60d..3bb947defd4 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -14,7 +14,7 @@ ha_release: pre 0.7 ha_qa_scale: internal --- -The `history` component will track everything that is going on within Home +The `history` integration will track everything that is going on within Home Assistant and allows the user to browse through it. It depends on the `recorder` component for storing the data and uses the same database setting. If any entities are excluded from being recorded, @@ -41,7 +41,7 @@ Drawing is happening 100% in your browser. No data is transferred to anyone at a {% configuration %} exclude: - description: Configure which components should **not** be displayed. + description: Configure which integrations should **not** be displayed. required: false type: map keys: @@ -54,7 +54,7 @@ exclude: required: false type: list include: - description: Configure which components should be displayed. + description: Configure which integrations should be displayed. required: false type: map keys: @@ -145,9 +145,9 @@ history: #### {% linkable_title Implementation details %} The history is stored in a SQLite database `home-assistant_v2.db` within your -configuration directory unless the `recorder` component is set up differently. +configuration directory unless the `recorder` integration is set up differently. - - events table is all events except `time_changed` that happened while recorder component was running. + - events table is all events except `time_changed` that happened while recorder integration was running. - states table contains all the `new_state` values of `state_changed` events. - Inside the states table you have: - `entity_id`: the entity_id of the entity @@ -157,7 +157,7 @@ configuration directory unless the `recorder` component is set up differently. - `last_updated`: timestamp anything has changed (state, attributes) - `created`: timestamp this entry was inserted into the database -When the `history` component queries the states table it only selects states +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 %} diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index 8d3dcfb083d..e7d5ca6d87f 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -18,9 +18,9 @@ ha_qa_scale: internal

-The `history_graph` component will make the UI display a graph similar to the graphs in `more-info` popups and the [history](/components/history/) panel. If you want to add history graphs to the Lovelace UI, please check the [History Graph Card](/lovelace/history-graph/) configuration as it slightly differs from the component. +The `history_graph` integration will make the UI display a graph similar to the graphs in `more-info` popups and the [history](/components/history/) panel. If you want to add history graphs to the Lovelace UI, please check the [History Graph Card](/lovelace/history-graph/) configuration as it slightly differs from the component. -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Minimal configuration.yaml entry diff --git a/source/_components/history_stats.markdown b/source/_components/history_stats.markdown index 17facd9a152..9d2fa83b8a0 100644 --- a/source/_components/history_stats.markdown +++ b/source/_components/history_stats.markdown @@ -17,9 +17,9 @@ redirect_from: - /components/sensor.history_stats/ --- -The `history_stats` sensor platform provides quick statistics about another component or platforms, using data from the [history](/components/history/). +The `history_stats` sensor platform provides quick statistics about another integration or platforms, using data from the [history](/components/history/). -It can track how long the component has been in a specific state, in a custom time period. +It can track how long the integration has been in a specific state, in a custom time period. Examples of what you can track: @@ -86,15 +86,15 @@ duration: ## {% linkable_title Sensor type %} -Depending on the sensor type you choose, the `history_stats` component can show different values: +Depending on the sensor type you choose, the `history_stats` integration can show different values: - **time**: The default value, which is the tracked time, in hours - **ratio**: The tracked time divided by the length of your period, as a percentage -- **count**: How many times the component you track was changed to the state you track +- **count**: How many times the integration you track was changed to the state you track ## {% linkable_title Time periods %} -The `history_stats` component will execute a measure within a precise time period. You should always provide 2 of the following : +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) - When the period ends (`end` variable) - How long is the period (`duration` variable) diff --git a/source/_components/hitron_coda.markdown b/source/_components/hitron_coda.markdown index 379f44132a7..10d38357a85 100644 --- a/source/_components/hitron_coda.markdown +++ b/source/_components/hitron_coda.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/device_tracker.hitron_coda/ --- -This component offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3) +This integration offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3) or [Shaw Hitron CGNM](https://community.shaw.ca/docs/DOC-4066) Router. To use a Hitron router in your installation, add the following to your `configuration.yaml` file: @@ -49,4 +49,4 @@ type: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index 7241947def8..a32aaaeafc1 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -25,9 +25,9 @@ redirect_from: - /components/switch.hive/ --- -The `hive` component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. +The `hive` integration is the main integration to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. -This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant. +This integration uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive integration in Home Assistant. There is currently support for the following device types within Home Assistant: @@ -64,7 +64,7 @@ scan_interval: ## {% linkable_title Binary Sensor %} -The `hive` binary sensor component integrates your Hive sensors into Home Assistant. +The `hive` binary sensor integration integrates your Hive sensors into Home Assistant. The platform supports the following Hive products: @@ -95,7 +95,7 @@ The platform supports the following Hive products: ## {% linkable_title Sensor %} -The `hive` sensor component exposes Hive data as a sensor. +The `hive` sensor integration exposes Hive data as a sensor. The platform exposes the following sensors: diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index fece1ba1b39..bcbc32d7358 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HomeKit" -description: "Instructions on how to set up the HomeKit component in Home Assistant." +description: "Instructions on how to set up the HomeKit integration in Home Assistant." date: 2018-02-20 17:30 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_release: 0.64 logo: apple-homekit.png --- -The `homekit` component allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple's Home app and Siri. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section. +The `homekit` integration allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple's Home app and Siri. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section.

If you want to control `HomeKit` only devices with Home Assistant, check out the [HomeKit controller](/components/homekit_controller/) component. @@ -71,7 +71,7 @@ homekit: type: integer default: 51827 name: - description: Need to be individual for each instance of Home Assistant using the component on the same local network. Between `3` and `25` characters. Alphanumeric and spaces allowed. + description: Need to be individual for each instance of Home Assistant using the integration on the same local network. Between `3` and `25` characters. Alphanumeric and spaces allowed. required: false type: string default: '`Home Assistant Bridge`' @@ -152,7 +152,7 @@ homekit: ## {% linkable_title Setup %} -To enable the HomeKit component in Home Assistant, add the following to your configuration file: +To enable the HomeKit integration in Home Assistant, add the following to your configuration file: ```yaml # Example for HomeKit setup @@ -169,7 +169,7 @@ After Home Assistant has started, the entities specified by the filter are expos 6. Follow the setup by clicking on `Next` and lastly `Done` in the top right-hand corner. 7. The `Home Assistant` Bridge and the Accessories should now be listed in the `Home` app. -After the setup is completed, you should be able to control your Home Assistant components through Apple's Home and Siri. +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 %} @@ -181,7 +181,7 @@ Before you copy it, make sure to stop the old and new Home Assistant instances f ### {% linkable_title Accessory ID %} -Currently, this component 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. +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 %} @@ -195,7 +195,7 @@ A common situation might be if you decide to disable parts of the configuration ## {% linkable_title 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` component is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.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`. If you have Z-Wave entities you want to be exposed to HomeKit, then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation. @@ -223,7 +223,7 @@ automation: ``` {% endraw %} -For a general delay where your component doesn't generate an event, you can also do: +For a general delay where your integration doesn't generate an event, you can also do: {% raw %} ```yaml @@ -324,7 +324,7 @@ To avoid any errors, after you have successfully paired your Home Assistant Brid ## {% linkable_title Supported Components %} -The following components are currently supported: +The following integrations are currently supported: | Component | Type Name | Description | | --------- | --------- | ----------- | @@ -434,11 +434,11 @@ Check if the domain of your entity is [supported](#supported-components). If it #### {% linkable_title HomeKit doesn't work on second Home Assistant instance %} -To use the HomeKit component 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) +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 %} -Although we try our best, some entities don't work with the HomeKit component 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) +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 %} diff --git a/source/_components/homekit_controller.markdown b/source/_components/homekit_controller.markdown index 74d42d423ea..6e5a0763aab 100644 --- a/source/_components/homekit_controller.markdown +++ b/source/_components/homekit_controller.markdown @@ -30,7 +30,7 @@ redirect_from: - /components/sensor.homekit_controller/ --- -[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit. +[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This integration should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit. There is currently support for the following device types within Home Assistant: @@ -43,7 +43,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor (HomeKit motion sensors) - Sensor (HomeKit humidity, temperature, and light level sensors) -The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit: +The integration will be automatically configured if the [`discovery:`](/components/discovery/) integration is enabled and an enable entry added for HomeKit: ```yaml discovery: diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index d8bb9127752..437293e9844 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -31,7 +31,7 @@ redirect_from: - /components/switch.homematic/ --- -The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. +The [Homematic](http://www.homematic.com/) integration provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well. There is currently support for the following device types within Home Assistant: @@ -50,7 +50,7 @@ Device support is available for most of the wired and wireless devices, as well If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute. We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default. -You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The HomeMatic component is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI. +You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The HomeMatic integration is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI. To set up the component, add the following information to your `configuration.yaml` file: @@ -402,7 +402,7 @@ action: #### {% linkable_title 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 components are still updated properly, in order to detect connection losses. This can be done in several ways through an automation: +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: - If you have a sensor which you know will be updated frequently (e.g., an outdoor temperature sensor, voltage sensor or light sensor) you could set up a helper binary sensor and an automation like this: diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 94aa7655f32..800872f7269 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -29,7 +29,7 @@ redirect_from: - /components/switch.homematicip_cloud/ --- -The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk. +The [HomematicIP](http://www.homematic-ip.com) integration platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk. There is currently support for the following device types within Home Assistant: @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: * Switch * Weather -## {% linkable_title Setup the component via the frontend %} +## {% linkable_title 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 component using the configuration files %} +## {% linkable_title Setup the integration using the configuration files %} Generate the authentication token: diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown index 2414a39019d..8ac001abbff 100644 --- a/source/_components/homeworks.markdown +++ b/source/_components/homeworks.markdown @@ -18,17 +18,17 @@ redirect_from: - /components/light.homeworks/ --- -[Lutron](http://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` component in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example). +[Lutron](http://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` integration in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example). Only a subset of the Homeworks system is supported - lights and keypads. -Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another component [lutron](/components/lutron/) which handles Lutron RadioRA 2 systems. +Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another integration [lutron](/components/lutron/) which handles Lutron RadioRA 2 systems. 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 %} -The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` component must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file: +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: ``` yaml # Example configuration.yaml entry diff --git a/source/_components/hook.markdown b/source/_components/hook.markdown index 787bf6c8fa0..2b23bf0bed1 100644 --- a/source/_components/hook.markdown +++ b/source/_components/hook.markdown @@ -15,13 +15,13 @@ redirect_from: - /components/switch.hook/ --- -The `hook` component allows you to control the [Hook Smart Home Hub](http://www.hooksmarthome.com/) from within Home Assistant. +The `hook` integration allows you to control the [Hook Smart Home Hub](http://www.hooksmarthome.com/) from within Home Assistant. Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://amzn.to/2WVZdGG). In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive commands at 315MHz and 433MHz. Unfortunately, this does not allow Hook to determine if the command was successful, so the state is assumed. -Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant component reads in devices that have been set up in the official app. +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 %} diff --git a/source/_components/horizon.markdown b/source/_components/horizon.markdown index 61b49c76999..fea3cf69fb4 100644 --- a/source/_components/horizon.markdown +++ b/source/_components/horizon.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.horizon/ --- -The `horizon` component allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant. +The `horizon` integration allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant. To add a Horizon HD Recorder to your installation, add the following to your `configuration.yaml` file: @@ -45,4 +45,4 @@ media_player: #### {% linkable_title 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 component will fail to start. +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 da2dc4603ae..fdd982b7fe2 100644 --- a/source/_components/hp_ilo.markdown +++ b/source/_components/hp_ilo.markdown @@ -28,7 +28,7 @@ Some more details about what can be retrieved from these sensors is available in ## {% linkable_title Configuration %} -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 3235e4667eb..eeb7c4952b9 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.http/ --- -The `http` component serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings. +The `http` integration serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings. There is currently support for the following device types within Home Assistant: @@ -103,7 +103,7 @@ ssl_profile: {% endconfiguration %}

-Configuring trusted_networks via the `http` component will be deprecated and moved to `auth_providers` instead. For instructions, see trusted networks. In Home Assistant 0.89.0 and 0.89.1, you need place the trusted network under both `http` and `auth_providers` if you still want to use trusted networks features. You can remove it from `http` section starting from 0.89.2. +Configuring trusted_networks via the `http` integration will be deprecated and moved to `auth_providers` instead. For instructions, see trusted networks. In Home Assistant 0.89.0 and 0.89.1, you need place the trusted network under both `http` and `auth_providers` if you still want to use trusted networks features. You can remove it from `http` section starting from 0.89.2.

The sample below shows a configuration entry with possible values: @@ -130,7 +130,7 @@ Or use a self signed certificate following the instructions here [Self-signed ce ## {% linkable_title APIs %} -On top of the `http` component 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/). +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. diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown index e4b669e5159..9a1133cc658 100644 --- a/source/_components/huawei_lte.markdown +++ b/source/_components/huawei_lte.markdown @@ -61,14 +61,14 @@ password: ### {% linkable_title Tested routers %} -Routers we know to be working with this component based on the documentation of used libraries and reports by users: +Routers we know to be working with this integration based on the documentation of used libraries and reports by users: - Huawei B310s-22 - Huawei B525s-23a - Huawei E5186s-22a - Huawei B618 -This is not a complete list. The component can probably connect to other Huawei LTE routers running similar firmware. +This is not a complete list. The integration can probably connect to other Huawei LTE routers running similar firmware. ## {% linkable_title Presence Detection %} @@ -82,7 +82,7 @@ device_tracker: - platform: huawei_lte ``` -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Notifications %} diff --git a/source/_components/huawei_router.markdown b/source/_components/huawei_router.markdown index 31ecacd2b4d..eee20dcff20 100644 --- a/source/_components/huawei_router.markdown +++ b/source/_components/huawei_router.markdown @@ -47,4 +47,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 60d5ba0f198..8fbb22e7cd7 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -32,7 +32,7 @@ When you configure the Hue bridge from Home Assistant, it writes a token to a fi Once registration is complete you should see the Hue lights listed as `light` entities, Hue presence sensors listed as `binary_sensor` entites, Hue temperature and light level sensors listed as `sensor` entities. If you don't you may have to restart Home Assistant once more. -If you want to enable the component without relying on the [discovery component](/components/discovery/), add the following lines to your `configuration.yaml` file: +If you want to enable the integration without relying on the [discovery component](/components/discovery/), add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -43,7 +43,7 @@ hue: {% configuration %} host: - description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges. + description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` integration to discover Hue bridges. required: true type: string allow_unreachable: diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index 7020eda923c..3ec24f8dc7e 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.hydrawise/ --- -The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. +The `hydrawise` integration allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/icloud.markdown b/source/_components/icloud.markdown index 46da072f17d..69aa317b105 100644 --- a/source/_components/icloud.markdown +++ b/source/_components/icloud.markdown @@ -66,11 +66,11 @@ You may receive an email from Apple stating that someone has logged into your ac To disable the drainage of the battery, a dynamic interval is being used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device. -If 2 Step Authentication is enabled for your iCloud account. The component will ask which device you want to use as Trusted Device and component will send a prompt to that device with the code which you can enter in Home Assistant. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months. +If 2 Step Authentication is enabled for your iCloud account. The integration will ask which device you want to use as Trusted Device and integration will send a prompt to that device with the code which you can enter in Home Assistant. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months. 2 Factor Authentication is the improved version of 2 Step Authentication, this is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet. 4 services are available for this component: - **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iphone location. Can be used in automations when manual location update is needed, e.g., to check if anyone is home when door's been opened. - **icloud_lost_iphone**: This service will play the Lost iPhone sound on a certain iDevice. The `account_name` and `device_name` are optional. - **icloud_set_interval**: This service will change the dynamic interval of an iDevice. The `account_name` and `device_name` are optional. If `interval` is used in the service_data, the iDevice will be updated with that new interval. That interval will be fixed until the iDevice changes zone or if this service is called again. If `interval` isn't used in the service_data, the interval for that iDevice will revert back to its default dynamic interval based on its current zone, its distance towards home and its battery level. -- **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are found by the component or if you have added a new iDevice to your account. The `account_name` is optional. +- **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are found by the integration or if you have added a new iDevice to your account. The `account_name` is optional. diff --git a/source/_components/idteck_prox.markdown b/source/_components/idteck_prox.markdown index 92145873a5d..cbd04ba75b0 100644 --- a/source/_components/idteck_prox.markdown +++ b/source/_components/idteck_prox.markdown @@ -14,7 +14,7 @@ ha_release: 0.85 ha_iot_class: Local Push --- -[IDTECK](http://www.idteck.com) makes ID systems used to control access and identify users. This component works with [Proximity Readers](http://www.idteck.com/en/products/proximity-reader-__-card-%26-tag-__125khz) (RFID card readers). The device is connected to Home Assistant through a serial to ethernet converter (NPort). +[IDTECK](http://www.idteck.com) makes ID systems used to control access and identify users. This integration works with [Proximity Readers](http://www.idteck.com/en/products/proximity-reader-__-card-%26-tag-__125khz) (RFID card readers). The device is connected to Home Assistant through a serial to ethernet converter (NPort). 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. diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index a926362e593..f020b557c2e 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -19,7 +19,7 @@ ha_release: 0.80 ## {% linkable_title 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 component ([docs](/components/http/#base_url)). +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 %} @@ -66,7 +66,7 @@ ifttt: Property screen of the Maker Channel

-Once you have added your key to your `configuration.yaml` file, restart your Home Assistant server. This will load up the IFTTT component and make a service available to trigger events in IFTTT. +Once you have added your key to your `configuration.yaml` file, restart your Home Assistant server. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.

After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow. diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown index c2908dee144..8ead80d665c 100644 --- a/source/_components/ihc.markdown +++ b/source/_components/ihc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IHC" -description: "Instructions on how to integrate the IHC components with Home Assistant" +description: "Instructions on how to integrate the IHC integrations with Home Assistant" date: 2017-11-11 22:00 sidebar: true comments: false @@ -71,13 +71,13 @@ info: ## {% linkable_title Auto setup of IHC products %} -If the auto setup is enabled, the `ihc` component 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. +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 %} -Each device is associated with an IHC resource id. To manually setup components 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. +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. The project file is an XML file and you can view it with any text/XML editor. You can rename it to have the XML extension and use a browser like Chrome or Internet Explorer. The resources are the \ or \ elements. Shown as inputs or outputs of products in the IHC application. You can also use inputs and outputs from function blocks. These are the \ and \ elements from the project file. diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index d2dfd222ce2..3311c755604 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -60,7 +60,7 @@ The following event attributes will be present (platform-dependent): `entity_id` ## {% linkable_title scan_interval and Optimising Resources %} -Image processing components 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. +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. ```yaml # Example configuration.yaml diff --git a/source/_components/imap.markdown b/source/_components/imap.markdown index cd675022fe7..e7aa43b15ba 100644 --- a/source/_components/imap.markdown +++ b/source/_components/imap.markdown @@ -67,7 +67,7 @@ search: ### {% linkable_title Configuring IMAP Searches %} -By default, this component will count unread emails. By configuring the search string, you can count other results, for example: +By default, this integration will count unread emails. By configuring the search string, you can count other results, for example: * `ALL` to count all emails in a folder * `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)) diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index c5d5047e84d..9aa71bbb39e 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -17,14 +17,14 @@ redirect_from: - /components/sensor.influxdb/ --- -The `influxdb` component makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or if you're using Hass.io, [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. +The `influxdb` integration makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or if you're using Hass.io, [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. There is currently support for the following device types within Home Assistant: - [Sensor](#sensor)

-The `influxdb` database component runs parallel to the Home Assistant database. It does not replace it. +The `influxdb` database integration runs parallel to the Home Assistant database. It does not replace it.

## {% linkable_title Configuration %} @@ -74,7 +74,7 @@ verify_ssl: default: true max_retries: type: integer - description: Set this to allow the component to retry if there was a network error when transmitting data. + description: Set this to allow the integration to retry if there was a network error when transmitting data. required: false default: 0 default_measurement: @@ -88,7 +88,7 @@ override_measurement: required: false exclude: type: list - description: Configure which components should be excluded from recording to InfluxDB. + description: Configure which integrations should be excluded from recording to InfluxDB. required: false keys: entities: @@ -101,7 +101,7 @@ exclude: required: false include: type: list - description: Configure which components should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the **exclude** lists will take precedence. + description: Configure which integrations should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the **exclude** lists will take precedence. required: false keys: entities: @@ -133,7 +133,7 @@ component_config: component_config_domain: type: string required: false - description: This attribute contains domain-specific component override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. + description: This attribute contains domain-specific integration override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. keys: override_measurement: type: string diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 711f800b147..0273a07bbb4 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Boolean" -description: "Instructions on how to integrate the Input Boolean component into Home Assistant." +description: "Instructions on how to integrate the Input Boolean integration into Home Assistant." date: 2016-01-17 16:58 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.11 --- -The `input_boolean` component allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations. +The `input_boolean` integration allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations. To enable input booleans in your installation, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ input_boolean: ### {% linkable_title Restore State %} -This component 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`. +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 %} diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 24af729cd29..b77ba74547d 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Datetime" -description: "Instructions on how to integrate the Input Datetime component into Home Assistant." +description: "Instructions on how to integrate the Input Datetime integration into Home Assistant." date: 2017-09-14 16:01 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.55 ha_qa_scale: internal --- -The `input_datetime` component allows the user to define date and time values +The `input_datetime` integration allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates. @@ -81,13 +81,13 @@ automations and templates. ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home +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 %} -This component provides a service to modify the state of the `input_datetime`. +This integration provides a service to modify the state of the `input_datetime`. | Service | Data | Description | | ----- | ----- | ----- | diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 1fd23355f1f..75ab05c282e 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Number" -description: "Instructions on how to integrate the Input Number component into Home Assistant." +description: "Instructions on how to integrate the Input Number integration into Home Assistant." date: 2017-09-19 03:30 sidebar: true comments: false @@ -16,10 +16,10 @@ ha_qa_scale: internal ---

-Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option. Also, service `select_value` is now `set_value`. +Before version 0.55 this integration was known as `input_slider` and did not have the `mode` configuration option. Also, service `select_value` is now `set_value`.

-The `input_number` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. +The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. To enable this input number in your installation, add the following lines to your `configuration.yaml`: @@ -86,7 +86,7 @@ input_number: ### {% linkable_title Restore State %} -This component 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`. +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 %} diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index 9da10404134..e5218340884 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Select" -description: "Instructions on how to integrate the Input Select component into Home Assistant." +description: "Instructions on how to integrate the Input Select integration into Home Assistant." date: 2016-02-02 17:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.13 ha_qa_scale: internal --- -The `input_select` component allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. +The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. To enable this platform in your installation, add the following lines to your `configuration.yaml`: @@ -66,11 +66,11 @@ Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, a ### {% linkable_title Restore State %} -This component 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`. +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 %} -This components provide three services to modify the state of the `input_select`. +This integrations provide three services to modify the state of the `input_select`. | Service | Data | Description | | ------- | ---- | ----------- | diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 2cfa1bd7686..1ec62c4528d 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Text" -description: "Instructions on how to integrate the Input Text component into Home Assistant." +description: "Instructions on how to integrate the Input Text integration into Home Assistant." date: 2016-03-15 06:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.53 ha_qa_scale: internal --- -The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). +The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). ```yaml # Example configuration.yaml entries @@ -73,7 +73,7 @@ input_text: ### {% linkable_title Services %} -This components provide three services to modify the state of the `input_text`. +This integrations provide three services to modify the state of the `input_text`. | Service | Data | Description | | ------- | ---- | ----------- | @@ -81,7 +81,7 @@ This components provide three services to modify the state of the `input_text`. ### {% linkable_title Restore State %} -This component 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`. +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 %} diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown index b3539442a7d..2d6c7df3676 100644 --- a/source/_components/insteon.markdown +++ b/source/_components/insteon.markdown @@ -27,7 +27,7 @@ redirect_from: ha_release: 0.39 --- -This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. +This integration adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. There is currently support for the following device types within Home Assistant: @@ -250,7 +250,7 @@ insteon: ### {% linkable_title What NOT to do %} -Insteon Modem is a top-level component 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: +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: ```yaml light: diff --git a/source/_components/intent_script.markdown b/source/_components/intent_script.markdown index 20a0c06074a..03942ddd6c9 100644 --- a/source/_components/intent_script.markdown +++ b/source/_components/intent_script.markdown @@ -14,7 +14,7 @@ ha_release: "0.50" ha_qa_scale: internal --- -The `intent_script` component allows users to configure actions and responses to intents. Intents can be fired by any component that supports it. Examples are [Alexa](/components/alexa/) (Amazon Echo), [Dialogflow](/components/dialogflow/) (Google Assistant) and [Snips](/components/snips/). +The `intent_script` integration allows users to configure actions and responses to intents. Intents can be fired by any integration that supports it. Examples are [Alexa](/components/alexa/) (Amazon Echo), [Dialogflow](/components/dialogflow/) (Google Assistant) and [Snips](/components/snips/). ```yaml # Example configuration.yaml entry diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown index 012bd24c055..c8764f871e1 100644 --- a/source/_components/introduction.markdown +++ b/source/_components/introduction.markdown @@ -14,9 +14,9 @@ ha_release: 0.7

This integration has been removed in Home Assistant 0.92. The UI will now take care of this text.

-The introduction component will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up. +The introduction integration will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up. -The introduction component is loaded by default on a new Home Assistant instance. +The introduction integration is loaded by default on a new Home Assistant instance. ```yaml # Example configuration.yaml entry diff --git a/source/_components/ios.markdown b/source/_components/ios.markdown index bbad6b84642..b9c35417ff5 100644 --- a/source/_components/ios.markdown +++ b/source/_components/ios.markdown @@ -14,4 +14,4 @@ ha_release: 0.31 ha_iot_class: Configurable --- -The `ios` component is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. +The `ios` integration is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_components/iota.markdown b/source/_components/iota.markdown index f7793f606a4..17e1ac972f5 100644 --- a/source/_components/iota.markdown +++ b/source/_components/iota.markdown @@ -19,7 +19,7 @@ redirect_from: [IOTA](http://iota.org/) is a new blockless distributed ledger which is scalable, lightweight and makes it possible to transfer value without any fees. -The `iota` component displays various details (e.g., the balance, node attributes) of IOTA wallets. +The `iota` integration displays various details (e.g., the balance, node attributes) of IOTA wallets. ```yaml # configuration.yaml example @@ -67,7 +67,7 @@ iota: ## {% linkable_title Sensor %} -The sensors are automatically created if the IOTA component is present. +The sensors are automatically created if the IOTA integration is present. Available sensors: diff --git a/source/_components/iperf3.markdown b/source/_components/iperf3.markdown index 7fe67b3e436..44b6aa3b014 100644 --- a/source/_components/iperf3.markdown +++ b/source/_components/iperf3.markdown @@ -17,13 +17,13 @@ redirect_from: - /components/sensor.iperf3/ --- -The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public [Iperf3](http://software.es.net/iperf/index.html) server. +The `iperf3` sensor integration allows you to measure network bandwidth performance against a private or public [Iperf3](http://software.es.net/iperf/index.html) server. -Enabling this component 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. +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 %} -This component 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. +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 %} @@ -114,7 +114,7 @@ You can use the service `sensor.iperf3_update` to trigger a manual speed test fo ### {% linkable_title Service %} -Once loaded, the `iperf3` component 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. +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. | Service data attribute | Description | | `host` | String that point at a configured `host` from configuration.yaml. Otherwise, tests will be run against all configured hosts. diff --git a/source/_components/itach.markdown b/source/_components/itach.markdown index 9c39c7aeb99..63a851c75e1 100644 --- a/source/_components/itach.markdown +++ b/source/_components/itach.markdown @@ -80,9 +80,9 @@ devices: type: string {% endconfiguration %} -An example to call the component from developer tools using the `remote.send_command` service: `{ "entity_id":"remote.tv", "command":"menu" }` +An example to call the integration from developer tools using the `remote.send_command` service: `{ "entity_id":"remote.tv", "command":"menu" }` -Note: Global Cache devices expect data in their own format of "sendir...". This component converts hex code to Global Cache IR form. +Note: Global Cache devices expect data in their own format of "sendir...". This integration converts hex code to Global Cache IR form. API Docs: diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index b2429628127..cdd30ea0c94 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/notify.joaoapps_join/ --- -The `joaoapps_join` component exposes services from +The `joaoapps_join` integration exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component @@ -102,7 +102,7 @@ You can use them like so: } ``` -The services exposed in the `joaoapps_join` component can be used with the +The services exposed in the `joaoapps_join` integration can be used with the service data described below: | Service | Data | diff --git a/source/_components/keenetic_ndms2.markdown b/source/_components/keenetic_ndms2.markdown index f3e7eb66d54..bcbebdd4fb0 100644 --- a/source/_components/keenetic_ndms2.markdown +++ b/source/_components/keenetic_ndms2.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/device_tracker.keenetic_ndms2/ --- -This component offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/) +This integration offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/) Router running NDMS2 firmware. To use a Keenetic router in your installation, add the following to your `configuration.yaml` file: @@ -54,4 +54,4 @@ interface: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index 45a044c1e33..eaf70a627da 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: pre 0.7 --- -The `keyboard` component simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS): +The `keyboard` integration simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS): - `keyboard/volume_up` - `keyboard/volume_down` diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index a01c19964a0..02fc97db18d 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push Receive signals from a keyboard and use it as a remote control. -This component allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules. +This integration allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules. The `evdev` package is used to interface with the keyboard and thus this is Linux only. It also means you can't use your normal keyboard for this because `evdev` will block it. @@ -84,9 +84,9 @@ automation: ## {% linkable_title Disconnections %} -This component manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery. +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. -If the keyboard disconnects, the component will fire an event `keyboard_remote_disconnected`. +If the keyboard disconnects, the integration will fire an event `keyboard_remote_disconnected`. When the keyboard reconnects, an event `keyboard_remote_connected` will be fired. Here's an automation example that plays a sound through a media player whenever the keyboard connects/disconnects: diff --git a/source/_components/kira.markdown b/source/_components/kira.markdown index 3be677669b4..b75a784cdec 100644 --- a/source/_components/kira.markdown +++ b/source/_components/kira.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/remote.kira/ --- -The `kira` component is the main component to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. +The `kira` integration is the main integration to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. There is currently support for the following device types within Home Assistant: @@ -93,7 +93,7 @@ If no sensors or remotes are specified, a sensor with default values will be add ### {% linkable_title Code Configuration %} -The first time the Kira component is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory. +The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory. ```yaml # Example kira_codes.yaml entry diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 3217c688da8..cf505449c26 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices. -The component requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus. +The integration requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.

Please note, the `knx` platform does not support Windows and needs at least python version 3.5. @@ -113,7 +113,7 @@ fire_event_filter: required: inclusive type: [list, string] state_updater: - description: The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior. + description: The integration will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior. required: false default: true type: boolean @@ -140,7 +140,7 @@ payload: ### {% linkable_title Exposing sensor values or time to knx bus %} -KNX component is able to expose time or sensor values to KNX bus. The component will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address: +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: ```yaml # Example configuration.yaml entry @@ -160,7 +160,7 @@ type: description: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). type: string entity_id: - description: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. + description: Entity id of the HASS integration to be exposed. Not necessary for types time and datetime. type: string address: description: KNX group address. diff --git a/source/_components/kodi.markdown b/source/_components/kodi.markdown index 3f0f335eafe..827545a0e24 100644 --- a/source/_components/kodi.markdown +++ b/source/_components/kodi.markdown @@ -138,7 +138,7 @@ With the `turn_on_action` and `turn_off_action` parameters you can run any combi #### Turn on Kodi with Wake on LAN -With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to config the [`wake_on_lan`](/components/wake_on_lan) component in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. +With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to config the [`wake_on_lan`](/components/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. ```yaml media_player: diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index de134519eb4..93122801396 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -19,20 +19,20 @@ redirect_from: - /components/switch.konnected/ --- -The `konnected` component lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. +The `konnected` integration lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware. -The component currently supports the following device types in Home Assistant: +The integration currently supports the following device types in Home Assistant: - Binary Sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch. - Switch: Actuate a siren, strobe, buzzer or relay module. - Sensor: Periodic measurements from DHT temperature/humidity sensors and DS18B20 temperature sensors. -This component uses the [`discovery`](/components/discovery) component, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description. +This integration uses the [`discovery`](/components/discovery) component, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description.

-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` component 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) +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 %} @@ -299,7 +299,7 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use 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 component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component. +This integration supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component. ### {% linkable_title Switch %} diff --git a/source/_components/kwb.markdown b/source/_components/kwb.markdown index bb4736616f9..2f0fd0d6dd6 100644 --- a/source/_components/kwb.markdown +++ b/source/_components/kwb.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.kwb/ --- -The `kwb` component integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller () into Home Assistant. +The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller () into Home Assistant. Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals). diff --git a/source/_components/lannouncer.markdown b/source/_components/lannouncer.markdown index eb52832c2e6..b67ff08ed1c 100644 --- a/source/_components/lannouncer.markdown +++ b/source/_components/lannouncer.markdown @@ -46,7 +46,7 @@ port: ### {% linkable_title 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 component doesn't use them. +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. Lannouncer uses the default Android TTS voice. You can tweak that in the Android configuration, or you can install a different TTS engine from the Play Store. You might want to raise the volume in the app settings since that depends on the actual hardware device. diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index b796e6c7f27..bc6197675e7 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -27,7 +27,7 @@ redirect_from: The `lcn` integration for Home Assistant allows you to connect to [LCN](http://www.lcn.eu) hardware devices. -The component requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses. +The integration requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses. With this setup sending and receiving commands to and from LCN modules is possible. There is currently support for the following device types within Home Assistant: @@ -41,7 +41,7 @@ There is currently support for the following device types within Home Assistant: - [Switch](#switch)

- Please note: Besides the implemented platforms the `lcn` component offers a variety of [service calls](#services). + Please note: Besides the implemented platforms the `lcn` integration offers a variety of [service calls](#services). These service calls cover functionalities of the LCN system which cannot be represented by the platform implementations. They are ideal to be used in automation scripts or for the `template` platforms.

@@ -333,7 +333,7 @@ Modules can be arranged in _segments_. Segments can be addressed by their numeri LCN Modules within the _same_ segment can be grouped by their group id (5..254) or 3 (= target all groups.) -The LCN component allows the connection to more than one hardware coupler. In this case it has to be specified which hardware coupler should be used for addressing the specified module. +The LCN integration allows the connection to more than one hardware coupler. In this case it has to be specified which hardware coupler should be used for addressing the specified module. Whenever the address of a module or a group has to be specified, it can be addressed using one of the following syntaxes: diff --git a/source/_components/lg_netcast.markdown b/source/_components/lg_netcast.markdown index e5b59c32db2..6bb81bf3c13 100644 --- a/source/_components/lg_netcast.markdown +++ b/source/_components/lg_netcast.markdown @@ -45,7 +45,7 @@ name: To get the access token for your TV configure the `lg_netcast` platform in Home Assistant without the `access_token`. After starting Home Assistant the TV will display the access token on screen. -Just add the token to your configuration and restart Home Assistant and the media player component for your LG TV will show up. +Just add the token to your configuration and restart Home Assistant and the media player integration for your LG TV will show up.

The access token will not change until you factory reset your TV. diff --git a/source/_components/lg_soundbar.markdown b/source/_components/lg_soundbar.markdown index 14e54ca98a1..0bf1c27c243 100644 --- a/source/_components/lg_soundbar.markdown +++ b/source/_components/lg_soundbar.markdown @@ -22,7 +22,7 @@ Supported devices: - The SK range -Compatible devices will be automatically added if the [`discovery`](/components/discovery/) component is enabled. +Compatible devices will be automatically added if the [`discovery`](/components/discovery/) integration is enabled. ### {% linkable_title Supported operations %} diff --git a/source/_components/life360.markdown b/source/_components/life360.markdown index dd01a0624a6..7037636417a 100644 --- a/source/_components/life360.markdown +++ b/source/_components/life360.markdown @@ -243,4 +243,4 @@ automation: ## {% linkable_title 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 component would no longer work. +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 4a966855d21..ce77866a3d6 100644 --- a/source/_components/lifx.markdown +++ b/source/_components/lifx.markdown @@ -15,11 +15,11 @@ ha_release: 0.81 redirect_from: /components/light.lifx/ --- -The `lifx` component allows you to integrate your [LIFX](https://www.lifx.com) into Home Assistant. +The `lifx` integration allows you to integrate your [LIFX](https://www.lifx.com) into Home Assistant. -_Please note, the `lifx` component does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._ +_Please note, the `lifx` integration does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._ -You can configure the LIFX component by going to the integrations page inside the config panel. +You can configure the LIFX integration by going to the integrations page inside the config panel. ## {% linkable_title Set state %} diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 794efa26195..80149d6185d 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -14,14 +14,14 @@ ha_release: 0.44 ha_iot_class: Local Polling --- -The `knx light` component is used as an interface to control knx actuators for lighting applications such as: +The `knx light` integration is used as an interface to control knx actuators for lighting applications such as: - switching actuators - dimming actuators - LED controllers - DALI gateways -The `knx` component must be configured correctly to use this component, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly to use this component, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/light.markdown b/source/_components/light.markdown index cc0563c73c6..d2b5c8f9041 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -This component allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it. +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 %} diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index 2dd1812b75f..f1a0024a4a1 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -14,7 +14,7 @@ ha_release: 0.38 ha_iot_class: Assumed State --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). @@ -140,7 +140,7 @@ Any on/off command from any alias ID updates the current state of the light. How ### {% linkable_title 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 component support three types of lights to make things work in every situation: +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: - *Hybrid*: This type sends a `dim` followed by an an `on` command; and `off` commands. This will make dimmable devices turn on at the requested dim level and on/off devices on. One caveat is this type is not compatible with signal repetition as multiple `on` signals will cause dimmers to go into disco mode. - *Switchable*: Device type that sends only `on` and `off` commands. It work for both on/off and dimmable type switches. However dimmables might have issues with signal repetition (see above). diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index f51d239cd96..22a874754b7 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -15,7 +15,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform creates lights that combine components and provides the +The `template` platform creates lights that combine integrations and provides the ability to run scripts or invoke services for each of the on, off, and brightness commands of a light. diff --git a/source/_components/light.xiaomi_aqara.markdown b/source/_components/light.xiaomi_aqara.markdown index 76627f37d38..5b433fbab97 100644 --- a/source/_components/light.xiaomi_aqara.markdown +++ b/source/_components/light.xiaomi_aqara.markdown @@ -15,7 +15,7 @@ ha_iot_class: Local Push --- -The `xiaomi aqara` light platform allows you to control the internal light of the xiaomi gateway. The component will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. +The `xiaomi aqara` light platform allows you to control the internal light of the xiaomi gateway. The integration will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. The requirement is that you have setup [Xiaomi aqara](/components/xiaomi_aqara/). diff --git a/source/_components/lightwave.markdown b/source/_components/lightwave.markdown index 4caecd8e0e0..227e9128324 100644 --- a/source/_components/lightwave.markdown +++ b/source/_components/lightwave.markdown @@ -19,9 +19,9 @@ redirect_from: - /components/switch.lightwave/ --- -The `lightwave` component links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches. +The `lightwave` integration links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches. -This component uses the official API published by Lightwave on their website [https://api.lightwaverf.com/](https://api.lightwaverf.com/). +This integration uses the official API published by Lightwave on their website [https://api.lightwaverf.com/](https://api.lightwaverf.com/). To add your Lightwave devices into your Home Assistant installation, add the following to your `configuration.yaml` file: ```yaml @@ -53,7 +53,7 @@ Each `switch` or `light` requires an `id` and a `name`. The `id` takes the form The first use of a light or switch will try to register with your Lightwave WiFi Link hub. If the hub has not been registered a message on your hub will be displayed asking you to pair the device. You have 12 seconds to push the button on your hub to accept this. Once done, you should be able to control your lights and switches via Home Assistant. This only needs to be done if the hub has not been registered. -The Lightwave Home Assistant component currently supports the following Lightwave devices: +The Lightwave Home Assistant integration currently supports the following Lightwave devices: - Lightwave lights - Lightwave switches diff --git a/source/_components/linksys_ap.markdown b/source/_components/linksys_ap.markdown index 905a41f895b..3cc93ad60b3 100644 --- a/source/_components/linksys_ap.markdown +++ b/source/_components/linksys_ap.markdown @@ -68,4 +68,4 @@ device_tracker: consider_home: 12 ``` -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/linksys_smart.markdown b/source/_components/linksys_smart.markdown index 40218e7173a..de5c03ff4be 100644 --- a/source/_components/linksys_smart.markdown +++ b/source/_components/linksys_smart.markdown @@ -44,4 +44,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index f114b51c969..758879c2c9f 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.linode/ --- -The `linode` component allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. +The `linode` integration allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 0b25e8bcbd9..31021895773 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push [LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/components/automation/). -Sending IR commands is not supported in this component (yet), but can be accomplished using the [shell_command component](/components/shell_command/) in conjunction with the `irsend` command. +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 %} @@ -82,7 +82,7 @@ lirc: #### {% linkable_title Events %} -The LIRC component fires `ir_command_received` events on the bus. You can capture the events and respond to them in automation scripts like this: +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: ```yaml # Example configuration.yaml automation entry diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index 065cf915907..bc08dc77371 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -21,7 +21,7 @@ Keeps track which locks are in your environment, their state and allows you to c ### {% linkable_title Services %} -A lock component provides the following services: +A lock integration provides the following services: #### {% linkable_title Service `lock.lock` %} diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown index b7282a64b61..39d6e4cde4b 100644 --- a/source/_components/lock.template.markdown +++ b/source/_components/lock.template.markdown @@ -19,7 +19,7 @@ The `template` platform creates locks that combines components. For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a lock that knows whether the garage door is open or closed. -This can simplify the GUI and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves. +This can simplify the GUI and make it easier to write automations. You can mark the integrations you have combined as `hidden` so they don't appear themselves. 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. diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index 51ec7583b94..5ed22180c9c 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Logbook" -description: "Instructions on how to enable the logbook component for Home Assistant." +description: "Instructions on how to enable the logbook integration for Home Assistant." date: 2015-04-25 9:23 sidebar: true comments: false @@ -15,12 +15,12 @@ ha_release: 0.7 -The logbook component provides a different perspective on the history of your +The logbook integration provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. [See the demo for a live example](/demo/). It depends on -the `recorder` component for storing the data. This means that if the -[`recorder`](/components/recorder/) component is set up to use e.g., MySQL or -PostgreSQL as data store, the `logbook` component does not use the default +the `recorder` integration for storing the data. This means that if the +[`recorder`](/components/recorder/) integration is set up to use e.g., MySQL or +PostgreSQL as data store, the `logbook` integration does not use the default SQLite database to store data. To enable the logbook in your installation, @@ -33,7 +33,7 @@ logbook: {% configuration %} exclude: - description: "Configure which components should **not** create logbook entries." + description: "Configure which integrations should **not** create logbook entries." required: false type: map keys: @@ -46,7 +46,7 @@ exclude: required: false type: list include: - description: Configure which components should create logbook entries. + description: Configure which integrations should create logbook entries. required: false type: map keys: diff --git a/source/_components/logentries.markdown b/source/_components/logentries.markdown index 48d8e16dc08..67bf57d3bf3 100644 --- a/source/_components/logentries.markdown +++ b/source/_components/logentries.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.13 --- -The `logentries` component makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint. +The `logentries` integration makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint. Open the **Add a Log** page and choose **Manual**. Enter a name for your log in **Log Name**, add a group in **Select Log Set**, set **Token TCP - logs are identified by a token.** and press **Create Log Token**. The generated token is required for the Home Assistant configuration. -To use the `logentries` component in your installation, add the following to your `configuration.yaml` file: +To use the `logentries` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 9d186deb679..8e3ec41f2c5 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Logger" -description: "Instructions on how to enable the logger component for Home Assistant." +description: "Instructions on how to enable the logger integration for Home Assistant." date: 2015-11-12 17:00 sidebar: true comments: false @@ -14,10 +14,10 @@ ha_qa_scale: internal ha_release: 0.8 --- -The `logger` component lets you define the level of logging activities in Home +The `logger` integration lets you define the level of logging activities in Home Assistant. -To enable the `logger` component in your installation, +To enable the `logger` integration in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -68,7 +68,7 @@ logger: type: '[log_level](#log-levels)' default: debug logs: - description: List of components and their log level. + description: List of integrations and their log level. required: false type: map keys: @@ -94,7 +94,7 @@ Possible log severity levels, listed in order from most severe to least severe, ### {% linkable_title Service `set_default_level` %} -You can alter the default log level (for components without a specified log +You can alter the default log level (for integrations without a specified log level) using the service `logger.set_default_level`. An example call might look like this: @@ -107,7 +107,7 @@ data: ### {% linkable_title Service `set_level` %} -You can alter log level for one or several components using the service +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. An example call might look like this: diff --git a/source/_components/logi_circle.markdown b/source/_components/logi_circle.markdown index a38aec5ea84..81255182169 100644 --- a/source/_components/logi_circle.markdown +++ b/source/_components/logi_circle.markdown @@ -85,7 +85,7 @@ Logi Circle cameras support the `camera.turn_on` and `camera.turn_off` services. The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant. -To customize which sensors are setup, you can extend the Logi Circle component configuration in your `configuration.yaml` file with the following settings: +To customize which sensors are setup, you can extend the Logi Circle integration configuration in your `configuration.yaml` file with the following settings: ```yaml # Example configuration.yaml entry diff --git a/source/_components/london_air.markdown b/source/_components/london_air.markdown index 14d7cf26387..6bcfb0c93df 100644 --- a/source/_components/london_air.markdown +++ b/source/_components/london_air.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.london_air/ --- -The `london_air` component [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. +The `london_air` integration [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes. diff --git a/source/_components/luci.markdown b/source/_components/luci.markdown index 40e34119d92..83115e944af 100644 --- a/source/_components/luci.markdown +++ b/source/_components/luci.markdown @@ -20,7 +20,7 @@ _This is one of multiple ways we support OpenWRT. For an overview, see [openwrt] This is a presence detection scanner for OpenWRT using [luci](http://wiki.openwrt.org/doc/techref/luci).

-This component requires a [workaround](https://github.com/home-assistant/home-assistant/issues/1258#issuecomment-252469880) when using luci with HTTPS and a self-signed certificate. +This integration requires a [workaround](https://github.com/home-assistant/home-assistant/issues/1258#issuecomment-252469880) when using luci with HTTPS and a self-signed certificate.

Before this scanner can be used you have to install the luci RPC package on OpenWRT: @@ -60,7 +60,7 @@ ssl: type: boolean {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. This device tracker provides a number of additional attributes for each tracked device (if it is at home): `flags`, `ip`, `device`, and `host`. The first three attributes are taken from the ARP table returned by the luci RPC. The `host` attribute is taken from the platform configuration and can be used to distinguish in which router a device is logged in, if you are using multiple OpenWRT routers. diff --git a/source/_components/luftdaten.markdown b/source/_components/luftdaten.markdown index b55cb0b5f7a..aa8e259f80f 100644 --- a/source/_components/luftdaten.markdown +++ b/source/_components/luftdaten.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/sensor.luftdaten/ --- -The `luftdaten` component 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. +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 %} @@ -109,4 +109,4 @@ luftdaten: 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. -You must have the `luftdaten` component (from above) configured to use this platform. After configuring that component, sensors will automatically appear. +You must have the `luftdaten` integration (from above) configured to use this platform. After configuring that component, sensors will automatically appear. diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown index ad8027a720a..adbf025d5b1 100644 --- a/source/_components/lupusec.markdown +++ b/source/_components/lupusec.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.lupusec/ --- -The `lupusec` component allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). +The `lupusec` integration allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). Supported units: diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index 1b8496c5c6a..753c58008af 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -23,13 +23,13 @@ redirect_from: - /components/switch.lutron/ --- -[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` component in Home Assistant is responsible for communicating with the main hub for these systems. +[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` integration in Home Assistant is responsible for communicating with the main hub for these systems. 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 %} -When configured, the `lutron` component 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. +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. To use Lutron RadioRA 2 devices in your installation, add the following to your `configuration.yaml` file using the IP address of your RadioRA 2 main repeater: @@ -74,7 +74,7 @@ For single-action buttons (scene selection, etc.), `action` will be `single`, an ## {% linkable_title Scene %} -This component uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads. +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. After setup, scenes will appear in Home Assistant using the area, keypad and button name. diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index b45e2da1771..ec5aeb37fb2 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -23,9 +23,9 @@ redirect_from: - /components/switch.lutron_caseta/ --- -[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` component in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](http://www.casetawireless.com) product line of dimmers, switches and shades. +[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](http://www.casetawireless.com) product line of dimmers, switches and shades. -This component only supports the [Caseta](http://www.casetawireless.com) line of products. Both Smart Bridge (L-BDG2-WH) and Smart Bridge PRO (L-BDGPRO2-WH) models are supported. For the RadioRA 2 product line, see the [Lutron component](/components/lutron/). +This integration only supports the [Caseta](http://www.casetawireless.com) line of products. Both Smart Bridge (L-BDG2-WH) and Smart Bridge PRO (L-BDGPRO2-WH) models are supported. For the RadioRA 2 product line, see the [Lutron component](/components/lutron/). The currently supported Caseta devices are: @@ -34,7 +34,7 @@ The currently supported Caseta devices are: - Scenes as Home Assistant - Lutron shades as Home Assistant -When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant. +When configured, the `lutron_caseta` integration will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant. To use Lutron Caseta devices in your installation, you must first log in to your Lutron account and generate a certificate that allows Home Assistant to connect to your bridge. This can be accomplished by downloading and executing [get_lutron_cert.py](https://github.com/gurumitts/pylutron-caseta/blob/master/get_lutron_cert.py), which will generate three files: caseta.key, caseta.crt, caseta-bridge.crt when you run it. See the instructions at the top of the script for more information. @@ -74,7 +74,7 @@ It is recommended to assign a static IP address to your Lutron Smart Bridge. Thi Use a DHCP reservation on your router to reserve the address or in the PRO model of the Smart Bridge, set the IP address under Network Settings in the Advanced / Integration menu in the mobile app.

-To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta component above. +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 %} diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index db47b0549e9..904b883ed40 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/notify.mailgun/ --- -To be able to receive webhooks from Mailgun, 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 component ([docs](/components/http/#base_url)). +To be able to receive webhooks from Mailgun, 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)). To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun. diff --git a/source/_components/manual.markdown b/source/_components/manual.markdown index 18a0c98ce9f..611f755a4d3 100644 --- a/source/_components/manual.markdown +++ b/source/_components/manual.markdown @@ -92,7 +92,7 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered: ## {% linkable_title State machine %} -The state machine of the manual alarm component is complex but powerful. The +The state machine of the manual alarm integration is complex but powerful. The transitions are timed according to three values, **delay_time**, **pending_time** and **trigger_time**. The values in turn can come from the default configuration variable or from a state-specific override. diff --git a/source/_components/manual_mqtt.markdown b/source/_components/manual_mqtt.markdown index a0fa6aa8d76..ecf2e39821a 100644 --- a/source/_components/manual_mqtt.markdown +++ b/source/_components/manual_mqtt.markdown @@ -19,7 +19,7 @@ The `mqtt` platform extends the [manual alarm](/components/alarm_control_panel.m It's essentially the opposite of the [MQTT Alarm Panel](/components/alarm_control_panel.mqtt/) which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device. -The component will accept the following commands from your Alarm Panel via the `command_topic`: +The integration will accept the following commands from your Alarm Panel via the `command_topic`: - `DISARM` - `ARM_HOME` diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown index 4cc3ce41822..2f362d092db 100644 --- a/source/_components/matrix.markdown +++ b/source/_components/matrix.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/notify.matrix/ --- -This component allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. +This integration allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index 6ede1134ffe..a8ec3c95402 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/climate.maxcube/ --- -[eQ-3 MAX!](http://www.eq-3.com/products/max.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported components available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names. +[eQ-3 MAX!](http://www.eq-3.com/products/max.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported integrations available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/mcp23017.markdown b/source/_components/mcp23017.markdown index 4629de4e426..8725d9f9439 100644 --- a/source/_components/mcp23017.markdown +++ b/source/_components/mcp23017.markdown @@ -16,7 +16,7 @@ ha_release: 0.94 ha_iot_class: Local Polling --- -The `mcp23017` component is the base for all related mcp23017 platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding sections. +The `mcp23017` integration is the base for all related mcp23017 platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections. For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017). diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown index ccbfaff639e..d853f0c31bb 100644 --- a/source/_components/media_extractor.markdown +++ b/source/_components/media_extractor.markdown @@ -14,7 +14,7 @@ ha_release: 0.49 ha_qa_scale: internal --- -The `media_extractor` component gets a stream URL and sends it to a media player entity. This component can extract entity specific streams if configured accordingly. +The `media_extractor` integration gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.

Media extractor doesn't transcode streams, it just tries to find stream that match requested query. diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 7a0bbe6d858..cbce37a2b08 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -51,7 +51,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | yes | Target a specific media player. Defaults to all. | -| `media_content_id` | no | A media identifier. The format of this is component dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. | +| `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` %} diff --git a/source/_components/mediaroom.markdown b/source/_components/mediaroom.markdown index e28fdac628a..5409e1d1d6c 100644 --- a/source/_components/mediaroom.markdown +++ b/source/_components/mediaroom.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.mediaroom/ --- -The `mediaroom` component allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. +The `mediaroom` integration allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. To add a Mediaroom STB to your installation, add the following to your `configuration.yaml` file: @@ -38,7 +38,7 @@ media_player: type: string default: Mediaroom STB optimistic: - description: In case the component cannot determine the status of the box, consider the box always ON. + description: In case the integration cannot determine the status of the box, consider the box always ON. required: false type: boolean default: false @@ -46,13 +46,13 @@ media_player: Notice that all parameters are optional, and discovery should configure everything for you. -#### {% linkable_title Using the Mediaroom component %} +#### {% linkable_title Using the Mediaroom integration %} -The component 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. +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. In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. -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 component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. +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 %} diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index 17eafe9bd02..f49f6c291a9 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -17,17 +17,17 @@ redirect_from: - /components/climate.melissa/ --- -The `melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. +The `melissa` integration is the main integration to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. There is currently support for the following device types within Home Assistant: - Climate -The climate platform will be automatically configured if Melissa component is configured. +The climate platform will be automatically configured if Melissa integration is configured. ## {% linkable_title Configuration %} -To set the Melissa component up, add the following information to your `configuration.yaml` file: +To set the Melissa integration up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index e21c4adc556..5b12016f0e0 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -21,16 +21,16 @@ redirect_from: - /components/sensor.mercedesme/ --- -The `mercedesme` component offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. +The `mercedesme` integration offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. -This component provides the following platforms: +This integration provides the following platforms: - Binary Sensors: Windows, tires, doors and lock. - Sensors:Fuel status, service interval, remaining km, etc. - Device tracker: To track location of your car. -Platforms will be automatically configured if Mercedes me component is configured. +Platforms will be automatically configured if Mercedes me integration is configured.

- The component was removed. The vendor disabled the API endpoint and a new API is not available currently. + The integration was removed. The vendor disabled the API endpoint and a new API is not available currently.

diff --git a/source/_components/meteo_france.markdown b/source/_components/meteo_france.markdown index 3226843488d..9abd6cf3762 100644 --- a/source/_components/meteo_france.markdown +++ b/source/_components/meteo_france.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/weather.meteo_france/ --- -The `meteo_france` component uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `city` configured in your `configuration.yaml` file. +The `meteo_france` integration uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `city` configured in your `configuration.yaml` file. There is currently support for the following device types within Home Assistant: @@ -72,7 +72,7 @@ meteo_france: ### {% linkable_title About `city` configuration %} -This component use the Météo-France search API to get the first city from the results returned. +This integration use the Météo-France search API to get the first city from the results returned. It works well with french postal code, city name, etc. In case your expected result doesn't come first, you can set a more specified query like `, `. diff --git a/source/_components/meteoalarm.markdown b/source/_components/meteoalarm.markdown index 5bb38e0a088..f57b9b51217 100644 --- a/source/_components/meteoalarm.markdown +++ b/source/_components/meteoalarm.markdown @@ -105,5 +105,5 @@ automation: {% endraw %}

-This component is not affiliated with MeteoAlarm and retrieves data from the website by using the XML feeds. Use it at your own risk. +This integration is not affiliated with MeteoAlarm and retrieves data from the website by using the XML feeds. Use it at your own risk.

diff --git a/source/_components/metoffice.markdown b/source/_components/metoffice.markdown index 7a5e787a859..de6704a3099 100644 --- a/source/_components/metoffice.markdown +++ b/source/_components/metoffice.markdown @@ -35,7 +35,7 @@ api_key: required: true type: string name: - description: Additional name for the weather component in Home Assistant. + description: Additional name for the weather integration in Home Assistant. required: false type: string default: Met Office diff --git a/source/_components/mhz19.markdown b/source/_components/mhz19.markdown index c01ff9d43fb..866dc57a9c6 100644 --- a/source/_components/mhz19.markdown +++ b/source/_components/mhz19.markdown @@ -66,4 +66,4 @@ Then (after a reboot): you can setup the sensor using: ## {% linkable_title 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 component does not allow turning this functionaly off. +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 496a3513dec..9f7dac5fdf6 100644 --- a/source/_components/microsoft.markdown +++ b/source/_components/microsoft.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/tts.microsoft/ --- -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 component uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. +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 %} diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index d26dffb6c0c..aae2a39cc02 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Microsoft Face" -description: "Instructions on how to integrate Microsoft Face component into Home Assistant." +description: "Instructions on how to integrate Microsoft Face integration into Home Assistant." date: 2017-01-25 00:00 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_category: ha_release: 0.37 --- -The `microsoft_face` component platform is the main component for Microsoft +The `microsoft_face` integration platform is the main integration for Microsoft 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. diff --git a/source/_components/mikrotik.markdown b/source/_components/mikrotik.markdown index 2ae7375363f..472015bccea 100644 --- a/source/_components/mikrotik.markdown +++ b/source/_components/mikrotik.markdown @@ -117,4 +117,4 @@ device_tracker: method: capsman ``` -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/mobile_app.markdown b/source/_components/mobile_app.markdown index ef2ab766b9a..f84a40bef45 100644 --- a/source/_components/mobile_app.markdown +++ b/source/_components/mobile_app.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mobile App" -description: "The Mobile App component allows a generic platform for integrating with mobile apps." +description: "The Mobile App integration allows a generic platform for integrating with mobile apps." date: 2019-03-06 01:30 sidebar: true comments: false @@ -14,16 +14,16 @@ ha_release: 0.89 ha_qa_scale: internal --- -The Mobile App component allows Home Assistant mobile apps to easily integrate with Home Assistant. +The Mobile App integration allows Home Assistant mobile apps to easily integrate with Home Assistant. -If you are planning to use a mobile application that integrates with Home Assistant, we recommend that you keep this component enabled. +If you are planning to use a mobile application that integrates with Home Assistant, we recommend that you keep this integration enabled. 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 %} -This component 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 component manually: +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: ```yaml # Example configuration.yaml entry diff --git a/source/_components/mochad.markdown b/source/_components/mochad.markdown index a4873a903cf..692c3c90738 100644 --- a/source/_components/mochad.markdown +++ b/source/_components/mochad.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/switch.mochad/ --- -The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately. +The `mochad` integration is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/mold_indicator.markdown b/source/_components/mold_indicator.markdown index 65f3ac9d1a5..73981cc1d40 100644 --- a/source/_components/mold_indicator.markdown +++ b/source/_components/mold_indicator.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mold Indicator" -description: "How to use the mold growth indication component in Home Assistant" +description: "How to use the mold growth indication integration in Home Assistant" date: 2016-02-11 22:00 sidebar: true comments: false @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.mold_indicator/ --- -The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. +The Mold Indicator sensor integration consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. 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. @@ -62,7 +62,7 @@ In this case, the weather forecast temperature sensor is used for the outside te ## {% linkable_title Calibration %} -The Mold Indicator sensor component 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. +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: ```text diff --git a/source/_components/mopar.markdown b/source/_components/mopar.markdown index 61ccb5e898c..82f4fa7a81b 100644 --- a/source/_components/mopar.markdown +++ b/source/_components/mopar.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.mopar/ --- -The `mopar` component provides the following for owners of FCA vehicles with a uConnect subscription: +The `mopar` integration provides the following for owners of FCA vehicles with a uConnect subscription: - Sensor per vehicle with vehicle health report and other meta-data - Lock per vehicle allowing to lock/unlock the vehicle diff --git a/source/_components/mpchc.markdown b/source/_components/mpchc.markdown index 6793fe01e97..21cc0b83e2a 100644 --- a/source/_components/mpchc.markdown +++ b/source/_components/mpchc.markdown @@ -19,7 +19,7 @@ redirect_from: The `mpchc` platform allows you to connect a [Media Player Classic Home Cinema](https://mpc-hc.org/) to Home Assistant. It will allow you to see the current playing item, and respond to changes in the player's state. -For this component to function, you will need to enable the Web Interface in the MPC-HC options dialog. +For this integration to function, you will need to enable the Web Interface in the MPC-HC options dialog.

diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index b35a2e57d49..557312d2e07 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -14,7 +14,7 @@ ha_release: 0.11 ha_iot_class: Configurable --- -The `mqtt_eventstream` component connects two Home Assistant instances via MQTT. +The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT. ## {% linkable_title Configuration %} diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index 362edcb75db..966b48b0ff3 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -69,7 +69,7 @@ Example JSON that should be published to the room topics: ### {% linkable_title Setting up clients %} -This component 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. +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: - [**room-assistant**](https://github.com/mKeRix/room-assistant): looks for Bluetooth LE beacons, based on Node.js diff --git a/source/_components/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index 14ea333bc5b..b98d78ab071 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -14,7 +14,7 @@ ha_release: 0.54 ha_iot_class: Configurable --- -The `mqtt_statestream` component publishes state changes in Home Assistant to individual MQTT topics. +The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. ## {% linkable_title Configuration %} @@ -44,7 +44,7 @@ publish_timestamps: default: false type: boolean exclude: - description: Configure which components should be excluded from recordings. See *Include/Exclude* section below for details. + description: Configure which integrations should be excluded from recordings. See *Include/Exclude* section below for details. required: false type: list keys: @@ -57,7 +57,7 @@ exclude: required: false type: list include: - description: Configure which components should be included in recordings. If set, all other entities will not be recorded. + description: Configure which integrations should be included in recordings. If set, all other entities will not be recorded. required: false type: list keys: @@ -73,14 +73,14 @@ include: ## {% linkable_title Operation %} -When any Home Assistant entity changes, this component will publish that change to MQTT. +When any Home Assistant entity changes, this integration will publish that change to MQTT. The topic for each entity is different, so you can easily subscribe other systems to just the entities you are interested in. The topic will be in the form `base_topic/domain/entity/state`. -For example, with the example configuration above, if an entity called 'light.master_bedroom_dimmer' is turned on, this component will publish `on` to `homeassistant/light/master_bedroom_dimmer/state`. +For example, with the example configuration above, if an entity called 'light.master_bedroom_dimmer' is turned on, this integration will publish `on` to `homeassistant/light/master_bedroom_dimmer/state`. -If that entity also has an attribute called `brightness`, the component will also publish the value of that attribute to `homeassistant/light/master_bedroom_dimmer/brightness`. +If that entity also has an attribute called `brightness`, the integration will also publish the value of that attribute to `homeassistant/light/master_bedroom_dimmer/brightness`. All states and attributes are passed through JSON serialization before publishing. **Please note** that this causes strings to be quoted (e.g., the string 'on' will be published as '"on"'). You can access the JSON deserialized values (as well as unquoted strings) at many places by using `value_json` instead of `value`. diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 5d681a94199..b56b7b1a500 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -17,9 +17,9 @@ redirect_from: - /components/sensor.mychevy/ --- -The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The MyChevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and has substantial outages. So be forwarned in using this component. +The `mychevy` integration communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The MyChevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and has substantial outages. So be forwarned in using this component. -This component provides the following platforms: +This integration provides the following platforms: - Binary sensors: if the car is plugged in - Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled @@ -55,7 +55,7 @@ country: The architecture of the GM automotive networking imposes some limitations on the functionality of the component. -The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the `mychevy` component only polls every 30 minutes to not overwhelms that connection. +The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the `mychevy` integration only polls every 30 minutes to not overwhelms that connection. The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not. diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index b7fc620ea8d..4ae4e38e749 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -14,7 +14,7 @@ ha_iot_class: Local Push 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 component 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. +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 %} @@ -149,7 +149,7 @@ mysensors: Present a MySensors sensor or actuator, by following these steps: 1. Connect the serial gateway to your computer or the Ethernet or MQTT gateway to your network. -2. Configure the MySensors component in `configuration.yaml`. +2. Configure the MySensors integration in `configuration.yaml`. 3. Start Home Assistant. 4. Write and upload your MySensors sketch to the sensor. Make sure you: - Send sketch name. @@ -253,7 +253,7 @@ Message validation was introduced in version 0.52 of Home Assistant. ### {% linkable_title 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` component 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. +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 logger: default: info diff --git a/source/_components/mythicbeastsdns.markdown b/source/_components/mythicbeastsdns.markdown index b5db1384f6b..67ae36f5a90 100644 --- a/source/_components/mythicbeastsdns.markdown +++ b/source/_components/mythicbeastsdns.markdown @@ -14,11 +14,11 @@ ha_iot_class: Cloud Push logo: mythic_beasts.png --- -With the `mythicbeastsdns` component you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). +With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/n26.markdown b/source/_components/n26.markdown index b4ea134c675..a5430f2cff1 100644 --- a/source/_components/n26.markdown +++ b/source/_components/n26.markdown @@ -1,7 +1,7 @@ --- layout: page title: "N26" -description: "Instructions on how to integrate N26 component within Home Assistant." +description: "Instructions on how to integrate N26 integration within Home Assistant." date: 2019-03-11 20:00 sidebar: true comments: false diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index b0798ab5004..72884063846 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.56 --- -With the `namecheapdns` component you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/). +With the `namecheapdns` integration you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/).

Namecheap only supports IPv4 addresses to update. @@ -21,7 +21,7 @@ Namecheap only supports IPv4 addresses to update. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 6fe4639c023..ad19520fe74 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/vacuum.neato/ --- -The `neato` component allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). +The `neato` integration allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). To enable `neato` in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ness_alarm.markdown b/source/_components/ness_alarm.markdown index cc60c07a848..6e54e59c29f 100644 --- a/source/_components/ness_alarm.markdown +++ b/source/_components/ness_alarm.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/binary_sensor.ness_alarm/ --- -The `ness_alarm` component will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm. +The `ness_alarm` integration will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 55a8da55918..7c8067cb8a6 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -24,7 +24,7 @@ redirect_from: ha_release: 0.7 --- -The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`. +The Nest integration is the main integration to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`. There is currently support for the following device types within Home Assistant: @@ -50,7 +50,7 @@ There is currently support for the following device types within Home Assistant: * Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important. 8. Click "Create Product" 9. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as `client_id` and `client_secret` below. -10. Add the Nest component to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up. +10. Add the Nest integration to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up. Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible. @@ -207,7 +207,7 @@ You must have the [Nest component](/components/nest/) configured to use the plat The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.

-You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set. +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 %} @@ -277,7 +277,7 @@ Please note due to limitations with the European Nest Thermostat E, integration The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.

-The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set. +The sensors will be setup if the `nest` integration is configured and the required configuration for the `nest sensor` is set.

## {% linkable_title Configuration %} diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 19281f38514..44b496ffa24 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo" -description: "Instructions on how to integrate Netatmo component into Home Assistant." +description: "Instructions on how to integrate Netatmo integration into Home Assistant." date: 2016-06-02 08:10 sidebar: true comments: false @@ -26,7 +26,7 @@ redirect_from: - /components/public_sensor.netatmo/ --- -The `netatmo` component platform is the main component to integrate all Netatmo related platforms. +The `netatmo` integration platform is the main integration to integrate all Netatmo related platforms. There is currently support for the following device types within Home Assistant: @@ -101,7 +101,7 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo 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). -To be able to receive events from Netatmo, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](https://www.home-assistant.io/addons/duckdns/)) and you need to have the base_url configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)). +To be able to receive events from Netatmo, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](https://www.home-assistant.io/addons/duckdns/)) and you need to have the base_url configured for the HTTP integration ([docs](https://www.home-assistant.io/components/http/#base_url)). 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. @@ -141,7 +141,7 @@ The Welcome camera additionally has these attributes for `netatmo_person` events | is_known | Boolean value if the person is known. | face_url | URL to a picture of the person. -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` component to `debug` to view the data in the Home Assistant logs. +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) %} @@ -154,7 +154,7 @@ There are two services to manually add and drop the webhooks. This might be usef ## {% linkable_title Binary Sensor %} -This component allows you to get the latest event seen by the camera. +This integration allows you to get the latest event seen by the camera. ### {% linkable_title Binary Sensor Advanced configuration %} @@ -217,7 +217,7 @@ will create a specific sensor for each camera ## {% linkable_title Camera %} -The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the 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 %} @@ -265,7 +265,7 @@ camera: ## {% linkable_title Climate %} -The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This component allows you to view the current temperature and setpoint. +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 %} diff --git a/source/_components/netgear.markdown b/source/_components/netgear.markdown index 689bbc7b193..622a451d59c 100644 --- a/source/_components/netgear.markdown +++ b/source/_components/netgear.markdown @@ -19,7 +19,7 @@ redirect_from: This platform allows you to detect presence by looking at connected devices to a [Netgear](http://www.netgear.com/) device.

-A recent updates of Orbi APs introduced a bug which takes several hours to detects presence on your local network. The current workaround is to force this component to use the Orbi's API v2 by adding the `accesspoints:` node to your configuration. +A recent updates of Orbi APs introduced a bug which takes several hours to detects presence on your local network. The current workaround is to force this integration to use the Orbi's API v2 by adding the `accesspoints:` node to your configuration.

To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -76,4 +76,4 @@ List of models that are known to use port 80: - Nighthawk X4S - AC2600 (R7800) - Orbi -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/nissan_leaf.markdown b/source/_components/nissan_leaf.markdown index 3eeb5148480..c291d89c383 100644 --- a/source/_components/nissan_leaf.markdown +++ b/source/_components/nissan_leaf.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/switch.nissan_leaf/ --- -The `nissan_leaf` component offers integration with the [NissanConnect EV](http://youplus.nissan.co.uk/GB/en/YouPlus/ConnectedServices.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers: +The `nissan_leaf` integration offers integration with the [NissanConnect EV](http://youplus.nissan.co.uk/GB/en/YouPlus/ConnectedServices.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers: * sensors for the battery status, range and charging status * a switch to start and stop the climate control @@ -102,7 +102,7 @@ You can use the `nissan_leaf.start_charge` service to send a request to the Niss ## {% linkable_title 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 component configuration. The service requests the VIN number as described above. +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. ```yaml - id: update_when_driver_not_home @@ -125,7 +125,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update * 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._ -* This component communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection. +* This integration communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection. * Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute. * The Nissan APIs do not allow charging to be stopped remotely. * The Nissan servers have a history of being unstable, therefore please confirm that the official Nissan Leaf app/website is working correctly before reporting bugs. diff --git a/source/_components/nmap_tracker.markdown b/source/_components/nmap_tracker.markdown index fe414f96646..84aafaa55fc 100644 --- a/source/_components/nmap_tracker.markdown +++ b/source/_components/nmap_tracker.markdown @@ -105,4 +105,4 @@ And you can set up the device tracker as scan_options: " --privileged -sP " ``` -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/nmbs.markdown b/source/_components/nmbs.markdown index 32c295f201e..061e6d332d2 100644 --- a/source/_components/nmbs.markdown +++ b/source/_components/nmbs.markdown @@ -32,7 +32,7 @@ sensor: exclude_vias: true ``` -The stations can only be provided by their standard names and not ids. The list of stations can be checked on the NMBS/SCNB website but for most accurate results check them on the [iRail API page](https://api.irail.be/stations/) which this component uses internally. +The stations can only be provided by their standard names and not ids. The list of stations can be checked on the NMBS/SCNB website but for most accurate results check them on the [iRail API page](https://api.irail.be/stations/) which this integration uses internally. {% configuration %} station_from: diff --git a/source/_components/no_ip.markdown b/source/_components/no_ip.markdown index c5b87a62c44..223f6f72bf0 100644 --- a/source/_components/no_ip.markdown +++ b/source/_components/no_ip.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.57 --- -With the `no_ip` component you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. +With the `no_ip` integration you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. Note that it does not confirm your hostname (as is required periodically for free domain names); you will still need to do that manually. -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/norway_air.markdown b/source/_components/norway_air.markdown index 068c9678a22..33c937cedb3 100644 --- a/source/_components/norway_air.markdown +++ b/source/_components/norway_air.markdown @@ -14,7 +14,7 @@ ha_iot_class: Cloud Polling ha_release: 0.88 --- -The `norway_air` component [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. +The `norway_air` integration [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. To add air quality sensor to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index e0fc018b947..78877b65559 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index 87df0e81f63..e0677d806cd 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported. +The `notify` integration makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported. If you want to send notifications to the Home Assistant Web Interface you may use the [Persistent Notification Component](/components/persistent_notification/). @@ -29,7 +29,7 @@ Once loaded, the `notify` platform will expose a service that can be called to s | `target` | yes | Some platforms will allow specifying a recipient that will receive the notification. See your platform page if it is supported. | `data` | yes | On platforms who have extended functionality. See your platform page if it is supported. -The notification component supports specifying [templates](/topics/templating/) with `data_template`. This will allow you to use the current state of Home Assistant in your notifications. +The notification integration supports specifying [templates](/topics/templating/) with `data_template`. This will allow you to use the current state of Home Assistant in your notifications. In an [action](/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject. diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown index 9af3508e092..a6f6d25a215 100644 --- a/source/_components/nuheat.markdown +++ b/source/_components/nuheat.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/climate.nuheat/ --- -The `nuheat` component lets control your connected [NuHeat Signature]([NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat)) floor heating thermostats from [NuHeat](http://www.nuheat.com/). +The `nuheat` integration lets control your connected [NuHeat Signature]([NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat)) floor heating thermostats from [NuHeat](http://www.nuheat.com/). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index 89925b02407..968026dfdb6 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -14,7 +14,7 @@ ha_release: 0.29 ha_iot_class: Local Polling --- -The `nuimo_controller` component allows you to connect to a [Nuimo](http://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python). +The `nuimo_controller` integration allows you to connect to a [Nuimo](http://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python). To connect to a Nuimo device add the following section to your `configuration.yaml` file: diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 5d5f4f7dc63..e08c2fe09f2 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.octoprint/ --- -[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors. +[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main integration to integrate OctoPrint sensors. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/onboarding.markdown b/source/_components/onboarding.markdown index 56236903277..4214d6def9c 100644 --- a/source/_components/onboarding.markdown +++ b/source/_components/onboarding.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Onboarding" -description: "This component is responsible for providing the onboarding endpoints." +description: "This integration is responsible for providing the onboarding endpoints." date: 2018-03-19 21:04 sidebar: true comments: false @@ -14,4 +14,4 @@ ha_release: 0.73 ha_qa_scale: internal --- -This component creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this component directly. +This integration creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this integration directly. diff --git a/source/_components/onkyo.markdown b/source/_components/onkyo.markdown index 948ecf0797f..3f0d8dfe462 100644 --- a/source/_components/onkyo.markdown +++ b/source/_components/onkyo.markdown @@ -17,7 +17,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 component to work in your Hardware. +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 %} diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index 2cb03e5984e..c478bca543d 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/sensor.opentherm_gw/ --- -The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. +The `opentherm_gw` integration is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. There is currently support for the following device types within Home Assistant: @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - Climate - Sensor -When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. +When enabled, this integration will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant.

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. @@ -273,7 +273,7 @@ monitored_variables: ## {% linkable_title 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` component and look for the status updates. +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 %} diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index bccc8d3c049..472c1d06525 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.openuv/ --- -The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io). +The `openuv` integration displays UV and Ozone data from [openuv.io](http://openuv.io). ## {% linkable_title Generating an API Key %} @@ -39,11 +39,11 @@ loads. To request new data, the `update_data` service may be used. Each use of the `update_data` service will consume 1 or 2 API calls, depending on which monitored conditions are configured. -If the OpenUV component is configured through the Home Assistant UI (via the +If the OpenUV integration is configured through the Home Assistant UI (via the `Configuration >> Integrations` panel), each service call will consume 2 API calls from the daily quota. -If the OpenUV component is configured via `configuration.yaml`, service calls +If the OpenUV integration is configured via `configuration.yaml`, service calls will consume 2 API calls if `monitored_conditions` contains both `uv_protection_window` and any other condition; any other scenarios will only consume 1 API call. diff --git a/source/_components/openwrt.markdown b/source/_components/openwrt.markdown index f9cf6785c48..4ac10e29a27 100644 --- a/source/_components/openwrt.markdown +++ b/source/_components/openwrt.markdown @@ -48,4 +48,4 @@ device_tracker: To get the best of both worlds, you can combine the two approaches, running both a periodic device scanner and an event-based device tracker. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/orangepi_gpio.markdown b/source/_components/orangepi_gpio.markdown index 1cdb9709981..168e16ff756 100644 --- a/source/_components/orangepi_gpio.markdown +++ b/source/_components/orangepi_gpio.markdown @@ -14,7 +14,7 @@ ha_release: 0.93 ha_iot_class: Local Push --- -The `orangepi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages. +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 %} @@ -55,7 +55,7 @@ invert_logic: default: "`false` (ACTIVE HIGH)" {% endconfiguration %} -Compared to the [Raspberry Pi GPIO](/components/rpi_gpio/) component, this component does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing. +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 %} @@ -70,7 +70,7 @@ As this platform supports different types of GPIO pinouts for difference Orange | `neocore2` | Supports the NanoPi Neocore 2 | ## {% linkable_title Additional steps %} -This component 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. +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/owlet.markdown b/source/_components/owlet.markdown index 4b4b3954cf0..94ae8376a92 100644 --- a/source/_components/owlet.markdown +++ b/source/_components/owlet.markdown @@ -18,9 +18,9 @@ ha_iot_class: Cloud Polling [Owlet Care](https://owletcare.com/) baby monitors check your baby's oxygen level and heart rate while sleeping. -Configuring this component will enable tracking of heart rate, oxygen level, motion and base station connection status. Battery status is available as an attribute on oxygen and heart rate sensors. +Configuring this integration will enable tracking of heart rate, oxygen level, motion and base station connection status. Battery status is available as an attribute on oxygen and heart rate sensors. -This component enables the following platforms automatically: +This integration enables the following platforms automatically: #### {% linkable_title Binary Sensors %} @@ -57,5 +57,5 @@ name: {% endconfiguration %}

-The intended purpose of this component is to enable data logging and automations such as battery status updates and charging reminders. This component should not replace the Owlet app nor should it be used for life-critical notifications. +The intended purpose of this integration is to enable data logging and automations such as battery status updates and charging reminders. This integration should not replace the Owlet app nor should it be used for life-critical notifications.

diff --git a/source/_components/panel_custom.markdown b/source/_components/panel_custom.markdown index 89eb17fc89e..a69d84452a7 100644 --- a/source/_components/panel_custom.markdown +++ b/source/_components/panel_custom.markdown @@ -36,7 +36,7 @@ Store your custom panels in `/www` to make them available in the fronten {% configuration %} name: - description: Name of the web component that renders your panel. + description: Name of the web integration that renders your panel. required: true type: string sidebar_title: diff --git a/source/_components/persistent_notification.markdown b/source/_components/persistent_notification.markdown index eb8985c99e8..e13a48dbe6a 100644 --- a/source/_components/persistent_notification.markdown +++ b/source/_components/persistent_notification.markdown @@ -30,7 +30,7 @@ The service `persistent_notification/create` takes in `message`, `title`, and `n | `title` | yes | Title of the notification. | `notification_id` | yes | If `notification_id` is given, it will overwrite the notification if there already was a notification with that ID. -The `persistent_notification` component supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications. +The `persistent_notification` integration supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications. In an [action](/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject. diff --git a/source/_components/person.markdown b/source/_components/person.markdown index 332936306c8..6b0ca02a1f8 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.88 --- -The person component allows connecting [device tracker](https://www.home-assistant.io/components/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order: +The person integration allows connecting [device tracker](https://www.home-assistant.io/components/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order: 1. If there are stationary trackers (non-GPS trackers, i.e., a router or Bluetooth 'device_trackers') presenting the status 'home', the tracker most recently updated will be used. 2. If there are trackers of type 'gps', then the most recently updated tracker will be used. @@ -36,15 +36,15 @@ 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` component via the Home Assistant configuration panel %} +## {% linkable_title Configuring the `person` integration via the Home Assistant configuration panel %} -If you prefer to use the configuration panel to configure the `person` component simply add one line to your `configuration.yaml` file and restart Home Assistant. +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. ```yaml person: ``` -## {% linkable_title Configuring the `person` component via YAML %} +## {% linkable_title Configuring the `person` integration via YAML %} If you prefer YAML, you can also configure your persons via `configuration.yaml`: diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 8dfe42157b5..4e1df44ff2f 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -25,7 +25,7 @@ redirect_from: This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/programs/daemon.html) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication. -The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes. +The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other integrations (e.g., automation). Additionally a send service is provided to send RF codes. There is currently support for the following device types within Home Assistant: @@ -111,11 +111,11 @@ name: required: false type: string payload_on: - description: "Variable `on` value. The component will recognize this as logical '1'." + description: "Variable `on` value. The integration will recognize this as logical '1'." required: false type: [string, float, integer] payload_off: - description: "Variable `off` value. The component will recognize this as logical '0'." + description: "Variable `off` value. The integration will recognize this as logical '0'." required: false type: [string, float, integer] disarm_after_trigger: diff --git a/source/_components/ping.markdown b/source/_components/ping.markdown index e99c62b91c9..b74dbe40d37 100644 --- a/source/_components/ping.markdown +++ b/source/_components/ping.markdown @@ -61,7 +61,7 @@ The sensor exposes the different round trip times values measured by `ping` as a - `round trip time min` - `round trip time max` -The default polling interval is 5 minutes. As many components [based on the entity class](/docs/configuration/platform_options), it is possible to overwrite this scan interval by specifying a `scan_interval` configuration key (value in seconds). In the example below we setup the `ping` binary sensor to poll the devices every 30 seconds. +The default polling interval is 5 minutes. As many integrations [based on the entity class](/docs/configuration/platform_options), it is possible to overwrite this scan interval by specifying a `scan_interval` configuration key (value in seconds). In the example below we setup the `ping` binary sensor to poll the devices every 30 seconds. ```yaml # Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds. @@ -107,4 +107,4 @@ count: type: integer {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/plaato.markdown b/source/_components/plaato.markdown index 5ae43cb5f8f..7fab3e8bd76 100644 --- a/source/_components/plaato.markdown +++ b/source/_components/plaato.markdown @@ -14,7 +14,7 @@ ha_category: ha_iot_class: Cloud Push --- -This component sets up integration with [Plaato Airlock](https://www.plaato.io/). +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! diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 7ba67c60fff..488aa2be4a5 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -35,7 +35,7 @@ plant: {% configuration %} entity_id: - description: Set by you and is used by the component as the `entity_id`. + description: Set by you and is used by the integration as the `entity_id`. required: true type: list keys: diff --git a/source/_components/plex.markdown b/source/_components/plex.markdown index be6245d2861..2533f91807b 100644 --- a/source/_components/plex.markdown +++ b/source/_components/plex.markdown @@ -87,7 +87,7 @@ verify: ### {% linkable_title Customization %} -You can customize the Plex component by adding any of the variables below to your configuration: +You can customize the Plex integration by adding any of the variables below to your configuration: ```yaml # Example configuration.yaml entry diff --git a/source/_components/postnl.markdown b/source/_components/postnl.markdown index d38f4e3d181..e39a79ae390 100644 --- a/source/_components/postnl.markdown +++ b/source/_components/postnl.markdown @@ -48,5 +48,5 @@ password: {% endconfiguration %}

-This component is not affiliated with PostNL and retrieves data from the endpoints of the mobile application. Use at your own risk. +This integration is not affiliated with PostNL and retrieves data from the endpoints of the mobile application. Use at your own risk.

diff --git a/source/_components/prometheus.markdown b/source/_components/prometheus.markdown index 1d31b5affa2..c428cefee07 100644 --- a/source/_components/prometheus.markdown +++ b/source/_components/prometheus.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.49 --- -The `prometheus` component exposes metrics in a format which [Prometheus](https://prometheus.io/) can read. +The `prometheus` integration exposes metrics in a format which [Prometheus](https://prometheus.io/) can read. -To use the `prometheus` component in your installation, add the following to your `configuration.yaml` file: +To use the `prometheus` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -28,7 +28,7 @@ namespace: required: false type: string filter: - description: Filtering directives for the components which should be included or excluded from recording. + description: Filtering directives for the integrations which should be included or excluded from recording. required: false type: list keys: diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 1c708cdac4a..f38e402fa86 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -14,9 +14,9 @@ ha_release: 0.13 ha_qa_scale: internal --- -The `proximity` component allows you to monitor the proximity of devices to a particular [zone](/components/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data. +The `proximity` integration allows you to monitor the proximity of devices to a particular [zone](/components/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data. -This component is useful to reduce the number of automation rules required when wanting to perform automations based on locations outside a particular zone. The [zone](/getting-started/automation-trigger/#zone-trigger) and [state](/getting-started/automation-trigger/#state-trigger) based triggers allow similar control but the number of rules grows exponentially when factors such as direction of travel need to be taken into account. +This integration is useful to reduce the number of automation rules required when wanting to perform automations based on locations outside a particular zone. The [zone](/getting-started/automation-trigger/#zone-trigger) and [state](/getting-started/automation-trigger/#state-trigger) based triggers allow similar control but the number of rules grows exponentially when factors such as direction of travel need to be taken into account. Some examples of its use include: @@ -40,7 +40,7 @@ The Proximity entity which is created has the following values: - 'mi' - 'ft' -To enable this component in your installation, add the following to your `configuration.yaml` file: +To enable this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -56,7 +56,7 @@ proximity: {% configuration %} zone: - description: The zone to which this component is measuring the distance to. Default is the home zone. + description: The zone to which this integration is measuring the distance to. Default is the home zone. required: false type: map keys: diff --git a/source/_components/ps4.markdown b/source/_components/ps4.markdown index 24a360a73c8..764a1aff2a6 100644 --- a/source/_components/ps4.markdown +++ b/source/_components/ps4.markdown @@ -14,10 +14,10 @@ ha_release: 0.89 ha_iot_class: Local Polling --- -The `ps4` component allows you to control a +The `ps4` integration allows you to control a [Sony PlayStation 4 console](https://www.playstation.com/en-us/explore/ps4/). -- This component supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release. +- This integration supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release. ## {% linkable_title Requirements %} @@ -41,7 +41,7 @@ The `ps4` component allows you to control a ## {% linkable_title Granting Port Access %} -The PlayStation 4 component 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. +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.

Do not run your Home Assistant instance itself as root or with root/sudo privileges to accomplish this. This would create a security risk for your host system. @@ -77,7 +77,7 @@ sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5 To find your system Python path: -- Add the [System Health](https://www.home-assistant.io/components/system_health/) component to your `configuration.yaml`. In a web browser access your frontend and navigate to the about/logs page "http:///dev-info). In the System Health box locate the item **python_version** and note the value that is displayed. Then in terminal run: +- Add the [System Health](https://www.home-assistant.io/components/system_health/) integration to your `configuration.yaml`. In a web browser access your frontend and navigate to the about/logs page "http:///dev-info). In the System Health box locate the item **python_version** and note the value that is displayed. Then in terminal run: ```bash whereis python @@ -111,12 +111,12 @@ When running Home Assistant using Docker, make sure that the Home Assistant cont ## {% linkable_title Configuration %}

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

## {% linkable_title 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 component 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. +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. | Available Regions | Unavailable Regions | | --------------------------------------------------------------------------- | -------------------------- | diff --git a/source/_components/ptvsd.markdown b/source/_components/ptvsd.markdown index ba7c77531ff..b80b5f693e7 100644 --- a/source/_components/ptvsd.markdown +++ b/source/_components/ptvsd.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.93 --- -The `ptvsd` component allows you to use the Visual Studio Code PTVSD debugger with Home Assistant. +The `ptvsd` integration allows you to use the Visual Studio Code PTVSD debugger with Home Assistant. This is useful in testing changes on a local development install, or connecting to a production server to debug issues. -To enable the `ptvsd` component add the following to your `configuration.yaml` file: +To enable the `ptvsd` integration add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -58,7 +58,7 @@ There have been reports of continually increasing memory use while the debugger ### {% linkable_title Waiting at startup %} -If you want to debug something in the boot-up sequence, configure the component to wait for a connection first: +If you want to debug something in the boot-up sequence, configure the integration to wait for a connection first: ```yaml # Example configuration.yaml entry diff --git a/source/_components/pulseaudio_loopback.markdown b/source/_components/pulseaudio_loopback.markdown index 5d60c9f99e7..08e2768ba13 100644 --- a/source/_components/pulseaudio_loopback.markdown +++ b/source/_components/pulseaudio_loopback.markdown @@ -22,7 +22,7 @@ For example, for a system with a 7.1 surround sound card, and 3 instances of [MP The benefit of this approach is that this audio routing can occur without modifying the design-time configuration of MPD or PulseAudio. -This component uses a TCP connection to control a local or remote PulseAudio server. So there are no local dependencies. +This integration uses a TCP connection to control a local or remote PulseAudio server. So there are no local dependencies. To enable this switch, add the following lines to your `configuration.yaml` file: @@ -69,5 +69,5 @@ tcp_timeout: {% endconfiguration %}

-This component relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this component, `module-cli-protocol` must be loaded on the PulseAudio server. +This integration relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this component, `module-cli-protocol` must be loaded on the PulseAudio server.

diff --git a/source/_components/pushover.markdown b/source/_components/pushover.markdown index 0371d118917..a25e7a4f2b6 100644 --- a/source/_components/pushover.markdown +++ b/source/_components/pushover.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/notify.pushover/ --- -The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover. +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 %} @@ -67,7 +67,7 @@ To use notifications, please see the [getting started with automation page](/get When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api). -Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: +Example notification triggered from the Alexa integration for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: {% raw %} diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index 574a426b159..d60955d5a20 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -14,7 +14,7 @@ ha_release: 0.47 ha_qa_scale: internal --- -This component allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: +This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: | Name | Description | | ---- | ----------- | diff --git a/source/_components/qnap.markdown b/source/_components/qnap.markdown index bfdc37cfb56..95c6472996c 100644 --- a/source/_components/qnap.markdown +++ b/source/_components/qnap.markdown @@ -128,7 +128,7 @@ If your QNAP device uses self-signed certificates, set the `verify_ssl` option t ### {% linkable_title QNAP device support: %} -This component has been tested on the following devices: +This integration has been tested on the following devices: - TS-259 Pro+ (QTS 4.2.6) - TS-410 (QTS 4.2.3) diff --git a/source/_components/quantum_gateway.markdown b/source/_components/quantum_gateway.markdown index 2747c206742..8d2ec7e7396 100644 --- a/source/_components/quantum_gateway.markdown +++ b/source/_components/quantum_gateway.markdown @@ -48,4 +48,4 @@ ssl: default: True {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index 2f330d4693b..9b87c0a5209 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/switch.qwikswitch/ --- -The `qwikswitch` component is the main component to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application. +The `qwikswitch` integration is the main integration to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application. There is currently support for the following device types within Home Assistant: @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -The `qwikswitch` component 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/). +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 %} diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index 637c2d37782..b62b336addc 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - **Binary Sensor** - Allows you to view the status of your [Rachio irrigation system](http://rachio.com/). - [**Switch**](#switch) -They will be automatically added if the Rachio component component is loaded. +They will be automatically added if the Rachio integration integration is loaded. ## {% linkable_title Getting your Rachio API Key %} diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 82211c4c199..18ddecf21c7 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.rainbird/ --- -This `rainbird` component 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. +This `rainbird` integration 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. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index d88af8d316c..9a1f49a24f2 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.raincloud/ --- -The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. +The `raincloud` integration allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index 132313647ce..dcfc0bf45c5 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.rainmachine/ --- -The `rainmachine` component is the main component to integrate all platforms related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/). +The `rainmachine` integration is the main integration to integrate all platforms related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/raspihats.markdown b/source/_components/raspihats.markdown index bf229a3eb14..df5b21c7e2b 100644 --- a/source/_components/raspihats.markdown +++ b/source/_components/raspihats.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.raspihats/ --- -The `raspihats` component is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the component itself. +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 %} diff --git a/source/_components/raspyrfm.markdown b/source/_components/raspyrfm.markdown index 4c7c3180a9e..6aa2a81910f 100644 --- a/source/_components/raspyrfm.markdown +++ b/source/_components/raspyrfm.markdown @@ -16,11 +16,11 @@ redirect_from: - /components/switch.raspyrfm/ --- -The `raspyrfm` component adds support for cheap RC 433 MHz outlets via one of the supported gateways. +The `raspyrfm` integration adds support for cheap RC 433 MHz outlets via one of the supported gateways. -Initially, this component was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi. +Initially, this integration was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi. -Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this component like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html). +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 %} diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 9c522e73cc5..609d9b721f8 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -14,13 +14,13 @@ ha_release: pre 0.7 ha_qa_scale: internal --- -The `recorder` component is responsible for storing details in a database, which then are handled by the [`history` component](/components/history/). +The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history` component](/components/history/). Home Assistant uses [SQLAlchemy](http://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM). This means that you can use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/). The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant`) and called `home-assistant_v2.db`. -To change the defaults for the `recorder` component in your installation, add the following to your `configuration.yaml` file: +To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -48,7 +48,7 @@ recorder: default: 1 type: integer exclude: - description: Configure which components should be excluded from recordings. + description: Configure which integrations should be excluded from recordings. required: false type: map keys: @@ -61,7 +61,7 @@ recorder: required: false type: List include: - description: Configure which components should be included in recordings. If set, all other entities will not be recorded. + description: Configure which integrations should be included in recordings. If set, all other entities will not be recorded. required: false type: map keys: @@ -129,7 +129,7 @@ Call the service `recorder.purge` to start a purge task which deletes events and | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the component `purge_keep_days` configuration) +| `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 %} diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index 890c7fed736..49eaafd508e 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.57 --- -The `Remember The Milk` (RTM) component 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 component allows you to have several RTM accounts in parallel. +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 %} @@ -60,7 +60,7 @@ In the background Home Assistant downloaded a "token" from the Remember The Milk ## {% linkable_title Creating/updating tasks with service ```create_task```%} -This component 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. +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. If you set an ```id``` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an ```id```, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task. diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index 8ae40a89946..f5ef991b05f 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -16,7 +16,7 @@ ha_release: 0.94 ha_iot_class: Local Push --- -The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding sections. +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 %} diff --git a/source/_components/repetier.markdown b/source/_components/repetier.markdown index 15654ed411a..03fb8adb5e8 100644 --- a/source/_components/repetier.markdown +++ b/source/_components/repetier.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling --- [Repetier-Server](https://www.repetier-server.com/) is a 3D printer/CNC server, able to control multiple devices on the same server. -This component handles the main integration to the server. +This integration handles the main integration to the server. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/rest.markdown b/source/_components/rest.markdown index 5536b035395..41d033c6549 100644 --- a/source/_components/rest.markdown +++ b/source/_components/rest.markdown @@ -207,7 +207,7 @@ my_sensor_secret_token: Bearer gh_DHQIXKVf6Pr4H8Yqz8uhApk_mnV6Zje6Pr4H8Yqz8A8nCx ### {% linkable_title Use GitHub to get the latest release of Home Assistant %} -This sample is very similar to the [`updater`](/components/updater/) component but the information is received from GitHub. +This sample is very similar to the [`updater`](/components/updater/) integration but the information is received from GitHub. ```yaml sensor: diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index bde8f82b077..2a77a169171 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -14,7 +14,7 @@ ha_release: 0.36 ha_iot_class: Local Push --- -This component can expose regular REST commands as services. Services can be called from a [script] or in [automation]. +This integration can expose regular REST commands as services. Services can be called from a [script] or in [automation]. [script]: /components/script/ [automation]: /getting-started/automation/ diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 8ab36707493..9ff0b8a4f91 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.38 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors. @@ -25,7 +25,7 @@ Note: Versions later than R44 add support for Ikea Ansluta, Philips Living Color A complete list of devices supported by RFLink can be found [here](http://www.rflink.nl/blog2/devlist). -This component is tested with the following hardware/software: +This integration is tested with the following hardware/software: - Nodo RFLink Gateway V1.4/RFLink R46 @@ -120,7 +120,7 @@ sensor: [RFLink Switches](/components/switch.rflink/) and [RFLink Binary Sensors](/components/binary_sensor.rflink/) cannot be added automatically. -The RFLink component 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. +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 %} @@ -147,7 +147,7 @@ Wildcards only work at the end of the ID, not in the middle or front! ### {% linkable_title 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 component please consider testing and adding support yourself. +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 %} @@ -156,7 +156,7 @@ If you find a device is recognized differently, with different protocols or the ### {% linkable_title 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 component 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. +- 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. diff --git a/source/_components/rfxtrx.markdown b/source/_components/rfxtrx.markdown index 2c933f81c1e..5cfcfc7e142 100644 --- a/source/_components/rfxtrx.markdown +++ b/source/_components/rfxtrx.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: pre 0.7 --- -The `rfxtrx` component supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com) which communicate in the frequency range of 433.92 MHz. +The `rfxtrx` integration supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com) which communicate in the frequency range of 433.92 MHz. To enable RFXtrx in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index ef23e231d78..90b4bc2ffa5 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -109,7 +109,7 @@ Currently it supports doorbell and stickup cameras. ## {% linkable_title 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) component in your configuration by adding the following to your `configuration.yaml`. +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`. ```yaml downloader: @@ -149,7 +149,7 @@ data = { 'filename': ring_cam.attributes.get('friendly_name') } -# call downloader component to save the video +# call downloader integration to save the video hass.services.call('downloader', 'download_file', data) ``` diff --git a/source/_components/ritassist.markdown b/source/_components/ritassist.markdown index 81cad07f613..33e4d7e11bc 100644 --- a/source/_components/ritassist.markdown +++ b/source/_components/ritassist.markdown @@ -61,7 +61,7 @@ include: type: strings {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. ## {% linkable_title Available attributes %} diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown index 6caf4c53e8d..7d2a95611e1 100644 --- a/source/_components/roku.markdown +++ b/source/_components/roku.markdown @@ -19,14 +19,14 @@ redirect_from: - /components/media_player.roku/ --- -The [Roku](http://www.roku.com/) component allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/components/discovery/). +The [Roku](http://www.roku.com/) integration allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/components/discovery/). There is currently support for the following device types within Home Assistant: - Media Player - Remote -The `roku` component can also be forced to load by adding the following lines to your `configuration.yaml`: +The `roku` integration can also be forced to load by adding the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry diff --git a/source/_components/roomba.markdown b/source/_components/roomba.markdown index ec0f7b30b6a..1b7dc688825 100644 --- a/source/_components/roomba.markdown +++ b/source/_components/roomba.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/vacuum.roomba/ --- -The `roomba` component allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum. +The `roomba` integration allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum.

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. diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown index a69cf2f170b..45b635e93dd 100644 --- a/source/_components/route53.markdown +++ b/source/_components/route53.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.81 --- -With the `route53` component can you keep your AWS Route53 DNS records up to date. +With the `route53` integration can you keep your AWS Route53 DNS records up to date. -The component will run every hour, but can also be started manually by using the service `route53.update_records` under services. +The integration will run every hour, but can also be started manually by using the service `route53.update_records` under services. Please note that this platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address. @@ -61,11 +61,11 @@ Here is an IAM Policy sample, don't forget to update your Zone ID on the Resourc 4. Once this has been done, create a new user called `homeassistant` and add the IAM policy to the user, allowing it to manage this DNS resource. -5. Under the security credentials tab for the `homeassistant` user, create a set of access keys for placement in the component definition YAML. +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 %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/rova.markdown b/source/_components/rova.markdown index c0b810a0939..1ecc44969d4 100644 --- a/source/_components/rova.markdown +++ b/source/_components/rova.markdown @@ -109,5 +109,5 @@ automation: {% endraw %}

-This component is not affiliated with Rova and retrieves data from the endpoints of their website. Use at your own risk. +This integration is not affiliated with Rova and retrieves data from the endpoints of their website. Use at your own risk.

diff --git a/source/_components/rpi_camera.markdown b/source/_components/rpi_camera.markdown index 1af3b0db255..5cedd54b3e5 100644 --- a/source/_components/rpi_camera.markdown +++ b/source/_components/rpi_camera.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/camera.rpi_camera/ --- -The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. +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 %} diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index ed21af54d40..b93ef5ac8ad 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.rpi_gpio/ --- -The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages. +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 %} diff --git a/source/_components/rpi_pfio.markdown b/source/_components/rpi_pfio.markdown index 02845b62720..c56ca851dfa 100644 --- a/source/_components/rpi_pfio.markdown +++ b/source/_components/rpi_pfio.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.rpi_pfio/ --- -The `rpi_pfio` component is the base for all related [PiFace Digital I/O (PFIO)](http://www.piface.org.uk/) platforms in Home Assistant. There is no setup needed for the component itself; for the platforms, please check their corresponding pages. +The `rpi_pfio` integration is the base for all related [PiFace Digital I/O (PFIO)](http://www.piface.org.uk/) platforms in Home Assistant. There is no setup needed for the integration itself; for the platforms, please check their corresponding pages. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index 31ebb4251cc..83a91590044 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RSS feed template" -description: "Use this component to generate RSS feeds showing your latest data." +description: "Use this integration to generate RSS feeds showing your latest data." date: 2017-04-11 20:42 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.44 ha_qa_scale: internal --- -The `rss_feed_template` component can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform. +The `rss_feed_template` integration can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform. For example, on Android, the app "Simple RSS Widget" can be used to display temperatures on the home screen. diff --git a/source/_components/sabnzbd.markdown b/source/_components/sabnzbd.markdown index b8a44c5f26f..f78a3fea200 100644 --- a/source/_components/sabnzbd.markdown +++ b/source/_components/sabnzbd.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.sabnzbd/ --- -The `sabnzbd` component will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. +The `sabnzbd` integration will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. If SABnzbd is discovered on your network, you can enter your API Key in the Configurator. Press "CONFIGURE" to do it. diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index be3b7b14dbe..85a067b0a38 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/binary_sensor.satel_integra/ --- -The `satel_integra` component will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed). +The `satel_integra` integration will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index e53322c85d2..c700914335e 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -15,7 +15,7 @@ ha_release: 0.63 The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index 96b29b24cff..5ade0182a50 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -71,5 +71,5 @@ automation: ```

-Please note that the scene component for the most part only supports one service call per entity to achieve the state. Due to this limitation, you cannot set states belonging to different services. A workaround for this limitation is to write a script, which you then turn on in your scene. A few components have direct support for multiple service calls per state, Currently this is the media_player and climate components. +Please note that the scene integration for the most part only supports one service call per entity to achieve the state. Due to this limitation, you cannot set states belonging to different services. A workaround for this limitation is to write a script, which you then turn on in your scene. A few integrations have direct support for multiple service calls per state, Currently this is the media_player and climate components.

diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 901f7dcf579..5efd98f0c19 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `script` component allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script component will create an entity for each script and allow them to be controlled via services. +The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script integration will create an entity for each script and allow them to be controlled via services. The sequence of actions is specified using the [Home Assistant Script Syntax](/getting-started/scripts/). diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index 21d33a67047..fa97b0f1b4a 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.scsgate/ --- -The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. +The SCSGate integration support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. There is currently support for the following device types within Home Assistant: @@ -46,7 +46,7 @@ device: ### {% linkable_title How to find the scs_id for your devices %} -The SCSGate component relies on the [scsgate](https://github.com/flavio/scsgate) Python module. +The SCSGate integration relies on the [scsgate](https://github.com/flavio/scsgate) Python module. This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your `configuration.yaml` file. diff --git a/source/_components/sensehat.markdown b/source/_components/sensehat.markdown index d42541c08c3..e38d76a4944 100644 --- a/source/_components/sensehat.markdown +++ b/source/_components/sensehat.markdown @@ -190,7 +190,7 @@ ln -s /usr/lib/python3/dist-packages/RTIMU.cpython-35m-arm-linux-gnueabihf.so /s sudo reboot ``` -Unfortunately enabling the SenseHAT Sensor component for a Virtual Environment install of Home Assistant fails with errors. +Unfortunately enabling the SenseHAT Sensor integration for a Virtual Environment install of Home Assistant fails with errors. _(The Raspberry Pi All-In-One installer and HASSbian both run Home Assistant in an virtual environment)._ These issues have been discussed in the repository issue [#5093](https://github.com/home-assistant/home-assistant/issues/5093) diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index 7c1b0022237..fe0abde9322 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -38,11 +38,11 @@ name: required: false type: string latitude: - description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.nl. + description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this integration to select a different location for buienradar.nl. required: false type: float longitude: - description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.nl. + description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this integration to select a different location for buienradar.nl. required: false type: float timeframe: diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index 88b5a2239f5..509091b5efa 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown index 08dad307556..d4ae3cae133 100644 --- a/source/_components/sensor.rflink.markdown +++ b/source/_components/sensor.rflink.markdown @@ -14,7 +14,7 @@ ha_release: 0.38 ha_iot_class: Local Polling --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). ## {% linkable_title Configuration %} diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index a8129cd686f..631fc1331c5 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7.6 --- -This component can expose regular shell commands as services. Services can be called from a [script] or in [automation]. +This integration can expose regular shell commands as services. Services can be called from a [script] or in [automation]. Shell commands aren't allowed for a camel-case naming, please use lowercase naming only and separate the names with underscores. [script]: /components/script/ diff --git a/source/_components/shiftr.markdown b/source/_components/shiftr.markdown index 540bce296aa..e4b801c884c 100644 --- a/source/_components/shiftr.markdown +++ b/source/_components/shiftr.markdown @@ -13,13 +13,13 @@ ha_category: ha_release: 0.48 --- -The `shiftr` component makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public! +The `shiftr` integration makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public! ## {% linkable_title Configuration %} Create a new [namespace](https://shiftr.io/new) and generate a new token. You will need to use `Key (Username)` and `Secret (Password)` to setup the component. -To use the `shiftr` component in your installation, add the following to your `configuration.yaml` file: +To use the `shiftr` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/shopping_list.markdown b/source/_components/shopping_list.markdown index 7edca86882d..91ad5757b2d 100644 --- a/source/_components/shopping_list.markdown +++ b/source/_components/shopping_list.markdown @@ -14,7 +14,7 @@ ha_release: "0.50" ha_qa_scale: internal --- -The `shopping_list` component allows you to keep track of shopping list items. Includes the ability to add items via your voice using the sentence "Add eggs to my shopping list". +The `shopping_list` integration allows you to keep track of shopping list items. Includes the ability to add items via your voice using the sentence "Add eggs to my shopping list". ## {% linkable_title Configuration %} diff --git a/source/_components/sigfox.markdown b/source/_components/sigfox.markdown index 9346bdc192b..b559f19083c 100644 --- a/source/_components/sigfox.markdown +++ b/source/_components/sigfox.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.sigfox/ --- -[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). +[SigFox](https://www.sigfox.com/en) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). ## {% linkable_title Setup %} diff --git a/source/_components/simplisafe.markdown b/source/_components/simplisafe.markdown index facc5b18d26..e1108078e63 100644 --- a/source/_components/simplisafe.markdown +++ b/source/_components/simplisafe.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/alarm_control_panel.simplisafe/ --- -The `simplisafe` component integrates SimpliSafe home security (V2 and V3) systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated. +The `simplisafe` integration integrates SimpliSafe home security (V2 and V3) systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/sisyphus.markdown b/source/_components/sisyphus.markdown index 6b7476276a9..acee28dbf19 100644 --- a/source/_components/sisyphus.markdown +++ b/source/_components/sisyphus.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - **Light** - Can be used to sleep/wake the table or adjust the brightness of the table light. - **Media Player** - Can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed. -The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus component is configured. +The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured. There are two ways to configure this component. For the automatic discovery of your table(s), simply add the following to your `configuration.yaml`: diff --git a/source/_components/sky_hub.markdown b/source/_components/sky_hub.markdown index c4f08e32b12..15af6329d70 100644 --- a/source/_components/sky_hub.markdown +++ b/source/_components/sky_hub.markdown @@ -34,4 +34,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown index 84d4cec5973..8744012a21a 100644 --- a/source/_components/smappee.markdown +++ b/source/_components/smappee.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/switch.smappee/ --- -The `smappee` component adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. +The `smappee` integration adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. There is currently support for the following device types within Home Assistant: @@ -29,13 +29,13 @@ There is currently support for the following device types within Home Assistant: Will be automatically added when you connect to the Smappee controller. -The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). Note: their cloud API now requires a subscription fee of €2.50 per month for Smappee Energy/Solar or €3 per month for Smappee Plus. +The smappee integration gets information from [Smappee API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). Note: their cloud API now requires a subscription fee of €2.50 per month for Smappee Energy/Solar or €3 per month for Smappee Plus. ## {% linkable_title Configuration %} Info on how to get API access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki). -To use the `smappee` component in your installation, add the following to your `configuration.yaml` file: +To use the `smappee` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/smarthab.markdown b/source/_components/smarthab.markdown index 6eac4877e80..c911db703a6 100644 --- a/source/_components/smarthab.markdown +++ b/source/_components/smarthab.markdown @@ -18,7 +18,7 @@ ha_iot_class: Cloud Polling If your home is fitted with [SmartHab](http://www.smarthab.fr/en/home/)'s devices and you have access to their app-based services, you will be able -to control your lights and shutters with the SmartHab component for Home +to control your lights and shutters with the SmartHab integration for Home Assistant. Once you have added a `smarthab` entry to your configuration, your supported @@ -27,7 +27,7 @@ devices will automatically be discovered and made available on your dashboard.

To prevent being automatically logged out of your SmartHab mobile app, you might want to create a secondary user in the app's settings and grant it - access to your home. You can then configure the component using this account's + access to your home. You can then configure the integration using this account's credentials. This is also more secure, as this user should be less priviledged.

diff --git a/source/_components/smartthings.markdown b/source/_components/smartthings.markdown index 5d51f701561..cb59245e6da 100644 --- a/source/_components/smartthings.markdown +++ b/source/_components/smartthings.markdown @@ -43,7 +43,7 @@ redirect_from: - /components/switch.smartthings/ --- -Samsung SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The SmartThings component is the main component to integrate all SmartThings related platforms. The basic features of this integration include: +Samsung SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The SmartThings integration is the main integration to integrate all SmartThings related platforms. The basic features of this integration include: 1. Controlling SmartThings devices with pushed state updates from SmartThings. 2. Entities automatically added, removed, or updated when changed in SmartThings (upon Home Assistant restart). @@ -62,7 +62,7 @@ The SmartThings integration utilizes a webhook to receive push updates from the ### {% linkable_title Cloudhook via Nabu Casa %} -If you are using Home Assistant Cloud (Nabu Casa) the integration will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the component prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.** +If you are using Home Assistant Cloud (Nabu Casa) the integration will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the integration prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.** 1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions). 2. Home Assistant Cloud is configured and logged-in with a non-expired subscription. @@ -90,7 +90,7 @@ If you are using Home Assistant Cloud (Nabu Casa) the integration will create a ### {% linkable_title Configure Home Assistant %}

-The SmartThings component is configured exclusively through the front-end. Manual setup through `configuration.yaml` is not available at this time. +The SmartThings integration is configured exclusively through the front-end. Manual setup through `configuration.yaml` is not available at this time.

1. From the Home Assistant front-end, navigate to 'Configuration' then 'Integrations'. Under 'Set up a new integration' locate 'SmartThings' and click 'Configure'. @@ -110,11 +110,11 @@ See the [troubleshooting](#troubleshooting) if you are having issues setting up ## {% linkable_title Events %} -The SmartThings component triggers events for select device capabilities. +The SmartThings integration triggers events for select device capabilities. ### {% linkable_title smartthings.button %} -The component will trigger an event when a device with the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload: +The integration will trigger an event when a device with the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload: ```json { @@ -128,7 +128,7 @@ The component will trigger an event when a device with the [button](https://smar | Attribute | Description |---------------------------|------------------------------------------------------------------| -`component_id` | Describes which component of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. +`component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. `device_id` | The unique id of the device in SmartThings. This can be located in the HASS device registry or in the [SmartThings Groovy IDE](https://developers.smartthings.com/). `location_id` | The unique id of the location the device is part of. This can be found in the config entry registry or in the [SmartThings Groovy IDE](https://developers.smartthings.com/). `value` | Describes the action taken on the button. See the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability reference for a list of possible values (not all are supported by every device). @@ -138,7 +138,7 @@ Event data payloads are logged at the debug level, see [debugging](#debugging) f ## {% linkable_title Platforms %} -SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings component maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms. +SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings integration maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms. - [Binary Sensor](#binary-sensor) - [Climate](#climate) @@ -312,7 +312,7 @@ The SmartThings Switch platform lets you control devices that have the [`switch` Perform the following steps if you receive one of the following error messages while attempting to setup the integration (this does not apply when integrated through Home Assistant Cloud): -- "SmartThings could not validate the endpoint configured in base_url. Please review the component requirements." +- "SmartThings could not validate the endpoint configured in base_url. Please review the integration requirements." - "Unable to setup the SmartApp. Please try again." #### {% linkable_title Checklist %} @@ -344,11 +344,11 @@ Perform the following steps if you receive one of the following error messages w {"pingData": {"challenge": "00000000-0000-0000-0000-000000000000"}} ``` -If you have completed the checklist above and are still unable to setup the platform, [activate debug logging](#debugging) for the SmartThings component and include the log messages up until the point of failure in [a new issue](https://github.com/home-assistant/home-assistant/issues). +If you have completed the checklist above and are still unable to setup the platform, [activate debug logging](#debugging) for the SmartThings integration and include the log messages up until the point of failure in [a new issue](https://github.com/home-assistant/home-assistant/issues). ### {% linkable_title Debugging %} -The SmartThings component will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml`: +The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml`: ```yaml logger: diff --git a/source/_components/smarty.markdown b/source/_components/smarty.markdown index cf7caa1f13c..ed00b38f893 100644 --- a/source/_components/smarty.markdown +++ b/source/_components/smarty.markdown @@ -15,14 +15,14 @@ ha_category: ha_release: 0.95 --- -The `smarty` component lets you control Salda [Smarty](http://www.salda.lt/en/products/category/compact-counter-flow-units) ventilation units from Home Assistant. You need a [MB-GATEWAY](http://www.salda.lt/en/products/item/5637227077) or something similar to connect to your local network. +The `smarty` integration lets you control Salda [Smarty](http://www.salda.lt/en/products/category/compact-counter-flow-units) ventilation units from Home Assistant. You need a [MB-GATEWAY](http://www.salda.lt/en/products/item/5637227077) or something similar to connect to your local network. There is currently support for the following device types within Home Assistant: - Fan - Sensor -The component has a fan platform to view and control the ventilation speed, and a sensors platform to read: +The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read: - Outdoor air temperature - Extract air temperature diff --git a/source/_components/smhi.markdown b/source/_components/smhi.markdown index 24564fc4e5e..9dc1df16236 100644 --- a/source/_components/smhi.markdown +++ b/source/_components/smhi.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/weather.smhi/ --- -The `smhi` component adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location. +The `smhi` integration adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index 60dc41ef5b8..6087aaaad3c 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -93,7 +93,7 @@ followed by a command, e.g. > Set the lights to green in the living room -As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. +As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. #### {% linkable_title Optional: specifying an external MQTT broker %} @@ -141,7 +141,7 @@ Alternatively, MQTT can be configured to bridge messages between servers if usin In Home Assistant, we trigger actions based on intents produced by Snips using the [`intent_script`](/components/intent_script) component. For instance, the following block handles a `ActivateLightColor` intent to change light colors: -Note: If your Snips action is prefixed with a username (e.g., `john:playmusic` or `john__playmusic`), the Snips component in Home Assistant [will try and strip off the username](https://github.com/home-assistant/home-assistant/blob/c664c20165ebeb248b98716cf61e865f274a2dac/homeassistant/components/snips.py#L126-L129). Bear this in mind if you get the error `Received unknown intent` even when what you see on the MQTT bus looks correct. Internally the Snips component is trying to match the non-username version of the intent (i.e., just `playmusic`). +Note: If your Snips action is prefixed with a username (e.g., `john:playmusic` or `john__playmusic`), the Snips integration in Home Assistant [will try and strip off the username](https://github.com/home-assistant/home-assistant/blob/c664c20165ebeb248b98716cf61e865f274a2dac/homeassistant/components/snips.py#L126-L129). Bear this in mind if you get the error `Received unknown intent` even when what you see on the MQTT bus looks correct. Internally the Snips integration is trying to match the non-username version of the intent (i.e., just `playmusic`). {% raw %} ```yaml diff --git a/source/_components/snmp.markdown b/source/_components/snmp.markdown index d6ac34a175e..a679debd103 100644 --- a/source/_components/snmp.markdown +++ b/source/_components/snmp.markdown @@ -35,7 +35,7 @@ This device tracker needs SNMP to be enabled on the router. It could be that you ## {% linkable_title Presence Detection %} -The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker component page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [Nmap](/components/device_tracker.nmap_tracker/) instead. +The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker integration page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [Nmap](/components/device_tracker.nmap_tracker/) instead. | Brand | Device/Firmware | OID | |---|---|---|---| @@ -101,7 +101,7 @@ priv_key: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Sensor %} diff --git a/source/_components/solax.markdown b/source/_components/solax.markdown index 180fee62291..bdb4bd37b8f 100644 --- a/source/_components/solax.markdown +++ b/source/_components/solax.markdown @@ -15,7 +15,7 @@ ha_release: 0.94 ha_iot_class: Local Polling --- -The `solax` component connects home-assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This component retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid. +The `solax` integration connects home-assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This integration retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid. ## {% linkable_title Configuration %} diff --git a/source/_components/somfy.markdown b/source/_components/somfy.markdown index 6a7d4a5fad2..4f837dd3a7b 100644 --- a/source/_components/somfy.markdown +++ b/source/_components/somfy.markdown @@ -14,7 +14,7 @@ ha_iot_class: Cloud Polling ha_release: 0.95 --- -The Somfy component will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [tahoma](/components/tahoma/) component. +The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [tahoma](/components/tahoma/) component. ### {% linkable_title Setting up developer account %} @@ -51,7 +51,7 @@ client_secret: type: string {% endconfiguration %} -### {% linkable_title Potential duplicate with the Tahoma component %} +### {% linkable_title Potential duplicate with the Tahoma integration %} If you use the [tahoma](/component/tahoma) component, you will have to exclude the covers added by this one. Otherwise, they will be added twice. diff --git a/source/_components/sonos.markdown b/source/_components/sonos.markdown index 096ac6d69a0..b222753c6bf 100644 --- a/source/_components/sonos.markdown +++ b/source/_components/sonos.markdown @@ -16,9 +16,9 @@ ha_iot_class: Local Polling redirect_from: /components/media_player.sonos/ --- -The `sonos` component allows you to control your [Sonos](https://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. +The `sonos` integration allows you to control your [Sonos](https://www.sonos.com) HiFi wireless speakers and audio integrations from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. -If you don't have the discovery component enabled, you can configure the Sonos component by going to the integrations page inside the config panel. +If you don't have the discovery integration enabled, you can configure the Sonos integration by going to the integrations page inside the config panel. ## {% linkable_title Services %} diff --git a/source/_components/spaceapi.markdown b/source/_components/spaceapi.markdown index 34d9add3420..81e8a83f9d3 100644 --- a/source/_components/spaceapi.markdown +++ b/source/_components/spaceapi.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: "0.70" --- -The `spaceapi` component allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](http://spaceapi.net/). +The `spaceapi` integration allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](http://spaceapi.net/). ## {% linkable_title Configuration %} -To setup the `spaceapi` component in your installation, add the following to your `configuration.yaml` file: +To setup the `spaceapi` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/speedtestdotnet.markdown b/source/_components/speedtestdotnet.markdown index 285897846b3..c9f7b1af7f9 100644 --- a/source/_components/speedtestdotnet.markdown +++ b/source/_components/speedtestdotnet.markdown @@ -18,9 +18,9 @@ redirect_from: - /components/sensor.speedtestdotnet/ --- -The `speedtestdotnet` component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. +The `speedtestdotnet` integration uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. -Enabling this component will automatically create the Speedtest.net Sensors for the monitored conditions (below). +Enabling this integration will automatically create the Speedtest.net Sensors for the monitored conditions (below). 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. @@ -80,15 +80,15 @@ scan_interval: ### {% linkable_title Service %} -Once loaded, the `speedtestdotnet` component will expose a service (`speedtestdotnet.speedtest`) that can be called to run a Speedtest.net speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. +Once loaded, the `speedtestdotnet` integration will expose a service (`speedtestdotnet.speedtest`) that can be called to run a Speedtest.net speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. ```yaml action: service: speedtestdotnet.speedtest ``` -This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. -Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display. +This integration uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. +Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this integration may display. When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `speedtestdotnet.speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. @@ -136,7 +136,7 @@ automation: ## {% linkable_title Notes %} - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. The Raspberry Pi 3+ models comes with a Gigabit LAN adapter which supports a [maximum throughput](https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/) of 300 Mbit/s. -- Running this component can have negative effects on the system's performance as it requires a fair amount of memory. +- Running this integration can have negative effects on the system's performance as it requires a fair amount of memory. - Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running. -- If ran frequently, this component has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. +- If ran frequently, this integration has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. - While running, your network capacity is fully utilized. This may have a negative effect on other devices in use the network such as gaming consoles or streaming boxes. diff --git a/source/_components/spider.markdown b/source/_components/spider.markdown index 244e0e33416..11f9c5f4b37 100644 --- a/source/_components/spider.markdown +++ b/source/_components/spider.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/climate.spider/ --- -The `spider` component is the main component to integrate all [Itho Daalderop Spider](https://www.ithodaalderop.nl/spider-thermostaat) related platforms. You will need your Spider account information (username, password) to discover and control devices which are related to your account. +The `spider` integration is the main integration to integrate all [Itho Daalderop Spider](https://www.ithodaalderop.nl/spider-thermostaat) related platforms. You will need your Spider account information (username, password) to discover and control devices which are related to your account. There is currently support for the following device types within Home Assistant: @@ -52,11 +52,11 @@ scan_interval: {% endconfiguration %}

-This component is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk. +This integration is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk.

### {% linkable_title Climate %}

-Although this component lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation. +Although this integration lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation.

diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index 3446eaf791f..de395889834 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.13 --- -The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. +The `splunk` integration makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. ## {% linkable_title Configuration %} -To use the `splunk` component in your installation, add the following to your `configuration.yaml` file: +To use the `splunk` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/spotify.markdown b/source/_components/spotify.markdown index 605ed0dbac0..cf946f4185a 100644 --- a/source/_components/spotify.markdown +++ b/source/_components/spotify.markdown @@ -25,7 +25,7 @@ The `spotify` media player platform allows you to control - Spotify application, properly configured (see below)

-Controlling the Spotify component (pause, play, next, etc.) requires a Premium account. If you do not have a Premium account, the component in the frontend will not show the controls. +Controlling the Spotify integration (pause, play, next, etc.) requires a Premium account. If you do not have a Premium account, the integration in the frontend will not show the controls.

To create the required Spotify application: diff --git a/source/_components/sql.markdown b/source/_components/sql.markdown index a2ee887e342..e25521de468 100644 --- a/source/_components/sql.markdown +++ b/source/_components/sql.markdown @@ -16,7 +16,7 @@ redirect_from: --- The `sql` sensor platform enables you to use values from an [SQL](https://en.wikipedia.org/wiki/SQL) database supported by the [sqlalchemy](https://www.sqlalchemy.org) library, to populate a sensor state (and attributes). -This can be used to present statistics about Home Assistant sensors if used with the `recorder` component database. It can also be used with an external data source. +This can be used to present statistics about Home Assistant sensors if used with the `recorder` integration database. It can also be used with an external data source. ## {% linkable_title Configuration %} diff --git a/source/_components/srp_energy.markdown b/source/_components/srp_energy.markdown index 87f6f8b9978..a951ca8b058 100644 --- a/source/_components/srp_energy.markdown +++ b/source/_components/srp_energy.markdown @@ -13,7 +13,7 @@ redirect_from: - /components/sensor.srp_energy/ --- -The `srp_energy` component shows information from Srp hourly energy usage report for their customers. The srpenergy module fetches the data found on the website. +The `srp_energy` integration shows information from Srp hourly energy usage report for their customers. The srpenergy module fetches the data found on the website. You need a Username, Password, and AccountId which you can create at [Srp](https://www.srpnet.com). diff --git a/source/_components/statistics.markdown b/source/_components/statistics.markdown index 81183439949..db3eea3b7bd 100644 --- a/source/_components/statistics.markdown +++ b/source/_components/statistics.markdown @@ -19,7 +19,7 @@ redirect_from: The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min`, `max`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If it's a binary sensor then only state changes are counted. -If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup. +If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` integration on startup. If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation. ## {% linkable_title Configuration %} @@ -27,7 +27,7 @@ If you are *not* running the `recorder` component, it can take time till the sen To enable the statistics sensor, add the following lines to your `configuration.yaml`: ```yaml -# enable the recorder component (optional) +# enable the recorder integration (optional) recorder: # Example configuration.yaml entry diff --git a/source/_components/statsd.markdown b/source/_components/statsd.markdown index 467d6f60acf..0ee10e6e850 100644 --- a/source/_components/statsd.markdown +++ b/source/_components/statsd.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.12 --- -The `statsd` component makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance. +The `statsd` integration makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance. -To use the `statsd` component in your installation, add the following to your `configuration.yaml` file: +To use the `statsd` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/stiebel_eltron.markdown b/source/_components/stiebel_eltron.markdown index 979d8065093..6be6d24fa7b 100644 --- a/source/_components/stiebel_eltron.markdown +++ b/source/_components/stiebel_eltron.markdown @@ -14,7 +14,7 @@ ha_release: 0.92 ha_iot_class: Local Polling --- -The `stiebel_eltron` component lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com). +The `stiebel_eltron` integration lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com). It requires the following components: @@ -66,7 +66,7 @@ hub: {% endconfiguration %}

-This component requires the [Modbus](/components/modbus/) component to be set up to work +This integration requires the [Modbus](/components/modbus/) integration to be set up to work

Full configuration example including modbus setup shown below: diff --git a/source/_components/stream.markdown b/source/_components/stream.markdown index 85f31bf63a7..a7bd237310e 100644 --- a/source/_components/stream.markdown +++ b/source/_components/stream.markdown @@ -15,7 +15,7 @@ ha_iot_class: Local Push ha_qa_scale: internal --- -The `stream` component provides a way to proxy live streams through Home Assistant. The component currently only supports proxying H.264 source streams to the HLS format and requires at least FFmpeg >= 3.2. +The `stream` integration provides a way to proxy live streams through Home Assistant. The integration currently only supports proxying H.264 source streams to the HLS format and requires at least FFmpeg >= 3.2. ## {% linkable_title Configuration %} diff --git a/source/_components/streamlabswater.markdown b/source/_components/streamlabswater.markdown index 21bd4583c48..a062d49a9c0 100644 --- a/source/_components/streamlabswater.markdown +++ b/source/_components/streamlabswater.markdown @@ -15,14 +15,14 @@ ha_release: "0.95" ha_iot_class: "Cloud Polling" --- -The `Streamlabs Water` component platform is used to interact with [Streamlabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [Streamlabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode. +The `Streamlabs Water` integration platform is used to interact with [Streamlabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [Streamlabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode. There is currently support for the following device types within Home Assistant: - Binary Sensor - Sensor -In preparation for using this component you will need to request an API key following the instructions in the [Streamlabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token. +In preparation for using this integration you will need to request an API key following the instructions in the [Streamlabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token. ## {% linkable_title Configuration %} diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index cae4f6d77d7..868642f98da 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -The sun component will use your current location to track if the sun is above or +The sun integration will use your current location to track if the sun is above or below the horizon. The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][sun_trigger] or as [a condition with an optional offset to test if the sun has already set or risen][sun_condition]. diff --git a/source/_components/swisscom.markdown b/source/_components/swisscom.markdown index b96a664655b..40407879a16 100644 --- a/source/_components/swisscom.markdown +++ b/source/_components/swisscom.markdown @@ -38,4 +38,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index 0d3139db41d..daba70717c1 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -14,9 +14,9 @@ ha_release: 0.24 ha_iot_class: Local Polling --- -The `knx` switch component is used as in interface to switching actuators. +The `knx` switch integration is used as in interface to switching actuators. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown index b69378cdd89..3dac74cce2b 100644 --- a/source/_components/switch.rflink.markdown +++ b/source/_components/switch.rflink.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.38 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). -The RFLink component does not know the difference between a `switch`, a `binary_sensor` and a `light`. Therefore all switchable devices are automatically added as `light` by default. +The RFLink integration does not know the difference between a `switch`, a `binary_sensor` and a `light`. Therefore all switchable devices are automatically added as `light` by default. RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`. diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown index 900c7e76d1a..132380544dd 100644 --- a/source/_components/switch.rfxtrx.markdown +++ b/source/_components/switch.rfxtrx.markdown @@ -73,7 +73,7 @@ signal_repetitions: {% endconfiguration %}

-This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`. +This integration and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.

diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown index 32eaa1cf798..e9522ea69cb 100644 --- a/source/_components/switch.template.markdown +++ b/source/_components/switch.template.markdown @@ -19,7 +19,7 @@ The `template` platform creates switches that combines components. For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a switch that knows whether the garage door is open or closed. -This can simplify the GUI and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves. +This can simplify the GUI and make it easier to write automations. You can mark the integrations you have combined as `hidden` so they don't appear themselves. ## {% linkable_title Configuration %} diff --git a/source/_components/switcher_kis.markdown b/source/_components/switcher_kis.markdown index 52772e11d13..d61e2024507 100644 --- a/source/_components/switcher_kis.markdown +++ b/source/_components/switcher_kis.markdown @@ -16,7 +16,7 @@ ha_release: 0.93 ha_iot_class: Local Push --- -This `Switcher` component allows you to control the [Switcher V2 Water Heater](https://www.switcher.co.il/). +This `Switcher` integration allows you to control the [Switcher V2 Water Heater](https://www.switcher.co.il/). To enable it, add an entry to your `configuration.yaml` according to the following configuration instructions. @@ -31,7 +31,7 @@ To retrieve your device's details, please follow the instructions [here](https:/

- Please note, on the original script repository, users recently reported difficulties controling the device after upgrading the firmware to the new 3.0 version.As this component is based on that script, please do not upgrade to version 3.0 until this issue is resolved. You can follow the issue [here](https://github.com/NightRang3r/Switcher-V2-Python/issues/3). + Please note, on the original script repository, users recently reported difficulties controling the device after upgrading the firmware to the new 3.0 version.As this integration is based on that script, please do not upgrade to version 3.0 until this issue is resolved. You can follow the issue [here](https://github.com/NightRang3r/Switcher-V2-Python/issues/3).

```yaml switcher_kis: diff --git a/source/_components/switchmate.markdown b/source/_components/switchmate.markdown index 202c794df46..1a67fff3fe9 100644 --- a/source/_components/switchmate.markdown +++ b/source/_components/switchmate.markdown @@ -44,4 +44,4 @@ flip_on_off: default: false {% endconfiguration %} -The component is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle. +The integration is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle. diff --git a/source/_components/synology.markdown b/source/_components/synology.markdown index d1a04f3390c..e82052fcb64 100644 --- a/source/_components/synology.markdown +++ b/source/_components/synology.markdown @@ -19,7 +19,7 @@ redirect_from: The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.

-Synology has disabled the livestreaming API and the component is currently broken if you are using Surveillance Station version 8.2.3-5828. +Synology has disabled the livestreaming API and the integration is currently broken if you are using Surveillance Station version 8.2.3-5828. There is an unsupported preview fix available. (8.2.3-5829) - Instructions can be found [here](https://www.vcloudinfo.com/2019/04/how-to-manually-upgrade-your-synology-surveillance-system-firmware.html) for updating manually.

diff --git a/source/_components/synology_srm.markdown b/source/_components/synology_srm.markdown index 6a01e496875..99e165d2737 100644 --- a/source/_components/synology_srm.markdown +++ b/source/_components/synology_srm.markdown @@ -67,4 +67,4 @@ List of models known to be supported: - RT1900ac - RT2600ac -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/system_health.markdown b/source/_components/system_health.markdown index e226efd2a16..5cd3ae314ca 100644 --- a/source/_components/system_health.markdown +++ b/source/_components/system_health.markdown @@ -1,7 +1,7 @@ --- layout: page title: "System Health" -description: "Systeam Health component will report system info and allow to run system diagnostics." +description: "Systeam Health integration will report system info and allow to run system diagnostics." date: 2019-02-06 13:40 sidebar: true comments: false @@ -14,11 +14,11 @@ ha_qa_scale: internal ha_release: 0.87 --- -The System Health component provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. +The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. Add the following to your configuration.yaml file. ```yaml system_health: ``` -Once added the system health component data can be viewed in the developer tools under service developer tool icon. +Once added the system health integration data can be viewed in the developer tools under service developer tool icon. diff --git a/source/_components/system_log.markdown b/source/_components/system_log.markdown index 3096336ea0f..3d9f143f8b2 100644 --- a/source/_components/system_log.markdown +++ b/source/_components/system_log.markdown @@ -14,11 +14,11 @@ ha_release: 0.58 ha_qa_scale: internal --- -The `system_log` component stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`. +The `system_log` integration stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`. ## {% linkable_title Configuration %} -This component is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: +This integration is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: ```yaml system_log: @@ -69,14 +69,14 @@ Errors and warnings are posted as the event `system_log_event`, so it is possibl Live examples of these events can be found in the Home Assistant log file (`home-assistant.log`) or by just looking in the system log. An example could, for instance, look like this: ```text -2019-02-14 16:20:35 ERROR (MainThread) [homeassistant.loader] Unable to find component system_healt +2019-02-14 16:20:35 ERROR (MainThread) [homeassistant.loader] Unable to find integration system_healt 2019-02-14 16:20:36 ERROR (MainThread) [homeassistant.components.device_tracker] Error setting up platform google_maps Traceback (most recent call last): File "/home/fab/Documents/repos/ha/home-assistant/homeassistant/components/device_tracker/__init__.py", line 184, in [...] ``` -The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. +The message ("Unable to find integration system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. ## {% linkable_title Examples %} diff --git a/source/_components/systemmonitor.markdown b/source/_components/systemmonitor.markdown index dff45f1b268..4e69be1c6b2 100644 --- a/source/_components/systemmonitor.markdown +++ b/source/_components/systemmonitor.markdown @@ -18,7 +18,7 @@ redirect_from: The `systemmonitor` sensor platform allows you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the -process component which is now considered deprecated. +process integration which is now considered deprecated. To add this platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown index 733f48f215c..85a84abf7a1 100644 --- a/source/_components/tado.markdown +++ b/source/_components/tado.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/sensor.tado/ --- -The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. +The `tado` integration platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. There is currently support for the following device types within Home Assistant: @@ -90,7 +90,7 @@ home_id: After configuration, your device has to be at home at least once before showing up as *home* or *away*. Polling Tado API for presence information will happen at most once every 30 seconds. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. ### {% linkable_title Finding your `home_id` %} diff --git a/source/_components/tahoma.markdown b/source/_components/tahoma.markdown index bfb36124078..fc8d3ccdf7d 100644 --- a/source/_components/tahoma.markdown +++ b/source/_components/tahoma.markdown @@ -25,7 +25,7 @@ redirect_from: - /components/sensor.tahoma/ --- -The `Tahoma` component platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform. +The `Tahoma` integration platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/tcp.markdown b/source/_components/tcp.markdown index 025a7987375..fc2b05b5795 100644 --- a/source/_components/tcp.markdown +++ b/source/_components/tcp.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/sensor.tcp/ --- -The TCP component allows the integration of some services for which a specific Home Assistant component does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this component will allow integration with it. +The TCP integration allows the integration of some services for which a specific Home Assistant integration does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this integration will allow integration with it. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/telegram_bot.markdown b/source/_components/telegram_bot.markdown index 524977f5263..6d6ebbda8eb 100644 --- a/source/_components/telegram_bot.markdown +++ b/source/_components/telegram_bot.markdown @@ -16,7 +16,7 @@ ha_iot_class: Cloud Push Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. -This component creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/components/telegram_bot.polling/) method or with the [webhooks](/components/telegram_bot.webhooks/) one, and trigger events when receiving messages. +This integration creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/components/telegram_bot.polling/) method or with the [webhooks](/components/telegram_bot.webhooks/) one, and trigger events when receiving messages. If you don't need to receive messages, you can use the [broadcast](/components/telegram_bot.broadcast/) platform instead. @@ -172,7 +172,7 @@ Remove the bot from the chat group where it was added. ## {% linkable_title `telegram` notification platform %} -The [`telegram` notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. +The [`telegram` notification platform](/components/notify.telegram/) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The required YAML configuration now reduces to: diff --git a/source/_components/tellduslive.markdown b/source/_components/tellduslive.markdown index 7e212988eed..a9ed21c4a03 100644 --- a/source/_components/tellduslive.markdown +++ b/source/_components/tellduslive.markdown @@ -27,13 +27,13 @@ redirect_from: - /components/switch.tellduslive/ --- -The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home. +The `tellduslive` integration let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.

If you are upgrading from 0.58 or older, you need to remove all Telldus configuration from your `configuration.yaml` file before continuing.

-Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API. +Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) integration is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API. ## {% linkable_title Configuration %} @@ -60,4 +60,4 @@ scan_interval: It is only possible to configure the `scan_interval` when setting up the device. If the polling interval needs to be changed after the device is configured it must be changed manually by changing `"scan_interval": 60,` for the device in the file `.storage/core.config_entries`.

-The component will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account. +The integration will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account. diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index 4742b96c093..ca4ebf4d6cb 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.tellstick/ --- -The `tellstick` component integrates [TellStick](https://telldus.com/produkt/z-wave-gateway-tellstick-znet-lite-ver-2/) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). +The `tellstick` integration integrates [TellStick](https://telldus.com/produkt/z-wave-gateway-tellstick-znet-lite-ver-2/) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/tensorflow.markdown b/source/_components/tensorflow.markdown index ee8c2680d73..9158668a7e2 100644 --- a/source/_components/tensorflow.markdown +++ b/source/_components/tensorflow.markdown @@ -19,7 +19,7 @@ redirect_from: The `tensorflow` image processing platform allows you to detect and recognize objects in a camera image using [TensorFlow](https://www.tensorflow.org/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.

- The following packages must be installed on Hassbian/Raspbian before following the setup for the component to work: + The following packages must be installed on Hassbian/Raspbian before following the setup for the integration to work: `$ sudo apt-get install libatlas-base-dev libopenjp2-7 libtiff5`

@@ -27,7 +27,7 @@ The `tensorflow` image processing platform allows you to detect and recognize ob You need to install the `tensorflow` Python packages with: `$ pip3 install tensorflow==1.11.0`. The wheel is not available for all platforms. See [the official install guide](https://www.tensorflow.org/install/) for other options. Hass.io is not yet supported but an addon is under development. -This component requires files to be downloaded, compiled on your computer, and added to the Home Assistant configuration directory. These steps can be performed using the sample script at [this gist](https://gist.github.com/hunterjm/6f9332f92b60c3d5e448ad936d7353c3). Alternatively, if you wish to perform the process manually, the process is as follows: +This integration requires files to be downloaded, compiled on your computer, and added to the Home Assistant configuration directory. These steps can be performed using the sample script at [this gist](https://gist.github.com/hunterjm/6f9332f92b60c3d5e448ad936d7353c3). Alternatively, if you wish to perform the process manually, the process is as follows: - Clone [tensorflow/models](https://github.com/tensorflow/models/tree/master/research/object_detection) - Compile protobuf models located in `research/object_detection/protos` with `protoc` @@ -83,7 +83,7 @@ source: required: false type: string file_out: - description: A [template](/docs/configuration/templating/#processing-incoming-data) for the component to save processed images including bounding boxes. `camera_entity` is available as the `entity_id` string of the triggered source camera. + description: A [template](/docs/configuration/templating/#processing-incoming-data) for the integration to save processed images including bounding boxes. `camera_entity` is available as the `entity_id` string of the triggered source camera. required: false type: list model: diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index c424f77acbe..77c0282708b 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -27,9 +27,9 @@ redirect_from: - /components/switch.tesla/ --- -The `Tesla` component offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature. +The `Tesla` integration offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature. -This component provides the following platforms: +This integration provides the following platforms: - Binary sensors - such as parking and charger connection. - Sensors - such as Battery level, Inside/Outside temperature, odometer, and estimated range. diff --git a/source/_components/tfiac.markdown b/source/_components/tfiac.markdown index f0d1e330dfa..60e205f74e2 100644 --- a/source/_components/tfiac.markdown +++ b/source/_components/tfiac.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/climate.tfiac/ --- -The `tfiac` component integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398). +The `tfiac` integration integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398). ## {% linkable_title Configuration %} diff --git a/source/_components/thethingsnetwork.markdown b/source/_components/thethingsnetwork.markdown index 320236003b0..fac90be48ba 100644 --- a/source/_components/thethingsnetwork.markdown +++ b/source/_components/thethingsnetwork.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.thethingsnetwork/ --- -The `thethingsnetwork` component allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network. +The `thethingsnetwork` integration allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network. The Things network support various integrations to make the data available: diff --git a/source/_components/thingspeak.markdown b/source/_components/thingspeak.markdown index d8864c4d2d3..340df13334f 100644 --- a/source/_components/thingspeak.markdown +++ b/source/_components/thingspeak.markdown @@ -13,14 +13,14 @@ ha_category: ha_release: 0.32 --- -The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). +The `thingspeak` integrations makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](/components/influxdb/). ## {% linkable_title Configuration %} You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use. -To setup the ThingSpeak component in your installation, add the following to your `configuration.yaml` file: +To setup the ThingSpeak integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/thomson.markdown b/source/_components/thomson.markdown index 3eca5dd99bc..4eea5e8d68d 100644 --- a/source/_components/thomson.markdown +++ b/source/_components/thomson.markdown @@ -46,4 +46,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/tibber.markdown b/source/_components/tibber.markdown index 70af502cd8f..c9a7316eaf0 100644 --- a/source/_components/tibber.markdown +++ b/source/_components/tibber.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.tibber/ --- -The `tibber` component provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer. +The `tibber` integration provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer. If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://watty.io/) it will also show the electricity consumption in real time. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/timer.markdown b/source/_components/timer.markdown index 6e214503133..f8280aa096f 100644 --- a/source/_components/timer.markdown +++ b/source/_components/timer.markdown @@ -14,7 +14,7 @@ ha_release: 0.57 ha_qa_scale: internal --- -The `timer` component aims to simplify automations based on (dynamic) durations. +The `timer` integration aims to simplify automations based on (dynamic) durations. When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event. @@ -154,7 +154,7 @@ timer: ### {% linkable_title Control a timer manually %} -With the [`script`](/components/script/) component you would be able to control a timer (see above for a `timer` configuration sample) manually. +With the [`script`](/components/script/) integration you would be able to control a timer (see above for a `timer` configuration sample) manually. ```yaml script: diff --git a/source/_components/tod.markdown b/source/_components/tod.markdown index 1443df092da..6b97736c7dd 100644 --- a/source/_components/tod.markdown +++ b/source/_components/tod.markdown @@ -67,7 +67,7 @@ after_offset: ## {% linkable_title Considerations %} -The primary purpose of this sensor is to use a simple time range definition instead of creating a complex template with references to `sun.sun` component attributes. +The primary purpose of this sensor is to use a simple time range definition instead of creating a complex template with references to `sun.sun` integration attributes. The sensor state is ON when this condition `after` + `after_offset` <= `current time` < `before` + `before_offset`. diff --git a/source/_components/todoist.markdown b/source/_components/todoist.markdown index bf27c18791c..979718e761a 100644 --- a/source/_components/todoist.markdown +++ b/source/_components/todoist.markdown @@ -111,7 +111,7 @@ Home Assistant does its best to [determine what task in each project is "most" i - **location**: Not used. - - **start_time**: The last time the Todoist component got updated. Usually within the last 15 minutes. + - **start_time**: The last time the Todoist integration got updated. Usually within the last 15 minutes. - **end_time**: When the task is due. diff --git a/source/_components/tomato.markdown b/source/_components/tomato.markdown index 14d08f2847f..5498a025875 100644 --- a/source/_components/tomato.markdown +++ b/source/_components/tomato.markdown @@ -70,7 +70,7 @@ http_id: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. A description of the API s available in this diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index 3a72312b636..f09880dfc68 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -21,9 +21,9 @@ redirect_from: - /components/switch.toon/ --- -The `toon` component platform can be used to control your Toon thermostat. This component adds a climate device for your Toon thermostat, sensors for power and gas consumption, sensors for solar production and several binary sensors for things like boiler burner on/off, hot tap water and boiler health status. +The `toon` integration platform can be used to control your Toon thermostat. This integration adds a climate device for your Toon thermostat, sensors for power and gas consumption, sensors for solar production and several binary sensors for things like boiler burner on/off, hot tap water and boiler health status. -For the `toon` component to work, you'll need an active Toon subscription with Eneco and a Toon API developer account. +For the `toon` integration to work, you'll need an active Toon subscription with Eneco and a Toon API developer account. There is currently support for the following device types within Home Assistant: @@ -43,7 +43,7 @@ In order to be able to use this component, you'll need to sign up for a free Too 4. Click on "Create App" to complete the creation process. 5. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page again and click on the app that you've just created. 6. You need the codes now shown: "Consumer Key" and "Consumer Secret". -7. Add the Toon component to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to Toon and follow the setup instructions. +7. Add the Toon integration to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to Toon and follow the setup instructions. ## {% linkable_title Configuration %} diff --git a/source/_components/tplink.markdown b/source/_components/tplink.markdown index 57a1353ad92..158c2969e8c 100644 --- a/source/_components/tplink.markdown +++ b/source/_components/tplink.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/device_tracker.tplink/ --- -The `tplink` component allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as smart plugs and smart bulbs. +The `tplink` integration allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as smart plugs and smart bulbs. There is currently support for the following device types within Home Assistant: @@ -34,7 +34,7 @@ The supported devices in your network are automatically discovered, but if you w ## {% linkable_title Supported Devices %} -This component supports devices that are controllable with the [KASA app](https://www.tp-link.com/us/kasa-smart/kasa.html). +This integration supports devices that are controllable with the [KASA app](https://www.tp-link.com/us/kasa-smart/kasa.html). The following devices are known to work with this component. ### {% linkable_title Plugs %} @@ -153,7 +153,7 @@ Currently supported devices includes the following: - Archer D9 firmware version 0.9.1 0.1 v0041.0 Build 160224 Rel.59129n

-TP-Link devices typically only allow one login at a time to the admin console. This component will count towards your one allowed login. Depending on how aggressively you configure device_tracker you may not be able to access the admin console of your TP-Link device without first stopping Home Assistant. Home Assistant takes a few seconds to login, collect data, and log out. If you log into the admin console manually, remember to log out so that Home Assistant can log in again. +TP-Link devices typically only allow one login at a time to the admin console. This integration will count towards your one allowed login. Depending on how aggressively you configure device_tracker you may not be able to access the admin console of your TP-Link device without first stopping Home Assistant. Home Assistant takes a few seconds to login, collect data, and log out. If you log into the admin console manually, remember to log out so that Home Assistant can log in again.

### {% linkable_title Configuration %} @@ -193,6 +193,6 @@ For Archer C9 models running firmware version 150811 or later please use the enc 5. Type `document.getElementById("login-password").value;` or `document.getElementById("pcPassword").value;`, depending on your firmware version. 6. Copy the returned value to your Home Assistant configuration as password. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. For Archer D9 model the default ip is 192.168.1.1, the username is not necessary and you can leave that field blank. \ No newline at end of file diff --git a/source/_components/tradfri.markdown b/source/_components/tradfri.markdown index bc7307031c7..9718779da0f 100644 --- a/source/_components/tradfri.markdown +++ b/source/_components/tradfri.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/switch.tradfri/ --- -The `tradfri` component support the IKEA Trådfri Gateway (a.k.a. IKEA Tradfri hub/bridge). The gateway can control compatible Zigbee-based lights (certified ZigBee Light Link products) connected to it and Home Assistant will automatically discover the gateways presence on your local network, if `discovery:` is present in your `configuration.yaml` file. +The `tradfri` integration support the IKEA Trådfri Gateway (a.k.a. IKEA Tradfri hub/bridge). The gateway can control compatible Zigbee-based lights (certified ZigBee Light Link products) connected to it and Home Assistant will automatically discover the gateways presence on your local network, if `discovery:` is present in your `configuration.yaml` file. You will be prompted to configure the gateway through the Home Assistant interface. The configuration process is very simple, when prompted, enter the security key printed on the physical sticker that is on the bottom of the IKEA Trådfri Gateway, then click configure. diff --git a/source/_components/transmission.markdown b/source/_components/transmission.markdown index e9bdc1d9a12..2e4bdc463dd 100644 --- a/source/_components/transmission.markdown +++ b/source/_components/transmission.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.transmission/ --- -The `transmission` component allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. +The `transmission` integration allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. ## {% linkable_title Setup %} @@ -100,7 +100,7 @@ monitored_conditions: ## {% linkable_title Event Automation %} -The Transmission component is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus, which allows to implement any kind of automation. +The Transmission integration is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus, which allows to implement any kind of automation. Possible events are: diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index 85b775d1ba9..b58fe8bcd43 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -26,7 +26,7 @@ tts: Depending on your setup, you might need to set a base URL (`base_url`) inside the [http component](/components/http/) or in the parameters of this component.

-The following optional parameters can be used with any platform. However, the TTS component will only look for global settings under the configuration of the first configured platform: +The following optional parameters can be used with any platform. However, the TTS integration will only look for global settings under the configuration of the first configured platform: {% configuration %} cache: @@ -139,7 +139,7 @@ data_template: ## {% linkable_title Cache %} -The component has two caches. Both caches can be controlled with the `cache` option in the platform configuration or the service call `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period. +The integration has two caches. Both caches can be controlled with the `cache` option in the platform configuration or the service call `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period. ## {% linkable_title REST Api %} diff --git a/source/_components/tuya.markdown b/source/_components/tuya.markdown index ddb2840d330..7a0cea9e949 100644 --- a/source/_components/tuya.markdown +++ b/source/_components/tuya.markdown @@ -27,7 +27,7 @@ redirect_from: - /components/switch.tuya/ --- -The `tuya` component is the main component to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. +The `tuya` integration is the main integration to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/twilio.markdown b/source/_components/twilio.markdown index 2485193b7d6..445fea0a2d2 100644 --- a/source/_components/twilio.markdown +++ b/source/_components/twilio.markdown @@ -13,14 +13,14 @@ ha_category: ha_release: "0.40" --- -The `twilio` component enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com). +The `twilio` integration enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com). A free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers. Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation. ## {% linkable_title Configuration %} -To use this notification component in your installation, add the following to your `configuration.yaml` file: +To use this notification integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -42,9 +42,9 @@ auth_token: ### {% linkable_title Usage %} -After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality. +After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) integrations to utilize the notification functionality. -To be able to receive events from Twilio, 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 component ([docs](/components/http/#base_url)). +To be able to receive events from Twilio, 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)). To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio. diff --git a/source/_components/ubee.markdown b/source/_components/ubee.markdown index 98033d9a96d..c547d0340a1 100644 --- a/source/_components/ubee.markdown +++ b/source/_components/ubee.markdown @@ -56,8 +56,8 @@ Supported models: - EVW3226@UPC

-This component uses pyUbee library, which was tested with models listed above. If you have different model of Ubee Router and it doesn't work with this component, please create pyUbee issue to request for support for your model. +This integration uses pyUbee library, which was tested with models listed above. If you have different model of Ubee Router and it doesn't work with this component, please create pyUbee issue to request for support for your model.

By default, Home Assistant pulls information about connected devices from Ubee router every 5 seconds. -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/ubus.markdown b/source/_components/ubus.markdown index 0a637ff158a..11871723c38 100644 --- a/source/_components/ubus.markdown +++ b/source/_components/ubus.markdown @@ -92,7 +92,7 @@ dhcp_software: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Troubleshooting %} @@ -186,7 +186,7 @@ Connection: keep-alive {"jsonrpc":"2.0","id":1,"result":{}} ``` -11. In this case we are actually receiving a valid response with no data. The request says that we are looking for ARP information from `hostapd.*`, which is the access point on the router. In my environment I don't use the AP on the router, and so it was correctly returning no data. Armed with this information, I know that I cannot use this component for device tracking or presence. +11. In this case we are actually receiving a valid response with no data. The request says that we are looking for ARP information from `hostapd.*`, which is the access point on the router. In my environment I don't use the AP on the router, and so it was correctly returning no data. Armed with this information, I know that I cannot use this integration for device tracking or presence. ### {% linkable_title Cleanup %} diff --git a/source/_components/unifi.markdown b/source/_components/unifi.markdown index 2be321f9cc2..f193cb2f6b0 100644 --- a/source/_components/unifi.markdown +++ b/source/_components/unifi.markdown @@ -34,9 +34,9 @@ Home Assistant offers UniFi integration through **Configuration** -> **Integrati Enter `host address`, `user name` and `password` and then continue to select which `site` you want to connect to Home Assistant. The user must have administrator privileges. -## {% linkable_title Debugging component %} +## {% linkable_title Debugging integration %} -If you have problems with UniFi or the component you can add debug prints to the log. +If you have problems with UniFi or the integration you can add debug prints to the log. ```yaml logger: @@ -112,7 +112,7 @@ monitored_conditions: {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ### {% linkable_title Configuring Users %} @@ -120,7 +120,7 @@ The Unifi controller allows you to create multiple users on it besides the main ### {% linkable_title Conflicts with MQTT %} -The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well. +The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well. It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation. diff --git a/source/_components/unifi_direct.markdown b/source/_components/unifi_direct.markdown index 3f3335b46bd..7dcd0fa5727 100644 --- a/source/_components/unifi_direct.markdown +++ b/source/_components/unifi_direct.markdown @@ -45,5 +45,5 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/upc_connect.markdown b/source/_components/upc_connect.markdown index 7a9a36fed15..e4adaf756ac 100644 --- a/source/_components/upc_connect.markdown +++ b/source/_components/upc_connect.markdown @@ -34,7 +34,7 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. Also known to be working with the following devices: - Irish Virgin Media Super Hub 3.0 diff --git a/source/_components/upcloud.markdown b/source/_components/upcloud.markdown index 517f2ed39d3..e592650e94b 100644 --- a/source/_components/upcloud.markdown +++ b/source/_components/upcloud.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.upcloud/ --- -The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant. +The `upcloud` integration allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown index 17453c0308d..6571e89c043 100644 --- a/source/_components/updater.markdown +++ b/source/_components/updater.markdown @@ -14,9 +14,9 @@ ha_qa_scale: internal ha_release: 0.8 --- -The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this component on Hass.io. +The `updater` integration will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this integration on Hass.io. -The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). +The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). ## {% linkable_title Configuration %} @@ -33,7 +33,7 @@ reporting: type: boolean default: true include_used_components: - description: Whether or not to report the components that you are using in Home Assistant. + description: Whether or not to report the integrations that you are using in Home Assistant. required: false type: boolean default: false @@ -41,7 +41,7 @@ include_used_components: For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/). If you choose not to share any information when checking for updates, you can set `reporting: false`. -It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`. +It is possible to report the integrations that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`. ```json "components": [ @@ -60,7 +60,7 @@ It is possible to report the components that you are using to the Home Assistant ## {% linkable_title Notification %} -For an added bonus, an automation component can be created to send a message with a notifier when that state of this component's entity changes. +For an added bonus, an automation integration can be created to send a message with a notifier when that state of this component's entity changes. ```yaml # Example configuration.yaml entry diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown index d26f55aace7..117f9014af4 100644 --- a/source/_components/upnp.markdown +++ b/source/_components/upnp.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.upnp/ --- -The `upnp` component enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router. +The `upnp` integration enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router. The IGD can automatically create port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router. @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: - **Sensor** - Allows to get the network statistics from your router such as bytes in/out and packets in/out. -Please note that UPnP or NAT-PMP needs to be enabled on your router for this component to work. +Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work. ## {% linkable_title Configuration %} @@ -44,12 +44,12 @@ With the default settings only the sensors are added for statistics. If you wish {% configuration %} port_mapping: - description: If the component should try to map ports. + description: If the integration should try to map ports. required: false type: boolean default: false sensors: - description: If the component should enable the UPNP sensors. + description: If the integration should enable the UPNP sensors. required: false type: boolean default: true diff --git a/source/_components/uscis.markdown b/source/_components/uscis.markdown index 3fe075065a1..2e9b5e97ba1 100644 --- a/source/_components/uscis.markdown +++ b/source/_components/uscis.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.uscis/ --- -The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) +The `uscis` sensor integration allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) ## {% linkable_title Configuration %} diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 76773a005f1..5c32f23119e 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -29,14 +29,14 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Prerequisites %} -This component requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated. +This integration requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated.

If you are using a Raspberry Pi, you must use PhantomJS.

-Hass.io containers are based on Alpine Linux. PhantomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io. +Hass.io containers are based on Alpine Linux. PhantomJS is not available for Alpine Linux. Therefore it is currently not possible to use this integration on Hass.io.

### {% linkable_title PhantomJS %} @@ -100,7 +100,7 @@ The USPS sensor logs into the MyUSPS website to scrape package data. It does not ## {% linkable_title Camera %} -The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](#sensor). +The `usps` camera integration allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](#sensor). ### {% linkable_title Configuration %} @@ -113,10 +113,10 @@ camera: scan_interval: 5 ``` -To enable this camera in your installation, set up the USPS component first. +To enable this camera in your installation, set up the USPS integration first. ## {% linkable_title Sensor %} -The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](#camera). +The `usps` sensor integration allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](#camera). -To enable this sensor in your installation, set up the USPS component first. +To enable this sensor in your installation, set up the USPS integration first. diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown index 509c03984dc..6f305cc76c7 100644 --- a/source/_components/utility_meter.markdown +++ b/source/_components/utility_meter.markdown @@ -15,14 +15,14 @@ logo: energy_meter.png ha_qa_scale: internal --- -The `utility meter` component provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). +The `utility meter` integration provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount). Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).

-Sensors created with this component are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the component was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant. +Sensors created with this integration are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant.

## {% linkable_title Configuration %} diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index 2a5da6f3263..db3c85f6399 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -10,11 +10,11 @@ footer: true ha_release: 0.51 --- -The `vacuum` component enables the ability to control home cleaning robots within Home Assistant. +The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant. ## {% linkable_title Configuration %} -To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/). +To use this integration in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/). ```yaml # Example configuration.yaml entry diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown index c02f97422c2..7a0bc6680e7 100644 --- a/source/_components/vacuum.mqtt.markdown +++ b/source/_components/vacuum.mqtt.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.54 --- -The `mqtt` vacuum component allows you to control your MQTT-enabled vacuum. +The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum. There are 2 possible message schemas - `legacy` and `state`. New installation should use `state` schema as `legacy` is deprecated and might be removed someday in the future. `state` schema is preferred because the vacuum will then be represented as a `StateVacuumDevice` which is preferred parent vacuum entity. @@ -228,7 +228,7 @@ vacuum: ## {% linkable_title Legacy MQTT Protocol %} -The above configuration for this component expects an MQTT protocol like the following. +The above configuration for this integration expects an MQTT protocol like the following. ### {% linkable_title Legacy Basic Commands %} @@ -399,7 +399,7 @@ vacuum: ## {% linkable_title State MQTT Protocol %} -The above configuration for this component expects an MQTT protocol like the following. +The above configuration for this integration expects an MQTT protocol like the following. ### {% linkable_title State Basic Commands %} @@ -475,7 +475,7 @@ State has to be one of vacuum states supported by Home Assistant: ## {% linkable_title Shared MQTT Protocol %} -The configuration for this component expects an MQTT protocol like the following. +The configuration for this integration expects an MQTT protocol like the following. These services are identical for both - legacy and state vacuum. ### {% linkable_title Set Fan Speed %} @@ -527,7 +527,7 @@ MQTT topic: `vacuum/send_command` ### {% linkable_title Usage with cloudless Xiaomi vacuums %} -This component is supported by the cloud-free Xiaomi Vacuum Webinterface [Valetudo](https://github.com/Hypfer/Valetudo). +This integration is supported by the cloud-free Xiaomi Vacuum Webinterface [Valetudo](https://github.com/Hypfer/Valetudo). ### {% linkable_title Retrofitting a non-wifi vacuums %} diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 750b8d12e1b..6f4d7787de5 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -60,7 +60,7 @@ name: ## {% linkable_title Platform Services %} -In addition to all of the services provided by the `vacuum` component (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: +In addition to all of the services provided by the `vacuum` integration (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: - `xiaomi_remote_control_start` - `xiaomi_remote_control_stop` diff --git a/source/_components/velbus.markdown b/source/_components/velbus.markdown index 8c01061b410..1914c093aa9 100644 --- a/source/_components/velbus.markdown +++ b/source/_components/velbus.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.velbus/ --- -The `velbus` component supports the Velbus USB, Velbus serial and a TCP/IP gateway. +The `velbus` integration supports the Velbus USB, Velbus serial and a TCP/IP gateway. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/velux.markdown b/source/_components/velux.markdown index a78a3490e48..3f31bc73c34 100644 --- a/source/_components/velux.markdown +++ b/source/_components/velux.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Velux" -description: "Instructions on how to integrate Velux KLF 200 component with Home Assistant." +description: "Instructions on how to integrate Velux KLF 200 integration with Home Assistant." date: 2017-07-09 12:00 sidebar: true comments: false diff --git a/source/_components/vizio.markdown b/source/_components/vizio.markdown index abe9e5996b7..d250a4ec784 100644 --- a/source/_components/vizio.markdown +++ b/source/_components/vizio.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.vizio/ --- -The `vizio` component will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs and Sound Bars (2016+ models). +The `vizio` integration will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs and Sound Bars (2016+ models). ## {% linkable_title Find your device %} diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index eeed03ca4c1..54562cd4051 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/device_tracker.volvooncall/ --- -The `volvooncall` component offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. +The `volvooncall` integration offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. ## {% linkable_title Configuration %} diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown index 0d445701761..6ec90e70ad0 100644 --- a/source/_components/vultr.markdown +++ b/source/_components/vultr.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.vultr/ --- -The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. +The `vultr` integration allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/w800rf32.markdown b/source/_components/w800rf32.markdown index 0012c015039..4f6da6b54f7 100644 --- a/source/_components/w800rf32.markdown +++ b/source/_components/w800rf32.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/binary_sensor.w800rf32/ --- -The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which +The `w800rf32` integration supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz. The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index b120e58f05b..61258d5efcb 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wake on LAN" -description: "Instructions on how to setup the Wake on LAN component in Home Assistant." +description: "Instructions on how to setup the Wake on LAN integration in Home Assistant." date: 2017-07-8 15:00 sidebar: true comments: false @@ -17,7 +17,7 @@ redirect_from: - /components/switch.wake_on_lan/ --- -The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. +The `wake_on_lan` integration enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. There is currently support for the following device types within Home Assistant: @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown index 13fb3b24e47..bceda20af50 100644 --- a/source/_components/water_heater.markdown +++ b/source/_components/water_heater.markdown @@ -10,7 +10,7 @@ footer: true ha_release: 0.81 --- -The `water_heater` component is built for the controlling and monitoring of hot water heaters. +The `water_heater` integration is built for the controlling and monitoring of hot water heaters. To enable this component, pick one of the platforms, and add it to your `configuration.yaml`: diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 322349760e7..b2a50f19822 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.waterfurnace/ --- -The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. +The `waterfurnace` integration communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. The sensors provided include: diff --git a/source/_components/watson_iot.markdown b/source/_components/watson_iot.markdown index dffff86af55..f2fd55a0732 100644 --- a/source/_components/watson_iot.markdown +++ b/source/_components/watson_iot.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.72 --- -The `watson_iot` component enables you to link the devices in Home Assistant +The `watson_iot` integration enables you to link the devices in Home Assistant with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud). ## {% linkable_title Configuration %} @@ -58,7 +58,7 @@ token: required: true type: string exclude: - description: Configure which components should be excluded from recording to Watson IoT Platform. + description: Configure which integrations should be excluded from recording to Watson IoT Platform. required: false type: map keys: @@ -71,7 +71,7 @@ exclude: required: false type: list include: - description: Configure which components should be included in recordings to Watson IoT Platform. If set, all other entities will not be recorded to Watson IoT Platform. Values set by the **blacklist** option will prevail. + description: Configure which integrations should be included in recordings to Watson IoT Platform. If set, all other entities will not be recorded to Watson IoT Platform. Values set by the **blacklist** option will prevail. required: false type: map keys: diff --git a/source/_components/waze_travel_time.markdown b/source/_components/waze_travel_time.markdown index a46e4147029..cea0d46a352 100644 --- a/source/_components/waze_travel_time.markdown +++ b/source/_components/waze_travel_time.markdown @@ -75,7 +75,7 @@ vehicle_type: ## {% linkable_title Example using dynamic destination %} -Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze component that will calculate travel time to multiple optional locations on demand. +Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand. In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval set to fetch Waze data). diff --git a/source/_components/webhooks.markdown b/source/_components/webhooks.markdown index b9e015982fe..5ac9a9dbe41 100644 --- a/source/_components/webhooks.markdown +++ b/source/_components/webhooks.markdown @@ -62,7 +62,7 @@ proxy_params: required: false type: string url: - description: Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://:`). + description: Allow to overwrite the `base_url` from the [`http`](/components/http/) integration for different configurations (`https://:`). required: false type: string trusted_networks: diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown index b957a3ee5d4..0615c7c001b 100644 --- a/source/_components/weblink.markdown +++ b/source/_components/weblink.markdown @@ -14,11 +14,11 @@ ha_release: 0.13 ha_qa_scale: internal --- -The `weblink` component allows you to display links in the Home Assistant frontend. +The `weblink` integration allows you to display links in the Home Assistant frontend. ## {% linkable_title Configuration %} -To use this component in your installation, add something like the following to your `configuration.yaml` file: +To use this integration in your installation, add something like the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown index 41befadad65..dbbb74c9ce2 100644 --- a/source/_components/websocket_api.markdown +++ b/source/_components/websocket_api.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.34 --- -The `websocket_api` component set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). +The `websocket_api` integration set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/).

It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet. diff --git a/source/_components/wemo.markdown b/source/_components/wemo.markdown index 0f8ca973c45..8a072ad7ec9 100644 --- a/source/_components/wemo.markdown +++ b/source/_components/wemo.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.wemo/ --- -The `wemo` component is the main component to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant. +The `wemo` integration is the main integration to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant. There is currently support for the following device types within Home Assistant: @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: type: list {% endconfiguration %} -Supported devices will be automatically discovered if the optional `discovery` configuration item is omitted or set to true or if the `discovery` component is enabled. If the `discovery` configuration item is set to false, then automatic discovery of WeMo devices is disabled both for the `wemo` component and for the `discovery` component. Loading the `wemo` component with the `discovery` configuration item omitted or set to true will scan the local network for WeMo devices, even if you are not using the `discovery` component. +Supported devices will be automatically discovered if the optional `discovery` configuration item is omitted or set to true or if the `discovery` integration is enabled. If the `discovery` configuration item is set to false, then automatic discovery of WeMo devices is disabled both for the `wemo` integration and for the `discovery` component. Loading the `wemo` integration with the `discovery` configuration item omitted or set to true will scan the local network for WeMo devices, even if you are not using the `discovery` component. ```yaml # Example configuration.yaml entry with automatic discovery enabled (by omitting the discovery configuration item) @@ -88,7 +88,7 @@ wemo: The `wemo` platform allows you to control your Belkin WeMo humidifiers from within Home Assistant. This includes support for the [Holmes Smart Humidifier](https://www.holmesproducts.com/wemo-humidifier.html). -WeMo devices are automatically discovered if the `discovery` component is enabled. +WeMo devices are automatically discovered if the `discovery` integration is enabled. ### {% linkable_title Attributes %} diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index 3ee8fd06985..2af60e06163 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -139,7 +139,7 @@ Error sending local control request. Sending request online ## {% linkable_title Service `refresh_state_from_wink` %} -The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync. +The Wink integration only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync. You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `true` states will be pulled from the devices controlling hub, not the online API. diff --git a/source/_components/wunderlist.markdown b/source/_components/wunderlist.markdown index fd754d35d3b..befac48e03d 100644 --- a/source/_components/wunderlist.markdown +++ b/source/_components/wunderlist.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.84 --- -The `wunderlist` component allows you to create tasks in [Wunderlist](https://www.wunderlist.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., Congratulate Dani. +The `wunderlist` integration allows you to create tasks in [Wunderlist](https://www.wunderlist.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., Congratulate Dani. ## {% linkable_title Setup %} @@ -46,7 +46,7 @@ access_token: ## {% linkable_title Creating tasks with service `create_task`%} -This component offers a new service domain `wunderlist` with the service `create_task`. +This integration offers a new service domain `wunderlist` with the service `create_task`. You can call this service with the argument `list_name` the argument `name` and the optional parameter `starred` to create a new task. | Service data attribute | Optional | Description | Example | diff --git a/source/_components/xbox_live.markdown b/source/_components/xbox_live.markdown index 234a18c22e0..a4fa60c4a7e 100644 --- a/source/_components/xbox_live.markdown +++ b/source/_components/xbox_live.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.xbox_live/ --- -The Xbox Live component is able to track [Xbox](http://xbox.com/) profiles. +The Xbox Live integration is able to track [Xbox](http://xbox.com/) profiles. To use this sensor you need a free API key from [XboxAPI.com](http://xboxapi.com). diff --git a/source/_components/xfinity.markdown b/source/_components/xfinity.markdown index f29fbffc0ab..e5a68d950d4 100644 --- a/source/_components/xfinity.markdown +++ b/source/_components/xfinity.markdown @@ -39,4 +39,4 @@ host: default: 10.0.0.1 {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 0e31f5a0a88..d9eb7ce56bb 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -15,7 +15,7 @@ ha_iot_class: Local Push redirect_from: /components/xiaomi/ --- -The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant. +The `xiaomi_aqara` integration allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant. Please note, there are two versions of the hub: v1 and v2. v1 can be used with Home Assistant without any problems, however, v2 might be less straight forward when it comes to enabling the local API, and might even require you to open up your device in order to do so. Xiaomi has suggested this is in the pipeline. diff --git a/source/_components/xs1.markdown b/source/_components/xs1.markdown index e77a3695096..eb02e826008 100644 --- a/source/_components/xs1.markdown +++ b/source/_components/xs1.markdown @@ -33,7 +33,7 @@ xs1: host: "192.168.2.100" ``` -The component will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects. +The integration will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects. {% configuration %} host: @@ -63,7 +63,7 @@ password: ## {% linkable_title Supported Device Types %}

-This component currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored. +This integration currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.

### {% linkable_title Sensors %} diff --git a/source/_components/yamaha.markdown b/source/_components/yamaha.markdown index c361bfa79af..64bb53466f5 100644 --- a/source/_components/yamaha.markdown +++ b/source/_components/yamaha.markdown @@ -63,7 +63,7 @@ zone_names: ### {% linkable_title Discovery notes %} -- If the `discovery` component is enabled, all units on the network +- If the `discovery` integration is enabled, all units on the network will be discovered using UPNP. - For receivers that support more than one zone, Home Assistant will add one media player per zone supported by the player, named "$name diff --git a/source/_components/yamaha_musiccast.markdown b/source/_components/yamaha_musiccast.markdown index ea4796b76c7..e4b21af9029 100644 --- a/source/_components/yamaha_musiccast.markdown +++ b/source/_components/yamaha_musiccast.markdown @@ -47,7 +47,7 @@ interval_seconds: ### {% linkable_title Supported operations %} -Currently, this component supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it. +Currently, this integration supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it. ### {% linkable_title Example configuration %} diff --git a/source/_components/yeelight.markdown b/source/_components/yeelight.markdown index 8fab6bffae1..37b266cb3b8 100644 --- a/source/_components/yeelight.markdown +++ b/source/_components/yeelight.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/light.yeelight/ --- -The `yeelight` component allows you to control your Yeelight Wifi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic. +The `yeelight` integration allows you to control your Yeelight Wifi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic. There is currently support for the following device types within Home Assistant: @@ -110,7 +110,7 @@ custom_effects: {% endconfiguration %} #### {% linkable_title Music mode %} -Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the component and it tries to keep the connection open, which may not be wanted in all use-cases. +Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the integration and it tries to keep the connection open, which may not be wanted in all use-cases. **Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from HASS the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.** ### {% linkable_title Initial setup %} @@ -124,7 +124,7 @@ Information on how to enable "LAN Mode" can be found [here](https://getyeti.co/p ### {% linkable_title Supported models %}

-This component is tested to work with the following models. If you have a different model and it is working please let us know. +This integration is tested to work with the following models. If you have a different model and it is working please let us know.

| Model ID | Model number | Product name | diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index e68b2841c6b..1b744cbca3b 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.zabbix/ --- -The `zabbix` component is the main component to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. +The `zabbix` integration is the main integration to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. There is currently support for the following device types within Home Assistant: @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To set the Zabbix component up, add the following information to your `configuration.yaml` file: +To set the Zabbix integration up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/zestimate.markdown b/source/_components/zestimate.markdown index 22e26652ccb..2bbea20b524 100644 --- a/source/_components/zestimate.markdown +++ b/source/_components/zestimate.markdown @@ -18,7 +18,7 @@ redirect_from: The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. -This component adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate. +This integration adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate. ## {% linkable_title Configuration %} diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 69f4fbbf2e5..907fc0b202d 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -41,7 +41,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title ZHA exception and deviation handling %} -Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. +Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA integration in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Shepherd Converters as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms. diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index 5d15a94c9ed..83107f9c911 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/switch.zigbee/ --- -[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network. +[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The integration requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/ziggo_mediabox_xl.markdown b/source/_components/ziggo_mediabox_xl.markdown index cef854b4770..8baf7a82dac 100644 --- a/source/_components/ziggo_mediabox_xl.markdown +++ b/source/_components/ziggo_mediabox_xl.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.ziggo_mediabox_xl/ --- -The `ziggo_mediabox_xl` component allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant. +The `ziggo_mediabox_xl` integration allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant. To add a Ziggo Mediabox XL to your installation, add the following to your `configuration.yaml` file: @@ -43,4 +43,4 @@ The channel information (numbers and names) are downloaded from ziggo.nl on star #### {% linkable_title Preparation of the Mediabox %} -Makes sure to enable the Home Network ("mijn thuisnetwerk") service in the settings menu of the media box. Once you have set up the Media Library ("mediabiblotheek"), we can determine whether the device is turned on or off. Without this, the component will fail to start. +Makes sure to enable the Home Network ("mijn thuisnetwerk") service in the settings menu of the media box. Once you have set up the Media Library ("mediabiblotheek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start. diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown index 269492938dd..09962cefb7e 100644 --- a/source/_components/zone.markdown +++ b/source/_components/zone.markdown @@ -16,7 +16,7 @@ ha_release: 0.69 Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a [trigger](/getting-started/automation-trigger/#zone-trigger) or [condition](/getting-started/automation-condition/#zone-condition) inside automation setups. -The `zone` component uses YAML sequences to configure multiple zones: +The `zone` integration uses YAML sequences to configure multiple zones: ```yaml # Example configuration.yaml entry @@ -72,7 +72,7 @@ To find the latitude/longitude of a certain place you can use [Google Maps](http ## {% linkable_title Home zone %} -If no configuration is given, the `zone` component will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**. +If no configuration is given, the `zone` integration will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.

Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI. diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown index a8a67d635a6..b5a8fd7172a 100644 --- a/source/_components/zoneminder.markdown +++ b/source/_components/zoneminder.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.zoneminder/ --- -The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance. +The ZoneMinder integration sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance. There is currently support for the following device types within Home Assistant: @@ -169,7 +169,7 @@ monitored_conditions: The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.

-You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System". +You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the integration configuration must have "Edit" permission for "System".

To enable this switch, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index b763a36811c..e79e1475336 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -64,7 +64,7 @@ Thermostats with support for fan modes or different operating modes, will be han If the thermostat supports different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.

-To enable the climate component for your Z-Wave network, add the following to your `configuration.yaml` file. +To enable the climate integration for your Z-Wave network, add the following to your `configuration.yaml` file. ```yaml climate: diff --git a/source/_cookbook/python_component_automation.markdown b/source/_cookbook/python_component_automation.markdown index e511c8b118d..9e9617cdceb 100644 --- a/source/_cookbook/python_component_automation.markdown +++ b/source/_cookbook/python_component_automation.markdown @@ -58,7 +58,7 @@ from homeassistant.helpers.event import (async_track_state_change, DOMAIN = "example" # List of integration names (string) your integration depends upon. -# We depend on group because group will be loaded after all the components that +# We depend on group because group will be loaded after all the integrations that # initialize devices have been setup. DEPENDENCIES = ['group', 'device_tracker', 'light']