companion-module-praisepad-present

A Bitfocus Companion module for PraisePad Present: a Stream Deck (or any surface Companion drives) presses the keys of PraisePad's console from across the room, and its buttons show what's live.

It talks to PraisePad over HTTPS only. Each press is one request; while a console is open the module asks what's live every second (every 10 seconds while none is). PraisePad never runs a show by itself: a press reaches the console that's open, live or in Practice, and the console does what that key does.

Install

Until it's in Companion's own list of modules:

1. Download praisepad-present-1.0.0.tgz from this repository's latest release.
2. In Companion 4.3 or later, open Modules, choose Import module package, and pick the file.
3. Add a connection: search the connections for PraisePad.

Using it

See companion/HELP.md, which Companion shows beside the connection. In short: add a surface in PraisePad's Present settings › Control surfaces, paste its key into the connection, and drag the presets onto your buttons.

What it sends

• POST https://app.praisepad.app/api/present/control with Authorization: Bearer pp_ctl_… and a JSON body: { "command": "next" }, "previous", "screen_off", "logo", "clear_words", "instrumental", "clear_message", "marker", "previous_section", "next_section", "captions_toggle" (pauses or resumes live captions; never starts them), { "command": "section", "kind": "verse" | "chorus" | "bridge" | "tag" | "pre-chorus", "n"?: 1–9 }, { "command": "moment", "n": 1–9 }, { "command": "message", "template": "<name>", "values"?: { "<blank>": "<words>" } } or { "command": "message", "text": "<up to 120 letters>" }. Add "presentation_id" to name one console when two run at once.
• GET https://app.praisepad.app/api/present/control/state (the same key; ?presentation=<id> to name one): { presentation, open, practice, seenAt, live: { block, label, slide, of, screen, cleared, message, recording, next } | null }. With none named it follows the console a press would go to: the live one, or with none live the one in Practice; with two of those, 409 and which ones, as a press says.

app.praisepad.app is the app; praisepad.app is the website, and a request sent there loses its key on the way to the app, so the module refuses that address.

Actions, feedbacks, variables

• Actions: Next, Back, Screen off, Logo, Clear words, Instrumental, Go to a section, Previous section, Next section (the service's sections: Before the service, Worship, Message…; from a loop before the service, Next section starts the service), Run a Moment, Show a message, Clear the message, Recording marker, Pause or resume captions.
• Feedbacks: Screen is off, Logo is on, Words are cleared, A message is showing, Recording, Captions are on, Practice, No console is running (every preset greys out with it).
• Variables: title, open, practice, block, label, slide, of, slide_of, screen, cleared, message, recording, next, next_section (the section Next section would start, "Worship"), captions (on, paused, armed, stopped or off), live.

Working on it

Node 22. npm install, then npm test (the request and state logic, with Node's own test runner) and npm run package (Companion's build tool) to make the package Companion loads (praisepad-present-<version>.tgz). It uses @companion-module/base 1.11.

License

MIT