How zain-ul-abdin45/anpr-toll-processing works
Project Type & Purpose
• This is a backend Toll‐Processing microservice built in Python using FastAPI.
• Its purpose is to read vehicle plates via ANPR (camera) or RFID, apply security checks, store transactions in PostgreSQL, generate alerts, and send notifications.
File Structure
• Top level:
• main.py – FastAPI app entrypoint
• api/ – HTTP route modules (plate, RFID, toll, notification, security)
• modules/ – Core business‐logic components (anpr, rfid, security checks, toll logic, SQL layer, logger, notification, vehicle simulation)
• configs/ – JSON/INI config files for DB, logger, system settings
• db_scripts/ – DDLs and seed scripts for PostgreSQL
• logs/ – Rolling directories capturing all runtime logs
• seeds_data.py & requirements.txt
• Architectural pattern: layered monolith separating API, business logic, data access, and cross‐cutting concerns (logging, config).
README Insights
• Tech stack: Python 3.10+, FastAPI, PostgreSQL
• Deployment: Uvicorn server, optional Render cloud hosting
• Logging is file‐based per concern (alerts, transactions, plate reads)
Main Components & Their Relationships
a. External Hardware / Services:
• ANPR Camera (plate image feed)
• RFID Reader
• Notification Channels (e.g., email/SMS gateway)
b. API Layer (FastAPI) – main.py + api/*.py
• Exposes REST endpoints for plate reads, RFID scans, toll transactions, security checks, notification triggers.
c. Business Logic Layer – modules/*.py
• anpr.py: image‐to‐plate parsing
• rfid.py: RFID tag validation
• security.py: user access checks
• toll_logic.py & toll_transaction.py: pricing, transaction creation
• vehicle.py & vehicle_simulation.py: vehicle modeling/testing
• notification.py: message formatting & dispatch
• sql.py: data‐access functions (CRUD in PostgreSQL)
• logger.py: centralized logger configuration & writes
d. Configuration Subsystem – configs/config.json, logger.ini, system.ini
e. Persistence Layer – PostgreSQL Database
f. Logging Subsystem – logs/… (alert_logs, plate_logs, rfid_logs, txn_logs, general_logs)
g. Deployment – Uvicorn ASGI server
Data Flows & Interactions
1. ANPR camera → HTTP POST /plate endpoint → api/plate_routes.py
2. Route handler calls modules/anpr.py → plate number
3. modules/security.py validates vehicle/user
4. modules/toll_logic.py computes toll, modules/sql.py persists transaction to PostgreSQL
5. modules/notification.py sends out alerts via configured channels
6. All steps log to modules/logger.py → rolling log files
Architectural Patterns & Design Principles
• Layered architecture: separation of concerns between API, business logic, data access
• Config‐driven: behavior controlled by configs under configs/
• Modular code: each domain function in its own module for testability & maintenance
• File‐based logging per concern for auditability