adafruit-circuitpython-lidarlite

Introduction

A CircuitPython & Python library for Garmin LIDAR Lite sensors over I2C

Does not work with Lidar Lite v4 at this time, no ETA when it may be added - PRs accepted!

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-lidarlite

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-lidarlite

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-lidarlite

Usage Examples

V3 Example

import time
import board
import busio
import adafruit_lidarlite

# Create library object using our Bus I2C port
i2c = busio.I2C(board.SCL, board.SDA)

# Default configuration, with only i2c wires
sensor = adafruit_lidarlite.LIDARLite(i2c)

while True:
    try:
        # We print tuples so you can plot with Mu Plotter
        print((sensor.distance,))
    except RuntimeError as e:
        # If we get a reading error, just print it and keep truckin'
        print(e)
    time.sleep(0.01) # you can remove this for ultra-fast measurements!

V3 HP Example

import time
import busio
import board
import adafruit_lidarlite

i2c = busio.I2C(board.SCL, board.SDA)

sensor = adafruit_lidarlite.LIDARLite(i2c, sensor_type=adafruit_lidarlite.TYPE_V3HP)

while True:
    try:
        print(f"Sensor ID#: {sensor.unit_id}")
        print(f"Distance = {sensor.distance}")
        print(f"  Strength: {sensor.signal_strength}")
    except RuntimeError as e:
        print(e)
    try:
        print(f"Status: 0b{sensor.status:b}")
        print(f"  Busy: {bool(sensor.status & adafruit_lidarlite.STATUS_BUSY_V3HP)}")
        print(f"  Overflow: {bool(sensor.status & adafruit_lidarlite.STATUS_SIGNAL_OVERFLOW_V3HP)}")
        print(f"  Health: 0b{sensor.health_status:b}")
        print(f"  Power Control: 0b{sensor.power_control:b}")
        print(f"  I2C Config: 0b{sensor.i2c_config:b}")
        print(f"  Test Command: 0b{sensor.test_command:b}")
        print(f"  Correlation: 0b{sensor.correlation_data}")
    except RuntimeError as e:
        print(e)

    print()
    time.sleep(1)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Release files for adafruit-circuitpython-lidarlite 1.3.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-lidarlite 1.3.7
File	Size	Uploaded
adafruit-circuitpython-lidarlite-1.3.7.tar.gz	28.3 kB	Dec 9, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-lidarlite 1.3.7
File	Interpreter	ABI	Platform	Reset
adafruit_circuitpython_lidarlite-1.3.7-py3-none-any.whl 7.2 kB Dec 9, 2023	Python 3	none	any	Details

Total release size: 35.5 kB

Release files / adafruit-circuitpython-lidarlite-1.3.7.tar.gz

Download URL	adafruit-circuitpython-lidarlite-1.3.7.tar.gz
Size	28.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`3aa04104a9aa1aa2e697cc3609d63549c4b611c09e84a7ec8cb6784242fc9bf1`
BLAKE2b-256 checksum How to use checksums	`050d8c4fd6fa3a6a10141874cb337f45696ba0cd6d6aac5470b5bfad2dd39ec7`
Upload date	Dec 9, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.7`

Release files / adafruit_circuitpython_lidarlite-1.3.7-py3-none-any.whl

Download URL	adafruit_circuitpython_lidarlite-1.3.7-py3-none-any.whl
Size	7.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2a6d6c40c4070211eda1535e0d8277f88393e8e106e55dac03aebfca85242221`
BLAKE2b-256 checksum How to use checksums	`e4106647f7b3b1acb37026632a1c0f70050673da01f8ba78531c9e131b700fe8`
Upload date	Dec 9, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.7`