From da1278cc746457daa900643ae412a00b5828d3a4 Mon Sep 17 00:00:00 2001 From: Nolan Gilley Date: Thu, 4 May 2017 16:14:24 -0400 Subject: [PATCH] update joaoapps join for PR 7443 (#2564) --- source/_components/joaoapps_join.markdown | 35 +++++++++++++---------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index ca6ea4650c2..a66389a6c88 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -15,16 +15,19 @@ ha_release: "0.24" The Join platform exposes services from [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. The notify platform allows us to send messages to Join devices, the the component allows us to access the other special features that Join offers. -In the `configuration.yaml` file you need to provide the device id of the target device. If you want to send to a group of devices, you need to provide an api key. You can find you device id and api key [here](https://joinjoaomgcd.appspot.com/). +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 [here](https://joinjoaomgcd.appspot.com/). To set it up, add the following information to your `configuration.yaml` file: ```yaml notify: - platform: joaoapps_join - device_id: d5asdfasdf54645h45h368761dfe5gt8a - name: droid *optional - api_key: asd97823jb628a34fwsdfwefd5384345tf2d *optional + api_key: asd97823jb628a34fwsdfwefd5384345tf2d + device_id: d5asdfasdf54645h45h368761dfe5gt8a *optional + device_ids: d5asdfasdf54645h45h368761dfe5gt8a, a4asdfasdf54645h45h368761dfe5gt3b *optional + device_names: Pixel, iPhone *optional + name: Phones *optional + joaoapps_join: - name: android @@ -34,23 +37,25 @@ joaoapps_join: Configuration variables: -- **device_id** (*Required*): The Id of your device. - **api_key** (*Required*): The API key for Join. +- **device_id** (*Optional*): The id of your device. +- **device_ids** (*Optional*): Comma separated list of device ids. +- **device_names** (*Optional*): Comma separated list of device names. -The notify service has two optional parameters: `icon` and `small icon`. You can use them like so: +The notify service has two optional parameters: `icon` and `vibration`. You can use them like so: ```json -{"message":"Hello!","title":"From Hass","data":{"icon":"https://goo.gl/KVqcYi","smallicon":"http://goo.gl/AU4Wf1"}} +{"message":"Hello from Home Assistant!","title":"Home Assistant","data":{"icon":"https://goo.gl/xeetdy", "vibration":"0,65,706,86,657,95,668,100"}} ``` The services exposed in the joaoapps_join component can be used with the service data described below: -| Service | Data | -|------------------------------ |------------------------------------------------------------------ | -| joaoapps_join/ring | | -| joaoapps_join/send_sms | {"number":"5553334444", "message":"Hello!"} | -| joaoapps_join/send_tasker | {"command":"test"} | -| joaoapps_join/send_url | {"url":"http://google.com"} | -| joaoapps_join/send_wallpaper | {"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"} | -| joaoapps_join/send_file | {"url":"http://download.thinkbroadband.com/5MB.zip"} | +| Service | Data | +|------------------------------ |------------------------------------------------------------------ | +| joaoapps_join/ring | | +| joaoapps_join/send_sms | {"number":"5553334444", "message":"Hello!"} | +| joaoapps_join/send_tasker | {"command":"test"} | +| joaoapps_join/send_url | {"url":"http://google.com"} | +| joaoapps_join/send_wallpaper | {"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"} | +| joaoapps_join/send_file | {"url":"http://download.thinkbroadband.com/5MB.zip"} |