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
+6-6
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,18 @@
2
2
3
3
Code for The Harvard Undergraduate Robotics Club's MATE ROV team.
4
4
5
-
The code consist of separate modules that are run on either the ROV or on a ground base. Inter-module communications are orchestrated by the RovController (rovController.py), which acts like a server. Modules send messages to the rovController and subscribe to certain messagetypes. When the RovController receives a message of a certain type, it forwards it to all the modules that have subscribed to that message type.
5
+
The code consist of separate modules that are run on either the ROV or on a ground base. Inter-module communications are orchestrated by the Server (server.py). Modules send messages to the server and subscribe to certain message types. When the server receives a message of a certain type, it forwards it to all the modules that have subscribed to that message type.
6
6
7
7
## How to run
8
8
9
-
1. Execute ./rovController
9
+
1. Execute ./server.py
10
10
2. Execute all of your modules
11
11
12
12
## Adding new modules
13
13
14
14
1. If necessary, create a new protocol buffer for your data.
15
-
- Create a new .proto file describing your buffer in the comm folder.
16
-
- Add your new .proto file to the Makefile in the comm folder.
15
+
- Create a new .proto file describing your buffer in the messages folder.
16
+
- Add your new .proto file to the Makefile in the messages folder.
17
17
- Before:
18
18
```
19
19
protobuf: first.proto
@@ -26,7 +26,7 @@ The code consist of separate modules that are run on either the ROV or on a grou
26
26
protoc -I=./ --python_out=./ ./second.proto
27
27
```
28
28
- Run the make command in the comm folder.
29
-
- In comm/constants.py do the following:
29
+
- In messages/__init__.py do the following:
30
30
- Import your new compiled buffer.
31
31
- Add a message type enum for your new buffer.
32
32
- Add the new message type and the associated buffer to message_buffers.
@@ -58,4 +58,4 @@ The code consist of separate modules that are run on either the ROV or on a grou
58
58
MsgType.SECOND: SecondMsg
59
59
}
60
60
```
61
-
2. Make a new module class that inherits from modules.ProtoModule. Look at MockGuiModule.py and MockSensorModule for examples on modules
61
+
2. Make a new module class that inherits from robomodules.ProtoModule. Look at MockGuiModule.py and MockSensorModule for examples on modules
0 commit comments