LAN of things HTTP API specs API documentation

/device-interfaces

/device-interfaces get

get

Returns a JSON array of devices that can be controlled by this node. This includes, for each device, a list of features that can be controlled by the node. Please note that different nodes may be able to control different features of the same device.

Response

HTTP status code 200

Body

Media type: application/json

Type: array of device-interface

Items: device-interface

type: required (string)
The device type. (TODO: Add reference to allowed types.)
device-id: required (string)
A unique id of your choice for the device.
features: required (array of )
A list of all the features that can be controlled using this device interface.

Example:

[
  {
    "type": "tv",
    "device-id": "bedroom-tv",
    "features": [
      "volume-up",
      "volume-down",
      "channel-up",
      "channel-down",
      "set-channel-number",
      "mute-toggle",
      "standby-toggle"
    ]
  },
  {
    "type": "temperature-sensor",
    "device-id": "bedroom-temp",
    "features": [
      "get-temperature"
    ]
  }
]

/device-interfaces/thermostat/{device-id}/set-temperature/{temperature} get

get

Set the temperature for the thermostat.

Request
Response

URI Parameters

device-id: required (string)
The device id.
Example:
```
bedroom-thermostat
```
temperature: required (number)
The temperature in degrees Celsius.
Example:
```
22.5
```

LAN of things HTTP API specs API documentation version 1.0.0

/device-interfaces

/device-interfaces get

get /device-interfaces

HTTP status code 200

Body

/device-interfaces/generic-light/{device-id}/turn-on get

get /device-interfaces/generic-light/{device-id}/turn-on

URI Parameters

HTTP status code 200

/device-interfaces/generic-light/{device-id}/turn-off get

get /device-interfaces/generic-light/{device-id}/turn-off

URI Parameters

HTTP status code 200

/device-interfaces/thermostat/{device-id}/set-temperature/{temperature} get

get /device-interfaces/thermostat/{device-id}/set-temperature/{temperature}

URI Parameters

HTTP status code 200