Phase Micro Stepper Device

This module implements the SATPhaseMicroStepper device.

class SatPhaseMicroStepper(*args, **kwargs)

An implementation of a PhaseMicroStepper Tango device for SatLmc.

Advance10M(argin)

Advance the output phase of 10MHz OUT signals, in units of 10ns.

Acceptable range is from 0 to +9.

Parameters:: argin (int) – the phase advance in units of 10ns
Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class Advance10MCommand(component_manager, logger=None)

Class for handling the Advance10M command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement Advance10M command functionality.

Parameters:

args (Any) – positional arguments. [0] the advance in units of 10ns
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

AdvanceAllPhase(argin)

Advance the output phase of all OUT signals, in units of 1e-15s.

The resolution is about 1e-13. Acceptable range is from -5000000 to +5000000.

Parameters:: argin (int) – the advance in units of 1e-15s
Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class AdvanceAllPhaseCommand(component_manager, logger=None)

Class for handling the AdvanceAllPhase command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement AdvanceAllPhase command functionality.

Parameters:

args (Any) – positional arguments.
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

AdvancePPS(argin)

Advance the phase of PPS OUT signals in units of 10ns.

The acceptable range is limited from -99000000 to 30000000.AdvancePPS.

Parameters:: argin (int) – the advance in units of 10ns
Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class AdvancePPSCommand(component_manager, logger=None)

Class for handling the AdvancePPS command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement AdvancePPS command functionality.

Parameters:

args (Any) – positional arguments. [0] the advance in units of 10ns
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

GetOffsetFrequency()

Get the offset frequency, in units of 1e-20.

Return type:: str
Returns:: the offset frequency send in the last setOffsetFrequencu command.

class GetOffsetFrequencyCommand(component_manager, logger=None)

Class for handling the GetOffsetFrequency() command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement GetOffsetFrequency() command functionality.

Parameters:

args (Any) – positional arguments. This should be empty and is provided for typehinting purposes only.
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

str

Returns:

the offset frequency

class InitCommand(*args, **kwargs)

Implement the device initialisation for the PhaseMicroStepper device.

do(*args, **kwargs)

Initialise the attributes and properties.

Parameters:

args (Any) – additional positional arguments; unused here
kwargs (Any) – additional keyword arguments; unused here

Return type:

tuple[ResultCode, str]

Returns:

a resultcode, message tuple

class SetIPAddressCommand(component_manager, logger=None)

Class for handling the SetIPAddress command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement SetIPAddress command functionality.

Parameters:

args (Any) – positional arguments. [0] the new IP address
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

SetIPaddress(argin)

Set the IP address of the EOG and closes the TCP connection.

Parameters:: argin (str) – the new IP address
Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

SetOffsetFrequency(offset)

Set the offset frequency.

Set the offset frequency of OUT signals respect to the frequency of 100MHz IN signal, in units of 1e-20. 7 Resolution is better than 3e-20. The acceptable range is from -1000000000000 to 1000000000000

Parameters:: offset (int) – the offset frequency
Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: the command + the converted offset frequency

class SetOffsetFrequencyCommand(component_manager, logger=None)

Class for handling the SetOffsetFrequency(argin) command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement SetOffsetFrequency command functionality.

Parameters:

args (Any) – positional args, the offset frequency is [0]
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class SetUDPAddressCommand(component_manager, logger=None)

Class for handling the SetUDPAddress command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement SetUDPAddress command functionality.

Parameters:

args (Any) – positional arguments. [0] the new UDP address
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

SetUDPaddress(argin)

Set the UDP address destination.

Parameters:: argin (str) – the str
Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

SyncPPS()

External sync of the 1PPS outputs.

Return type:: tuple[list[ResultCode], list[Optional[str]]]
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class SyncPPSCommand(component_manager, logger=None)

Class for handling the SyncPPS(argin) command.

__init__(component_manager, logger=None)

Initialise a new Command instance.

Parameters:

component_manager (PhaseMicroStepperDriver) – a component manager instance
logger (Optional[Logger]) – a logger for this command to use.

do(*args, **kwargs)

Implement SyncPPS command functionality.

Parameters:

args (Any) – positional arguments. This should be empty and is provided for typehinting purposes only.
kwargs (Any) – unspecified keyword arguments. This should be empty and is provided for typehinting purposes only.

Return type:

tuple[ResultCode, str]

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

__init__(*args, **kwargs)

Initialise a new instance.

Parameters:

args (Any) – positional arguments.
kwargs (Any) – keyword arguments.

create_component_manager()

Create and return a component manager for this device.

Return type:: PhaseMicroStepperDriver
Returns:: a component manager for this device.

first_internal_oscillator()

Report the status of the first internal oscillator.

Return type:: float
Returns:: oscillator 1 value (fixed point 6 decimal digits)

init_command_objects()

Initialise the command handlers for commands supported by this device.

Return type:: None

init_device()

Initialise the device.

Return type:: None

internal_temperature()

Report the internal temperature of the device.

Return type:: float
Returns:: temperature in celcius (fixed point 2 decimal digits)

is_Advance10M_allowed()

Check if command Advance10M is allowed in the current device state.

Return type:: bool
Returns:: True if the command is allowed

is_AdvanceAllPhase_allowed()

Check if command AdvanceAllPhase is allowed in the current device state.

Return type:: bool
Returns:: True if the command is allowed

is_AdvancePPS_allowed()

Check if command AdvancePPS is allowed in the current device state.

Return type:: bool
Returns:: True if the command is allowed

is_SetIPaddress_allowed()

Check if command SetIPaddress is allowed in the current device state.

Return type:: bool
Returns:: True if the command is allowed

is_SetUDPaddress_allowed()

Check if command SetUDPaddress is allowed in the current device state.

Return type:: bool
Returns:: True if the command is allowed

is_SyncPPS_allowed()

Check if command SyncPPS is allowed in the current device state.

Return type:: bool
Returns:: True if the command is allowed

is_attribute_allowed(attr_req_type)

Protect attribute access before being updated otherwise it reports alarm.

Parameters:: attr_req_type (AttReqType) – tango attribute type READ/WRITE
Return type:: bool
Returns:: True if the attribute can be read else False

second_internal_oscillator()

Report the status of the second internal oscillator.

Return type:: float
Returns:: oscillator 2 value (fixed point 6 decimal digits)

serial_number()

Report the serial number of the device.

Return type:: int
Returns:: the serial number

main(*args, **kwargs)

Entry point for module.

Parameters:

args (str) – positional arguments
kwargs (str) – named arguments

Return type:

int

Returns:

exit code