|
2 | 2 | "pluginAlias": "Alexa", |
3 | 3 | "pluginType": "platform", |
4 | 4 | "singular": true, |
5 | | - "headerDisplay": "<h1><p align='center'>Allow your Amazon Alexa to control your homebridge devices</H1></p><h1><p align='center'> <img width='18%' src='https://user-images.githubusercontent.com/19808920/210089307-7622bb91-49d0-4d90-b2c3-31118e1a76c0.png'><b> => </b><img width='20%' src='https://user-images.githubusercontent.com/19808920/210090318-9e8ddc2a-a025-40ac-9718-7b5a2aa9a518.png'></p></h1> <br>To setup the service:<br>1 - First <b>create</b> an account on <a href='https://www.homebridge.ca/'>https://www.homebridge.ca/</a>. <br>2 - Then <b>enter</b> the username and password for your account <b>below</b>. <br>3 - <b>Save</b> the settings and <b>restart</b> homebridge. <br>4 - In the Amazon Alexa Application on your smart phone, <b>search</b> for the Homebridge Skill and enable it. When you enable the skill, it will take you to the <b>https://www.homebridge.ca/</b> website to <b>enable</b> and link the skill to the plugin. <br>5 - You can now ask Alexa to <b>`discover devices`</b> and it should discover your homebridge devices.<br><br>Detailed setup instructions are available <a href='https://github.com/NorthernMan54/homebridge-alexa/blob/master/Installation.md#setup-instructions'>here</a>.", |
| 5 | + "headerDisplay": "<h1><p align='center'>Allow your Amazon Alexa to control your homebridge devices</H1></p><h1><p align='center'><img src='https://raw.githubusercontent.com/NorthernMan54/homebridge-alexa/main/docs/README_Image.001.jpeg' width='80%' style='vertical-align:middle'></p></h1> <br><b>To setup the service:</b><br><br>1 - First <b>create</b> an account on <a href='https://www.homebridge.ca/'>https://www.homebridge.ca/</a>. <br>2 - Then <b>enter</b> the username and password for your account <b>below</b>. <br>3 - <b>Save</b> the settings and <b>restart</b> homebridge. <br>4 - In the Amazon Alexa Application on your smart phone, <b>search</b> for the Homebridge Skill and enable it. When you enable the skill, it will take you to the <b>https://www.homebridge.ca/</b> website to <b>enable</b> and link the skill to the plugin. <br>5 - You can now ask Alexa to <b>`discover devices`</b> and it should discover your homebridge devices.<br><br>Detailed setup instructions are available <a href='https://github.com/NorthernMan54/homebridge-alexa/blob/master/Installation.md#setup-instructions'>here</a>.<br>", |
6 | 6 | "footerDisplay": "Homebridge Alexa Skill: https://www.amazon.com/Northern-Man-54-Homebridge/dp/B07B9QMTFQ", |
7 | 7 | "schema": { |
8 | 8 | "type": "object", |
9 | 9 | "properties": { |
10 | 10 | "name": { |
11 | | - "title": "Name", |
| 11 | + "title": "<b>Name</b>", |
12 | 12 | "type": "string", |
13 | 13 | "required": true, |
14 | 14 | "default": "Alexa", |
15 | 15 | "description": "Plugin name as displayed in the Homebridge log" |
16 | 16 | }, |
17 | 17 | "username": { |
18 | | - "title": "Username", |
| 18 | + "title": "<b>Username</b>", |
19 | 19 | "type": "string", |
20 | 20 | "required": true, |
21 | 21 | "description": "Username for https://www.homebridge.ca/" |
22 | 22 | }, |
23 | 23 | "password": { |
24 | | - "title": "Password", |
| 24 | + "title": "<b>Password</b>", |
25 | 25 | "type": "string", |
26 | 26 | "required": true, |
27 | 27 | "description": "Password for https://www.homebridge.ca/" |
28 | 28 | }, |
29 | 29 | "pin": { |
30 | | - "title": "Homebridge Pin", |
| 30 | + "title": "<b>Homebridge Pin</b>", |
31 | 31 | "type": "string", |
32 | 32 | "placeholder": "031-45-154", |
33 | 33 | "description": "This needs to match the Homebridge pin set in your config.json file" |
34 | 34 | }, |
35 | 35 | "routines": { |
36 | | - "title": " Routines - enables passing of Motion and Contact sensor events to Alexa. For use in the Alexa app to create Routines triggered by these sensors.", |
| 36 | + "title": "<b>Routines</b>", |
37 | 37 | "type": "boolean", |
38 | | - "placeholder": false |
| 38 | + "placeholder": false, |
| 39 | + "description": "Enables passing of Motion and Contact sensor events to Alexa. For use in the Alexa app to create Routines triggered by these sensors." |
39 | 40 | }, |
40 | 41 | "blind": { |
41 | | - "title": "Enables natural wording for opening and closing blinds, and window coverings. Not supported in all countries. Defaults to false", |
| 42 | + "title": "<b>Blind</b>", |
42 | 43 | "type": "boolean", |
43 | | - "placeholder": false |
| 44 | + "placeholder": false, |
| 45 | + "description": "Enables natural wording for opening and closing blinds, and window coverings. Not supported in all countries. Defaults to false" |
44 | 46 | }, |
45 | 47 | "door": { |
46 | | - "title": "Enables natural wording for opening and closing garage doors. Not supported in all countries. Please note that opening a garage door requires setting a voice pin within the Alexa app. Defaults to false", |
| 48 | + "title": "<b>Door</b>", |
47 | 49 | "type": "boolean", |
48 | | - "placeholder": false |
| 50 | + "placeholder": false, |
| 51 | + "description": "Enables natural wording for opening and closing garage doors. Not supported in all countries. Please note that opening a garage door requires setting a voice pin within the Alexa app. Defaults to false" |
49 | 52 | }, |
50 | 53 | "debug": { |
51 | | - "title": "Enable debug level logging to assist in problem investigation", |
| 54 | + "title": "<b>Debug</b>", |
52 | 55 | "type": "boolean", |
53 | | - "placeholder": false |
| 56 | + "placeholder": false, |
| 57 | + "description": "Enable debug level logging to assist in problem investigation." |
| 58 | + }, |
| 59 | + "beta": { |
| 60 | + "title": "<b>beta</b>", |
| 61 | + "type": "boolean", |
| 62 | + "placeholder": false, |
| 63 | + "description": "Enable beta test environment. Only available by invitation." |
54 | 64 | }, |
55 | 65 | "refresh": { |
56 | | - "title": "Accessory Cache Refresh Interval", |
| 66 | + "title": "<b>Accessory Cache Refresh Interval</b>", |
57 | 67 | "type": "integer", |
58 | 68 | "default": 900, |
59 | 69 | "description": "Frequency of refreshes of the homebridge accessory cache, in seconds. Defaults to 900 Seconds ( 15 minutes ). This is the interval before new devices/homebridge instances are discovered. This should never require changing, unless you are frequently changing your homebridge configuration without restarting the plugin.", |
60 | 70 | "minimum": 120, |
61 | 71 | "maximum": 86400 |
62 | 72 | }, |
63 | 73 | "keepalive": { |
64 | | - "title": "Cloud Server Connection Keepalive", |
| 74 | + "title": "<b>Cloud Server Connection Keepalive</b>", |
65 | 75 | "type": "integer", |
66 | 76 | "default": "5", |
67 | 77 | "description": "Frequency of keepalive messages to cloud server, in minutes. Defaults to 5 minutes. Do not change from default unless requested as part of problem investigation.", |
|
72 | 82 | } |
73 | 83 | }, |
74 | 84 | "mergeServiceName": { |
75 | | - "title": "Alternate device naming approach", |
| 85 | + "title": "<b>Alternate device naming approach</b>", |
76 | 86 | "type": "boolean", |
77 | 87 | "description": "This is an alternate device naming approach, which combines the internal HomeKit names for a device. It may resolve duplicate device name issues. Do not enable on an existing implementation, as you will lose control of your existing devices.", |
78 | 88 | "placeholder": false |
79 | 89 | }, |
| 90 | + "thermostatTurnOn": { |
| 91 | + "title": "<b>Thermostat Turn On Behaviour</b>", |
| 92 | + "description": "Set Thermostat `Turn On` Behaviour to either Heat, Cool or Auto when Alexa is asked to turn on a Thermostat. Defaults to doing nothing and saying `That command does not work on device ...`.", |
| 93 | + "type": "integer", |
| 94 | + "oneOf": [ |
| 95 | + { |
| 96 | + "title": "Heat", |
| 97 | + "enum": [ |
| 98 | + 1 |
| 99 | + ] |
| 100 | + }, |
| 101 | + { |
| 102 | + "title": "Cool", |
| 103 | + "enum": [ |
| 104 | + 2 |
| 105 | + ] |
| 106 | + }, |
| 107 | + { |
| 108 | + "title": "Auto", |
| 109 | + "enum": [ |
| 110 | + 3 |
| 111 | + ] |
| 112 | + } |
| 113 | + ] |
| 114 | + }, |
80 | 115 | "CloudTransport": { |
81 | | - "title": "Cloud Server Connection Transport", |
| 116 | + "title": "<b>Cloud Server Connection Transport</b>", |
82 | 117 | "description": "Transport options for cloud server connection. MQTTS - this is the recommended setting. MQTT - this is the original/legacy option. WSS - this is the an alternative transport option.", |
83 | 118 | "type": "string", |
84 | 119 | "default": "mqtts", |
|
105 | 140 | ] |
106 | 141 | }, |
107 | 142 | "filter": { |
108 | | - "title": "Homebridge Instance Filter", |
| 143 | + "title": "<b>Homebridge Instance Filter</b>", |
109 | 144 | "type": "string", |
110 | 145 | "placeholder": "eg. 192.168.1.122:51826", |
111 | | - "description": "Limits accessories shared with Alexa to a single homebridge instance.", |
| 146 | + "description": "Limits accessories shared with Alexa to a single homebridge instance. Uses ip address and port of homebridge instance.", |
112 | 147 | "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$" |
113 | 148 | }, |
114 | 149 | "deviceListHandling": { |
115 | | - "title": "<b>Filtering of devices by name, either allow or ignore.</b>", |
| 150 | + "title": "<b>Device List</b>", |
116 | 151 | "type": "string", |
| 152 | + "description": "Allows filtering of devices by name. You can either allow or ignore a list of device names.", |
117 | 153 | "default": "none", |
118 | 154 | "required": true, |
119 | 155 | "oneOf": [ |
|
144 | 180 | "type": "string" |
145 | 181 | }, |
146 | 182 | "condition": { |
147 | | - "functionBody": "return model.deviceListHandling !== 'null';" |
| 183 | + "functionBody": "if (model.deviceListHandling === 'allow' || model.deviceListHandling === 'deny') { return true } else { return false };" |
148 | 184 | } |
149 | 185 | }, |
150 | 186 | "combine": { |
|
214 | 250 | "pin", |
215 | 251 | "routines", |
216 | 252 | "debug", |
| 253 | + "thermostatTurnOn", |
217 | 254 | "deviceListHandling", |
218 | 255 | { |
219 | 256 | "key": "deviceList", |
|
239 | 276 | "keepalive", |
240 | 277 | "refresh", |
241 | 278 | "filter", |
242 | | - "mergeServiceName" |
| 279 | + "mergeServiceName", |
| 280 | + "blind", |
| 281 | + "door" |
243 | 282 | ] |
244 | 283 | }, |
245 | 284 | { |
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments