pixoo_overlay_text
pixoo_overlay_textSet or clear persistent scrolling text overlays on Pixoo displays using device-native fonts. Overlays remain active across channel switches until explicitly removed.
Instructions
Set or clear a device-native scrolling text overlay. Use mode "set" to add or update an overlay on a slot (0–19); use mode "clear" to remove it. Overlays use device-rendered fonts (115 font IDs, 0–114) and persist across channel switches until explicitly cleared with mode "clear". Not previewable — rendering happens on-device. Best for persistent tickers over pushed scenes; for styled, previewable text use pixoo_display_text instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | set = add/update overlay; clear = remove it. | |
| id | Yes | Overlay slot ID (0–19). Each ID is an independent overlay layer. | |
| text | No | Text to display (required for mode=set). | |
| x | No | X start position on display (default: 0). | |
| y | No | Y start position on display (default: 0). | |
| font | No | Device font ID (0–114). 0 = default, 18 = arrows, 20 = °C/°F. Device-rendered; no preview. | |
| color | No | Text color as CSS hex color (default: white). | #ffffff |
| speed | No | Scroll speed (0–100, device units; default: 50). | |
| direction | No | Scroll direction (default: left). | left |
| align | No | Text alignment (default: left). | left |
| width | No | Text region width in pixels (optional; defaults to display width). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| acknowledged | Yes | True when the device confirmed the overlay command (error_code: 0). | |
| mode | Yes | Operation performed: "set" (overlay added/updated) or "clear" (overlay removed). | |
| id | Yes | The overlay slot ID (0–19) that was operated on. |