Open Rally Computer

An open source tripmaster for navigation rallies

(after 2000km abuse...)

Description

This is a Fork of the Open Rally Computer project by Matías Godoy. The original project can be found https://github.com/mattogodoy/open-rally-computer

The Open Rally Computer (previously known as Baja Pro) is a complete tripmaster for navigation rallies.

Some of its features are:

Based on GPS technology
Adjustable partial distance odometer
Total distance odometer
Speedometer
Average speed
Max speed
Trip time
Multiple languages and unit systems

changes / additions in this fork:

Compass (CAP heading) with 2D Compass Rose
Firmware updates over-the-air using webinterface (ElegantOTA)
GPX Track Logging to SD Card
POI Saving to SD Card
Display 12V input voltage display
http endpoint for GPX Tracks and Saved POIs
http endpoint for querying driving stats
The GPX Track endpoint is available on route /. It is possible to download all saved tracks here.

The stats endpoint lists all current stats and returns a formatted JSON like this:

{
  "currentSpeed": 45.2,
  "currentHeading": 275.8,
  "currentLatitude": 52.520008,
  "currentLongitude": 13.404954,
  "currentAltitude": 34.50,
  "gpsSatellites": 8,
  "gpsFix": 1,
  "gpsPrecision": 2.1,
  "currentTemperature": 23,
  "isMoving": true,
  "average": 42.7,
  "timeHours": 14,
  "timeMinutes": 32,
  "timeSeconds": 45,
  "tripPartial": 127.5,
  "tripTotal": 1543.2,
  "maxSpeed": 78.9,
  "units": 0
}

Note: There is an addon project that utilizes the stats endpoint to operate an automatic chain oiler. You can find it here: ChainOiler

The main goal of this project is to achieve a widely used open-source device that can be improved over time by ourselves, the pilots behind the roadbook.

Note: contrary to the original project, this fork does not use FRAM to store the data, but saves it to the SD Card. This makes it MUCH more UNreliable! So if you are planning to use this in a real rally, I would recommend to use the original project.

Schematics and PCB

For a more sophisticated version of the ORC with Schematics and PCB, please go to the Open Rally Computer repository of Matías Godoy.

this fork here is a simplified version wireing the components directly to the used ESP32 DevKit V1. The mess of wires can be seen in the image below:

This includes:

the pins are listet in pins.h (when changing them, make sure to take into account that two SPI ports are used (Display and SD Card Reader) and that the GPS Module uses the Serial Port 2)

3D Printed Case

a very basic case can be found in the docs/stl folder. It is designed to be printed in two parts and stacked together.

User manual

You can find the User Manual in the manual folder.

Getting Started

These instructions will allow you to compile the project in you local computer. In order to run it you will need an actual device.

Prerequisites

This project has been developed using VSCode with the PlatformIO plugin, which is is the recommended setup.

Install VSCode
Install the PlatformIO plugin
Clone this repository

git clone https://github.com/pcace/open-rally-computer.git

Building

To build this project you can open the directory of the repository you just downloaded in VSCode.

Once open, go to the sidebar at the left, PlatformIO -> esp32dev -> General -> Build

The required libraries are already bundled in the lib directory of this repo. PlatformIO will automatically try to use them. If for some reason you are getting compilation errors because of missing libraries, you can always install them manually going to PlatformIO -> PIO Home -> Libraries.

You can find the list of necessary libraries in the file platformio.ini.

Flashing into device

Once the project compiles correctly in your computer, you are ready to flash it into the rally computer.

Connect your ESP32 (DevKit or programmer) to your computer via USB.
Go to PlatformIO -> esp32dev -> General -> Upload
PlatformIO should automatically detect the serial port where your ESP32 is connected, buld the project and flash it for you.

Flashing over-the-air

Once the project is flashed into the device, you can update the firmware over-the-air. After the first flash the device will open up a wifi network called "ORC" (see webserver.cpp for PW). After connecting to this network you can use the webinterface to upload a new firmware.

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests.

Also read CODE_OF_CONDUCT.md for details on the code of conduct for this project.

Versioning

We use SemVer for versioning.

For a list of available versions, see the tags on this repository.

Authors

Original Repository: Matías Godoy - matto.io
this Fork: pcace - pcace

See also the list of contributors who participated in this project.

TO-DO

There are a few things I'd like to do in order to improve this project and its repository:

Build, upload and tag Version 1.0.0 binary as a release
Translate user manual to english

License

This project is licensed under the GPL v3 License - see the LICENSE file for details.

This is what this means:

Anyone can copy, modify and distribute this software.
If you do, you have to include the license and copyright notice with each and every distribution.
You can use this software privately.
You can use this software for commercial purposes.
If you build your business based on this code, you have to open-source your whole code base.
Any modifications of this code base MUST be distributed with the same license (GPL v3).
Any changes made to this code MUST be indicated on distribution.
This software is provided without warranty.
The software author or license can not be held liable for any damages inflicted by the software.

Changelog

1.0.0: Initial version
- The complete project was open sourced, including source code, bill of materials, PCB desings and user manual.

Contributors

turtle3333: User manual translation

License

pcace/open-rally-computer

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages