TheiaMCR 2.0.4

Theia MCR motor control functions

Theia Technologies motor control board interface

Theia Technologies offers a MCR600 motor control board for controlling Theia's motorized lenses. This board controls focus, zoom, iris, and IRC filter motors. It can be connected to a host comptuer by USB, UART, or I2C connection.

Features

The MCR600 board (and MCR400, MCR500 and others in the MCR series) has a proprietary command protocol to control and get information from the board. The protocol is a customized string of up to 12 bytes which can be deciphered in the MCR600 documentation. For ease of use, Theia has developed this Python module to format the custom byte strings and send them to the board. The user can request the focus motor to move 1000 steps for example. The focusRel function will convert this request to the appropriate byte string and send it over USB connection to the MCR control board. This will cause the lens motor to move 1000 steps.

Quick start

This module can be loaded into a Python program using "pip install TheiaMCR".
Theia's motorized lens should be connected to the MCR600 board and the board should be connected to the host computer via USB connection thorugh a virtual com port.

Functions

Initialization functions

• create a MCRControl class instance to initialize the board communications
• focusInit, zoomInit, irisInit: initialize the motors
• IRCInit: initialize the IR cut filter motor

Motor movement functions

• IRCState: set the filter switch state to 0 or 1 (For the following functions "motor" is replaced with "focus", "zoom" or "iris")
• motor.home: send the motor to the home position and set the current step number
• motor.moveAbs: move the motor to an absolute step number after sending it to home first
• motor.moveRel: move by a relative number of steps

Information and setting functions

• MCRBoard.readFWRevision: read board firmware revision
• MCRBoard.readBoardSN: read board serial number
• motor.setMotorSpeed: set the motor speed in pulses per second (pps)
• motor.setRespectLimits: turn on or off the home position limit stops for focus and zoom

Important variables

Each motor has these variables available

• motor.currentStep: current motor step number
• motor.currentSpeed: current motor speed in pulses per second (pps)
• motor.maxSteps: maximum number of steps for the full range of movement
• motor.PIStep: photointerrupber limit switch step position (within the full range of movement). After sending the motor to home, the current step will be set to this PIStep number.

License

Theia Technologies BSD license Copyright 2023 Theia Technologies

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Contact information

For more information contact: Mark Peterson at Theia Technologies [e-mail]

Revision

v.2.0.4