Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_lidarlite-1.3.11.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_lidarlite-1.3.11.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_lidarlite-1.3.11.tar.gz
Algorithm Hash digest
SHA256 3a1c154b6fa735281632875c5a8ca9b61edbe308520b728a8b5e73e977182d7c
MD5 b998ea955f97090808fa48431c142495
BLAKE2b-256 22e7bb9eab38b3c686cd92135670d747e5b8120eb00606018ba29786d4c25987

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_lidarlite-1.3.11-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_lidarlite-1.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 783fef0e0cbf869fe67ec104fd04cc2a1c4fc96538297d09a125f391af9a9b91
MD5 8f7713f43fbe72ae52dfb74c67b2b9af
BLAKE2b-256 f729413ba9e791c32941353e1412af2c05baac58d76034832b32d9a6894adad1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page