Novastar H Series Api < CERTIFIED ⇒ >
All commands follow the JSON-RPC 2.0 specification. You will send a request and receive a response object.
The NovaStar H Series API marks a transition from the LED display as a passive screen to an active, managed device within the Internet of Things (IoT). As NovaStar faces competition from companies like Brompton Technology (with its Tessera API) and Colorlight, the robustness of the API becomes a key differentiator. Future iterations will likely embrace RESTful APIs over HTTPS, include better event-driven webhooks (instead of constant polling), and offer SDKs in common languages like Python and C#.
In conclusion, the NovaStar H Series API is a powerful, albeit somewhat guarded, tool for professionals seeking to automate and integrate LED displays. It transforms the receiving card from a dumb data conduit into a smart, networked endpoint. For system architects, display rental companies, and broadcast engineers, mastering this API is no longer optional—it is the key to building resilient, efficient, and innovative visual environments. While documentation and security hurdles remain, the API’s ability to provide granular control over hardware parameters makes it an indispensable asset in the modern LED ecosystem.
NovaStar H Series API is a powerful but notoriously "private" control protocol designed for professional AV integration. Unlike standard open-source APIs, it is primarily a UDP-based protocol
that allows third-party controllers (like Crestron or Bitfocus Companion) to manage high-end video wall splicers. The Developer Experience: "Gatekept" and Complex Most developers describe the API as a high-barrier tool. NDA Dependency
: Official documentation is typically not public. Developers often have to sign an with NovaStar to receive the full control protocol. Documentation Quality
: Reviews from the integration community often label the documentation as challenging
or "useless" for beginners, frequently citing mismatches between the manual and real-world device behavior. Protocol Style : It uses a specific JSON-like command structure sent over UDP port 6000 . A successful command typically returns an "ack": "Ok" Core API Capabilities
For those who navigate the setup, the API offers deep control over the H-Series hardware (H2, H5, H9, H15): Preset Management : The most common use case is recalling presets for live events or corporate lobbies. Layer Control novastar h series api
: Programmatic switching of input sources, layer positioning, and "Take" functions (sending preview to live). Environmental Monitoring : Querying device status, such as temperature, fan speed, and voltage Visual Adjustments : Real-time control of brightness and screen configurations. Community Solutions
Because the official path is difficult, many pros turn to community-built modules: OPEN API or Take Function · Issue #3 - GitHub
The NovaStar H Series supports comprehensive third-party integration, offering an OpenAPI for HTTP-based control and a JSON-based protocol via UDP/RS232 for automation tasks. These interfaces enable control over video wall presets, layer management, and system monitoring. For full technical details, refer to the NovaStar H Series OpenAPI Instructions. H Series Video Wall Splicers User Manual - NovaStar
The NovaStar H Series video wall splicers utilize an OpenAPI based on the HTTP protocol with JSON data formatting for third-party control . This API allows developers to manage layers, presets, and input sources remotely . API Access & Setup
To begin using the API, you must first enable and configure the project through the device's web interface .
Login: Access the web console using the device's IP address (default is 192.168.0.10) and credentials (default: admin/admin) . Enable API: Navigate to Settings > OpenAPI Management .
Create Project: Click Add to create a new project. The system will automatically generate a pId (Project ID) and a secretKey required for authentication in your requests . Communication Protocol Method: POST . Format: JSON-based instruction set .
Encapsulation: Commands are typically enclosed in brackets (e.g., [ "cmd": "...", ... ]) . All commands follow the JSON-RPC 2
Port: The default control port is 6000 for UDP-based command packets, though standard API interactions often use the HTTP interface . Key API Command Parameters
When constructing commands, you will frequently reference these specific IDs found in the H Series Splicers Control Protocol : inputId: Unique ID for the signal source channel . screenId: The specific screen being controlled .
layerId: ID of the window/layer for positioning and source switching .
presetId: Used to recall or overwrite saved layout configurations . Common Operations
Third-party developers can perform various tasks via the H Series OpenAPI :
Presets: Read currently played presets, edit preset groups, or overwrite existing ones .
Layers: Adjust position (X, Y) and size (Width, Height) coordinates for precise layout control .
IPC Sources: Manage IP Camera source lists, including adding, deleting, or renaming channels . Set brightness (pseudo-TCP):
Monitoring: Query device status such as temperature, voltage, and connection health .
For detailed command syntax and specific JSON structures, refer to the NovaStar H Series OpenAPI Instructions or the official H Series User Manual .
If you tell me the specific programming language you're using (e.g., Python, C#, JavaScript) or the control system (e.g., Crestron, Q-SYS), I can provide a code snippet for a basic command like switching a preset. H Series Video Wall Splicers User Manual - NovaStar
The third-party developers can control video wall splicers through this connector. Click Add to add a new open API project. H Series OpenAPI Instructions - NovaStar
Note: specific byte formats vary by firmware version. Consult your device’s protocol reference for exact packet formats.
Set brightness (pseudo-TCP):
Update network settings (HTTP or TCP):
Upload panel configuration (mapping):
Firmware upgrade: