M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

manual: explain how to select TCube device from serial number

This commit is contained in:
Yann Sionneau 2015-06-19 17:06:50 +02:00
parent 979f3522cb
commit b8bb3d8ca7
2 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
artiq/frontend/thorlabs_tcube_controller.py
View File

@ -13,7 +13,9 @@ def get_argparser():
help="type of the Thorlabs T-Cube device to control", help="type of the Thorlabs T-Cube device to control",
choices=["TDC001", "TPZ001"]) choices=["TDC001", "TPZ001"])
parser.add_argument("-d", "--device", default=None, parser.add_argument("-d", "--device", default=None,
help="serial port. Omit for simulation mode.") help="serial device. See documentation for how to "
"specify a USB Serial Number. Omit for simulation "
"mode.")
simple_network_args(parser, 3255) simple_network_args(parser, 3255)
verbosity_args(parser) verbosity_args(parser)
return parser return parser

16
doc/manual/ndsp_reference.rst
View File

@ -88,6 +88,8 @@ Controller
Thorlabs T-Cube Thorlabs T-Cube
--------------- ---------------
.. _tdc001-controller-usage-example:
TDC001 controller usage example TDC001 controller usage example
+++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++
@ -98,6 +100,15 @@ First, run the TDC001 controller::
.. note:: .. note::
On Windows the serial port (the ``-d`` argument) will be of the form ``COMx``. On Windows the serial port (the ``-d`` argument) will be of the form ``COMx``.
.. note::
Anything compatible `with serial_for_url <http://pyserial.sourceforge.net/pyserial_api.html#serial.serial_for_url>`_
can be given as a device in ``-d`` argument.
For instance, if you want to specify the Vendor/Product ID and the USB Serial Number, you can do:
``-d hwgrep://<VID>:<PID> SNR=<serial_number>``.
The hwgrep URL works on both Linux and Windows.
Then, send commands to it via the ``artiq_rpctool`` utility:: Then, send commands to it via the ``artiq_rpctool`` utility::
$ artiq_rpctool ::1 3255 list-targets $ artiq_rpctool ::1 3255 list-targets
@ -118,6 +129,11 @@ First, run the TPZ001 controller::
.. note:: .. note::
On Windows the serial port (the ``-d`` argument) will be of the form ``COMx``. On Windows the serial port (the ``-d`` argument) will be of the form ``COMx``.
.. note::
See the :ref:`TDC001 documentation <tdc001-controller-usage-example>` for
how to specify the USB Serial Number of the device instead of the
/dev/ttyUSBx (or the COMx name).
Then, send commands to it via the ``artiq_rpctool`` utility:: Then, send commands to it via the ``artiq_rpctool`` utility::
$ artiq_rpctool ::1 3255 list-targets $ artiq_rpctool ::1 3255 list-targets