Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Commit

Permalink
Global Path Service (#30)
Browse files Browse the repository at this point in the history 
* Created a Global Path Service message

* minor refactoring

* updates to readme

* Update markdownlint configuration

* Update other table

---------

Co-authored-by: Patrick Creighton <[email protected]>
  • Loading branch information
@SPDonaghy @patrick-5546
SPDonaghy and patrick-5546 authored Nov 30, 2023
1 parent 9820731 commit 3885add
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 20 deletions.
5 changes: 4 additions & 1 deletion .markdownlint.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"default": true,
"MD013": {
"line_length": 120
"line_length": 120,
"code_blocks": false,
"tables": false
},
"MD004": {
"style": "dash"
Expand All @@ -12,6 +14,7 @@
"MD035": {
"style": "---"
},
"MD033": false,
"MD040": false,
"MD041": false,
"MD046": false
Expand Down
2 changes: 2 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ rosidl_generate_interfaces(${PROJECT_NAME}
${simulator_msg}
${simulator_action}

"srv/GlobalPath.srv"

# Add packages that above messages depend on below if needed
DEPENDENCIES std_msgs geometry_msgs
)
Expand Down
38 changes: 19 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,22 @@ Formatting reminder:
1. Keep 'Type' column organized alphabetically
2. 'mock' version of topic should be after its common counterpart
--->
| Topic | Type | Publisher | Subscriber(s) |
| ---------------------- | -------------- | ------------------ | -------------------------------------------------- |
| `ais_ships` | AISShips | CanTrxRosIntf | Local Pathfinding, Local Transceiver |
| `mock_ais_ships` | AISShips | Mock AIS | CanSimIntf |
| `batteries` | Batteries | CanTrxRosIntf | Local Transceiver |
| `boat_sim_input` | CanSimToBoatSim | CanSimIntf | Boat Simulator |
| `desired_heading` | DesiredHeading | Local Pathfinding | CanTrxRosIntf |
| `data_sensors` | GenericSensors | CanTrxRosIntf | Local Transceiver |
| `gps` | GPS | CanTrxRosIntf | Controller, Local Transceiver, Local Pathfinding |
| `mock_gps` | GPS | Boat Simulator | CanSimIntf |
| `local_path_data` | LPathData | Local Pathfinding | Local Transceiver |
| `global_path` | Path | Local Transceiver | Local Pathfinding |
| `sail_cmd` | SailCmd | Controller | CanTrxRosIntf |
| `filtered_wind_sensor` | WindSensor | CanTrxRosIntf | Controller, Local Transceiver, Local Pathfinding |
| `wind_sensors` | WindSensors | CanTrxRosIntf | Local Transceiver |
| `mock_wind_sensors` | WindSensors | Boat Simulator | CanSimIntf |
| Topic | File Name | Publisher | Subscriber(s) |
| ---------------------- | ------------------- | ------------------------------------ | ---------------------------------------------------|
| `ais_ships` | AISShips.msg | CanTrxRosIntf | Local Pathfinding, Local Transceiver |
| `mock_ais_ships` | AISShips.msg | Mock AIS | CanSimIntf |
| `batteries` | Batteries.msg | CanTrxRosIntf | Local Transceiver |
| `boat_sim_input` | CanSimToBoatSim.msg | CanSimIntf | Boat Simulator |
| `desired_heading` | DesiredHeading.msg | Local Pathfinding | CanTrxRosIntf |
| `data_sensors` | GenericSensors.msg | CanTrxRosIntf | Local Transceiver |
| `gps` | GPS.msg | CanTrxRosIntf | Controller, Local Transceiver, Local Pathfinding |
| `mock_gps` | GPS.msg | Boat Simulator | CanSimIntf |
| `local_path_data` | LPathData.msg | Local Pathfinding | Local Transceiver |
| `global_path` | GlobalPath.srv | Local Transceiver, Mock Global Path | Local Pathfinding |
| `sail_cmd` | SailCmd.msg | Controller | CanTrxRosIntf |
| `filtered_wind_sensor` | WindSensor.msg | CanTrxRosIntf | Controller, Local Transceiver, Local Pathfinding |
| `wind_sensors` | WindSensors.msg | CanTrxRosIntf | Local Transceiver |
| `mock_wind_sensors` | WindSensors.msg | Boat Simulator | CanSimIntf |

### Project-wide Internal Interfaces

Expand All @@ -55,9 +55,9 @@ ROS messages and services used in our [boat simulator](https://github.com/UBCSai

### Boat Simulator External Interfaces

| Topic | Type | Publisher | Subscriber(s) |
| ---------------------- | -------------- | ------------------------ | ------------------------------------------- |
| `mock_kinematics` | SimWorldState | Simulator Physics Engine | Simulator Visualizer |
| Topic | File Name | Publisher | Subscriber(s) |
| ---------------------- | ------------------ | ------------------------ | ------------------------------------------- |
| `mock_kinematics` | SimWorldState.msg | Simulator Physics Engine | Simulator Visualizer |

### Boat Simulator Actions

Expand Down
3 changes: 3 additions & 0 deletions srv/GlobalPath.srv
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Path global_path
---
bool response

0 comments on commit 3885add

Please sign in to comment.