Skip to content

Commit 7c985c1

Browse files
csuermanncsuermann
committed
fix(readme): add FAQ on PRO plan
1 parent 9a9dd48 commit 7c985c1

1 file changed

Lines changed: 52 additions & 39 deletions

File tree

‎readme.md‎

Lines changed: 52 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ I dedicated endless hours to this project and really hope it adds value for you!
109109
- mention this package in your next blog post / podcast / YouTube
110110
- say thank you by [buying me a coffee](https://paypal.me/cornelius/5).
111111

112-
__THANK YOU!__
112+
**THANK YOU!**
113113

114114
## Changelog
115115

@@ -129,74 +129,87 @@ The "Free" plan will be limited to 7 virtual devices.
129129

130130
## FAQ
131131

132-
1. Q: Which voice commands can I use to control my devices with Alexa?
132+
1. Q: Which voice commands can I use to control my devices with Alexa?
133133

134-
A: Take a look at the [example flows](https://github.com/csuermann/node-red-contrib-virtual-smart-home/tree/master/examples) which you can import from the Node-RED import menu (Import > Examples > node-red-contrib-virtual-smart-home).
134+
A: Take a look at the [example flows](https://github.com/csuermann/node-red-contrib-virtual-smart-home/tree/master/examples) which you can import from the Node-RED import menu (Import > Examples > node-red-contrib-virtual-smart-home).
135135

136-
Here are some of the most often used commands:
137-
- Alexa, switch on / off DEVICE-NAME
138-
- Alexa, set DEVICE-NAME to X percent
139-
- Alexa, set DEVICE-NAME to Warm white / Soft white / Daylight white / Cool white / Red / Crimson / Salmon / Orange / Gold / Yellow / Green / Turquoise / Cyan / Sky blue / Blue / Purple / Magenta / Pink / Lavendar
140-
- Alexa, open / close DEVICE-NAME
136+
Here are some of the most often used commands:
141137

142-
1. Q: How can I control devices in a specific room?
138+
- Alexa, switch on / off DEVICE-NAME
139+
- Alexa, set DEVICE-NAME to X percent
140+
- Alexa, set DEVICE-NAME to Warm white / Soft white / Daylight white / Cool white / Red / Crimson / Salmon / Orange / Gold / Yellow / Green / Turquoise / Cyan / Sky blue / Blue / Purple / Magenta / Pink / Lavendar
141+
- Alexa, open / close DEVICE-NAME
143142

144-
A: You can create rooms in the Alexa app and assign your devices to them. Create a room which groups together an Alexa device (e.g. Echo) and some virtual lights. You can then control all those lights simply by speaking "Alexa, switch off the light" into the Alexa device.
143+
1. Q: How can I control devices in a specific room?
145144

146-
1. Q: Why do my devices suddenly fail to connect and show up as 'offline'?
145+
A: You can create rooms in the Alexa app and assign your devices to them. Create a room which groups together an Alexa device (e.g. Echo) and some virtual lights. You can then control all those lights simply by speaking "Alexa, switch off the light" into the Alexa device.
147146

148-
A: If your device was not connected to the VSH backend for more than 30 days its certificate will be revoked. You can fix that by deleting the old connection, creating a new one and linking your virtual devices to the new one. All your devices should then get re-discovered by Alexa.
147+
1. Q: Why do my devices suddenly fail to connect and show up as 'offline'?
149148

150-
Another reason could be that you are using an outdated version of VSH. Please update to the latest version (e.g using the Node-RED palette manager).
149+
A: If your device was not connected to the VSH backend for more than 30 days its certificate will be revoked. You can fix that by deleting the old connection, creating a new one and linking your virtual devices to the new one. All your devices should then get re-discovered by Alexa.
151150

152-
1. Q: Why do some of my devices show up as duplicates in the Alexa app?
151+
Another reason could be that you are using an outdated version of VSH. Please update to the latest version (e.g using the Node-RED palette manager).
153152

154-
A: Your duplicate devices might belong to a vsh-connection that no longer exists. You can delete them manually on the connection page where they probably show up with a shaded background, indicating they belong to another vsh-connection.
153+
1. Q: Why do some of my devices show up as duplicates in the Alexa app?
155154

156-
1. Q: I deleted a virtual device but Alexa keeps rediscovering it!
155+
A: Your duplicate devices might belong to a vsh-connection that no longer exists. You can delete them manually on the connection page where they probably show up with a shaded background, indicating they belong to another vsh-connection.
157156

158-
A: You probably deleted the device in the Alexa app instead of Node-RED. Open the connection page which lists all known devices and click the trash icon next to the device you want to delete.
157+
1. Q: I deleted a virtual device but Alexa keeps rediscovering it!
159158

160-
1. Q: Why does VSH not work offline?
159+
A: You probably deleted the device in the Alexa app instead of Node-RED. Open the connection page which lists all known devices and click the trash icon next to the device you want to delete.
161160

162-
A: Alexa lives in the cloud. When you ask Alexa to control one of your devices, your voice is sent to Amazon servers for processing. Amazon's servers then try to make sense of what you said and which skill to invoke. If you said "Alexa, dim the kitchen light to fifty percent!", Alexa will realize that 'kitchen light' belongs to the VSH skill and invoke the VSH backend with a 'directive' containing the command that was understood (e.g. 'SetBrightness'). The VSH skill backend then sends a message to your connected virtual device which triggers an outgoing msg object with the device state for you to make use of. This requires your VSH devices to be online.
161+
1. Q: Why does VSH not work offline?
163162

164-
1. Q: What do you do with my data?
163+
A: Alexa lives in the cloud. When you ask Alexa to control one of your devices, your voice is sent to Amazon servers for processing. Amazon's servers then try to make sense of what you said and which skill to invoke. If you said "Alexa, dim the kitchen light to fifty percent!", Alexa will realize that 'kitchen light' belongs to the VSH skill and invoke the VSH backend with a 'directive' containing the command that was understood (e.g. 'SetBrightness'). The VSH skill backend then sends a message to your connected virtual device which triggers an outgoing msg object with the device state for you to make use of. This requires your VSH devices to be online.
165164

166-
A: The VSH backend only stores metadata about your configured devices needed for VSH to function and your basic profile information provided by Amazon when you enabled the skill. Neither your Amazon password nor your voice prompts or your location is ever shared with VSH. I also have no interest in analyzing your usage patterns although this _would technically_ be possible.
165+
1. Q: What do you do with my data?
167166

168-
1. Q: Where can I see what data is being sent to / received from the backend?
167+
A: The VSH backend only stores metadata about your configured devices needed for VSH to function and your basic profile information provided by Amazon when you enabled the skill. Neither your Amazon password nor your voice prompts or your location is ever shared with VSH. I also have no interest in analyzing your usage patterns although this _would technically_ be possible.
169168

170-
A: Activate the `Debug` option on the connection page and observe the output logged to stdout.
169+
1. Q: Where can I see what data is being sent to / received from the backend?
171170

172-
1. Q: Can I run my own backend?
171+
A: Activate the `Debug` option on the connection page and observe the output logged to stdout.
173172

174-
A: Yes! Check out the [backend repository](https://github.com/csuermann/virtual-smart-home/) and follow the instructions precisely. Keep in mind that it might be cheaper to keep using the official backend and donate some money so that I can keep the system up for you.
173+
1. Q: Can I run my own backend?
175174

176-
1. Q: Is there a way to persist the state of devices across restarts of Node-RED?
175+
A: Yes! Check out the [backend repository](https://github.com/csuermann/virtual-smart-home/) and follow the instructions precisely. Keep in mind that it might be cheaper to keep using the official backend and donate some money so that I can keep the system up for you.
177176

178-
A: Yes! The device state is stored as 'context' provided by Node-RED, which is kept in memory by default. You can easily change that by adding this snippet to your Node-RED's settings.js file:
177+
1. Q: Is there a way to persist the state of devices across restarts of Node-RED?
179178

180-
```javascript
181-
contextStorage: {
182-
default: {
183-
module: "localfilesystem",
184-
},
185-
},
186-
```
179+
A: Yes! The device state is stored as 'context' provided by Node-RED, which is kept in memory by default. You can easily change that by adding this snippet to your Node-RED's settings.js file:
187180

188-
1. Q: Can you add feature X, please?
181+
```javascript
182+
contextStorage: {
183+
default: {
184+
module: "localfilesystem",
185+
},
186+
},
187+
```
189188

190-
A: I'm always eager to hear your ideas! Please [file a ticket](https://github.com/csuermann/node-red-contrib-virtual-smart-home/issues/new).
189+
1. Q: In which way is the FREE plan limited?
191190

192-
1. Q: Where can I ask a question that hasn't been addressed yet?
191+
A: While you can use the FREE plan free of charge for as long as you want, it is currently limited to 7 virtual devices and doesn't support retrieving device state by Alexa, e.g. commands like "Alexa, what's the temperature in the living room" will fail.
193192

194-
A: Check out [existing issues](https://github.com/csuermann/node-red-contrib-virtual-smart-home/issues) on GitHub or [file a new ticket](https://github.com/csuermann/node-red-contrib-virtual-smart-home/issues/new).
193+
1. Q: Why did a paid PRO plan get introduced?
194+
195+
A: With growing popularity of VSH the infrastructure costs also grew significantly. I had to make a decision to either shut VSH down or to introduce a paid plan. For 12 EUR per year, you can deploy up to 200 virtual devices and support further development of VSH.
196+
197+
1. Q: Where can I manage my VSH subscription?
198+
199+
A: Click the 'manage subscription' button on the vsh-connection page in Node-RED or manually log into the [Stripe dashboard](https://billing.stripe.com/p/login/6oE00vdQ62Tp3LidQQ).
200+
201+
1. Q: Can you add feature X, please?
202+
203+
A: I'm always eager to hear your ideas! Please [file a ticket](https://github.com/csuermann/node-red-contrib-virtual-smart-home/issues/new).
204+
205+
1. Q: Where can I ask a question that hasn't been addressed yet?
206+
207+
A: Check out [existing issues](https://github.com/csuermann/node-red-contrib-virtual-smart-home/issues) on GitHub or [file a new ticket](https://github.com/csuermann/node-red-contrib-virtual-smart-home/issues/new).
195208

196209
## Terms of Use
197210

198211
This package comes without any warranty. Use it, enjoy it, but all at your own
199-
risk. If you are satisfied with this project, consider [bying me a coffee](https://paypal.me/cornelius/5). Thank you!
212+
risk. If you are satisfied with this project, consider upgrading to the PRO plan or [bying me a coffee](https://paypal.me/cornelius/5). Thank you!
200213

201214
### NOTE
202215

0 commit comments

Comments
 (0)