# slamtec/rplidar_ros architecture

> Architecture diagram of the GitHub repository slamtec/rplidar_ros, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/slamtec/rplidar_ros
- Repository: https://github.com/slamtec/rplidar_ros

## Overview

This ROS package exposes RPLIDAR through a ROS node, with a separate console client for viewing scans. The principal flow is sensor communication through the SDK, scan decoding, then ROS-facing scan output for tools such as RViz. The SDK also provides command/protocol definitions, channel abstractions, asynchronous transport, and multiple sample decoders. README documents supported model launch variants and the two viewing workflows; source excerpts and the index show SDK composition, but not the ROS topic wiring or the client’s implementation details.

Main entry points: [`sdk/src/dataunpacker/dataunpacker.cpp`](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/dataunpacker.cpp) (Sample unpacker), [`src/node.cpp`](https://github.com/slamtec/rplidar_ros/blob/master/src/node.cpp) (ROS node), [`sdk/include/sl_lidar_driver.h`](https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_driver.h) (Driver API), [`sdk/src/sl_lidar_driver.cpp`](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/sl_lidar_driver.cpp) (Driver implementation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ros["ROS integration"]
  node_ros_node["ROS node<br/>[node.cpp]"]
  node_scan_view["RViz scan view"]
  node_console_client["Console client<br/>[client.cpp]"]
end

subgraph group_sdk["LIDAR SDK"]
  node_sdk_api["Driver API<br/>[sl_lidar_driver.h]"]
  node_sdk_impl["Driver implementation"]
  node_protocol["Commands and protocol<br/>[sl_lidar_cmd.h]"]
  node_channel_api["Channel interfaces<br/>[sl_lidar_driver.h]"]
  node_transceiver["Async transceiver"]
  node_platform_io["Platform transports"]
  node_scan_protocol["Scan data structures"]
end

subgraph group_decode["Scan decoding"]
  node_data_unpacker["Sample unpacker<br/>[dataunpacker.cpp]"]
  node_capsule_decoder["Capsule decoders"]
  node_hq_decoder["HQ node decoder<br/>[handler_hqnode.cpp]"]
  node_normal_decoder["Normal node decoder"]
end

node_operator(("Operator"))

node_operator -->|"launches"| node_ros_node
node_ros_node -->|"uses"| node_sdk_api
node_sdk_impl -->|"feeds samples"| node_data_unpacker
node_sdk_impl -->|"uses"| node_transceiver
node_sdk_impl -->|"implements"| node_sdk_api
node_sdk_api -->|"defines channels"| node_channel_api
node_data_unpacker -->|"dispatches"| node_capsule_decoder
node_data_unpacker -->|"dispatches"| node_hq_decoder
node_data_unpacker -->|"dispatches"| node_normal_decoder
node_capsule_decoder -->|"decodes"| node_scan_protocol
node_hq_decoder -->|"decodes"| node_scan_protocol
node_sdk_api -->|"uses commands"| node_protocol
node_operator -->|"views scans"| node_scan_view
node_operator -->|"runs"| node_console_client
node_ros_node -.->|"publishes scan for"| node_scan_view
node_console_client -.->|"connects to"| node_ros_node
node_channel_api -.->|"implemented by"| node_platform_io
node_transceiver -.->|"transfers data"| node_channel_api

click node_ros_node "https://github.com/slamtec/rplidar_ros/blob/master/src/node.cpp"
click node_console_client "https://github.com/slamtec/rplidar_ros/blob/master/src/client.cpp"
click node_sdk_api "https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_driver.h"
click node_sdk_impl "https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/sl_lidar_driver.cpp"
click node_protocol "https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_cmd.h"
click node_channel_api "https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_driver.h"
click node_transceiver "https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/sl_async_transceiver.cpp"
click node_platform_io "https://github.com/slamtec/rplidar_ros/tree/master/sdk/src/arch"
click node_data_unpacker "https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/dataunpacker.cpp"
click node_capsule_decoder "https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/unpacker/handler_capsules.cpp"
click node_hq_decoder "https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/unpacker/handler_hqnode.cpp"
click node_normal_decoder "https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/unpacker/handler_normalnode.cpp"
click node_scan_protocol "https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_protocol.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ros_node,node_scan_view,node_console_client toneBlue
class node_sdk_api,node_sdk_impl,node_protocol,node_channel_api,node_transceiver,node_platform_io,node_scan_protocol toneAmber
class node_data_unpacker,node_capsule_decoder,node_hq_decoder,node_normal_decoder toneMint
class node_operator toneIndigo
```

## Components

### ROS integration

- [ROS node](https://github.com/slamtec/rplidar_ros/blob/master/src/node.cpp): `src/node.cpp`
- **RViz scan view**
- [Console client](https://github.com/slamtec/rplidar_ros/blob/master/src/client.cpp): `src/client.cpp`

### LIDAR SDK

- [Driver API](https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_driver.h): `sdk/include/sl_lidar_driver.h`
- [Driver implementation](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/sl_lidar_driver.cpp): `sdk/src/sl_lidar_driver.cpp`
- [Commands and protocol](https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_cmd.h): `sdk/include/sl_lidar_cmd.h`
- [Channel interfaces](https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_driver.h): `sdk/include/sl_lidar_driver.h`
- [Async transceiver](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/sl_async_transceiver.cpp): `sdk/src/sl_async_transceiver.cpp`
- [Platform transports](https://github.com/slamtec/rplidar_ros/tree/master/sdk/src/arch): `sdk/src/arch`
- [Scan data structures](https://github.com/slamtec/rplidar_ros/blob/master/sdk/include/sl_lidar_protocol.h): `sdk/include/sl_lidar_protocol.h`

### Scan decoding

- [Sample unpacker](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/dataunpacker.cpp): `sdk/src/dataunpacker/dataunpacker.cpp`
- [Capsule decoders](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/unpacker/handler_capsules.cpp): `sdk/src/dataunpacker/unpacker/handler_capsules.cpp`
- [HQ node decoder](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/unpacker/handler_hqnode.cpp): `sdk/src/dataunpacker/unpacker/handler_hqnode.cpp`
- [Normal node decoder](https://github.com/slamtec/rplidar_ros/blob/master/sdk/src/dataunpacker/unpacker/handler_normalnode.cpp): `sdk/src/dataunpacker/unpacker/handler_normalnode.cpp`

### Other components

- **Operator**

## Connections

- Operator → ROS node: launches
- ROS node → Driver API: uses (evidence: `src/node.cpp`)
- Driver implementation → Sample unpacker: feeds samples (evidence: `sdk/src/sl_lidar_driver.cpp`)
- Driver implementation → Async transceiver: uses (evidence: `sdk/src/sl_lidar_driver.cpp`)
- Driver implementation → Driver API: implements (evidence: `sdk/src/sl_lidar_driver.cpp`)
- Driver API → Channel interfaces: defines channels (evidence: `sdk/include/sl_lidar_driver.h`)
- Sample unpacker → Capsule decoders: dispatches (evidence: `sdk/src/dataunpacker/dataunpacker.cpp`)
- Sample unpacker → HQ node decoder: dispatches (evidence: `sdk/src/dataunpacker/dataunpacker.cpp`)
- Sample unpacker → Normal node decoder: dispatches (evidence: `sdk/src/dataunpacker/dataunpacker.cpp`)
- Capsule decoders → Scan data structures: decodes (evidence: `sdk/src/dataunpacker/unpacker/handler_capsules.cpp`)
- HQ node decoder → Scan data structures: decodes (evidence: `sdk/src/dataunpacker/unpacker/handler_hqnode.cpp`)
- Driver API → Commands and protocol: uses commands (evidence: `sdk/include/sl_lidar_driver.h`)
- Operator → RViz scan view: views scans
- Operator → Console client: runs
- ROS node → RViz scan view: publishes scan for
- Console client → ROS node: connects to
- Channel interfaces → Platform transports: implemented by
- Async transceiver → Channel interfaces: transfers data (evidence: `sdk/src/sl_async_transceiver.cpp`)
