mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
YAML syntax highlighting
This commit is contained in:
parent
cb82716922
commit
6fbf16fda1
@ -167,7 +167,7 @@ switch:
|
|||||||
__Hikvision camera motion detection support__<br>
|
__Hikvision camera motion detection support__<br>
|
||||||
This switch platform allows you to control your motion detection setting on your Hikvision camera.
|
This switch platform allows you to control your motion detection setting on your Hikvision camera.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: hikvisioncam
|
platform: hikvisioncam
|
||||||
|
@ -64,7 +64,7 @@ __Kodi (XBMC)__<br>
|
|||||||
<img src='/images/supported_brands/kodi.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
<img src='/images/supported_brands/kodi.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
||||||
Ettisan has contributed a Kodi (XBMC) platform for the media player component. This allows you to track all the media that you are playing and allow you to control it.
|
Ettisan has contributed a Kodi (XBMC) platform for the media player component. This allows you to track all the media that you are playing and allow you to control it.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: kodi
|
platform: kodi
|
||||||
|
@ -36,7 +36,7 @@ __Raspberry PI GPIO Support__<br>
|
|||||||
<img src='/images/supported_brands/raspberry-pi.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
<img src='/images/supported_brands/raspberry-pi.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
||||||
[@gbarba](https://github.com/gbarba) has contributed support to use the general purpose input and output pins on a Raspberry PI as switches inside Home Assistant.
|
[@gbarba](https://github.com/gbarba) has contributed support to use the general purpose input and output pins on a Raspberry PI as switches inside Home Assistant.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: rpi_gpio
|
platform: rpi_gpio
|
||||||
@ -62,7 +62,7 @@ __Logitech Squeezebox media player support__<br>
|
|||||||
<img src='/images/supported_brands/logitech.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
<img src='/images/supported_brands/logitech.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
||||||
[@persandstrom](https://github.com/persandstrom) also contributed support for the Logitech Squeezebox media player. This allows you to control your Logitech Squeezebox from Home Assistant.
|
[@persandstrom](https://github.com/persandstrom) also contributed support for the Logitech Squeezebox media player. This allows you to control your Logitech Squeezebox from Home Assistant.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: squeezebox
|
platform: squeezebox
|
||||||
@ -88,7 +88,7 @@ __Edimax Smart Switches support__<br>
|
|||||||
<img src='/images/supported_brands/edimax.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
<img src='/images/supported_brands/edimax.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
||||||
[@rkabadi](https://github.com/rkabadi) has contributed support for integrating Edimax Smart Switches into Home Assistant.
|
[@rkabadi](https://github.com/rkabadi) has contributed support for integrating Edimax Smart Switches into Home Assistant.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: edimax
|
platform: edimax
|
||||||
@ -113,7 +113,7 @@ The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-i
|
|||||||
__TEMPer temperature sensor support__<br>
|
__TEMPer temperature sensor support__<br>
|
||||||
Support for Temper temperature sensors has been contributed by [@rkabadi](https://github.com/rkabadi).
|
Support for Temper temperature sensors has been contributed by [@rkabadi](https://github.com/rkabadi).
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: temper
|
platform: temper
|
||||||
|
@ -54,7 +54,7 @@ Maker channel setup:
|
|||||||
<img src='/images/blog/2015-09-ifttt/recipe-twitter.png' />
|
<img src='/images/blog/2015-09-ifttt/recipe-twitter.png' />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
This will tweet a message when a MQTT message is received that the smoke alarm has been triggered.
|
This will tweet a message when an MQTT message is received that the smoke alarm has been triggered.
|
||||||
Setup Maker channel with event name `HA_FIRE_ALARM` and Twitter channel to tweet the message in
|
Setup Maker channel with event name `HA_FIRE_ALARM` and Twitter channel to tweet the message in
|
||||||
`value1`.
|
`value1`.
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ __iTunes and airplay speakers__<br>
|
|||||||
[@maddox](https://github.com/maddox) has contributed support for controlling iTunes and airplay speakers. For this to work you will
|
[@maddox](https://github.com/maddox) has contributed support for controlling iTunes and airplay speakers. For this to work you will
|
||||||
have to run [itunes-api](https://github.com/maddox/itunes-api) on your Mac as middleware.
|
have to run [itunes-api](https://github.com/maddox/itunes-api) on your Mac as middleware.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: itunes
|
platform: itunes
|
||||||
|
@ -17,7 +17,7 @@ including the network-prefix notation (`192.168.1.1/24`) and the range notation
|
|||||||
If you're on Debian or Ubuntu, you might have to install the packages for arp and nmap. Do so by
|
If you're on Debian or Ubuntu, you might have to install the packages for arp and nmap. Do so by
|
||||||
running `apt-get install net-tools nmap`.
|
running `apt-get install net-tools nmap`.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
device_tracker:
|
device_tracker:
|
||||||
platform: nmap_tracker
|
platform: nmap_tracker
|
||||||
|
@ -21,7 +21,8 @@ It will be able to add Google Chreomcasts and Belkin WeMo switches automatically
|
|||||||
|
|
||||||
To load this component, add the following lines to your `configuration.yaml`:
|
To load this component, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
discovery:
|
discovery:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ The `downloader` component provides a service to download files. It will raise a
|
|||||||
|
|
||||||
To enable it, add the following lines to your `configuration.yaml`:
|
To enable it, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
downloader:
|
downloader:
|
||||||
download_dir: downloads
|
download_dir: downloads
|
||||||
|
@ -15,7 +15,8 @@ Philips Hue support is integrated into Home Assistant as a light platform. The p
|
|||||||
|
|
||||||
If you want to enable the light component directly, add the following lines to your `configuration.yaml`:
|
If you want to enable the light component directly, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
platform: hue
|
platform: hue
|
||||||
```
|
```
|
||||||
|
@ -14,7 +14,7 @@ The limitlessled can control your [LimitlessLED](http://www.limitlessled.com/) l
|
|||||||
|
|
||||||
To add limitlessled to your installation, add the following to your `configuration.yaml` file:
|
To add limitlessled to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
platform: limitlessled
|
platform: limitlessled
|
||||||
|
@ -23,7 +23,7 @@ logbook:
|
|||||||
|
|
||||||
It is possible to add custom entries to the logbook by using the script component to fire an event.
|
It is possible to add custom entries to the logbook by using the script component to fire an event.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
script:
|
script:
|
||||||
add_logbook_entry:
|
add_logbook_entry:
|
||||||
|
@ -20,7 +20,7 @@ footer: true
|
|||||||
|
|
||||||
To add iTunes to your installation, add the following to your `configuration.yaml` file:
|
To add iTunes to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: itunes
|
platform: itunes
|
||||||
|
@ -14,7 +14,7 @@ The kodi platform allows you to control a [Kodi](http://kodi.tv/) multimedia sys
|
|||||||
|
|
||||||
To add Kodi to your installation, add the following to your `configuration.yaml` file:
|
To add Kodi to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: kodi
|
platform: kodi
|
||||||
|
@ -14,7 +14,7 @@ The mpd platform allows you to control a [Music Player Daemon](http://www.musicp
|
|||||||
|
|
||||||
To add MPD to your installation, add the following to your `configuration.yaml` file:
|
To add MPD to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: mpd
|
platform: mpd
|
||||||
|
@ -14,7 +14,7 @@ The squeezebox platform allows you to control a [Logitech Squeezebox](https://en
|
|||||||
|
|
||||||
To add your Squeezebox to your installation, add the following to your `configuration.yaml` file:
|
To add your Squeezebox to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
media_player:
|
media_player:
|
||||||
platform: squeezebox
|
platform: squeezebox
|
||||||
|
@ -27,7 +27,7 @@ Home Assistant currently supports a wide range of services for notifications:
|
|||||||
|
|
||||||
Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your `configuration.yaml` to be notified when the sun sets.
|
Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your `configuration.yaml` to be notified when the sun sets.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
automation:
|
automation:
|
||||||
alias: Sun set notification
|
alias: Sun set notification
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ The default value is `notify`. The notifier will bind to the service
|
|||||||
|
|
||||||
Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your `configuration.yaml` to be notified when the sun sets.
|
Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your `configuration.yaml` to be notified when the sun sets.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
automation:
|
automation:
|
||||||
alias: Sun set notification
|
alias: Sun set notification
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ The rpi_gpio sensor platform allows you to read sensor values of the GPIOs of yo
|
|||||||
|
|
||||||
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: rpi_gpio
|
platform: rpi_gpio
|
||||||
|
@ -13,7 +13,7 @@ This temper sensor platform allows you to get the current temperature from a TEM
|
|||||||
|
|
||||||
To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file:
|
To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: temper
|
platform: temper
|
||||||
|
@ -14,7 +14,7 @@ This edimax switch platform allows you to control the state of your [Edimax](htt
|
|||||||
|
|
||||||
To use your Edimax switch in your installation, add the following to your `configuration.yaml` file:
|
To use your Edimax switch in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: edimax
|
platform: edimax
|
||||||
|
@ -14,7 +14,7 @@ This hikvisioncam switch platform allows you to control your motion detection se
|
|||||||
|
|
||||||
To use your Hikvision cam in your installation, add the following to your `configuration.yaml` file:
|
To use your Hikvision cam in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: hikvisioncam
|
platform: hikvisioncam
|
||||||
|
@ -14,7 +14,7 @@ The rpi_gpio switch platform allows you to control the GPIOs of your [Raspberry
|
|||||||
|
|
||||||
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: rpi_gpio
|
platform: rpi_gpio
|
||||||
|
@ -14,7 +14,7 @@ The nest thermostat platform let you control a thermostat from [Nest](https://ne
|
|||||||
|
|
||||||
To set it up, add the following information to your `configuration.yaml` file:
|
To set it up, add the following information to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
thermostat:
|
thermostat:
|
||||||
platform: nest
|
platform: nest
|
||||||
username: USERNAME
|
username: USERNAME
|
||||||
|
@ -11,7 +11,7 @@ footer: true
|
|||||||
|
|
||||||
<img src='/images/supported_brands/vera.png' class='brand' />
|
<img src='/images/supported_brands/vera.png' class='brand' />
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: vera
|
platform: vera
|
||||||
|
@ -23,7 +23,7 @@ To get started with the Wink API, you will first need to get yourself an API acc
|
|||||||
|
|
||||||
After you have gotten your access token, add the following to your `configuration.yaml`:
|
After you have gotten your access token, add the following to your `configuration.yaml`:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
wink:
|
wink:
|
||||||
access_token: YOUR_ACCESS_TOKEN
|
access_token: YOUR_ACCESS_TOKEN
|
||||||
```
|
```
|
||||||
|
@ -16,7 +16,7 @@ The first is [hello_world.py](https://github.com/balloob/home-assistant/blob/mas
|
|||||||
|
|
||||||
If you want to load these components in Home Assistant, add the following lines to your `configuration.yaml` file:
|
If you want to load these components in Home Assistant, add the following lines to your `configuration.yaml` file:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
hello_world:
|
hello_world:
|
||||||
|
|
||||||
example:
|
example:
|
||||||
@ -79,7 +79,7 @@ The Home Assistant object contains three objects to help you interact with the s
|
|||||||
### {% linkable_title Example on using the configuration parameter %}
|
### {% linkable_title Example on using the configuration parameter %}
|
||||||
If your configuration file contains the following lines:
|
If your configuration file contains the following lines:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
example:
|
example:
|
||||||
host: paulusschoutsen.nl
|
host: paulusschoutsen.nl
|
||||||
```
|
```
|
||||||
|
@ -23,7 +23,7 @@ Do not use development mode in production. Home Assistant uses aggressive cachin
|
|||||||
# {% linkable_title Turning on development mode %}
|
# {% linkable_title Turning on development mode %}
|
||||||
Home Assistant will by default serve the compiled version of the frontend. To change it so that each component and JavaScript are served separately, update your `configuration.yaml` to have these lines:
|
Home Assistant will by default serve the compiled version of the frontend. To change it so that each component and JavaScript are served separately, update your `configuration.yaml` to have these lines:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
http:
|
http:
|
||||||
development: 1
|
development: 1
|
||||||
```
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user