Amateur Radio contesting is an activity where hobbyists get on air, exchange information and log the exchange. A contest awards points for such an exchange using rules defined by the contest manager. This project implements a contest logging solution that is Open Source, Cross Platform and Extensible.
The project has several active branches:
- Main - the general main active branch where the actual application will emerge once we have something that's an actual application.
- Pre-Alpha - A Proof of Concept (PoC), has been developed in a separate branch to act as a demonstration, one step above drawing on a piece of paper. You should not rely on it to accurately do anything. If you find issues, please lodge an issue, but understand that this is NOT the actual product, it's the first pass at exploring what kinds of issues will need to be resolved when implementing an open source, cross-platform contest logging solution.
- system-design - the place where this project is being designed.
There are many tools that provide various levels of contest logging. I have tried most, if not all of them. Whilst I have used several of them for serious contesting, I've always found that they didn't meet my expectations. In order to progress this area of Amateur Radio, I started putting together a list of requirements for my ideal solution.
The result is this project.
You are encouraged to play with this, provide feedback, suggest improvements, give constructive criticism and participate as much or as little as you like. Ultimately this is intended to be a tool that works for as many people as possible.
To start a discussion about features and functionality, a Proof of Concept (PoC), has been developed as a product demonstration, one step above drawing on a piece of paper. You should not rely on it to accurately do anything. If you find issues, please raise a ticket, but understand that this is NOT the actual product, it's the first pass at exploring what kinds of issues will need to be resolved when implementing an open source, cross-platform contest logging solution.
It is available online as a Progressive Web App (PWA) and can be used in any web browser and should be installable as an application on all operating systems for offline use. Note that several browsers do not (yet) support installing a PWA.
The PoC has the following functionality:
- Form with basic logging fields
- Table with log entries
- Example of a Preferences screen
- Log current time
- Local storage of current log
- Log export to file
- Example of a validation error
- Switching between two layout style sheets
- Installable PWA
Currently in-hand is the overall system and architecture design. It's very much a work in progress and you're encouraged to comment and suggest functionality using the issue-tracker. It's being managed in the system-design branch.
As a first pass at defining the feature set and requirements for this tool, below is a list that describes what an "ideal" amateur radio contest logging tool should provide. The list is not complete, is likely not in order and open to discussion.
These sections describe the environment in which this tool is intended to operate.
- must be open source and the code must be available to the entire community. There are too many stories of great tools dying or being held hostage by individuals or small groups. The tool should continue to exist and be usable regardless of the participation of the original developer. Users should be able to fix things, add functionality, change themes, whatever.
- must be cross platform, as-in, you should be able to use it on whatever computer you have access to, a Linux workstation, a Macintosh Laptop, an Android Phone or tablet, Windows, iOS and a Raspberry Pi. In other words, there shouldn't be a situation where you cannot run the tool because you have some random combination of operating system or CPU that the developer doesn't support.
- must be usable without needing to be connected to the internet during the contest.
- must provide an update mechanism.
- updates must not be forced on the user.
These sections describe what type of contesting functionality the tool should have.
- must have the ability to add contest rules, using a versioned plug-in system that can be authored by novice programmers or contest managers.
- plug-ins must be shareable by the user.
- must be extensible. Not every contest requires the same information. For example, the John Moyle Memorial Field Day, a contest run every year during March in Australia requires that VHF and UHF contacts record the maidenhead locator, a four or six character message that designates the location of the station. This is used to calculate distance between two stations and award points accordingly. Such a requirement isn't needed in most other contests.
- must support live validation be able to show if a contact if valid by whatever means the rules for a particular contest decide.
- must export data in whatever format the contest organiser accepts.
- must export entire log set for backup and takeout purposes using an open standard.
- should support the super check partial list to validate partial callsigns.
- should provide an API for other validation lists.
These sections describe the requirements for user experience.
- user must be able to set a preferred layout using a style sheet that can be shared.
- must be able to disable fields in such a way that the field is visible, but not required for a successful log entry.
- must respect users already defined system settings such as:
- dark mode
- date format
- fields must be able to have a default value
- fields should be able to be hidden and data entry should skip hidden fields.
- must honour user preferred input method and be able to use that to complete all the common contesting data entry.
- must be able to use keyboard or mouse, or both.
- must not require crazy keyboard shortcuts, unless specified by the user, in other words, the tool needs to be able to get out of the way of the user.
- must provide a mechanism to edit a contact after it has been logged.
- must track previous entries and present data from previous contacts.
- must store all contacts ever made.
- must automatically log time with the ability to manually override.
- logging must be in UTC.
- should be able to import existing logs so you can start to consolidate older logs.
This is an Open Source project, on purpose. The idea is that it's your project to contribute to in what ever way works for you. You can email me cq@vk6flab.com, or create an issue, better still, make a pull-request.
I look forward to your ideas!
73, de Onno VK6FLAB