home-assistant.io/source/_components/joaoapps_join.markdown
joemcmonagle f567c18850 Update joaoapps_join.markdown (#4144)
* Update joaoapps_join.markdown

After publishing, the website displays this quotes as curly/smart quotation marks which breaks copy and paste
See where someone ran into this issue on a reddit post here: https://www.reddit.com/r/homeassistant/comments/7dvqka/anybody_using_joaoapps_join_error_parsing_json/

* Minor changes
2017-12-06 08:10:35 +01:00

2.7 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release
page Joaoapps Join Instructions for how to integrate the Join by Joaoapps service within Home Assistant. 2016-07-12 10:49 true false true true joaoapps_join.png Hub 0.24

The joaoapps_join component exposes services from 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.

To set it up, add the following information to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - platform: joaoapps_join
    api_key: asd97823jb628a34fwsdfwefd5384345tf2d
    device_id: d5asdfasdf54645h45h368761dfe5gt8a
    device_ids: d5asdfasdf54645h45h368761dfe5gt8a, a4asdfasdf54645h45h368761dfe5gt3b
    device_names: Pixel, iPhone
    name: Phones
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:

{"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"}