Signal generator subpackage (ska_ser_test_equipment.signal_generator)
This subpackage provides for monitoring and control of signal generators.
- class ska_ser_test_equipment.signal_generator.SignalGeneratorComponentManager(interface_definition, protocol, host, port, logger, communication_state_callback, component_state_callback, update_rate=5.0)
A component manager for a signal generator.
- __init__(interface_definition, protocol, host, port, logger, communication_state_callback, component_state_callback, update_rate=5.0)
Initialise a new signal generator component manager instance.
- Parameters:
interface_definition (
InterfaceDefinitionType) – definition of the signal generator’s SCPI interface.protocol (
Literal['tcp','telnet']) – the network protocol to be used to communicate with the signal generator.host (
str) – the host name or IP address of the signal generator.port (
int) – the port of the signal generator.logger (
Logger) – a logger for this component manager to use for logging.communication_state_callback (
Callable) – callback to be called when the status of communications between the component manager and its component changes.component_state_callback (
Callable) – callback to be called when the state of the component changes.update_rate (
float) – how often updates to attribute values should be provided. This is not necessarily the same as the rate at which the instrument is polled. For example, the instrument may be polled every 0.1 seconds, thus ensuring that any invoked commands or writes will be executed promptly. However, if the update_rate is 5.0, then routine reads of instrument values will only occur every 50th poll (i.e. every 5 seconds).
- get_request()
Return the reads and writes to be executed in the next poll.
- Return type:
- Returns:
reads and writes to be executed in the next poll.
- off(task_callback=None)
Turn the component off.
- Parameters:
task_callback (
Optional[Callable]) – callback to be called when the status of the command changes.- Raises:
NotImplementedError – because this command is not yet implemented.
- Return type:
- on(task_callback=None)
Turn the component on.
- Parameters:
task_callback (
Optional[Callable]) – callback to be called when the status of the command changes.- Raises:
NotImplementedError – because this command is not yet implemented.
- Return type:
- poll(poll_request)
Poll the hardware.
Connect to the hardware, write any values that are to be written, and then read all values.
- Parameters:
poll_request (
AttributeRequest) – specification of the reads and writes to be performed in this poll.- Return type:
- Returns:
responses to queries in this poll.
- poll_succeeded(poll_response)
Handle the receipt of new polling values.
This is a hook called by the poller when values have been read during a poll.
- Parameters:
poll_response (
AttributeResponse) – response to the pool, including any values read.- Return type:
- polling_stopped()
Respond to polling having stopped.
This is a hook called by the poller when it stops polling.
- Return type:
- reset(task_callback=None)
Reset the component (from fault state).
- standby(task_callback=None)
Put the component into low-power standby mode.
- Parameters:
task_callback (
Optional[Callable]) – callback to be called when the status of the command changes.- Raises:
NotImplementedError – because this command is not yet implemented.
- Return type:
- write_attribute(**kwargs)
Update signal generator attribute value(s).
This doesn’t actually immediately write to the signal generator. It only stores the details of the requested write where it will be picked up by the next iteration of the polling loop.
- class ska_ser_test_equipment.signal_generator.SignalGeneratorDevice(*args, **kwargs)
A Tango device for monitor and control of a signal generator.
- create_component_manager()
Create and return a component manager for this device.
- Return type:
- Returns:
a component manager for this device.