M100DAxis¶

class asgard_alignment.NewportMotor.M100DAxis(connection: NewportConnection, semaphore_id: int, axis: Literal['U', 'V'], name: str)¶

Bases: Motor

A class for the tip or tilt M100D motors https://www.newport.com.cn/p/CONEX-AG-M100D

Attributes Summary

`CONTROLLER_STATES`
`LOWER_LIMIT`
`UPPER_LIMIT`
`axis`

Methods Summary

`init`()
`is_at_limit`()	Check if the motor is at the limit
`is_init_success`()	Check if the initialisation was successful
`is_motion_done`()	Check if the motion is done
`is_moving`()	Check if the motor is moving
`is_reset_success`()	Check if the reset was successful
`is_stop_success`()	Check if the stop was successful
`move_abs`(position)	Move the motor to an absolute position
`move_relative`(position)	Move the motor to a relative position
`read_position`()	Read the position of the motor
`read_state`([echo])	Read the state of the motor

Attributes Documentation

CONTROLLER_STATES = {'14': 'CONFIGURATION', '28': 'MOVING CL', '29': 'STEPPING OL', '32': 'READY from Reset', '33': 'READY from MOVING CL', '34': 'READY from DISABLE', '35': 'READY from JOGGING OL', '36': 'READY from STEPPING OL', '3C': 'DISABLE from READY OL', '3D': 'DISABLE from MOVING CL', '46': 'JOGGING OL'}¶

LOWER_LIMIT = -0.75¶

UPPER_LIMIT = 0.75¶

axis¶

Methods Documentation

init()¶

is_at_limit()¶

Check if the motor is at the limit

Returns:¶

bool: True if the motor is at the limit, False otherwise

is_init_success()¶

Check if the initialisation was successful

Returns:¶

bool: True if the initialisation was successful, False otherwise

is_motion_done()¶

Check if the motion is done

Returns:¶

bool: True if the motion is done, False otherwise

is_moving()¶

Check if the motor is moving

Returns:¶

is_moving: bool: True if the motor is moving, False otherwise

is_reset_success()¶

Check if the reset was successful

Returns:¶

bool: True if the reset was successful, False otherwise

is_stop_success()¶

Check if the stop was successful

Returns:¶

bool: True if the stop was successful, False otherwise

move_abs(position: float)¶

Move the motor to an absolute position

Parameters:¶

position: float: The position to move to

move_relative(position: float)¶

Move the motor to a relative position

Parameters:¶

position: float: The position to move to

read_position()¶

Read the position of the motor

Returns:¶

position: float: The position of the motor

read_state(echo=False)¶: Read the state of the motor

CONTROLLER_STATES = {'14': 'CONFIGURATION', '28': 'MOVING CL', '29': 'STEPPING OL', '32': 'READY from Reset', '33': 'READY from MOVING CL', '34': 'READY from DISABLE', '35': 'READY from JOGGING OL', '36': 'READY from STEPPING OL', '3C': 'DISABLE from READY OL', '3D': 'DISABLE from MOVING CL', '46': 'JOGGING OL'}¶

LOWER_LIMIT = -0.75¶

UPPER_LIMIT = 0.75¶

property axis¶

disable()¶: The DISABLE command can be used to request the MCU to power off devices.

enable()¶: The ENABLE command can be used to request the MCU to power on devices.

init()¶

is_at_limit()¶

Check if the motor is at the limit

Returns:¶

bool: True if the motor is at the limit, False otherwise

is_init_success()¶

Check if the initialisation was successful

Returns:¶

bool: True if the initialisation was successful, False otherwise

is_motion_done()¶

Check if the motion is done

Returns:¶

bool: True if the motion is done, False otherwise

is_moving()¶

Check if the motor is moving

Returns:¶

is_moving: bool: True if the motor is moving, False otherwise

is_reset_success()¶

Check if the reset was successful

Returns:¶

bool: True if the reset was successful, False otherwise

is_stop_success()¶

Check if the stop was successful

Returns:¶

bool: True if the stop was successful, False otherwise

move_abs(position: float)¶

Move the motor to an absolute position

Parameters:¶

position: float: The position to move to

move_relative(position: float)¶

Move the motor to a relative position

Parameters:¶

position: float: The position to move to

online()¶: Upon reception, the ICS back-end server of the MCU shall power on all the controlled devices and have them ready to accept SETUP commands.

ping()¶: The PING command is used to check the status of the controller, sending a dummy command such as *IDN? and making sure there is a reply

read_position()¶

Read the position of the motor

Returns:¶

position: float: The position of the motor

read_state(echo=False)¶: Read the state of the motor

setup(value)¶: Command to move a device to a given position. The position is given in the value field.

standby()¶: Upon reception, the ICS back-end server of the MCU shall move some of the controlled devices to a safe “parking” position (if required) and power off all the controlled devices.

stop()¶: The STOP command is issued by the ICS on wag to immediately stop the motion (initiated by a SETUP command) of devices.