Skip to content

System Interface

The System (system) interface provides standard methods for retriving data about a device:

SystemInterface

manufacturer

Retrieve the device manufacturer (if available):

json
{
    "msg": "io.upswell.xagent.ControlRequest",
    "device": "<device alias>",
    "method": "manufacturer",
    "mid": "123abc"
}

Returns: DeviceAttribute

model

Retrieve the device model (if available):

json
{
    "msg": "io.upswell.xagent.ControlRequest",
    "device": "<device alias>",
    "method": "model",
    "mid": "123abc"
}

Returns: DeviceAttribute

serial

Retrieve the device serial number (if available):

json
{
    "msg": "io.upswell.xagent.ControlRequest",
    "device": "<device alias>",
    "method": "serial",
    "mid": "123abc"
}

Returns: DeviceAttribute

version

Retrieve the current device, application or firmware version:

json
{
    "msg": "io.upswell.xagent.ControlRequest",
    "device": "<device alias>",
    "method": "version",
    "mid": "123abc"
}

Returns: DeviceAttribute

Atlas, Hybrid cloud, on-premesis platform for large scale media program development, delivery and operation.