Skip to content

Commit

Permalink
Change docs from feedbacks. (#29)
Browse files Browse the repository at this point in the history
* Change docs from feedbacks.

* Fix minor issues on build paths.

---------

Co-authored-by: Jongkuk Lim <limjk@jmarple.ai>
  • Loading branch information
JeiKeiLim and Jongkuk Lim authored Dec 11, 2023
1 parent b4f59f9 commit 18d5e27
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 6 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@
``` 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
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
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 18 additions & 1 deletion docs/getting_started/slambox_setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ For your convinience, turn Local echo on by pressing `<Ctrl>+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 `<Ctrl>+A x` -> `<Enter>`
</details>
<details open>
Expand All @@ -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.
</details>
## Configure SLAMBOX {#SLAMBOXSetting-ConfigureSLAMBOX}
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 18d5e27

Please sign in to comment.