Skip to content

ipc.md

Latest commit

 

History

History
75 lines (62 loc) · 2.32 KB

ipc.md

File metadata and controls

75 lines (62 loc) · 2.32 KB

IPC protocol

For programmatic control beyond clockie ctl, you can send JSON commands directly to the Unix socket.

Socket location: $XDG_RUNTIME_DIR/clockie.sock (fallback: /tmp/clockie-$UID.sock)

Protocol: Send a single JSON object followed by a newline (\n). Read one JSON line back as the response.

Commands

Command JSON
Set face {"cmd": "set-face", "face": "digital"}
Toggle face {"cmd": "toggle-face"}
Set compact {"cmd": "set-compact", "compact": true}
Toggle compact {"cmd": "toggle-compact"}
Set font size {"cmd": "set-font-size", "size": 64.0}
Set diameter {"cmd": "set-diameter", "diameter": 200}
Scale by delta {"cmd": "scale-by", "delta": 10}
Set locked {"cmd": "set-locked", "locked": true}
Toggle locked {"cmd": "toggle-locked"}
Move to output {"cmd": "move-to-output", "name": "HDMI-A-1"}
Reload config {"cmd": "reload-config"}
Get state {"cmd": "get-state"}
Quit {"cmd": "quit"}
Gallery next {"cmd": "gallery-next"}
Gallery previous {"cmd": "gallery-prev"}
Gallery set index {"cmd": "gallery-set", "index": 2}
Gallery start rotate {"cmd": "gallery-rotate-start"} or {"cmd": "gallery-rotate-start", "interval": 5}
Gallery stop rotate {"cmd": "gallery-rotate-stop"}
Gallery set interval {"cmd": "gallery-rotate-interval", "seconds": 10}

The move-to-output command also accepts "next" and "prev" as the name to cycle through outputs.

gallery-next/gallery-prev/gallery-set operate on whichever face mode is currently active (digital or analogue).

Responses

Success:

{"ok": true}

Error:

{"ok": false, "error": "Description of the error"}

State (get-state only):

{
  "ok": true,
  "face": "digital",
  "compact": false,
  "width": 352,
  "height": 98,
  "font_size": 48.0,
  "diameter": 180,
  "config_path": "/home/user/.config/clockie/config.toml",
  "locked": false,
  "output": "eDP-1",
  "gallery_digital_index": 0,
  "gallery_analogue_index": 0,
  "gallery_digital_count": 3,
  "gallery_analogue_count": 2,
  "gallery_rotate_active": true,
  "gallery_rotate_interval": 300
}

Example with socat

echo '{"cmd":"get-state"}' | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/clockie.sock