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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update the join documentation (#9436)

Browse Source 
Added clarification on several areas that are not clear, and corrected a few errors
This commit is contained in:
domier 2019-05-12 01:41:33 +09:00 committed by Fabian Affolter
parent 625a07a832
commit 06e7c7f8f1
1 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
source/_components/joaoapps_join.markdown
View File

@ -20,7 +20,7 @@ The `joaoapps_join` component exposes services from
[Join](http://joaoapps.com/join). In Home Assistant, the Join features are [Join](http://joaoapps.com/join). In Home Assistant, the Join features are
divided up in two locations, the Join component, and the Join notify platform. divided up in two locations, the Join component, and the Join notify platform.
The notify platform allows us to send messages to Join devices, the component The notify platform allows us to send messages to Join devices, the component
allows us to access the other special features that Join offers. allows us to access the other special features that Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this this is based on.
In the `configuration.yaml` file you need to provide the api key and device id In the `configuration.yaml` file you need to provide the api key and device id
or name of the target device. You can find your device id and api key or name of the target device. You can find your device id and api key
@ -34,8 +34,8 @@ notify:
- platform: joaoapps_join - platform: joaoapps_join
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
device_id: DEVICE_ID device_id: DEVICE_ID
device_ids: DEVICE_ID_1, DEVICE_ID_2 device_ids: DEVICE_ID_1,DEVICE_ID_2
device_names: DEVICE_1_NAME, DEVICE_2_NAME device_names: DEVICE_1_NAME,DEVICE_2_NAME
name: NAME name: NAME
joaoapps_join: joaoapps_join:
- name: NAME_OF_GROUP - name: NAME_OF_GROUP
@ -49,20 +49,39 @@ api_key:
required: true required: true
type: string type: string
device_id: device_id:
description: The id of your device. description: The id of your device or group
required: false required: false
type: string type: string
device_ids: device_ids:
description: Comma separated list of device ids. description: Comma separated list of device ids or groups.
required: false required: false
type: string type: string
device_names: device_names:
description: Comma separated list of device names. description: Comma separated list of device names.
required: false required: false
type: string type: string
name:
description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as service `notify.<name>`. The name will defailt to `notify` if not supplied. See the [Notifications Component](http://www.home-assistant.io/components/notify) for more details.
required: false
type: string
{% endconfiguration %} {% endconfiguration %}
The notify service has two optional parameters: `icon`, `smallicon`, `image`, `sound`, `url`, `notification_id`, `tts`, `tts_language` and `vibration`. Use only one of `device_id`, `device_ids`, or `device_names`, this will determine the notification recipient(s).
```yaml
# Example configuration.yaml entry
notify:
- platform: joaoapps_join
api_key: YOUR_API_KEY
device_id: DEVICE_ID1
name: NAME1
- platform: joaoapps_join
api_key: YOUR_API_KEY
device_id: DEVICE_ID2
name: NAME2
```
The notify service has several optional parameters: `icon`, `smallicon`, `image`, `sound`, `url`, `notification_id`, `tts`, `tts_language` and `vibration`.
You can use them like so: You can use them like so:
```json ```json