A CircuitPython & Python library for Garmin LIDAR Lite sensors over I2C.
Project description
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-lidarliteTo install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-lidarliteTo 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-lidarliteUsage 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 history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file adafruit-circuitpython-lidarlite-1.3.6.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-lidarlite-1.3.6.tar.gz
- Upload date:
- Size: 28.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 353ab4fdfaa16b8c7f3b6838797d09e10b61893dbb0493eb1b0edbeaf471d455 |
|
| MD5 | e97ce0d0346cc0a7a74218119f179d3b |
|
| BLAKE2b-256 | cf3ae99883f7083018651d9235a845e529e6377a3ae9a9fd28d0ed323c14d421 |
File details
Details for the file adafruit_circuitpython_lidarlite-1.3.6-py3-none-any.whl.
File metadata
- Download URL: adafruit_circuitpython_lidarlite-1.3.6-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | af10fdba3faeb90707313fc3cf551a1b8b4d1202b11ba85a52b373d64bf62926 |
|
| MD5 | 62d00d65ca0d9a43a47e3b811ecaca08 |
|
| BLAKE2b-256 | 07322375261faa4e90c0a98fe36f21e943577482692c0989e328e6a89e0c9d83 |
