quoije/yaris-obd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: drop duplicated device-identity section, add RTC + power to hardware table

Browse Source
This commit is contained in:
Mathieu Moran
2026-08-15 21:26:15 -04:00
parent 28f3643e59
commit 386920b258
1 changed files with 2 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+2 -72
View File
@@ -83,6 +83,8 @@ Dashboard — mobile (390 px) and desktop (1280 px):
| Raspberry Pi 3 Model B Rev 1.2 | Web UI host, logger, uploader, and WiFi hotspot |
| Waveshare SIM868 HAT | GNSS (GPS) + optional GSM/GPRS uplink, unused Bluetooth |
| USB OBD-II adapter | PL2303-based, ELM327-compatible (originally Bluetooth, switched to USB) |
| DS3231 RTC module | Battery-backed real-time clock on I²C (`i2c-1`, 0x68) — keeps trip timestamps correct with no internet |
| Power | Regulated 5V hard-wired to GPIO pins 2 & 6 (red/black), fed from a fused 12V→5V source — bypasses the worn micro-USB port |
| 2× TP-Link Archer T3U (RTL8812BU) | USB WiFi dongles — AC1300 dual-band. wlan1 hosts the 5GHz in-car AP; wlan2 carries the internet uplink since 2026-08-14 |
| Onboard BCM43438 (wlan0) | Fallback only — was the internet uplink until 2026-08-14 |
| USB dashcam | Any brand — detected as generic USB mass storage |
@@ -109,78 +111,6 @@ including the one-shot `deploy/auto_install.sh` installer — use
For the remote server (receives trip logs + dashcam uploads), see [server/README.md](./server/README.md).
## Customizing device identity
The Pi displays an owner name, car model, device name, and avatar. You can manage those values in
two ways:
- **Locally on the Pi** through the Settings page
- **From the server portal** when **Sync with server** is enabled on the Pi
The local fallback/default source remains [config/device.json](./config/device.json), so the car
still boots with sensible identity values even when fully offline.
### Edit device configuration
Edit [config/device.json](./config/device.json):
```json
{
"owner_name": "quoije",
"car_model": "Yaris 2013",
"device_name": "Yaris OBD",
"avatar_path": "img/yaris.png"
}
```
| Field | Location | Purpose |
|-------|----------|---------|
| `owner_name` | Top-right of app topbar | Your name/username |
| `car_model` | Left sidebar (next to car icon) | Vehicle model/year |
| `device_name` | Local settings / remote portal | Device identity used by server sync/provisioning |
| `avatar_path` | Top-right avatar circle | Profile picture (relative to `static/`) |
If you edit the JSON file directly, restart the app:
```bash
# If running as a systemd service:
sudo systemctl restart yaris-obd.service
# If running manually:
# Ctrl+C and python3 app.py
```
### Changing the profile picture
Option 1: Replace the default image file:
```bash
cp /path/to/your/image.png static/img/yaris.png
```
Option 2: Add your image to `static/img/` and update `avatar_path`:
```json
{
"avatar_path": "img/my-avatar.png"
}
```
### Important: Username and database filename
The local SQLite database filename is based on `owner_name`: `db/sql/<owner_name>_<car_model>.db` (via [modules/app_sql.py](./modules/app_sql.py)).
If you **change `owner_name`** and already have trip data:
- The app will create a **new database** with the new name
- Your old database remains at `db/sql/quoije_Yaris2013.db` (orphaned)
To preserve your data:
```bash
# Option 1: Rename the database file
mv db/sql/quoije_Yaris2013.db "db/sql/YourName_YourCar.db"
# Option 2: Start fresh
rm db/sql/quoije_Yaris2013.db
```
## Project status
The Pi app, remote server, device sync, and the Android companion app are all implemented and