mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-28 05:46:48 +00:00
dd51ad0df5
* fixed double 'the' mostly 's/the the /the /', little style changes where 'is' or 'to' was missing * removed duplicate words removed duplicate words like 'to to', 'you you' or 'account account' etc. a batch of pizza-toasts burnt for this.
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "Joaoapps Join"
|
|
description: "Instructions for how to integrate the Join by Joaoapps service within Home Assistant."
|
|
date: 2016-07-12 10:49
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: joaoapps_join.png
|
|
ha_category: Hub
|
|
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 component allows us to access the other special features that Join offers.
|
|
|
|
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
|
|
api_key: asd97823jb628a34fwsdfwefd5384345tf2d
|
|
device_id: d5asdfasdf54645h45h368761dfe5gt8a *optional
|
|
device_ids: d5asdfasdf54645h45h368761dfe5gt8a, a4asdfasdf54645h45h368761dfe5gt3b *optional
|
|
device_names: Pixel, iPhone *optional
|
|
name: Phones *optional
|
|
|
|
|
|
joaoapps_join:
|
|
- name: android
|
|
device_id: group.android
|
|
api_key: asd97823jb628a34fwsdfwefd5384345tf2d
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **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 `vibration`. You can use them like so:
|
|
|
|
```json
|
|
{"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"} |
|
|
|