Skip to content

Commit 7d572dd

Browse files
authored
Cleanup (#104)
2 parents 3a64080 + 024352b commit 7d572dd

File tree

11 files changed

+9
-533
lines changed

11 files changed

+9
-533
lines changed

.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,6 @@ ENV/
191191
# Rope project settings
192192
.ropeproject
193193

194-
195-
/bitbots_body_behaviour/scripts/behaviour_graph.png
196-
197194
# auto-generated documentation
198195
**/docs/_build
199196
**/docs/_out

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ When the element is reevaluated, `perform` is called on the element.
8080
If the result of `perform` is the same as the last time it was called, nothing happens and the next decision is reevaluated.
8181
If the result of `perform` is different from the last time, everything above the reevaluated decision is discarded and a new element, depending on the result of `perform`, is pushed on the stack and executed.
8282

83-
An action can call `self.do_not_reevaluate()` to avoid reevaluation of the stack on the next call to `update`. Alternatively the parameters (see #Parameters) `r` or `reevaluate` can be used in the dsd file to enable or disable the reevaluation during a specific action.
83+
An action can call `self.do_not_reevaluate()` to avoid reevaluation of the stack on the next call to `update`. Alternatively the parameters (see #Parameters) `r` or `reevaluate` can be used in the dsd file to enable or disable the reevaluation during a specific action.
8484

8585
## Sequence elements
8686

@@ -96,7 +96,7 @@ The syntax is `@Action + parameter:value`, multiple parameters can be passed usi
9696
The parameters to an element are passed to the element's constructor as a dictionary.
9797
The value of the parameter is passed through `yaml.safe_load`.
9898
Therefore, you can use integers, floats, booleans or strings as values.
99-
It is also possible to load parameters from the ROS parameter server using `parameter:%rosparam`, where `rosparam` is the name of the parameter on the parameter server.
99+
It is also possible to load parameters from the ROS parameter server using `parameter:%rosparam`, where `rosparam` is the name of the parameter on the parameter server.
100100

101101
Here is an example:
102102
```
@@ -158,13 +158,13 @@ $Mode
158158

159159
## Interrupt
160160

161-
A stack element can call `self.interrupt()` to create an interrupt which removes all elements except for the start element from the stack (i.e., the DSD is restarted).
161+
A stack element can call `self.interrupt()` to create an interrupt which removes all elements except for the start element from the stack (i.e., the DSD is restarted).
162162

163163
## Debugging
164164

165165
For debugging, the DSD visualization should be used.
166-
It reads the locations of different DSDs from `config/locations.yaml` and can be launched in rqt.
167-
The visualization shows the DSD tree with the currently active actions and decisions on the left and the current stack on the right.
166+
It automatically discovers all running DSDs with a debug topic and visualizes them in RQT.
167+
The visualization shows the DSD tree with the currently active actions and decisions as a tree on the left and the current stack on the right.
168168
More information can be added to the right side by calling `self.publish_debug_data(label, data)` in any action or decision.
169169

170170
## DSD Development GUI
@@ -176,8 +176,8 @@ If you use VSCode, you can use the [DSD extension](https://marketplace.visualstu
176176
## Examples
177177

178178
Here are a few projects that use the DSD and can be used for reference:
179-
* The [Bit-Bots Body Behavior](https://github.com/bit-bots/bitbots_behavior/tree/master/bitbots_body_behavior/bitbots_body_behavior)
180-
* The [Bit-Bots Humanoid Control Module](https://github.com/bit-bots/bitbots_motion/tree/master/bitbots_hcm/bitbots_hcm/hcm_dsd)
179+
* The [Bit-Bots Behavior](https://github.com/bit-bots/bitbots_main/tree/main/bitbots_behavior)
180+
* The [Bit-Bots Humanoid Control Module](https://github.com/bit-bots/bitbots_main/tree/main/bitbots_motion/bitbots_hcm/bitbots_hcm/hcm_dsd)
181181
* The [Parser Test](https://github.com/bit-bots/dynamic_stack_decider/tree/master/dynamic_stack_decider/test) in this repository
182182

183183
## The Paper

dynamic_stack_decider/CMakeLists.txt

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ cmake_minimum_required(VERSION 3.5)
22
project(dynamic_stack_decider)
33

44
find_package(ament_cmake_python REQUIRED)
5-
find_package(bitbots_docs REQIRED)
65

7-
enable_bitbots_docs()
86
ament_python_install_package(${PROJECT_NAME})
97
ament_package()

dynamic_stack_decider/docs/conf.py

-187
This file was deleted.

dynamic_stack_decider/docs/index.rst

-25
This file was deleted.

dynamic_stack_decider/package.xml

+2-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<package format="3">
44
<name>dynamic_stack_decider</name>
55
<version>0.5.3</version>
6-
<description>The bitbots_dsd is an extended form
6+
<description>The bitbots dsd is an extended form
77
of a behaviour state machine. It works like a stack where
88
classes describing decisions or actions are pushed on top,
99
executed, and popped off again. In difference to a state
@@ -22,15 +22,11 @@
2222
<exec_depend>rosidl_default_runtime</exec_depend>
2323

2424
<depend>rclpy</depend>
25-
<depend>bitbots_docs</depend>
25+
<depend>std_msgs</depend>
2626
<depend>python3-yaml</depend>
2727
<test_depend>python3-coverage</test_depend>
2828

2929
<export>
30-
<bitbots_documentation>
31-
<status>tested_integration</status>
32-
<language>python3</language>
33-
</bitbots_documentation>
3430
<build_type>ament_python</build_type>
3531
</export>
3632
</package>
Binary file not shown.

0 commit comments

Comments
 (0)