From 5d48f1280612b2f525c9a2d60f96434f1a217156 Mon Sep 17 00:00:00 2001 From: kutayboz Date: Thu, 3 Aug 2023 17:44:37 +0300 Subject: Finished cfg file implementation. Preliminary readme. v1.0.0 --- readme | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 readme (limited to 'readme') diff --git a/readme b/readme new file mode 100644 index 0000000..e959d29 --- /dev/null +++ b/readme @@ -0,0 +1,35 @@ +CelNetMon - Cellular Network Monitor +A cellular network signal quality monitoring utility. Written to be used during my thesis work. +Uses the BG96 chip with AT commands, connected through GPIO and serial pins of a Linux machine. Should be easy to adapt the code to other devices using AT commands. +Requires libgpiod. +Compiled and tested with Clang 11.0.1 aarch64. + +Compiling +CMake is used in development. +For development, "celnetmon" target can be used to work in the build folder. +For release, "install" target creates and puts the executable in "./bin". + +Usage +Make sure to create a "celnetmon.cfg" config file in the same folder with the executable. An example "celnetmon.cfg.example" is included in the repo. + +"celnetmon --init" +Powers the BG96 chip on, initiates the GNSS system, configures and connects to the network. + +"celnetmon --publish" +Collects network telemetry and GNSS location, publishes the data to the specified MQTT server in the config file. + +"celnetmon --stop" +Powers the chip down. + +A-GPS technologies are not implemented. For that reason, GNSS takes some time to establish. +Telemetry data that is collected are: +- Network operator name +- Roaming status +- Tracking area code +- Cell ID +- Technology +- Band +- Channel +- Network Time +- GPS location +- Signal quality indicators (BER, RSRP, RSRQ, RSSI, SINR) \ No newline at end of file -- cgit v1.3