python backend arduino service

This commit is contained in:
Mikkeli Matlock
2026-01-26 11:52:29 +09:00
parent 2a379ede20
commit 8f22966eb0
5 changed files with 252 additions and 7 deletions

View File

@@ -1,6 +1,6 @@
# Backend
Python GPS service for Smart Serow. Connects to `gpsd`, buffers positions, exposes HTTP API.
Python GPS and Arduino telemetry service for Smart Serow. Connects to `gpsd` and Arduino serial, buffers data, exposes HTTP API.
## Setup
@@ -28,9 +28,11 @@ uv run flask --app main run --host 0.0.0.0 --port 5000 --reload
| Endpoint | Description |
|----------|-------------|
| `GET /health` | Health check, shows gpsd connection status |
| `GET /health` | Health check, shows gpsd and Arduino connection status |
| `GET /gps` | Latest GPS fix (lat, lon, alt, speed, track) |
| `GET /gps/history` | Last 100 buffered positions |
| `GET /gps/history` | Last 100 buffered GPS positions |
| `GET /arduino` | Latest Arduino telemetry (voltage, rpm, eng_temp, gear) |
| `GET /arduino/history` | Last 100 buffered Arduino readings |
## Test from SSH
@@ -38,6 +40,8 @@ uv run flask --app main run --host 0.0.0.0 --port 5000 --reload
curl http://localhost:5000/health
curl http://localhost:5000/gps
curl http://localhost:5000/gps/history | jq
curl http://localhost:5000/arduino
curl http://localhost:5000/arduino/history | jq
```
## gpsd Setup (Pi)
@@ -62,9 +66,48 @@ gpsmon
cgps -s
```
## Arduino Setup (Pi)
The Arduino Nano connects via USB serial (typically `/dev/ttyUSB0` or `/dev/ttyACM0`).
```bash
# Check available ports
ls /dev/tty*
# May need dialout group for serial access
sudo usermod -aG dialout $USER
# Then log out and back in
```
### Arduino Protocol
**Production format (JSON at 115200 baud):**
```json
{"v":12.45,"rpm":4500,"eng":85,"gear":3}
```
**Legacy text format (also supported):**
```
V_bat: 12.45V
RPM: 4500
ENG: 85C
```
The parser tries JSON first, falls back to regex for legacy format.
### Configuring the Port
Edit `main.py` to change the default port:
```python
arduino = ArduinoService(port="/dev/ttyACM0", baudrate=115200)
```
## Stub Mode
If `gpsdclient` isn't installed or gpsd isn't running, the service generates fake GPS data for UI testing.
- **GPS**: If `gpsdclient` isn't installed or gpsd isn't running, generates fake GPS data
- **Arduino**: If `pyserial` isn't installed or serial port unavailable, generates fake telemetry
Both services run in stub mode for UI testing without hardware.
## Deploy

View File

@@ -0,0 +1,175 @@
"""Arduino service - connects to Arduino Nano via serial, buffers telemetry."""
import json
import re
import threading
import time
from collections import deque
from typing import Any
# pyserial for UART communication
try:
import serial
except ImportError:
serial = None # Allow import without pyserial for testing structure
class ArduinoService:
"""Threaded Arduino serial reader with buffering and auto-reconnect."""
# Regex patterns for legacy text protocol
PATTERNS = {
"voltage": re.compile(r"V_bat:\s*(\d+\.?\d*)V?", re.IGNORECASE),
"rpm": re.compile(r"RPM:\s*(\d+)", re.IGNORECASE),
"eng_temp": re.compile(r"ENG:\s*(\d+)C?", re.IGNORECASE),
"gear": re.compile(r"GEAR:\s*(\d+)", re.IGNORECASE),
}
def __init__(
self,
port: str = "/dev/ttyUSB0",
baudrate: int = 115200,
buffer_size: int = 100,
):
self.port = port
self.baudrate = baudrate
self.buffer_size = buffer_size
self._buffer: deque[dict[str, Any]] = deque(maxlen=buffer_size)
self._latest: dict[str, Any] = {}
self._connected = False
self._running = False
self._thread: threading.Thread | None = None
self._lock = threading.Lock()
@property
def connected(self) -> bool:
return self._connected
def get_latest(self) -> dict[str, Any]:
"""Get most recent telemetry values."""
with self._lock:
return self._latest.copy() if self._latest else {"error": "no data"}
def get_buffer(self) -> list[dict[str, Any]]:
"""Get buffered telemetry history."""
with self._lock:
return list(self._buffer)
def start(self):
"""Start background serial reader thread."""
if self._running:
return
self._running = True
self._thread = threading.Thread(target=self._reader_loop, daemon=True)
self._thread.start()
def stop(self):
"""Stop background reader."""
self._running = False
if self._thread:
self._thread.join(timeout=2.0)
def _reader_loop(self):
"""Main reader loop with reconnection logic."""
while self._running:
try:
self._connect_and_read()
except Exception as e:
self._connected = False
print(f"[Arduino] Connection error: {e}, retrying in 5s...")
time.sleep(5)
def _connect_and_read(self):
"""Connect to Arduino serial and read data."""
if serial is None:
# Stub mode - no pyserial installed
print("[Arduino] pyserial not installed, running in stub mode")
self._stub_mode()
return
try:
ser = serial.Serial(
port=self.port,
baudrate=self.baudrate,
timeout=1.0,
)
except serial.SerialException as e:
print(f"[Arduino] Cannot open {self.port}: {e}, falling back to stub mode")
self._stub_mode()
return
try:
self._connected = True
print(f"[Arduino] Connected to {self.port} @ {self.baudrate} baud")
while self._running:
try:
line = ser.readline().decode("utf-8", errors="ignore").strip()
if not line:
continue
data = self._parse_line(line)
if data:
data["time"] = time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime())
with self._lock:
# Merge new values into latest (preserve old values for partial updates)
for key, val in data.items():
if val is not None:
self._latest[key] = val
self._latest["time"] = data["time"]
self._buffer.append(self._latest.copy())
except serial.SerialException as e:
print(f"[Arduino] Serial error: {e}")
break
finally:
self._connected = False
ser.close()
def _parse_line(self, line: str) -> dict[str, Any] | None:
"""Parse a line from Arduino - JSON first, fallback to regex.
JSON format: {"v":12.45,"rpm":4500,"eng":85,"gear":3}
Legacy text: V_bat: 12.45V
"""
# Try JSON first (production format)
try:
obj = json.loads(line)
return {
"voltage": obj.get("v"),
"rpm": obj.get("rpm"),
"eng_temp": obj.get("eng"),
"gear": obj.get("gear"),
}
except json.JSONDecodeError:
pass
# Fallback to regex for legacy text protocol
result = {}
for key, pattern in self.PATTERNS.items():
match = pattern.search(line)
if match:
val = match.group(1)
result[key] = float(val) if "." in val else int(val)
return result if result else None
def _stub_mode(self):
"""Fake data for testing without Arduino connected."""
import random
while self._running:
self._connected = True
data = {
"time": time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()),
"voltage": round(12.0 + random.uniform(-0.5, 0.8), 2),
"rpm": random.randint(800, 6000) if random.random() > 0.3 else None,
"eng_temp": random.randint(60, 95),
"gear": random.randint(1, 6) if random.random() > 0.2 else 0, # 0 = neutral
}
with self._lock:
self._latest = data
self._buffer.append(data)
time.sleep(0.5) # 2Hz stub updates

View File

@@ -1,16 +1,22 @@
"""Smart Serow Backend - GPS service with HTTP API."""
"""Smart Serow Backend - GPS and Arduino services with HTTP API."""
from flask import Flask, jsonify
from gps_service import GPSService
from arduino_service import ArduinoService
app = Flask(__name__)
gps = GPSService()
arduino = ArduinoService()
@app.route("/health")
def health():
"""Health check endpoint."""
return jsonify({"status": "ok", "gps_connected": gps.connected})
return jsonify({
"status": "ok",
"gps_connected": gps.connected,
"arduino_connected": arduino.connected,
})
@app.route("/gps")
@@ -25,13 +31,27 @@ def gps_history():
return jsonify(gps.get_buffer())
@app.route("/arduino")
def arduino_data():
"""Current Arduino telemetry (voltage, rpm, etc)."""
return jsonify(arduino.get_latest())
@app.route("/arduino/history")
def arduino_history():
"""Buffered Arduino telemetry history."""
return jsonify(arduino.get_buffer())
def main():
"""Entry point."""
gps.start()
arduino.start()
try:
# Host 0.0.0.0 for access from Flutter app
app.run(host="0.0.0.0", port=5000, debug=False)
finally:
arduino.stop()
gps.stop()

View File

@@ -1,11 +1,12 @@
[project]
name = "smartserow-backend"
version = "0.1.0"
description = "GPS service for Smart Serow"
description = "GPS and Arduino telemetry service for Smart Serow"
requires-python = ">=3.11"
dependencies = [
"flask>=3.0",
"gpsdclient>=1.3",
"pyserial>=3.5",
]
[project.optional-dependencies]