Quickstart

This guide will walk you through registering your first device and visualizing its telemetry in under 5 minutes.

Step 1: Create a Device Profile

A Device Profile acts as a template for your hardware. It defines how data from that specific model should be decoded.

1. Log in to your AdaTrack dashboard.

2. Navigate to Device Profiles and click Create Profile.

3. Enter a name (e.g., "GPS Tracker v1") and select a device type.

4. In the Payload Decoder tab, you'll see a default JavaScript template. For this quickstart, we'll use the default decoder which parses a simple binary format:

   function Decoder(bytes, port) {
       // Simple 4-byte Lat/Lon decoder
       return {
           latitude: (bytes[0] << 24 | bytes[1] << 16 | bytes[2] << 8 | bytes[3]) / 1000000.0,
           longitude: (bytes[4] << 24 | bytes[5] << 16 | bytes[6] << 8 | bytes[7]) / 1000000.0,
           battery: bytes[8]
       };
   }

5. Click Save Profile.

Step 2: Register your Device

Now that you have a profile, you can register an individual device.

1. Navigate to the Devices page and click Register Device.

2. Enter a Device ID (this must be unique and is often the IMEI or Serial Number).

3. Select the Device Profile you created in Step 1.

4. Generate or enter an HMAC Key (32-byte HEX string). This key will be used by your device to sign its UDP packets.

5. Click Register.

Step 3: Configure your Device

Configure your hardware or simulator to send UDP packets to the AdaTrack ingestion endpoint.

• Ingestion IP: ingest.adatrack.example.com (Check your dashboard for the exact IP/Port)

• Port: 1234

• Protocol: UDP

• Security: Packets must be signed using the HMAC Key you registered in Step 2.

Test with a Simulator (optional): If you don't have hardware ready, you can use our CLI Simulator to send test packets:

# Registering device 12345 with key ABCDEF...
./adatrack-sim --device 12345 --key ABCDEF... --host ingest.adatrack.example.com --port 1234

Step 4: Visualize Real-time Data

1. Navigate to the Live Map tab.

2. Once your device sends its first valid packet, a marker will appear on the map.

3. Click the marker to view the latest decoded telemetry (Latitude, Longitude, Battery, etc.).

4. Watch the marker move in real-time as new packets arrive.

---

Next Steps

• Define Geofences: Create virtual boundaries and receive alerts when they are crossed.

• Set Up Alerts: Configure telemetry rules to trigger notifications (e.g., "Battery < 20%").

• Generate Reports: Create historical data reports for compliance or analysis.