API Reference

Complete documentation for all public types, methods, and properties in RpLidar.NET.


Namespaces

Namespace Contents
RpLidar.NET RPLidar, RpLidarSerialDevice, ILidarService, Constants
RpLidar.NET.Entities All data types: LidarPoint, LidarPointGroup, settings, enums, responses
RpLidar.NET.Helpers Internal helper utilities (not typically used directly)

Type Overview

Entry Points

Type Kind Description
RPLidar Class High-level wrapper — auto-connects and starts scanning
RpLidarSerialDevice Class Low-level serial device with full protocol control
ILidarService Interface Shared contract implemented by RpLidarSerialDevice

Data Types

Type Kind Description
LidarPoint Class Single measurement: angle, distance, quality
LidarPointGroup Sealed Class Angle-indexed collection of points from one sweep
LidarPointGroupItem Sealed Class One slot in a LidarPointGroup (per 0.1° bin)
InfoDataResponse Class Device info: model, firmware, serial number
RpHealthResponse Class Device health status
ResponseDescriptor Class Raw protocol response descriptor

Configuration

Type Kind Description
ILidarSettings Interface Settings contract
LidarSettings Sealed Class Default settings implementation

Enumerations

Type Description
ScanMode Standard, Boost, Sensitivity
Command Protocol command bytes
RpDataType Response data type identifiers
SendMode Single or multi-response request mode

Delegates

Delegate Signature Description
LidarPointScanEvenHandler (List<LidarPoint>) Fired per scan event with all points
LidarPointGroupScanEvenHandler (LidarPointGroup) Fired per scan event with grouped points

Table of contents


Copyright © 2024 Asheesh Maheshwari. Distributed under the MIT license.

This site uses Just the Docs, a documentation theme for Jekyll.