YAML_SCHEMAS.md

way-displays YAML Schemas

Document loosely follow the YAML failsafe + JSON schema.

Enums

!!arrange

!!str : <ROW | COL>

!!align

!!str : <TOP | MIDDLE | BOTTOM | LEFT | RIGHT>

!!log_threshold

!!str : <ERROR | WARNING | INFO | DEBUG>

!!transform

!!str : <90 | 180 | 270 | FLIPPED | FLIPPED-90 | FLIPPED-180 | FLIPPED-270>

!!ipc_op

!!str : <GET | CFG_WRITE | CFG_SET | CFG_DEL>

!!rc

See [ipc.h](../inc/ipc.h)

0: success 1: warning 2: error 11: bad request 12: bad response 13: request in progress

!!cfg

Used by configuration file. See default cfg.yaml for an example.

!!map
ARRANGE: !!arrange
ALIGN: !!align
ORDER: !!seq
  - !!str
SCALING: !!bool
AUTO_SCALE: !!bool
SCALE: !!seq
  - !!map
    NAME_DESC: !!str
    SCALE: !!float
MODE: !!seq
  - !!map
    NAME_DESC: !!str
    WIDTH: !!int
    HEIGHT: !!int
    HZ: !!int
  - !!map
    NAME_DESC: !!str
    WIDTH: !!int
    HEIGHT: !!int
  - !!map
    NAME_DESC: !!str
    MAX: !!bool
TRANSFORM: !!seq
  - !!map
    NAME_DESC: !!str
    TRANSFORM: !!transform
VRR_OFF: !!seq
  - !!str
DISABLED: !!seq
  - !!str
LOG_THRESHOLD: !!log_threshold
LAPTOP_DISPLAY_PREFIX: !!str

!!lid

!!map
CLOSED: !!bool
DEVICE_PATH: !!str

!!head_state

!!map
SCALE: !!float
ENABLED: !!bool
X: !!int
Y: !!int
VRR: !!bool
MODE: !!mode

!!mode

!!map
WIDTH: !!int
HEIGHT: !!int
REFRESH_MHZ: !!int
PREFERRED: !!bool

!!head

!!map
NAME: !!str
DESCRIPTION: !!str
WIDTH_MM: !!int
HEIGHT_MM: !!int
TRANSFORM: !!transform
MAKE: !!str
MODEL: !!str
SERIAL_NUMBER: !!str
CURRENT: !!head_state
DESIRED: !!head_state
MODES: !!seq
  - !!mode

!!ipc_request

!!map
OP: !!ipc_op
LOG_THRESHOLD: !!log_threshold
CFG: !!cfg

!!ipc_response

!!map
DONE: !!bool
RC: !!rc
STATE:
  HEADS: !!seq
  - !!head
  LID: !!lid
CFG: !!cfg
MESSAGES: !!seq
  - !!map
    !!log_threshold: !!str