From dbe102e3663686da3786b38e19f0e7d815da766a Mon Sep 17 00:00:00 2001 From: Carlos Guerra Date: Wed, 1 Apr 2026 12:55:01 +0200 Subject: [PATCH] including documentation changes --- doc/configuration.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/configuration.md b/doc/configuration.md index 8834f17..28878e9 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -20,6 +20,10 @@ Through web UI you can set: - *Warnings*, which will alert when a heuristic is triggered. Alerts will be sent at most once every five minutes. - *Low Battery*, which will alert when the device's battery is low. Notifications may not be supported for all devices—you can check if your device is supported by looking at whether the battery level indicator is functioning on the System Information section of the Rayhunter UI. - With **Analyzer Heuristic Settings** you can switch on or off built-in [Rayhunter heuristics](heuristics.md). Some heuristics are experimental or can trigger a lot of false positive warnings in some networks (our tests have shown that some heuristics have different behavior in US or European networks). In that case you can decide whether you would like to have the heuristics that trigger a lot of false positives on or off. Please note that we are constantly improving and adding new heuristics, so a new release may reduce false positives in existing heuristics as well. +- The **GPS Settings** allows you to attach GPS coordinates to every packet in the PCAP file of each session depending on the mode you choose. The relevant attached fields are latitude, longitude, and GPS collection timestamp. This timestamp is meant to be compared during analysis with the packet timestamp so we know the time difference between the packet capture from the GPS capture (given GPS captures are taken in a separate sstream/device from the Rayhunter sensor and might also be inconstant because of coverage issues, among other reasons). The modes are: + - *Disabled*, the default option, won't attach any comment to the packets or enable any program logic for the management of coordinates. + - *Fixed*, this is more suitable for measurements taken in the same geographic position for that session, it enables two input fields for latitude and longitude. They accept decimal degrees format (from -90 to 90 for latitude, and -180 to 180 for latitude). This mode adds a "fixed" value to the GPS timestamp in the PCAP packets to help during analysis to know the coordinates were set up manually. + - *API Endpoint*, enables the /api/gps endpoint to send POST requests in json format with the values for latitude, longitude, and timestamp. The GPS timestamp should be provided as Unix timestamp, and can be passed as number or string without errors, but any other format won't pass the validation process. ## WiFi Client Mode