move pyratetest into example_module

Interpause · Dec 3, 2022 · afddbe8 · afddbe8
1 parent 1e94385
commit afddbe8
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 500 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "example_module"]
+	path = example_module
+	url = https://github.com/Interpause/ros-example-node.git
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ Template for ROS2 workspace using [VS Code Dev Containers](https://code.visualst
   - [Dev Container Lifecycle Hooks](#dev-container-lifecycle-hooks)
 - [Tips](#tips)
   - [`git` Submodules](#git-submodules)
+  - [`example_module`](#example_module)
   - [Update Package Indexes](#update-package-indexes)
   - [Minimize Changes to the Dockerfile](#minimize-changes-to-the-dockerfile)
   - [Change ROS Distro](#change-ros-distro)
@@ -137,6 +138,14 @@ git submodule foreach --recursive git checkout main
 
 This is done for you automatically if using a named volume to store the repository.
 
+### `example_module`
+
+`example_module`'s [README.md](./example_module/README.md) provides instructions on how to create a `git` submodule and add ROS packages to it. It also contains a simple pub-sub `launch` file that can be used to test bandwidth & latency. To remove `example_module`:
+
+```sh
+git rm example_module
+```
+
 ### Update Package Indexes
 
 The `rosdep` and Ubuntu package managers rely on a local cache of their package index. If the package index is outdated, it may not contain any active package distribution server, leading to package downloads failing. Hence, it is recommended to periodically re-download the package index:

diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -20,7 +20,7 @@ services:
 
     volumes:
       # (OPTION) Choose whether to use named volume to store repository.
-      # - .:/code:cached # Repository located on host is mounted into container.
+      - .:/code:cached # Repository located on host is mounted into container.
       # - code:/code # named volume used to store repository.
       # (OPTION) Mount point for `data` folder.
       # - ./data:/data:cached

diff --git a/example_module b/example_module
diff --git a/pyratetest/launch/test.launch.py b/pyratetest/launch/test.launch.py
diff --git a/pyratetest/package.xml b/pyratetest/package.xml
diff --git a/pyratetest/pyratetest/__init__.py b/pyratetest/pyratetest/__init__.py
diff --git a/pyratetest/pyratetest/job.py b/pyratetest/pyratetest/job.py
diff --git a/pyratetest/pyratetest/publish.py b/pyratetest/pyratetest/publish.py