Documentation Todo-List / Changelog Dedicated Forum Beta-testing cat

Presentation of the plugin

Plugin that complements Alexa’s possibilities by bringing the link with the products in the range Amazon smartHome.

All equipment detected by the Alexa application must be able to be detected and reassembled in Jeedom.

Gradually, developers integrate the possible types and commands. Not all equipment is available yet, use the Community Forum to engage with the community.

The TODOList and ChangeLog are the subject of a special page.

Compatible equipment

All devices compatible with Amazon smartHome are compatible with the plugin.

They will all be detected, the list is here
Some examples are given in the rest of the documentation.

If you only want of Amazon products, you can consult this page.

Orders for each type of module are integrated gradually, as each module is purchased/tested.

State returns are not working yet as we have not yet found how to get the information. Thus, if you start a change in the state of a lamp, you will have a change in the value of the widget, but be careful, it is only based on the action that has just been performed and not on a validation of the module. (This is therefore not a return of state)

As a temporary solution to the absence of a status return, a CRON is provided to launch a refresh and recover the status of the devices returned to us by the Amazon server. This is sufficient for most devices, but is not suitable for e.g. presence detection.

Consult the ChangeLog to see the evolution of module detection. If you have a special need, do not hesitate to meet the development team and the beta testers on The Slack.

Installing the Alexa-smartHome Plugin

Very important, Alexa-AmazonMusic needs the Alexa-API plugin (free) to talk to your Alexa:

Step 1: Install the Alexa-API plugin

Step 2: Install the Alexa-smartHome Plugin

from the Market, category Connected objects or by typing its name in the search field

Note on the versions:

You have the choice between the version Stable or version beta.

Many new features are always more present on the Beta than on the Stable but they are in test.

If you are a gamer and curious, you can install the Beta version.

Note: You do not need to install Jeedom en Beta (this is not recommended for that matter) to install the Beta plugin.

You can switch from a Beta version to a Stable version quite easily and vice versa, just reinstall over the other version.

Step 3: Activate Plugin

 

Step 4: Go back to the Alexa-API plugin

Step 5: Relaunching the SCAN

SmartHome devices will be generated automatically

Go to Alexa-smartHome to view them

Update or Change Version (from Beta to Stable or from Stable to Beta)

What to do?

Since the plugin and its API are alive (Amazon has not documented the API and allows it to change its protocols over time), updates make it possible to make corrections in the links between the plugin and the Amazon server.

Please note that it is always advisable to update Alexa-API when updating multimedia plugins (Alexa-AmazonMusic, Alexa-Deezer, Alexa-Spotify or Alexa-smartHome)

Two solutions to have an operational installation:

• Remove all Amazon devices and their orders and recreate them
• Force update of all commands
• Launch a SCAN that detects new equipment or commands

The choice between these three solutions depends on the number of scenarios you have developed thanks to them. Indeed, the first solution removes all devices and all commands, so it will delete these in your scenarios. The second solution is more respectful of your scenarios because it will update your orders without removing them and therefore your scenarios will be intact.

Solution 1: Remove all equipment and their controls and recreate them

This is the most important mode clean and the most optimised since you leave with an installation like new devices and their commands.

To do so, use the button (in the configuration screen of the Alexa-API plugin)

Attention, this function removes all equipment and their commands, so you lose all links in your scenarios.

Solution 2: Force update of all commands

This is the most important mode simple and risk-free since your equipment and their orders are not deleted. This forcing therefore does not impact your scenarios.

To do this, you have to use the button 

If you do not want to start the update forcing on all the Orders of all equipment, you can launch it on a single equipment (and therefore on all its orders). To do so, go to the equipment concerned and click on:

Solution 3: The SCAN

Finally, note that the scan can be launched at any time, it does not impact the equipment already detected or the existing commands, but it recreates all the new Devices or Devices removed. It also recreates all the news orders or orders deleted.

Searches for "actions" commands

"Actions" commands are being detected by the developer and beta testers.

To do this, this section will serve as a documentary base to try to find the commands to send to the devices.

Alexa.BrightnessController Interface

The documentation of the skill (indicative) indicates:

{
  "Directive": {
    "header": {
      "namespace": "Alexa.BrightnessController",
      "name": "SetBrightness",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "<an OAuth2 bearer token>"
      },
      "endpointId": "<endpoint id>",
      "cookie": {}
    },
    "payload": {
      "brightness": 50
    }
  }
}

The order to be sent will be SmarthomeCommand?command=setBrightness&brightness=50

Alexa.PowerController Interface

The documentation of the skill (indicative) indicates:

{
  "Directive": {
    "header": {
      "namespace": "Alexa.PowerController",
      "name": "TurnOn",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "<an OAuth2 bearer token>"
      },
      "endpointId": "<endpoint id>",
      "cookie": {}
    },
    "payload": {}
  }
}

The order to be sent will be SmarthomeCommand?command=turnOn

Alexa.ColorController Interface

The documentation of the skill (indicative) indicates:

{
  "Directive": {
    "header": {
      "namespace": "Alexa.ColorController",
      "name": "SetColor",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "<an OAuth2 bearer token>"
      },
      "endpointId": "<endpoint id>",
      "cookie": {}
    },
    "payload": {
      "color": {
        "hue": 350.5,
        "saturation": 0.7138,
        "brightness": 0.6524
      }
    }
  }
}

The order to be sent will be SmarthomeCommand?command=setColor&color=green

List of orders

List of commands given on this page

Supported actions are:

• decrementPercentage
• decrementTargetTemperature
• getLockState
• getTargetTemperature
• getTemperatureReading
• incrementPercentage
• incrementTargetTemperature
• setLockState
• getLockState
• setPercentage
• setTargetTemperature
• turnOff
• turnOn

We keep looking for the other … commands Thank you for posting your information on the Forum!!