doc/introduction.rst

Thu, 24 May 2018 23:10:06 +0200

author
David Douard <david.douard@logilab.fr>
date
Thu, 24 May 2018 23:10:06 +0200
changeset 103
ad9b6e53ca68
parent 95
c6b655d9b855
permissions
-rw-r--r--

[doc/logo] improved logo

63
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
1 .. -*- coding: utf-8 -*-
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
2
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
3 Features
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
4 ========
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
5
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
6 - Control GPIB devices using cheap Prologix_ USB-GPIB devices using a
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
7 "high" level API; some other GPIB backends could be implemented, but
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
8 I for now only have a Prologix USB bundle...
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
9
91
f2a8f688dbc0 project moved to bitbucket
David Douard <david.douard@logilab.fr>
parents: 73
diff changeset
10 - A simple (and incomplete) GPIB plotter is available.
63
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
11
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
12 - Infrastructure to "easily" create description of a specific test
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
13 equipment.
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
14
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
15 Known test equipment
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
16 ====================
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
17
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
18 For now, the following test equipment have been (partially)
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
19 implemented:
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
20
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
21 - HP 3562A/3563A Dynamic Signal Analyzer
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
22 - Simple GPIB plotter
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
23
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
24 The devices I should implement soon (well, ASAP):
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
25
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
26 - HP 8904A Signal Synthetizer
67
e6340960fcbe updated introduction doc
David Douard <david.douard@logilab.fr>
parents: 63
diff changeset
27 - HP 3456A Meter
63
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
28
72
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
29 =======
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
30 Tools
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
31 =======
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
32
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
33 For the sake of testing these tools, some example files are proposed
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
34 in the `example` directory.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
35
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
36 `examples/hpgl_plots` are examples of HPGL files (resulting from
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
37 plotting from my HP3562A).
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
38
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
39 `examples/datablocks` are examples of HP3562A state, trace and coords
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
40 datablocks dumped.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
41
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
42 The `mockup` mode of the tools presented below are using these files
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
43 as data source.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
44
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
45
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
46 GUI Tools
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
47 =========
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
48
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
49 qgpibplotter
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
50 ------------
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
51
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
52 This is a little app to emulate a GPIB HPGL plotter.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
53
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
54 Once started, one can load and display a previously saved HPGL file
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
55 (using the File menu).
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
56
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
57 However, the main usage is to use it as a passive device on the GPIB
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
58 bus (default address is 5, but this may be configured in user
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
59 preferences). There is a main "On Line" button which can be in out
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
60 out. When "online", it will receive plots from every device on the
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
61 GPIB bus performing plot commands.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
62
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
63 There is "test" mode, in which a fake GPIB connection will be used
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
64 instead of the real one. So is one want to see *qgpibplotter* in
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
65 action, just run it with the ``-m`` option (mockup). Type
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
66
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
67 qgpibplotter -h
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
68
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
69 for details.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
70
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
71 q3562
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
72 -----
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
73
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
74 This a small GUI application that allow to easily retrieve state, trace
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
75 and coord datablocks from a HP3562A/HP3563A device (see HP manuals of
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
76 these devices for details).
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
77
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
78 There is "test" mode, in which a fake GPIB connection will be used
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
79 instead of the real one. So is one want to see *qgpibplotter* in
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
80 action, just run it with the ``-m`` option (mockup). Type
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
81
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
82 q3562 -h
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
83
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
84 for details.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
85
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
86 Command line tools
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
87 ==================
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
88
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
89 gpib_detect
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
90 -----------
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
91
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
92 Simple GPIB device detector. The computer GPIB device is configured so
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
93 it is the Controller In Charge on the GPIB bus. It takes a while
73
2645ef311424 small cleanups and doc update
David Douard <david.douard@logilab.fr>
parents: 72
diff changeset
94 (several seconds) to run the retection procedure.
2645ef311424 small cleanups and doc update
David Douard <david.douard@logilab.fr>
parents: 72
diff changeset
95
2645ef311424 small cleanups and doc update
David Douard <david.douard@logilab.fr>
parents: 72
diff changeset
96 Once complete, it will simply display the list of devices found on the
2645ef311424 small cleanups and doc update
David Douard <david.douard@logilab.fr>
parents: 72
diff changeset
97 bus, with a decription of the device (if available, ie. if it replies
2645ef311424 small cleanups and doc update
David Douard <david.douard@logilab.fr>
parents: 72
diff changeset
98 to the IDN? command, which is not the case of older devices).
72
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
99
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
100 dump_datablock
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
101 --------------
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
102
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
103 Retrieve a datablock from a HP3562A/HP3563A device. The datablock can
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
104 be the state, trace or coord datablock, and it can use the ASCII,
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
105 BINARY or ANSI dumping mode. The resulting data are saved in a file.
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
106
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
107 read_XXX
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
108 --------
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
109
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
110 These 3 tools can be used to display a datablock previously dumped in
91
f2a8f688dbc0 project moved to bitbucket
David Douard <david.douard@logilab.fr>
parents: 73
diff changeset
111 a file (using *dump_datablock*).
72
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
112
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
113
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
114 ..
a81d0fd26332 Improve docs.
David Douard <david.douard@logilab.fr>
parents: 67
diff changeset
115 ..
63
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
116
91
f2a8f688dbc0 project moved to bitbucket
David Douard <david.douard@logilab.fr>
parents: 73
diff changeset
117 .. _pygpibtoolkit: https://bitbucket.org/dddouard/pygpibtoolkit
63
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
118 .. _Prologix: http://www.prologix.com
1c0d92f95115 added doc (almost empty) files
David Douard <david.douard@logilab.fr>
parents:
diff changeset
119 .. _Python: http://www.python.org

mercurial