simske / python-sireader

Python code for talking to Sportident stations. Used e.g. in the sport of orienteering.

TODO: Readme has to be updated

sportident-python

Python code for talking to Sportident stations. Used e.g. in the sport of orienteering.

The core functionality is in the file sireader2.py, which can be used as a library when developing other Python programs that interfaces to Sportident stations. It is mostly an extended version of sireader.py developed by Gaudenz Steinlin, Simon Harston and Jan Vorwerk.

si_read_backup.py is useful when reading out the backup memories of several stations.

si_normalize_station.py is useful when preparing several stations for an event.

Additions and modifications in sireader2.py compared to sireader.py:

• A few more parts of the SYS_VAL structure were worked out and described.
• The format of the data when reading out the backup memory was reverse engineered and documented, both for stations in legacy and extended protocol modes.
• Added function to read out backup memory of stations in legacy and extended protocol modes.
• Added function to save the backup data to a CSV file of the same format as that used by Sportident Config+.
• Added functions to set the station in direct and remote mode.
• A wakeup byte is sent as default before packets to stations. This seems to make the communication more robust.
• Made the serial port search smarter for Windows.
• Fixed an issue with "raise StopIteration" in the _crc routine, which no longer works in Python 3.7 (PEP 479).
• Compatibility with Python 2 is probably no longer preserved.
• Added sysval_ functions to access configuration data in SYS_VAL.

Install

For Windows, you will need a driver to talk to older generations of USB stations. From https://www.sportident.com/products/96-software/161-usb-driver.html: "New generation of BS11-BS/-BL with HID interface do not require this driver."

For macOS users extra driver for SI station readout is necessary. silabs.com CP210x USB to UART Bridge was used.

On Linux, make sure that the module cp210x is loaded:

modprobe cp210x

# create virtual environment
python3 -m venv env

# install dependencies
env/bin/pip install -r requirements.txt

Use

from sireader2 import SIReaderReadout

sir = SIReaderReadout()

sir.poll_sicard()  # returns True if card is inserted
sir.read_sicard()  # reads card in full
sir.ack_sicard()   # beeps the station after readout