Overview

A Python interface for controlling Prism hardware and acquiring measurement data through shared memory communication. This API is provided by Optigon, Inc. for use with Prism hardware products.

Features

  • Control of hardware parameters (DOFs) with range validation

  • Measurement data acquisition with timeout support

  • Bed camera image capture

  • Bed position control

  • Type hints and documentation

Installation

The package is listed in the package registry on Optigon’s GitLab. Access is restricted to those with deployment keys which are provided with purchase or for evaluation. Please contact contact@optigon.us with any questions.

  1. To install with pip:

    Simply run (replacing the token info):

    pip install prismapi --index-url https://<token-name>:<token-password>@gitlab.com/api/v4/projects/64432539/packages/pypi/simple
    
  2. To install with pipenv:

    In your Pipfile, change the source to (replacing the token info):

    [[source]]
    url = "https://<token-name>:<token-password>@gitlab.com/api/v4/projects/64432539/packages/pypi/simple"
    verify_ssl = true
    name = "gitlab"
    

    then run:

    pipenv install prismapi
    

    (All other packages will be redirected to the standard “https://pypi.org/simple” source)

Quick Start

After installing, see the “Getting Started” example in the examples section.

Support

For technical support, please contact:

License

This software is proprietary to Optigon, Inc. and is provided solely for use with Optigon hardware products. See the LICENSE file for the complete license agreement.