There is a need for a node that will interface with a smartmicro radar driver and publish the data acquired by the sensor through the ROS2 pipeline. This package implements such a node.
./smart_extract.shros2 launch umrr_ros2_driver radar.launch.py
From a separate terminal and after sourcing workspace
rviz2 -d [`recorder.rviz`](smart_rviz_plugin/config/rviz/recorder.rviz)
From smart_rviz_plugin folder
python custom_can_sender.py
- ROS2 foxy
A smartmicro UMRR96, UMRR11, DRVEGRD 171, DRVEGRD 152, DRVEGRD 169 or DRVEGRD 169 MSE radar are required to run this node. This code is bundled with a version of Smart Access API. Please make sure the version used to publish the data is compatible with this version:
- Date of release:
June 07, 2024 - Smart Access Automotive version:
v3.8.0
For each sensor user interface there is a corressponding sensor firmware. The following list all the possible combinations.
| User Interface Version | Sensor Firmware Version |
|---|---|
| UMRR96 Type 153 AUTOMOTIVE v1.2.1 | UMRR96 Type 153: V5.2.4 |
| UMRR96 Type 153 AUTOMOTIVE v1.2.2 | UMRR96 Type 153: V5.2.4 |
| UMRR11 Type 132 AUTOMOTIVE v1.1.1 | UMRR11 Type 132: V5.1.4 |
| UMRR11 Type 132 AUTOMOTIVE v1.1.2 | UMRR11 Type 132: V5.1.4 |
| UMRR9F Type 169 AUTOMOTIVE v1.1.1 | UMRR9F Type 169: V1.3.0 |
| UMRR9F Type 169 AUTOMOTIVE v2.0.0 | UMRR9F Type 169: V2.0.1 |
| UMRR9F Type 169 AUTOMOTIVE v2.1.1 | UMRR9F Type 169: V2.0.1 |
| UMRR9F Type 169 AUTOMOTIVE v2.2.0 | UMRR9F Type 169: V2.2.0 |
| UMRR9F Type 169 AUTOMOTIVE v2.2.1 | UMRR9F Type 169: V2.2.0 |
| UMRR9F Type 169 AUTOMOTIVE v2.4.1 | UMRR9F Type 169: V2.4.0 |
| UMRR9D Type 152 AUTOMOTIVE v1.0.2 | UMRR9D Type 152: V2.1.0 |
| UMRR9D Type 152 AUTOMOTIVE v1.0.3 | UMRR9D Type 152: V2.5.0 |
| UMRR9D Type 152 AUTOMOTIVE v1.2.2 | UMRR9D Type 152: V2.5.0 |
| UMRR9D Type 152 AUTOMOTIVE v1.4.1 | UMRR9D Type 152: V2.7.0 |
| UMRRA4 Type 171 AUTOMOTIVE v1.0.0 | UMRRA4 Type 171: V1.0.0 |
| UMRRA4 Type 171 AUTOMOTIVE v1.0.1 | UMRRA4 Type 171: V1.0.0 |
| UMRRA4 Type 171 AUTOMOTIVE v1.2.1 | UMRRA4 Type 171: V1.2.1 |
| UMRR11 Type 132 MSE v1.1.1 | UMRR11 Type 132-MSE: V6.1.2 |
| UMRR9F Type 169 MSE v1.0.0 | UMRR9F Type 169-MSE: V1.1.0 |
To add targets to the point cloud in a safe and quick fashion a
point_cloud_msg_wrapper library is used within
this project's node. This project can be installed either through rosdep or manually by executing:
sudo apt install ros-foxy-point-cloud-msg-wrapper
To use the GUI provided, it is required to install the following package:
pip install python-can
The inputs are coming as network packages generated in either of the following two ways:
- Through directly interfacing with the sensor
- Through a provided pcap file
- Through using the sensor simulators
These inputs are processed through the Smart Access C++ API and trigger a callback. Every time this callback is triggered a new point cloud message is created and published.
The driver publishes sensor_msgs::msg::PointCloud2 messages with the radar targets on the topic
umrr/targets which can be remapped through the parameters.
For setting up a sensor with ethernet or can, the interfaces of the should be set properly prior to configuring the node. The sensor is equipped with three physical layers (RS485, CAN and ethernet) however the driver uses only ethernet and can:
- ethernet: to set-up an ethernet interface the following command could be used
ifconfig my_interface_name 192.168.11.17 netmask 255.255.255.0. The command above uses the default source ip address used by the sensors. - can: if using LAWICEL to set-up a can interface the following commands could be used
slcand -o -s6 -t hw -S 3000000 /dev/ttyUSBxand thanip link set up my_interface_name. This uses the default baudrate of 500000. When using Peak CAN the interfaces are recognized by linux and is only needed to set the baudrate.
The node is configured through the parameters. Here is a short recap of the most important parts.
For more details, see the radar.sensor.example.yaml and
radar.adapter.example.yaml files.
For the setting up the sensors:
link_type: the type of hardware connectionmodel: the model of the sensor being used- can: 'umrr9f_can_mse_v1_0_0', 'umrra4_can_v1_0_1', 'umrr96_can_v1_2_2', 'umrr11_can_v1_1_2', 'umrr9d_can_v1_0_3', 'umrr9d_can_v1_2_2', 'umrr9f_can_v2_1_1', 'umrr9f_can_v2_2_1'
- port: 'umrr9f_mse_v1_0_0', 'umrra4_v1_0_1', 'umrr96_v1_2_2', 'umrr11_v1_1_2', 'umrr9d_v1_0_3', 'umrr9d_v1_2_2', 'umrr9f_v1_1_1', 'umrr9f_v2_1_1', 'umrr9f_v2_2_1'
dev_id: adapter id to which sensor is connected. The adapter and sensor should have the same dev_idid: the client_id of the sensor/source, must be a unique integer and non-zero.ip: the unique ip address of the sensor or of the source acting as a sensor, required only for sensors using ethernet.port: port to be used to receive the packets, default is 55555frame_id: name of the frame in which the messages will be publishedhistory_size: size of history for the message publisherinst_type: the type of instruction serialization type, relevant to sensors using ethernet and should be 'port_based'data_type: the type of data serialization type, relevant to sensors using ethernet and should be 'port_based'uifname: the user interface name of the sensor (refer to theuser_interfaces)uifmajorv: the major version of the sensor user interfaceuifminorv: the minor version of the sensor user interfaceuifpatchv: the patch version of the sensor user interface
For setting up the adapters:
master_inst_serial_type: the instruction serilization type of the master. When using a hybrid of 'can' and 'port' use 'can_based'master_data_serial_type: the data serilization type of the master. When using a hybrid of 'can' and 'port' use 'can_based'hw_type: the type of the hardware connectionhw_dev_id: adapter id of the hardware, the sensor and adapter should use the same idhw_iface_name: name of the used network interfacebaudrate: the baudrate of the sensor connected with can, default is 500000port: port to be used to receive the packets, default is 55555
The smartmicro radars come equipped with numerous features and modes of operation. Using the ros2 services provided one
may access these modes and send commands to the sensor. A list of available sensor operations is given in the user_interfaces.
A ros2 SetMode service should be called to implement these mode changes. There are three inputs to a ros2 service call:
param: name of the mode instruction (specific to the sensor)value: the mode of operation (specific to sensor where the modes are same)sensor_id: the id of the sensor to which the service call should be sent.
For instance, changing the Index of Transmit Antenna (tx_antenna_idx) of a UMRR-11 sensor to AEB (2) mode would require the following call:
ros2 service call /smart_radar/set_radar_mode umrr_ros2_msgs/srv/SetMode "{param: "tx_antenna_idx", value: 2, sensor_id: 100}"
Similarly, a ros2 SendCommand service could be used to send commands to the sensors. There are three inputs for sending a command:
command: name of the command (specific to the sensor interface)value: the value of the commandsensor_id: the id of the sensor to which the service call should be sent.
The call for such a service would be as follows:
ros2 service call /smart_radar/send_command umrr_ros2_msgs/srv/SendCommand "{command: "comp_eeprom_ctrl_default_param_sec", value: 2, sensor_id: 100}"
In order to use multiple sensors (maximum of up to eight sensors) with the node the sensors should be configured separately. The IP addresses of the sensors could be assigned using:
- The smartmicro tool
DriveRecorder. - Using the
Smart Access C++ API - Using
Sensor Servicesprovided by the node
Each sensor has to be assigned a unique IP address!
To use the ros2 SetIpservice we require two inputs:
value_ip: the value of the ip address in decimal. For instance to set the IP to192.168.11.64its corresponding value in decimal3232238400should be used.sensor_id: the sensor whose ip address is to be changed.
The call for such a service would be as follows:
ros2 service call /smart_radar/set_ip_address umrr_ros2_msgs/srv/SetIp "{value_ip: 3232238400, sensor_id: 100}"
Note: For successful execution of this call it is important that the sensor is restarted, the ip address in the
radar.template.yaml is updated and the driver is build again.
All the smartmicro radar sensors have independent firmware which are updated every now and than. To keep the sensor updated a firmware download needs to be performed.
A ros2 FirmwareDownload service should be called to implement these mode changes. There are two inputs to a ros2 service call:
file_path: the path where the firmware is locatedsensor_id: the id of the sensor to which the service call should be sent.
The call for such a service would be as follows:
ros2 service call /smart_radar/firmware_download umrr_ros2_msgs/srv/FirmwareDownload "{sensor_id: 100, file_path: '/path/to/firmware/file'}"
Note: The download could be performed only for one sensor at a time! Important: The download requires that the transfer length of the interface is set to minimum 4k!
The sensor services respond with certain value codes. The following is a lookup table for the possible responses:
| Value | Description |
|---|---|
| 0 | No instruction Response |
| 1 | Instruction Response was processed successfully |
| 2 | General error |
| 6 | Invalid protection |
| 7 | Value out of minimal bounds |
| 8 | Value out of maximal bounds |
A custom plugin for rviz to log the target list has been provided. A config file is available which adds this plugin to the rviz. WIth the plugin it is now possible to view the target list data for the desired sensor. Along with logging the data the plugin also gives the possibility to record the target list data, convert it into a csv format and save it.
Separately, a python GUI is also provided with which it is possible to send custom CAN messages.
The dockerfile can be used to build and test the ros driver.
- Docker version >= 20.10.14
- Docker compose version >= 1.29.2
Accept the agreement and get the smartaccess release
./smart_extract.shBuilding docker container
docker build . -t umrr-ros:latestBuilding the driver with the docker container
docker run --rm -v`pwd`:/code umrr-ros colcon build --packages-skip smart_rviz_pluginRunning the unit and integration tests via the docker compose
docker-compose upGetting the test coverage via the docker container
docker run --rm -v`pwd`:/code umrr-ros colcon test-result --all --verboseStop and remove docker containers and networks
docker-compose downThe Smart Access release which will be downloaded using the script also offers platform support for armv8. In order to build the driver on an armv8 machine, the CMakeLists.txt should be adopted.
Instead of using the default lib-linux-x86_64_gcc_9 the user should plugin the lib-linux-armv8-gcc_9 for armv8.
This project is a joint effort between smartmicro and Apex.AI. The initial version of the code was developed by Igor Bogoslavskyi of Apex.AI (@niosus) and was thereafter adapted and extended by smartmicro.
Licensed under the Apache 2.0 License.
