http_api |
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
http_api [2025/01/07 17:00] cflintiii [user_remove] |
http_api [2025/04/16 15:32] (current) anthony [PtzAuxiliary] |
||
|---|---|---|---|
| Line 1889: | Line 1889: | ||
| ---- | ---- | ||
| - | //**data **// Parse the JSON formatted data and retrieve the mode, position and speed value. | + | //**data **// JSON formatted table with parameters: |
| + | |||
| + | * **idx** (integer) - PTZ index. Possible values: 0, 1. | ||
| + | * **Value** (integer) - ON/OFF state of the PTZ AUX function. Possible values: 0 - OFF, 1 - ON. | ||
| + | * **AuxId ** (integer) - PTZ AUX index. Possible values: 0 to 255. | ||
| == Returns: == | == Returns: == | ||
| Line 1898: | Line 1902: | ||
| **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | + | **//status//** String describing the failure when **ret** is 1. "OK" on success. |
| ---- | ---- | ||
| + | |||
| ==== PtzClearPreset ==== | ==== PtzClearPreset ==== | ||
| Line 20571: | Line 20576: | ||
| //**data**// Parse the JSON formatted data and retrieve the PTZ tour spots values. | //**data**// Parse the JSON formatted data and retrieve the PTZ tour spots values. | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== UpdateTerm ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Control serial port terminal server for VISCA | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**data**// Parse the JSON formatted data and retrieve the terminal server values. | ||
| - | |||
| - | //**term_mode**// Possible values: client, server | ||
| - | |||
| - | //**term_protocol**// Possible values: clearchannel, telnet | ||
| - | |||
| - | //**term_localport**// Local TCP port (for server mode) | ||
| - | |||
| - | //**term_servaddr**// Remote IP address (for client mode only) | ||
| - | |||
| - | //**term_servport**// Remote TCP port (for client mode only) | ||
| - | |||
| - | //**term_data_bits**// number of data bits. | ||
| - | |||
| - | //**term_parity**// Possible values: None, Odd, Even, Mark, Space | ||
| - | |||
| - | //**term_stop_bits**// Stop bits sent at the end of every character. | ||
| - | |||
| - | //**term_baudrate**// Possible values: 9600, 19200, 38400, 57600, 115200 | ||
| - | |||
| - | //**term_devicefile**// device fine name | ||
| - | |||
| - | //**term_function**// functionality | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== user_add ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Add a new user in the Database. | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**Name**// Get new user name | ||
| - | |||
| - | //**Level**// Get the level of permission for the new user name. Possible value: 0 to 7. | ||
| - | |||
| - | //**Password**// Get the password for the new user name. | ||
| == Returns: == | == Returns: == | ||
http_api.1736269203.txt.gz · Last modified: 2025/01/07 17:00 by cflintiii
Page Tools
