This repository is intended to include all actions and feeds of Watson IoT Platform.
This package contains different actions in order to interact with Watson Iot Platform through Openwhisk, following is a list of prerequisite:
- Create an instance of Watson IoT Platform service Bluemix Catalog.
- Generate API Key as well as API Authentication Token:
- In the sidebar of Watson IoT Platform dashboard -> Access
- Select API Keys Tab
- Press Generate API Key button
Note: Copy the API key as well as the authentication token as you will not be able to restore the authentication token after closing the window.
| Entity | Type | Parameters | Description |
|---|---|---|---|
/whisk.system/iot |
package | orgId, apiKey, apiToken | Watson IoT Platform Package |
/whisk.system/iot/createDeviceType |
action | see action details | create a new device type |
/whisk.system/iot/deleteDeviceType |
action | see action details | delete a device type |
/whisk.system/iot/registerDevice |
action | see action details | add a new device |
/whisk.system/iot/deleteDevice |
action | see action details | delete a registered device |
/whisk.system/iot/sendEvent |
action | see action details | send device event ( simulating a device) |
/whisk.system/iot/createDeviceType is an action to create a new device type in Watson IoT platform.
| Parameter | Type | Required | Description | Options | Default | Example |
|---|---|---|---|---|---|---|
| apiKey | string | yes | Watson IoT platform API key | - | - | "XXXXX" |
| apiToken | string | yes | Watson IoT platform API authentication token | - | - | "XXXXXXXXX" |
| orgId | string | yes | Watson IoT platform organization ID | - | - | "xvfrw1" |
| typeId | string | yes | Device Type ID | - | - | "sampleType" |
| serialNumber | string | no | The serial number of the device | - | - | "10211002XYZ" |
| manufacturer | string | no | The manufacturer of the device | - | - | "Texas Instruments |
| model | string | no | The model of the device | - | - | "HGI500" |
| deviceClass | string | no | The class of the device | false,true | false | false |
| description | string | no | The descriptive name of the device | - | - | - |
| fwVersion | string | no | The firmware version currently known to be on the device | - | - | "1.0" |
| hwVersion | string | no | The hardware version of the device | - | false | "1.0" |
| descriptiveLocation | string | no | A descriptive location, such as a room or building number, or a geographical region | - | - | "Office 220, building 16" |
| metadata | object | no | Metadata of the device | - | - | {"customField1": "customValue1","customField2": "customValue2"} |
To use this action, you need to pass the required parameters (refer to the table above)
wsk action invoke /whisk.system/iot/createDeviceType -p orgId 'xxxxx' -p apiKey 'yyyyyy' -p apiToken 'zzzzzzzz' -p typeId 'Raspberry_Pi' --blockingorgId, apiKey as well as apiToken parameters can be ignored if it is already passed to the package at binding time.
Example of success response:
{
"classId": "Device",
"createdDateTime": "2016-06-16T10:27:43+00:00",
"deviceInfo": {
},
"id": "Raspberry_Pi",
"updatedDateTime": "2016-06-16T10:27:43+00:00"
}/whisk.system/iot/deleteDeviceType is an action to delete an existing device type in Watson IoT platform.
| Parameter | Type | Required | Description | Options | Default | Example |
|---|---|---|---|---|---|---|
| apiKey | string | yes | Watson IoT platform API key | - | - | "XXXXX" |
| apiToken | string | yes | Watson IoT platform API authentication token | - | - | "XXXXXXXXX" |
| orgId | string | yes | Watson IoT platform organization ID | - | - | "xvfrw1" |
| typeId | string | yes | Device Type ID | - | - | "sampleType" |
To use this action, you need to pass the required parameters (refer to the table above)
wsk action invoke /whisk.system/iot/deleteDeviceType -p orgId 'xxxxx' -p apiKey 'yyyyyy' -p apiToken 'zzzzzzzz' -p typeId 'Raspberry_Pi' --blockingorgId, apiKey as well as apiToken parameters can be ignored if it is already passed to the package at binding time.
Example of success response:
{
"success": "device type deleted",
}/whisk.system/iot/registerDevice is an action to register new device to Watson IoT platform.
| Parameter | Type | Required | Description | Options | Default | Example |
|---|---|---|---|---|---|---|
| apiKey | string | yes | Watson IoT platform API key | - | - | "XXXXX" |
| apiToken | string | yes | Watson IoT platform authonToken | - | - | "XXXXXXXXX" |
| orgId | string | yes | Watson IoT platform organization ID | - | - | "xvfrw1" |
| deviceId | string | yes | Device ID | - | - | "newDevice" |
| typeId | string | yes | Device Type ID | - | - | "sampleType" |
| deviceAuthToken | string | no | Device authentication token, will be generated if not supplied | - | - | "an_unhackable_token" |
| serialNumber | string | no | Serial number of the device | - | - | "10211002XYZ" |
| manufacturer | string | no | Manufacturer of the device | - | - | "Texas Instruments |
| model | string | no | Model of the device | - | - | "HGI500" |
| deviceClass | string | no | Class of the device | false,true | false | false |
| description | string | no | Descriptive name of the device | - | - | - |
| fwVersion | string | no | Firmware version currently known to be on the device | - | - | "1.0" |
| hwVersion | string | no | Hardware version of the device | - | false | "1.0" |
| descriptiveLocation | string | no | A descriptive location, such as a room or building number, or a geographical region | - | - | "Office 220, building 16" |
| long | decimal | no | Longitude in decimal degrees using the WGS84 system | - | - | 9.038550 |
| lat | decimal | no | Latitude in decimal degrees using the WGS84 system | - | - | 48.665390 |
| elev | decimal | no | Elevation in meters using the WGS84 system | - | - | 507 |
| accuracy | decimal | no | Accuracy of the position in meters | false,true | - | 5 |
| measuredDateTime | string | no | Date and time of location measurement (ISO8601) | - | - | "2016-05-19T11:36:42.825Z" |
| metadata | object | no | Metadata of the device | - | - | {"customField1": "customValue1","customField2": "customValue2"} |
To use this action, you need to pass the required parameters (refer to the table above)
wsk action invoke /whisk.system/iot/registerDevice -p orgId 'xxxxx' -p apiKey 'yyyyyy' -p apiToken 'zzzzzzzz' -p typeId 'Raspberry_Pi' -p deviceId "deviceId" --blockingorgId, apiKey as well as apiToken parameters can be ignored if it is already passed to the package at binding time.
Example of success response:
{
"apiToken": "xxxxxxxxx",
"clientId": "d:orgId:Raspberry_Pi:deviceId",
"deviceId": "deviceId",
"deviceInfo": {
},
"refs": {
"diag": {
"errorCodes": "/api/v0002/device/types/Raspberry_Pi/devices/deviceId/diag/errorCodes/",
"logs": "/api/v0002/device/types/Raspberry_Pi/devices/deviceId/diag/logs/"
},
"location": "/api/v0002/device/types/Raspberry_Pi/devices/deviceId/location/"
},
"registration": {
"auth": {
"id": "apiKey",
"type": "app"
},
"date": "2016-06-16T10:46:08.000Z"
},
"status": {
"alert": {
"enabled": false,
"timestamp": "2016-06-16T10:46:08.965Z"
}
},
"typeId": "Raspberry_Pi"
}/whisk.system/iot/deleteDevice is an action to delete a registered device.
| Parameter | Type | Required | Description | Options | Default | Example |
|---|---|---|---|---|---|---|
| apiKey | string | yes | Watson IoT platform API key | - | - | "XXXXX" |
| apiToken | string | yes | Watson IoT platform authonToken | - | - | "XXXXXXXXX" |
| orgId | string | yes | Watson IoT platform organization ID | - | - | "xvfrw1" |
| deviceId | string | yes | Device ID | - | - | "newDevice" |
| typeId | string | yes | Device Type ID | - | - | "sampleType" |
wsk action invoke /whisk.system/iot/deleteDevice -p orgId 'xxxxxxxx' -p apiKey 'yyyyyyyy' -p apiToken 'zzzzzz' -p typeId 'Raspberry_Pi' -p deviceId "deviceId" --blocking
orgId, apiKey as well as apiToken parameters can be ignored if it is already passed to the package at binding time.
Example of success response:
{
"success": "device deleted"
}/whisk.system/iot/sendEvent is an action to send events on behalf of a device ( simulating a device).
| Parameter | Type | Required | Description | Options | Default | Example |
|---|---|---|---|---|---|---|
| apiKey | string | yes | Watson IoT platform API key | - | - | "XXXXX" |
| apiToken | string | yes | Watson IoT platform authonToken | - | - | "XXXXXXXXX" |
| orgId | string | yes | Watson IoT platform organization ID | - | - | "xvfrw1" |
| deviceId | string | yes | Device ID | - | - | "newDevice" |
| typeId | string | yes | Device Type ID | - | - | "sampleType" |
| eventName | string | yes | Event name | - | - | "temperature" |
| eventBody | string | yes | Event Data | - | - | "{'temperature':'42'}" |
wsk action invoke /whisk.system/iot/deleteDevice -p orgId 'xxxxx' -p apiKey 'yyyyyyyyy' -p apiToken 'zzzzzzz' -p typeId 'sampleiot' -p deviceId "TareqDevice44" --blockingorgId, apiKey as well as apiToken parameters can be ignored if it is already passed to the package at binding time.
Example of success response:
{
"success": "event is sent"
}This package contains an install script that will create a package and add the actions into it :
git clone https://github.com/tareqmamari/openwhisk-package-iot
cd openwhisk-package-iot
./install.sh <apihost> <authkey> <pathtowskcli>Where apihost: host of openwhisk, authkey: Authentication key ( e.g. $(cat $OPENWHISK_HOME/config/keys/auth.whisk.system) for whisk.system authentication key), pathtowskcli: path of Openwhisk CLI (e.g. $OPENWHISK_HOME/bin/wsk).
Note: To uninstall the package please use ./uninstall $API_HOST $AUTH_KEY $WSK