The API Evaluation Toolkit is software tool for accessing the API of the Carrier Board and Module over UART. The toolkit supports up to two boards connected simultaneously (ex. encoder and decoder). It auto-detects boards connected via UART, and auto-configures IP addresses to get you started quickly.
Command | Description |
---|---|
rescan | Close open ports, scan for valid boards. |
e | Select Encoder as the API target. |
d | Select Decoder as the API target. |
pc [manual_ip] | PC's local IP address - If not detected, may be manually set with this cmd. |
e-pc [and_play?] | Encoder to PC - Configure Encoder board to send stream to PC (open with VLC). If and_play=1 given, play the stream using VLC/FFPLAY. |
e-d | Encoder to Decoder - Read IP address of Decoder board, configure Encoder board to send stream to Decoder board. |
list | List the detected API endpoints. |
Please note that command parameters are usually optional. When parameter is given, the value is written; when no parameter is provided, the current value is read back.
First set API target to Encoder with the "e" command.
Command | Description |
---|---|
rx [[A.B.C.D][:port]] | Board IP address (receiving streams) |
tx [[A.B.C.D][:port]] | Stream destination IP address (sending streams) |
rst | Reset encoder core |
| PCR offset (decode time allowance per frame) |
res [[width]x[height]] | Check detected resolution, or crop from top-left |
fps | Read detected frame-rate |
decimate [[keep]/[total]] | Skip frames (ex. 1/2 = skip every 2nd, 1/3 = skip every 3rd) |
vbr [bitrate_mbps] | Set target bitrate (called VBR, but implementation is really CRF - encoder is adjuted to meet the target bitrate) |
cbr [bitrate_mbps] [null] | Set a bitrate ceiling, with optional null padding bytes. |
cqp [qp 0-51] | Contant-QP |
chroma [420/422] | Chroma format (4:2:0 or 4:2:2) (if supported) |
depth [8/10] | Bit-depth 8bit or 10bit (if supported) |
gop [value] | Set the group-of-pictures [value] values:
|
isize [0-15] | I-frame size factor relative to baseline bitrate |
stats | Print a summary of Encoder paramaters |
First set API target to Decoder with the "d" command.
Command | Description |
---|---|
rx [[A.B.C.D][:port]] | Board IP address (receiving streams) |
Command | Description |
---|---|
r <prefix><address> // or "rd" |
|
w <prefix><address> <value>[.d|.h|.b] // or "wr" |
|
.<command> | Direct serial command - prefix "." to send string directly (ex. r00aa) |