http_api |
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
http_api [2020/03/04 18:45] cflintiii [HTTP API for Z3CAM / HE2K-DCK / HE4K-DCK / FV2K-DCK / FV4K-DCK/ FSDI-DCK / DME-10 / HE1080-RPS] |
http_api [2020/07/24 16:28] cflintiii [CameraControl] |
||
|---|---|---|---|
| Line 700: | Line 700: | ||
| ==== CameraControl ==== | ==== CameraControl ==== | ||
| - | |||
| Send VISCA commands to camera. | Send VISCA commands to camera. | ||
| - | |||
| Only one command can be sent at a time; the list below are the only supported VISCA commands through the HTTP API. To use VISCA commands that are not listed, usage of the TCP socket can be used to send those VISCA commands. | Only one command can be sent at a time; the list below are the only supported VISCA commands through the HTTP API. To use VISCA commands that are not listed, usage of the TCP socket can be used to send those VISCA commands. | ||
| - | |||
| API Format: | API Format: | ||
| + | <code> | ||
| + | action=CameraControl&command=visca_command&cam_index=1 | ||
| - | <code> | ||
| - | action=CameraControl&command=visca_command | ||
| </code> | </code> | ||
| - | + | **example:** | |
| - | **example:** | + | |
| Commands without value assignments | Commands without value assignments | ||
| + | <code> | ||
| + | action=CameraControl&command=dzoom_off&cam_index=1 | ||
| - | <code> | ||
| - | action=CameraControl&command=dzoom_off | ||
| </code> | </code> | ||
| - | |||
| Commands with value assignments | Commands with value assignments | ||
| + | <code> | ||
| + | action=CameraControl&command=set_monitor_mode 1080p-59.94&cam_index=1 | ||
| - | <code> | ||
| - | action=CameraControl&command=set_monitor_mode 1080p-59.94 | ||
| </code> | </code> | ||
| - | |||
| The commands use the same syntax as the serial menu "V" command, as shown below | The commands use the same syntax as the serial menu "V" command, as shown below | ||
| - | |||
| For the most current list of VISCA commands supported press "V" from the Serial/SSH session of the Serial Menu. | For the most current list of VISCA commands supported press "V" from the Serial/SSH session of the Serial Menu. | ||
| - | |||
| <code> | <code> | ||
| - | auto_icr_disable | + | auto_icr_disable |
| - | auto_icr_enable | + | auto_icr_enable |
| - | cam_control_inquiry | + | cam_control_inquiry |
| - | cam_custom_recall | + | cam_custom_recall |
| - | cam_custom_reset | + | cam_custom_reset |
| - | cam_custom_set | + | cam_custom_set |
| - | chroma_get_suppress | + | chroma_get_suppress |
| chroma_suppress Set Chroma Suppression (0=none, 1 to 3=chroma supression strength) | chroma_suppress Set Chroma Suppression (0=none, 1 to 3=chroma supression strength) | ||
| - | clear_if | + | clear_if |
| color_gain Set Color gain (0=60%, 14=200%) | color_gain Set Color gain (0=60%, 14=200%) | ||
| - | color_get_gain | + | color_get_gain |
| - | color_get_hue | + | color_get_hue |
| color_hue Set Color hue (0=-14 degrees, 14=+14 degrees) | color_hue Set Color hue (0=-14 degrees, 14=+14 degrees) | ||
| - | debug_rx | + | debug_rx |
| - | dzoom_combine_mode | + | dzoom_combine_mode |
| dzoom_direct D-Zoom Position (0x00 to 0xeb) | dzoom_direct D-Zoom Position (0x00 to 0xeb) | ||
| * Enabled during Separate mode | * Enabled during Separate mode | ||
| - | dzoom_off | + | dzoom_off |
| - | dzoom_on | + | dzoom_on |
| - | dzoom_separate_mode | + | dzoom_separate_mode |
| - | dzoom_stop | + | dzoom_stop |
| - | dzoom_super_res | + | dzoom_super_res |
| dzoom_tele_var p = 0 (Low) .. 7 (High) | dzoom_tele_var p = 0 (Low) .. 7 (High) | ||
| * Enabled during Separate Mode | * Enabled during Separate Mode | ||
| dzoom_wide_var p = 0 (Low) .. 7 (High) | dzoom_wide_var p = 0 (Low) .. 7 (High) | ||
| * Enabled during Separate Mode | * Enabled during Separate Mode | ||
| - | dzoom_x1_max | + | dzoom_x1_max |
| - | eflip_off | + | eflip_off |
| - | eflip_on | + | eflip_on |
| - | ext1_func_inquiry | + | ext1_func_inquiry |
| - | ext2_func_inquiry | + | ext2_func_inquiry |
| - | ext3_func_inquiry | + | ext3_func_inquiry |
| - | focus_auto | + | focus_auto |
| focus_direct focus pos | focus_direct focus pos | ||
| Min. 0x1000 Over Inf | Min. 0x1000 Over Inf | ||
| Line 790: | Line 781: | ||
| 0xd000 6cm | 0xd000 6cm | ||
| 0xe000 1cm | 0xe000 1cm | ||
| - | focus_get_mode | + | focus_get_mode |
| - | focus_get_pos | + | focus_get_pos |
| - | focus_manual | + | focus_manual |
| focus_near_limit focus near limit | focus_near_limit focus near limit | ||
| Min. 0x1000 Over Inf | Min. 0x1000 Over Inf | ||
| Line 808: | Line 799: | ||
| 0xd000 6cm | 0xd000 6cm | ||
| 0xe000 1cm | 0xe000 1cm | ||
| - | focus_stop | + | focus_stop |
| - | focus_tele_std | + | focus_tele_std |
| focus_tele_var p = 0 (Low) .. 7 (High) | focus_tele_var p = 0 (Low) .. 7 (High) | ||
| - | focus_toggle | + | focus_toggle |
| - | focus_wide_std | + | focus_wide_std |
| focus_wide_var p (0 (Low) .. 7 (High)) | focus_wide_var p (0 (Low) .. 7 (High)) | ||
| get_low_delay_mode Get low delay mode: 0 - normal, 1 - low delay | get_low_delay_mode Get low delay mode: 0 - normal, 1 - low delay | ||
| get_monitor_mode get_monitor_mode: Get video mode of camera output | get_monitor_mode get_monitor_mode: Get video mode of camera output | ||
| - | help | + | help |
| - | high_sensitivity_off | + | high_sensitivity_off |
| - | high_sensitivity_on | + | high_sensitivity_on |
| icr_mode modes: | icr_mode modes: | ||
| - | auto | + | auto |
| on | on | ||
| off | off | ||
| threshold [0-255] | threshold [0-255] | ||
| - | lens_control_inquiry | + | lens_control_inquiry |
| - | lens_get_temp | + | lens_get_temp |
| - | lr_reverse_off | + | lr_reverse_off |
| - | lr_reverse_on | + | lr_reverse_on |
| - | other_inquiry | + | other_inquiry |
| - | power_inquiry | + | power_inquiry |
| - | power_off | + | power_off |
| - | power_on | + | power_on |
| register_read Read internal register. | register_read Read internal register. | ||
| register_write Write internal register. | register_write Write internal register. | ||
| * Note: To make register changes effective, run power_off and power_on | * Note: To make register changes effective, run power_off and power_on | ||
| - | set_address | + | set_address |
| set_low_delay_mode Set low delay mode: 0 - normal, 1 - low delay | set_low_delay_mode Set low delay mode: 0 - normal, 1 - low delay | ||
| set_monitor_mode Set monitor mode. | set_monitor_mode Set monitor mode. | ||
| Line 851: | Line 842: | ||
| limit [0-255] | limit [0-255] | ||
| trace enable (0=off, 1=on) | trace enable (0=off, 1=on) | ||
| - | version_inquiry | + | version_inquiry |
| - | wb_auto_mode | + | wb_auto_mode |
| - | wb_autotrace_mode | + | wb_autotrace_mode |
| - | wb_get_bgain | + | wb_get_bgain |
| - | wb_get_mode | + | wb_get_mode |
| - | wb_get_mode_name | + | wb_get_mode_name |
| - | wb_get_rgain | + | wb_get_rgain |
| - | wb_indoor_mode | + | wb_indoor_mode |
| wb_manual_bgain_direct Set Manual WB BGain (0..255) | wb_manual_bgain_direct Set Manual WB BGain (0..255) | ||
| * Enabled during Manual WB mode | * Enabled during Manual WB mode | ||
| - | wb_manual_bgain_reset | + | wb_manual_bgain_reset |
| - | wb_manual_mode | + | wb_manual_mode |
| wb_manual_rgain_direct Set Manual WB RGain (0..255) | wb_manual_rgain_direct Set Manual WB RGain (0..255) | ||
| * Enabled during Manual WB mode | * Enabled during Manual WB mode | ||
| - | wb_manual_rgain_reset | + | wb_manual_rgain_reset |
| - | wb_onepush_mode | + | wb_onepush_mode |
| - | wb_onepush_trigger | + | wb_onepush_trigger |
| - | wb_outdoor_auto_mode | + | wb_outdoor_auto_mode |
| - | wb_outdoor_mode | + | wb_outdoor_mode |
| - | wb_sodium_lamp_auto_mode | + | wb_sodium_lamp_auto_mode |
| - | wb_sodium_lamp_fixed_mode | + | wb_sodium_lamp_fixed_mode |
| - | wb_sodium_lamp_outdoor_mode | + | wb_sodium_lamp_outdoor_mode |
| zoom_direct pos | zoom_direct pos | ||
| Min. 0x0000 | Min. 0x0000 | ||
| Line 880: | Line 871: | ||
| Max. 0x6000h (In Combine mode, DZoom=Super Resolution Zoom, and monitoring mode FHD or less) | Max. 0x6000h (In Combine mode, DZoom=Super Resolution Zoom, and monitoring mode FHD or less) | ||
| Max. 0x7AC0h (In Combine mode and DZoom=On) | Max. 0x7AC0h (In Combine mode and DZoom=On) | ||
| - | zoom_get_pos | + | zoom_get_pos |
| - | zoom_stop | + | zoom_stop |
| - | zoom_tele_std | + | zoom_tele_std |
| zoom_tele_var p = 0 (Low) .. 7 (High) | zoom_tele_var p = 0 (Low) .. 7 (High) | ||
| - | zoom_wide_std | + | zoom_wide_std |
| zoom_wide_var p (0 (Low) .. 7 (High)) | zoom_wide_var p (0 (Low) .. 7 (High)) | ||
| + | |||
| </code> | </code> | ||
| + | |||
| + | With dual VISCA camera supported added we need to tell the API which camera we want to talk to. this is done with cam_index | ||
| + | |||
| + | The values accepted are either 1 or 2 | ||
http_api.txt · Last modified: 2024/04/05 15:35 by anthony
Page Tools
