From 6a9017ac3c6154140065e0ab8c058b4d931d23b9 Mon Sep 17 00:00:00 2001 From: Denis Urs Rudolph Date: Thu, 11 Dec 2025 21:44:57 +0100 Subject: [PATCH] Added Readme.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0b08b5 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# OTA Vehicle Simulator + +A .NET Console Application simulating a connected vehicle in the fleet. It mimics the lifecycle of an IoT device checking for OTA updates. + +## Functionality +* **Registration**: Automatically registers with the backend on startup using a generated or configured VIN. +* **Heartbeat**: Sends regular heartbeats to the backend to report "Online" status. +* **Poll for Updates**: Periodically queries the backend for available firmware updates relative to its current version. +* **Simulation**: Simulates the download and installation process (delays, status updates). + +## Configuration +Inside `Program.cs` or `appsettings.json` (if added): +* **Backend URL**: Defaults to `http://localhost:5000`. +* **VIN**: Can be set via command line args or config; defaults to a random UUID if not provided. + +## Usage +Run multiple instances to simulate a fleet. + +```bash +dotnet run +# OR with specific VIN (if logic implemented to read args) +# dotnet run --vin "VEHICLE_001" +```