Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document supported sensor drivers #293

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+420 −520
Open

Document supported sensor drivers #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25f9a57
Added supported drivers subsection
evan-palmer Sep 9, 2024
533d514
Updated npm deps
evan-palmer Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions .devcontainer/documentation/Dockerfile
View file
Open in desktop

This file was deleted.

10 changes: 3 additions & 7 deletions .devcontainer/documentation/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"name": "Documentation",
"build": {
"dockerfile": "Dockerfile"
},
"image": "mcr.microsoft.com/devcontainers/javascript-node:20",
"remoteUser": "node",
"forwardPorts": [3000],
"customizations": {
"vscode": {
"settings": {
Expand All @@ -13,10 +12,7 @@
"editor.tabSize": 2,
"editor.rulers": [80]
},
"extensions": [
"esbenp.prettier-vscode",
"unifiedjs.vscode-mdx"
]
"extensions": ["esbenp.prettier-vscode", "unifiedjs.vscode-mdx"]
}
}
}
22 changes: 21 additions & 1 deletion docs/docs/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,29 @@ Several vehicle models have been implemented and tested with Blue in
</Vehicle>
</div>

## Supported sensor drivers

Blue has been tested with a variety of underwater sensor platforms. Below is a
list of ROS 2 drivers that we have developed ourselves or that we recommend
exploring.

### In-House Drivers

| Sensor | Driver |
| ------ | ------ |
| Water Linked DVL-A50 | [waterlinked_dvl](https://github.com/Robotic-Decision-Making-Lab/waterlinked_dvl) |

### Third-Party Drivers

| Sensor | Driver |
| ------ | ------ |
| Blue Robotics Ping360 Sonar | [ping360_sonar](https://github.com/CentraleNantesRobotics/ping360_sonar) |
| Motion Capture Systems | [MOCAP4ROS2-Project](https://github.com/MOCAP4ROS2-Project) |

## Alternative projects

If you find that Blue does not meet your needs, we recommend exploring the following alternative projects:
If you find that Blue does not meet your needs, we recommend exploring the
following alternative projects:

- [Orca4](https://github.com/clydemcqueen/orca4)
- [Marine Vehicle Packages (MVP)](https://github.com/uri-ocean-robotics/mvp_readme)
Loading