Main MRPT website > C++ reference for MRPT 1.5.7
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
rp::standalone::rplidar::RPlidarDriverSerialImpl Class Reference

Detailed Description

Definition at line 39 of file rplidar_driver_serial.h.

#include <rplidar/src/rplidar_driver_serial.h>

Inheritance diagram for rp::standalone::rplidar::RPlidarDriverSerialImpl:
Inheritance graph

Public Types

enum  { MAX_SCAN_NODES = 2048 }
 
enum  { LEGACY_SAMPLE_DURATION = 476 }
 
enum  { DEFAULT_TIMEOUT = 2000 }
 
enum  { DRIVER_TYPE_SERIALPORT = 0x0 }
 

Public Member Functions

 RPlidarDriverSerialImpl ()
 
virtual ~RPlidarDriverSerialImpl ()
 
virtual u_result connect (const char *port_path, _u32 baudrate, _u32 flag)
 Open the specified serial port and connect to a target RPLIDAR device. More...
 
virtual void disconnect ()
 Disconnect with the RPLIDAR and close the serial port. More...
 
virtual bool isConnected ()
 Returns TRUE when the connection has been established. More...
 
virtual u_result reset (_u32 timeout=DEFAULT_TIMEOUT)
 Ask the RPLIDAR core system to reset it self The host system can use the Reset operation to help RPLIDAR escape the self-protection mode. More...
 
virtual u_result getHealth (rplidar_response_device_health_t &, _u32 timeout=DEFAULT_TIMEOUT)
 Retrieve the health status of the RPLIDAR The host system can use this operation to check whether RPLIDAR is in the self-protection mode. More...
 
virtual u_result getDeviceInfo (rplidar_response_device_info_t &, _u32 timeout=DEFAULT_TIMEOUT)
 Get the device information of the RPLIDAR include the serial number, firmware version, device model etc. More...
 
virtual u_result getSampleDuration_uS (rplidar_response_sample_rate_t &rateInfo, _u32 timeout=DEFAULT_TIMEOUT)
 Get the sample duration information of the RPLIDAR. More...
 
virtual u_result setMotorPWM (_u16 pwm)
 Set the RPLIDAR's motor pwm when using accessory board, currently valid for A2 only. More...
 
virtual u_result startMotor ()
 Start RPLIDAR's motor when using accessory board. More...
 
virtual u_result stopMotor ()
 Stop RPLIDAR's motor when using accessory board. More...
 
virtual u_result checkMotorCtrlSupport (bool &support, _u32 timeout=DEFAULT_TIMEOUT)
 Check whether the device support motor control. More...
 
virtual u_result getFrequency (bool inExpressMode, size_t count, float &frequency, bool &is4kmode)
 Calcuate RPLIDAR's current scanning frequency from the given scan data Please refer to the application note doc for details Remark: the calcuation will be incorrect if the specified scan data doesn't contains enough data. More...
 
virtual u_result startScan (bool force=false, bool autoExpressMode=true)
 Ask the RPLIDAR core system to enter the scan mode(Normal/Express, Express mode is 4k mode) A background thread will be created by the RPLIDAR driver to fetch the scan data continuously. More...
 
virtual u_result startScanNormal (bool force, _u32 timeout=DEFAULT_TIMEOUT)
 
virtual u_result startScanExpress (bool fixedAngle, _u32 timeout=DEFAULT_TIMEOUT)
 
virtual u_result checkExpressScanSupported (bool &support, _u32 timeout=DEFAULT_TIMEOUT)
 Check whether the device support express mode. More...
 
virtual u_result stop (_u32 timeout=DEFAULT_TIMEOUT)
 Ask the RPLIDAR core system to stop the current scan operation and enter idle state. More...
 
virtual u_result grabScanData (rplidar_response_measurement_node_t *nodebuffer, size_t &count, _u32 timeout=DEFAULT_TIMEOUT)
 Wait and grab a complete 0-360 degree scan data previously received. More...
 
virtual u_result ascendScanData (rplidar_response_measurement_node_t *nodebuffer, size_t count)
 Ascending the scan data according to the angle value in the scan. More...
 

Static Public Member Functions

static RPlidarDriverCreateDriver (_u32 drivertype=DRIVER_TYPE_SERIALPORT)
 Create an RPLIDAR Driver Instance This interface should be invoked first before any other operations. More...
 
static void DisposeDriver (RPlidarDriver *drv)
 Dispose the RPLIDAR Driver Instance specified by the drv parameter Applications should invoke this interface when the driver instance is no longer used in order to free memory. More...
 

Protected Member Functions

u_result _waitNode (rplidar_response_measurement_node_t *node, _u32 timeout=DEFAULT_TIMEOUT)
 
u_result _waitScanData (rplidar_response_measurement_node_t *nodebuffer, size_t &count, _u32 timeout=DEFAULT_TIMEOUT)
 
u_result _cacheScanData ()
 
void _capsuleToNormal (const rplidar_response_capsule_measurement_nodes_t &capsule, rplidar_response_measurement_node_t *nodebuffer, size_t &nodeCount)
 
u_result _waitCapsuledNode (rplidar_response_capsule_measurement_nodes_t &node, _u32 timeout=DEFAULT_TIMEOUT)
 
u_result _cacheCapsuledScanData ()
 
u_result _sendCommand (_u8 cmd, const void *payload=NULL, size_t payloadsize=0)
 
u_result _waitResponseHeader (rplidar_ans_header_t *header, _u32 timeout=DEFAULT_TIMEOUT)
 
u_result _waitSampleRate (rplidar_response_sample_rate_t *res, _u32 timeout=DEFAULT_TIMEOUT)
 
void _disableDataGrabbing ()
 

Protected Attributes

bool _isConnected
 
bool _isScanning
 
bool _isSupportingMotorCtrl
 
rp::hal::Locker _lock
 
rp::hal::Event _dataEvt
 
rp::hal::serial_rxtx_rxtx
 
rplidar_response_measurement_node_t _cached_scan_node_buf [2048]
 
size_t _cached_scan_node_count
 
_u16 _cached_sampleduration_std
 
_u16 _cached_sampleduration_express
 
rplidar_response_capsule_measurement_nodes_t _cached_previous_capsuledata
 
bool _is_previous_capsuledataRdy
 
rp::hal::Thread _cachethread
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DEFAULT_TIMEOUT 

Definition at line 46 of file rplidar_driver.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
DRIVER_TYPE_SERIALPORT 

Definition at line 50 of file rplidar_driver.h.

◆ anonymous enum

anonymous enum
Enumerator
MAX_SCAN_NODES 

Definition at line 43 of file rplidar_driver_serial.h.

◆ anonymous enum

anonymous enum
Enumerator
LEGACY_SAMPLE_DURATION 

Definition at line 47 of file rplidar_driver_serial.h.

Constructor & Destructor Documentation

◆ RPlidarDriverSerialImpl()

rp::standalone::rplidar::RPlidarDriverSerialImpl::RPlidarDriverSerialImpl ( )

◆ ~RPlidarDriverSerialImpl()

rp::standalone::rplidar::RPlidarDriverSerialImpl::~RPlidarDriverSerialImpl ( )
virtual

Definition at line 81 of file rplidar_driver.cpp.

References _rxtx, disconnect(), and rp::hal::serial_rxtx::ReleaseRxTx().

Member Function Documentation

◆ _cacheCapsuledScanData()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_cacheCapsuledScanData ( )
protected

◆ _cacheScanData()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_cacheScanData ( )
protected

◆ _capsuleToNormal()

void rp::standalone::rplidar::RPlidarDriverSerialImpl::_capsuleToNormal ( const rplidar_response_capsule_measurement_nodes_t &  capsule,
rplidar_response_measurement_node_t *  nodebuffer,
size_t &  nodeCount 
)
protected

◆ _disableDataGrabbing()

void rp::standalone::rplidar::RPlidarDriverSerialImpl::_disableDataGrabbing ( )
protected

◆ _sendCommand()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_sendCommand ( _u8  cmd,
const void payload = NULL,
size_t  payloadsize = 0 
)
protected

◆ _waitCapsuledNode()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_waitCapsuledNode ( rplidar_response_capsule_measurement_nodes_t &  node,
_u32  timeout = DEFAULT_TIMEOUT 
)
protected

◆ _waitNode()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_waitNode ( rplidar_response_measurement_node_t *  node,
_u32  timeout = DEFAULT_TIMEOUT 
)
protected

◆ _waitResponseHeader()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_waitResponseHeader ( rplidar_ans_header_t *  header,
_u32  timeout = DEFAULT_TIMEOUT 
)
protected

◆ _waitSampleRate()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_waitSampleRate ( rplidar_response_sample_rate_t *  res,
_u32  timeout = DEFAULT_TIMEOUT 
)
protected

◆ _waitScanData()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::_waitScanData ( rplidar_response_measurement_node_t *  nodebuffer,
size_t &  count,
_u32  timeout = DEFAULT_TIMEOUT 
)
protected

◆ ascendScanData()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::ascendScanData ( rplidar_response_measurement_node_t *  nodebuffer,
size_t  count 
)
virtual

Ascending the scan data according to the angle value in the scan.

Parameters
nodebufferBuffer provided by the caller application to do the reorder. Should be retrived from the grabScanData
countThe caller must initialize this parameter to set the max data count of the provided buffer (in unit of rplidar_response_measurement_node_t). Once the interface returns, this parameter will store the actual received data count. The interface will return RESULT_OPERATION_FAIL when all the scan data is invalid.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 551 of file rplidar_driver.cpp.

References angle_q6_checkbit, distance_q2, RESULT_OK, RESULT_OPERATION_FAIL, RPLIDAR_RESP_MEASUREMENT_ANGLE_SHIFT, and RPLIDAR_RESP_MEASUREMENT_CHECKBIT.

◆ checkExpressScanSupported()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::checkExpressScanSupported ( bool &  support,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

Check whether the device support express mode.

Parameters
supportReturn the result.
timeoutThe operation timeout value (in millisecond) for the serial port communication.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 272 of file rplidar_driver.cpp.

References _cached_sampleduration_express, _cached_sampleduration_std, getDeviceInfo(), getSampleDuration_uS(), IS_FAIL, and RESULT_OK.

Referenced by startScan().

◆ checkMotorCtrlSupport()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::checkMotorCtrlSupport ( bool &  support,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

Check whether the device support motor control.

Note: this API will disable grab.

Parameters
supportReturn the result.
timeoutThe operation timeout value (in millisecond) for the serial port communication.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 924 of file rplidar_driver.cpp.

References _disableDataGrabbing(), _lock, _rxtx, _sendCommand(), _waitResponseHeader(), rp::hal::serial_rxtx::ANS_OK, IS_FAIL, isConnected(), rp::hal::serial_rxtx::recvdata(), RESULT_INVALID_DATA, RESULT_OK, RESULT_OPERATION_FAIL, RESULT_OPERATION_TIMEOUT, RPLIDAR_ANS_HEADER_SIZE_MASK, RPLIDAR_ANS_TYPE_ACC_BOARD_FLAG, RPLIDAR_CMD_GET_ACC_BOARD_FLAG, RPLIDAR_RESP_ACC_BOARD_FLAG_MOTOR_CTRL_SUPPORT_MASK, and rp::hal::serial_rxtx::waitfordata().

Referenced by connect().

◆ connect()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::connect ( const char *  port_path,
_u32  baudrate,
_u32  flag 
)
virtual

Open the specified serial port and connect to a target RPLIDAR device.

Parameters
port_paththe device path of the serial port e.g. on Windows, it may be com3 or \. on Unix-Like OS, it may be /dev/ttyS1, /dev/ttyUSB2, etc
baudratethe baudrate used For most RPLIDAR models, the baudrate should be set to 115200
flagother flags Reserved for future use, always set to Zero

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 89 of file rplidar_driver.cpp.

References _isConnected, _isSupportingMotorCtrl, _lock, _rxtx, rp::hal::serial_rxtx::bind(), checkMotorCtrlSupport(), rp::hal::serial_rxtx::flush(), isConnected(), rp::hal::serial_rxtx::open(), RESULT_ALREADY_DONE, RESULT_INSUFFICIENT_MEMORY, RESULT_INVALID_DATA, RESULT_OK, and stopMotor().

◆ CreateDriver()

RPlidarDriver * rp::standalone::rplidar::RPlidarDriver::CreateDriver ( _u32  drivertype = DRIVER_TYPE_SERIALPORT)
staticinherited

Create an RPLIDAR Driver Instance This interface should be invoked first before any other operations.

Parameters
drivertypethe connection type used by the driver.

Definition at line 50 of file rplidar_driver.cpp.

References rp::standalone::rplidar::RPlidarDriver::DRIVER_TYPE_SERIALPORT.

◆ disconnect()

void rp::standalone::rplidar::RPlidarDriverSerialImpl::disconnect ( )
virtual

Disconnect with the RPLIDAR and close the serial port.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 114 of file rplidar_driver.cpp.

References _isConnected, _rxtx, rp::hal::serial_rxtx::close(), and stop().

Referenced by ~RPlidarDriverSerialImpl().

◆ DisposeDriver()

void rp::standalone::rplidar::RPlidarDriver::DisposeDriver ( RPlidarDriver drv)
staticinherited

Dispose the RPLIDAR Driver Instance specified by the drv parameter Applications should invoke this interface when the driver instance is no longer used in order to free memory.

Definition at line 61 of file rplidar_driver.cpp.

◆ getDeviceInfo()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::getDeviceInfo ( rplidar_response_device_info_t &  info,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

Get the device information of the RPLIDAR include the serial number, firmware version, device model etc.

Parameters
infoThe device information returned from the RPLIDAR
timeoutThe operation timeout value (in millisecond) for the serial port communication

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 179 of file rplidar_driver.cpp.

References _disableDataGrabbing(), _lock, _rxtx, _sendCommand(), _waitResponseHeader(), rp::hal::serial_rxtx::ANS_OK, info, IS_FAIL, isConnected(), rp::hal::serial_rxtx::recvdata(), RESULT_INVALID_DATA, RESULT_OK, RESULT_OPERATION_FAIL, RESULT_OPERATION_TIMEOUT, RPLIDAR_ANS_HEADER_SIZE_MASK, RPLIDAR_ANS_TYPE_DEVINFO, RPLIDAR_CMD_GET_DEVICE_INFO, and rp::hal::serial_rxtx::waitfordata().

Referenced by checkExpressScanSupported(), and getSampleDuration_uS().

◆ getFrequency()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::getFrequency ( bool  inExpressMode,
size_t  count,
float &  frequency,
bool &  is4kmode 
)
virtual

Calcuate RPLIDAR's current scanning frequency from the given scan data Please refer to the application note doc for details Remark: the calcuation will be incorrect if the specified scan data doesn't contains enough data.

Parameters
inExpressModeIndicate whether the RPLIDAR is in express mode
countThe number of sample nodes inside the given buffer
frequencyThe scanning frequency (in HZ) calcuated by the interface.
is4kmodeReturn whether the RPLIDAR is working on 4k sample rate mode.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 218 of file rplidar_driver.cpp.

References _cached_sampleduration_express, _cached_sampleduration_std, and RESULT_OK.

◆ getHealth()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::getHealth ( rplidar_response_device_health_t &  health,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

Retrieve the health status of the RPLIDAR The host system can use this operation to check whether RPLIDAR is in the self-protection mode.

Parameters
healthThe health status info returned from the RPLIDAR
timeoutThe operation timeout value (in millisecond) for the serial port communication

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 141 of file rplidar_driver.cpp.

References _disableDataGrabbing(), _lock, _rxtx, _sendCommand(), _waitResponseHeader(), rp::hal::serial_rxtx::ANS_OK, IS_FAIL, isConnected(), rp::hal::serial_rxtx::recvdata(), RESULT_INVALID_DATA, RESULT_OK, RESULT_OPERATION_FAIL, RESULT_OPERATION_TIMEOUT, RPLIDAR_ANS_HEADER_SIZE_MASK, RPLIDAR_ANS_TYPE_DEVHEALTH, RPLIDAR_CMD_GET_DEVICE_HEALTH, and rp::hal::serial_rxtx::waitfordata().

◆ getSampleDuration_uS()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::getSampleDuration_uS ( rplidar_response_sample_rate_t &  rateInfo,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

Get the sample duration information of the RPLIDAR.

Parameters
rateInfoThe sample duration information returned from the RPLIDAR
timeoutThe operation timeout value (in millisecond) for the serial port communication

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 874 of file rplidar_driver.cpp.

References _cached_sampleduration_express, _cached_sampleduration_std, _disableDataGrabbing(), _lock, _rxtx, _sendCommand(), _waitResponseHeader(), rp::hal::serial_rxtx::ANS_OK, getDeviceInfo(), IS_FAIL, isConnected(), rp::hal::serial_rxtx::recvdata(), RESULT_INVALID_DATA, RESULT_OK, RESULT_OPERATION_FAIL, RESULT_OPERATION_TIMEOUT, RPLIDAR_ANS_HEADER_SIZE_MASK, RPLIDAR_ANS_TYPE_SAMPLE_RATE, RPLIDAR_CMD_GET_SAMPLERATE, and rp::hal::serial_rxtx::waitfordata().

Referenced by checkExpressScanSupported().

◆ grabScanData()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::grabScanData ( rplidar_response_measurement_node_t *  nodebuffer,
size_t &  count,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

Wait and grab a complete 0-360 degree scan data previously received.

The grabbed scan data returned by this interface always has the following charactistics:

1) The first node of the grabbed data array (nodebuffer[0]) must be the first sample of a scan, i.e. the start_bit == 1 2) All data nodes are belong to exactly ONE complete 360-degrees's scan 3) Note, the angle data in one scan may not be ascending. You can use API ascendScanData to reorder the nodebuffer.

Parameters
nodebufferBuffer provided by the caller application to store the scan data
countThe caller must initialize this parameter to set the max data count of the provided buffer (in unit of rplidar_response_measurement_node_t). Once the interface returns, this parameter will store the actual received data count.
timeoutMax duration allowed to wait for a complete scan data, nothing will be stored to the nodebuffer if a complete 360-degrees' scan data cannot to be ready timely.

The interface will return RESULT_OPERATION_TIMEOUT to indicate that no complete 360-degrees' scan can be retrieved withing the given timeout duration.

caller application can set the timeout value to Zero(0) to make this interface always returns immediately to achieve non-block operation.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 524 of file rplidar_driver.cpp.

References _cached_scan_node_buf, _cached_scan_node_count, _dataEvt, _lock, rp::hal::Event::EVENT_OK, rp::hal::Event::EVENT_TIMEOUT, mrpt::system::os::memcpy(), min, RESULT_OK, RESULT_OPERATION_FAIL, RESULT_OPERATION_TIMEOUT, and rp::hal::Event::wait().

◆ isConnected()

bool rp::standalone::rplidar::RPlidarDriverSerialImpl::isConnected ( )
virtual

Returns TRUE when the connection has been established.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 121 of file rplidar_driver.cpp.

References _isConnected.

Referenced by checkMotorCtrlSupport(), connect(), getDeviceInfo(), getHealth(), getSampleDuration_uS(), startScanExpress(), and startScanNormal().

◆ reset()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::reset ( _u32  timeout = DEFAULT_TIMEOUT)
virtual

Ask the RPLIDAR core system to reset it self The host system can use the Reset operation to help RPLIDAR escape the self-protection mode.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 127 of file rplidar_driver.cpp.

References _lock, _sendCommand(), IS_FAIL, RESULT_OK, and RPLIDAR_CMD_RESET.

◆ setMotorPWM()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::setMotorPWM ( _u16  pwm)
virtual

Set the RPLIDAR's motor pwm when using accessory board, currently valid for A2 only.

Parameters
pwmThe motor pwm value would like to set

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 971 of file rplidar_driver.cpp.

References _lock, _sendCommand(), IS_FAIL, RESULT_OK, and RPLIDAR_CMD_SET_MOTOR_PWM.

Referenced by startMotor(), and stopMotor().

◆ startMotor()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::startMotor ( )
virtual

Start RPLIDAR's motor when using accessory board.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 988 of file rplidar_driver.cpp.

References _isSupportingMotorCtrl, _lock, _rxtx, rp::hal::serial_rxtx::clearDTR(), DEFAULT_MOTOR_PWM, delay, RESULT_OK, and setMotorPWM().

◆ startScan()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::startScan ( bool  force = false,
bool  autoExpressMode = true 
)
virtual

Ask the RPLIDAR core system to enter the scan mode(Normal/Express, Express mode is 4k mode) A background thread will be created by the RPLIDAR driver to fetch the scan data continuously.

User Application can use the grabScanData() interface to retrieved the scan data cached previous by this background thread.

Parameters
forceForce the core system to output scan data regardless whether the scanning motor is rotating or not.
autoExpressModeForce the core system to trying express mode first, if the system does not support express mode, it will use normal mode.
timeoutThe operation timeout value (in millisecond) for the serial port communication.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 337 of file rplidar_driver.cpp.

References checkExpressScanSupported(), IS_FAIL, startScanExpress(), and startScanNormal().

◆ startScanExpress()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::startScanExpress ( bool  fixedAngle,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

◆ startScanNormal()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::startScanNormal ( bool  force,
_u32  timeout = DEFAULT_TIMEOUT 
)
virtual

◆ stop()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::stop ( _u32  timeout = DEFAULT_TIMEOUT)
virtual

Ask the RPLIDAR core system to stop the current scan operation and enter idle state.

The background thread will be terminated

Parameters
timeoutThe operation timeout value (in millisecond) for the serial port communication

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 355 of file rplidar_driver.cpp.

References _disableDataGrabbing(), _lock, _sendCommand(), IS_FAIL, RESULT_OK, and RPLIDAR_CMD_STOP.

Referenced by disconnect(), startScanExpress(), and startScanNormal().

◆ stopMotor()

u_result rp::standalone::rplidar::RPlidarDriverSerialImpl::stopMotor ( )
virtual

Stop RPLIDAR's motor when using accessory board.

Implements rp::standalone::rplidar::RPlidarDriver.

Definition at line 1002 of file rplidar_driver.cpp.

References _isSupportingMotorCtrl, _lock, _rxtx, delay, RESULT_OK, rp::hal::serial_rxtx::setDTR(), and setMotorPWM().

Referenced by connect().

Member Data Documentation

◆ _cached_previous_capsuledata

rplidar_response_capsule_measurement_nodes_t rp::standalone::rplidar::RPlidarDriverSerialImpl::_cached_previous_capsuledata
protected

Definition at line 106 of file rplidar_driver_serial.h.

Referenced by _capsuleToNormal().

◆ _cached_sampleduration_express

_u16 rp::standalone::rplidar::RPlidarDriverSerialImpl::_cached_sampleduration_express
protected

◆ _cached_sampleduration_std

_u16 rp::standalone::rplidar::RPlidarDriverSerialImpl::_cached_sampleduration_std
protected

◆ _cached_scan_node_buf

rplidar_response_measurement_node_t rp::standalone::rplidar::RPlidarDriverSerialImpl::_cached_scan_node_buf[2048]
protected

Definition at line 100 of file rplidar_driver_serial.h.

Referenced by _cacheCapsuledScanData(), _cacheScanData(), and grabScanData().

◆ _cached_scan_node_count

size_t rp::standalone::rplidar::RPlidarDriverSerialImpl::_cached_scan_node_count
protected

◆ _cachethread

rp::hal::Thread rp::standalone::rplidar::RPlidarDriverSerialImpl::_cachethread
protected

◆ _dataEvt

rp::hal::Event rp::standalone::rplidar::RPlidarDriverSerialImpl::_dataEvt
protected

Definition at line 98 of file rplidar_driver_serial.h.

Referenced by _cacheCapsuledScanData(), _cacheScanData(), and grabScanData().

◆ _is_previous_capsuledataRdy

bool rp::standalone::rplidar::RPlidarDriverSerialImpl::_is_previous_capsuledataRdy
protected

Definition at line 107 of file rplidar_driver_serial.h.

Referenced by _capsuleToNormal(), and _waitCapsuledNode().

◆ _isConnected

bool rp::standalone::rplidar::RPlidarDriverSerialImpl::_isConnected
protected

Definition at line 93 of file rplidar_driver_serial.h.

Referenced by _sendCommand(), _waitScanData(), connect(), disconnect(), and isConnected().

◆ _isScanning

bool rp::standalone::rplidar::RPlidarDriverSerialImpl::_isScanning
protected

◆ _isSupportingMotorCtrl

bool rp::standalone::rplidar::RPlidarDriverSerialImpl::_isSupportingMotorCtrl
protected

Definition at line 95 of file rplidar_driver_serial.h.

Referenced by connect(), startMotor(), and stopMotor().

◆ _lock

rp::hal::Locker rp::standalone::rplidar::RPlidarDriverSerialImpl::_lock
protected

◆ _rxtx

rp::hal::serial_rxtx* rp::standalone::rplidar::RPlidarDriverSerialImpl::_rxtx
protected



Page generated by Doxygen 1.8.14 for MRPT 1.5.7 Git: 5902e14cc Wed Apr 24 15:04:01 2019 +0200 at lun oct 28 01:39:17 CET 2019