Skip to content

Commit 652952b

Browse files
committed
Extended documentation, fixed links to system_modes repository
1 parent 474ea85 commit 652952b

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

system_modes/index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,41 +46,45 @@ The envisioned key elements to achieve this goal are:
4646

4747
## Requirements
4848

49-
The list of requirements is maintained in the doc folder of the micro-ROS system modes repository, at https://github.com/microROS/system_modes/system_modes/doc/requirements.md
49+
The list of requirements is maintained in the doc folder of the micro-ROS system modes repository, at: https://github.com/microROS/system_modes/blob/master/system_modes/doc/requirements.md
5050

5151

5252
## Background: ROS 2 Lifecycle
5353

54-
Our approach is based on the ROS 2 Lifecycle. The primary goal of the ROS 2 lifecycle is TODO INSERT TEXT.
54+
Our approach is based on the ROS 2 Lifecycle. The primary goal of the ROS 2 lifecycle is to allows greater control over the state of a ROS system. It allows consistent initialization, restart and/or replacing of system parts during runtime. It provides a default lifecycle for managed ROS 2 nodes and a matching set of tools for managing lifecycle nodes.
5555

56-
The description of the concept can be found at [http://design.ros2.org/articles/node_lifecycle.html](http://design.ros2.org/articles/node_lifecycle.html). The implementation is described at [https://index.ros.org/doc/ros2/Managed-Nodes/](https://index.ros.org/doc/ros2/Managed-Nodes/).
56+
The description of the concept can be found at: [http://design.ros2.org/articles/node_lifecycle.html](http://design.ros2.org/articles/node_lifecycle.html)
57+
The implementation of the Lifecycle Node is described at:
58+
[https://index.ros.org/doc/ros2/Managed-Nodes/](https://index.ros.org/doc/ros2/Managed-Nodes/).
5759

5860
## Main Features
5961

6062
### Extended Lifecycle
6163

62-
In micro-ROS, we extended the ROS 2 lifecycle by allowing to specify modes, i.e. substates, specializing the *active* *state based on the standard ROS 2 parameters mechanism. We implemented this concept in rcl and rclcpp for ROS 2 and micro-ROS.
64+
In micro-ROS, we extend the ROS 2 lifecycle by allowing to specify modes, i.e. substates, specializing the *active* *state based on the standard ROS 2 parameters mechanism. We implemented this concept based on rcl and rclcpp for ROS 2 and micro-ROS.
6365

6466
Documentation and code can be found at:
65-
https://github.com/microROS/system_modes/system_modes/README.md#lifecycle
67+
[github.com:system_modes/README.md#lifecycle](https://github.com/microROS/system_modes/blob/master/system_modes/README.md#lifecycle)
6668

6769

6870
### System Hierarchy and Modes
6971

7072
We provide a modeling concept for specifying the hierarchical composition of systems recursively from nodes and for specifying the states and modes of systems and subsystems with the extended lifecycle, analogously to nodes. This system modes and hierarchy (SMH) model also includes an application-specific the mapping of the states and modes along the system hierarchy down to nodes.
7173

7274
The description of this model can be found at:
73-
https://github.com/microROS/system_modes/system_modes/README.md#system-modes
75+
[github.com:system_modes/README.md#system-modes](https://github.com/microROS/system_modes/blob/master/system_modes/README.md#system-modes)
76+
A simple example is provided at:
77+
[github.com:system_modes_examples/README.md#example-mode-file](https://github.com/microROS/system_modes/blob/master/system_modes_examples/README.md#example-mode-file)
7478

7579

7680
### Mode manager
7781

7882
The mode manager allows for runtime system adaptation based on such a system hierarchy and modes model. It parses the model and provides all services and topics to request state and mode changes and to monitor these changes.
7983

8084
The documentation and code can be found at:
81-
com/microROS/system_modes/system_modes/README.md#mode-manager
82-
A simple example is provided at:
83-
https://github.com/microROS/system_modes/system_modes_examples/
85+
[github.com:system_modes/README.md#mode-manager](https://github.com/microROS/system_modes/blob/master/system_modes/README.md#mode-manager)
86+
A simple example is provided at:
87+
[github.com:system_modes_examples/README.md#setup](https://github.com/microROS/system_modes/blob/master/system_modes_examples/README.md#setup)
8488

8589

8690
## Roadmap

0 commit comments

Comments
 (0)