Skip to content
This repository has been archived by the owner on Jul 3, 2022. It is now read-only.
/ Car Public archive

The code that runs in the vehicle that gathers data

Notifications You must be signed in to change notification settings

DylanGore-FYP/Car

Repository files navigation

Car

All Contributors

GitHub Workflow Status

This software is intended to run on a device located within a vehicle and can poll data from the OBD-II port and GNSS. The default output for this data is via MQTT but a new output plugin can be created if required.

Configuration

Please create a configuration file called config.toml and modify it to suit your needs. An example is included in the repository.

Running

To run this software, you need pipenv.

pip3 install pipenv

Once pipenv is installed run:

pipenv install

to create a virtual environment and install all the requirements

followed by:

pipenv run python3 -m car

to run the code.

Deployment

For instructions on how to setup and configure a Raspberry Pi to run this software, please see the relevant documentation page.

Commit Message Convention

This project uses Gitmoji for commit organisation. For more details see the Gitmoji Repository.

Contributors


Dylan Gore

💻 📖 🤔

Mohit Taneja

🤔

This project follows the all-contributors specification.