Docs/update docs (#35)

* Fix documentations along with CBT feedbacks.

* Change menu order.

---------

Co-authored-by: Jongkuk Lim <limjk@jmarple.ai>

DoxygenLayout.xml

@@ -8,8 +8,8 @@
     <tab type="usergroup" visible="yes" title="Getting started">
       <tab type="user" url="@ref HardwareOverview" title="Hardware Overview"/>
       <tab type="user" url="@ref Tutorial" visible="yes" title="Tutorial"/>
-      <tab type="user" url="@ref LiDARSetting" title="LiDAR Setting"/>
       <tab type="user" url="@ref SLAMBOXSetting" title="SLAMBOX Setting"/>
+      <tab type="user" url="@ref LiDARSetting" title="LiDAR Setting"/>
     </tab>
     <!-- <tab type="user" url="todo.html" visible="yes" title="TODO"/> -->
     <tab type="usergroup" visible="yes" title="Examples">

docs/getting_started/hardware_overview.md

@@ -1,6 +1,6 @@
 # Hardware Overview {#HardwareOverview}
 
-![SLAMBOX Hardware](getting_started/sbox_board_rev1_numbering.jpg){width=50%}
+![SLAMBOX Hardware](getting_started/sbox_board_rev2_numbering.png){width=50%}
 
 
 1. Power (3.8v ~ 40v)
@@ -9,11 +9,11 @@
 
 3. USB port (Currently disabled)
 
-4. Reboot switch
+4. Restart button
 
 5. Mavlink UART port
 
-6. SLAMBOX UART port
+6. SLAMBOX I/O UART port
 
 7. Ethernet port for LiDAR
 

docs/getting_started/lidar_setting.md

@@ -40,7 +40,7 @@ In this tutorial, we will set IP address to `192.168.1.50`
 
 ![IP Address Setting](getting_started/lidar_setting/ip_setting_192_168_1_50.jpg){width=800px}
 
-Once you setup IP address, you may require to disable and re-enable in order to apply the configuration.
+Once you setup IP address, you may require to disable and re-enable your ethernet in order to apply the configuration.
 
 
 ### 1.2.4. Launching LiDAR Viewer Software
@@ -87,7 +87,7 @@ In this tutorial, we will set IP address to `192.168.1.50`
 
 ![IP Address Setting](getting_started/lidar_setting/ip_setting_192_168_1_50.jpg){width=800px}
 
-Once you setup IP address, you may require to disable and re-enable in order to apply the configuration.
+Once you setup IP address, you may require to disable and re-enable your ethernet in order to apply the configuration.
 
 
 ### 2.2.4. Launching LiDAR Viewer Software
@@ -137,7 +137,7 @@ Set the computer's IPv4 Method to Link-Local only.
 
 ![IP Address Setting](getting_started/lidar_setting/ip_setting_link_local.jpg){width=800px}
 
-Once you setup IP address, you may require to disable and re-enable in order to apply the configuration.
+Once you setup IP address, you may require to disable and re-enable your ethernet in order to apply the configuration.
 
 
 ### 3.2.4. Launching LiDAR Viewer Software
@@ -157,7 +157,7 @@ Set the computer's IP Address to `192.168.1.50`
 
 ![IP Address Setting](getting_started/lidar_setting/ip_setting_192_168_1_50.jpg)
 
-Once you setup IP address, you may require to disable and re-enable in order to apply the configuration.
+Once you setup IP address, you may require to disable and re-enable your ethernet in order to apply the configuration.
 
 Select detected LiDAR on Ouster Studio and click Configure and visualize.
 Make sure LiDAR data is visible in Ouster Studio.

docs/getting_started/slambox_setting.md

@@ -51,7 +51,7 @@ Working with Unix OS, use `minicom` to configure the **SLAMBOX**
     minicom -D ${SERIAL_PORT} -b 115200
     ```
 
-    Set Hardware Flow Control to `No`. It can be done by pressing `<Ctrl>+A o` -> Serial port setup -> Press `f`.
+    Set Hardware Flow Control to `No`. It can be done by pressing `<Ctrl>+a` -> `o` -> Serial port setup -> Press `f`.
 
 ```
 +------------------------------------------------+
@@ -66,14 +66,16 @@ Working with Unix OS, use `minicom` to configure the **SLAMBOX**
 |    Change which setting?                       |
 +------------------------------------------------+
 ```
+    
+Once you set `Hardware Flow Control` to NO, presse `<Enter>` -> `<ESC>` to escape setting menu.
 
-For your convinience, turn Local echo on by pressing `<Ctrl>+A z e`
+For your convinience, turn Local echo on by pressing `<Ctrl>+a` -> `z` -> `e`. Minicom does not show you what you type if Local echo is off.
 
 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>`
+Minicom can be exited by pressing `<Ctrl>+a` -> `x` -> `<Enter>`
 
 </details>
 
@@ -103,10 +105,9 @@ If you successfully open port, start configuration as your needs by following [b
 Use ascii command to change configuration of **SLAMBOX**
 
 - The commands must be start with `$` and ends with `#` which is header and ender of the command
+    - example) If you want to check current configuration status, send `$CONFIG#`
 
-- Either *upper case* or *lower case* can be used.
-
-- Regardless of changing configuration of **SLAMBOX**, the serial communication for settings operates
+- The commands are case insensitive. You can use either *upper case* or *lower case*.
 
 - The following commands below, type the commands in *minicom* or *ComPortMaster*
 
@@ -149,6 +150,7 @@ $CONFIG#
 - Please check the available baud rate table below
 
 **NOTE**: The *maximum* and *minimum* baud rate could be different depands on your USB2TTL device.
+**NOTE** Regardless of whether you disable serial communication, this configuration mode will always work with baudrate 115200.
 
 |Available baud rate|
 |:---:|
@@ -247,20 +249,6 @@ $MAVLINK_TYPE 0#
 $LIDAR_TYPE 1#
 ```
 
-**NOTE** Once you have changed `LIDAR_TYPE` it requires to restart SLAMBOX device.
-Please send `$SAVE#` and restart device to take an effect.
-
-
-### Save Configurations {#SLAMBOXSetting-ConfigureSLAMBOX-SaveConfigurations}
-
-- Configurtaion can be saved by command `SAVE` or `START`
-
-- The command `SAVE` just save the configuration
+**NOTE** Once you have changed `LIDAR_TYPE`, restarting SLAMBOX device is required to take an effect.
 
-- The command `START` finish the configuration and start the *SLAMBOX*
-
-```
-$SAVE#
-
-$START#
-```
+**NOTE** If you are done with setting SLAMBOX, you must exit serial communication application.

docs/getting_started/tutorial.md

@@ -1,10 +1,12 @@
 # Tutorial {#Tutorial}
 
+This tutorial guides you on how to setup SLAMBOX and your environment. [Chapter 1. Communication Setting](#Tutorial-CommunicationSetting) shows how to make communication available between SLAMBOX and your robot or PC.
+
 [TOC]
 
 # 1. Communication Setting {#Tutorial-CommunicationSetting}
 
-- To communicate with *SLAMBOX*, you need to setup the serial and ethernet of your **host PC**
+- To communicate with *SLAMBOX*, you need to setup the serial communication or ethernet communication of your **host PC**
 
 ## 1.1. Serial {#Tutorial-CommunicationSetting-Serial}
 
@@ -35,13 +37,13 @@ newgrp dialout
 
 ## 1.2. Ethernet (OTG) {#Tutorial-CommunicationSetting-Ethernet}
 
-To get data from *SLAMBOX* through etherent, then set your host PC's host IP like below.
+To get data from *SLAMBOX* through etherent, set your host PC's host IP like below. You set this up either via [CLI](#Tutorial-CommunicationSetting-Ethernet-SetStaticIPwithTerminal) or [GUI](#Tutorial-CommunicationSetting-Ethernet-SetStaticIPwithUbuntuGUI).
 
-### 1.2.1. Set Static IP with Terminal {#Tutorial-CommunicationSetting-Ethernet-SetStaticIPwithTerminal}
+### 1.2.1. Set Static IP with CLI {#Tutorial-CommunicationSetting-Ethernet-SetStaticIPwithTerminal}
 
 To set static ip to your host PC, please follow the commands below
 
-**NOTE**: The default IP address of OTG port of *SLAMBOX* is `192.168.101.101`
+**NOTE**: The default IP address of OTG port of *SLAMBOX* is `192.168.101.101`. You need to avoid using this IP address.
 
 ```bash
 # check the ethernet device
@@ -57,11 +59,11 @@ enx5ad1753eff84: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
         TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
 ```
 
-The device name `enx5ad1753eff84` is the OTG ethernet connection of SLAMBOX
+The device name `enx5ad1753eff84` is the OTG ethernet connection of SLAMBOX.
 
-Then set the device's IP 
+Then set the device's IP.
 
-In this example, set the static IP to `192.168.101.5`
+In this example, we set the static IP to `192.168.101.5`
 
 ```bash
 # set device's IP
@@ -94,22 +96,23 @@ Then, set the device IP like the screen shot below
 
 ![Set static ip of the host device](imgs/getting_started/communication_setup/setup_static_ip_gui.png){width=70%}
 
-# 2. LiDAR Setting {#Tutorial-LiDARSetting}
+# 2. SLAMBOX Setting {#Tutorial-SLAMBOXSetting}
 
-- Check how to setup LiDAR to *SLAMBOX*, please see here([LiDAR Setting](#LiDARSetting))
+- Check how to setup *SLAMBOX* or how to configure *SLAMBOX*, please see here([SLAMBOX Setting](#SLAMBOXSetting))
 
-# 3. SLAMBOX Setting {#Tutorial-SLAMBOXSetting}
+# 3. LiDAR Setting {#Tutorial-LiDARSetting}
 
-- Check how to setup *SLAMBOX* or how to configure *SLAMBOX*, please see here([SLAMBOX Setting](#SLAMBOXSetting))
+- Check how to setup LiDAR to *SLAMBOX*, please see here([LiDAR Setting](#LiDARSetting))
 
 # 4. Advanced {#Tutorial-Advanced}
 
-We prefer you to check examples below
+Please check following pages for the next step.
+
+- [ROS example](https://github.com/j-marple-dev/slambox-ros)
 
 - [TurtleBot3 example](#TurtleBotExample)
 
 - [PX4 example](#PX4Example)
 
 - [Ardupilot example](#ArdupilotExample)
 
-- [ROS example](https://github.com/j-marple-dev/slambox-ros)

docs/index.md

@@ -1,19 +1,22 @@
 # 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.
 
-![SLAMBOX](sbox_board_rev1.jpg){width=40%}
+![SLAMBOX](sbox_board_rev2.png){width=40%}
 
 # How do I get started?
 
-Ensure your [LiDAR settings](LiDARSetting.html) are configured.
-Customize [SLAMBOX settings](SLAMBOXSetting.html) as needed.
+[Configure SLAMBOX](SLAMBOXSetting.html) as your needs.
+Ensure your [LiDAR settings](LiDARSetting.html) are configured for SLAMBOX.
 Connect LiDAR to SLAMBOX using provided cables.
 You're now ready to dive into your project with seamless SLAM processing.
 
 ## Getting started on ROS1
 Please follow instructions on https://github.com/j-marple-dev/slambox_ros_driver
 
-## Getting started on your own
+## Getting started on ROS2
+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