Generated files

Author: denniszollo

c/include/libsbp/cpp/message_traits.h

@@ -1057,13 +1057,13 @@ struct MessageTraits<msg_linux_sys_state_t> {
 
 
 template<>
-struct MessageTraits<msg_linux_process_socket_counts_t> {
+struct MessageTraits<msg_proc_socket_counts_t> {
   static constexpr u16 id = 32515;
 };
 
 
 template<>
-struct MessageTraits<msg_linux_process_socket_queues_t> {
+struct MessageTraits<msg_proc_socket_queues_t> {
   static constexpr u16 id = 32516;
 };
 
@@ -1075,13 +1075,13 @@ struct MessageTraits<msg_linux_socket_usage_t> {
 
 
 template<>
-struct MessageTraits<msg_linux_process_fd_count_t> {
+struct MessageTraits<msg_proc_fd_count_t> {
   static constexpr u16 id = 32518;
 };
 
 
 template<>
-struct MessageTraits<msg_linux_process_fd_summary_t> {
+struct MessageTraits<msg_linux_fd_summary_t> {
   static constexpr u16 id = 32519;
 };
 
@@ -1140,24 +1140,6 @@ struct MessageTraits<msg_soln_meta_t> {
 };
 
 
-template<>
-struct MessageTraits<gnss_input_type_t> {
-  static constexpr u16 id = 65511;
-};
-
-
-template<>
-struct MessageTraits<imu_input_type_t> {
-  static constexpr u16 id = 65512;
-};
-
-
-template<>
-struct MessageTraits<odo_input_type_t> {
-  static constexpr u16 id = 65513;
-};
-
-
 template<>
 struct MessageTraits<msg_heartbeat_t> {
   static constexpr u16 id = 65535;

c/include/libsbp/linux.h

@@ -33,7 +33,7 @@ SBP_PACK_START
  * This message indicates the process state of the top 10 heaviest
  * consumers of CPU on the system.
  */
-#define SBP_MSG_LINUX_CPU_STATE             0x7F00
+#define SBP_MSG_LINUX_CPU_STATE    0x7F00
 typedef struct SBP_ATTR_PACKED {
   u8 index;      /**< sequence of this status message, values from 0-9 */
   u16 pid;        /**< the PID of the process */
@@ -43,12 +43,12 @@ typedef struct SBP_ATTR_PACKED {
 } msg_linux_cpu_state_t;
 
 
-/** List CPU state on the system
+/** List CPU state on the linux system
  *
  * This message indicates the process state of the top 10 heaviest
  * consumers of memory on the system.
  */
-#define SBP_MSG_LINUX_MEM_STATE             0x7F01
+#define SBP_MSG_LINUX_MEM_STATE    0x7F01
 typedef struct SBP_ATTR_PACKED {
   u8 index;      /**< sequence of this status message, values from 0-9 */
   u16 pid;        /**< the PID of the process */
@@ -62,7 +62,7 @@ typedef struct SBP_ATTR_PACKED {
  *
  * This presents a summary of CPU and memory utilization.
  */
-#define SBP_MSG_LINUX_SYS_STATE             0x7F02
+#define SBP_MSG_LINUX_SYS_STATE    0x7F02
 typedef struct SBP_ATTR_PACKED {
   u16 mem_total;         /**< total system memory */
   u8 pcpu;              /**< percent of total cpu currently utilized */
@@ -73,11 +73,11 @@ typedef struct SBP_ATTR_PACKED {
 } msg_linux_sys_state_t;
 
 
-/** A list of processes with high socket counts
+/** A list of linux processes with high socket counts
  *
  * Top 10 list of processes with high socket counts.
  */
-#define SBP_MSG_LINUX_PROCESS_SOCKET_COUNTS 0x7F03
+#define SBP_MSG_PROC_SOCKET_COUNTS 0x7F03
 typedef struct SBP_ATTR_PACKED {
   u8 index;            /**< sequence of this status message, values from 0-9 */
   u16 pid;              /**< the PID of the process in question */
@@ -93,14 +93,14 @@ typedef struct SBP_ATTR_PACKED {
   and 0x8000 (unknown)
  */
   char cmdline[0];       /**< the command line of the process in question */
-} msg_linux_process_socket_counts_t;
+} msg_proc_socket_counts_t;
 
 
-/** A list of processes with deep socket queues
+/** A list of linux processes with deep socket queues
  *
  * Top 10 list of sockets with deep queues.
  */
-#define SBP_MSG_LINUX_PROCESS_SOCKET_QUEUES 0x7F04
+#define SBP_MSG_PROC_SOCKET_QUEUES 0x7F04
 typedef struct SBP_ATTR_PACKED {
   u8 index;                 /**< sequence of this status message, values from 0-9 */
   u16 pid;                   /**< the PID of the process in question */
@@ -120,14 +120,14 @@ typedef struct SBP_ATTR_PACKED {
 of the connection.
  */
   char cmdline[0];            /**< the command line of the process in question */
-} msg_linux_process_socket_queues_t;
+} msg_proc_socket_queues_t;
 
 
-/** Summary of socket usage across the system
+/** Summary of socket usage across the linux system
  *
  * Summaries the socket usage across the system.
  */
-#define SBP_MSG_LINUX_SOCKET_USAGE          0x7F05
+#define SBP_MSG_LINUX_SOCKET_USAGE 0x7F05
 typedef struct SBP_ATTR_PACKED {
   u32 avg_queue_depth;        /**< average socket queue depths across all sockets on the system */
   u32 max_queue_depth;        /**< the max queue depth seen within the reporting period */
@@ -140,32 +140,32 @@ the first entry corresponds to the first enabled bit in `types_reported`.
 } msg_linux_socket_usage_t;
 
 
-/** Summary of processes with large amounts of open file descriptors
+/** Summary of linux processes with large amounts of open file descriptors
  *
  * Top 10 list of processes with a large number of open file descriptors.
  */
-#define SBP_MSG_LINUX_PROCESS_FD_COUNT      0x7F06
+#define SBP_MSG_PROC_FD_COUNT      0x7F06
 typedef struct SBP_ATTR_PACKED {
   u8 index;       /**< sequence of this status message, values from 0-9 */
   u16 pid;         /**< the PID of the process in question */
   u16 fd_count;    /**< a count of the number of file descriptors opened by the process */
   char cmdline[0];  /**< the command line of the process in question */
-} msg_linux_process_fd_count_t;
+} msg_proc_fd_count_t;
 
 
-/** Summary of open file descriptors on the system
+/** Summary of open file descriptors on the linux system
  *
  * Summary of open file descriptors on the system.
  */
-#define SBP_MSG_LINUX_PROCESS_FD_SUMMARY    0x7F07
+#define SBP_MSG_LINUX_FD_SUMMARY   0x7F07
 typedef struct SBP_ATTR_PACKED {
   u32 sys_fd_count;    /**< count of total FDs open on the system */
   char most_opened[0];  /**< A null delimited list of strings which alternates between
 a string representation of the process count and the file
 name whose count it being reported.  That is, in C string
 syntax "32\0/var/log/syslog\012\0/tmp/foo\0" with the end
 of the list being 2 NULL terminators in a row. */
-} msg_linux_process_fd_summary_t;
+} msg_linux_fd_summary_t;
 
 
 /** \} */

c/include/libsbp/solution_meta.h

@@ -55,46 +55,40 @@ typedef struct SBP_ATTR_PACKED {
   u16 vdop;                      /**< Vertical Dilution of Precision, as per last available DOPS from Starling GNSS engine [0.01] */
   u8 n_sats;                    /**< Number of satellites, as per last available solution from Starling GNSS engine */
   u16 age_corrections;           /**< Age of the corrections (0xFFFF indicates invalid), as per last available AGE_CORRECTIONS from Starling GNSS engine [deciseconds] */
-  u8 alignment_status;          /**< Bits for reason why it cannot align (yet) */
+  u8 alignment_status;          /**< State of alignment and the status and receipt of the alignment inputs */
   u32 last_used_gnss_pos_tow;    /**< Tow of last-used GNSS position measurement [ms] */
   u32 last_used_gnss_vel_tow;    /**< Tow of last-used GNSS velocity measurement [ms] */
   solution_input_type_t sol_in[0];                 /**< Array of Metadata describing the sensors potentially involved in the solution. Each element in the array represents a single sensor type and consists of flags containing (meta)data pertaining to that specific single sensor. Refer to each (XX)InputType descriptor in the present doc. */
 } msg_soln_meta_t;
 
 
-/** Flags for a given GNSS sensor used as input for the fuzed solution.
+/** Instruments the physical type of GNSS sensor input to the fuzed solution.
  *
- * Metadata around the GNSS sensors involved in the fuzed solution. Accessible through sol_in[N].flags
- *                                                                         in a MSG_SOLN_META.
- * Note: Just to build descriptive tables in documentation and not actually used.
+ * Metadata around the GNSS sensors involved in the fuzed solution.
+ * Accessible through sol_in[N].flags in a MSG_SOLN_META.
  */
-#define SBP_GNSSInputType 0xFFE7
 typedef struct SBP_ATTR_PACKED {
   u8 flags;    /**< flags that store all relevant info specific to this sensor type. */
 } gnss_input_type_t;
 
 
-/** Flags for a given IMU sensor used as input for the fuzed solution.
+/** Provides detail about the IMU sensor, its timestamping mode, and its quality for input to the fuzed solution.
  *
- * Metadata around the IMU sensors involved in the fuzed solution. Accessible through sol_in[N].flags
- *                                                                        in a MSG_SOLN_META.
- * Note: Just to build descriptive tables in documentation and not actually used.
+ * Metadata around the IMU sensors involved in the fuzed solution.
+ * Accessible through sol_in[N].flags in a MSG_SOLN_META.
  */
-#define SBP_IMUInputType  0xFFE8
 typedef struct SBP_ATTR_PACKED {
-  u8 flags;    /**< flags that store all relevant info specific to this sensor type. */
+  u8 flags;    /**< Instrument time, grade, and architecture for a sensor. */
 } imu_input_type_t;
 
 
-/** Flags for a given Odometry sensor used as input for the fuzed solution.
+/** Provides detail about the Odometry sensor, its timestamping mode, and its quality for input to the fuzed solution.
  *
- * Metadata around the Odometry sensors involved in the fuzed solution. Accessible through sol_in[N].flags
- *                                                                             in a MSG_SOLN_META.
- * Note: Just to build descriptive tables in documentation and not actually used.
+ * Metadata around the Odometry sensors involved in the fuzed solution.
+ * Accessible through sol_in[N].flags in a MSG_SOLN_META.
  */
-#define SBP_OdoInputType  0xFFE9
 typedef struct SBP_ATTR_PACKED {
-  u8 flags;    /**< flags that store all relevant info specific to this sensor type. */
+  u8 flags;    /**< Instrument ODO rate, grade, and quality. */
 } odo_input_type_t;