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-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor changes (#6761)

Browse Source 
* Minor changes

* Remove char
This commit is contained in:
Fabian Affolter 2018-10-13 23:04:27 +02:00 committed by GitHub
parent d488fcaf84
commit e9c4c36f78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 72 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
source/_components/android_ip_webcam.markdown
View File

@ -17,7 +17,13 @@ The `android_ip_webcam` component turns an Android phone into a network camera w
It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
To set it up, download [the IP Webcam app][app], and add the following information to your `configuration.yaml` file:
## {% linkable_title Setup %}
Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. You will be able to the IP address of the device.
## {% linkable_title Configuration %}
To set it up the component, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -27,7 +33,7 @@ android_ip_webcam:
{% configuration %}
host:
description: The IP Address of the phone on the network.
description: The IP address of the phone on the network.
required: true
type: string
port:
@ -59,50 +65,50 @@ sensors:
type: list
keys:
audio_connections:
description: Audio Connections
description: The audio connections
battery_level:
description: Battery Level
description: The battery level
battery_temp:
description: Battery Temperature
description: The battery temperature
battery_voltage:
description: Battery Voltage
description: The battery voltage
light:
description: Light Level
description: The light level
motion:
description: Motion
description: Motion detection
pressure:
description: Pressure
description: The current pressure
proximity:
description: Proximity
description: The proximity
sound:
description: Sound
description: The sound detection
video_connections:
description: Video Connections
description: The video connections
switches:
description: Conditions to display settings in the frontend. See the list of supported switches.
required: false
type: list
keys:
exposure_lock:
description: Exposure Lock
description: Control the exposure lock
ffc:
description: Front-facing Camera
description: Control the front-facing camera.
focus:
description: Focus
description: Control the focus.
gps_active:
description: GPS Active
description: Control the GPS.
night_vision:
description: Night Vision
description: Control the night vision.
overlay:
description: Overlay
description: Control the overlay.
torch:
description: Torch
description: Control the torch.
whitebalance_lock:
description: White Balance Lock
description: Control the white balance lock.
video_recording:
description: Video Recording
description: Control the video recording.
motion_sensor:
description: Activate motion sensor if auto_discovery is disabled.
description: Activate motion sensor if `auto_discovery` is disabled.
required: false
type: boolean
{% endconfiguration %}
@ -147,4 +153,3 @@ android_ip_webcam:
- torch
```
[app]: https://play.google.com/store/apps/details?id=com.pas.webcam

14
source/_components/notify.aws_lambda.markdown
View File

@ -14,9 +14,13 @@ ha_release: "0.20"
The `aws_lambda` notification platform enables invoking [AWS Lambda](https://aws.amazon.com/lambda/) functions.
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
## {% linkable_title Setup %}
### Configuration
For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions.
## {% linkable_title Configuration %}
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -30,9 +34,9 @@ notify:
Configuration variables:
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name. For more information, please see the [boto3 documentation section about credentials](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file).
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name.
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **context** (*Optional*): An optional dictionary you can provide to pass custom context through to the Lambda function. The `context` dictionary (if any) is combined with the same data available at the `/api/config` HTTP API route.

12
source/_components/notify.aws_sns.markdown
View File

@ -14,6 +14,12 @@ ha_release: "0.20"
The `aws_sns` notification platform enables publishing to an [AWS SNS](https://aws.amazon.com/sns/) topic or application.
## {% linkable_title Setup %}
For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions.
## {% linkable_title Configuration %}
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -28,9 +34,9 @@ notify:
Configuration variables:
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name. For more information, please see the [boto3 documentation section about credentials](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file).
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name.
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.

12
source/_components/notify.aws_sqs.markdown
View File

@ -14,6 +14,12 @@ ha_release: "0.20"
The `aws_sqs` notification platform enables publishing to an [AWS SQS](https://aws.amazon.com/sqs/) message queue.
## {% linkable_title Setup %}
For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions.
## {% linkable_title Configuration %}
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -28,9 +34,9 @@ notify:
Configuration variables:
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name. For more information, please see the [boto3 documentation section about credentials](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file).
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name.
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.

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

@ -43,7 +43,7 @@ resource:
type: string
default: string
method:
description: The method of the request.
description: The method of the request. Either `POST` or `GET`.
required: false
type: string
default: GET

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

@ -34,7 +34,7 @@ name:
type: string
default: Uptime
unit_of_measurement:
description: "Units for uptime measurement in either `days`, `hours`, or `minutes`."
description: "Units for uptime measurement in either `days`, `hours` or `minutes`."
required: false
type: string
default: days

22
source/_components/tts.amazon_polly.markdown
View File

@ -15,6 +15,12 @@ ha_release: 0.37
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
Polly is a paid service via Amazon Web Services. There is a [free tier](https://aws.amazon.com/polly/pricing/) for the first 12 months and then a charge per million characters afterwards.
## {% linkable_title Setup %}
For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions.
Available voices are listed in the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html).
## {% linkable_title Configuration %}
To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly):
@ -29,21 +35,22 @@ tts:
{% configuration %}
aws_access_key_id:
description: "Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`."
description: "Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`."
required: true
type: string
aws_secret_access_key:
description: "Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`."
description: "Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`."
required: true
type: string
profile_name:
description: A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information.
description: A credentials profile name.
required: false
type: string
region_name:
description: "The region identifier to connect to. The default is `us-east-1`. See the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions."
description: The region identifier to connect to.
required: false
type: string or list
default: us-east-1
name:
description: "Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`."
required: false
@ -54,18 +61,19 @@ text_type:
type: string
default: text
voice:
description: "Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices."
description: Voice name to be used.
required: false
type: string
output_format:
description: "Override the default output format, e.g., `mp3`, `ogg_vorbis` or `pcm`."
description: "Override the default output format. Either `mp3`, `ogg_vorbis` or `pcm`."
required: false
type: string
default: mp3
sample_rate:
description: "Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm."
description: "Override the default sample rate."
required: false
type: string
default: 22050 for MP3 and Ogg Vorbis, 16000 for pcm
{% endconfiguration %}