Axis Network IO Write

Control a virtual IO port on an Axis device (or one that otherwise supports VAPIX).

Overview

The Axis Network IO Write node writes data to an Axis device over the network. This node makes it easy to build common use cases such as triggering alarms, controlling devices, etc.

Inputs & Outputs

  • Inputs : 1, Media Format : Raw Video
  • Outputs : 1, Media Format: Raw Video
  • Output Metadata : None

Pipeline usage

Place this node after the analytics or event node referenced by trigger. follow keeps the remote port synchronized with the condition, whereas activate and deactivate act when the condition becomes true and may use pulse_duration. Digital ports can optionally be reconfigured as outputs; confirm that this is safe for the connected hardware. Use HTTPS in production and enable insecure only for a trusted device whose certificate cannot be verified. The gateway must be able to reach the Axis device and the credentials need VAPIX I/O permission.

Properties

PropertyDescriptionTypeDefaultRequired
triggerDrive an IO port with the value of this condition.trigger-conditionnullYes
actionAction to take on the remote IO port when the trigger condition becomes true. When set to 'Follow condition', the port is activated or deactivated as the condition becomes true or false, respectively. Options: Follow condition (follow); Activate (activate); Deactivate (deactivate).enumfollowYes
io_port_typeType of port(s) to activate or deactivate. Options: Digital IO (digital); Virtual Input (virtual).enumdigitalYes
vapix_virtual_io_portComma separated IO port numbers to act on. Refer to your device's documentation for supported IO port listing.stringnullYes
pulse_durationDuration of Activate or Deactivate pulse in seconds. 0 means no pulse. Only used when the action is set to 'Activate' or 'Deactivate'.number0No
ip_addressIP address of the VAPIX device.stringnullYes
vapix_usernameVAPIX authentication usernamestringnullYes
vapix_passwordVAPIX authentication passwordstringnullYes
use_httpsWhether to use a secure HTTPS connection for the VAPIX request.boolfalseNo
insecureWhether the TLS certificate used for the HTTPS connection should be verified. Conditional on use_https being true.boolfalseNo
reconfigure_portsIf true, reconfigure the specified Digital IO ports to be Outputs. Conditional on io_port_type being digital.boolfalseNo
output_typeOutput type. Options: Active Closed (closed); Active Open (open). Conditional on io_port_type being digital.enumclosedYes
debugDebugboolfalseNo

Output Metadata

Node does not insert any output metadata; upstream metadata continues through the pipeline


Did this page help you?