AP_DroneCAN: document CANS (Can Bus Statistics) log message

vincentpoont2 · Dec 15, 2024 · 4554dd2 · 4554dd2
1 parent 7c1cc26
commit 4554dd2
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/libraries/AP_DroneCAN/AP_DroneCAN.cpp b/libraries/AP_DroneCAN/AP_DroneCAN.cpp
@@ -1953,6 +1953,24 @@ void AP_DroneCAN::logging(void)
         return;
     }
     const auto &s = *stats;
+
+// @LoggerMessage: CANS
+// @Description: CAN Bus Statistics
+// @Field: TimeUS: Time since system startup
+// @Field: I: driver index
+// @Field: T: transmit success count
+// @Field: Trq: transmit request count
+// @Field: Trej: transmit reject count
+// @Field: Tov: transmit overflow count
+// @Field: Tto: transmit timeout count
+// @Field: Tab: transmit abort count
+// @Field: R: receive count
+// @Field: Rov: receive overflow count
+// @Field: Rer: receive error count
+// @Field: Bo: bus offset error count
+// @Field: Etx: ESC successful send count
+// @Field: Stx: Servo successful send count
+// @Field: Ftx: ESC/Servo failed-to-send count
     AP::logger().WriteStreaming("CANS",
                                 "TimeUS,I,T,Trq,Trej,Tov,Tto,Tab,R,Rov,Rer,Bo,Etx,Stx,Ftx",
                                 "s#-------------",