Control Plane Message Format

Control Plane Message Format Overview

This specification defines the Control Plane Message format for performing actions with the rack or virtual device.

Message Handlers

• Remote

Remote Message Structure

YAML Example: sending 3 independent key events

remote:
  - event: 
      key: "KEY_ENTER" 
  - event:
      key: "KEY_UP"
      delay: 1
  - event:
      key: "KEY_DOWN"
      repeat: 3

Possible Fields

remote: # (required) A list of event objects
  - event: # (required) An event object representing a key action
      key: "KEY_ENTER" # (required) Key to be pressed
      map: "rc6" # (optional) Remove key map
      delay: 2 # (optional) Delay in seconds (optional, defaults to 0)
      repeat: 3 # (optional) Number of repetitions (optional, defaults to 1)

Constraints

• remote: (required) The remote object must be a list containing one or more event objects.
  • event: (required) Each event object must have a valid key field (e.g., "KEY_ENTER", "KEY_UP") Refer to rcCodes.py
  • map: (optional) Remote Key Map Translation table to use (defaults to the first map)
  • delay: (optional) If specified, must be a non-negative integer.
  • repeat: (optional) If specified, must be a non-negative integer.