Captures packets from network interfaces using SnifferDriver. Supports local, remote, or both directions, and optional pcap filters.

          "driver": {
            "name": "SnifferDriver",
            "active": true,
            "adapter": "\\Device\\NPF_Loopback",
            "filter": "udp",
            "remoteIP": "127.0.0.1",
            "remotePort": 0,
            "localIP": "127.0.0.1",
            "localPort": 3021,
            "source": "remote",
            "destination": "remote"
            //https://www.tcpdump.org/manpages/pcap-filter.7.html
          }
        

Field Reference

Interfaces with NI DAQ cards. Supports multiple ports, read/write configuration, raw types, and power-up states.

      "driver": {
        "name": "NI65xxDriver",
        "active": true,
        "CardType": "MX",
        "DeviceID": 1,
        "PortNum": 2,
        "PowerUpState": "low", //"high" , "TriState", "NA"
        "RawType": "U", //BI binary signed, BU binary unsigned, U unsigned, F analog float64
        "LinesPerPort": 16, //16, 32, 64 floats
        "Port0": "R",
        "Port1": "W",
        ...
        "PortX": "W"
      }
    

Field Reference

Socket driver for UDP and TCP. Supports multiple IN/OUT blocks, optional header markers, and raw counter bytes.

      "driver": {
        "name": "UDPSocketDriver",
        "active": true,
        "remoteIP": "172.30.176.2",
        "remoteIPBind": "172.30.192.1",
        "remotePortBind": 8081,
        "remotePort": 8081,
        "localIP": "172.30.192.1",
        "localPort": 8081
      }
    

High-speed FPGA streaming. Supports video frames, frame sync, metadata, and static/dynamic streaming modes.

      "driver": {
        "name": "XDMADriver",
        "DeviceGuid": "{74c7e4a9-6d5d-4a70-bc0d-20691dff9e9d}",
        "userBaseAddress": "0x00020000",
        "DDR_BASE": "0x88000000",
        "DeviceIndex": 0,
        "FrameWidth": 640,
        "FrameHeight": 512,
        "BPP": 2,
        "FrameRateUs": 200000,
        "FrameSyncDelayMs": 10,
        "AddMetadata": "Yes",
        //StreamingMode=Static/Dynamic",
        "StreamingMode": "Static",
        //SyncSource=Internal/External/Sim
        "SyncSource": "External"
      }
    

CIGI protocol driver.

      "driver": {
        "name": "CIGIDriver",
        "remoteIP": "127.0.0.1",
        "remotePort": 8015,
        "localIP": "",
        "localPort": 8014
      }
    

Serial port driver for telemetry, commands, and sensors. Configurable COM port, baud rate, parity, stop bits, flow control, USB latency, buffer sizes, and overlapping mode.

      "driver": {
        "name": "SerialDriver",
        "comPort": "\\\\.\\com5",
        "baudRate": 921600,
        "parity": 0,
        "stopBits": 1,
        "byteSize": 8,
        "latency": 1, //-1 report port latency, 0 use default latency, >0 set latency in ms
        "flowcontrol": "none", //"software", "hardware", "none"
        "totalTimeoutConstant": 0,
        "overlapping": "yes",
        "InBufferSize": "auto",
        "OutBufferSize": "auto"
      }
    }
    

Understanding flowcontrol

Flow control decides how the two ends of the link tell each other to pause sending when a receive buffer is filling up, so bytes aren't silently dropped.

• "none" — No pacing at all; the sender never slows down for the receiver. Simplest and lowest-overhead option. Fine for low/moderate baud rates or protocols that fit comfortably within the driver's buffers (short framed messages, telemetry that isn't continuously bursty). At sustained high baud rates with a slow-to-drain receiver, "none" risks buffer overrun and dropped bytes.
• "hardware" — Uses the RTS/CTS signal lines: the receiving side de-asserts CTS to tell the sender to pause, and re-asserts it once buffer space is free. Signaling happens on dedicated wires, so it never touches the data stream, works with binary protocols, and reacts almost instantly. Use this whenever the cable/adapter wires RTS/CTS and you're running high sustained baud rates or long bursts of data (e.g. firmware/log streaming) — it's the safest option for high-throughput links.
• "software" — Uses in-band XON/XOFF control characters to pause/resume the stream. Only appropriate for plain ASCII/text protocols: because it reserves two byte values inside the data itself, it will corrupt any binary protocol where those byte values occur naturally as payload data. Mostly relevant for legacy modem/terminal links; avoid it for ICD binary messages.

Default recommendation: use "none" for framed binary protocols at moderate baud rates, switch to "hardware" if you see overruns at high baud rates and the wiring supports RTS/CTS, and reserve "software" for legacy text-only links.

Understanding latency

Most COM ports used with APIC are USB-to-serial adapters (FTDI, CP210x, CH340, etc.). Their driver briefly buffers incoming bytes for a fixed window — the "latency timer" — before handing them to the application, trading a little delay for fewer, larger USB transfers. On Windows this default is commonly 16 ms, which is negligible for logging but can add noticeable, variable delay to time-critical command/response or control-loop traffic.

• latency: -1 — Query only: reports the port's currently configured latency without changing it. Useful for diagnostics.
• latency: 0 — Leave the driver/OS default latency in place. Good enough for low baud rates (9600–57600) or non-time-critical bulk/log streams, where minimizing USB overhead matters more than shaving a few milliseconds.
• latency: >0 (e.g. 1) — Explicitly sets the latency timer to that many milliseconds. Use a low value like 1 ms for high baud rates (typically ≥115200, as in the 921600 example above) driving real-time telemetry, command/response, or hardware-in-the-loop links where deterministic, low-jitter byte delivery matters more than USB bus efficiency. This increases USB polling frequency and CPU/bus overhead slightly, so don't set it unnecessarily low on links that aren't timing-sensitive.

Serial port driver using UEI solutions. Configurable COM port, baud rate, parity, stop bits, buffer sizes, and overlapping mode.

      "driver": {
        "name": "UEISerialDriver",
        "ip": "192.168.100.102",
        //Serial standard settings
        "comPort": "\\\\.\\COM10",
        "baudRate": 921600,
        "parity": 0,
        "stopBits": 1,
        "byteSize": 8,
        "totalTimeoutConstant": 10,
        "InBufferSize": "auto",
        "OutBufferSize": "4096"
      }
    }
    

Video streaming driver using FFMpeg solution. Configurable video camera streaming properties

      "driver": {
        "name": "FFMPegDriver",
        "cameraName": "Lenovo FHD Webcam",
        "format": "yuvj422p",
        "fps": 30,
        "width": 640,
        "height": 480,
        "bufferSizeMB": 10
      }
    }
    

Video streaming driver using FFMpeg solution. Configurable video camera streaming properties

      "driver": {
        "name": "GenICamDriver",
        "cameraName": "Lenovo FHD Webcam",
        "format": "yuvj422p",
        "externalSync": {
          "line": "Line4",
          "activation": "RisingEdge"
        },
        "fps": 30,
        "width": 640,
        "height": 480,
        "numOfPreAllocatedBuffers": 16,
        "waitForFrameTimeout_us": 0,
      }
    }
    

Shared memory interface for inter-process communication. Supports configurable filename and size.

        "driver": {
            "name": "ShmemDriver",
            "filename": "sharememFilename",
            "size": 2048
        }
    

Field Reference

HTTP/SFTP stream. Supports protocol, IP, port, URLs, and custom headers.

      "driver": {
        "name": "INETDriver",
        "protocol": "http", //sftp / http
        //"IP": "192.168.1.103",
        "IP": "127.0.0.1",
        "port": 30000,
        "URL": "/api/v0/{1}",
        "header": {
          "Content-Type": "application/json",
          "Accept": "text/json",
          "Accept-Language": "en-US",
          "Cache-Control": "no-cache"
        }
      }
    }
    

Field Reference

Header Fields

The GDL90 driver implements standard protocal for aviation entities display.

      "driver": {
          "name": "GDL90Driver",
          "active": true,
          "remoteIP": "127.0.0.1",
          "remotePort": 4000,
          "localIP": "",
          "localPort": 4001
      }
    }
    

Field Reference