Skip to main content

Alexa Skill and GVA Action Templates

This section provides templates for commonly required fields for Alexa and Google Voice Assistant (GVA).

note

The following templates are specific to the RainMaker Alexa skill and GVA action. They can be used as references when creating similar configurations for your own Alexa skill and GVA action.

You should replace instances of:

  • "ESP RainMaker" to your product name.
  • "switch" and "lightbulb" devices to your product types.
  • ESP RainMaker website URL to your product's website URL.
  • ESP RainMaker Privacy Policy URL to your product's privacy URL.
  • ESP RainMaker terms of use URL to your product's terms of use URL.
  • Control commands to the control commands supported by your device, e.g., "Alexa, turn on the boiler switch" -> "Alexa, turn on the AC".
  • If the step for provisioning the device are different from steps for provisioning RainMaker URL, update description accordingly.

Alexa Skill​

One-line description​

Control your ESP RainMaker-based Smart Home devices using this skill.

Detailed description​

Connect Alexa to your RainMaker-based devices by following these steps:

  1. Implement a standard switch or lightbulb device by following the instructions on https://rainmaker.espressif.com/.
  2. Download the ESP RainMaker Android or iOS app.
  3. Sign in using any of the third-party sign-in options provided or sign-up using your email address.
  4. Provision the device by scanning its unique QR code.
  5. Once provisioning is successful, the device will connect to the internet through your Wi-Fi router and get associated to the signed-in user.
  6. Give some user-friendly name to your device. This name will show up in Alexa.
  7. In the Alexa app, search for the "ESP RainMaker" skill.
  8. Click Enable skill and sign in using the same credentials you used in the ESP RainMaker app.
  9. Once the linking is successful, allow Alexa to discover your devices.
  10. Once the devices are discovered, the setup is complete. You can now start controlling them using Alexa.

Following controls are supported:

  1. Switch Controls
  • "Alexa, turn on the boiler switch"
  • "Alexa, turn off the boiler switch"
  1. Light controls
  • "Alexa, turn on the kitchen light"
  • "Alexa, turn off the kitchen light"
  • "Alexa, set the kitchen light to 50 percent"
  1. Light color controls
  • "Alexa, set kitchen light to red"
  • "Alexa, set kitchen light to green"

If you have any queries, please contact us at esp-rainmaker-admin@espressif.com.

Testing Instructions Template​

To learn more about RainMaker, visit https://rainmaker.espressif.com.

Prerequisites:

  • Our framework links users with their nodes, which can currently be controlled via the mobile app.
  • We are extending this functionality to support voice assistants such as Alexa.

Steps to follow:

  1. An account has been created for your team in our system.
    • Username: <ACCOUNT_USER_NAME>
    • Password: <ACCOUNT_PASSWORD>
  2. Enable the skill and log in with the above credentials. Device discovery will begin.
  3. Some test devices have been pre-configured under this account. Once discovered, they will appear on your Devices page.
  4. These devices can now be controlled through Alexa (The device name configured is Boiler Switch).
  5. You can control them via:
    • The Devices page in the app
    • Voice commands in the app
    • Echo devices, using the device name

If you need any further assistance or run into any issues, feel free to contact us.

Google Action​

Short description​

Control your ESP RainMaker-based Smart Home devices using this action.

Detailed Description​

Connect Google Smart Home Actions to your RainMaker-based devices by following these steps:

  1. Implement a standard switch or lightbulb device by following the instructions on https://rainmaker.espressif.com/.
  2. Download the ESP RainMaker Android or iOS app.
  3. Sign in using any of the third-party sign-in options provided or sign-up using your email address.
  4. Provision the device by scanning its unique QR code.
  5. Once provisioning is successful, the device will connect to the Internet through your Wi-Fi router and get associated with the signed-in user.
  6. Give some user-friendly name to your device. This name will show up in Google Assistant.
  7. In the Google Assistant, search for the "ESP RainMaker" action.
  8. Sign in the Google Action using the same credentials you used in the ESP RainMaker app.
  9. Once the linking is successful, allow Google Home App to discover your devices.
  10. Once the devices are discovered, the setup is complete. You can now start controlling them using Google Home App.

Following controls are supported:

  1. Switch Controls
  • "Hey Google, turn on the boiler switch"
  • "Hey Google, turn off the boiler switch"
  1. Light controls
  • "Ok Google, turn on the kitchen light"
  • "Ok Google, turn off the kitchen light"
  • "Ok Google, set the kitchen light to 50 percent"
  1. Light color controls
  • "Ok Google, set kitchen light to red"
  • "Ok Google, set kitchen light to green"

If you have any queries, please contact us at esp-rainmaker-admin@espressif.com.

Testing Instructions Template​

To learn more about RainMaker, visit https://rainmaker.espressif.com.

Prerequisites:

  • Our framework links users with their nodes, which can currently be controlled via the mobile app.
  • We are extending this functionality to support voice assistants such as Google Assistant.

Steps to follow:

  1. An account has been created for your team in our system.
    • Username: <ACCOUNT_USER_NAME>
    • Password: <ACCOUNT_PASSWORD>
  2. Enable the Google action and log in with the above credentials. Device discovery will begin.
  3. Some test devices have been pre-configured under this account. You can see devices added in your Google Assistant.
  4. You can now control these devices through Google Assistant (The name we have configured is Boiler Switch).
  5. You can control them via:
    • Google Home app
    • Voice commands in the app
    • Google Assistant devices with the device name

If you need any further assistance or run into any issues, feel free to contact us.

Common​

You can create privacy policy and terms of use URLs for your product, taking reference from below.

Privacy Policy URL​

https://rainmaker.espressif.com/docs/privacy-policy.html

Terms of Use URL​

https://rainmaker.espressif.com/docs/terms-of-use.html

On this page