Device

Get Device State

URL /api/v2/device
Method GET
Authentication basic

Description

Returns information about the device like name, serial number, version of the firmware, model etc. Response also contains state of audio, display, bluetooth and wi-fi.

Parameters

Property Description
fields

Comma separated list of field you want to receive in response. Possible values are:

  • id
  • name
  • serial_number
  • os_version
  • mode
  • model
  • audio
  • display
  • bluetooth
  • wifi

Response

Property Type Description
id String Id of the device on the cloud
name String User specified name of the device
serial_number String Device serial number
os_version String Software version in format <major>.<minor>.<patch>
model String Model number
mode String

Current device mode. Can be one of “auto”, “manual” or “kiosk”

  • auto - auto scroll mode, when device switch between apps automatically
  • manual - click to scroll mode, when user can manually switch between apps
  • kiosk - kiosk mode when single app is locked on the device.
audio Object Audio state. Allows to get current volume
bluetooth Object Bluetooth state
display Object Display state
wifi Object Wi-Fi state

Examples

Request:

GET http://192.168.0.239:8080/api/v2/device

Response:

HTTP/1.1 200 OK
CONTENT-TYPE: application/json;charset=UTF8
Transfer-Encoding: chunked
Date: Thu, 23 Jun 2016 16:33:07 GMT
Server: lighttpd/1.4.35

{
    "id" : "1",
    "name" : "LM0001",
    "serial_number" : "SA150600000100W00BS9",
    "os_version" : "1.6.0",
    "mode" : "manual",
    "model" : "LM 37X8",
    "audio" : {
        "volume" : 100
    },
    "bluetooth" : {
        "available" : true,
        "name" : "LM0001",
        "active" : false,
        "discoverable" : false,
        "pairable" : true,
        "address" : "58:63:56:10:FD:2F"
        },
    "display" : {
        "brightness" : 67,
        "brightness_mode" : "auto",
        "width" : 37,
        "height" : 8,
        "type" : "mixed"
    },
    "wifi" : {
        "active" : true,
        "address" : "58:63:56:10:D6:1F",
        "available" : true,
        "encryption" : "WPA",
        "essid" : "home-wifi",
        "ip" : "192.168.0.233",
        "mode" : "dhcp",
        "netmask" : "255.255.255.0",
        "strength" : 100
    }
}

Request:

GET http://192.168.0.233:8080/api/v2/device?fields=name,wifi

Response:

HTTP/1.1 200 OK
CONTENT-TYPE: application/json;charset=UTF8
Transfer-Encoding: chunked
Date: Thu, 23 Jun 2016 17:06:14 GMT
Server: lighttpd/1.4.35

{
    "name" : "LM0001",
    "wifi" : {
        "active" : true,
        "address" : "58:63:56:10:D6:1F",
        "available" : true,
        "encryption" : "WPA",
        "essid" : "home-wifi",
        "ip" : "192.168.0.233",
        "mode" : "dhcp",
        "netmask" : "255.255.255.0",
        "strength" : 100
    }
}