Overview

The Axis Network IO Read node reads data from an Axis device over the network. This node makes it easy to build common use cases such as reading sensor data, triggering alarms, etc.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : Axis IO Port Status

Properties

Property	Description	Type	Default	Required
`vapix_virtual_io_port`	Comma separated Digital IO port numbers to read. Refer to your device's documentation for supported IO port listing.	`string`	`null`	Yes
`metadata_name`	Customizable name for the values read from the specified ports. This will be accessible in downstream metadata, with 'delta' and 'state' fields. Alphanumeric characters and underscores only.	`string`	`null`	No
`ip_address`	IP address of the VAPIX device.	`string`	`null`	Yes
`vapix_username`	VAPIX authentication username	`string`	`null`	Yes
`vapix_password`	VAPIX authentication password	`string`	`null`	Yes
`use_https`	Whether to use a secure HTTPS connection for the VAPIX request.	`bool`	`false`	No
`insecure`	Whether the TLS certificate used for the HTTPS connection should be verified. Conditional on `use_https` being `true`.	`bool`	`false`	No
`reconfigure_ports`	If true, reconfigure the specified Digital IO ports to be Inputs.	`bool`	`false`	No
`input_type`	Input type. Options: Active Closed (`closed`); Active Open (`open`).	`enum`	`closed`	Yes
`debug`	Debug	`bool`	`false`	No

Note: Virtual IO port and Digital IO port are not network ports. They refer to digital IO interfaces on the Axis device.

Output Metadata

The fields below are declared by this node's metadata schema; the JSON values are representative examples.

Path	Type	Description
`nodes.<node_id>.all_pin_delta`	`boolean`	When all pins have a change in state
`nodes.<node_id>.all_pin_state`	`boolean`	Boolean indicating whether all configured input pins are active.
`nodes.<node_id>.any_pin_delta`	`boolean`	When any pin has a change in state
`nodes.<node_id>.any_pin_state`	`boolean`	Boolean indicating whether any configured input pin is active.
`nodes.<node_id>.pins.<pin_number>.delta`	`integer`	When the specified pin has a change in state
`nodes.<node_id>.pins.<pin_number>.state`	`integer`	Current numeric state reported for this input pin.
`nodes.<node_id>.type`	`string`	Identifies the node type that produced this metadata.

JSON example

{
  "nodes": {
    "axis_network_io_read1": {
      "all_pin_delta": false,
      "all_pin_state": false,
      "any_pin_delta": false,
      "any_pin_state": false,
      "pins": {
        "pin_number": {
          "delta": 0,
          "state": 0
        }
      },
      "type": "axis_network_io_read"
    }
  }
}