mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Rename md files to markdown files (#39282)
This commit is contained in:
Simon Lamon
GitHub
parent
600c5114ff
commit
a6e059d9bb
@ -1,27 +1,27 @@
|
||||
---
|
||||
title: UK Environment Agency Flood Monitoring
|
||||
description: Monitor nearby water levels and be prepared for flooding with the UK Environment Agency API integration.
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_release: 0.115
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@Jc2k'
|
||||
---
|
||||
|
||||
The `eafm` integration offers integration with the [UK Environment Agency Flood Monitoring](https://environment.data.gov.uk/flood-monitoring/doc/reference) API to provide sensors for nearby water levels. Combined with Home Assistant notifications, you could give yourself a warning if a nearby river was likely to flood your local cycle path or the only road out of your village.
|
||||
|
||||
{% important %}
|
||||
|
||||
The UK Environment Agency Flood Monitoring only provides data for England - Northern Ireland, Scotland and Wales have their own flood agencies.
|
||||
|
||||
{% endimportant %}
|
||||
|
||||
## Configuration
|
||||
|
||||
Home Assistant offers the flood monitoring integration through **Settings** -> **Devices & services** -> **Environment Agency Flood Gauges**.
|
||||
|
||||
You will be prompted to select a monitoring station. You can find the name of nearby monitoring stations on the Flood information service [website](https://check-for-flooding.service.gov.uk/river-and-sea-levels).
|
||||
|
||||
Sensors for that monitoring station should then appear in your Home Assistant instance.
|
||||
---
|
||||
title: UK Environment Agency Flood Monitoring
|
||||
description: Monitor nearby water levels and be prepared for flooding with the UK Environment Agency API integration.
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_release: 0.115
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@Jc2k'
|
||||
---
|
||||
|
||||
The `eafm` integration offers integration with the [UK Environment Agency Flood Monitoring](https://environment.data.gov.uk/flood-monitoring/doc/reference) API to provide sensors for nearby water levels. Combined with Home Assistant notifications, you could give yourself a warning if a nearby river was likely to flood your local cycle path or the only road out of your village.
|
||||
|
||||
{% important %}
|
||||
|
||||
The UK Environment Agency Flood Monitoring only provides data for England - Northern Ireland, Scotland and Wales have their own flood agencies.
|
||||
|
||||
{% endimportant %}
|
||||
|
||||
## Configuration
|
||||
|
||||
Home Assistant offers the flood monitoring integration through **Settings** -> **Devices & services** -> **Environment Agency Flood Gauges**.
|
||||
|
||||
You will be prompted to select a monitoring station. You can find the name of nearby monitoring stations on the Flood information service [website](https://check-for-flooding.service.gov.uk/river-and-sea-levels).
|
||||
|
||||
Sensors for that monitoring station should then appear in your Home Assistant instance.
|
||||
@ -1,18 +1,18 @@
|
||||
---
|
||||
title: Internet Printing Protocol (IPP)
|
||||
description: Instructions on how to integrate printers that support the Internet Printing Protocol (IPP) into Home Assistant.
|
||||
ha_category:
|
||||
- System monitor
|
||||
ha_release: 0.108
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@ctalkington'
|
||||
ha_domain: ipp
|
||||
---
|
||||
|
||||
The `Internet Printing Protocol (IPP)` integration allows you to read current data from your networked printer that supports the [Internet Printing Protocol](https://www.pwg.org/ipp/everywhere.html).
|
||||
|
||||
It provides information about the printer's state and remaining ink levels.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
---
|
||||
title: Internet Printing Protocol (IPP)
|
||||
description: Instructions on how to integrate printers that support the Internet Printing Protocol (IPP) into Home Assistant.
|
||||
ha_category:
|
||||
- System monitor
|
||||
ha_release: 0.108
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@ctalkington'
|
||||
ha_domain: ipp
|
||||
---
|
||||
|
||||
The `Internet Printing Protocol (IPP)` integration allows you to read current data from your networked printer that supports the [Internet Printing Protocol](https://www.pwg.org/ipp/everywhere.html).
|
||||
|
||||
It provides information about the printer's state and remaining ink levels.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
@ -1,54 +1,54 @@
|
||||
---
|
||||
title: LinkPlay
|
||||
description: Connect and control your LinkPlay media players using the LinkPlay integration
|
||||
ha_category:
|
||||
- Media player
|
||||
ha_domain: linkplay
|
||||
ha_zeroconf: true
|
||||
ha_integration_type: integration
|
||||
ha_release: 2024.8
|
||||
ha_codeowners:
|
||||
- '@Velleman'
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- media_player
|
||||
- button
|
||||
ha_iot_class: Local Polling
|
||||
---
|
||||
|
||||
The LinkPlay {% term integrations %} for Home Assistant allows you to control various media players based on the LinkPlay protocol. The integration supports auto-discovery on your local network through [Zeroconf](/integrations/zeroconf).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Features
|
||||
|
||||
### Media Player
|
||||
|
||||
The media player entity offers robust controls and playback features from the media player integration and provides additionally:
|
||||
|
||||
- **Preset playback**: Play LinkPlay presets configured on the device using the action `linkplay.play_preset`.
|
||||
- **Multiroom**: Combine multiple LinkPlay devices in a multiroom. Use the actions `media_player.join` and `media_player.unjoin`.
|
||||
|
||||
### Buttons
|
||||
|
||||
The button entities provide some additional LinkPlay features available on the device:
|
||||
|
||||
- **Time Sync**: Synchronize the device's internal clock with the current time in Home Assistant.
|
||||
- **Restart Device**: Reboot the device, allowing for convenient troubleshooting and maintenance.
|
||||
|
||||
## Actions
|
||||
|
||||
The LinkPlay integration makes various custom actions available in addition to the [standard media player actions](/integrations/media_player/#actions).
|
||||
|
||||
### Action `linkplay.play_preset`
|
||||
|
||||
Play a preset on a LinkPlay media player.
|
||||
|
||||
{% note %}
|
||||
Companion apps, such as 4stream, allow to save music presets (for example, Spotify playlists). This action can be used to start playing these presets.
|
||||
{% endnote %}
|
||||
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | The speakers to target. To target all LinkPlay devices, use `all`.
|
||||
| `preset_number` | no | The number of the preset to play.
|
||||
---
|
||||
title: LinkPlay
|
||||
description: Connect and control your LinkPlay media players using the LinkPlay integration
|
||||
ha_category:
|
||||
- Media player
|
||||
ha_domain: linkplay
|
||||
ha_zeroconf: true
|
||||
ha_integration_type: integration
|
||||
ha_release: 2024.8
|
||||
ha_codeowners:
|
||||
- '@Velleman'
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- media_player
|
||||
- button
|
||||
ha_iot_class: Local Polling
|
||||
---
|
||||
|
||||
The LinkPlay {% term integrations %} for Home Assistant allows you to control various media players based on the LinkPlay protocol. The integration supports auto-discovery on your local network through [Zeroconf](/integrations/zeroconf).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Features
|
||||
|
||||
### Media Player
|
||||
|
||||
The media player entity offers robust controls and playback features from the media player integration and provides additionally:
|
||||
|
||||
- **Preset playback**: Play LinkPlay presets configured on the device using the action `linkplay.play_preset`.
|
||||
- **Multiroom**: Combine multiple LinkPlay devices in a multiroom. Use the actions `media_player.join` and `media_player.unjoin`.
|
||||
|
||||
### Buttons
|
||||
|
||||
The button entities provide some additional LinkPlay features available on the device:
|
||||
|
||||
- **Time Sync**: Synchronize the device's internal clock with the current time in Home Assistant.
|
||||
- **Restart Device**: Reboot the device, allowing for convenient troubleshooting and maintenance.
|
||||
|
||||
## Actions
|
||||
|
||||
The LinkPlay integration makes various custom actions available in addition to the [standard media player actions](/integrations/media_player/#actions).
|
||||
|
||||
### Action `linkplay.play_preset`
|
||||
|
||||
Play a preset on a LinkPlay media player.
|
||||
|
||||
{% note %}
|
||||
Companion apps, such as 4stream, allow to save music presets (for example, Spotify playlists). This action can be used to start playing these presets.
|
||||
{% endnote %}
|
||||
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | The speakers to target. To target all LinkPlay devices, use `all`.
|
||||
| `preset_number` | no | The number of the preset to play.
|
||||
@ -1,23 +1,23 @@
|
||||
---
|
||||
title: "Locative"
|
||||
description: "Instructions on how to use Locative to track devices in Home Assistant."
|
||||
ha_category:
|
||||
- Presence detection
|
||||
ha_release: 0.86
|
||||
ha_iot_class: Cloud Push
|
||||
ha_domain: locative
|
||||
---
|
||||
|
||||
This platform allows you to detect presence using [Locative](https://www.locative.app/). Locative is an open source app for [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
|
||||
|
||||
Install on your smartphone:
|
||||
|
||||
- [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4)
|
||||
|
||||
To configure Locative, you must set it up via the integrations panel in the configuration screen. You must set up the app to send a POST request to your Home Assistant instance at the webhook URL provided by the integration during setup. When you enter or exit a geofence, Locative will send the appropriate request to that URL, updating Home Assistant. You are not able to specify a device name in Locative. Instead, you will need to look in your `dev-state` menu for a new device that Locative will have created on its first `GET`. If you had been or are using Owntracks as well, you will need to update the device name used in the Owntracks setup with the name that Locative generated.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/locative.png'/>
|
||||
</p>
|
||||
|
||||
When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".
|
||||
---
|
||||
title: "Locative"
|
||||
description: "Instructions on how to use Locative to track devices in Home Assistant."
|
||||
ha_category:
|
||||
- Presence detection
|
||||
ha_release: 0.86
|
||||
ha_iot_class: Cloud Push
|
||||
ha_domain: locative
|
||||
---
|
||||
|
||||
This platform allows you to detect presence using [Locative](https://www.locative.app/). Locative is an open source app for [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
|
||||
|
||||
Install on your smartphone:
|
||||
|
||||
- [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4)
|
||||
|
||||
To configure Locative, you must set it up via the integrations panel in the configuration screen. You must set up the app to send a POST request to your Home Assistant instance at the webhook URL provided by the integration during setup. When you enter or exit a geofence, Locative will send the appropriate request to that URL, updating Home Assistant. You are not able to specify a device name in Locative. Instead, you will need to look in your `dev-state` menu for a new device that Locative will have created on its first `GET`. If you had been or are using Owntracks as well, you will need to update the device name used in the Owntracks setup with the name that Locative generated.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/locative.png'/>
|
||||
</p>
|
||||
|
||||
When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".
|
||||
@ -1,115 +1,115 @@
|
||||
---
|
||||
title: Vogel's MotionMount
|
||||
description: Instructions on how to integrate Vogel's MotionMount into Home Assistant.
|
||||
ha_category:
|
||||
- Number
|
||||
- Select
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_release: 2024.1
|
||||
ha_iot_class: Local Push
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- number
|
||||
- select
|
||||
- binary_sensor
|
||||
- sensor
|
||||
ha_codeowners:
|
||||
- '@RJPoelstra'
|
||||
ha_domain: motionmount
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
The `motionmount` {% term integration %} allows you to control the position of your [TVM 7675 Pro](https://www.vogels.com/p/tvm-7675-pro-motorized-tv-wall-mount-black) SIGNATURE MotionMount from Vogel's.
|
||||
|
||||
This integration uses the Ethernet (IP) connection of your MotionMount. It's not possible to connect using the RS-232 connection.
|
||||
|
||||
It provides information about the current position of the mount and allows setting a new position.
|
||||
|
||||
A use case would be to position the TV based on whether anyone is actively watching. The MotionMount provides an HDMI connection to monitor whether the TV is turned on and in response move it to a preset position or the last known position. However, if you also use the TV for background music, you probably don't want the MotionMount to extend. By using a presence sensor to check whether anyone is actually in front of the TV, you can ensure the MotionMount only extends when the TV is actively being watched.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
{% configuration_basic %}
|
||||
Host:
|
||||
description: Hostname or IP address of the device, for example:`192.168.1.2`.
|
||||
Port:
|
||||
description: The TCP port of the device. Defaults to 23. Only change this when you're absolutely certain that it shouldn't be 23.
|
||||
PIN:
|
||||
description: The user level pincode, if configured on the device.
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## Removing the integration
|
||||
|
||||
This integration follows standard integration removal. No extra steps are required.
|
||||
|
||||
{% include integrations/remove_device_service.md %}
|
||||
|
||||
## Data updates
|
||||
|
||||
The MotionMount pushes new data to the integration.
|
||||
The only exception is the presets. Changes to the presets are {% term polling polled %}, by default every 60 seconds.
|
||||
|
||||
## Known limitations
|
||||
|
||||
The integration does not provide the ability to configure the MotionMount.
|
||||
All settings, including configuring presets, should be done via the MotionMount app.
|
||||
|
||||
Only IP connections are supported. Connection via RS-232 or Bluetooth Low Energy is not supported.
|
||||
|
||||
## Supported devices
|
||||
|
||||
The following devices are supported:
|
||||
|
||||
- TVM 7675 Pro (SIGNATURE MotionMount with Pro extension)
|
||||
|
||||
## Unsupported devices
|
||||
|
||||
The following devices are *not* supported:
|
||||
|
||||
- TVM 7675 (SIGNATURE MotionMount without Pro extension)
|
||||
- TVM 7355 (NEXT MotionMount)
|
||||
|
||||
## Supported functionality
|
||||
|
||||
### Entities
|
||||
|
||||
#### Sensors
|
||||
|
||||
- **Moving**
|
||||
- **Description**: Indicates whether the MotionMount is moving.
|
||||
|
||||
- **Error Status**
|
||||
- **Description**: The error status of the MotionMount.
|
||||
- None: There is no error.
|
||||
- Motor: There is a problem communicating with the motor.
|
||||
- HDMI CEC: There is a problem communicating with the TV. Check the HDMI cable.
|
||||
- Obstruction: The MotionMount detected an obstacle and stopped moving.
|
||||
- TV Width Constraint: The MotionMount detected that the TV moved too close to the wall and stopped moving.
|
||||
- Internal: There is an internal error. Refer to the MotionMount app for support.
|
||||
|
||||
#### Numbers
|
||||
|
||||
- **Extension**
|
||||
- **Description**: The current extension of the MotionMount from the wall.
|
||||
|
||||
- **Turn**
|
||||
- **Description**: The current rotation of the MotionMount.
|
||||
|
||||
#### Selects
|
||||
|
||||
- **Presets**
|
||||
- **Description**: If the MotionMount is at a preset location, this shows the corresponding preset.
|
||||
Any preset can be selected to move the MotionMount to this preset position.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Can't connect to device
|
||||
|
||||
1. Make sure the device is powered on.
|
||||
2. Make sure the device is connected to the same network as Home Assistant.
|
||||
3. Make sure the IP address of the MotionMount is configured correctly.
|
||||
- In case of doubt, perform a network reset by holding the reset button for approx. 5 seconds.
|
||||
- **Result**: The LED will start to blink slowly. This indicates that the network configuration is being reset to use DHCP.
|
||||
- **Important**: Don't hold the reset button for too long (approx. 10 s). Holding the button for 10 s or longer starts a factory reset. A factory reset is indicated by the LED blinking fast.
|
||||
|
||||
---
|
||||
title: Vogel's MotionMount
|
||||
description: Instructions on how to integrate Vogel's MotionMount into Home Assistant.
|
||||
ha_category:
|
||||
- Number
|
||||
- Select
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_release: 2024.1
|
||||
ha_iot_class: Local Push
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- number
|
||||
- select
|
||||
- binary_sensor
|
||||
- sensor
|
||||
ha_codeowners:
|
||||
- '@RJPoelstra'
|
||||
ha_domain: motionmount
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
The `motionmount` {% term integration %} allows you to control the position of your [TVM 7675 Pro](https://www.vogels.com/p/tvm-7675-pro-motorized-tv-wall-mount-black) SIGNATURE MotionMount from Vogel's.
|
||||
|
||||
This integration uses the Ethernet (IP) connection of your MotionMount. It's not possible to connect using the RS-232 connection.
|
||||
|
||||
It provides information about the current position of the mount and allows setting a new position.
|
||||
|
||||
A use case would be to position the TV based on whether anyone is actively watching. The MotionMount provides an HDMI connection to monitor whether the TV is turned on and in response move it to a preset position or the last known position. However, if you also use the TV for background music, you probably don't want the MotionMount to extend. By using a presence sensor to check whether anyone is actually in front of the TV, you can ensure the MotionMount only extends when the TV is actively being watched.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
{% configuration_basic %}
|
||||
Host:
|
||||
description: Hostname or IP address of the device, for example:`192.168.1.2`.
|
||||
Port:
|
||||
description: The TCP port of the device. Defaults to 23. Only change this when you're absolutely certain that it shouldn't be 23.
|
||||
PIN:
|
||||
description: The user level pincode, if configured on the device.
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## Removing the integration
|
||||
|
||||
This integration follows standard integration removal. No extra steps are required.
|
||||
|
||||
{% include integrations/remove_device_service.md %}
|
||||
|
||||
## Data updates
|
||||
|
||||
The MotionMount pushes new data to the integration.
|
||||
The only exception is the presets. Changes to the presets are {% term polling polled %}, by default every 60 seconds.
|
||||
|
||||
## Known limitations
|
||||
|
||||
The integration does not provide the ability to configure the MotionMount.
|
||||
All settings, including configuring presets, should be done via the MotionMount app.
|
||||
|
||||
Only IP connections are supported. Connection via RS-232 or Bluetooth Low Energy is not supported.
|
||||
|
||||
## Supported devices
|
||||
|
||||
The following devices are supported:
|
||||
|
||||
- TVM 7675 Pro (SIGNATURE MotionMount with Pro extension)
|
||||
|
||||
## Unsupported devices
|
||||
|
||||
The following devices are *not* supported:
|
||||
|
||||
- TVM 7675 (SIGNATURE MotionMount without Pro extension)
|
||||
- TVM 7355 (NEXT MotionMount)
|
||||
|
||||
## Supported functionality
|
||||
|
||||
### Entities
|
||||
|
||||
#### Sensors
|
||||
|
||||
- **Moving**
|
||||
- **Description**: Indicates whether the MotionMount is moving.
|
||||
|
||||
- **Error Status**
|
||||
- **Description**: The error status of the MotionMount.
|
||||
- None: There is no error.
|
||||
- Motor: There is a problem communicating with the motor.
|
||||
- HDMI CEC: There is a problem communicating with the TV. Check the HDMI cable.
|
||||
- Obstruction: The MotionMount detected an obstacle and stopped moving.
|
||||
- TV Width Constraint: The MotionMount detected that the TV moved too close to the wall and stopped moving.
|
||||
- Internal: There is an internal error. Refer to the MotionMount app for support.
|
||||
|
||||
#### Numbers
|
||||
|
||||
- **Extension**
|
||||
- **Description**: The current extension of the MotionMount from the wall.
|
||||
|
||||
- **Turn**
|
||||
- **Description**: The current rotation of the MotionMount.
|
||||
|
||||
#### Selects
|
||||
|
||||
- **Presets**
|
||||
- **Description**: If the MotionMount is at a preset location, this shows the corresponding preset.
|
||||
Any preset can be selected to move the MotionMount to this preset position.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Can't connect to device
|
||||
|
||||
1. Make sure the device is powered on.
|
||||
2. Make sure the device is connected to the same network as Home Assistant.
|
||||
3. Make sure the IP address of the MotionMount is configured correctly.
|
||||
- In case of doubt, perform a network reset by holding the reset button for approx. 5 seconds.
|
||||
- **Result**: The LED will start to blink slowly. This indicates that the network configuration is being reset to use DHCP.
|
||||
- **Important**: Don't hold the reset button for too long (approx. 10 s). Holding the button for 10 s or longer starts a factory reset. A factory reset is indicated by the LED blinking fast.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user