Remote Two/3 WebSocket Dock-API 0.8.0-beta

Accepts one of the following messages:

• #0auth

  🚀 Authenticate a connection.

  Sent by the client right after establishing a connection, or after an auth_required request by the server.

  Payload

  Expand all

  object

  uid: authRequestMsg

  Examples values:
  • {"type":"auth","token":"1234"}

  type

  required

  string

  Const:"auth"

  token

  required

  string

  [ 4 .. 40 ] charactersuid: token

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Authentication response.

  description

  The authentication result is provided in the `code` attribute: - `200`: success, API can be used and message requests are accepted. - `401`: authentication failed, the provided API-key is not valid. The server will close the connection.

  payload

  Expand all

  object

  uid: authResponseMsg

  type

  required

  string

  Const:"auth"

  msg

  required

  string

  Const:"authentication"

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Default value:200

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  • #1 Example

    {
      "type": "auth",
      "token": "1234"
    }
    

• #1ping

  🚀 Application level based ping to determine whether connection is alive.

  Client can ping the server to determine whether connection is alive. Server responds with pong.

  This is an application level ping as opposed to the standard WebSocket ping frames. This is only required if a client framework doesn't support WebSocket ping frames!

  Payload

  Expand all

  object

  uid: ping

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"ping"

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Pong is a response to ping message.

  description

  Server pong response to a ping to determine whether connection is alive. This is an application level pong as opposed to default pong in websockets standard which is sent by client in response to a ping.

  payload

  Expand all

  object

  uid: pong

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"pong"

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  {
    "type": "dock",
    "msg": "ping"
  }
  

  This example has been generated automatically.

• #2command

  🚀 Perform a system command.

  The following system commands can be executed:

  • ir_receive_on: Enables IR learning.
    • Learned codes are broadcasted with the ir_receive event message.
    • Learning mode status can be retrieved with the get_sysinfo request.
    • While learning mode is activated, no IR codes can be transmitted.
  • ir_receive_off: Stops IR learning.
  • remote_charged: Set status LED to normal operation (LED off)
  • remote_lowbattery: Set status LED to low battery mode (blink twice every 4 seconds).
  • remote_normal: Set status LED to normal operation (LED off, turn on when charging).
  • identify: Docking station identification, blink status LED green, amber, blue and red.
  • reboot: Reboot the device.
  • reset: Factory reset the device.
    • ❗️ All configuration data is erased and the device is put in setup mode.

  The server will respond with a result message and a status code of the request.

  ❗️ For reboot and reset commands there might be no response message. The dock will reboot after the command is processed.

  Payload

  Expand all

  object allOf

  uid: systemCmdMsg

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Allowed values:
  • "ir_receive_on"
  • "ir_receive_off"
  • "remote_charged"
  • "remote_lowbattery"
  • "remote_normal"
  • "identify"
  • "reboot"
  • "reset"

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "ir_receive_on"
  }
  

  This example has been generated automatically.

• #3get_sysinfo

  🚀 Get system information.

  Get hardware and software information about the device like serial number, model number, connection status and installed firmware version.

  This message does not require authentication.

  Payload

  Expand all

  object allOf

  uid: getSystemInfoMsg

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"get_sysinfo"

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 System information response.

  payload

  Expand all

  object allOf

  uid: systemInfoMsg

  Examples values:
  • {"type":"dock","req_id":2,"msg":"get_sysinfo","code":200,"name":"My dock","hostname":"UC-Dock-1234","model":"UCD2","revision":"5.4","version":"0.4.0","serial":"0042","ir_learning":false}

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"get_sysinfo"

  name

  required

  string

  hostname

  required

  string

  model

  required

  string

  revision

  required

  string

  version

  required

  string

  serial

  required

  string

  features

  integer

  >= 0uid: features

  Bit-field encoded feature flags. These are new or optional features a client can use. They also allow an easy way to keep backward compatibility. Available features:

  • Bit 0: support for disabling IR repeat response messages. Default: disabled.
  • Bit 1: ir_send command supports the hold parameter to send ir command for x milliseconds.

  led_brightness

  integer

  eth_led_brightness

  integer

  ir_learning

  required

  boolean

  ethernet

  boolean

  wifi

  boolean

  ssid

  string

  ports

  Expand all

  array<object allOf>

  3️⃣ External port mode configuration.

  Items:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  volume

  integer

  3️⃣🔍 Speaker volume.

  uptime

  string

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "get_sysinfo"
  }
  

  This example has been generated automatically.

• #4ir_send

  🚀 Send an IR code or continue repeating a previous code.

  Send an IR code on the given output(s), either in Unfolded Circle or PRONTO HEX format.

  • If multiple outputs are specified, the IR signal is transmitted in parallel on the given outputs.
  • Only one IR code can be transmitted at the same time.
    It is not possible to send different codes on individual outputs at the same time.
  • IR transmission is blocked while the device is in learning mode.
  • If no output is specified: int_side is used as default output.
  • 3️⃣ Outputs not configured for IR sending are silently ignored.

  The IR transmission begins after the full message has been received, parsed and validated. Depending on the state of the IR device, different actions are taken:

  • Device is idle: a single code is transmitted and status code 200 returned after completion.
  • Transmitting the same IR code with the repeat field set: return status code 202 and continue repeating the IR code.
  • Transmitting another IR code: return error code 429.

  See Result codes below for all status codes.

  Continuous IR repeat

  This feature allows to repeat an IR signal autonomously by the dock for a specified number of times.

  The repeated IR signal is usually a special IR command to tell the receiving device, that a button on a remote control is hold for a longer time. Depending on the device, a repeat signal can either simply execute the same action as if someone would rapidly press the same button, or it can adjust the command to a different function. One common example is to progressively increase the volume steps, e.g. start slowly with 0.1 dBA steps, then after a short time increase to 0.5 or 1 dBA steps.
  Please note that not all devices or IR formats / commands support this feature. This is manufacturer specific.

  The continuous IR repeat feature is activated with the optional repeat field in the ir_send command.

  • The IR repeat signal will automatically be sent the number of times specified in the repeat field.
  • If the next ir_send request contains the same command value, the repeat count will be reset and therefore the repeat signal prolonged.
  • An ir_stop request will stop the remaining repeat commands.
  • Depending on the IR format, a repeat value might be already part of the code.
    • ⚠️ The repeat value will override the embedded repeat information.
    • See IR formats below.
  • Each repeat request will be acknowledged with a response message and a 202 status code, unless it gets disabled with the feature flag in bit 0.

  If not specified (or set to zero):

  • The provided code is sent as is, with the contained repeat information (depending on IR format).
  • Continuous IR repeat is not activated:
    • every ir_send command will send the full IR command.
    • ⚠️ the ir_stop command will have no effect!

  IR formats

  • pronto: PRONTO HEX format:
    • The PRONTO HEX format does not include a dedicated repeat count field, but an optional 2nd burst pair sequence used for repeats.
      • The third number in the PRONTO code specifies the number of burst pairs in the 1st sequence.
      • The fourth number in the PRONTO code specifies the number of burst pairs in the 2nd sequence.
      • If the fourth number is 0, then there's no repeat sequence.
      • Note that either sequence is optional. Also there might be both sequences defined, or only the 1st or 2nd one.
    • If the repeat field is set (> 0), the 2nd burst pair sequence of the PRONTO code is repeated.
      • If the PRONTO code doesn't contain a 2nd burst pair sequence, then the repeat value is ignored.
  • hex: Unfolded Circle format:
    • The repeat count is part of the code and might be required for certain protocols.
      • E.g. Sony needs to send the same command two or three times so it's recognized as a single command by a device.
    • If the repeat field is set (> 0), this will override the repeat count in code!
    • The actual emitted IR repeat signal depends on the IR protocols.
      • E.g. Denon will simply repeat the full command, whereas LG has a mandatory repeat-specific code sent after the command. This is all handled by the dock firmware, when sending the IR code.

  Result codes

  • 200: IR command has been sent. Either a single command, or after an IR repeat has finished.
  • 202: IR repeat command accepted. Default behavior, except the response message has been disabled with the feature flag.
  • 400: Cannot send command: invalid data or format.
  • 429: Cannot send command: last IR command is still being sent.
  • 503: IR sending not possible because learning is active.

  Payload

  Expand all

  object allOf

  uid: irSendMsg

  Examples values:
  • {"type":"dock","id":1,"command":"ir_send","code":"4;0x10;12;0","format":"hex","int_side":true}
  • {"type":"dock","id":2,"command":"ir_send","code":"0000 006c 0022 0002 015b 00ad 0016 0016 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0622 015b 0057 0016 0e6c","format":"pronto","ext1":true}
  • {"type":"dock","id":3,"command":"ir_send","code":"4;0x10;12;1","format":"hex","repeat":3,"int_side":true}
  • {"type":"dock","id":4,"command":"ir_send","code":"0000 006c 0022 0002 015b 00ad 0016 0016 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0622 015b 0057 0016 0e6c","format":"pronto","repeat":3,"ext1":true}

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"ir_send"

  code

  required

  string

  format: ^(?:[\d]{1,3};0x[a-fA-F0-9]{1,16};[\d]{1,2};[\d]{1,2}|[0]{1,4}(?:(?: [a-fA-F0-9]{1,4}){5,}|(?:,[a-fA-F0-9]{1,4}){5,}))$

  IR code, either in Unfolded Circle or PRONTO hex format.
  PRONTO code values must be separated by a space or comma (and the separator may not be mixed).

  format

  required

  string

  uid: irFormat

  IR format:

  • hex: Unfolded Circle format: <protocol>;<hex-ir-code>;<bits>;<repeat-count> e.g. "4;0x640C;15;0"
    • Maximum repeat count is 20.
    • Protocol and code are based on IRremoteESP8266.
  • pronto: PRONTO HEX format. Codes separated by space or comma.
    • Only raw PRONTO codes are supported (first code must be 0000).
    • Codes may be shortened, e.g. 0000 can be specified as 0, or 0010 as 10.

  Default value:"hex"

  Allowed values:
  • "hex"
  • "pronto"

  repeat

  integer

  [ 0 .. 20 ]

  Optional repeat value for sending continuous IR repeat signals (depending on IR protocol).

  f

  integer

  >= 0

  Optional feature flag for sending IR repeat signals.

  • Bit 0: do not send a response message if an active IR repeat sequence is extended.

  int_side

  boolean

  Enable internal output at the bottom around the dock.

  int_top

  boolean

  Enable top output.

  Default value:false

  ext1

  boolean

  Enable external output 1.

  ext2

  boolean

  Enable external output 2.

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  • #1 Example

    {
      "type": "dock",
      "id": 1,
      "command": "ir_send",
      "code": "4;0x10;12;0",
      "format": "hex",
      "int_side": true
    }
    

  • #2 Example

    {
      "type": "dock",
      "id": 2,
      "command": "ir_send",
      "code": "0000 006c 0022 0002 015b 00ad 0016 0016 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0622 015b 0057 0016 0e6c",
      "format": "pronto",
      "ext1": true
    }
    

  • #3 Example

    {
      "type": "dock",
      "id": 3,
      "command": "ir_send",
      "code": "4;0x10;12;1",
      "format": "hex",
      "repeat": 3,
      "int_side": true
    }
    

  • #4 Example

    {
      "type": "dock",
      "id": 4,
      "command": "ir_send",
      "code": "0000 006c 0022 0002 015b 00ad 0016 0016 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0622 015b 0057 0016 0e6c",
      "format": "pronto",
      "repeat": 3,
      "ext1": true
    }
    

• #5ir_stop

  🔍 Stop an active IR repeat transmission.

  This command stops an active IR repeat transmission at the end of the current repeat signal.

  Status 200 is always returned, even if there's no active IR transmission.

  Payload

  Expand all

  object allOf

  uid: irStopMsg

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  command

  string

  Const:"ir_stop"

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "ir_stop"
  }
  

  This example has been generated automatically.

• #6set_config

  🚀 Configure the dock.

  Configure the dock with a custom friendly name, change the API access token and set the WiFi connection.

  Notes:

  • One or multiple settings can be configured at once.
  • For the WiFi configuration both ssid and wifi_password fields must be specified.
  • The dock will be restarted if the WiFi configuration is specified.
  • Ethernet has precedence over WiFi connection. If the ethernet connection has a link, WiFi won't be activated.
  • The friendly name will be announced over mDNS and returned in get_sysinfo.

  Payload

  Expand all

  object allOf

  uid: setConfigMsg

  Examples values:
  • {"type":"dock","id":1,"command":"set_config","friendly_name":"My dock"}
  • {"type":"dock","id":2,"command":"set_config","token":"1234"}
  • {"type":"dock","id":3,"command":"set_config","ssid":"My WiFi","wifi_password":"topsecret"}

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"set_config"

  friendly_name

  string

  <= 40 characters

  token

  string

  [ 4 .. 40 ] charactersuid: token

  ssid

  string

  <= 32 characters

  wifi_password

  string

  <= 63 characters

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  • #1 Example

    {
      "type": "dock",
      "id": 1,
      "command": "set_config",
      "friendly_name": "My dock"
    }
    

  • #2 Example

    {
      "type": "dock",
      "id": 2,
      "command": "set_config",
      "token": "1234"
    }
    

  • #3 Example

    {
      "type": "dock",
      "id": 3,
      "command": "set_config",
      "ssid": "My WiFi",
      "wifi_password": "topsecret"
    }
    

• #7set_brightness

  🚀 Set status LED brightness.

  Set the maximum brightness of the status LED and ethernet indicator LED.

  Payload

  Expand all

  object allOf

  uid: setBrightnessMsg

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"set_brightness"

  status_led

  integer

  [ 0 .. 255 ]

  eth_led

  integer

  [ 0 .. 255 ]

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "set_brightness",
    "status_led": 255,
    "eth_led": 255
  }
  

  This example has been generated automatically.

• #8set_volume

  3️⃣️ 🔍 Set speaker volume.

  Payload

  Expand all

  object allOf

  uid: setVolumeMsg

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  command

  string

  Const:"set_volume"

  volume

  integer

  [ 0 .. 100 ]

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "set_volume",
    "volume": 100
  }
  

  This example has been generated automatically.

• #9set_logging

  2️⃣ 🧪 Configure logging parameters.

  Set log level and an optional syslog server. Levels:

  • 0: EMERGENCY, system is unusable
  • 1: ALERT, action must be taken immediately
  • 2: CRITICAL, critical conditions
  • 3: ERROR, error conditions
  • 4: WARNING, warning conditions
  • 5: NOTICE, normal but significant condition
  • 6: INFO, informational
  • 7: DEBUG, debug-level messages

  ⚠️ This feature is currently only available on Dock Two.

  Payload

  Expand all

  object allOf

  uid: setLogging

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"set_logging"

  log_level

  integer

  [ 0 .. 7 ]

  syslog_server

  string

  <= 64 characters

  syslog_port

  integer

  [ 0 .. 65535 ]

  Default value:514

  syslog_enabled

  boolean

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  • #ucd2

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "set_logging",
    "log_level": 7,
    "syslog_server": "string",
    "syslog_port": 514,
    "syslog_enabled": true
  }
  

  This example has been generated automatically.

• #10get_port_mode

  3️⃣️ 🧪 Get external port configuration.

  ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: getPortMode

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"get_port_mode"

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  3️⃣️ 🧪 External port configuration.

  description

  ⚠️ This feature is only available on Dock Three.

  payload

  Expand all

  object allOf

  uid: portMode

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"get_port_mode"

  And with:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  tags

  Expand all

  1 item:

  Expand all

  name

  ucd3

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "get_port_mode",
    "port": 1
  }
  

  This example has been generated automatically.

• #11set_port_mode

  3️⃣️ 🧪 Configure an external port.

  ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: setPortMode

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"set_port_mode"

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "set_port_mode",
    "port": 1,
    "mode": "AUTO",
    "uart": {
      "baud_rate": 9600,
      "data_bits": 8,
      "stop_bits": "1",
      "parity": "none"
    }
  }
  

  This example has been generated automatically.

• #12get_port_modes

  3️⃣️ 🧪 Get all external port configurations.

  ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: getPortModes

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  command

  string

  Const:"get_port_modes"

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  3️⃣️ 🧪 External port configurations.

  description

  ⚠️ This feature is only available on Dock Three.

  payload

  Expand all

  object allOf

  uid: portModes

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  msg

  string

  Const:"get_port_modes"

  ports

  Expand all

  array<object allOf>

  Items:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  tags

  Expand all

  1 item:

  Expand all

  name

  ucd3

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "get_port_modes"
  }
  

  This example has been generated automatically.

• #13set_port_trigger

  3️⃣️ 🧪 Set trigger state of an external port.

  Result codes

  • 200: trigger has been set.
  • 400: invalid port number or unsupported command (on Dock Two).
  • 404: port is not configured as trigger.
  • 409: conflict: impulse is already active.
  • 423: port is temporarily unavailable. It might be reconfigured or is in use.
  • 500: internal error.
  • 503: port not available. ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: setPortTrigger

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  command

  required

  string

  Const:"set_port_trigger"

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  trigger

  required

  boolean

  duration

  integer

  >= 1

  Optional trigger time in milliseconds.

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  🚀 Command result message.

  payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "set_port_trigger",
    "port": 1,
    "trigger": true,
    "duration": 1
  }
  

  This example has been generated automatically.

• #14get_port_trigger

  3️⃣️ 🧪 Get trigger state of an external port.

  ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: getPortTrigger

  Consists of:

  Expand all

  object

  uid: commonReq

  Common request message properties.

  type

  required

  string

  Request message type.

  Allowed values:
  • "dock"
  • "auth"

  id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  command

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  command

  string

  Const:"get_port_trigger"

  port

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  Additional properties are allowed.

  Extensions

  Expand all

  x-response

  Expand all

  summary

  3️⃣️ 🧪 Trigger state of an external port.

  description

  ### Result codes - `200`: success. - `400`: invalid port number or unsupported command (on Dock Two). - `404`: port is not configured as trigger. - `503`: port not available.

  payload

  Expand all

  object allOf

  uid: portTrigger

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  msg

  string

  Const:"get_port_trigger"

  trigger

  boolean

  Additional properties are allowed.

  tags

  Expand all

  1 item:

  Expand all

  name

  ucd3

  schemaFormat

  application/vnd.aai.asyncapi;version=2.2.0

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "id": 0,
    "command": "get_port_trigger",
    "port": 1
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0pong

  🚀 Pong is a response to ping message.

  Server pong response to a ping to determine whether connection is alive. This is an application level pong as opposed to default pong in websockets standard which is sent by client in response to a ping.

  Payload

  Expand all

  object

  uid: pong

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"pong"

  Additional properties are allowed.

  Examples

  Payload

  {
    "type": "dock",
    "msg": "pong"
  }
  

  This example has been generated automatically.

• #1authentication

  🚀 Authentication response.

  The authentication result is provided in the code attribute:

  • 200: success, API can be used and message requests are accepted.
  • 401: authentication failed, the provided API-key is not valid. The server will close the connection.

  Payload

  Expand all

  object

  uid: authResponseMsg

  type

  required

  string

  Const:"auth"

  msg

  required

  string

  Const:"authentication"

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Default value:200

  Additional properties are allowed.

  Examples

  Payload

  {
    "type": "auth",
    "msg": "authentication",
    "code": 200
  }
  

  This example has been generated automatically.

• #2result

  🚀 Command result message.

  Payload

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  Examples

  Payload

  {
    "type": "dock",
    "req_id": 0,
    "msg": "string",
    "code": 200,
    "reboot": true
  }
  

  This example has been generated automatically.

• #3sysinfo

  🚀 System information response.

  Payload

  Expand all

  object allOf

  uid: systemInfoMsg

  Examples values:
  • {"type":"dock","req_id":2,"msg":"get_sysinfo","code":200,"name":"My dock","hostname":"UC-Dock-1234","model":"UCD2","revision":"5.4","version":"0.4.0","serial":"0042","ir_learning":false}

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"get_sysinfo"

  name

  required

  string

  hostname

  required

  string

  model

  required

  string

  revision

  required

  string

  version

  required

  string

  serial

  required

  string

  features

  integer

  >= 0uid: features

  Bit-field encoded feature flags. These are new or optional features a client can use. They also allow an easy way to keep backward compatibility. Available features:

  • Bit 0: support for disabling IR repeat response messages. Default: disabled.
  • Bit 1: ir_send command supports the hold parameter to send ir command for x milliseconds.

  led_brightness

  integer

  eth_led_brightness

  integer

  ir_learning

  required

  boolean

  ethernet

  boolean

  wifi

  boolean

  ssid

  string

  ports

  Expand all

  array<object allOf>

  3️⃣ External port mode configuration.

  Items:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  volume

  integer

  3️⃣🔍 Speaker volume.

  uptime

  string

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    {
      "type": "dock",
      "req_id": 2,
      "msg": "get_sysinfo",
      "code": 200,
      "name": "My dock",
      "hostname": "UC-Dock-1234",
      "model": "UCD2",
      "revision": "5.4",
      "version": "0.4.0",
      "serial": "0042",
      "ir_learning": false
    }
    

• #4port_mode

  3️⃣️ 🧪 External port configuration.

  ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: portMode

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  required

  string

  Const:"dock"

  msg

  required

  string

  Const:"get_port_mode"

  And with:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "req_id": 0,
    "msg": "get_port_mode",
    "code": 200,
    "reboot": true,
    "port": 1,
    "mode": "AUTO",
    "active_mode": "AUTO",
    "supported_modes": "AUTO",
    "uart": {
      "baud_rate": 9600,
      "data_bits": 8,
      "stop_bits": "1",
      "parity": "none"
    }
  }
  

  This example has been generated automatically.

• #5port_modes

  3️⃣️ 🧪 External port configurations.

  ⚠️ This feature is only available on Dock Three.

  Payload

  Expand all

  object allOf

  uid: portModes

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  msg

  string

  Const:"get_port_modes"

  ports

  Expand all

  array<object allOf>

  Items:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "req_id": 0,
    "msg": "get_port_modes",
    "code": 200,
    "reboot": true,
    "ports": [
      {
        "port": 1,
        "mode": "AUTO",
        "active_mode": "AUTO",
        "supported_modes": "AUTO",
        "uart": {
          "baud_rate": 9600,
          "data_bits": 8,
          "stop_bits": "1",
          "parity": "none"
        }
      }
    ]
  }
  

  This example has been generated automatically.

• #6port_trigger

  3️⃣️ 🧪 Trigger state of an external port.

  Result codes

  • 200: success.
  • 400: invalid port number or unsupported command (on Dock Two).
  • 404: port is not configured as trigger.
  • 503: port not available.

  Payload

  Expand all

  object allOf

  uid: portTrigger

  Consists of:

  Expand all

  object

  uid: commonResp

  Common response message properties.

  type

  required

  string

  Response message type.

  Allowed values:
  • "dock"
  • "auth"

  req_id

  integer

  >= 0uid: msgId

  Request message ID which is reflected in response message.

  msg

  required

  string

  [ 1 .. 32 ] charactersuid: command

  One of the defined API message commands.

  code

  required

  integer

  Response code of the operation according to HTTP status codes.

  Commonly used status codes are:

  • 200: request successful
  • 400: bad request, data in request is not valid
  • 429: too many requests, try again later. E.g. IR sending is still active
  • 503: service not available. E.g. IR sending not possible because learning is active

  Default value:200

  reboot

  boolean

  Optional flag: the device will restart after this message.

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  type

  string

  Const:"dock"

  msg

  string

  Const:"get_port_trigger"

  trigger

  boolean

  Additional properties are allowed.

  • #ucd3

  Examples

  Payload

  {
    "type": "dock",
    "req_id": 0,
    "msg": "get_port_trigger",
    "code": 200,
    "reboot": true,
    "trigger": true
  }
  

  This example has been generated automatically.

• #7auth_required

  🚀 Authentication request event after connection is established.

  The event contains additional metadata of the dock to inform the client of the specific dock model and firmware version.
  The client must authenticate with the auth request message.

  Payload

  Expand all

  object

  uid: authRequiredEvent

  Examples values:
  • {"type":"auth_required","model":"UCD2","revision":"5.4","version":"0.6.0"}

  type

  required

  string

  Const:"auth_required"

  model

  string

  Dock model

  revision

  string

  Dock revision

  version

  string

  Dock firmware version

  features

  integer

  >= 0uid: features

  Bit-field encoded feature flags. These are new or optional features a client can use. They also allow an easy way to keep backward compatibility. Available features:

  • Bit 0: support for disabling IR repeat response messages. Default: disabled.
  • Bit 1: ir_send command supports the hold parameter to send ir command for x milliseconds.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    {
      "type": "auth_required",
      "model": "UCD2",
      "revision": "5.4",
      "version": "0.6.0"
    }
    

• #8ir_receive

  🚀 IR learning event.

  Sent whenever an IR code was learned in IR learning mode.

  Payload

  Expand all

  object allOf

  uid: irReceiveEvent

  Examples values:
  • {"type":"event","msg":"ir_receive","ir_code":"4;0x10;12;0"}

  Consists of:

  Expand all

  object

  uid: commonEvent

  Common event message properties.

  type

  required

  string

  Event message identifier.

  Const:"event"

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  msg

  required

  string

  Const:"ir_receive"

  ir_code

  required

  string

  Learned IR code

  format

  string

  uid: irFormat

  IR format:

  • hex: Unfolded Circle format: <protocol>;<hex-ir-code>;<bits>;<repeat-count> e.g. "4;0x640C;15;0"
    • Maximum repeat count is 20.
    • Protocol and code are based on IRremoteESP8266.
  • pronto: PRONTO HEX format. Codes separated by space or comma.
    • Only raw PRONTO codes are supported (first code must be 0000).
    • Codes may be shortened, e.g. 0000 can be specified as 0, or 0010 as 10.

  Default value:"hex"

  Allowed values:
  • "hex"
  • "pronto"

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    {
      "type": "event",
      "msg": "ir_receive",
      "ir_code": "4;0x10;12;0"
    }
    

• #9ir_receive_on_event

  3️⃣️ 🧪 IR-learning active event.

  Sent when IR-learning has been activated.

  ⚠ currently only available on Dock 3.

  Payload

  Expand all

  object allOf

  uid: irReceiveOnEvent

  Consists of:

  Expand all

  object

  uid: commonEvent

  Common event message properties.

  type

  required

  string

  Event message identifier.

  Const:"event"

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  msg

  required

  string

  Const:"ir_receive_on"

  Additional properties are allowed.

  • #ucd3

  Examples

  Payload

  {
    "type": "event",
    "msg": "ir_receive_on"
  }
  

  This example has been generated automatically.

• #10ir_receive_off_event

  3️⃣️ 🧪 IR-learning stopped event.

  Sent when IR-learning has been stopped.

  ⚠ currently only available on Dock 3.

  Payload

  Expand all

  object allOf

  uid: irReceiveOffEvent

  Consists of:

  Expand all

  object

  uid: commonEvent

  Common event message properties.

  type

  required

  string

  Event message identifier.

  Const:"event"

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  msg

  required

  string

  Const:"ir_receive_off"

  Additional properties are allowed.

  • #ucd3

  Examples

  Payload

  {
    "type": "event",
    "msg": "ir_receive_off"
  }
  

  This example has been generated automatically.

• #11port_mode_event

  3️⃣️ 🧪 External port mode change event.

  Sent when an external port mode was detected.

  Payload

  Expand all

  object allOf

  uid: portModeEvent

  Consists of:

  Expand all

  object

  uid: commonEvent

  Common event message properties.

  type

  required

  string

  Event message identifier.

  Const:"event"

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  msg

  required

  string

  Const:"port_mode"

  And with:

  Expand all

  object allOf

  uid: externalPortConfiguration

  External port configuration.

  • mode: configured operation mode.
  • active_mode: active operation mode, usually only set with the detected peripheral for mode: AUTO.

  Consists of:

  Expand all

  restricted any

  port

  required

  integer

  [ 1 .. 2 ]uid: externalPortNumber

  1-based port index number.

  mode

  required

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  active_mode

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  supported_modes

  string

  uid: externalPortMode

  Allowed values:
  • "AUTO"
  • "NONE"
  • "IR_BLASTER"
  • "IR_EMITTER_MONO_PLUG"
  • "IR_EMITTER_STEREO_PLUG"
  • "TRIGGER_5V"
  • "RS232"

  uart

  Expand all

  object

  uid: uartConfiguration

  baud_rate

  required

  integer

  [ 300 .. 115200 ]uid: baudRate

  Common baud rate values: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

  Default value:9600

  data_bits

  required

  integer

  [ 5 .. 8 ]uid: dataBits

  Default value:8

  stop_bits

  required

  string

  uid: stopBits

  Stop bits must be set as string, number format is not supported!

  Default value:"1"

  Allowed values:
  • "1"
  • "1.5"
  • "2"

  parity

  required

  string

  uid: parity

  Default value:"none"

  Allowed values:
  • "none"
  • "even"
  • "odd"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #ucd3

  Examples

  Payload

  {
    "type": "event",
    "msg": "port_mode",
    "port": 1,
    "mode": "AUTO",
    "active_mode": "AUTO",
    "supported_modes": "AUTO",
    "uart": {
      "baud_rate": 9600,
      "data_bits": 8,
      "stop_bits": "1",
      "parity": "none"
    }
  }
  

  This example has been generated automatically.