From 80b89a9734f62fb833bfb9a0a1525ac82862897c Mon Sep 17 00:00:00 2001 From: kutayboz Date: Thu, 3 Aug 2023 18:01:20 +0300 Subject: Readme formatting --- README.md | 36 ++++++++++++++++++++++++++++++++++++ readme | 35 ----------------------------------- 2 files changed, 36 insertions(+), 35 deletions(-) create mode 100644 README.md delete mode 100644 readme diff --git a/README.md b/README.md new file mode 100644 index 0000000..ccbf301 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# 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. + +> [!NOTE] +> 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 diff --git a/readme b/readme deleted file mode 100644 index e959d29..0000000 --- a/readme +++ /dev/null @@ -1,35 +0,0 @@ -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