Novastar H Series Api __exclusive__ File

Master the NovaStar H Series: A Developer’s Guide to the OpenAPI 

The NovaStar H Series stands as a flagship all-in-one video splicing processor, specifically engineered for fine-pitch LED applications. For developers and system integrators, its powerful OpenAPI is the key to unlocking seamless automation and custom control.  Understanding the H Series API Architecture 

The H Series utilizes a modern HTTP-based OpenAPI that communicates using the POST method and JSON data format. Unlike older serial-only protocols, this allows for robust network-based control over standard Ethernet infrastructure.  Key Communication Specs:  Protocol: HTTP Method: POST Data Format: JSON

Default Port: Often utilizes port 6000 for UDP-based alternate commands.  Getting Started: Authentication 

To begin using the OpenAPI, you must first obtain your credentials from the device's web management interface: 

Log in to the H Series system via a web browser using its IP address (default is typically 192.168.0.10). Navigate to Settings > OpenAPI Management.

Generate or retrieve your pId (Requestor ID) and secretKey. These are essential for authenticating your JSON requests.  Core API Capabilities 

The H Series API provides granular control over nearly every aspect of the video wall’s operation. Essential commands include: 

Preset Management: You can read currently played presets, edit preset groups, and overwrite existing presets.

Layer & Source Control: Switch input sources, select specific screens (by screenId), and manipulate layers (layerId) by resizing or moving them.

Screen Adjustments: Remotely set global brightness (values 0–255), freeze or unfreeze the screen, and trigger "Fade to Black" (FTB).

IPC (IP Camera) Integration: Manage IPC source lists, add/delete channels, and configure IPC mosaic sources for security or monitoring applications.

BKG & OSD: Dynamically create, delete, or update Background (BKG) images and On-Screen Display (OSD) text or images.  Real-World Integration Tools 

For developers looking for pre-built wrappers or integration modules, several community and official tools exist:  H Series - Global leading LED display control solution novastar h series api

The NovaStar H Series Open API is a critical software interface that allows third-party developers to integrate flagship video wall splicers—such as the H2, H5, H9, H15, and H20—into custom control platforms, building automation systems, or professional AV environments. 1. Integration and Authentication

To begin using the API, administrators must first enable it within the H Series web console.

Key Credentials: The system generates a pId (Requestor ID) and a secretKey. These credentials are required to authenticate every request, ensuring secure communication between the third-party controller and the video processor.

Encryption: The H Series supports both encrypted and unencrypted transmission of request parameters, providing flexibility for different security requirements. 2. Core Functional Capabilities

The Open API provides granular control over the H Series' powerful hardware features, which can handle up to 520 million pixels on the high-end H20 model.

Preset Management: Developers can use the API to recall up to 2,000 saved presets, enabling instant scene changes during live events or in control rooms.

Layer and Source Control: The API allows for the dynamic manipulation of video layers. Users can adjust layerId, inputId (signal source), and cropId (signal cropping) programmatically.

Monitoring and Management: Integrated support for SNMP (Simple Network Management Protocol) allows for real-time monitoring of device health, such as temperature, voltage, and signal status. 3. Multi-Protocol and Environmental Support

Beyond the core RESTful API, the H Series is designed for broad interoperability:

Protocol Support: It supports RS232 and TCP/IP for central control systems, as well as IP camera protocols like RTSP, ONVIF, and GB28181 for surveillance integration.

Intelligent Control: It is compatible with hardware like the Stream Deck, allowing API commands to be mapped to physical buttons for functions like screen blackouts or OSD (On-Screen Display) toggling. 4. Technical Resource Access

While some high-level instructions are public, specific control protocols are often protected by an NDA. Developers should contact NovaStar Support to obtain the latest version of the detailed interface documents and the H Series User Manual. 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 Master the NovaStar H Series: A Developer’s Guide

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": "...", ... ]) .

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 .

Monitoring: Query device status such as temperature, voltage, and connection health . asyncio

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

5.2 Q-SYS Script (Lua)

function setInput(inputNumber)
  local socket = require("socket")
  local client = socket.tcp()
  client:connect("192.168.0.10", 5000)
  client:send("SIn " .. inputNumber .. "\r\n")
  client:close()
end

3.1 Command Format

Each command is a string terminated with \r\n (CR+LF).
<Command Name> <Parameter1> <Parameter2> ... \r\n

Response format:
(ACK|NAK) <ReturnCode> <Data>\r\n

Case B: Python Script for Automated Show Control

If you run a live event, you can script the NovaStar H series API to sync with your lighting console (DMX/Art-Net).

import asyncio
import websockets
import json
async def control_novastar_h9():
uri = "ws://192.168.1.100:8088/novastar/api"
async with websockets.connect(uri) as websocket:
# Login
await websocket.send(json.dumps(
"jsonrpc": "2.0", "method": "login",
"params": "username": "admin", "password": "123456", "id": 1
))
response = await websocket.recv()
token = json.loads(response)['result']['token']
    # Dim screen for mood lighting
    await websocket.send(json.dumps(
        "jsonrpc": "2.0", "method": "display/brightness",
        "params": "token": token, "value": 10, "id": 2
    ))
    print("Screen dimmed to 10%")

asyncio.run(control_novastar_h9())

Abstract

The NovaStar H Series (H2, H5, H9) are high-performance all-in-one LED display controllers widely used in live events, command centers, and fixed installations. This paper details the API capabilities of the H Series, covering TCP/IP-based command protocols, HTTP REST endpoints for third-party control, and integration with show control systems (Crestron, Extron, Q-SYS). Practical examples include input switching, layer management, preset recall, and device monitoring.

12) Quick reference (common ports & protocols — confirm with device docs)

• UDP discovery broadcast: often on a vendor-specified port (check manual)
• TCP control: model-dependent port (e.g., 5000–6000 range on some devices)
• HTTP web UI: 80 or 8080 (or HTTPS 443 on secure models)
• Serial: TTL/RS232/RS485 depending on hardware

If you want, I can:

• Provide sample discovery and control code in Python or Node.js for a specific H-series model.
• Produce exact packet formats and example hex sequences if you supply the controller’s protocol manual or model name/firmware version.

2.2 Control Methods

There are two primary avenues for API-level integration:

1. VNNOX Cloud API (Official): The recommended method for managing fleets or integrating with third-party CMS/platforms.
2. Local TCP/IP Protocol (Unofficial/Direct): Used for direct command injection (e.g., switching inputs, adjusting brightness) without cloud latency.

6. Security and Best Practices