Roku · Schema

DeviceInfo

Roku device metadata returned as XML.

StreamingTelevisionMediaEntertainmentConnected TVConsumer Electronics

Properties

Name	Type	Description
udn	string	Unique Device Name (UUID).
serialNumber	string	Hardware serial number.
deviceId	string
modelNumber	string	Hardware model number (e.g., 4660X).
modelName	string	Marketing model name (e.g., Roku Ultra).
friendlyDeviceName	string
softwareVersion	string
softwareBuild	string
userDeviceName	string
wifiMac	string
ethernetMac	string
networkType	string
countryCode	string
language	string
timeZone	string
powerMode	string
supportsEcsTextedit	boolean
supportsEcsMicrophone	boolean
supportsWakeOnWlan	boolean
developerEnabled	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/external-control-protocol-device-info-schema.json",
  "title": "DeviceInfo",
  "description": "Roku device metadata returned as XML.",
  "type": "object",
  "properties": {
    "udn": {
      "type": "string",
      "description": "Unique Device Name (UUID)."
    },
    "serialNumber": {
      "type": "string",
      "description": "Hardware serial number."
    },
    "deviceId": {
      "type": "string"
    },
    "modelNumber": {
      "type": "string",
      "description": "Hardware model number (e.g., 4660X)."
    },
    "modelName": {
      "type": "string",
      "description": "Marketing model name (e.g., Roku Ultra)."
    },
    "friendlyDeviceName": {
      "type": "string"
    },
    "softwareVersion": {
      "type": "string",
      "example": "12.5.0"
    },
    "softwareBuild": {
      "type": "string"
    },
    "userDeviceName": {
      "type": "string"
    },
    "wifiMac": {
      "type": "string"
    },
    "ethernetMac": {
      "type": "string"
    },
    "networkType": {
      "type": "string",
      "enum": [
        "wifi",
        "ethernet"
      ]
    },
    "countryCode": {
      "type": "string"
    },
    "language": {
      "type": "string"
    },
    "timeZone": {
      "type": "string"
    },
    "powerMode": {
      "type": "string",
      "enum": [
        "PowerOn",
        "DisplayOff",
        "Headless",
        "Ready"
      ]
    },
    "supportsEcsTextedit": {
      "type": "boolean"
    },
    "supportsEcsMicrophone": {
      "type": "boolean"
    },
    "supportsWakeOnWlan": {
      "type": "boolean"
    },
    "developerEnabled": {
      "type": "boolean"
    }
  }
}