Monitorian Documentation

Time commands execute a sequence of actions at a specific daily time.

Requirements:

• The commands must be defined in a JSON array.
• DueTimeHours: 0-23.
• DueTimeMinutes: 0-59.
• DurationMinutes: 1-1439. This defines a window after the due time. If the system starts or resumes within this window, the commands will execute. If the system starts after this window, they will not.
• Loading a new set of time commands will overwrite previous ones with the same due time.

JSON Schema for Commands:

• Option: SetBrightness or SetContrast
• DeviceInstanceId: String ID or null (for all).
• IsAll: Boolean.
• Value: Integer (0-100).

[
  {
    "DueTimeHours": 9,
    "DueTimeMinutes": 0,
    "DurationMinutes": 60,
    "Commands": [
      {
        "Option": "SetBrightness",
        "DeviceInstanceId": "[Device Instance ID of monitor 1]",
        "IsAll": false,
        "Value": 40
      }
    ]
  }
]

Key commands execute actions when a specific hotkey combination is pressed.

Requirements:

• The commands must be defined in a JSON array.
• KeyGesture: A combination of modifier keys (Alt, Ctrl, Shift, Windows) and a key, delimited by + (e.g., Ctrl+Alt+O).
• Description: A string describing the hotkey.
• Hotkeys must be enabled in Key Settings within the application.
• If a hotkey is already used by the OS or another app, it cannot be set.
• Increment/Decrement brightness commands are only repeatable if the entire command set for that key consists of increment/decrement actions.

Available Command Options:

• SetBrightness
• SetContrast
• SetInput (Used to change monitor input source)
• IncrementBrightness
• DecrementBrightness

[
  {
    "KeyGesture": "Ctrl+Alt+Y",
    "Description": "Monitor 1 to HDMI 1",
    "Commands": [
      {
        "Option": "SetInput",
        "DeviceInstanceId": "[Device Instance ID of monitor 1]",
        "IsAll": false,
        "Value": 17
      }
    ]
  }
]

Conditional commands execute a sequence of actions when a specific monitor's brightness reaches a certain value.

Requirements:

• The commands must be defined in a JSON array.
• Each set requires a ConditionalDeviceInstanceId (the monitor being watched), a ConditionalValue (the brightness threshold from 0-100), and a Commands array.
• To execute multiple commands for the same condition, include them in a single set.
• If the conditional monitor is in unison (mirrored), commands will not execute.
• While a conditional command is executing, other conditional, time, or key commands are suppressed.

JSON Schema for Commands:

• Option: SetBrightness or SetContrast
• DeviceInstanceId: String ID of the target monitor, or null to target all monitors.
• IsAll: Boolean; if true, applies to all monitors.
• Value: Integer (0-100).

[
  {
    "ConditionalDeviceInstanceId": "[Device Instance ID of monitor 1]",
    "ConditionalValue": 50,
    "Commands": [
      {
        "Option": "SetBrightness",
        "DeviceInstanceId": "[Device Instance ID of monitor 2]",
        "IsAll": false,
        "Value": 100
      },
      {
        "Option": "SetContrast",
        "DeviceInstanceId": "[Device Instance ID of monitor 2]",
        "IsAll": false,
        "Value": 50
      }
    ]
  }
]