Python async interface to Loadstar Sensors USB devices.
Project description
About
- Python Package Name: loadstar_sensors_interface
- Description: Python async interface to Loadstar Sensors USB devices.
- Version: 1.0.0
- Release Date: 2023-01-31
- Creation Date: 2022-08-16
- License: BSD-3-Clause
- URL: https://github.com/janelia-pypi/loadstar_sensors_interface_python
- Author: Peter Polidoro
- Email: peter@polidoro.io
- Copyright: 2023 Howard Hughes Medical Institute
- References:
- https://pyserial-asyncio.readthedocs.io/en/latest/
- https://tinkering.xyz/async-serial/
- https://www.loadstarsensors.com/
- https://www.loadstarsensors.com/di-100u-di-1000u-command-set.html
- Dependencies:
- pyserial-asyncio
- click
Example Usage
Python
from loadstar_sensors_interface import LoadstarSensorsInterface
import asyncio
async def my_sensor_value_callback(sensor_value):
print(f'my_sensor_value_callback: {sensor_value}')
await asyncio.sleep(0)
async def example():
dev = LoadstarSensorsInterface()
await dev.open_high_speed_serial_connection(port='/dev/ttyUSB0')
await dev.tare()
dev.start_getting_sensor_values(my_sensor_value_callback)
await asyncio.sleep(4)
await dev.stop_getting_sensor_values()
count = dev.get_sensor_value_count()
duration = dev.get_sensor_value_duration()
rate = dev.get_sensor_value_rate()
print(f'{count} sensor values in {duration}s at a rate of {rate}Hz')
await dev.print_device_info()
asyncio.run(example())
Command Line
help
loadstar --help
# Usage: loadstar [OPTIONS]
# Command line interface for loadstar sensors.
# Options:
# -p, --port TEXT Device name (e.g. /dev/ttyUSB0 on GNU/Linux or COM3
# on Windows)
# -H, --high-speed Open serial port with high speed baudrate.
# -d, --debug Print debugging information.
# -i, --info Print the device info and exit
# -T, --tare Tare before getting sensor values.
# -d, --duration INTEGER Duration of sensor value measurements in seconds.
# [default: 10]
# -h, --help Show this message and exit.
device info
# DI-100, DI-1000
loadstar --port /dev/ttyUSB0 --info
# DI-1000UHS
loadstar --port /dev/ttyUSB0 --high-speed --info
example usage
# DI-100, DI-1000
loadstar --port /dev/ttyUSB0 --tare --duration 10
# DI-1000UHS
loadstar --port /dev/ttyUSB0 --high-speed --tare --duration 10
Installation
https://github.com/janelia-pypi/python_setup
GNU/Linux
Drivers
GNU/Linux computers usually have all of the necessary drivers already installed, but users need the appropriate permissions to open the device and communicate with it.
Udev is the GNU/Linux subsystem that detects when things are plugged into your computer.
Udev may be used to detect when a loadstar sensor is plugged into the computer and automatically give permission to open that device.
If you plug a sensor into your computer and attempt to open it and get an error such as: "FATAL: cannot open /dev/ttyUSB0: Permission denied", then you need to install udev rules to give permission to open that device.
Udev rules may be downloaded as a file and placed in the appropriate directory using these instructions:
-
Download rules into the correct directory
curl -fsSL https://raw.githubusercontent.com/platformio/platformio-core/master/scripts/99-platformio-udev.rules | sudo tee /etc/udev/rules.d/99-platformio-udev.rules
-
Restart udev management tool
sudo service udev restart
-
Ubuntu/Debian users may need to add own “username” to the “dialout” group
sudo usermod -a -G dialout $USER sudo usermod -a -G plugdev $USER
-
After setting up rules and groups
You will need to log out and log back in again (or reboot) for the user group changes to take effect.
After this file is installed, physically unplug and reconnect your board.
Python Code
The Python code in this library may be installed in any number of ways, chose one.
-
pip
python3 -m venv ~/venvs/loadstar_sensors_interface source ~/venvs/loadstar_sensors_interface/bin/activate pip install loadstar_sensors_interface
-
guix
Setup guix-janelia channel:
https://github.com/guix-janelia/guix-janelia
guix install python-loadstar-sensors-interface
Windows
Drivers
Download and install Windows driver:
Loadstar Sensors Windows Driver
Python Code
The Python code in this library may be installed in any number of ways, chose one.
-
pip
python3 -m venv C:\venvs\loadstar_sensors_interface C:\venvs\loadstar_sensors_interface\Scripts\activate pip install loadstar_sensors_interface
Development
Install Guix
Clone Repository
git clone https://github.com/janelia-pypi/loadstar_sensors_interface_python
cd loadstar_sensors_interface_python
Make alias
source .metadata/.alias
Edit metadata.org
,make metadata-edits
Tangle metadata.org
,make metadata
Test Python package using ipython shell
,make ipython-shell
import loadstar_sensors_interface
exit
Test installation of Guix package
,make installed-shell
exit
Upload Python package to pypi
,make upload
Test direct device interaction using serial terminal
Low Speed
DI-100, DI-1000
,make serial-shell # PORT=/dev/ttyUSB0
# ,make PORT=/dev/ttyUSB1 serial-shell
? # help
settings
[C-a][C-x] # to exit
High Speed
DI-1000UHS
,make serial-shell-hs # PORT=/dev/ttyUSB0
# ,make PORT=/dev/ttyUSB1 serial-shell-hs
? # help
settings
[C-a][C-x] # to exit
Test Python package using ipython shell and serial port
,make ipython-shell-port # PORT=/dev/ttyUSB0
# ,make PORT=/dev/ttyUSB1 ipython-shell-port
import loadstar_sensors_interface
exit
Test installation of Guix package and serial port
,make installed-shell-port # PORT=/dev/ttyUSB0
# ,make PORT=/dev/ttyUSB1 installed-shell-port
exit
Project details
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
Hashes for loadstar_sensors_interface-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5718e465a17ca4e6a4004191bae61c73394762ca0e011e6b276f03cb3d89f42d |
|
MD5 | a6db88a87ba9eb58a55351be8113e3d4 |
|
BLAKE2b-256 | 0f103f0c0706123a813138c51824402a0726217f61cd47e89acfd86b99cb7860 |
Hashes for loadstar_sensors_interface-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdd746d923730f38158ba02e31327a79063c156cba36fd3340c435a1a633b607 |
|
MD5 | 876a1d1b5e3a2245bc89de70da038fb6 |
|
BLAKE2b-256 | a9f2caeeb8479319351b5c46e17a2dd207656b15f2a12ddba1d0531a459d505d |