From 1df32fca3d0d9cdc8d852865119d91e37b97c218 Mon Sep 17 00:00:00 2001 From: Jon Maddox Date: Mon, 14 Sep 2015 20:20:26 -0400 Subject: [PATCH] add some docs --- platforms/HomeAssistant.js | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/platforms/HomeAssistant.js b/platforms/HomeAssistant.js index 22a3d72..075d90c 100644 --- a/platforms/HomeAssistant.js +++ b/platforms/HomeAssistant.js @@ -7,6 +7,29 @@ // URL: http://home-assistant.io // GitHub: https://github.com/balloob/home-assistant // +// HA accessories supported: Lights, Switches, Media Players. +// +// Media Player Support +// +// Media players on your Home Assistant will be added to your HomeKit as a light. +// While this seems like a hack at first, it's actually quite useful. You can +// turn them on, off, and set their volume (as a function of brightness). +// +// There are some rules to know about how on/off treats your media player. If +// your media player supports play/pause, then turning them on and off via +// HomeKit will play and pause them. If they do not support play/pause but then +// support on/off they will be turned on and then off. +// +// HomeKit does not have a characteristic of Volume or a Speaker type. So we are +// using the light device type here. So to turn your speaker up and down, you +// will need to use the same language you use to set the brighness of a light. +// You can play around with language to see what fits best. +// +// Examples +// +// Dim the Kitchen Speaker to 40% +// Set the brightness of the Kitchen Speaker to 40% +// // Remember to add platform to config.json. Example: // "platforms": [ // {