This release is a pre-release and may not be stable for production use.
Helium Positioning API
Features
Prediction of the location of devices belonging to an organization in the Helium Console. Several different methods and models are available.
Installation
Developer install
The following allows a user to create a developer install of the positioning api.
pip install -r requirements.txt
poetry install
poetry shell
pip install git+https://github.com/emergotechnologies/helium-api-wrapper
Prerequisites
Before use, ensure that there is an .env file in the root directory of the repository where the API_KEY variable is entered (see .env.sample). You can generate and copy the API_KEY at https://console.helium.com/profile.
Usage
The service allows usage via command line interface or locally hosted REST interface.
CLI
Get Device Position
python -m helium_positioning_api predict --uuid 92f23793-6647-40aa-b255-fa1d4baec75d
Currently defaults to the "nearest_neighbor" model.
Advanced Requests
The location prediction command is
python -m helium_positioning_api predict --uuid 'your uuid' --model 'your model selection'
See the table below for a list of currently available models.
| Model | Position estimation explanation | Suggested use |
|---|---|---|
| nearest_neighbor | Location of hotspot with the best signal | Purchase of at most one packet from a device (see Packet Configurations for more details) |
| midpoint | Point of equal distance from the two hotspots with the best signals | Purchase of at least two packets from a device (see Packet Configurations for more details) |
| linear_regression (experimental) | Trilateration with an linear regression distance estimator | Experimental. Purchase of at least three packets from a device (see Packet Configurations for more details) |
| gradient_boosting (experimental) | Trilateration with a gradient boosted regression distance estimator | Experimental. Purchase of at least three packets from a device (see Packet Configurations for more details) |
REST-API
- Start local REST-API (default)
python -m helium_positioning_api serve - Open Browser and navigate to
127.0.0.1:8000/docs - Click on
predict_tfpath to drop down the endpoint details - Click on the
Try it outbutton. - Fill in the
uuidof your device and click on the buttonExecuteto get an estimation using thenearest_neighbormodel - You can see the location prediction response in the
Responsessection below.
The mapping of available models to paths can be seen in the table below.
| model | path |
|---|---|
| nearest_neighbor | predict_tf |
| midpoint | predict_mp |
| linear_regression | predict_tl_lin |
| gradient_boosting | predict_tl_grad |
Contributing
Contributions are very welcome. To learn more, see the Contributor Guide.
License
Distributed under the terms of the MIT license, Helium Positioning API is free and open source software.
Issues
If you encounter any problems, please file an issue along with a detailed description.
Credits
This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.
1 maintainer
Metadata
1 maintainer
Release files for helium-positioning-api 0.0.2.dev1677683454
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| helium_positioning_api-0.0.2.dev1677683454.tar.gz | 13.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| helium_positioning_api-0.0.2.dev1677683454-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.3 kB
Release files / helium_positioning_api-0.0.2.dev1677683454.tar.gz
| Download URL | helium_positioning_api-0.0.2.dev1677683454.tar.gz |
|---|---|
| Size | 13.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
04dd05a317425a4baa860467d7076ca6671a1a242e8ababaab7867cc98f4df78
|
|
BLAKE2b-256 checksum How to use checksums |
1abe0ba80ec29207d793bf6f9c03149e64ffaf53560810e9491dc34cd1567ff0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / helium_positioning_api-0.0.2.dev1677683454-py3-none-any.whl
| Download URL | helium_positioning_api-0.0.2.dev1677683454-py3-none-any.whl |
|---|---|
| Size | 13.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
da5eaf5587fd4d21d8f9dc4c7f2047875e18aca98d357e9e0e0500f0ebe83735
|
|
BLAKE2b-256 checksum How to use checksums |
25061accdc875d0a361c6fce7c4eb4e4d1a0237a0163cd33f6cd1f151fb570b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
