mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-12-10 00:30:02 -06:00
Standardize integration docs: F integrations (#42485)
This commit is contained in:
parent
963dc4163d
commit
9d90b40daf
@ -8,7 +8,7 @@ ha_iot_class: Local Polling
|
|||||||
ha_domain: ffmpeg
|
ha_domain: ffmpeg
|
||||||
---
|
---
|
||||||
|
|
||||||
The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](https://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem.
|
The **FFmpeg Camera** {% term integration %} allows you to use any video feed as a camera in Home Assistant via [FFmpeg](https://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `facebook` notification {% term integration %} enables sending notifications via Facebook Messenger, powered by [Facebook](https://facebook.com).
|
The **Facebook Messenger** {% term integration %} enables sending notifications via Facebook Messenger, powered by [Facebook](https://facebook.com).
|
||||||
|
|
||||||
To use this notification {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
To use this notification {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
||||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The Fail2Ban {% term integration %} allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend.
|
The **Fail2Ban** {% term integration %} allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend.
|
||||||
|
|
||||||
{% important %}
|
{% important %}
|
||||||
This integration is only available on {% term "Home Assistant Container" %} . Unfortunately, it cannot be used with {% term "Home Assistant Operating System" %}.
|
This integration is only available on {% term "Home Assistant Container" %} . Unfortunately, it cannot be used with {% term "Home Assistant Operating System" %}.
|
||||||
|
|||||||
@ -17,7 +17,7 @@ ha_platforms:
|
|||||||
ha_integration_type: service
|
ha_integration_type: service
|
||||||
---
|
---
|
||||||
|
|
||||||
The `fastdotcom` {% term integration %} uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.
|
The **Fast.com** {% term integration %} uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
Currently, the Fast.com integration only supports measuring download bandwidth.
|
Currently, the Fast.com integration only supports measuring download bandwidth.
|
||||||
|
|||||||
@ -10,7 +10,7 @@ ha_platforms:
|
|||||||
ha_integration_type: system
|
ha_integration_type: system
|
||||||
---
|
---
|
||||||
|
|
||||||
The FFmpeg integration allows other Home Assistant integrations to process
|
The **FFmpeg** {% term integration %} allows other Home Assistant integrations to process
|
||||||
video and audio streams.
|
video and audio streams.
|
||||||
|
|
||||||
This integration supports all FFmpeg versions since 3.0.0. If you run
|
This integration supports all FFmpeg versions since 3.0.0. If you run
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `ffmpeg` {% term integration %} allows you to use any video feed with [FFmpeg](https://www.ffmpeg.org/) for motion sensors in Home Assistant.
|
The **FFmpeg Motion** {% term integration %} allows you to use any video feed with [FFmpeg](https://www.ffmpeg.org/) for motion sensors in Home Assistant.
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `ffmpeg` {% term integration %} allows you to use any video or audio feed with [FFmpeg](https://www.ffmpeg.org/) for various sensors in Home Assistant.
|
The **FFmpeg Noise** {% term integration %} allows you to use any video or audio feed with [FFmpeg](https://www.ffmpeg.org/) for various sensors in Home Assistant.
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
|
|||||||
@ -32,7 +32,7 @@ ha_config_flow: true
|
|||||||
ha_integration_type: hub
|
ha_integration_type: hub
|
||||||
---
|
---
|
||||||
|
|
||||||
The Fibaro {% term integration %} allows you to connect Home Assistant to Fibaro Home Center, Nice Yubii Home, or a Zooz Z-Box Hub, enabling control and monitoring of connected devices and scene execution. Home Assistant uses a local connection to the hub.
|
The **Fibaro** {% term integration %} allows you to connect Home Assistant to Fibaro Home Center, Nice Yubii Home, or a Zooz Z-Box Hub, enabling control and monitoring of connected devices and scene execution. Home Assistant uses a local connection to the hub.
|
||||||
|
|
||||||
## Supported hub models
|
## Supported hub models
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
With the FinTS {% term integration %}, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline.
|
With the **FinTS** {% term integration %}, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
|||||||
@ -17,7 +17,7 @@ ha_integration_type: integration
|
|||||||
ha_quality_scale: bronze
|
ha_quality_scale: bronze
|
||||||
---
|
---
|
||||||
|
|
||||||
The Firefly III {% term integration %} is used as an interface to the [Firefly III API](https://api-docs.firefly-iii.org/).
|
The **Firefly III** {% term integration %} is used as an interface to the [Firefly III API](https://api-docs.firefly-iii.org/).
|
||||||
Firefly III is a free open-source personal finance manager. It contains a full transaction management system, budgets, categories and reports. You can easily import transactions via the diverse options Firefly III offers. It even contains a rule engine to automate and help organize your bookkeeping.
|
Firefly III is a free open-source personal finance manager. It contains a full transaction management system, budgets, categories and reports. You can easily import transactions via the diverse options Firefly III offers. It even contains a rule engine to automate and help organize your bookkeeping.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|||||||
@ -14,7 +14,7 @@ ha_codeowners:
|
|||||||
ha_config_flow: true
|
ha_config_flow: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Fitbit sensor allows you to expose data from [Fitbit](https://fitbit.com/) to Home Assistant.
|
The **Fitbit** {% term integration %} allows you to expose data from [Fitbit](https://fitbit.com/) to Home Assistant.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `fixer` {% term integration %} will show you the current exchange rate from [Fixer.io](https://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu).
|
The **Fixer** {% term integration %} will show you the current exchange rate from [Fixer.io](https://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu).
|
||||||
|
|
||||||
To get an overview about the available [currencies](https://fixer.io/symbols).
|
To get an overview about the available [currencies](https://fixer.io/symbols).
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `fleetgo` device tracker {% term integration %} allows you to integrate your vehicles equipped with [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
|
The **FleetGO** {% term integration %} allows you to integrate your vehicles equipped with [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `flic` {% term integration %} allows you to receive click events from [flic](https://flic.io) smart buttons.
|
The **Flic** {% term integration %} allows you to receive click events from [flic](https://flic.io) smart buttons.
|
||||||
|
|
||||||
The {% term integration %} does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
|
The {% term integration %} does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
|
||||||
|
|
||||||
|
|||||||
@ -19,7 +19,7 @@ ha_platforms:
|
|||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
The Flo {% term integration %} integrates
|
The **Flo** {% term integration %} integrates
|
||||||
[Flo by Moen smart water shutoff valves](https://www.moen.com/flo) into Home Assistant.
|
[Flo by Moen smart water shutoff valves](https://www.moen.com/flo) into Home Assistant.
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `flock` {% term integration %} uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant.
|
The **Flock** {% term integration %} uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
|||||||
@ -22,7 +22,7 @@ related:
|
|||||||
title: Configuration file
|
title: Configuration file
|
||||||
---
|
---
|
||||||
|
|
||||||
The Flume {% term integration %} will show you the current [Flume](https://flumewater.com/) status for the given Device ID.
|
The **Flume** {% term integration %} will show you the current [Flume](https://flumewater.com/) status for the given Device ID.
|
||||||
|
|
||||||
Flume monitors the real-time status of your home water meter. Allowing the end-user to detect small leaks, gain real-time information on household water consumption, set water goals and budgets, and receive push notifications when suspicious water activities occur.
|
Flume monitors the real-time status of your home water meter. Allowing the end-user to detect small leaks, gain real-time information on household water consumption, set water goals and budgets, and receive push notifications when suspicious water activities occur.
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
title: Configuration file
|
title: Configuration file
|
||||||
---
|
---
|
||||||
|
|
||||||
The `flux` switch {% term integration %} 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 `flux` switch restores its last state after startup.
|
The **Flux** {% term integration %} 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 `flux` switch restores its last state after startup.
|
||||||
|
|
||||||
The {% term 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.
|
The {% term 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.
|
||||||
|
|
||||||
|
|||||||
@ -12,7 +12,7 @@ ha_integration_type: integration
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `foobot` sensor platform will fetch air quality data from your or yours [Foobot device(s)](https://foobot.io/features/).
|
The **Foobot** {% term integration %} will fetch air quality data from your or yours [Foobot device(s)](https://foobot.io/features/).
|
||||||
|
|
||||||
This sensor requires an API token. Please obtain one at [Foobot API site](https://api.foobot.io/apidoc/index.html).
|
This sensor requires an API token. Please obtain one at [Foobot API site](https://api.foobot.io/apidoc/index.html).
|
||||||
|
|
||||||
|
|||||||
@ -16,7 +16,7 @@ ha_platforms:
|
|||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
The `foscam` platform allows you to watch the live stream of your [Foscam](https://www.foscam.com) IP camera in Home Assistant.
|
The **Foscam** {% term integration %} allows you to watch the live stream of your [Foscam](https://www.foscam.com) IP camera in Home Assistant.
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
|
|||||||
@ -13,7 +13,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `foursquare` {% term integration %} accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and an action to check users in on Swarm.
|
The **Foursquare** {% term integration %} accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and an action to check users in on Swarm.
|
||||||
|
|
||||||
To enable Foursquare, add the following to your {% term "`configuration.yaml`" %} file.
|
To enable Foursquare, add the following to your {% term "`configuration.yaml`" %} file.
|
||||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||||
|
|||||||
@ -15,7 +15,7 @@ related:
|
|||||||
ha_quality_scale: legacy
|
ha_quality_scale: legacy
|
||||||
---
|
---
|
||||||
|
|
||||||
The `free_mobile` {% term integration %} uses the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone.
|
The **Free Mobile** {% term integration %} uses the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
|||||||
@ -27,7 +27,7 @@ ha_zeroconf: true
|
|||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
The `freebox` {% term integration %} allows you to observe and control [Freebox router](https://www.free.fr/freebox/).
|
The **Freebox** {% term integration %} allows you to observe and control [Freebox router](https://www.free.fr/freebox/).
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
|
|||||||
@ -31,7 +31,7 @@ related:
|
|||||||
title: Enabling or disabling entities
|
title: Enabling or disabling entities
|
||||||
---
|
---
|
||||||
|
|
||||||
The FRITZ!Box Tools integration allows you to control your [FRITZ!Box](https://en.fritz.com/products/fritzbox/) router (by FRITZ!, formerly AVM) and have presence detection for connected network devices.
|
The **FRITZ!Box Tools** {% term integration %} allows you to control your [FRITZ!Box](https://en.fritz.com/products/fritzbox/) router (by FRITZ!, formerly AVM) and have presence detection for connected network devices.
|
||||||
|
|
||||||
There is support for the following platform types within Home Assistant:
|
There is support for the following platform types within Home Assistant:
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ ha_codeowners:
|
|||||||
ha_integration_type: hub
|
ha_integration_type: hub
|
||||||
---
|
---
|
||||||
|
|
||||||
The FRITZ!SmartHome {% term integration %} for Home Assistant allows you to integrate [FRITZ! Smart Home](https://fritz.com/en/collections/smart-home/) (_former AVM FRITZ!DECT_) devices like plugs, thermostats or shutter drivers as also trigger so called smart home templates (_contains settings for Smart Home devices of the same type_).
|
The **FRITZ!SmartHome** {% term integration %} for Home Assistant allows you to integrate [FRITZ! Smart Home](https://fritz.com/en/collections/smart-home/) (_former AVM FRITZ!DECT_) devices like plugs, thermostats or shutter drivers as also trigger so called smart home templates (_contains settings for Smart Home devices of the same type_).
|
||||||
|
|
||||||
#### Tested devices
|
#### Tested devices
|
||||||
|
|
||||||
|
|||||||
@ -14,7 +14,7 @@ ha_codeowners:
|
|||||||
- '@cdce8p'
|
- '@cdce8p'
|
||||||
---
|
---
|
||||||
|
|
||||||
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [FRITZ!Box](https://en.fritz.com/products/fritzbox/) routers (by FRITZ!, formerly AVM) on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
|
The **FRITZ!Box Call Monitor** {% term integration %} monitors the call monitor exposed by [FRITZ!Box](https://en.fritz.com/products/fritzbox/) routers (by FRITZ!, formerly AVM) on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
|
||||||
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|||||||
@ -18,7 +18,7 @@ ha_integration_type: integration
|
|||||||
ha_quality_scale: platinum
|
ha_quality_scale: platinum
|
||||||
---
|
---
|
||||||
|
|
||||||
The Fronius integration polls a [Fronius](https://www.fronius.com/) solar inverter or datalogger for details of a Fronius SolarNet setup and integrate it in your Home Assistant installation.
|
The **Fronius** {% term integration %} polls a [Fronius](https://www.fronius.com/) solar inverter or datalogger for details of a Fronius SolarNet setup and integrate it in your Home Assistant installation.
|
||||||
|
|
||||||
## Supported devices
|
## Supported devices
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ ha_platforms:
|
|||||||
ha_iot_class: Cloud Polling
|
ha_iot_class: Cloud Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
The {{ page.title }} {% term integration %} provides support for Fujitsu heat pumps and air conditioners that use the FGLair app.
|
The **FGLair** {% term integration %} provides support for Fujitsu heat pumps and air conditioners that use the FGLair app.
|
||||||
To find out which app to use for your heat pump, check [the Fujitsu FGLair FAQ](https://www.fujitsu-general.com/global/support/faq/airstage-mobile/0127.html).
|
To find out which app to use for your heat pump, check [the Fujitsu FGLair FAQ](https://www.fujitsu-general.com/global/support/faq/airstage-mobile/0127.html).
|
||||||
|
|
||||||
## Supported devices
|
## Supported devices
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user