Codebase list sireader / HEAD PKG-INFO
HEAD

Tree @HEAD (Download .tar.gz)

PKG-INFO @HEAD — raw · history · blame 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
Metadata-Version: 1.1
Name: sireader
Version: 1.1.1
Summary: Python module to communicate with SportIdent main stations
Home-page: http://bosco.durcheinandertal.ch/
Author: Gaudenz Steinlin
Author-email: gaudenz@durcheinandertal.ch
License: GPLv3+
Description: 
        SportIdent Reader
        =================
        
        Sireader is a python module to communicate with a SportIdent main station to
        read out SportIdent cards. SportIdent is an electronic punching system mainly
        used for orienteering events.
        
        Sireader supports two major operation modes. It can be used for complete card
        readout or in control station mode to send punches from a control. The first mode
        is typically used for card readout after the finish line to read the card data
        into an event software. The second mode is used to get live result from an
        intermediate control.
        
        Website: http://bosco.durcheinandertal.ch/
        
        GIT Repository: http://git.durcheinandertal.ch/?p=sireader.git;a=summary
        
        Usage
        -----
        
        There are 3 classes in the sireader module. **SIReader** is the base class
        containing common functions. It's imported to have easy access to it's
        constants. **SIReaderReadout** implements classical card readout.
        **SIReaderControl** implements a station configured as control which
        continuously sends punches.
        
        First import the relevant classes::
        
          from sireader import SIReader, SIReaderReadout, SIReaderControl
        
        SIReader only supports the so called "Extended Protocol" mode. If your
        base station is not in this mode you have to change the protocol mode
        first::
        
          # change to extended protocol mode
          si.set_extended_protocol()
        
        To use a SportIdent base station for card readout::
        
          from time import sleep
        
          # connect to base station, the station is automatically detected,
          # if this does not work, give the path to the port as an argument
          # see the pyserial documentation for further information.
          si = SIReaderReadout()
        
          # wait for a card to be inserted into the reader
          while not si.poll_sicard():
              sleep(1)
        
          # some properties are now set
          card_number = si.sicard
          card_type = si.cardtype
        
          # read out card data
          card_data = si.read_sicard()
        
          # beep
          si.ack_sicard()
        
        To use a base station as a control sending punches::
        
          # configure station
          si.set_operating_mode(SIReader.M_CONTROL)
          si.set_station_code(99)
          si.set_autosend()
        
          # connect to station
          si = SIReaderControl()
        
          # poll for new punches
          punches = si.poll_punch()
        
          # reset station configuration
          si.set_operating_mode(SIReader.M_READOUT)
          si.set_autosend(False)
        
        Finally set the station back to basic protocol::
        
          # change back to basic protocl
          si.set_extended_protocol(False)
        
        
        
        API Documentation
        -----------------
        
        Complete documentation is contained in the module source code and can
        be read online at:
        
        http://bosco.durcheinandertal.ch/epydoc-sireader/
        
        This documentation is autogenerated from the source code and
        represents the version in the GIT repository.
        
Keywords: sportident orienteering bosco
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4