Getting Started Edit
Welcome to our API page.
This API document is designed for those interested in ZWave compatibility.
This API is still under development and will continue being updated.
Device connected
Device ID is needed
Connection is failing
Connection failed
Authentication Edit
This is the API for old ZWave compatibility that can be ran untop of a parallel processing mesh network
Add the API key to all requests as a GET parameter.
Nothing will work unless you include the Device ID
[
"http://10.0.0.225:8080"
]
{
"uri": "http://10.0.0.220:8080",
"id": "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}
Errors Edit
Code | Name | Description |
---|---|---|
200 | OK | Success |
201 | Created | Creation Successful |
400 | Bad Request | We could not process that action |
403 | Forbidden | We couldn’t authenticate you |
All errors will return JSON in the following format:
{
"error": true,
"message": "error message here"
}
/z-wave Edit
Device ID, value and time unit
Parameters
- deviceId
- Calls the device ID
- SetState
- Set the state of devices
x-swagger-router-controller: “ZWave” /lighting/dimmers/{deviceId}/{value}/timer/{timeunit}:
Sets device Id response through ZWave
$ref: '#/definitions/ApiResponse'
$ref: '#/definitions/LightingSummary'
{
"zones": [
{
"id": "string",
"name": "string",
"deviceId": 0,
"deviceType": "dimmer",
"zone": "string"
}
],
"zoneStatus": [
{
"id": "string",
"name": "string",
"lastUpdate": "2020-06-16T23:40:29.510Z",
"level": 0
}
]
}
$ref: '#/definitions/HeaterState'
$ref: '#/definitions/TemperatureZone'
$ref: '#/definitions/TemperatueZoneStatus'
/devices Edit
Get devices
Parameters
- skip
- Number of records to skip
- limit
- Max number of records to return
limit integer($int32) Max number of records to return
$ref: '#/definitions/DeviceRegistrationInfo'
responses:
200:
description: successfully registered device
);
responses:
200:
description: successfully registered device
{
"error": true,
"message": "Invalid score"
}
/z-wave/:id Edit
Device ID and values
Returns Device ID and Values
DeviceRegistrationInfo:
type: object
properties:
uri:
type: string
format: uri
example: http://10.0.0.220:8080
id:
type: string
format: uuid
example: '0729a580-2240-11e6-9eb5-0002a5d5c51b'
host: virtserver.swaggerhub.com
basePath: /Lonero/Decentralized-Internet_API/1.0.0
schemes: - https
/z-wave/:id Edit
Device IDs
Parameters
- device
- Collect device ids for peers
- deviceId
- Set path for collecting device ids
Set path for the calling of device ids
{
"uri": "http://10.0.0.220:8080",
"id": "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}
operationId: "setDimmer"
parameters:
- name: "deviceId"
in: "path"
required: true
type: "string"
- name: "value"
in: "path"
required: true
type: "integer"
maximum: 100.0
minimum: 0.0
format: "int32"
/devices/:id Edit
Post devices
Successfully registered device
[
"http://10.0.0.225:8080"
]
{
"uri": "http://10.0.0.220:8080",
"id": "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}
$ref: '#/definitions/DeviceRegistrationInfo'