README.txt

   1 ====================
   2  Total Open Station
   3 ====================
   4
   5 A generic Python interface for downloading data from total station devices.
   6
   7 Introduction
   8 ============
   9
  10 I started writing this program for making it easier to manage different
  11 models of total stations, often used in the same fieldwork unit, mainly in a
  12 GNU/Linux environment. However, I try to develop following standards, so
  13 porting to Windows or Mac shouldn't be difficult.
  14
  15 Every model has its own quirks. So, I decided to use a modular structure,
  16 that is based on an abstract interface. Each time a new model is added to
  17 the program, you create a new instance of this base class, with all needed
  18 data.
  19
  20 This program is licensed under the GNU General Public License version 3.
  21
  22 The application icons are copyright by Lapo Calamandrei 2008.
  23
  24 Helper application
  25 ==================
  26
  27 The helper application is found in the `helper` directory of the source tree.
  28
  29 To run it, you will need:
  30
  31 * the pySerial library
  32 * the Python Tkinter GUI library
  33
  34 What the helper is
  35 ------------------
  36
  37 It is meant as a simple tool for obtaining two pieces of information:
  38
  39 1. the right **serial connection parameters** from an unknown device. The user
  40    can play with the 8 options and see the results in a text area. Once the
  41    downloaded results look good, we are almost sure that we have used the right
  42    parameters, and we can add the tested model to the program database.
  43 2. **sample data dumps** from unknown models that are needed to develop new
  44    parser modules.
  45
  46 The helper consists of a single python module which can be executed stand-alone
  47 on any platform. For Microsoft Windows, a single executable program is
  48 available through `py2exe`. It has been reported to work on GNU/Linux
  49 (including the OpenMoko FreeRunner) and Microsoft Windows.
  50
  51 What the helper is **not**
  52 --------------------------
  53
  54 * The helper is not a beta version of Total Open Station
  55 * The helper is not a draft of the final GUI
  56 * The helper is not a broken Total Open Station implementation
  57 * The helper is not ugly. It's just you who don't like Tk
  58 * The helper is not a wizard. You have to tune the options using your prior
  59   knowledge of your total station.
  60
  61 Documentation
  62 =============
  63
  64 Documentation is available at http://totalopenstation.sharesource.org/docs/
  65 with details on the application structure, supported models and other stuff.
  66