Axis Network IO Read
Read a virtual IO port on an Axis device (or one that otherwise supports VAPIX).
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 | true |
| 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 | false |
| ip_address | IP address of the VAPIX device. Can be an IP address, FQDN or IP:API_Port format. | string | null | true |
| vapix_username | VAPIX authentication username. | string | null | true |
| vapix_password | VAPIX authentication password. | string | null | true |
| use_https | Whether to use a secure HTTPS connection for the VAPIX request. | bool | false | false |
| insecure | Whether the TLS certificate used for the HTTPS connection should be verified. Conditional on 'use_https'. | bool | false | false |
| reconfigure_ports | If true, reconfigure the specified Digital IO ports to be Inputs. | bool | false | false |
| input_type | Input type. Supported values: 'Active Closed' (closed), 'Active Open' (open). | enum | 'closed' | true |
| debug | Debug. | bool | false | false |
Note: Virtual IO port and Digital IO port are not network ports. They refer to digital IO interfaces on the Axis device.
Metadata
| Metadata Property | Description |
|---|---|
nodes.<node_id> | Describes the data read from the Axis device. <node_id> for Axis Network IO Read Nodes is of the form axis_network_io_readX (ex. axis_network_io_read1). |
nodes.<node_id>.all_pin_delta | A boolean value indicating if there is a change in any of the pin states. |
nodes.<node_id>.all_pin_state | A boolean value indicating the state of all pins. |
nodes.<node_id>.any_pin_delta | A boolean value indicating if there is a change in the state of at least one pin. |
nodes.<node_id>.any_pin_state | A boolean value indicating the state of any pin. |
nodes.<node_id>.pins.<pin_number or metadata_name>.delta | A boolean value indicating if there is a change in the state of the specified pin. |
nodes.<node_id>.pins.<pin_number or metadata_name>.state | A boolean value indicating the state of the specified pin. |
Example
Updated 10 months ago