Files
car/README.md
T
2026-06-07 00:33:58 +09:00

41 lines
1.2 KiB
Markdown

# Car
PHP based vehicle service for state collection, TCP command dispatch, monitoring, and mobile data usage display.
## Main Features
- Vehicle status collection and storage.
- TCP command dispatch for allowed vehicle commands.
- Monitoring UI with separated status and usage AJAX endpoints.
- Data usage and billing display with adjustment metadata.
- TCP failure reason and receive freshness metadata.
## Main APIs
- `api.php?action=status`
- `api.php?action=command`
- `monitor.php?mode=ajax`
- `monitor.php?mode=usage`
## Structure
- `api.php`: vehicle status and control API.
- `monitor.php`: monitoring UI and AJAX responses.
- `common.php`: external secret loading and shared DB/API helpers.
- `collector_se.php`: CLI/cron state collector.
- `sw.js`: service worker.
- `assets/`: icons and static assets.
## Secrets
Runtime settings are loaded from `/home/seo/secret/car.php`. Do not commit that file.
Expected values include TCP settings, DB credentials, API token, and allowed IP policy.
## Security
- Vehicle API uses API token or allowed IP policy.
- Control commands are limited to known command codes.
- Secret files must remain outside the repository with restricted permissions.