Repository navigation
Completing RedPitaya Move Plugins with additional functionalities of the Fast and Slow Analog outputs. #3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
|
|
||
| from typing import Union, List, Dict | ||
| from pymodaq.control_modules.move_utility_classes import (DAQ_Move_base, comon_parameters_fun, | ||
| main, DataActuatorType, DataActuator) | ||
|
|
||
| from pymodaq_utils.utils import ThreadCommand # object used to send info back to the main thread | ||
|
|
||
| from pymodaq_gui.parameter import Parameter | ||
|
|
||
| from pymeasure.instruments.redpitaya.redpitaya_scpi import RedPitayaScpi, AnalogOutputFastChannel | ||
|
|
||
| from pymodaq_data import Q_ | ||
|
|
||
| from pymodaq_plugins_redpitaya.utils import Config | ||
|
|
||
| plugin_config = Config() | ||
|
|
||
| class DAQ_Move_RedpitayaAnalogSlow(DAQ_Move_base): | ||
| """ Instrument plugin class for Red Pitaya | ||
|
|
||
| This object inherits all functionalities to communicate with PyMoDAQ’s DAQ_Move module through | ||
| inheritance via DAQ_Move_base. It makes a bridge between the DAQ_Move module and the | ||
| Python wrapper of a particular instrument. | ||
|
|
||
| * Should be compatible with all redpitaya flavours using the SCPI communication protocol | ||
| * Tested with Red Pitaya 2.00-37 OS | STEMlab 125-14 Pro (Gen 2) version | ||
| * PyMoDAQ >= 5.0.5 | ||
| * Tested with Linux Ubuntu 24.04.1 LTS | ||
| * Installation instruction: | ||
| These instructions are valid when using an Ethernet cable to communicate with the Red Pitaya. | ||
| The instrument is accessed using a TCP/IP Socket communication adapter, in the form: “TCPIP::x.y.z.k::port::SOCKET” | ||
| - x.y.z.k is the IP address of the SCPI server (that should be activated on the board) | ||
| - port is the TCP/IP port number, usually 5000 | ||
| To activate the use of the Red Pitaya: | ||
| 1. Connect the redpitaya to your computer/network with an ethernet cable. | ||
| 2. Enter the url address written on the network plug (on the Red Pitaya) | ||
| It should be something like “RP-F0B462.LOCAL/” | ||
| 3. Browse the menu, open the System application then the Network manager application | ||
| Look at the ip_address, and modify the config_template | ||
| 4. Return to the menu, open the Development application and activate the SCPI server. | ||
| 5. You can now run daq_move_RedpiatayaSCPI.py | ||
|
|
||
| Attributes: | ||
| ----------- | ||
| controller: object | ||
| The particular object that allow the communication with the hardware, in general a python wrapper around the | ||
| hardware library. | ||
| """ | ||
|
|
||
| is_multiaxes = True | ||
| _axis_names: Union[List[str], Dict[str, int]] = ['voltage'] | ||
| _controller_units: Union[str, List[str]] = ['V'] | ||
| _epsilon: Union[float, List[float]] = [0.128] # Detailing 5mV and 1Hz. Resolution of reading is 5mV | ||
| # _epsilon: Union[float, List[float]] = 0.1 # Detailing 1mV and 1Hz #TODO replace this by a value that is correct depending on your controller | ||
| # TODO it could be a single float of a list of float (as much as the number of axes) | ||
| data_actuator_type = DataActuatorType.DataActuator | ||
|
|
||
| params = [ {'title': 'IP Address:', 'name': 'ip_address', 'type': 'str', | ||
| 'value': plugin_config('ip_address')}, | ||
| {'title': 'Port:', 'name': 'port', 'type': 'int', 'value': plugin_config('port')}, | ||
| {'title': 'Board name:', 'name': 'bname', 'type': 'str', 'readonly': True}, | ||
|
|
||
| {'title': 'Channel', 'name': 'channel', 'type': 'list', 'limits':{'0': 0, '1': 1, '2': 2, '3': 3}, | ||
| 'value': plugin_config('generator_slow', 'channel')}, | ||
|
|
||
| ] + comon_parameters_fun(is_multiaxes, axis_names=_axis_names, epsilon=_epsilon) | ||
| # _epsilon is the initial default value for the epsilon parameter allowing pymodaq to know if the controller reached | ||
| # the target value. It is the developer responsibility to put here a meaningful value | ||
|
|
||
| def ini_attributes(self): | ||
| self.controller: RedPitayaScpi = None | ||
| self.target_value = 0 | ||
| # self.conv_factor = 50e-6 | ||
| # self.scale = True | ||
| pass | ||
|
|
||
| def get_actuator_value(self): | ||
| """Get the current value from the hardware with scaling conversion. | ||
|
|
||
| Returns | ||
| ------- | ||
| float: The position obtained after scaling conversion. | ||
| """ | ||
|
|
||
| pos = DataActuator(data=getattr(self.aout_slow, self.axis_name), | ||
| units=self.axis_unit) | ||
| pos = self.get_position_with_scaling(pos) | ||
| return pos | ||
|
|
||
|
|
||
| def close(self): | ||
| """Terminate the communication protocol""" | ||
| self.aout_slow.reset() | ||
|
|
||
|
|
||
| def commit_settings(self, param: Parameter): | ||
| """Apply the consequences of a change of value in the detector settings | ||
|
|
||
| Parameters | ||
| ---------- | ||
| param: Parameter | ||
| A given parameter (within detector_settings) whose value has been changed by the user | ||
| """ | ||
| if param.name() == 'axis': | ||
| if param.value == 'voltage': | ||
| # self.settings.child('bounds', 'is_bounds').value() | ||
| self.settings.child('bounds', 'min_bound').setValue(0) | ||
| self.settings.child('bounds', 'max_bound').setValue(1.8) | ||
| self.settings.child('bounds', 'is_bounds').setValue(True) | ||
|
|
||
|
|
||
| # def is_enabled(self) -> bool: | ||
| # "It defines if the supply voltage is enabled on the output channel chosen" | ||
| # return self.settings['enable'] == True | ||
|
|
||
| @property | ||
| def aout_slow(self): | ||
| """ It defines what output channel the user chose""" | ||
| return self.controller.analog_out_slow[self.settings['channel']] | ||
|
|
||
| def ini_stage(self, controller=None): | ||
| """Actuator communication initialization | ||
|
|
||
| Parameters | ||
| ---------- | ||
| controller: (object) | ||
| custom object of a PyMoDAQ plugin (Slave case). None if only one actuator by controller (Master case) | ||
|
|
||
| Returns | ||
| ------- | ||
| info: str | ||
| initialized: bool | ||
| False if initialization failed otherwise True | ||
| """ | ||
|
|
||
| if self.is_master: # is needed when controller is master | ||
| self.controller = RedPitayaScpi(ip_address=self.settings['ip_address']) # arguments for instantiation!) | ||
| # self.controller = RedPitayaScpi(ip_address=plugin_config('ip_address')) # arguments for instantiation!) | ||
| else: | ||
| self.controller = controller | ||
|
|
||
| self.settings.child('bounds', 'min_bound').setValue(0) | ||
| self.settings.child('bounds', 'max_bound').setValue(1.8) | ||
| self.settings.child('bounds', 'is_bounds').value() | ||
| self.settings.child('bounds', 'is_bounds').setValue(True) | ||
| # self.settings.child('bounds', 'is_bounds').setOpts(readonly=True) | ||
|
|
||
| info = "Whatever info you want to log" | ||
| initialized = True | ||
| return info, initialized | ||
|
|
||
| def move_abs(self, value: DataActuator): | ||
| """ Move the actuator to the absolute target defined by value | ||
|
|
||
| Parameters | ||
| ---------- | ||
| value: (float) value of the absolute target positioning | ||
| """ | ||
| value = self.check_bound(value) #if user checked bounds, the defined bounds are applied here | ||
| self.target_value = value | ||
| print(value) | ||
| value = self.set_position_with_scaling(value) # TODO apply scaling if the user specified one | ||
| print(self.axis_unit) | ||
| setattr(self.aout_slow, self.axis_name, value.value(self.axis_unit)) | ||
| # TODO change this run command to work with other trigger sources than INTernal trigger | ||
|
|
||
| def move_rel(self, value: DataActuator): | ||
| """ Move the actuator to the relative target actuator value defined by value | ||
|
|
||
| Parameters | ||
| ---------- | ||
| value: (float) value of the relative target positioning | ||
| """ | ||
| value = self.check_bound(self.current_position + value) - self.current_position | ||
| self.target_value = value + self.current_position | ||
| self.move_abs(self.target_value) | ||
|
|
||
| def move_home(self): | ||
| """Call the reference method of the controller""" | ||
| pass | ||
|
|
||
| def stop_motion(self): | ||
| """Stop the actuator and emits move_done signal""" | ||
| pass | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| main(__file__, init=False) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this has changed wrt the redpitaya version, one should add_them in the plugin preferences adding also the selection of the type of board gen1 or 2