diff --git a/Doxyfile b/Doxyfile index d403186..218d006 100644 --- a/Doxyfile +++ b/Doxyfile @@ -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. diff --git a/README.md b/README.md index 24cc1aa..e9b619d 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/SLAMBOX_Protocol_v0.1.0_R1.pdf b/docs/SLAMBOX_Protocol_v0.1.0_R1.pdf new file mode 100644 index 0000000..526c7aa Binary files /dev/null and b/docs/SLAMBOX_Protocol_v0.1.0_R1.pdf differ diff --git a/docs/index.md b/docs/index.md index d120519..4b0505d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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%} @@ -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