Project

rplidar

0.0
No release in over 3 years
Low commit activity in last 3 years
Tested on SLAMTEK RPLIDAR A2M8
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0

Runtime

 Project Readme

Rplidar

Build Status codecov Maintainability security Gem Version

Ruby implementation of SLAMTEK RPLIDAR lidar driver. Tested on A2M8 model.

Installation

Add this line to your application's Gemfile:

gem 'rplidar'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rplidar

Usage

Run bundle exec irb

require 'rplidar'

# for Mac OS
lidar = Rplidar::Driver.new('/dev/tty.SLAB_USBtoUART')
lidar.current_state

lidar.start_motor
lidar.scan
...
lidar.stop
lidar.stop_motor
lidar.close

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yura/rplidar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.