diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 8a5f993..3ca72b9 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "name": "ROS2 ros2_diag_tree Development", + "name": "ROS2 ros2_medkit Development", "build": { "dockerfile": "Dockerfile", "context": "..", diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 3cf85dc..6eaf013 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -24,7 +24,7 @@ What you expected to happen. What actually happened, including any error messages or stack traces. ### Environment -- ros2_diag_tree version: +- ros2_medkit version: - ROS 2 distro: - OS: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c8c0462..6ac3f74 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ # Pull Request - + ## Description diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9e2457..ec8a11d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,24 @@ -# Contributing to ros2_diag_tree +# Contributing to ros2_medkit -Thanks for your interest in contributing to ros2_diag_tree! This guide explains how to report issues, suggest features, and contribute code. +Thanks for your interest in contributing to ros2_medkit! This guide explains how to report issues, suggest features, and contribute code. ## How to Report Issues ### Did you find a bug? -- **Ensure the bug was not already reported** by searching [Issues](https://github.com/bburda/ros2_diag_tree/issues) -- If you can't find an existing issue, [open a new one](https://github.com/bburda/ros2_diag_tree/issues/new/choose) and select the **Bug report** template +- **Ensure the bug was not already reported** by searching [Issues](https://github.com/bburda/ros2_medkit/issues) +- If you can't find an existing issue, [open a new one](https://github.com/bburda/ros2_medkit/issues/new/choose) and select the **Bug report** template - Fill in all sections of the template: - **Steps to reproduce** - numbered steps to recreate the issue - **Expected behavior** - what you expected to happen - **Actual behavior** - what actually happened, including error messages or stack traces - - **Environment** - ros2_diag_tree version, ROS 2 distro, OS + - **Environment** - ros2_medkit version, ROS 2 distro, OS - **Additional information** - logs, snippets, or screenshots if helpful ### Do you want to suggest a feature or improvement? -- Check if the feature has already been suggested in [Issues](https://github.com/bburda/ros2_diag_tree/issues) -- If not, [open a new issue](https://github.com/bburda/ros2_diag_tree/issues/new/choose) and select the **Feature request / General issue** template +- Check if the feature has already been suggested in [Issues](https://github.com/bburda/ros2_medkit/issues) +- If not, [open a new issue](https://github.com/bburda/ros2_medkit/issues/new/choose) and select the **Feature request / General issue** template - Fill in all sections: - **Proposal** - describe the change or feature you'd like to see - **Motivation** - why is this important? Who does it benefit? @@ -103,18 +103,18 @@ Before submitting your PR, ensure: ## Questions and Help -- For questions about **using ros2_diag_tree**, open a [Discussion](https://github.com/bburda/ros2_diag_tree/discussions) or an Issue with the question label +- For questions about **using ros2_medkit**, open a [Discussion](https://github.com/bburda/ros2_medkit/discussions) or an Issue with the question label - For questions about **contributing**, feel free to ask in your PR or Issue - For **security vulnerabilities**, see [`SECURITY.md`](SECURITY.md) ## Code of Conduct -By contributing to ros2_diag_tree, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and considerate in all interactions. +By contributing to ros2_medkit, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and considerate in all interactions. ## License -By contributing to ros2_diag_tree, you agree that your contributions will be licensed under the Apache License 2.0. +By contributing to ros2_medkit, you agree that your contributions will be licensed under the Apache License 2.0. --- -Thank you for improving ros2_diag_tree! We value contributions of all sizes - from typo fixes to major features. 🚀 +Thank you for improving ros2_medkit! We value contributions of all sizes - from typo fixes to major features. 🚀 diff --git a/README.md b/README.md index 5dee1db..ac9837a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# ros2_diag_tree +# ros2_medkit -[![CI](https://github.com/bburda/ros2_diag_tree/actions/workflows/ci.yml/badge.svg)](https://github.com/bburda/ros2_diag_tree/actions/workflows/ci.yml) +[![CI](https://github.com/bburda/ros2_medkit/actions/workflows/ci.yml/badge.svg)](https://github.com/bburda/ros2_medkit/actions/workflows/ci.yml) Modern, SOVD-compatible diagnostics for ROS 2 robots, built around an entity tree (Area / Component / Function / App) for runtime discovery, health modeling, and troubleshooting. -## What is ros2_diag_tree? +## What is ros2_medkit? -ros2_diag_tree is an experiment in **modern diagnostics for ROS 2–based systems**. +ros2_medkit is an experiment in **modern diagnostics for ROS 2–based systems**. -Instead of hardcoding knowledge about every node, topic, or ECU, ros2_diag_tree models a robot +Instead of hardcoding knowledge about every node, topic, or ECU, ros2_medkit models a robot as a **diagnostic entity tree**: - **Area** – physical or logical domain (e.g. `base`, `arm`, `safety`, `navigation`) diff --git a/SECURITY.md b/SECURITY.md index 5ea15f8..73a737a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -11,7 +11,7 @@ Security vulnerabilities are taken seriously. I appreciate your efforts to respo Instead, please report them using one of the following methods: 1. **Preferred: GitHub Security Advisories** (recommended) - - Go to the [Security tab](https://github.com/bburda/ros2_diag_tree/security/advisories/new) of this repository + - Go to the [Security tab](https://github.com/bburda/ros2_medkit/security/advisories/new) of this repository - Click "Report a vulnerability" - Fill out the form with details about the vulnerability @@ -51,19 +51,19 @@ Please allow reasonable time to investigate and address the vulnerability before | ------- | ------------------ | | main | :white_check_mark: | -**Note:** As ros2_diag_tree is currently in early development, security updates will be applied to the `main` branch. Once stable releases are available, this section will be updated with specific version support information. +**Note:** As ros2_medkit is currently in early development, security updates will be applied to the `main` branch. Once stable releases are available, this section will be updated with specific version support information. ## Security Best Practices -When using ros2_diag_tree in your ROS 2 system: +When using ros2_medkit in your ROS 2 system: -- Keep your ROS 2 distribution and ros2_diag_tree up to date +- Keep your ROS 2 distribution and ros2_medkit up to date - Follow ROS 2 security best practices - Properly configure access controls for diagnostic data - Review and audit diagnostic configurations regularly ## Questions? -If you have questions about this security policy or the security of ros2_diag_tree, please open an issue in the repository. +If you have questions about this security policy or the security of ros2_medkit, please open an issue in the repository. -Thank you for helping keep ros2_diag_tree and its users safe! +Thank you for helping keep ros2_medkit and its users safe! diff --git a/src/ros2_diag_tree_gateway/CMakeLists.txt b/src/ros2_medkit_gateway/CMakeLists.txt similarity index 97% rename from src/ros2_diag_tree_gateway/CMakeLists.txt rename to src/ros2_medkit_gateway/CMakeLists.txt index e96f50f..3eb8c6b 100644 --- a/src/ros2_diag_tree_gateway/CMakeLists.txt +++ b/src/ros2_medkit_gateway/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.8) -project(ros2_diag_tree_gateway) +project(ros2_medkit_gateway) if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") add_compile_options(-Wall -Wextra -Wpedantic) diff --git a/src/ros2_diag_tree_gateway/README.md b/src/ros2_medkit_gateway/README.md similarity index 70% rename from src/ros2_diag_tree_gateway/README.md rename to src/ros2_medkit_gateway/README.md index d3890b2..af4a86d 100644 --- a/src/ros2_diag_tree_gateway/README.md +++ b/src/ros2_medkit_gateway/README.md @@ -1,6 +1,6 @@ -# ros2_diag_tree_gateway +# ros2_medkit_gateway -HTTP gateway node for the ros2_diag_tree diagnostics system. +HTTP gateway node for the ros2_medkit diagnostics system. ## Overview @@ -14,13 +14,13 @@ This package provides an HTTP server that exposes diagnostic information from th ## Building ```bash -colcon build --packages-select ros2_diag_tree_gateway +colcon build --packages-select ros2_medkit_gateway ``` ## Running ```bash -ros2 run ros2_diag_tree_gateway gateway_node +ros2 run ros2_medkit_gateway gateway_node ``` ### Parameters @@ -31,7 +31,7 @@ ros2 run ros2_diag_tree_gateway gateway_node ### Example with custom port ```bash -ros2 run ros2_diag_tree_gateway gateway_node --ros-args -p port:=9090 +ros2 run ros2_medkit_gateway gateway_node --ros-args -p port:=9090 ``` ## Dependencies diff --git a/src/ros2_diag_tree_gateway/package.xml b/src/ros2_medkit_gateway/package.xml similarity index 85% rename from src/ros2_diag_tree_gateway/package.xml rename to src/ros2_medkit_gateway/package.xml index 7415f42..49cd6c2 100644 --- a/src/ros2_diag_tree_gateway/package.xml +++ b/src/ros2_medkit_gateway/package.xml @@ -1,9 +1,9 @@ - ros2_diag_tree_gateway + ros2_medkit_gateway 0.1.0 - HTTP gateway for ros2_diag_tree diagnostics system + HTTP gateway for ros2_medkit diagnostics system bburda Apache-2.0 diff --git a/src/ros2_diag_tree_gateway/src/gateway_node.cpp b/src/ros2_medkit_gateway/src/gateway_node.cpp similarity index 98% rename from src/ros2_diag_tree_gateway/src/gateway_node.cpp rename to src/ros2_medkit_gateway/src/gateway_node.cpp index 76bdafe..906b454 100644 --- a/src/ros2_diag_tree_gateway/src/gateway_node.cpp +++ b/src/ros2_medkit_gateway/src/gateway_node.cpp @@ -78,7 +78,7 @@ class GatewayNode : public rclcpp::Node { (void)req; // Unused parameter nlohmann::json info_json = { - {"service", "ros2_diag_tree_gateway"}, + {"service", "ros2_medkit_gateway"}, {"version", VERSION}, {"endpoints", nlohmann::json::array({"/health", "/"})}}; diff --git a/src/ros2_diag_tree_gateway/test/test_gateway_node.cpp b/src/ros2_medkit_gateway/test/test_gateway_node.cpp similarity index 97% rename from src/ros2_diag_tree_gateway/test/test_gateway_node.cpp rename to src/ros2_medkit_gateway/test/test_gateway_node.cpp index bee429e..c185d0f 100644 --- a/src/ros2_diag_tree_gateway/test/test_gateway_node.cpp +++ b/src/ros2_medkit_gateway/test/test_gateway_node.cpp @@ -92,7 +92,7 @@ class GatewayNode : public rclcpp::Node { (void)req; nlohmann::json info_json = { - {"service", "ros2_diag_tree_gateway"}, + {"service", "ros2_medkit_gateway"}, {"version", VERSION}, {"endpoints", nlohmann::json::array({"/health", "/"})}}; @@ -153,7 +153,7 @@ TEST_F(TestGatewayNode, test_root_endpoint) { // Parse and verify JSON auto json_response = nlohmann::json::parse(res->body); - EXPECT_EQ(json_response["service"], "ros2_diag_tree_gateway"); + EXPECT_EQ(json_response["service"], "ros2_medkit_gateway"); EXPECT_EQ(json_response["version"], "0.1.0"); EXPECT_TRUE(json_response.contains("endpoints")); EXPECT_TRUE(json_response["endpoints"].is_array());