Update configure step (#274)

Author: pablogs9

README.md

@@ -118,9 +118,9 @@ By running this command without any argument the available demo applications and
 
 Common options available at this configuration step are:
   - `--transport` or `-t`: `udp`, `serial` or any hardware specific transport label
-  - `--dev` or `-d`: agent string descriptor in a serial-like transport
-  - `--ip` or `-i`: agent IP in a network-like transport
-  - `--port` or `-p`: agent port in a network-like transport
+  - `--dev` or `-d`: agent string descriptor in a serial-like transport (optional)
+  - `--ip` or `-i`: agent IP in a network-like transport (optional)
+  - `--port` or `-p`: agent port in a network-like transport (optional)
 
 
 Please note that each RTOS has its configuration approach that you might use for further customization of these base configurations. Visit the [micro-ROS webpage](https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/) for detailed information about RTOS configuration.

config/freertos/esp32/configure.sh

@@ -14,12 +14,9 @@ function help {
 echo $CONFIG_NAME > $FW_TARGETDIR/APP
 
 if [ "$UROS_TRANSPORT" == "serial" ]; then
-    # if [ "$UROS_AGENT_DEVICE" -gt 2 ]; then
-    #     echo ESP32 only supports USART0, USART1 or USART2
-    #     exit 1
-    # fi
-
     echo "Using serial device USART."
+    echo "Please check firmware/freertos_apps/microros_esp32_extensions/main/main.c"
+    echo "for configuring serial device before build."
 
     update_meta "microxrcedds_client" "UCLIENT_PROFILE_CUSTOM_TRANSPORT=ON"
     update_meta "microxrcedds_client" "UCLIENT_PROFILE_STREAM_FRAMING=ON"

config/freertos/nucleo_f446re/configure.sh

@@ -5,14 +5,16 @@ EXTENSIONS_DIR=$FW_TARGETDIR/freertos_apps/microros_nucleo_f446re_extensions
 function help {
       echo "Configure script need an argument."
       echo "   --transport -t        serial or serial-usb"
-      echo "   --dev -d             agent string descriptor in a serial-like transport"
 }
 
 echo $CONFIG_NAME > $FW_TARGETDIR/APP
 # TODO add USB-OTG support
 if [ "$UROS_TRANSPORT" == "serial" ]; then
       echo "Using serial device USART."
 
+      echo "Please check firmware/freertos_apps/microros_nucleo_f446re_extensions/Core/Src/freertos.c"
+      echo "for configuring serial device before build."
+
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_CUSTOM_TRANSPORT=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_STREAM_FRAMING=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_SERIAL=OFF"

config/freertos/nucleo_f446ze/configure.sh

@@ -6,14 +6,16 @@ EXTENSIONS_DIR=$FW_TARGETDIR/freertos_apps/microros_nucleo_f446ze_extensions
 function help {
       echo "Configure script need an argument."
       echo "   --transport -t        serial or serial-usb"
-      echo "   --dev -d             agent string descriptor in a serial-like transport"
 }
 
 echo $CONFIG_NAME > $FW_TARGETDIR/APP
 # TODO add USB-OTG support
 if [ "$UROS_TRANSPORT" == "serial" ]; then
       echo "Using serial device USART."
 
+      echo "Please check firmware/freertos_apps/microros_nucleo_f446ze_extensions/Src/main.c"
+      echo "for configuring serial device before build."
+
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_CUSTOM_TRANSPORT=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_STREAM_FRAMING=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_SERIAL=OFF"

config/freertos/nucleo_f746zg/configure.sh

@@ -6,7 +6,6 @@ EXTENSIONS_DIR=$FW_TARGETDIR/freertos_apps/microros_nucleo_f746zg_extensions
 function help {
       echo "Configure script need an argument."
       echo "   --transport -t       udp, serial or serial-usb"
-      echo "   --dev -d             agent string descriptor in a serial-like transport"
       echo "   --ip -i              agent IP in a network-like transport"
       echo "   --port -p            agent port in a network-like transport"
 }
@@ -30,6 +29,9 @@ if [ "$UROS_TRANSPORT" == "udp" ]; then
 elif [ "$UROS_TRANSPORT" == "serial" ]; then
       echo "Using serial device USART."
 
+      echo "Please check firmware/freertos_apps/microros_nucleo_f746zg_extensions/Src/main.c"
+      echo "for configuring serial device before build."
+
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_CUSTOM_TRANSPORT=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_STREAM_FRAMING=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_SERIAL=OFF"

config/freertos/nucleo_f767zi/configure.sh

@@ -6,7 +6,6 @@ EXTENSIONS_DIR=$FW_TARGETDIR/freertos_apps/microros_nucleo_f767zi_extensions
 function help {
       echo "Configure script need an argument."
       echo "   --transport -t       udp, serial or serial-usb"
-      echo "   --dev -d             agent string descriptor in a serial-like transport"
       echo "   --ip -i              agent IP in a network-like transport"
       echo "   --port -p            agent port in a network-like transport"
 }
@@ -30,6 +29,9 @@ if [ "$UROS_TRANSPORT" == "udp" ]; then
 elif [ "$UROS_TRANSPORT" == "serial" ]; then
       echo "Using serial device USART."
 
+      echo "Please check firmware/freertos_apps/microros_nucleo_f767zi_extensions/Src/main.c"
+      echo "for configuring serial device before build."
+
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_CUSTOM_TRANSPORT=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_STREAM_FRAMING=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_SERIAL=OFF"

config/freertos/olimex-stm32-e407/configure.sh

@@ -6,7 +6,6 @@ EXTENSIONS_DIR=$FW_TARGETDIR/freertos_apps/microros_olimex_e407_extensions
 function help {
       echo "Configure script need an argument."
       echo "   --transport -t       udp, serial or serial-usb"
-      echo "   --dev -d             agent string descriptor in a serial-like transport"
       echo "   --ip -i              agent IP in a network-like transport"
       echo "   --port -p            agent port in a network-like transport"
 }
@@ -29,6 +28,9 @@ if [ "$UROS_TRANSPORT" == "udp" ]; then
 elif [ "$UROS_TRANSPORT" == "serial" ]; then
       echo "Using serial device USART."
 
+      echo "Please check firmware/freertos_apps/microros_olimex_e407_extensions/Src/main.c"
+      echo "for configuring serial device before build."
+
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_CUSTOM_TRANSPORT=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_STREAM_FRAMING=ON"
       update_meta "microxrcedds_client" "UCLIENT_PROFILE_SERIAL=OFF"

config/zephyr/generic/configure.sh

@@ -6,10 +6,6 @@ EXTENSIONS_DIR=$FW_TARGETDIR/zephyr_apps
 function help {
       echo "Configure script need an argument."
       echo "   --transport -t       udp, serial or serial-usb"
-      echo "   --dev -d             agent string descriptor in a serial-like transport"
-      echo "   --ip -i              agent IP in a network-like transport"
-      echo "   --port -p            agent port in a network-like transport"
-
 }
 
 echo $CONFIG_NAME > $FW_TARGETDIR/APP
@@ -23,3 +19,18 @@ update_meta "microxrcedds_client" "UCLIENT_PROFILE_TCP=OFF"
 update_meta "rmw_microxrcedds" "RMW_UXRCE_TRANSPORT=custom"
 
 echo $UROS_TRANSPORT > $FW_TARGETDIR/TRANSPORT
+
+if [ "$UROS_TRANSPORT" == "udp" ]; then
+      echo "Configured UDP mode."
+      echo "Please check firmware/zephyr_apps/microros_extensions/microros_transports.h"
+      echo "for configuring IP and port before build."
+elif [ "$UROS_TRANSPORT" == "serial" ]; then
+      echo "Using serial device."
+      echo "Please check firmware/zephyr_apps/microros_extensions/microros_transports.h"
+      echo "for configuring serial device before build."
+elif [ "$UROS_TRANSPORT" == "serial-usb" ]; then
+      echo "Using USB serial device."
+      echo "Configured $UROS_TRANSPORT mode with agent at USB serial"
+else
+      help
+fi