Plugin documentation¶
Last change¶
Purpose¶
This Domogik plugin WithingDevices allow user to see informations from withing API (user/measures).
You Need to create a withing dev account here https://oauth.withings.com/partner/add and create an application.
Save your Api key and Api 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 |
| api key | Your Application api_key | |
| api secret | Your Application api_secret | |
| 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 withing device¶
In clients page of admin UI, go to plugin-withingdevice-<your_host_domogik>, select tab “Devices”, “New” to create your devices.
Chose one way creation by product or device type.
device_types : withing.user¶
| Key | Example | Description |
|---|---|---|
| Device name | USer one | 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. |
| userid | 10000 | Id of a user from you withing. See advanced page to get User Id |
device_types : withing.measure¶
| Key | Example | Description |
|---|---|---|
| Device name | User one measure | 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. |
| userid | 10000 | Id of a user from you withing. See advanced page to get User Id |