Changelog

CARET

v0.4.16.1 _ Sep 21, 2023

• Fix: Fixed an issue that prevented CARETmeasurement when using cyclonedds 0.10.x. (caret #121)
• New: Added API to plot the response time of Paths as timeseries. (CARET_analyze #322)
• Changed to temporarily specify the version of setuptools to be installed, as the latest setuptools causes error during CARET building. (CARET_analyze #330)

v0.4.15 _ Sep 4, 2023

• Updated the version of humble branch in tier4/rclcpp repository, which is forked from ros2/rclcpp, from 16.0.1 to 16.0.5. (rclcpp #4)
• Refactored and added APIs to calculate response time, these are a preparation to add options for visualizing graph in the future update. (CARET_analyze #310), (CARET_analyze #313), (CARET_analyze #319)
• Fixed typo in CMakeLists.txt. (CARET_analyze_cpp_impl #131)
• Specified Pandas library version as '<2.1.0' to avoid problems with the Pandas library 2.1.0. (CARET_analyze #324)
• Fixed to force loading process to ignore the second and subsequent callbacks even if "Duplicated callback id" occurs during CARET analyzing. (CARET_analyze #314)

v0.4.14 _ Aug 21, 2023

• Supported for function argument changes in ros/ros2_tracing. This support is in preparation for functionality improvements that will make rebuilding of the measurement application unnecessary. (rclcpp #2), (ros2_tracing #5), (CARET_trace #136), (CARET_analyze #302), (CARET_doc #204)
  • This change affects trace data compatibility. However, this only affects cases where trace data captured after this update is analyzed by caret_analyze before this update. Please see the table below for the supported combinations.

	trace data (<=0.4.13)	trace data (>=v0.4.14)
CARET_analyze (<=v0.4.13)	Supported	Unsupported
CARET_analyze (>=v0.4.14)	Supported	Supported

• Adjusted Lttng buffer size to appropriate value. (ros2_tracing #6)
• Fixed a build error that occurred in environments older than Python 3.10. (ros2caret #81)

v0.4.13 _ Jul 24, 2023

• Fixed a bug that delayed starting a measurement after caret record is launched depending on the time elapsed after the application being measured was launched. (CARET_trace #129)

v0.4.12 _ Jul 10, 2023

• Fixed a bug in the Plot class API that could not create graphs correctly when the xaxis_type='sim_time' option was specified. (CARET_analyze #276), (CARET_analyze #306)
• Fixed a bug that caused incorrect warnings to be output when using ros2 caret check_ctf. (CARET_analyze #308)

v0.4.11 _ Jun 26, 2023

• Applied to the type hinting for generics in standard collections adopted from Python 3.9. (CARET_analyze #294), (CARET_analyze #299)
• Fixed a segmentation fault problem that occurred depending on the condition of the data analyzed by CARET_analyze. (CARET_analyze_cpp_impl #79)
• Added ros2 caret version command to get the CARET version. (ros2caret #69)

v0.4.10 _ Jun 12, 2023

• Update: Changed trace points used to tie records of inter-process communication. This change affects trace data compatibility. However, this only affects cases where trace data captured after this update is analyzed by caret_analyze before this update. In that case, update caret_analyze (CARET_analyze #296), (CARET_trace #113), (CARET_doc #191), (ros2caret #70)
  • Please see the table below for the supported combinations

	trace data (<=0.4.9)	trace data (>=v0.4.10)
CARET_analyze (<=v0.4.9)	Supported	Unsupported
CARET_analyze (>=v0.4.10)	Supported	Supported

• Added remove functions to modify intra-node data path: remove_variable_passing and remove_publisher_callback (CARET_analyze #297)

v0.4.9 _ May 15, 2023

• Update:Improved path analysis to analyze paths that contain the same symbol object (CARET_analyze #261), (CARET_doc #183)
• Improved Plot class not to plot on a graph when communication is not established (CARET_analyze #291), (CARET_doc #184)
• Removed old modules: node_graph and callback_graph (CARET_analyze #290)

v0.4.8 _ May 1, 2023

• Removed deprecated interface such as message_flow (CARET_analyze #179), (CARET_analyze #274), (CARET_analyze #282)
• Reduced warnings when loading trace data (CARET_analyze #284)

v0.4.7 _ Apr 17, 2023

• Refactored the Plot package design (CARET_analyze #267), (CARET_analyze #275), (CARET_analyze #277), (CARET_analyze #278), (CARET_analyze #279), (CARET_analyze #280)

v0.4.6 _ Apr 3, 2023

• New: Added function to visualize response time with the stacked bar graph(CARET_analyze #265, CARET_analyze #259, CARET_doc #169)
• Update: Added selective path definition to include or exclude first and last callback execution (CARET_analyze #263, CARET_analyze #271, CARET_analyze #272, CARET_analyze #273)
• Added a new function to get difference between two Architecture objects (CARET_analyze #245, CARET_doc #168)
• Removed deprecated interface such as callback_sched and Plot.create_*_plot (CARET_analyze #266)
• Refactored visualization API such as message_flow (CARET_analyze #267)

v0.4.5 _ Mar 20, 2023

• Enhanced the trace filtering to exclude selected DDS events (CARET_trace #101)
• Added the unit to the label of y-axis on time-series graph (CARET_analyze #256)
• Refactored the Plot package (CARET_analyze #257, CARET_analyze #258)
• Added the docstring for explaining rename methods for Architecture object (CARET_analyze #253)

v0.4.4 _ Feb 21, 2023

• Fixed the time format of the time-series graphs (CARET_analyze #255)
• Added the design documentation for trace filtering to exclude events in DDS-layer (CARET_doc #158)
• Moved get_range() function to record package (CARET_analyze #254)

v0.4.3 _ Feb 10, 2023

• Fixed the bug preventing check_ctf from running properly after supporting activation/deactivation on runtime (CARET_analyze #251)
• Suppressed update frequency of progress bar from tqdm when reading trace data (CARET_analyze #248)
• Fixed incorrect annotation from list to List (CARET_analyze #252)
• Changed setup_caret.bash script to prompt users to install the packages (caret #72)

v0.4.2 _ Jan 23, 2023

• Added lightweight recording option to ros2caret (ros2caret #63)
• Removed old interface of Plot.create_callback_jitter_plot (CARET_analyze #231)
• Refactored Plot.create_callback_scheduling_plot (CARET_analyze #240)
• Added new API to combine two paths found by Architecture.search_paths() (CARET_analyze #224)
• Fixed the bug in Records class (CARET_analyze #246)
• Applied minor refactoring (CARET_analyze #244, CARET_analyze #243, CARET_analyze #237, CARET_analyze #234)
• Suppressed warning message outputted during runtime recording (CARET_analyze #238, CARET_analyze #236)
• Added construction_order item to identify multiple callbacks which have common symbol (CARET_analyze #225)

v0.4.1 _ Dec 26, 2022

• New: Added functions to assign intra-node data path with message_context (CARET_analyze #196)
• Update: Changed design of visualization API for refactoring to avoid usage of Pandas (CARET_analyze #116, CARET_analyze #167, CARET_analyze #168, CARET_analyze #170)
• Added configure file to control log level to suppress warning message (CARET_analyze #220)
• Changed behavior of visualization to output empty graph if inputted data does not have any data rather than raising exception (CARET_analyze #223)
• Fixed ValueError, when create_publish_subscription_frequency_plot is called with being inputted empty object (CARET_analyze #227)
• Added metric name to tooltip for identifying plots on a graph

v0.4.0 _ Dec 16, 2022

• New: Added a new feature to start, stop, and resume even recording whenever users want to (CARET_trace #68, CARET_analyze #190, ros2caret #48, and CARET_doc #126)

v0.3.4 _ Dec 12, 2022

• New: Added functions to rename subsystems in Architecture object like executor, node, callback and topic (CARET_analyze#156)
• Suppressed warning messages, which are outputted because service event is not supported, during trace data loading (CARET_analyze#192)
• Fixed bug which calculated incorrect period or frequency (CARET_analyze#213)
• Fixed error messages from Mypy (CARET_analyze#211)

v0.3.3 _ Nov 28, 2022

• Added guidances for a beginner to avoid getting stuck in unexpected cases (CARET_analyze #200 and CARET_analyze #186)
• Added publishers and subscriptions properties to Architecture and Application classes (CARET_analyze #179, CARET_analyze #180)
• Added function to update cache file named as caret_converted (CARET_analyze#189)
• Suppressed unnecessary warnings in check_caret_rclcpp (ros2caret #53, ros2caret #54)
• Improved documentation of installation (CARET_doc #111), configuration (CARET_doc #112), visualization (CARET_doc #98), and design (CARET_doc#106)
• Fixed a bug which makes incorrect graphs (CARET_analyze #201)

v0.3.2 _ Nov 14, 2022

• Improved warning messages of CARET_analyze (CARET_analyze #144, CARET_analyze #158, CARET_analyze #162, CARET_analyze #172, CARET_analyze #182)
• Added properties of publishers and subscriptions to Application and Architecture object(CARET_analyze #179)
• Improved ros2caret(ros2caret #44, ros2caret #50)
• Enlarged buffer size(ros2_tracing #2)
• Added some minor changes (CARET_analyze #183, CARET_analyze #187)

v0.3.1 _ Oct 31, 2022

• Added record function to ros2caret for upcoming feature. (ros2caret #38)
• Added function to display histogram for response time (CARET_analyze #165)
• Added API to calculate period and latency (CARET_analyze #167, CARET_analyze #168)
• Fixed some bugs (CARET_analyze #141, CARET_analyze #153, CARET_analyze #157)
• Refactored Architecture object interface (CARET_analyze)
• Added some minor changes (CARET_analyze #139, CARET_analyze #146, CARET_analyze #147, CARET_analyze #151, CARET_analyze #159, CARET_analyze #162, CARET_analyze #165, CARET_analyze#171)

v0.3.0 _ Sept 26, 2022

• Supported OS: Ubuntu 22.04
• Supported ROS Dist.: ROS Humble
• Imported to Ubuntu 22.04 and ROS Humble
• Added new feature to show response time (CARET_analyze #96)
• Added new APIs to visualize frequency, period, and latency of publishes, subscriptions, and communications (CARET_analyze #124, #130, #133, #134, #136, #140)
• Reduced memory consumption wasted for recorded data (CARET_analyze #100)
• Launched CARET_analyze API document
• Added small fixes
  • CARET_analyze #107
  • CARET_analyze #107
  • CARET_analyze #108
  • CARET_analyze #109
  • CARET_analyze #112
  • CARET_analyze #115

v0.2.3 _ July 14, 2022

• Supported OS: Ubuntu 20.04
• Supported ROS Dist.: ROS Galactic
• Improved output message from path.verify() method
• Improved view of graphs
• Added wildcard support for Architecture.callbacks() method
• Added command line function to check trace data
• Fixed specification of Architecture.search_paths() method
• Added function to extract duplicated timer callback

v0.2.2 _ May 2, 2022

• Supported OS: Ubuntu 20.04
• Supported ROS Dist.: ROS Galactic
• Added feature to measure complicated node path
• Added feature to choose optional trace points
• Added Architecture.search_paths() method
• Improved trace filtering function