akorinda / MiSCA-ID-Sticker-Generator

Create sticker sheets with scannable codes for MiSCA athletes
GNU General Public License v3.0
0 stars 0 forks source link

Contributors Forks Stargazers Issues GNU GPL v3.0 License


MiSCA ID Sticker Generator

Short scripts to turn your MiSCA roster report into a sheet of scannable ID codes ready to print
Explore the docs »

Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

As you get more and more members on your team checking everyone in and out begins to take significant time. The idea here is to create scannable codes, currently QR only, which can be printed on sticker sheets and affixed to an athlete's equipment (i.e. helmet).

Why?

Built With

Getting Started

Option 1) Download and run "Create Rider QR.exe" on Windows Option 2) Run a local copy of the script following these steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

  1. Clone the repo
    git clone https://github.com/akorinda/MiSCA-ID-Sticker-Generator.git
  2. Install Python packages
    py -m pip install -r requirements.txt

Usage

Executing the two Python scripts will create sheet of codes which a standard 2D scanner can read to enter rider information into an electronic record. These can then be printed on Avery 1"x1" sticker label sheets and distributed to the athletes. Only those with the role "Rider" will be recognized.

Suggested use case: Place a sticker on each altheles' equipment and scan it as they come and leave practice. The scanned data can populate a spreadsheet to track attendance and provide an electronic record that everyone returned from the ride. If requested I can create a sanitized version of what MMBC used in 2021 and link it here. Create an issue if you are interested.

Work Flow:

  1. Download your rider roster. Important columns are a key (unique identifier), first name, and last name
  2. Convert the roster to an Excel format (.xls or .xlsx) if it isn't already
  3. Run "Create Rider QR.exe or "Create-Images.py"
  4. Follow the instructions presented in the text window
  5. Print the docx file on Avery Presta 94103 1"x1" sticker labels

Sticker Considerations:
The code spacing is currently fixed and only validated for Avery 1"x1" sticker label sheets. It is not on the roadmap to make more templates available but contributions are welcome and appreciated. We choose Avery 94103 for their removable yet water resistant adhesive. These came off cleanly from the athlete's equipment at the end of the season.

Placement Considerations:
At Midland Mountain Bike Crew (MMBC) we found helmets worked best. We tried bike frames but the curve was too much for our cheap 2D scanner. With a QR code lighting did matter and it was possible for the code to be too light but shading with a hand resolved the issue. Similarly, putting the helmet under a brim kept the code shaded and protected it from rain; however, the helmet had to be removed from the rider's head to scan. In the future we want to try a 1D barcode to see if the laser scan is less sensitive to light levels.

Are Duplicants Needed?
The program will ask you how many copies of each sticker you want. We started the season with 3 stickers for each rider. In 2021, out of 64 riders, only one went through all three. We used an inkjet printer and the stickers were succeptible to smugging from rain; two stickers were replaced for water damage. After 12 weeks one sticker would not scan because it had become too faded from sun exposure.

Barcode Scanner Requirements
QR codes require a 2D capable barcode scanner. MMBC used a basic wired 1D 2D barcode scanner in 2021 with success. If power isn't a concern I'd suggest trying a bluetooth one. We found the cord either got in the way or athletes didn't come close enough without prompting. It is not recommended to scan with a barcode scanner directly to a mobile phone. Scanners work like typeboards and phones aren't desired for such quick input. It is possible to use most smartphone cameras as barcode scanners.

Roadmap

See the open issues for a list of proposed features (and known issues).

Overview:

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GNU GPL v3.0 License. See LICENSE for more information.

Contact

Andy Korinda - akorinda

Project Link: https://github.com/akorinda/MiSCA-ID-Sticker-Generator

Acknowledgements