Metadata-Version: 2.1
Name: adafruit-circuitpython-rplidar
Version: 1.2.0
Summary: RPLidar support
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_rplidar
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-rplidar/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/rplidar/en/latest/
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/discord/327254708534116352.svg
            :target: https://adafru.it/discord
            :alt: Discord
        
        .. image:: https://github.com/adafruit/Adafruit_CircuitPython_RPLIDAR/workflows/Build%20CI/badge.svg
            :target: https://github.com/adafruit/Adafruit_CircuitPython_RPLIDAR
            :alt: Build Status
        
        .. Provide a convenient interface to the Slamtec RPLidar.
        
        Dependencies
        =============
        This driver depends on:
        
        * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
        * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
        * `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
        
        Please ensure all dependencies are available on the CircuitPython filesystem.
        This is easily achieved by downloading
        `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
        
        Usage Example
        =============
        
        .. code-block:: python
        
            import os
            from math import floor
            from adafruit_rplidar import RPLidar
        
        
            # Setup the RPLidar
            PORT_NAME = '/dev/ttyUSB0'
            lidar = RPLidar(None, PORT_NAME, timeout=3)
        
            # used to scale data to fit on the screen
            max_distance = 0
        
            def process_data(data):
                print(data)
        
            scan_data = [0]*360
        
            try:
            #    print(lidar.get_info())
                for scan in lidar.iter_scans():
                    for (_, angle, distance) in scan:
                        scan_data[min([359, floor(angle)])] = distance
                    process_data(scan_data)
        
            except KeyboardInterrupt:
                print('Stopping.')
            lidar.stop()
            lidar.disconnect()
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_RPLIDAR/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
        
Keywords: adafruit blinka circuitpython micropython rplidar lidar sensors
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
