Detailed WFB-ng facts available for OSD (#41)

seriyps · web-flow · commit 1eb91f2d9866 · 2025-03-10T20:11:20.000+01:00
* 1st attempt to use wfb-cli msgpack socket * Use public JSON api instead of private msgpack one See svpcom/wfb-ng#382 * Document WFB stats facts in README
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -53,7 +53,9 @@ jobs:
           tee /etc/apt/sources.list.d/70-radxa.list <<< "deb [signed-by=/usr/share/keyrings/radxa-archive-keyring.gpg] https://radxa-repo.github.io/bullseye/ bullseye main"
           tee /etc/apt/sources.list.d/80-rockchip.list <<< "deb [signed-by=/usr/share/keyrings/radxa-archive-keyring.gpg] https://radxa-repo.github.io/bullseye rockchip-bullseye main"
 
+          rm -r /boot/* #save space
           apt-get update
+          apt clean
           apt-get install -y cmake g++ git pkg-config librockchip-mpp-dev libcairo-dev libdrm-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libspdlog-dev nlohmann-json3-dev
           apt clean
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -21,6 +21,8 @@ set(SOURCE_FILES
         src/mavlink.c
         src/main.cpp
         src/main.h
+        src/wfbcli.hpp
+        src/wfbcli.cpp
         src/scheduling_helper.hpp
         src/gstrtpreceiver.cpp
         src/gstrtpreceiver.h)
diff --git a/README.md b/README.md
@@ -107,6 +107,49 @@ Currently implemented fact categories are grouped by Mavlink message types:
 
 More can be easily added later. You can use `DebugWidget` to inspect the current raw value of the fact(s).
 
+Pixelpilot is also able to connect to WFB-ng statistics API and extract some of the facts from there.
+Receiving packets statistics (each fact has "id" tag - channel name, eg "video"/"mavlink"/"tunnel" etc):
+
+| Fact                          | Type | Description                          |
+|:------------------------------|:-----|:-------------------------------------|
+| `wfbcli.rx.packets.all`       | uint | Number of packets received           |
+| `wfbcli.rx.packets.all_bytes` | uint | Number of bytes received             |
+| `wfbcli.rx.packets.dec_err`   | uint | Number of packets lost               |
+| `wfbcli.rx.packets.dec_ok`    | uint | Number of good packets               |
+| `wfbcli.rx.packets.fec_rec`   | uint | Number of packets recovered with FEC |
+
+Receiving per-antenna statistics (each fact has "id" - channel name and "ant_id" - antenna number tags)
+| Fact                           | Type   | Description                                     |
+|:-------------------------------|:-------|:------------------------------------------------|
+| `wfbcli.rx.ant_stats.freq`     | uint   | Antenna frequency, MHz, eg 5800                 |
+| `wfbcli.rx.ant_stats.mcs`      | uint   | MCS value for this antenna                      |
+| `wfbcli.rx.ant_stats.bw`       | uint   | Bandwidth value for antenna (MHz)               |
+| `wfbcli.rx.ant_stats.pkt_recv` | uint   | Number of WiFi packets received by this antenna |
+| `wfbcli.rx.ant_stats.rssi_avg` | int    | Average RSSI for this antenna                   |
+| `wfbcli.rx.ant_stats.snr_avg`  | double | Average SNR for this antenna                    |
+
+Transmitting packets stats (same tags as receiving packets):
+
+| Fact                               | Type | Description                              |
+|:-----------------------------------|:-----|:-----------------------------------------|
+| `wfbcli.tx.packets.injected`       | uint | Number of successfully injected packets  |
+| `wfbcli.tx.packets.injected_bytes` | uint | Number of successfully injected bytes    |
+| `wfbcli.tx.packets.dropped`        | uint | Number of dropped packets                |
+| `wfbcli.tx.packets.truncated`      | uint | Number of truncated (?) packets          |
+| `wfbcli.tx.packets.fec_timeouts`   | uint | ?                                        |
+| `wfbcli.tx.packets.incoming`       | uint | Even TX interface may receive, n packets |
+| `wfbcli.tx.packets.incoming_bytes` | uint | Even TX interface may receive, n bytes   |
+
+Transmitting per-antenna stats (same tags as receiving antennas):
+
+| Fact                           | Type | Description                                |
+|:-------------------------------|:-----|:-------------------------------------------|
+| `wfbcli.tx.ant_stats.pkt_sent` | uint | Number packets sent through this antenna   |
+| `wfbcli.tx.ant_stats.pkt_drop` | uint | Number packets dropped by this antenna     |
+| `wfbcli.tx.ant_stats.lat_avg`  | uint | Average injection latency for this antenna |
+
+#### Widgets
+
 Currently we have generic widgets and more ad-hoc specific ones. Generic widgets normally can be used
 to display any fact (as long as datatype matches):
 
@@ -171,6 +214,9 @@ Pixelpilot starts several threads:
 * MAVLINK_THREAD (if OSD and mavlink configured):
   reads mavlink packets from UDP, decodes and updates `osd_vars` (without any mutex).
   The loop yields on UDP read.
+* WFBCLI_THREAD (if OSD is enabled):
+  connects to the local WFB instance stats API, reads JSON stats messages and publishes OSD facts.
+  The loop yields on TCP read.
 * OSD_THREAD (if OSD is enabled):
   takes `drm_fd`, `output_list` and JSON config as thread parameters,
   receives Facts through mutex-with-timeout-protected `std::queue`, feeds Facts to widgets and
diff --git a/config_osd.json b/config_osd.json
@@ -304,32 +304,64 @@
             "name": "Dump raw facts to the scren (remove `--` from `type` to enable)",
             "type": "---DebugWidget",
             "x": 10,
-            "y": -100,
+            "y": -200,
             "facts": [
                 {
                     "name": "mavlink.heartbeet.base_mode.armed"
                 },
                 {
-                    "name": "mavlink.radio_status.rssi",
+                    "name": "wfbcli.rx.packets.all",
                     "tags": {
-                        "sysid": "3",
-                        "compid": "68"
+                        "id": "video rx"
                     }
                 },
                 {
-                    "name": "mavlink.gps_raw.lat"
+                    "name": "wfbcli.rx.packets.lost",
+                    "tags": {
+                        "id": "video rx"
+                    }
                 },
                 {
-                    "name": "mavlink.gps_raw.lon"
+                    "name": "wfbcli.rx.ant_stats.freq",
+                    "tags": {
+                        "id": "video rx",
+                        "ant_id": "0"
+                    }
                 },
                 {
-                    "name": "mavlink.gps_raw.fix_type"
+                    "name": "wfbcli.rx.ant_stats.mcs",
+                    "tags": {
+                        "id": "video rx",
+                        "ant_id": "0"
+                    }
                 },
                 {
-                    "name": "mavlink.global_position_int.lat"
+                    "name": "wfbcli.rx.ant_stats.rssi_avg",
+                    "tags": {
+                        "id": "video rx",
+                        "ant_id": "0"
+                    }
+                },
+                {
+                    "name": "wfbcli.rx.ant_stats.freq",
+                    "tags": {
+                        "id": "video rx",
+                        "ant_id": "1"
+                    }
                 },
                 {
-                    "name": "mavlink.global_position_int.lon"
+                    "name": "wfbcli.rx.ant_stats.mcs",
+                    "tags": {
+                        "id": "video rx",
+                        "ant_id": "1"
+                    }
+                },
+                {
+                    "name": "wfbcli.rx.ant_stats.rssi_avg",
+                    "tags": {
+                        "id": "video rx",
+                        "ant_id": "1"
+                    }
                 }
             ]
         },
diff --git a/src/main.cpp b/src/main.cpp
@@ -46,6 +46,7 @@ extern "C" {
 
 #include "osd.h"
 #include "osd.hpp"
+#include "wfbcli.hpp"
 #include "dvr.h"
 #include "gstrtpreceiver.h"
 #include "scheduling_helper.hpp"
@@ -353,6 +354,7 @@ void sig_handler(int signum)
 	spdlog::info("Received signal {}", signum);
 	signal_flag++;
 	mavlink_thread_signal++;
+	wfb_thread_signal++;
 	osd_thread_signal++;
 	if (dvr != NULL) {
 		dvr->shutdown();
@@ -544,6 +546,7 @@ int main(int argc, char **argv)
 	bool dvr_filenames_with_sequence = false;
 	uint16_t listen_port = 5600;
 	uint16_t mavlink_port = 14550;
+	uint16_t wfb_port = 8103;
 	uint16_t mode_width = 0;
 	uint16_t mode_height = 0;
 	uint32_t mode_vrefresh = 0;
@@ -704,6 +707,11 @@ int main(int argc, char **argv)
 		continue;
 	}
 
+	__OnArgument("--wfb-api-port") {
+		wfb_port = atoi(__ArgValue);
+		continue;
+	}
+
 	__OnArgument("--version") {
 		printf("PixelPilot Rockchip %d.%d\n", APP_VERSION_MAJOR, APP_VERSION_MINOR);
 		return 0;
@@ -785,7 +793,7 @@ int main(int argc, char **argv)
 	ret = pthread_cond_init(&video_cond, NULL);
 	assert(!ret);
 
-	pthread_t tid_frame, tid_display, tid_osd, tid_mavlink, tid_dvr;
+	pthread_t tid_frame, tid_display, tid_osd, tid_mavlink, tid_dvr, tid_wfbcli;
 	if (dvr_template != NULL) {
 		dvr_thread_params args;
 		args.filename_template = dvr_template;
@@ -817,6 +825,11 @@ int main(int argc, char **argv)
 			ret = pthread_create(&tid_mavlink, NULL, __MAVLINK_THREAD__, &signal_flag);
 			assert(!ret);
 		}
+		wfb_thread_params *wfb_args = (wfb_thread_params *)malloc(sizeof *wfb_args);
+		wfb_args->port = wfb_port;
+		ret = pthread_create(&tid_wfbcli, NULL, __WFB_CLI_THREAD__, wfb_args);
+		assert(!ret);
+
 		osd_thread_params *args = (osd_thread_params *)malloc(sizeof *args);
         args->fd = drm_fd;
         args->out = output_list;
@@ -853,6 +866,8 @@ int main(int argc, char **argv)
 		assert(!ret);
 	}
 	if (enable_osd) {
+		ret = pthread_join(tid_wfbcli, NULL);
+		assert(!ret);
 		ret = pthread_join(tid_osd, NULL);
 		assert(!ret);
 	}
diff --git a/src/osd.cpp b/src/osd.cpp
@@ -1699,7 +1699,7 @@ void osd_add_double_fact(void *batch, char const *name, osd_tag *tags, int n_tag
 	facts->push_back(Fact(FactMeta(std::string(name), fact_tags), value));
 };
 
-void osd_add_str_fact(void *batch, char const *name, osd_tag *tags, int n_tags, char *value) {
+void osd_add_str_fact(void *batch, char const *name, osd_tag *tags, int n_tags, const char *value) {
 	std::vector<Fact> *facts = static_cast<std::vector<Fact> *>(batch);
 	FactTags fact_tags;
 	mk_tags(tags, n_tags, &fact_tags);
@@ -1733,7 +1733,7 @@ void osd_publish_double_fact(char const *name, osd_tag *tags, int n_tags, double
 	publish(Fact(FactMeta(std::string(name), fact_tags), value));
 };
 
-void osd_publish_str_fact(char const *name, osd_tag *tags, int n_tags, char *value) {
+void osd_publish_str_fact(char const *name, osd_tag *tags, int n_tags, const char *value) {
 	FactTags fact_tags;
 	mk_tags(tags, n_tags, &fact_tags);
 	publish(Fact(FactMeta(std::string(name), fact_tags), std::string(value)));
diff --git a/src/osd.h b/src/osd.h
@@ -93,14 +93,14 @@ void osd_add_bool_fact(void *batch, char const *name, osd_tag *tags, int n_tags,
 void osd_add_int_fact(void *batch, char const *name, osd_tag *tags, int n_tags, long value);
 void osd_add_uint_fact(void *batch, char const *name, osd_tag *tags, int n_tags, ulong value);
 void osd_add_double_fact(void *batch, char const *name, osd_tag *tags, int n_tags, double value);
-void osd_add_str_fact(void *batch, char const *name, osd_tag *tags, int n_tags, char *value);
+void osd_add_str_fact(void *batch, char const *name, osd_tag *tags, int n_tags, const char *value);
 
 // Publish individual facts
 void osd_publish_bool_fact(char const *name, osd_tag *tags, int n_tags, bool value);
 void osd_publish_int_fact(char const *name, osd_tag *tags, int n_tags, long value);
 void osd_publish_uint_fact(char const *name, osd_tag *tags, int n_tags, ulong value);
 void osd_publish_double_fact(char const *name, osd_tag *tags, int n_tags, double value);
-void osd_publish_str_fact(char const *name, osd_tag *tags, int n_tags, char *value);
+void osd_publish_str_fact(char const *name, osd_tag *tags, int n_tags, const char *value);
 #ifdef __cplusplus
 }
 #endif
diff --git a/src/wfbcli.cpp b/src/wfbcli.cpp
diff --git a/src/wfbcli.hpp b/src/wfbcli.hpp
