Ullr Quickstart

A serial <-> MQTT interface for sports timing.

Ullr signal flow.

Ullr (pronounce “OOH-ler”) allows for reading and writing data from remote serial devices. It was designed with ski racing in mind, but can be used to access any remote serial device with an available internet connection. It also acts as a hub, allowing for an arbitrary number of serial devices to be connected to an arbitrary number of software instances.

Multiple devices sharing a single serial connection.

Installation

pip install ullr

The simplest way to install Ullr is in a Python environment using pip. It is recommended, if possible, to install as superuser in Linux environments.

An installer for the latest Windows release can be found here: Latest Windows Release.

The latest Debian(amd64) binary can be found here: Latest Debian(amd64) Release.

An in-depth guide to installation on a Raspberry Pi can be found here.

Configuring Ullr

See the Configuration section for an in-depth guide to configuring Ullr.

Running

From a command line, type ullr. Or navigate to the Windows start shortcut. By default, Ullr starts a web interface on localhost:5000. Navigate to this page from a browser.

The Ullr web interface.

See the Usage section for more information.

Get the Source

Ullr is published under the GNU GPL 3 license.

The source is always available on the Ullr GitHub homepage and available for download here.

Getting Started

• Ullr Quickstart
• RS-232 Terminology
• MQTT Messaging Protocol

Installation In-Depth

• Virtual Null Modems
  • Windows
  • Linux
• Running on a Raspberry Pi
  • Choosing an OS
  • Some Linux Basics
  • Installing on a Raspberry Pi
  • Setting Ullr to run on boot

Configuration and Use

• Configuration
  • Navigating to the WebUI
  • MQTT Broker Settings
  • Adding Local Devices
  • Adding Remote Devices
  • Saving configuration
• Usage
  • Monitoring Message Transmission
  • Using the Console
  • Using the Log File
  • The Advanced Menu

Example Use Cases

• Wireless ski race timing
  • At the start
  • At the finish
• Advanced Ski Racing
  • Connecting multiple timers to Ski Club
  • Adding additional timers
  • Translation Settings
• Connecting to a Remote Display Board

Advanced

• Command Line Operation
  • Command Line Arguments
  • Running in the Terminal
• Using the Config File
  • Finding the config file
  • Default config settings
  • MQTT broker settings
  • Adding a device

Reference

• Project Links
• External Links
• Contributing to Ullr
  • Ullr is Developed on Github
  • Use Github Flow, So All Code Changes Happen Through Pull Requests
  • Any contributions you make will be under the GNU GPL v3 license.
  • Report bugs using Github’s issues
  • References