jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Standardize example configuration blocks (#6953)

Browse Source 
* Standardized values in the example configuration

Removed what appear to be an actual API key from the example configuration.yaml block. And, replaced with values as described in the [developer docs](https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages)

* Standardize example configuration-ecobee

* Standardize example configuration-coinbase

* Standardize example configuration-google assistant

* Standardize example configuration-cloudflare

* Standardize example configuration-cloudflare

* Standardize example configuration-habitica

* Standardize example configuration-ifttt

* Standardize example configuration-openalpr

* Standardize example configuration-multiple

* Standardize example configuration-instapush

* Standardize example configuration-llamalab

* Standardize example configuration-notify

* Standardize example configuration-mailgun

* Standardize example configuration-MULTIPLE

* Standardize example configuration-rtm

* Standardize example configuration-spotcrime

* Standardize example configuration-trafikverket

* Standardize example configuration-uk transport

* Standardize example configuration-wunderground

* Standardize example configuration-wsdot

* Standardize example configuration-telegram

* Standardize example configuration-tts

* Standardize example configuration-tts, vultr

* Replace email entry

* Replace IP address

* Place email address
This commit is contained in:
Stuart McCroden 2018-10-19 15:52:25 -05:00 committed by Fabian Affolter
parent 4ce2a36429
commit 72631830da
36 changed files with 77 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_components/cloudflare.markdown
View File

@ -28,9 +28,9 @@ To use the component in your installation, add the following to your `configurat
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
cloudflare: cloudflare:
email: user@example.com email: YOUR_EMAIL_ADDRESS
api_key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41 api_key: YOUR_GLOBAL_API_KEY
zone: example.com zone: EXAMPLE.COM
records: records:
- bin - bin
- www - www

4
source/_components/coinbase.markdown
View File

@ -25,8 +25,8 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
coinbase: coinbase:
api_key: asdfghjklqwertyuiopzxcvbnm api_key: YOUR_API_KEY
api_secret: nkjnewncfghjklqwertyuiopzxcvbnm api_secret: YOUR_API_SECRET
exchange_rate_currencies: exchange_rate_currencies:
- BTC - BTC
- ETH - ETH

2
source/_components/ecobee.markdown
View File

@ -48,7 +48,7 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
ecobee: ecobee:
api_key: asdfghjklqwertyuiopzxcvbnm api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}

18
source/_components/google_assistant.markdown
View File

@ -103,21 +103,21 @@ Now add the following lines to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
google_assistant: google_assistant:
project_id: someproject-2d0b8 project_id: YOUR_PROJECT_ID
api_key: [a Homegraph API Key generated for the Google Actions project] api_key: YOUR_API_KEY
exposed_domains: exposed_domains:
- switch - SWITCH
- light - LIGHT
- group - GROUP
entity_config: entity_config:
switch.kitchen: switch.kitchen:
name: Custom Name for Google Assistant name: CUSTOM_NAME_FOR_GOOGLE_ASSISTANT
aliases: aliases:
- bright lights - BRIGHT_LIGHTS
- entry lights - ENTRY_LIGHTS
light.living_room: light.living_room:
expose: false expose: false
room: living room room: LIVING_ROOM
``` ```
{% configuration %} {% configuration %}

4
source/_components/habitica.markdown
View File

@ -20,8 +20,8 @@ To use the component you should use this example configuration:
```yaml ```yaml
# Minimum viable configuration.yaml entry # Minimum viable configuration.yaml entry
habitica: habitica:
- api_user: 'REPLACE_ME_WITH_YOUR_USER_ID' - api_user: YOUR_USER_ID
api_key: 'REPLACE_ME_WITH_YOUR_API_KEY' api_key: YOUR_API_KEY
``` ```
You can specify several users, providing `api_user` and `api_key` for each. You can specify several users, providing `api_user` and `api_key` for each.

2
source/_components/ifttt.markdown
View File

@ -49,7 +49,7 @@ automation:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
ifttt: ifttt:
key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx key: YOUR_API_KEY
``` ```
`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**. `key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**.

4
source/_components/image_processing.openalpr_cloud.markdown
View File

@ -26,10 +26,10 @@ take a look at the [component](/components/image_processing/) page.
# Example configuration.yaml entry # Example configuration.yaml entry
image_processing: image_processing:
- platform: openalpr_cloud - platform: openalpr_cloud
api_key: 'sk_abcxyz123456' api_key: YOUR_API_KEY
region: eu region: eu
source: source:
- entity_id: camera.garage - entity_id: CAMERA.GARAGE
``` ```
{% configuration %} {% configuration %}

4
source/_components/light.avion.markdown
View File

@ -43,8 +43,8 @@ light:
devices: devices:
00:21:4D:00:00:01: 00:21:4D:00:00:01:
name: Light 1 name: Light 1
api_key: Gr35a/rt3RgaRenl9ag8Ba== api_key: YOUR_API_KEY
00:21:3D:20:00:a1: 00:21:3D:20:00:a1:
name: Light 2 name: Light 2
api_key: Gr35a/rt3RgaRenl9ag8Ba== api_key: YOUR_API_KEY
``` ```

2
source/_components/light.decora.markdown
View File

@ -25,7 +25,7 @@ light:
- platform: decora - platform: decora
devices: devices:
00:21:4D:00:00:01: 00:21:4D:00:00:01:
api_key: 0x12345678 api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}

4
source/_components/mailgun.markdown
View File

@ -23,8 +23,8 @@ To send messages, use the [Mailgun notify platform][notify].
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
mailgun: mailgun:
domain: mg.example.com domain: EXAMPLE.COM
api_key: XXXXXXXXXXXXX api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}

4
source/_components/media_player.emby.markdown
View File

@ -22,8 +22,8 @@ To add Emby to your installation, add the following to your `configuration.yaml`
# Example configuration.yaml entry # Example configuration.yaml entry
media_player: media_player:
- platform: emby - platform: emby
host: 192.168.11.5 host: YOUR_IP_ADDRESS
api_key: "emby_api_key" api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}

4
source/_components/notify.html5.markdown
View File

@ -29,8 +29,8 @@ add the following lines to your `configuration.yaml` file:
notify: notify:
- platform: html5 - platform: html5
name: NOTIFIER_NAME name: NOTIFIER_NAME
gcm_api_key: 'gcm-server-key' gcm_api_key: YOUR_API_KEY
gcm_sender_id: 'gcm-sender-id' gcm_sender_id: YOUR_SENDER_ID
``` ```
{% configuration %} {% configuration %}

8
source/_components/notify.instapush.markdown
View File

@ -24,10 +24,10 @@ To add Instapush to your installation, add the following to your `configuration.
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: instapush platform: instapush
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ app_secret: YOUR_APP_SECRET
event: ABCDEFGHJKLMNOPQRSTUVXYZ event: PUSH_TO_EVENT
tracker: ABCDEFGHJKLMNOPQRSTUVXYZ tracker: TRACKER_NAME
``` ```
Configuration variables: Configuration variables:

4
source/_components/notify.llamalab_automate.markdown
View File

@ -24,8 +24,8 @@ To add Automate to your installation, add the following to your `configuration.y
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: llamalab_automate platform: llamalab_automate
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
to: example@gmail.com to: YOUR_EMAIL_ADDRESS
``` ```
Configuration variables: Configuration variables:

6
source/_components/notify.mailgun.markdown
View File

@ -21,13 +21,13 @@ The Mailgun notification service allows you to send emails via Mailgun's REST AP
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
mailgun: mailgun:
domain: mg.example.com domain: EXAMPLE.COM
api_key: XXXXXXXXXXXXXX api_key: YOUR_API_KEY
notify: notify:
- name: mailgun - name: mailgun
platform: mailgun platform: mailgun
recipient: me@example.com recipient: CHANGE@EXAMPLE.COM
``` ```
{% configuration %} {% configuration %}

4
source/_components/notify.markdown
View File

@ -17,8 +17,8 @@ The `notify` component makes it possible to send notifications to a wide variety
# Example configuration.yaml entry # Example configuration.yaml entry
notify: notify:
- platform: pushbullet - platform: pushbullet
name: paulus name: NOTIFY_NAME
api_key: ABCDEFG api_key: YOUR_API_KEY
``` ```
The **name** parameter is optional but needed if you want to use multiple platforms. The platform will be exposed as service `notify.<name>`. The name will default to `notify` if not supplied. The **name** parameter is optional but needed if you want to use multiple platforms. The platform will be exposed as service `notify.<name>`. The name will default to `notify` if not supplied.

2
source/_components/notify.prowl.markdown
View File

@ -24,7 +24,7 @@ To add Prowl notifications to your installation, add the following to your `conf
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: prowl platform: prowl
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
``` ```
Configuration variables: Configuration variables:

4
source/_components/notify.pushover.markdown
View File

@ -26,8 +26,8 @@ To use Pushover notifications, add the following to your `configuration.yaml` fi
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: pushover platform: pushover
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ user_key: YOUR_USER_KEY
``` ```
Configuration variables: Configuration variables:

2
source/_components/notify.pushsafer.markdown
View File

@ -23,7 +23,7 @@ To use Pushsafer notifications, add the following to your `configuration.yaml` f
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: pushsafer platform: pushsafer
private_key: ABCDEFGHJKLMNOPQRSTUVXYZ private_key: YOUR_KEY
``` ```
**Configuration variables:** **Configuration variables:**

2
source/_components/notify.sendgrid.markdown
View File

@ -20,7 +20,7 @@ To enable notification emails via SendGrid in your installation, add the followi
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: sendgrid platform: sendgrid
api_key: API_KEY api_key: YOUR_API_KEY
sender: SENDER_EMAIL_ADDRESS sender: SENDER_EMAIL_ADDRESS
recipient: YOUR_RECIPIENT recipient: YOUR_RECIPIENT
``` ```

2
source/_components/notify.slack.markdown
View File

@ -38,7 +38,7 @@ To enable the Slack notification in your installation, add the following to your
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: slack platform: slack
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
default_channel: '#general' default_channel: '#general'
``` ```

2
source/_components/notify.telegram.markdown
View File

@ -79,7 +79,7 @@ To enable Telegram notifications in your installation, add the following to your
# Example configuration.yaml entry for the Telegram Bot # Example configuration.yaml entry for the Telegram Bot
telegram_bot: telegram_bot:
- platform: polling - platform: polling
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
allowed_chat_ids: allowed_chat_ids:
- CHAT_ID_1 - CHAT_ID_1
- CHAT_ID_2 - CHAT_ID_2

8
source/_components/notify.twitter.markdown
View File

@ -28,10 +28,10 @@ To add Twitter to your installation, add the following to your `configuration.ya
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: twitter platform: twitter
consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ consumer_key: YOUR_API_KEY
consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ consumer_secret: YOUR_API_SECRET
access_token: ABCDEFGHJKLMNOPQRSTUVXYZ access_token: YOUR_ACCESS_TOKEN
access_token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ access_token_secret: YOUR_ACCESS_SECRET
``` ```
{% configuration %} {% configuration %}

4
source/_components/remember_the_milk.markdown
View File

@ -27,8 +27,8 @@ To be able to use this component, you need a Remember The Milk account and you n
remember_the_milk: remember_the_milk:
- name: your_rtm_account - name: your_rtm_account
api_key: <your secret api key goes here> api_key: YOUR_API_KEY
shared_secret: <your secret shared secret goes here> shared_secret: YOUR_SHARED_SECRET
``` ```

6
source/_components/sensor.spotcrime.markdown
View File

@ -25,9 +25,9 @@ To enable this sensor, add the following lines to your `configuration.yaml`. You
```yaml ```yaml
sensor: sensor:
- platform: spotcrime - platform: spotcrime
name: <any name> name: NAME
radius: <your radius> radius: SEARCH_RADIUS
api_key: <"your_api_key_here"> api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}

8
source/_components/sensor.trafikverket_weatherstation.markdown
View File

@ -29,7 +29,7 @@ To enable this sensor, add the following lines to your `configuration.yaml`.
sensor: sensor:
- platform: trafikverket_weatherstation - platform: trafikverket_weatherstation
name: Trafikverket Kungälv name: Trafikverket Kungälv
api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX api_key: YOUR_API_KEY
station: Kungälv station: Kungälv
monitored_conditions: monitored_conditions:
- air_temp - air_temp
@ -93,7 +93,7 @@ Click [here](https://www.trafikverket.se/trafikinformation/vag/?TrafficType=pers
sensor: sensor:
- platform: trafikverket_weatherstation - platform: trafikverket_weatherstation
name: Trafikverket Kungälv name: Trafikverket Kungälv
api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX api_key: YOUR_API_KEY
station: Kungälv station: Kungälv
monitored_conditions: monitored_conditions:
- air_temp - air_temp
@ -105,7 +105,7 @@ sensor:
- wind_speed - wind_speed
- platform: trafikverket_weatherstation - platform: trafikverket_weatherstation
name: Trafikverket Lanna name: Trafikverket Lanna
api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX api_key: YOUR_API_KEY
station: Lanna station: Lanna
monitored_conditions: monitored_conditions:
- air_temp - air_temp
@ -113,7 +113,7 @@ sensor:
- humidity - humidity
- platform: trafikverket_weatherstation - platform: trafikverket_weatherstation
name: Trafikverket Nöbbele name: Trafikverket Nöbbele
api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX api_key: YOUR_API_KEY
station: Nöbbele station: Nöbbele
monitored_conditions: monitored_conditions:
- air_temp - air_temp

8
source/_components/sensor.uk_transport.markdown
View File

@ -29,8 +29,8 @@ To add a single train departure sensor add the following to your `configuration.
# Example configuration.yaml entry for a single sensor # Example configuration.yaml entry for a single sensor
sensor: sensor:
- platform: uk_transport - platform: uk_transport
app_id: abc123 app_id: YOUR_APP_ID
app_key: efg456 app_key: YOUR_APP_KEY
queries: queries:
- mode: train - mode: train
origin: MAL origin: MAL
@ -116,8 +116,8 @@ The `destination` must be a valid location in the "direction" field returned by
# Example configuration.yaml entry for multiple sensors # Example configuration.yaml entry for multiple sensors
sensor: sensor:
- platform: uk_transport - platform: uk_transport
app_id: abc123 app_id: YOUR_APP_ID
app_key: efg456 app_key: YOUR_APP_KEY
queries: queries:
- mode: bus - mode: bus
origin: 340000368SHE origin: 340000368SHE

2
source/_components/sensor.wsdot.markdown
View File

@ -23,7 +23,7 @@ Once you have the code, create `wsdot` sensors by editing your `configuration.ya
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
- platform: wsdot - platform: wsdot
api_key: XXXXXXXXXXXXXXXXXXXXXXX api_key: YOUR_API_KEY
travel_time: travel_time:
- id: 95 - id: 95
name: I-90 Eastbound HOV name: I-90 Eastbound HOV

6
source/_components/sensor.wunderground.markdown
View File

@ -27,7 +27,7 @@ To add Wunderground to your installation, add the following to your `configurati
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
- platform: wunderground - platform: wunderground
api_key: your_api_key api_key: YOUR_API_KEY
monitored_conditions: monitored_conditions:
- alerts - alerts
- dewpoint_c - dewpoint_c
@ -207,7 +207,7 @@ in the `_1h_` part of the sensor name with `1` to `36`. e.g., `weather_24h` will
```yaml ```yaml
sensor: sensor:
- platform: wunderground - platform: wunderground
api_key: your_api_key api_key: YOUR_API_KEY
monitored_conditions: monitored_conditions:
- weather_1d_metric - weather_1d_metric
- weather_1n_metric - weather_1n_metric
@ -239,7 +239,7 @@ group:
```yaml ```yaml
sensor: sensor:
- platform: wunderground - platform: wunderground
api_key: your_api_key api_key: YOUR_API_KEY
monitored_conditions: monitored_conditions:
- temp_high_record_c - temp_high_record_c
- temp_high_1d_c - temp_high_1d_c

2
source/_components/telegram_bot.broadcast.markdown
View File

@ -21,7 +21,7 @@ To integrate this into Home Assistant, add the following section to your `config
telegram_bot: telegram_bot:
- platform: broadcast - platform: broadcast
api_key: <telegram api key> api_key: YOUR_API_KEY
allowed_chat_ids: allowed_chat_ids:
- 12345 - 12345
- 67890 - 67890

2
source/_components/telegram_bot.polling.markdown
View File

@ -23,7 +23,7 @@ To integrate this into Home Assistant, add the following section to your `config
telegram_bot: telegram_bot:
- platform: polling - platform: polling
api_key: <telegram api key> api_key: YOUR_API_KEY
allowed_chat_ids: allowed_chat_ids:
- 12345 - 12345
- 67890 - 67890

4
source/_components/telegram_bot.webhooks.markdown
View File

@ -27,7 +27,7 @@ http:
telegram_bot: telegram_bot:
- platform: webhooks - platform: webhooks
api_key: telegram api key api_key: YOUR_API_KEY
parse_mode: html parse_mode: html
allowed_chat_ids: allowed_chat_ids:
- 12345 - 12345
@ -78,7 +78,7 @@ http:
telegram_bot: telegram_bot:
- platform: webhooks - platform: webhooks
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ api_key: YOUR_API_KEY
trusted_networks: trusted_networks:
- 149.154.167.197/32 - 149.154.167.197/32
- 149.154.167.198/31 - 149.154.167.198/31

4
source/_components/tts.microsoft.markdown
View File

@ -21,7 +21,7 @@ To enable text-to-speech with Microsoft, add the following lines to your `config
# Example configuration.yaml entry # Example configuration.yaml entry
tts: tts:
- platform: microsoft - platform: microsoft
api_key: [YourAPIKey] api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}
@ -71,7 +71,7 @@ A full configuration sample including optional variables:
# Example configuration.yaml entry # Example configuration.yaml entry
tts: tts:
- platform: microsoft - platform: microsoft
api_key: XXXXXXXXX api_key: YOUR_API_KEY
language: en-gb language: en-gb
gender: Male gender: Male
type: George, Apollo type: George, Apollo

2
source/_components/tts.voicerss.markdown
View File

@ -57,7 +57,7 @@ The configuration sample below show how a entry can look like:
# Example configuration.yaml entry # Example configuration.yaml entry
tts: tts:
- platform: voicerss - platform: voicerss
api_key: 'XXXXX' api_key: YOUR_API_KEY
language: 'de-de' language: 'de-de'
codec: mp3 codec: mp3
format: '8khz_8bit_mono' format: '8khz_8bit_mono'

2
source/_components/tts.yandextts.markdown
View File

@ -67,7 +67,7 @@ The configuration sample below show how a entry can look like:
# Example configuration.yaml entry # Example configuration.yaml entry
tts: tts:
- platform: yandextts - platform: yandextts
api_key: 'XXXXX' api_key: YOUR_API_KEY
language: 'ru-RU' language: 'ru-RU'
codec: mp3 codec: mp3
voice: oksana voice: oksana

2
source/_components/vultr.markdown
View File

@ -28,7 +28,7 @@ To integrate your Vultr subscriptions with Home Assistant, add the following sec
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
vultr: vultr:
api_key: ABCDEFG12345 api_key: YOUR_API_KEY
``` ```
{% configuration %} {% configuration %}