diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66d52b4..4b5f2ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,8 +17,8 @@ ``` shell # ex) Current Make version is 3.16.3 cd ~ -wget https://github.com/Kitware/CMake/releases/download/v3.16.3/cmake-3.16.3-linux-x86_64.tar.gz -tar -xzvf cmake-3.16.3-linux-x86_64.tar.gz +wget https://github.com/Kitware/CMake/releases/download/v3.16.3/cmake-3.16.3-Linux-x86_64.tar.gz +tar -xzvf cmake-3.16.3-Linux-x86_64.tar.gz # Backup previous CMake just in case sudo mv /usr/bin/cmake /usr/bin/cmake.old @@ -26,9 +26,9 @@ sudo mv /usr/bin/ctest /usr/bin/ctest.old sudo mv /usr/bin/cpack /usr/bin/cpack.old # Make softlink to /usr/bin -sudo ln -s ${HOME}/cmake-3.16.3-linux-x86_64/bin/cmake /usr/bin/cmake -sudo ln -s ${HOME}/cmake-3.16.3-linux-x86_64/bin/ctest /usr/bin/ctest -sudo ln -s ${HOME}/cmake-3.16.3-linux-x86_64/bin/cpack /usr/bin/cpack +sudo ln -s ${HOME}/cmake-3.16.3-Linux-x86_64/bin/cmake /usr/bin/cmake +sudo ln -s ${HOME}/cmake-3.16.3-Linux-x86_64/bin/ctest /usr/bin/ctest +sudo ln -s ${HOME}/cmake-3.16.3-Linux-x86_64/bin/cpack /usr/bin/cpack ``` ## 2.1. Formating diff --git a/README.md b/README.md index 3e1d93b..24cc1aa 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ SLAMBOX SDK allows developers to effortlessly integrate and control SLAMBOX func - How to install: ```bash git clone https://github.com/google/glog.git -b v0.6.0 + cd glog cmake -S . -B build -G "Unix Makefiles" cmake --build build sudo cmake --build build --target install diff --git a/docs/getting_started/slambox_setting.md b/docs/getting_started/slambox_setting.md index 0f49d8e..971900b 100644 --- a/docs/getting_started/slambox_setting.md +++ b/docs/getting_started/slambox_setting.md @@ -71,6 +71,10 @@ For your convinience, turn Local echo on by pressing `+A z e` Then, start configuration as your needs by following [below section](#SLAMBOXSetting-ConfigureSLAMBOX). +**NOTE** Once you have finished setup process, minicom must be exited in order to continue on next step. + +Minicom can be exited by pressing `+A x` -> `` +
@@ -82,8 +86,16 @@ Then, start configuration as your needs by following [below section](#SLAMBOXSet Install the *ComPortMaster* from the [link](http://withrobot.com/data/?mod=document&uid=12) - ![How to use ComPortMaster](getting_started/slambox_setting/comportmaster.png) +2. Connect to SLAMBOX serial + + Please follow settings as below screenshot. `Device` name might be different depending on your OS condition. + +![How to use ComPortMaster](getting_started/slambox_setting/comportmaster.png) + +If you successfully open port, start configuration as your needs by following [below section](#SLAMBOXSetting-ConfigureSLAMBOX). + +**NOTE** Once you have finished setup process, you must disconnect connection on ComPortMaster to continue on next step.
## Configure SLAMBOX {#SLAMBOXSetting-ConfigureSLAMBOX} @@ -136,6 +148,9 @@ $SERIAL_ENABLE 1# $SERIAL_BAUD 921600# ``` +**NOTE** If you set both `Serial` and `UDP` communication enabled, pointcloud will only be sent via `UDP` communication. + + ### SLAMBOX Ethernet Configuration {#SLAMBOXSetting-ConfigureSLAMBOX-SLAMBOXEthernetConfiguration} - `ETH_ENABLE` with option `0` or `1`. `0` means to disable and `1` means enable this option @@ -155,6 +170,8 @@ $ETH_PORT 25180# $ETH_IP 192.168.1.50# ``` +**NOTE** If you set both `Serial` and `UDP` communication enabled, pointcloud will only be sent via `UDP` communication. + ### SLAMBOX Mavlink Configuration {#SLAMBOXSetting-ConfigureSLAMBOX-SLAMBOXMavlinkConfiguration} - `MAVLINK_ENABLE` with option `0` or `1`. `0` means to disable and `1` means enable this option