You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -30,17 +30,17 @@ The `Manager` class is the core of RAM, orchestrating operations and managing tr
30
30
-`idle`: The initial state, waiting for a connection.
31
31
-`connected`: Connected and ready to initiate processes.
32
32
-`world_ready`: The world environment is set up and ready.
33
-
-`visualization_ready`: Visualization tools are prepared and ready.
33
+
-`tools_ready`: Tools are prepared and ready.
34
34
-`application_running`: A robotic application is actively running.
35
35
-`paused`: The application is paused.
36
36
-**Transitions**:
37
37
-`connect`: Moves from `idle` to `connected`.
38
38
-`launch_world`: Initiates the world setup from `connected`.
39
-
-`prepare_visualization`: Prepares the visualization tools in `world_ready`.
40
-
-`run_application`: Starts the application in `visualization_ready` or `paused`.
39
+
-`prepare_tools`: Prepares the tools in `world_ready`.
40
+
-`run_application`: Starts the application in `tools_ready` or `paused`.
41
41
-`pause`: Pauses the running application.
42
42
-`resume`: Resumes a paused application.
43
-
-`terminate`: Stops the application and goes back to `visualization_ready`.
43
+
-`terminate`: Stops the application and goes back to `tools_ready`.
44
44
-`stop`: Completely stops the application.
45
45
-`disconnect`: Disconnects from the current session and returns to `idle`.
46
46
-**Stateless Transitions**:
@@ -54,7 +54,7 @@ The `Manager` class is the core of RAM, orchestrating operations and managing tr
54
54
55
55
-`on_connect(self, event)`: Manages the transition to the 'connected' state.
56
56
-`on_launch_world(self, event)`: Prepares and launches the robotic world.
57
-
-`on_prepare_visualization(self, event)`: Sets up visualization tools.
57
+
-`on_prepare_tools(self, event)`: Sets up tools.
58
58
-`on_run_application(self, event)`: Executes the robotic application.
59
59
-`on_pause(self, msg)`: Pauses the running application.
60
60
-`on_resume(self, msg)`: Resumes the paused application.
@@ -84,13 +84,13 @@ The `Manager` class is the core of RAM, orchestrating operations and managing tr
84
84
4.**Termination and Cleanup**: `Manager` can instruct `LauncherWorld` to terminate the world environment through its `terminate` method. `LauncherWorld` ensures a clean and orderly shutdown of all modules and resources involved in the world setup.
85
85
5.**Error Handling and Logging**: `Manager` handles exceptions and errors that may arise during the world setup or termination processes, ensuring robust operation.
86
86
87
-
#### Interaction Between `Manager` and `LauncherVisualization`
87
+
#### Interaction Between `Manager` and `LauncherTools`
88
88
89
-
1.**Visualization Setup**: `Manager` initializes `LauncherVisualization` with a specific visualization configuration, which can include types like `console`, `gazebo_gra`, `gazebo_rae`, etc.
90
-
2.**Module Launching for Visualization**: `LauncherVisualization` dynamically launches visualization modules based on the configuration provided by `Manager`.
91
-
3.**State Management and Synchronization**: Upon successful setup of the visualization tools, `Manager` can update its state (e.g., to `visualization_ready`) to reflect the readiness of the visualization environment.
92
-
4.**Termination of Visualization Tools**: `Manager` can instruct `LauncherVisualization` to terminate the current visualization setup using its `terminate` method.
93
-
5.**Error Handling and Logging**: `Manager` is equipped to manage exceptions and errors that might occur during the setup or termination of visualization tools.
89
+
1.**Visualization Setup**: `Manager` initializes `LauncherTools` with a specific tools configuration, which can include tools like `console`, `simulator`, `web_gui`, etc.
90
+
2.**Module Launching for Tools**: `LauncherTools` dynamically launches tools modules based on the configuration provided by `Manager`.
91
+
3.**State Management and Synchronization**: Upon successful setup of the tools, `Manager` can update its state (e.g., to `tools_ready`) to reflect the readiness of the tools.
92
+
4.**Termination of Tools**: `Manager` can instruct `LauncherTools` to terminate the current tools setup using its `terminate` method.
93
+
5.**Error Handling and Logging**: `Manager` is equipped to manage exceptions and errors that might occur during the setup or termination of the tools.
94
94
95
95
#### Interaction Between `Manager` and `application_process`
96
96
@@ -100,7 +100,7 @@ The `Manager` class is the core of RAM, orchestrating operations and managing tr
100
100
4.**Error Handling and Logging**: `Manager` is responsible for handling any errors or exceptions that occur during the execution of the `application_process`.
101
101
5.**State Synchronization**: The state of the `application_process` is closely synchronized with the state machine in `Manager`.
102
102
103
-
#### Interaction Between `Manager` and `Server` (Specific to RoboticsAcademy Applications)
103
+
#### Interaction Between `Manager` and `Server` (Specific to RoboticsAcademy Applications) (Now inside tool web_gui)
104
104
105
105
1.**Dedicated WebSocket Server for GUI Updates**: `Server` is used exclusively for RoboticsAcademy applications that require real-time interaction with a web-based GUI.
106
106
2.**Client Communication for GUI Module**: For RoboticsAcademy applications with a GUI module, `Server` handles incoming and outgoing messages.
@@ -120,10 +120,10 @@ The `Manager` class is the core of RAM, orchestrating operations and managing tr
120
120
- Once connected, the client can request RAM to launch a robotic world by sending a `launch_world` command.
121
121
- RAM transitions to the `world_ready` state after successfully setting up the world environment.
122
122
123
-
3.**Setting Up Visualization**:
123
+
3.**Setting Up Tools**:
124
124
125
-
- After the world is ready, the client requests RAM to prepare the visualization tools with a `prepare_visualization` command.
126
-
- RAM transitions to the `visualization_ready` state, indicating that visualization tools are set up and ready.
125
+
- After the world is ready, the client requests RAM to prepare the tools with a `prepare_tools` command.
126
+
- RAM transitions to the `tools_ready` state, indicating that the tools are set up and ready.
127
127
128
128
4.**Running an Application**:
129
129
@@ -138,7 +138,7 @@ The `Manager` class is the core of RAM, orchestrating operations and managing tr
138
138
6.**Stopping the Application**:
139
139
140
140
- Finally, the client can send a `stop` command to halt the application.
141
-
- RAM stops the application and transitions back to the `visualization_ready` state, ready for new commands.
141
+
- RAM stops the application and transitions back to the `tools_ready` state, ready for new commands.
142
142
143
143
7.**Disconnecting**:
144
144
- Once all tasks are completed, the client can disconnect from RAM, which then returns to the `idle` state, ready for a new session.
0 commit comments