Mercurial > pygpibtoolkit / file comparison
comparison: doc/introduction.rst
doc/introduction.rst
- changeset 73
- 2645ef311424
- parent 72
- a81d0fd26332
- child 91
- f2a8f688dbc0
equal
deleted
inserted
replaced
| 72:a81d0fd26332 | 73:2645ef311424 |
|---|---|
| 1 .. -*- coding: utf-8 -*- | 1 .. -*- coding: utf-8 -*- |
| 2 | 2 |
| 3 ============== | 3 ============== |
| 4 Presentation | 4 Introduction |
| 5 ============== | 5 ============== |
| 6 | 6 |
| 7 pygpibtoolkit_ is a Python_ toolkit for talking with GPIB devices. It | 7 pygpibtoolkit_ is a Python_ toolkit for talking with GPIB devices. It |
| 8 consist in a set of python modules (low-level and some more | 8 consist in a set of python modules (low-level and some more |
| 9 high-level) in order to ease writing python code to play with GPIB | 9 high-level) in order to ease writing python code to play with GPIB |
| 45 | 45 |
| 46 ======= | 46 ======= |
| 47 Tools | 47 Tools |
| 48 ======= | 48 ======= |
| 49 | 49 |
| 50 Every tool presented in this section can display a *help* message | 50 Every tool presented in this section can be found in the `bin` |
| 51 using the ``-h`` or ``--help`` option. | 51 directory, and can display a *help* message using the ``-h`` or |
| 52 ``--help`` option. | |
| 52 | 53 |
| 53 For the sake of testing these tools, some example files are proposed | 54 For the sake of testing these tools, some example files are proposed |
| 54 in the `example` directory. | 55 in the `example` directory. |
| 55 | 56 |
| 56 `examples/hpgl_plots` are examples of HPGL files (resulting from | 57 `examples/hpgl_plots` are examples of HPGL files (resulting from |
| 109 gpib_detect | 110 gpib_detect |
| 110 ----------- | 111 ----------- |
| 111 | 112 |
| 112 Simple GPIB device detector. The computer GPIB device is configured so | 113 Simple GPIB device detector. The computer GPIB device is configured so |
| 113 it is the Controller In Charge on the GPIB bus. It takes a while | 114 it is the Controller In Charge on the GPIB bus. It takes a while |
| 114 (several seconds) to run the retection procedure. When complete, it | 115 (several seconds) to run the retection procedure. |
| 115 will simply display the list of devices found on the bus, with a | 116 |
| 116 decription of the device (if available). | 117 Once complete, it will simply display the list of devices found on the |
| 118 bus, with a decription of the device (if available, ie. if it replies | |
| 119 to the IDN? command, which is not the case of older devices). | |
| 117 | 120 |
| 118 dump_datablock | 121 dump_datablock |
| 119 -------------- | 122 -------------- |
| 120 | 123 |
| 121 Retrieve a datablock from a HP3562A/HP3563A device. The datablock can | 124 Retrieve a datablock from a HP3562A/HP3563A device. The datablock can |
