User Guide
Everything you need to know about using CollarID to track and manage your wildlife devices.
Live Map
The map is the main interface for monitoring your devices in real time. Devices appear as colored dots that update via a live WebSocket connection.
Device Markers
- Green = seen in the last 60 seconds
- Amber = seen in the last 5 minutes
- Red = not seen for more than 5 minutes
Click a marker to open its popup with GPS coordinates, signal info, weather, and quick links to history, notes, alerts, and more.
Sidebar
The left panel lists all your devices with battery levels, coordinates, signal strength, and quick-access buttons:
- stats — Dashboard with daily fix count, distance traveled, and uptime
- config — View the device's ChirpStack LoRaWAN configuration (DevEUI, keys, region)
- cmds — Send raw hex downlink commands to the device
- history — Open the telemetry history table and track visualization
- notes — Add and view field notes for the device
Click the pencil icon next to a device name to rename it. Click the emoji to set a custom avatar.
Map Controls
Map Style
Cycle between Dark, Satellite, and Terrain (OpenTopoMap) views using the style button in the top-right corner of the map.
Heatmap
Toggle a density heatmap overlay showing where your devices have been concentrated.
Distance Measurement
Click the ruler tool, then click points on the map to measure distances between locations. Double-click to finish.
Marker Clustering
When zoomed out, nearby devices are automatically grouped into clusters showing the count. Click a cluster to zoom in.
Refresh Interval
Use the dropdown next to the connection status indicator to control how often the sidebar and marker colors refresh: 5s, 15s (default), 30s, 60s, or Off. Device data still arrives in real time via WebSocket regardless of this setting.
Tags & Filtering
Organize devices by adding tags (e.g., "herd-A", "north-field"). Tags are stored locally in your browser.
- Click the + button on a device card to add a tag
- Click an existing tag to remove it
- Use the tag filter bar at the top of the sidebar to show only devices matching a specific tag
- Tag filtering also applies to map markers and clusters — non-matching devices are hidden on the map
History & Tracks
Click history on any device to open the telemetry table. Use the time range presets (24h, 3d, 7d, 30d, All) or set a custom date range.
- Show Track — Draws the device's GPS path on the map. Night segments are colored indigo, daytime segments are blue.
- Home Range — Choose between Convex Hull (simple bounding polygon) or KDE (kernel density estimation with 50%/75%/95% contours).
- Clear HR — Removes the home range visualization from the map.
- CSV — Export the current history data as a CSV file (client-side).
- GPX — Export GPS track points as a GPX file (server-side, suitable for GIS software).
Toggle subsystem columns (GPS, Environment, LoRa, Activity, etc.) using the row of buttons above the table.
Geofences
Define geographic boundaries and get notified when devices cross them.
- Open the Geofences panel at the bottom of the sidebar
- Click + New to start drawing — click on the map to add points, double-click to close the polygon
- Name your geofence (e.g., "North Pasture") and save
- When a device enters or exits a geofence, you receive:
- A real-time banner notification on the map
- An email alert (if enabled in Account Settings)
- A webhook POST (if configured)
- Click a geofence on the map to edit or delete it
- Geofence updates are automatically synced to your devices via LoRaWAN downlink
Alerts
Set up alerts for individual devices to monitor battery levels and connectivity:
- Click a device marker on the map, then click Alerts in the popup
- Battery Low — Set a percentage threshold (e.g., 20%). You'll be notified when the device drops below it (max once per hour).
- Offline — Set a duration threshold. You'll be notified if the device hasn't reported in.
Alerts are delivered via WebSocket (in-app), email, and webhook — depending on your Account Settings.
Field Notes
Attach text notes to any device for field observations, maintenance logs, or other records.
- Click notes on a device card in the sidebar, or click Notes in the marker popup
- Notes include a timestamp and are stored on the server
- Delete individual notes with the trash button
Webhook Notifications
Receive real-time JSON POST notifications to an external URL (Slack, Discord, custom server, etc.).
- Open Account Settings (the key icon at the bottom of the sidebar)
- Enter your webhook URL in the Webhook URL field
- All geofence and battery alerts will be POSTed as JSON
- Slack-compatible: the payload includes a
textfield for automatic rendering
Example payload:
{
"type": "geofence_alert",
"event": "ENTERED",
"device_uid": "0x0024000D",
"display_name": "Bella",
"fence_name": "North Pasture",
"message": "Bella entered geofence 'North Pasture'",
"text": "Bella entered geofence 'North Pasture'"
}
Data Export
Per-Device Export
- CSV — Exports all visible telemetry columns from the history table. Generated client-side.
- GPX — Exports GPS track points in standard GPX format. Generated server-side for the selected time range.
Both are available from the history panel toolbar when viewing a device's history.
Bulk Export
Export data for all your devices at once from the Cloud Data page:
- ZIP of CSVs — Downloads a ZIP file containing one CSV per device with all telemetry data.
- GeoJSON — Downloads a single GeoJSON FeatureCollection with all device points, suitable for GIS tools like QGIS.
Notes Download
In the Notes modal for any device, click the download button to save all notes as a .txt file.
Keyboard Shortcuts
Use these shortcuts on the Live Map page for faster navigation:
- Esc — Close the topmost modal or overlay
- / — Focus the device search box in the sidebar
- N — Select the next device in the list
- P — Select the previous device in the list
Shortcuts are disabled when typing in input fields or text areas.
Organizations
Organizations let multiple users share devices and geofences. When your account belongs to an org:
- You see all devices assigned to your organization, in addition to your own
- Geofences created by any org member are visible to all members
- Real-time WebSocket updates include org-shared devices automatically
Organization membership and device assignments are managed by your admin in the Admin Panel under the Orgs tab.
Mobile
On mobile devices, the sidebar appears as a bottom sheet that you can swipe up and down:
- A drag handle is visible at the bottom of the screen — tap or swipe up to open the device list
- Swipe down to minimize it back to the handle
- The map remains fully interactive underneath
Account Settings
Click the key icon at the bottom of the sidebar to manage your account:
- Change password — Requires your current password
- Email address — Used for alert notifications
- Email alerts — Toggle email delivery for geofence enter/exit events
- Webhook URL — Set a URL to receive JSON alert notifications