mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 21:36:52 +00:00
parent
4504576383
commit
c0d8b1fbf0
@ -37,7 +37,6 @@ Send a _magic packet_ to wake up a device with 'Wake-On-LAN' capabilities.
|
||||
| `mac` | no | MAC address of the device to wake up. |
|
||||
| `broadcast_address` | yes | Optional broadcast IP where to send the magic packet. |
|
||||
|
||||
|
||||
Sample service data:
|
||||
|
||||
```json
|
||||
@ -45,4 +44,3 @@ Sample service data:
|
||||
"mac":"00:40:13:ed:f1:32"
|
||||
}
|
||||
```
|
||||
|
||||
|
@ -53,10 +53,8 @@ unit:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
#### {% linkable_title Limitations %}
|
||||
|
||||
The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle.
|
||||
|
||||
While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented.
|
||||
|
||||
|
@ -83,7 +83,6 @@ include:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
### {% linkable_title Full configuration %}
|
||||
|
@ -33,8 +33,8 @@ name:
|
||||
station:
|
||||
description: "The station ID string. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station."
|
||||
required: optional
|
||||
default: The closest station
|
||||
type: string
|
||||
default: The closest station
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
|
@ -41,12 +41,14 @@ longitude:
|
||||
required: false
|
||||
type: float
|
||||
forecast:
|
||||
description: "'True' to add a temperature forecast, 'False' to suppress it."
|
||||
description: "`true` to add a temperature forecast, `false` to suppress it."
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Full configuration %}
|
||||
|
||||
A full configuration example:
|
||||
|
||||
```yaml
|
||||
|
@ -22,23 +22,23 @@ To add the IPMA weather platform to your installation, add the following to your
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
weather:
|
||||
- platform: ipma
|
||||
- platform: ipma
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name you would like to give to the weather station.
|
||||
required: false
|
||||
default: The name of the used station
|
||||
required: false
|
||||
type: string
|
||||
default: The name of the used station
|
||||
latitude:
|
||||
description: Latitude of the location for which you want weather information.
|
||||
required: false
|
||||
default: Home Assistant global latitude configuration
|
||||
required: false
|
||||
type: string
|
||||
default: Home Assistant global latitude configuration
|
||||
longitude:
|
||||
description: Longitude of the location for which you want weather information.
|
||||
required: false
|
||||
default: Home Assistant global longitude configuration
|
||||
required: false
|
||||
type: string
|
||||
default: Home Assistant global longitude configuration
|
||||
{% endconfiguration %}
|
||||
|
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location.
|
||||
The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location.
|
||||
|
||||
Home Assistant currently supports free web services and such which require a registration. Please check the sidebar for a full list of supported `weather` platforms.
|
||||
|
||||
@ -32,4 +32,3 @@ The `weather` platform only knows the below listed conditions. The reason for th
|
||||
- 'windy'
|
||||
- 'windy-variant'
|
||||
- 'exceptional':
|
||||
|
||||
|
@ -24,7 +24,6 @@ weather:
|
||||
- platform: met
|
||||
```
|
||||
|
||||
|
||||
{% configuration %}
|
||||
latitude:
|
||||
description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration.
|
||||
|
@ -34,8 +34,8 @@ api_key:
|
||||
name:
|
||||
description: Additional name for the weather component in Home Assistant.
|
||||
required: false
|
||||
default: Met Office
|
||||
type: string
|
||||
default: Met Office
|
||||
latitude:
|
||||
description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
|
||||
required: inclusive
|
||||
@ -50,4 +50,3 @@ longitude:
|
||||
This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor.
|
||||
The weather platform is easier to configure but less customizable.
|
||||
</p>
|
||||
|
||||
|
@ -30,29 +30,29 @@ weather:
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
required: true
|
||||
description: Your API key for [OpenWeatherMap](http://openweathermap.org/).
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
required: false
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: OpenWeatherMap
|
||||
type: string
|
||||
mode:
|
||||
required: false
|
||||
description: "Can specify `hourly` or `daily`. Select `hourly` for a three-hour forecast or `daily` for daily forecast."
|
||||
default: "`hourly`"
|
||||
required: false
|
||||
type: string
|
||||
default: "`hourly`"
|
||||
latitude:
|
||||
required: false
|
||||
description: Latitude of the location to display the weather.
|
||||
default: "The latitude in your `configuration.yaml` file."
|
||||
type: float
|
||||
longitude:
|
||||
required: false
|
||||
description: Longitude of the location to display the weather.
|
||||
default: "The longitude in your `configuration.yaml` file."
|
||||
type: float
|
||||
default: "The latitude in your `configuration.yaml` file."
|
||||
longitude:
|
||||
description: Longitude of the location to display the weather.
|
||||
required: false
|
||||
type: float
|
||||
default: "The longitude in your `configuration.yaml` file."
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
|
@ -12,7 +12,6 @@ ha_category: Weather
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as a source for current meteorological data. This component will show you the condition and temperatures for max. 10 days.
|
||||
|
||||
<p class='note warning'>
|
||||
@ -39,8 +38,8 @@ woeid:
|
||||
name:
|
||||
description: The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option.
|
||||
required: false
|
||||
default: yweather
|
||||
type: string
|
||||
default: yweather
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
|
@ -29,23 +29,23 @@ weather:
|
||||
|
||||
{% configuration %}
|
||||
station_id:
|
||||
required: false
|
||||
description: The ID number for a supported ZAMG station.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
required: false
|
||||
description: A name for the weather platform.
|
||||
required: false
|
||||
type: string
|
||||
latitude:
|
||||
required: false
|
||||
description: "Latitude coordinate to monitor weather of (required if **longitude** is specified)."
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
type: float
|
||||
longitude:
|
||||
required: false
|
||||
description: "Longitude coordinate to monitor weather of (required if **latitude** is specified)."
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
type: float
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
longitude:
|
||||
description: "Longitude coordinate to monitor weather of (required if **latitude** is specified)."
|
||||
required: false
|
||||
type: float
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
|
@ -15,6 +15,8 @@ ha_qa_scale: internal
|
||||
|
||||
The `weblink` component 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:
|
||||
|
||||
```yaml
|
||||
|
@ -18,6 +18,8 @@ The `websocket_api` component set up a WebSocket API and allows one to interact
|
||||
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
websocket_api:
|
||||
|
@ -15,6 +15,8 @@ ha_release: pre 0.7
|
||||
|
||||
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.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Supported devices will be automatically discovered if the discovery component is enabled. Loading the `wemo` component will scan the local network for WeMo devices, even if you are not using the discovery component
|
||||
|
||||
```yaml
|
||||
|
@ -78,8 +78,8 @@ client_secret:
|
||||
local_control:
|
||||
description: If set to `true` state changes for lights, locks and switches will be issued to the local hub.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
Local control:
|
||||
|
@ -15,6 +15,8 @@ ha_release: 0.68
|
||||
|
||||
The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](http://wirelesstag.net) sensors tags in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -25,14 +27,14 @@ wirelesstag:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Username for your [wirelesstag.net](http://wirelesstag.net) account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Password for your [wirelesstag.net](http://wirelesstag.net) account.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: Username for your wirelesstag.net account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Password for your wirelesstag.net account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Finish your configuration by visiting the [WirelessTag binary sensor](/components/binary_sensor.wirelesstag/), [WirelessTag sensor](/components/sensor.wirelesstag/), or [WirelessTag switch](/components/switch.wirelesstag/) documentation.
|
||||
@ -44,4 +46,4 @@ Finish your configuration by visiting the [WirelessTag binary sensor](/component
|
||||
|
||||
<p class='note warning'>
|
||||
Tags Manager supports local push notifications for `http` schema only. So if your hass uses `https`, local push notifications are disabled and data is received via cloud polling.
|
||||
</p>
|
||||
</p>
|
||||
|
@ -92,38 +92,38 @@ xiaomi_aqara:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
gateways:
|
||||
description: A list of gateways to set up.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
mac:
|
||||
description: The MAC address of your gateway. *Optional if only using one gateway.*
|
||||
required: false
|
||||
type: string
|
||||
key:
|
||||
description: The key of your gateway. *Optional if only using sensors and/or binary sensors.*
|
||||
required: false
|
||||
type: string
|
||||
host:
|
||||
description: The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
||||
required: false
|
||||
type: string
|
||||
disable:
|
||||
description: Disable the gateway. This is only useful if you don't want to integrate a specific gateway.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
discovery_retry:
|
||||
description: Number of times that Home Assistant should try to reconnect to the gateway.
|
||||
required: false
|
||||
type: integer
|
||||
default: 3
|
||||
interface:
|
||||
description: Which network interface to use.
|
||||
required: false
|
||||
type: string
|
||||
default: any
|
||||
gateways:
|
||||
description: A list of gateways to set up.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
mac:
|
||||
description: The MAC address of your gateway. *Optional if only using one gateway.*
|
||||
required: false
|
||||
type: string
|
||||
key:
|
||||
description: The key of your gateway. *Optional if only using sensors and/or binary sensors.*
|
||||
required: false
|
||||
type: string
|
||||
host:
|
||||
description: The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
||||
required: false
|
||||
type: string
|
||||
disable:
|
||||
description: Disable the gateway. This is only useful if you don't want to integrate a specific gateway.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
discovery_retry:
|
||||
description: Number of times that Home Assistant should try to reconnect to the gateway.
|
||||
required: false
|
||||
type: integer
|
||||
default: 3
|
||||
interface:
|
||||
description: Which network interface to use.
|
||||
required: false
|
||||
type: string
|
||||
default: any
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Services %}
|
||||
@ -274,4 +274,3 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
|
||||
- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`.
|
||||
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
|
||||
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`).
|
||||
|
||||
|
@ -34,13 +34,13 @@ host:
|
||||
path:
|
||||
description: Path to your Zabbix install.
|
||||
required: false
|
||||
default: "`/zabbix/`"
|
||||
type: string
|
||||
default: "`/zabbix/`"
|
||||
ssl:
|
||||
description: Set to `True` if your Zabbix installation is using SSL.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
default: false
|
||||
username:
|
||||
description: Your Zabbix username.
|
||||
required: false
|
||||
|
@ -14,6 +14,8 @@ ha_release: 0.18
|
||||
|
||||
The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -21,7 +23,7 @@ To integrate this into Home Assistant, add the following section to your `config
|
||||
zeroconf:
|
||||
```
|
||||
|
||||
The registration will include meta-data about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing.
|
||||
The registration will include meta-data about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing.
|
||||
|
||||
```bash
|
||||
$ avahi-browse -alr
|
||||
@ -39,6 +41,6 @@ Browsing domain 'local' on -1.-1 ...
|
||||
Browsing for services of type '_home-assistant._tcp' in domain 'local' on 4.0 ...
|
||||
Found service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0.
|
||||
Service data for service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0:
|
||||
Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data:
|
||||
Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data:
|
||||
['requires_api_password=true', 'base_url=http://192.168.0.70:8123', 'version=0.41.0']
|
||||
```
|
||||
|
@ -31,6 +31,8 @@ Known working ZigBee radios:
|
||||
- [Elelabs ZigBee USB Adapter](https://elelabs.com/products/elelabs_usb_adapter.html)
|
||||
- [Elelabs ZigBee Raspberry Pi Shield](https://elelabs.com/products/elelabs_zigbee_shield.html)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To configure the component, a `zha` section must be present in the `configuration.yaml`,
|
||||
and the path to the serial device for the radio and path to the database which will persist your network data is required.
|
||||
|
||||
@ -45,8 +47,8 @@ zha:
|
||||
radio_type:
|
||||
description: One of `ezsp` or `xbee`.
|
||||
required: false
|
||||
default: ezsp
|
||||
type: string
|
||||
default: ezsp
|
||||
usb_path:
|
||||
description: Path to the serial device for the radio.
|
||||
required: true
|
||||
@ -54,8 +56,8 @@ usb_path:
|
||||
baudrate:
|
||||
description: Baud rate of the serial device.
|
||||
required: false
|
||||
default: 57600
|
||||
type: integer
|
||||
default: 57600
|
||||
database_path:
|
||||
description: _Full_ path to the database which will keep persistent network data.
|
||||
required: true
|
||||
|
@ -22,6 +22,8 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [Light](../light.zigbee) (digital output pins)
|
||||
- [Switch](../switch.zigbee) (digital output pins)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
The local ZigBee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed.
|
||||
|
||||
A `zigbee` section must be present in the `configuration.yaml` file and contain the following options as required:
|
||||
@ -35,13 +37,13 @@ zigbee:
|
||||
device:
|
||||
description: The serial port to which the local ZigBee device is connected.
|
||||
required: false
|
||||
default: "/dev/ttyUSB0"
|
||||
type: string
|
||||
default: "`/dev/ttyUSB0`"
|
||||
baud:
|
||||
description: The baud rate at which to communicate with the local ZigBee device.
|
||||
required: false
|
||||
default: 9600
|
||||
type: integer
|
||||
default: 9600
|
||||
{% endconfiguration %}
|
||||
|
||||
To find the possible serial port names of your device, run:
|
||||
|
@ -53,8 +53,8 @@ longitude:
|
||||
radius:
|
||||
description: The radius of the zone in meters.
|
||||
required: false
|
||||
default: 100
|
||||
type: integer
|
||||
default: 100
|
||||
icon:
|
||||
description: The icon to show instead of name.
|
||||
required: false
|
||||
@ -62,8 +62,8 @@ icon:
|
||||
passive:
|
||||
description: To only use the zone for automation and hide it from the frontend and not use the zone for device tracker name.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
To find the latitude/longitude of a certain place you can use [Google Maps](https://www.google.com/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
|
||||
|
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance so that [cameras](/components/camera.zoneminder/), [sensors](/components/sensor.zoneminder/), and [switches](/components/switch.zoneminder) can use it.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
zoneminder:
|
||||
@ -30,23 +32,23 @@ host:
|
||||
path:
|
||||
description: Path to your ZoneMinder install.
|
||||
required: false
|
||||
default: "`/zm/`"
|
||||
type: string
|
||||
default: "`/zm/`"
|
||||
path_zms:
|
||||
description: Path to the CGI script for streaming. This should match `PATH_ZMS` in ZM's "Paths" settings.
|
||||
required: false
|
||||
default: "`/zm/cgi-bin/nph-zms`"
|
||||
type: string
|
||||
default: "`/zm/cgi-bin/nph-zms`"
|
||||
ssl:
|
||||
description: Set to `true` if your ZoneMinder installation is using SSL.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
default: false
|
||||
verify_ssl:
|
||||
description: Verify the certification of the endpoint.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
username:
|
||||
description: Your ZoneMinder username.
|
||||
required: false
|
||||
|
@ -15,6 +15,8 @@ ha_iot_class: "Local Push"
|
||||
|
||||
The [Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Please see the [Z-Wave getting started section](/docs/z-wave/) for in-depth documentation on how to use and setup the Z-Wave component.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
If you have setup the requirements, then add the following entry `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
Loading…
x
Reference in New Issue
Block a user