Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A pinewood derby status board & sensor driver
Ruby CoffeeScript Shell CSS JavaScript
Branch: master

README.md

PinewoodDerby

Code Climate

A web-based race manager and status board application for the Cub Scout pinewood derby

screenshot

Features

  • Show a status board (TV/projector) with the standings, most recent heat times, and upcoming heats, all updated in real-time
  • Register contestants, even after the derby has begun
  • Activate the start switch for each race with a button in the app
  • Swap out contestants in upcoming heats when someone is MIA or not ready to race
  • Redo the most recent heat when something goes wrong
  • Manage the derby, show the display board, and run the sensor on different devices if desired
  • Retire contestants that drop out of the derby
  • The welcome screen displays the URL at which other devices can access the application
  • Warnings are displayed when the USB device is unplugged or the sensor daemon is not running
  • Lineup order is automatically generated (using the rules below)
  • Race using a configurable number of lanes
  • Password authentication

Derby lineup rules

  • Each contestant will run exactly once in each lane
  • The winner is the contestant with the lowest cumulative/average time (no brackets/playoffs)
  • In the first round, contestants race in the order they were registered
  • Contestants will race against others they have not yet raced against when possible
  • Keeping the above constraints, racers with slower averages will race before those with faster averages
  • When swapping out or adding contestants, the upcoming 3 heats are not recalculated unless there are empty lanes

Missing features

  • Manual lineup - Races are lined up using the rules above and cannot yet be manually set
  • Customization - support for other devices and variations on the lineup rules
  • Deltas - indicate when a contestant moves up or down in rank with a green or red highlight
  • Non-finishers - handle people whose cars don't make it to the sensor in under 10 seconds; currently they don't get a time for that heat
  • Windows support - The application runs only on Linux and Mac OSX
  • Mobile layout - the responsive mobile layout sometimes isn't very pretty

Feel free to inquire (via issues) regarding how you can modify this app for your setup. I am happy to assist.

Supported Track Sensors

Adding support for any track sensor that communicates via serial port should be straightforward.

Initial Setup

  1. Install drivers for the USB serial connector
  2. Install Ruby >= 2.0.0, bundler, and [node.js][http://nodejs.org].
  3. Install build tools for your operating system: a. Mac OSX: Install the Xcode command line tools b. Ubuntu/Debian Linux: sudo apt-get install build-essential c. Fedora/CentOS/RedHat Linux: yum groupinstall "Development Tools"
  4. Install the required ruby dependencies

    bundle install
    
  5. Initialize the database

    rake db:setup RAILS_ENV=development
    rake db:setup RAILS_ENV=production
    
  6. Ensure the config/derby_config.yaml file is configured correctly for your setup

  7. Precompile assets for production mode (Do this every time you update javascript/css/images)

    rake assets:precompile RAILS_ENV=production
    

Starting the Derby

  1. Run the application and sensor daemon as root (for access to port 80) and wait a few seconds

    sudo foreman start   # or rvmsudo if using rvm
    
  2. Visit http://localhost/ - You should see the welcome screen, and it should report that the sensor is not plugged in

  3. Connect the sensor via USB, and turn it on. (DT-8000: Hit the reset button, and it should display "3 lanes". Press reset until the sensor display goes blank.)
  4. Verify that the "not plugged in" warning has gone away
  5. Connect with other devices to the URL on the welcome page (status board and/or other device to manage the derby)
  6. Visit the contestants page to register contestants
  7. Visit the Dashboard page to manage the races

Running a heat

  1. Have the contestants for the upcoming heat place their cars on the track. If a contestant is missing, click their name to swap in another contestant and try the missing person later.
  2. On the Dashboard page, click the "Start the race" button. The next race is highlighted in green.
  3. Simultaneously release the cars and release the sensor's start switch to start the timer. The race times will appear on the Dashboard after they pass the finish line.
  4. If needed, click the "redo" button to re-run the same heat.

Configuration

config/derby_config.yml contains several configuration options, including sensor type, device file location, and lane count.

Password Authentication

A password can be used to prevent others who access the app URL from doing things that only the derby master should.

The default config/derby_config.yml uses the environment variable DERBY\_ADMIN\_KEY to supply the password, for example:

DERBY_ADMIN_KEY="mySuperSecretPassword" sudo -E foreman start

Alternatively, the password can be stored directly in config/derby_config.yml:

admin_password: "mySuperSecretPassword"

When a password is set, the app locks itself down in read-only mode and creates a "Run the race" login button on the front page.

Revisit the login page to log out.

Running for Testing / Development

To simulate a track sensor when one is not plugged in, use the mock sensor:

bin/mock-sensor

mock-sensor will announce what device file (eg. /dev/ttys009) it is using.

Before staring the server/daemon, set the environment variable TRACK_SENSOR_DEVICE to this device file. Eg:

In production:

TRACK_SENSOR_DEVICE=/dev/ttys009 sudo -E foreman start   # or rvmsudo if using rvm

In development:

TRACK_SENSOR_DEVICE=/dev/ttys009 RAILS_ENV=development DEBUG=true sudo -E foreman start   # or rvmsudo if using rvm

Optionally set the environment variable DEBUG=true to get more output from the sensor_watch daemon, including sensor device status and data received.

Developing

This project uses Rails 4.2.

Contributing

This pinewood-derby application is Copyright 2015 Edward Anderson, and is distributed under the GNU Affero General Public License (see LICENSE). This license requires that you provide the source code to users of this application.

Please let me know (via issues) if you're interested in using this PinewoodDerby software or need help with it.

Something went wrong with that request. Please try again.