Subscribe buzzer topics

1. Experimental purpose

Learn ESP32-microROS components, access the ROS2 environment, and subscribe to the topic of controlling the buzzer switch.

2. Hardware connection

As shown in the figure below, the microROS control board integrates an active buzzer and the ESP32-S3-WROOM core module, which has its own wireless WiFi function. The ESP32-S3 core module needs to be connected to an antenna and a type-C data cable. The computer and microROS control board function as firmware burning.

3. Core code analysis

The virtual machine path corresponding to the program source code is as follows

~/esp/Samples/microros_samples/beep_subscriber

Since an active buzzer is used this time, and the components of the active buzzer have been made in the previous routine, the components of the active buzzer need to be copied to the components directory of the project. Call Beep_Init at the beginning of the program to initialize the buzzer.

Get the WiFi name and password to connect from the IDF configuration tool.

xxxxxxxxxx
#define ESP_WIFI_SSID      CONFIG_ESP_WIFI_SSID
#define ESP_WIFI_PASS      CONFIG_ESP_WIFI_PASSWORD
#define ESP_MAXIMUM_RETRY  CONFIG_ESP_MAXIMUM_RETRY

The uros_network_interface_initialize function will connect to WiFi hotspots based on the WiFi configuration in IDF.

xxxxxxxxxx
ESP_ERROR_CHECK(uros_network_interface_initialize());

Then obtain ROS_NAMESPACE, ROS_DOMAIN_ID, ROS_AGENT_IP and ROS_AGENT_PORT from the IDF configuration tool.

xxxxxxxxxx
#define ROS_NAMESPACE      CONFIG_MICRO_ROS_NAMESPACE
#define ROS_DOMAIN_ID      CONFIG_MICRO_ROS_DOMAIN_ID
#define ROS_AGENT_IP       CONFIG_MICRO_ROS_AGENT_IP
#define ROS_AGENT_PORT     CONFIG_MICRO_ROS_AGENT_PORT

Initialize the configuration of microROS, in which ROS_DOMAIN_ID, ROS_AGENT_IP and ROS_AGENT_PORT are modified in the IDF configuration tool according to actual needs.

​x
    rcl_allocator_t allocator = rcl_get_default_allocator();
    rclc_support_t support;

    // 创建rcl初始化选项
    // Create init_options.
    rcl_init_options_t init_options = rcl_get_zero_initialized_init_options();
    RCCHECK(rcl_init_options_init(&init_options, allocator));
    // 修改ROS域ID
    // change ros domain id
    RCCHECK(rcl_init_options_set_domain_id(&init_options, ROS_DOMAIN_ID));

    // 初始化rmw选项
    // Initialize the rmw options
    rmw_init_options_t *rmw_options = rcl_init_options_get_rmw_init_options(&init_options);

    // 设置静态代理IP和端口
    // Setup static agent IP and port
    RCCHECK(rmw_uros_options_set_udp_address(ROS_AGENT_IP, ROS_AGENT_PORT, rmw_options));

Try to connect to the proxy. If the connection is successful, go to the next step. If the connection to the proxy is unsuccessful, you will always be in the connected state.

xxxxxxxxxx
    while (1)
    {
        ESP_LOGI(TAG, "Connecting agent: %s:%s", ROS_AGENT_IP, ROS_AGENT_PORT);
        state_agent = rclc_support_init_with_options(&support, 0, NULL, &init_options, &allocator);
        if (state_agent == ESP_OK)
        {
            ESP_LOGI(TAG, "Connected agent: %s:%s", ROS_AGENT_IP, ROS_AGENT_PORT);
            break;
        }
        vTaskDelay(pdMS_TO_TICKS(500));
    }

Create the node "beep_subscriber", in which ROS_NAMESPACE is empty by default and can be modified in the IDF configuration tool according to actual conditions.

xxxxxxxxxx
    rcl_node_t node;
    RCCHECK(rclc_node_init_default(&node, "beep_subscriber", ROS_NAMESPACE, &support));

To create subscriber "beep", you need to specify the ROS topic information as std_msgs/msg/UInt16 type.

xxxxxxxxxx
    RCCHECK(rclc_subscription_init_default(
        &subscriber,
        &node,
        ROSIDL_GET_MSG_TYPE_SUPPORT(std_msgs, msg, UInt16),
        "beep"));

Add subscribers to the executor, where the handle_num parameter of the executor represents the number added to the executor.

xxxxxxxxxx
    rclc_executor_t executor;
    int handle_num = 1;
    RCCHECK(rclc_executor_init(&executor, &support.context, handle_num, &allocator));
    
    RCCHECK(rclc_executor_add_subscription(&executor, &subscriber, &msg_beep, &beep_callback, ON_NEW_DATA));

When microros subscribers receive topic data, the beep_callback callback function is triggered and the active buzzer is controlled based on the received value.

xxxxxxxxxx
void beep_callback(const void * msgin)
{
    const std_msgs__msg__UInt16 * msg = (const std_msgs__msg__UInt16 *)msgin;
    printf("Beep: %d\n",  (int)  msg->data);
    // 根据接收到的数据控制蜂鸣器的状态
    // Control the state of the buzzer based on the received data
    Beep_On_Time(msg->data);
}

Call rclc_executor_spin_some in the loop to make microros work normally.

xxxxxxxxxx
    while (1)
    {
        rclc_executor_spin_some(&executor, RCL_MS_TO_NS(100));
        usleep(1000);
    }

4. Compile, download and flash firmware

Use a Type-C data cable to connect the virtual machine/computer and the microROS control board. If the system pops up, choose to connect to the virtual machine.

Activate the ESP-IDF development environment. Note that every time you open a new terminal, you need to activate the ESP-IDF development environment before compiling the firmware.

xxxxxxxxxx
source ~/esp/esp-idf/export.sh

Enter the project directory

xxxxxxxxxx
cd ~/esp/Samples/microros_samples/beep_subscriber

Open the ESP-IDF configuration tool.

xxxxxxxxxx
idf.py menuconfig

Open micro-ROS Settings, fill in the IP address of the agent host in micro-ROS Agent IP, and fill in the port number of the agent host in micro-ROS Agent Port.

Open micro-ROS Settings->WiFi Configuration in sequence, and fill in your own WiFi name and password in the WiFi SSID and WiFi Password fields.

Open the micro-ROS example-app settings. The Ros domain id of the micro-ROS defaults to 20. If multiple users are using it at the same time in the LAN, the parameters can be modified to avoid conflicts. Ros namespace of the micro-ROS is empty by default and does not need to be modified under normal circumstances. If non-empty characters (within 10 characters) are modified, the namespace parameter will be added before the node and topic.

After modification, press S to save, and then press Q to exit the configuration tool.

Compile, flash, and open the serial port simulator.

xxxxxxxxxx
idf.py build flash monitor

If you need to exit the serial port simulator, press Ctrl+].

5. Experimental results

After powering on, ESP32 tries to connect to the WiFi hotspot, and then tries to connect to the proxy IP and port.

If the agent is not turned on in the virtual machine/computer terminal, please enter the following command to turn on the agent. If the agent is already started, there is no need to start the agent again.

xxxxxxxxxx
docker run -it --rm -v /dev:/dev -v /dev/shm:/dev/shm --privileged --net=host microros/micro-ros-agent:humble udp4 --port 8090 -v4

After the connection is successful, a node and a subscriber are created.

At this time, you can open another terminal on the virtual machine/computer and view the /beep_subscriber node.

xxxxxxxxxx
ros2 node list
ros2 node info /beep_subscriber

Publish data to the /beep topic and control the buzzer to sound continuously.

xxxxxxxxxx
ros2 topic pub --once /beep std_msgs/msg/UInt16 "data: 1"

Publish data to the /beep topic and control the buzzer to turn off.

xxxxxxxxxx
ros2 topic pub --once /beep std_msgs/msg/UInt16 "data: 0"

Publish data to the /beep topic and control the buzzer to sound for 300 milliseconds and then turn off automatically.

xxxxxxxxxx
ros2 topic pub --once /beep std_msgs/msg/UInt16 "data: 300"

You can see the printed beep information on the serial port simulator, indicating that the subscription is successful.