Content
Summary
This document provides information about the Generic Rest API implementation for VSM.
| Status of Driver | |
|---|
| Component for Driver | |
|---|
| Release (Build) of Component | vsmGadgetserver 5.6.1.200 |
|---|
| Revision of Implementation | 1.0.1.0 |
|---|
| Name/Type of 3rd Party API | AJA Generic REST API |
|---|
| Version of 3rd Party API | FS4 version 2.0.1.5 FS|HDR version 4.1.0.43
|
|---|
| Additional 3rd Party information |
|
|---|
Connection
| Connection Type | TCP/ IP |
|---|
| Default Port | 80 (HTTP) |
|---|
Supported Features
The implementation tries to show all visible parameters from the FS(4|HDR) device. An internal and undocumented index to name mapping is implemented to show same group names as the WebUi. If the root node shows child nodes as Unknown Group - XY then no mapping name has been found for the reported parameter group index. In this case you propably interfacing an unsupported/untested device type or there is a newer firmware talking to us.
Group nodes can have parameters and also one level of sub nodes(menu nodes like) which when the naming is Menu_XY then we could not create a meaninful name.
Supported Commands
| desc.json | Downloads the definition file. |
|---|
| map.json | Downloads the mapping file. |
|---|
| config?action=connect | Registers for polling. |
|---|
| config?action=set¶mid={parameterId}&value={parameterValue} | Changes the value of a parameter. |
|---|
| config?action=wait_for_config_events&connectionid={connectionId] | Waits for value change events. |
|---|
Configuration Details
Known Issues