
oFlow control: None
The serial lin is shared by the carrier board and the module endpoints, one at a time. The
API endpoint mode can be cycled by pressing the API Mode Cycle button. API Mode LED
indicates the endpoint that is currently lin ed.
Endpoint API Functions Available Documentation
Carrier Board API
•Networ Configuration
(send/receive IP/port)
•Test-pattern Generator
•Flash Update
•VTR-4000B API Manual
Module API
•CODEC Engine API
•CODEC System API
•Video Input API
•H.264 Encoder API Manual
•H.265 Encoder API Manual
•Encoder System API Manual
•Video Input API Manual
The API serial format is available in two formats. You may press ESC (or ENTER without
entering a value) to cycle the prompt. Important: Backspace is not supported If you ma e a
mista e, use ESC to cycle bac and restart the input.
New API 2.0 format
API 2.0 prompt loo s li e this: “>”
The New API offers a simplified interface that is easier to automate and script. To
read/write values on module endpoints send:
Read a register value:
R <address hex>
Change a register value
W <address hex> <value hex>
Legacy API 1.0 format
Legacy API prompt loo s li e this: “Enter an address(HEX):”
The API will expose an address-value prompt-loop. To change values, enter the
register address at the address prompt (in hex), and then the decimal value at the
value prompt, followed by enter. Hex values are also accepted when given an “h”
prefix/suffix, (ex. 4ABCh or h4ABC represent 0x4ABC)
You can safely press ESC at any time to cycle the prompt without changing current
values.