| Name | godirect JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | None |
| Summary | Library to interface with GoDirect devices via USB and BLE |
| upload_time | 2025-09-05 00:09:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
godirect
vernier
usb
ble
bluetooth
sensors
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# godirect
A Python module for reading from [Vernier Go Direct® Sensors](https://www.vernier.com/products/sensors/go-direct-sensors/)<sup>1</sup> connected to USB or your system's on-board bluetooth radio. The module has been tested on Windows 10, macOS, and various Linux distros.
Take a look at the [godirect-examples repository](https://github.com/VernierST/godirect-examples/tree/main/python) for ideas and a number of helpful examples.
## Requirements
The following Python modules are required for `godirect`. They will be installed automatically as dependencies when installing `godirect` via pip.
* bleak (native Bluetooth Low Energy stack for Mac, Windows and Linux)
* hidapi (USB HID device support)
## Installation
Automatically install all the dependencies for both USB and native BLE.
```bash
pip install godirect
```
## Installation and Usage
Go to our [Getting Started with Vernier Go Direct Sensors and Python document](https://github.com/VernierST/godirect-examples/blob/main/python/readme.md) for detailed information regarding installation and usage of the godirect module.
## Legacy Support for Bluegiga Dongle
Prior to version 1.1.0, some platforms required a Bluegiga BLE dongle to connect over BLE. While we recommend using the native BLE radio (through bleak), the old functionality has been left in the library. In order to use the Bluegiga BLE dongle, vernierpygatt must be installed. This is a fork of the pygatt project with a fix for the BGAPI on Windows. See [the vernierpygatt PyPi page](https://pypi.org/project/vernierpygatt/) for details.
## Local builds
In order to explore and contribute to this module, you can modify this module, build and install it locally.
_# Uninstall any installed version_
```bash
pip uninstall godirect
```
_# Install the build tool (if you have not already)_
```bash
pip install build
```
_# Build the module_
```bash
python -m build
```
_# Install the module_
```bash
pip install .
```
## 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.
<sup>1</sup> Go Direct spectrometers are not supported.
Raw data
{
"_id": null,
"home_page": null,
"name": "godirect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Vernier Software and Technology <info@vernier.com>",
"keywords": "godirect, vernier, usb, ble, bluetooth, sensors",
"author": null,
"author_email": "Vernier Software and Technology <info@vernier.com>",
"download_url": "https://files.pythonhosted.org/packages/a9/1d/2683f6c0f1add36079c27ef5485131a9d646dd760a1ebda7c9f712786cae/godirect-1.2.1.tar.gz",
"platform": null,
"description": "# godirect\n\nA Python module for reading from [Vernier Go Direct\u00ae Sensors](https://www.vernier.com/products/sensors/go-direct-sensors/)<sup>1</sup> connected to USB or your system's on-board bluetooth radio. The module has been tested on Windows 10, macOS, and various Linux distros.\n\nTake a look at the [godirect-examples repository](https://github.com/VernierST/godirect-examples/tree/main/python) for ideas and a number of helpful examples.\n\n## Requirements\n\nThe following Python modules are required for `godirect`. They will be installed automatically as dependencies when installing `godirect` via pip.\n\n* bleak (native Bluetooth Low Energy stack for Mac, Windows and Linux)\n* hidapi (USB HID device support)\n\n## Installation\n\nAutomatically install all the dependencies for both USB and native BLE.\n```bash\npip install godirect\n```\n\n## Installation and Usage\n\nGo to our [Getting Started with Vernier Go Direct Sensors and Python document](https://github.com/VernierST/godirect-examples/blob/main/python/readme.md) for detailed information regarding installation and usage of the godirect module.\n\n## Legacy Support for Bluegiga Dongle\n\nPrior to version 1.1.0, some platforms required a Bluegiga BLE dongle to connect over BLE. While we recommend using the native BLE radio (through bleak), the old functionality has been left in the library. In order to use the Bluegiga BLE dongle, vernierpygatt must be installed. This is a fork of the pygatt project with a fix for the BGAPI on Windows. See [the vernierpygatt PyPi page](https://pypi.org/project/vernierpygatt/) for details.\n\n## Local builds\n\nIn order to explore and contribute to this module, you can modify this module, build and install it locally.\n\n_# Uninstall any installed version_\n```bash\npip uninstall godirect\n```\n\n_# Install the build tool (if you have not already)_\n```bash\npip install build\n```\n\n_# Build the module_\n```bash\npython -m build\n```\n\n_# Install the module_\n```bash\npip install .\n```\n\n## License\n\nGNU General Public License v3 (GPLv3)\n\nVernier 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.\n\n<sup>1</sup> Go Direct spectrometers are not supported.\n",
"bugtrack_url": null,
"license": null,
"summary": "Library to interface with GoDirect devices via USB and BLE",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/vernierst/godirect-py",
"Repository": "https://github.com/vernierst/godirect-py"
},
"split_keywords": [
"godirect",
" vernier",
" usb",
" ble",
" bluetooth",
" sensors"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c371410010d143517709b13da22b212db98f1c9388cf33735b186053a644d6ab",
"md5": "ac41b854f669dd0903f945ab987c369e",
"sha256": "79e31737fede29c011945f031b450cc70ad5c49e7beef2e2c35e50dbba814ffd"
},
"downloads": -1,
"filename": "godirect-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac41b854f669dd0903f945ab987c369e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 37353,
"upload_time": "2025-09-05T00:09:29",
"upload_time_iso_8601": "2025-09-05T00:09:29.613175Z",
"url": "https://files.pythonhosted.org/packages/c3/71/410010d143517709b13da22b212db98f1c9388cf33735b186053a644d6ab/godirect-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a91d2683f6c0f1add36079c27ef5485131a9d646dd760a1ebda7c9f712786cae",
"md5": "76dc7f5b3cf29c15b7d68ad0c433ec50",
"sha256": "d8fac756cd782659a6ae11e0abb1c8d80924bdb2d08d8edffca5fcaa5f8a2201"
},
"downloads": -1,
"filename": "godirect-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "76dc7f5b3cf29c15b7d68ad0c433ec50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 33808,
"upload_time": "2025-09-05T00:09:30",
"upload_time_iso_8601": "2025-09-05T00:09:30.938331Z",
"url": "https://files.pythonhosted.org/packages/a9/1d/2683f6c0f1add36079c27ef5485131a9d646dd760a1ebda7c9f712786cae/godirect-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 00:09:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vernierst",
"github_project": "godirect-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "godirect"
}
