Code for fetching and displaying directions and obd2 metrics
Breakdown of file structure:
- docs - contains documentation for codebase
- docsrc - for using sphinx to autogenerate docs
- src - most important directory, contains code for PathFinder
- tests - contains code for testing (no longer in use)
Download this repo by running git clone https://github.com/Marcusk19/Pathfinder.git
or alternatively download from GitHub as zipfile and unpack it.
Main code for HUD and directions can be found in src
To run code first enter working directory:
cd pathfinder
Install dependencies with:
pip install -r requirements.txt
or...
make init
Then execute binary:
make run
Navigate to http://pfnder.ddns.net
From there you can enter a source and destination
Go back to console and observe output:
NOTE: this information is deprecated as it was written at initialization of the project.
Due to differences in local environments, it may be necessary to run the code in a container
In order to do so you must have docker installed on your machine - follow the instructions here to get started
Download the Docker Desktop and build the image by running: docker build -t pathfinder .
Check that the image has been created: docker images
Run the program by using: docker run -it pathfinder python3 src/HUD.py
Changes in code can be pushed to the container through: docker build -t pathfinder:latest .
Follow this guide here to get setup with a Google developer account and obtain your api key.
View the example.env file to see how you should set up your .env file and replace my_api_key with the api key you received from Google.
Code uses MQTT messaging protocol to send and receive information. Depicted below is the flow of data for the PathFinder:
Code for our client can be found here
Change working directory to docsrc cd docsrc
Run make github - html documentation can be found in docs directory.
[TODO]