Skip to main content

Library to interface with GoDirect devices via USB and BLE

Project description

godirect

A Python module for reading from Vernier Go Direct devices using USB or BLE.

Requirements

The following Python modules are required for godirect. They will be installed automatically as dependencies when installing godirect via pip.

  • vernierpygatt (fork of the pygatt project with a fix for the BGAPI on Windows)
  • hidapi

Installation

pip install godirect

Example Use

Connect to the first available USB device or closest BLE device within the default threshold and collect 10 samples from the default sensor.

from godirect import GoDirect
godirect = GoDirect()
device = godirect.get_device()
if device != None and device.open() and device.start():
	sensors = device.get_enabled_sensors()
	print("Connected to "+device.name)
	print("Reading 10 measurements")
	for i in range(0,10):
		if device.read():
			for sensor in sensors:
				print(sensor.sensor_description+": "+str(sensor.value))
	device.stop()
	device.close()
godirect.quit()

Note that you can choose to enable USB, BLE, or both.

godirect = GoDirect(use_ble=True, use_usb=True)

Here is how to obtain a list of GoDirectDevice objects from the BLE and/or USB backends.

# returns a list of GoDirectDevice objects
devices = godirect.list_devices()

Or you can let the library automatically find the nearest device for you.

# returns a GoDirectDevice on success or None on failure
mydevice = godirect.get_device()

# to adjust the BLE threshold pass in a minimum dB value
mydevice = godirect.get_device(threshold=-200)

Once a device is found or selected it must be opened.

# returns True on success or False on failure
mydevice.open()

Once a device is opened you can obtain a list of GoDirectSensor objects available on the device.

# returns a list of GoDirectSensor objects
sensors = mydevice.list_sensors()

Optionally you can select the sensors you want to collect from, otherwise the default sensor(s) will be used.

# pass a list of sensor numbers to enable
mydevice.enable_sensors([2,3,4])
# start measurements at the typical rate for the enabled sensors
mydevice.start() # returns True on success

# start measurements at 1000ms per sample
mydevice.start(period=1000)

# get a list of the GoDirectSensor objects that are enabled
mysensors = mydevice.get_enabled_sensors()

The read() method will block until data is returned so it is acceptable to read in a tight loop.

for i in range(0,10):
  # read() will append the measurement received to the values list in the GoDirectSensor object
  if mydevice.read():
    for sensor in mysensors:
			print(sensor.value)

The stop() method will stop data collection on the device. The close() method will disconnect the USB or BLE device. The quit() method will stop the USB or BLE backends gracefully.

Debugging

godirect uses the standard python logging module. You can set the logging verbosity to INFO or DEBUG to see more communication detail.

import logging
logging.basicConfig()
logging.getLogger('godirect').setLevel(logging.DEBUG)
logging.getLogger('pygatt').setLevel(logging.DEBUG)

Windows

The pygatt module uses the BGAPI backend to communicate with the BLE dongle. You might have to specify the COM port assigned to the BLE dongle if the auto-detection fails.

godirect = GoDirect(ble_com_port='COM9')

License

GNU General Public License v3 (GPLv3)

Vernier products are designed for educational use. Our products are not designed nor are they recommended for any industrial, medical, or commercial process such as life support, patient diagnosis, control of a manufacturing process, or industrial testing of any kind.

Maintainer

Generate pydocs from the docs folder with:

python -m pydoc -w godirect
python -m pydoc -w godirect.sensor
# etc

Upload to the PyPI test server: python setup.py sdist bdist_wheel && python -m twine upload dist/*

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

godirect-0.9.4.tar.gz (14.3 kB view hashes)

Uploaded Source

Built Distributions

godirect-0.9.4-py3.7.egg (36.3 kB view hashes)

Uploaded Source

godirect-0.9.4-py3-none-any.whl (27.9 kB view hashes)

Uploaded Python 3

Supported by

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