Veona Connect — Command Line

Veona Connect runs as a small application on a PC inside your laboratory network. It speaks to your analysers and imaging machines and forwards their results to Veona. Alongside the on-screen console, Connect ships a simple command-line tool — veona — that your lab’s IT or operator uses to list the instruments Connect supports, check a configuration before going live, and test that every device is reachable.

This page is a reference for that tool. For what Connect does and how results flow into a requisition, see the Connect module page.

Note

These commands are run by the person who looks after the Connect PC (your lab IT or a Veona engineer), in a terminal on that machine. They are safe to run at any time — devices, validate and doctor only read; they never change anything.

Running the tool

The tool is the veona command, available on the machine where Connect is installed. Ask for help at any time:

veona --help            # the list of commands
veona devices --help    # the options for one command

usage: veona [-h] {admin,doctor,devices,validate,run} ...

positional arguments:
    admin       serve the on-screen console and run the bridge
    doctor      test the connection to every device in a configuration
    devices     list the instruments Connect supports
    validate    check a configuration file
    run         start the bridge from a configuration file

List supported instruments — veona devices

Lists every instrument Connect can talk to, grouped by how thoroughly each has been verified.

veona devices

348 instrument codecs registered:

── FILE_INGEST ──
  ↑ fully_chem                  (Fully) Fully chemistry analyzer (OpenELIS Fully plugin)  [chemistry]
  ↑ openelis_generic_file       (generic) OpenELIS GenericFile (configurable file import)  [file-ingest]
  ...
── SPEC_PENDING ──
  ↑ mission_u120                ACON Laboratories Mission U120 / U120 Smart (urine strip)  [urinalysis (chemistry strip)]
  ...
── VARIANT ──
  ⇅ abbott_architect_ci4000     Abbott ARCHITECT ci4000  [chemistry]
  ...
── VERIFIED ──
  ↑ generic_csv                 (generic) Delimited file export (CSV/TSV)  [file-ingest]
  ⇅ generic_astm                (generic) Standard ASTM E1394 / LIS2-A2 analyzer  [generic]
  ...

Show just one group with --maturity:

veona devices --maturity verified

Reading the list

• The first symbol is the direction of the link: ⇅ two-way (Veona can send orders down and receive results up), ↑ results only (the instrument sends results up), · neither.
• The group headers describe how each instrument has been confirmed:
  • verified — tested against the manufacturer’s own sample messages.
  • variant — a model that reuses a verified instrument’s identical protocol.
  • file_ingest — no live protocol; Connect reads the file the instrument exports.
  • spec_pending — listed with accurate details; the final confirmation is waiting on a sample message or specification from the device.

Check a configuration — veona validate

Reads your configuration file and reports exactly what it would set up — without connecting to anything. Run this before going live.

veona validate devices.yaml

OK — 2 device(s), 1 channel(s)
  device chem-1: codec=mindray_bs230 transport=tcp_server caps=bi
  device hema-1: codec=sysmex_xn transport=tcp_server caps=bi
  channel sync

caps=bi means a two-way device; caps=uni means results-only. If anything is wrong (an unknown instrument, a missing setting), the command points to the exact cause so you can fix that line and run it again.

Test every device — veona doctor

Runs a connection test against every device in your configuration and prints a health report, then a pass count.

veona doctor devices.yaml

  ✓ chem-1               ok       OK — codec round-trips, tcp_server reachable (0.2 ms)
  ✓ hema-1               ok       OK — codec round-trips, tcp_server reachable (0.1 ms)

2/2 devices OK

Each device shows ✓ ok, … pending (waiting on a device sample), ! warn, or ✗ fail with the reason. A device that can’t be reached shows ✗ fail — a quick way to confirm cabling and network before a clinic opens.

Tip

veona doctor reports a failure code when any device is unreachable, so your IT team can wire it into a simple monitoring check that flags a disconnected analyser.

Start the bridge — veona run and veona admin

Normally Connect starts automatically as a background service, but it can be started by hand:

• veona run devices.yaml — start the bridge with no screen (headless).
• veona admin devices.yaml — start the bridge and the on-screen console, where you can switch equipment on and off, run a connection test, and view logs in a browser.

Veona Connect admin console → http://127.0.0.1:8770  (2 devices, 1 channels)

Then open the address shown in a web browser on the same machine.

Note

Installing Connect, writing the device configuration, and connecting it securely to Veona are handled with your Veona representative during setup. This page covers the day-to-day commands once Connect is in place.