pyVOYIS

Python library for controlling the Voyis Recon LS camera, strobes and laser system.

Installation

Use pip to install the library:

pip install pyvoyis

Usage

The library can be used as standalone or as a module. The following examples show how to use it as a module.

from pyvoyis import VoyisAPI, Configuration

# Create a configuration object
c = Configuration()

# Set your parameters
c.ip_address = "192.168.1.10"
c.port = 4875

# Instance the API
api = VoyisAPI(c)

# If you want the acquision to start straight away, you can request it
api.request_acquisition()

api.run()  # This will block until the acquisition is finished and the API disconnected

# From a different thread, you can request a stop
api.request_stop()

or you can call the API from the command line:

pyvoyis --ip 192.168.1.10 --port 4875

and it will start the acquisition and block until it's stopped with Ctrl+C.

Configuration

All configuration parameters can be set via YAML file, and the file needs to be provided to the API either via the module or via command-line.

pyvoyis --config config/pyvoyis.yaml

See config/pyvoyis.yaml for more information.

Notes

If the IP address of the time source or nav source are not "pingable" the device does not report and AckRsp. Sometimes it might realise and return a "Bad parameter" error.

Can the laser be disabled via software?

Set laser intensity to zero or laser camera frequency to 0 Hz.

What are the max frequencies for cameras?

If the raw laser images are saved to disk, its frequency is currently limited to 1 Hz.

Laser calibration

Can we take images of the laser with both cameras? (e.g. leave the laser ON continuously and disable the strobes?)