# HG changeset patch
# User David Douard <david.douard@logilab.fr>
# Date 1219177304 -7200
# Node ID 1c0d92f9511574a2b79593420fdd954483d9db99
# Parent  486a480d196bef0b709eaf7a62f9c3250615355c
added doc (almost empty) files

diff -r 486a480d196b -r 1c0d92f95115 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Tue Aug 19 22:21:44 2008 +0200
@@ -0,0 +1,12 @@
+pygpibtoolkit is (c) 2007-2008 David Douard and is available under the GNU Public Licence.
+
+You can get information on Projman on
+http://www.logilab.org/project/pygpibtoolkit
+
+See `doc/introduction.rst` for a quick overview.
+
+If you have any questions, please mail david.douard@logilab.fr
+for support.
+
+David Douard
+
diff -r 486a480d196b -r 1c0d92f95115 doc/developer_manual.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/developer_manual.rst	Tue Aug 19 22:21:44 2008 +0200
@@ -0,0 +1,15 @@
+.. -*- coding: utf-8 -*-
+
+=============
+ Description
+=============
+
+The code is organized as follow:
+
+``pygpibtoolkit`` is the main python package directory, holding
+generic GPIB stuffs. A GPIB controller is a class responsible for
+managing the communication with the GPIB device plugged in the
+computer. For now, the only GPIB controller is the Prologix one,
+defined in the ``pygpibtoolkit.prologix`` module.
+
+
diff -r 486a480d196b -r 1c0d92f95115 doc/introduction.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/introduction.rst	Tue Aug 19 22:21:44 2008 +0200
@@ -0,0 +1,46 @@
+.. -*- coding: utf-8 -*-
+
+==============
+ Presentation
+==============
+
+pygpibtoolkit_ is a Python_ toolkit for talking with GPIB devices. It consist
+in a set of python modules (low-level and some more high-level) in
+order to ease writing python code to play with GPIB devices.
+There are also some utility commands written using this library.
+
+The aim of the project is to have an infrastructure that make it easy
+to write code to command/interact with GPIB-controlled devices, and,
+as a corrolary, make it easy to write "description" code for specific
+test equipments.
+
+Features
+========
+
+- Control GPIB devices using cheap Prologix_ USB-GPIB devices using a
+  "high" level API; some other GPIB backends could be implemented, but
+  I for now only have a Prologix USB bundle...
+
+- A simple (and incomplete) GPIB plotter is available. 
+
+- Infrastructure to "easily" create description of a specific test
+  equipment.
+
+Known test equipment
+====================
+
+For now, the following test equipment have been (partially)
+implemented:
+
+- HP 3562A/3563A Dynamic Signal Analyzer
+- Simple GPIB plotter
+
+The devices I should implement soon (well, ASAP):
+
+- HP 8904A Signal Synthetizer
+- HP ???? Meter
+
+
+.. _pygpibtoolkit: http://www.logilab.org/pygpibtoolkit
+.. _Prologix: http://www.prologix.com
+.. _Python: http://www.python.org
diff -r 486a480d196b -r 1c0d92f95115 pygpibtoolkit/gpib_utils.py
--- a/pygpibtoolkit/gpib_utils.py	Tue Aug 19 19:09:28 2008 +0200
+++ b/pygpibtoolkit/gpib_utils.py	Tue Aug 19 22:21:44 2008 +0200
@@ -1,6 +1,6 @@
-#
+# -*- coding: utf-8 -*-
 """
-Several untity functions for GPIB data conversions
+Several utility functions for GPIB data conversions
 """
 import struct
 import re
@@ -43,7 +43,7 @@
     return r
 
 ###
-# Datavlock useful functions
+# Datablock useful functions
 def format_datablock_header(header, head_struct, columns=80):
     """
     Pretty print a data block (trace, state or coord) 
diff -r 486a480d196b -r 1c0d92f95115 pygpibtoolkit/gpibcontroller.py
--- a/pygpibtoolkit/gpibcontroller.py	Tue Aug 19 19:09:28 2008 +0200
+++ b/pygpibtoolkit/gpibcontroller.py	Tue Aug 19 22:21:44 2008 +0200
@@ -264,7 +264,7 @@
             return devicemgr
         else:
             print "can't find a manager for", repr(idn)
-            print  deviceRegister._registry
+            print deviceRegister._registry
 
     def idn(self, address):
         """