RobotEye Library
 All Classes Namespaces Functions Pages
Public Member Functions | List of all members
RobotEye.LensController.Lenscontroller Class Reference

The Lens Controller class. More...

Public Member Functions

def __init__
 The default RobotEye constructor. More...
 
def SetAperture
 SetAperture for lens controller Set desired value for aperture (in f-number) More...
 
def SetFocus
 Sends setFocus command to lens Controller. More...
 
def ChangeIP
 Changes IP of lens Controller. More...
 
def Reboot
 Soft restart LC-2. More...
 
def Restart
 Hard restart LC-2. More...
 
def GetControllerVersion
 Get the lens controller firmware version. More...
 
def MoveAperture
 Move Aperture motor on X step (one-quarter-stop f-number) More...
 
def MoveFocus
 Move Focus motor on X units where X could be as positive as negative values. More...
 
def GetLens
 Get lens name. More...
 

Detailed Description

The Lens Controller class.

This class contains all of the public programmatic interfaces to the Lens Controller system. The class can be instantiated multiple times to connect to lens Controller systems on different IP addresses. The response from each API is in JSON format which can be easily loaded using json.loads

Constructor & Destructor Documentation

def RobotEye.LensController.Lenscontroller.__init__ (   self,
  lensControllerIP 
)

The default RobotEye constructor.

Parameters
lenscontrollerIP- the IP address of the Lens Controller expressed as a string i.e. "10.1.1.200"
Exceptions
ConnectionRefusedError- likely causes; incorrect network setup, configuration errors.

Member Function Documentation

def RobotEye.LensController.Lenscontroller.ChangeIP (   self,
  newIp 
)

Changes IP of lens Controller.

Parameters
newIp
Returns
IPchanged, lens controller will set IP and restart It will be required to construct a new LensController object to communicate with the LC on the new address.
def RobotEye.LensController.Lenscontroller.GetControllerVersion (   self)

Get the lens controller firmware version.

Returns
Returns the Lens Controller firmware version
def RobotEye.LensController.Lenscontroller.GetLens (   self)

Get lens name.

Returns
JSON response with NO_ERR Error code and Lens:XXX, where XXX is the lens name stored in internal lens memory, lens should support this command.
def RobotEye.LensController.Lenscontroller.MoveAperture (   self,
  xunits 
)

Move Aperture motor on X step (one-quarter-stop f-number)

Parameters
xunits
Returns
“Iris=Y”, where Y – current value of Aperture or “errorAperLimits” when aperture value is not reachable
def RobotEye.LensController.Lenscontroller.MoveFocus (   self,
  xunits 
)

Move Focus motor on X units where X could be as positive as negative values.

Parameters
xunits
Returns
JSON object with errorCode NO_ERR and Focus:Y, where Y – current value of Focus motor or “errorFocus” when focus value is not reachable
def RobotEye.LensController.Lenscontroller.Reboot (   self)

Soft restart LC-2.

Returns
OK
def RobotEye.LensController.Lenscontroller.Restart (   self)

Hard restart LC-2.

Returns
OK
def RobotEye.LensController.Lenscontroller.SetAperture (   self,
  aperture 
)

SetAperture for lens controller Set desired value for aperture (in f-number)

Parameters
apertureSupported Values : [1.0, 1.1, 1.3, 1.4, 1.6, 1.8, 2.0, 2.2, 2.5, 2.8, 3.2, 3.5, 4.0, 4.5, 5.0, 5.6, 6.3, 7.1, 8.0, 9.0, 10, 11, 13, 14, 16, 18, 20, 22, 25, 29, 32, 36, 40, 45, 51, 57, 64, 72 ,80, 90]
Returns
Response from the lens Controller in JSON format string
def RobotEye.LensController.Lenscontroller.SetFocus (   self,
  focus 
)

Sends setFocus command to lens Controller.

Parameters
focus
Returns
Response from the lens Controller returned as is

The documentation for this class was generated from the following file: