This repository is part of project for tracking vehicles. Main repository with backend server can be found here.
Whole configuration is located in Constants.h header file. Default configuration should look like:
const int MPU_ADDR = 0x69;
static const int MOVEMENT_THRESHOLD = 3000;
static const int POWER_PIN = 5;
static const int RED_LED_PIN = 26;
static const int GREEN_LED_PIN = 25;
static const int POSITION_FREQUENCE = 3000; // ms
static const int POSITIONS_IN_REPORT = 5;
static const int REPORT_FREQUENCE = POSITIONS_IN_REPORT * POSITION_FREQUENCE; // ms
static char WIFI_SSID[] = "tracker";
static char WIFI_PASSWORD[] = "12345678";
static char STATIC_FILES_PREFIX[] = "/w";
static int HTTP_PORT = 80;
static int DNS_PORT = 53;
static char WEBSOCKET_PATH[] = "/ws";
static float MINIMAL_ACCURACY = 3.0;
static float SPEED_LOWER_LIMIT = 3.0;
static float SPEED_UPPER_LIMIT = 200.0;| Variable name | Description |
|---|---|
| MPU_ADDR | I2C address of accelerometer |
| POWER_PIN | ESP32 pin that is connected to power pin on WARCAR module |
| RED_LED_PIN | Pin that is connected to red (part of) LED |
| GREEN_LED_PIN | Pin that is connected to green (part of) LED |
| POSITION_FREQUENCE | sampling frequency of actual vehicle position |
| REPORT_FREQUENCE | frequency of sending reports to the MQTT broker |
| MAX_DISTANCE_BETWEEN_TWO_POSITIONS | positions that are set apart that are more than this threshold (in meters) apart are ignored as invalid |
| WIFI_SSID | name of the wifi network broadcast by the tracker |
| WIFI_PASSWORD | password to the wifi network broadcast by the tracker |
| STATIC_FILES_PREFIX | path to frontend in SPIFFS (other) filesystem |
| HTTP_PORT | number of port where the web ui will be exposed |
| WEBSOCKET_PATH | path to endpoint where it will be possible to connect |
| MINIMAL_ACCURACY | data from GPS with lower accuracy then this threshold will be ignored |
| SPEED_LOWER_LIMIT | data from GPS with lower speed then this threshold will be ignored |
| SPEED_UPPER_LIMIT | data from GPS with higher speed then this threshold will be ignored |
Variables above allows to modify just technical aspects of tracker. The configuration and pairing with backend is done
by the UI. This is the reason why tracker needs to configure WiFi SSID and password. Connect to WiFi broadcast by
tracker (WIFI_SSID). Once you will be connected, you can type tracker.local into address line in your browser. User
interface will appear and you'll be prompted to upload configuration file. You can generate a configuration file in the
web administration (more info here: TO DO).
A PlatformIO framework is required for the code to work properly!
There is upload-all.sh build script that compile whole code and uploads it to ESP (ports can be changed
in platformio.ini)