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

Add Protocol document. #36

Merged
merged 2 commits into from
Dec 18, 2023
Merged

Add Protocol document. #36

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
974a6e2
Add Protocol document.
Dec 18, 2023
db7fec2
Modify protocol document.
Dec 18, 2023
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
3 changes: 2 additions & 1 deletion Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1370,7 +1370,8 @@ HTML_EXTRA_FILES = docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggl
docs/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
docs/doxygen-awesome-css/doxygen-awesome-interactive-toc.js \
docs/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
docs/doxygen-awesome-css/doxygen-awesome-tabs.js
docs/doxygen-awesome-css/doxygen-awesome-tabs.js \
docs/SLAMBOX_Protocol_v0.1.0_R1.pdf

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SLAMBOX SDK
SLAMBOX SDK is a C++ library specifically designed for seamless communication with the SLAMBOX device.
SLAMBOX SDK is a C++ library specifically designed for seamless communication with the SLAMBOX device, aligning with the [SLAMBOX Protocol documentation](docs/SLAMBOX_Protocol_v0.1.0_R1.pdf).
The SLAMBOX device empowers LiDAR devices with simultaneous localization and mapping (SLAM) algorithms.
SLAMBOX SDK allows developers to effortlessly integrate and control SLAMBOX functionality in their C++ applications, offering advanced spatial awareness and navigation capabilities.

Expand Down
Binary file added docs/SLAMBOX_Protocol_v0.1.0_R1.pdf
View file
Open in desktop
Binary file not shown.
9 changes: 6 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Welcome
Wecome to SLAMBOX documentation. SLAMBOX is your all-in-one solution for seamlessly connecting LiDAR devices, processing SLAM algorithms, and effortlessly transmitting results through serial or Ethernet communication. Designed with simplicity in mind, SLAMBOX empowers you to focus on your application, unleashing the true potential of LiDAR technology.
Wecome to SLAMBOX documentation. SLAMBOX is your all-in-one solution for seamlessly connecting LiDAR devices, processing SLAM(Simultaneous Localization and Mapping) algorithms, and effortlessly transmitting results through serial or Ethernet communication. Designed with simplicity in mind, SLAMBOX empowers you to focus on your application, unleashing the true potential of LiDAR technology.

![SLAMBOX](sbox_board_rev2.png){width=40%}

Expand All @@ -14,10 +14,13 @@ You're now ready to dive into your project with seamless SLAM processing.
Please follow instructions on https://github.com/j-marple-dev/slambox_ros_driver

## Getting started on ROS2
Comming soon
Comming Soon

## Getting started on your own with C++ API
Please look at [examples](https://github.com/j-marple-dev/SLAMBOX-SDK/tree/main/examples) on https://github.com/j-marple-dev/SLAMBOX-SDK for C++ development
Please look at [examples](https://github.com/j-marple-dev/SLAMBOX-SDK/tree/main/examples) on https://github.com/j-marple-dev/SLAMBOX-SDK for C++ development.

## Getting started on your own
Please look at [SLAMBOX protocol documentation](SLAMBOX_Protocol_v0.1.0_R1.pdf) to implement on your own environment.


# Key Features
Expand Down