Plugin documentation¶
Last change¶
Purpose¶
This Domogik plugin XeeDevices allow user to see informations from xee API (Car/Car.status).
You Need to create a Xee dev account here https://dev.xee.com/register and create an apps.
In redirect url don’t forget to put http://localhost and for Scopes select all.
Here is an the related docs from xee apidoc: https://dev.xee.com/doc/setup/README.html
Save your apps Id and Secret. You will need them later to configure the plugin.
Plugin configuration¶
Configuration¶
In Domogik administration section, go to client plugin-xeedevice details page.
| Key | Default value | Description |
|---|---|---|
| startup-plugin | false | Automatically start plugin at Domogik startup |
| client_id | Your Xee dev client-id | |
| client_secret | Your Xee dev client-secret | |
| redirect_url | http://localhost | Your Xee dev redirect_url |
| period | 300 | Refresh period from Xee API platform in seconds |
Generating token from admin page¶
Once you have saved your credentails in Configuration go to the Advanced page to generate a token file.
In section “Generating a Code for Token” open th proposed link in a new tab to get the code from url after you validate the needed autorisation.
Paste the code in the input and clic on genrate token file.
Creating devices for xee device¶
In clients page of admin UI, go to plugin-xeedevice-<your_host_domogik>, select tab “Devices”, “New” to create your devices.
Chose one way creation by product or device type.
device_types : xee.information¶
| Key | Example | Description |
|---|---|---|
| Device name | my Car | The display name for this device. |
| Description | What you want | A short description for this device. |
| Reference | What you want | A Reference for this device. |
| carid | 10000 | Id of a car from you xee account. See advanced page to get all Car Id |
device_types : xee.status¶
| Key | Example | Description |
|---|---|---|
| Device | Car status | The display name for this device. |
| Description | What you want | A short description for this device. |
| Reference | What you want | A Reference for this device. |
| carid | 10000 | Should be the id of a car from you xee account |