feat: (system_monitor) adding a node for CMOS battery monitoring

launch/tier4_system_launch/config/system_error_monitor/diagnostic_aggregator/system.param.yaml

@@ -171,3 +171,13 @@
                   path: tasks_summary
                   contains: [": Tasks Summary"]
                   timeout: 3.0
+
+            hardware:
+              type: diagnostic_aggregator/AnalyzerGroup
+              path: voltage
+              analyzers:
+                cmos_battery:
+                  type: diagnostic_aggregator/GenericAnalyzer
+                  path: cmos_battery
+                  contains: [": CMOS Battery Status"]
+                  timeout: 3.0

launch/tier4_system_launch/config/system_monitor/voltage_monitor.param.yaml

@@ -0,0 +1,5 @@
+/**:
+  ros__parameters:
+    cmos_battery_warn: 2.90
+    cmos_battery_error: 2.70
+    cmos_battery_label: ""

system/system_error_monitor/config/diagnostic_aggregator/system.param.yaml

@@ -225,3 +225,13 @@
                   path: tasks_summary
                   contains: [": Tasks Summary"]
                   timeout: 3.0
+
+            hardware:
+              type: diagnostic_aggregator/AnalyzerGroup
+              path: voltage
+              analyzers:
+                cmos_battery:
+                  type: diagnostic_aggregator/GenericAnalyzer
+                  path: cmos_battery
+                  contains: [": CMOS Battery Status"]
+                  timeout: 3.0

system/system_monitor/CMakeLists.txt

@@ -105,6 +105,10 @@ ament_auto_add_library(gpu_monitor_lib SHARED
   ${GPU_MONITOR_SOURCE}
 )
 
+ament_auto_add_library(voltage_monitor_lib SHARED
+  src/voltage_monitor/voltage_monitor.cpp
+)
+
 ament_auto_add_executable(msr_reader
   reader/msr_reader/msr_reader.cpp
 )
@@ -129,6 +133,7 @@ find_package(Boost REQUIRED COMPONENTS
 )
 
 ## Specify libraries to link a library or executable target against
+target_link_libraries(voltage_monitor_lib ${Boost_LIBRARIES} ${LIBRARIES})
 target_link_libraries(cpu_monitor_lib ${Boost_LIBRARIES} ${LIBRARIES})
 target_link_libraries(hdd_monitor_lib ${Boost_LIBRARIES} ${LIBRARIES})
 target_link_libraries(mem_monitor_lib ${LIBRARIES})
@@ -175,6 +180,11 @@ rclcpp_components_register_node(gpu_monitor_lib
   EXECUTABLE gpu_monitor
 )
 
+rclcpp_components_register_node(voltage_monitor_lib
+  PLUGIN "VoltageMonitor"
+  EXECUTABLE voltage_monitor
+)
+
 # TODO(yunus.caliskan): Port the tests to ROS2, robustify the tests.
 if(BUILD_TESTING)
   # ament_add_ros_isolated_gtest(test_cpu_monitor

system/system_monitor/README.md

@@ -13,6 +13,7 @@ This package provides the following nodes for monitoring system:
 - NTP Monitor
 - Process Monitor
 - GPU Monitor
+- Voltage Monitor
 
 ### Supported architecture
 
@@ -50,6 +51,7 @@ Every topic is published in 1 minute interval.
 - [NTP Monitor](docs/topics_ntp_monitor.md)
 - [Process Monitor](docs/topics_process_monitor.md)
 - [GPU Monitor](docs/topics_gpu_monitor.md)
+- [Voltage Monitor](docs/topics_voltage_monitor.md)
 
 [Usage] ✓：Supported, -：Not supported
 
@@ -83,6 +85,7 @@ Every topic is published in 1 minute interval.
 |                 | GPU Memory Usage             |   ✓   |      -       |      -       |                                                                                                                                                                                                 |
 |                 | GPU Thermal Throttling       |   ✓   |      -       |      -       |                                                                                                                                                                                                 |
 |                 | GPU Frequency                |   ✓   |      ✓       |      -       | For Intel platform, monitor whether current GPU clock is supported by the GPU.                                                                                                                  |
+| Voltage Monitor | CMOS Battery Staus           |   ✓   |      -       |      -       | Battery Health for RTC and BIOS -                                                                                                                                                               |
 
 ## ROS parameters
 
@@ -183,6 +186,85 @@ Currently GPU monitor for intel platform only supports NVIDIA GPU whose informat
 Also you need to install CUDA libraries.
 For installation instructions for CUDA 10.0, see [NVIDIA CUDA Installation Guide for Linux](https://docs.nvidia.com/cuda/archive/10.0/cuda-installation-guide-linux/index.html).
 
+## <u>Voltage monitor for CMOS Battery</u>
+
+Some platforms have built-in batteries for the RTC and CMOS. This node determines the battery status from the result of executing cat /proc/driver/rtc.
+Also, if lm-sensors is installed, it is possible to use the results.
+However, the return value of sensors varies depending on the chipset, so it is necessary to set a string to extract the corresponding voltage.
+It is also necessary to set the voltage for warning and error.
+For example, if you want a warning when the voltage is less than 2.9V and an error when it is less than 2.7V.
+The execution result of sensors on the chipset nct6106 is as follows, and "in7:" is the voltage of the CMOS battery.
+
+```txt
+$ sensors
+pch_cannonlake-virtual-0
+Adapter: Virtual device
+temp1:        +42.0°C
+
+nct6106-isa-0a10
+Adapter: ISA adapter
+in0:           728.00 mV (min =  +0.00 V, max =  +1.74 V)
+in1:             1.01 V  (min =  +0.00 V, max =  +2.04 V)
+in2:             3.34 V  (min =  +0.00 V, max =  +4.08 V)
+in3:             3.34 V  (min =  +0.00 V, max =  +4.08 V)
+in4:             1.07 V  (min =  +0.00 V, max =  +2.04 V)
+in5:             1.05 V  (min =  +0.00 V, max =  +2.04 V)
+in6:             1.67 V  (min =  +0.00 V, max =  +2.04 V)
+in7:             3.06 V  (min =  +0.00 V, max =  +4.08 V)
+in8:             2.10 V  (min =  +0.00 V, max =  +4.08 V)
+fan1:          2789 RPM  (min =    0 RPM)
+fan2:             0 RPM  (min =    0 RPM)
+```
+
+The setting value of voltage_monitor.param.yaml is as follows.
+
+```yaml
+/**:
+  ros__parameters:
+    cmos_battery_warn: 2.90
+    cmos_battery_error: 2.70
+    cmos_battery_label: "in7:"
+```
+
+The above values of 2.7V and 2.90V are hypothetical. Depending on the motherboard and chipset, the value may vary. However, if the voltage of the lithium battery drops below 2.7V, it is recommended to replace it.
+In the above example, the message output to the topic /diagnostics is as follows.
+If the voltage < 2.9V then:
+
+```txt
+  name: /autoware/system/resource_monitoring/voltage/cmos_battery
+  message: Warning
+  hardware_id: ''
+  values:
+  - key: 'voltage_monitor: CMOS Battery Status'
+    value: Low Battery
+```
+
+If the voltage < 2.7V then:
+
+```txt
+  name: /autoware/system/resource_monitoring/voltage/cmos_battery
+  message: Warning
+  hardware_id: ''
+  values:
+  - key: 'voltage_monitor: CMOS Battery Status'
+    value: Battery Died
+```
+
+If neither, then:
+
+```txt
+  name: /autoware/system/resource_monitoring/voltage/cmos_battery
+  message: OK
+  hardware_id: ''
+  values:
+  - key: 'voltage_monitor: CMOS Battery Status'
+    value: OK
+```
+
+If the CMOS battery voltage drops less than voltage_error or voltage_warn,It will be a warning.
+If the battery runs out, the RTC will stop working when the power is turned off. However, since the vehicle can run, it is not an error. The vehicle will stop when an error occurs, but there is no need to stop immediately.
+It can be determined by the value of "Low Battery" or "Battery Died".
+
 ## UML diagrams
 
 See [Class diagrams](docs/class_diagrams.md).

system/system_monitor/config/voltage_monitor.param.yaml

@@ -0,0 +1,5 @@
+/**:
+  ros__parameters:
+    cmos_battery_warn: 2.90
+    cmos_battery_error: 2.70
+    cmos_battery_label: ""

system/system_monitor/docs/ros_parameters.md

@@ -100,3 +100,13 @@ gpu_monitor:
 | gpu_usage_error    | float | %(1e-2) |  1.00   | Generates error when GPU usage reaches a specified value or higher.          |
 | memory_usage_warn  | float | %(1e-2) |  0.90   | Generates warning when GPU memory usage reaches a specified value or higher. |
 | memory_usage_error | float | %(1e-2) |  1.00   | Generates error when GPU memory usage reaches a specified value or higher.   |
+
+## <u>Voltage Monitor</u>
+
+voltage_monitor:
+
+| Name               |  Type  | Unit | Default | Notes                                                                           |
+| :----------------- | :----: | :--: | :-----: | :------------------------------------------------------------------------------ |
+| cmos_battery_warn  | float  | volt |   2.9   | Generates warning when voltage of CMOS Battery is lower.                        |
+| cmos_battery_error | float  | volt |   2.7   | Generates error when voltage of CMOS Battery is lower.                          |
+| cmos_battery_label | string | n/a  |   ""    | voltage string in sensors command outputs. if emtpy no voltage will be checked. |

system/system_monitor/docs/topics_voltage_monitor.md

@@ -0,0 +1,42 @@
+# ROS topics: Voltage Monitor
+
+"CMOS Battery Status" and "CMOS battey voltage" are exclusive.
+Only one or the other is generated.
+Which one is generated depends on the value of cmos_battery_label.
+
+## <u>CMOS Battery Status</u>
+
+/diagnostics/voltage_monitor: CMOS Battery Status
+
+<b>[summary]</b>
+
+| level | message      |
+| ----- | ------------ |
+| OK    | OK           |
+| WARN  | Battery Dead |
+
+<b>[values]</b>
+
+| key (example)      | value (example)   |
+| ------------------ | ----------------- |
+| CMOS battey status | OK / Battery Dead |
+
+\*key: thermal_zone[0-9] for ARM architecture.
+
+## <u>CMOS Battery Voltage</u>
+
+/diagnostics/voltage_monitor: CMOS battey voltage
+
+<b>[summary]</b>
+
+| level | message      |
+| ----- | ------------ |
+| OK    | OK           |
+| WARN  | Low Battery  |
+| WARN  | Battery Died |
+
+<b>[values]</b>
+
+| key                 | value (example) |
+| ------------------- | --------------- |
+| CMOS battey voltage | 3.06            |

system/system_monitor/include/system_monitor/voltage_monitor/voltage_monitor.hpp

@@ -0,0 +1,78 @@
+// Copyright 2022 Tier IV, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @file voltage_monitor.h
+ * @brief  voltage monitor class
+ */
+
+#ifndef SYSTEM_MONITOR__VOLTAGE_MONITOR__VOLTAGE_MONITOR_HPP_
+#define SYSTEM_MONITOR__VOLTAGE_MONITOR__VOLTAGE_MONITOR_HPP_
+
+#include <diagnostic_updater/diagnostic_updater.hpp>
+
+#include <climits>
+#include <regex>
+#include <string>
+<<<<<<< HEAD
+=======
+== == == =
+>>>>>>> 24d1e32bf92ddae1a1a7b5d93ae54ab99099bd8d
+>>>>>>> e9c848290a1c083b8c0d81b195b0398f5ce301d9
+
+  class VoltageMonitor : public rclcpp::Node
+{
+public:
+  /**
+   * @brief constructor
+   * @param [in] options Options associated with this node.
+   */
+  explicit VoltageMonitor(const rclcpp::NodeOptions & options);
+
+  /**
+   * @brief Update the diagnostic state.
+   */
+  void update();
+
+protected:
+  using DiagStatus = diagnostic_msgs::msg::DiagnosticStatus;
+
+  diagnostic_updater::Updater updater_;  //!< @brief Updater class which advertises to /diagnostics
+
+  char hostname_[HOST_NAME_MAX + 1];  //!< @brief host name
+
+  /**
+   * @brief check CMOS Battey
+   * @param [out] stat diagnostic message passed directly to diagnostic publish calls
+   * @note NOLINT syntax is needed since diagnostic_updater asks for a non-const reference
+   * to pass diagnostic message updated in this function to diagnostic publish calls.
+   */
+  void checkVoltage(
+    diagnostic_updater::DiagnosticStatusWrapper & stat);  // NOLINT(runtime/references)
+  /**
+   * @brief check CMOS Battey
+   * @param [out] stat diagnostic message passed directly to diagnostic publish calls
+   * @note NOLINT syntax is needed since diagnostic_updater asks for a non-const reference
+   * to pass diagnostic message updated in this function to diagnostic publish calls.
+   */
+  void checkBatteryStatus(
+    diagnostic_updater::DiagnosticStatusWrapper & stat);  // NOLINT(runtime/references)
+
+  float voltage_warn_;
+  float voltage_error_;
+  std::string voltage_string_;
+  std::regex voltage_regex_;
+};
+
+#endif  // SYSTEM_MONITOR__VOLTAGE_MONITOR__VOLTAGE_MONITOR_HPP_

system/system_monitor/launch/system_monitor.launch.py

@@ -96,6 +96,16 @@ def launch_setup(context, *args, **kwargs):
             gpu_monitor_config,
         ],
     )
+    with open(LaunchConfiguration("voltage_monitor_config_file").perform(context), "r") as f:
+        voltage_monitor_config = yaml.safe_load(f)["/**"]["ros__parameters"]
+    voltage_monitor = ComposableNode(
+        package="system_monitor",
+        plugin="VoltageMonitor",
+        name="voltage_monitor",
+        parameters=[
+            voltage_monitor_config,
+        ],
+    )
 
     # set container to run all required components in the same process
     container = ComposableNodeContainer(
@@ -111,6 +121,7 @@ def launch_setup(context, *args, **kwargs):
             ntp_monitor,
             process_monitor,
             gpu_monitor,
+            voltage_monitor,
         ],
         output="screen",
     )
@@ -151,6 +162,10 @@ def generate_launch_description():
                 "gpu_monitor_config_file",
                 default_value=os.path.join(system_monitor_path, "gpu_monitor.param.yaml"),
             ),
+            DeclareLaunchArgument(
+                "voltage_monitor_config_file",
+                default_value=os.path.join(system_monitor_path, "voltage_monitor.param.yaml"),
+            ),
             OpaqueFunction(function=launch_setup),
         ]
     )

system/system_monitor/launch/system_monitor.launch.xml

@@ -6,6 +6,7 @@
   <arg name="ntp_monitor_config_file" default="$(find-pkg-share system_monitor)/config/ntp_monitor.param.yaml"/>
   <arg name="process_monitor_config_file" default="$(find-pkg-share system_monitor)/config/process_monitor.param.yaml"/>
   <arg name="gpu_monitor_config_file" default="$(find-pkg-share system_monitor)/config/gpu_monitor.param.yaml"/>
+  <arg name="voltage_monitor_config_file" default="$(find-pkg-share system_monitor)/config/voltage_monitor.param.yaml"/>
 
   <group>
     <node pkg="system_monitor" exec="cpu_monitor" name="cpu_monitor" output="log" respawn="true">
@@ -29,5 +30,8 @@
     <node pkg="system_monitor" exec="gpu_monitor" name="gpu_monitor" output="log" respawn="true">
       <param from="$(var gpu_monitor_config_file)"/>
     </node>
+    <node pkg="system_monitor" exec="voltage_monitor" name="voltage_monitor" output="log" respawn="true">
+      <param from="$(var voltage_monitor_config_file)"/>
+    </node>
   </group>
 </launch>