Helium Positioning API
Project description
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_tf
path to drop down the endpoint details - Click on the
Try it out
button. - Fill in the
uuid
of your device and click on the buttonExecute
to get an estimation using thenearest_neighbor
model - You can see the location prediction response in the
Responses
section 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.
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 helium_positioning_api-0.0.2.dev1677238889.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9af03f7245e39db49046f1883b1f884ab6e2c7e3fa952a9c8168e740cf99c932 |
|
MD5 | b04b03ec15f78d2299afef4ce5d37e6d |
|
BLAKE2b-256 | 0352b9b709d5376b306670b998c6a2725ddfd4c5ac5e35c4fa8a8e4ccceaea53 |
Hashes for helium_positioning_api-0.0.2.dev1677238889-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 397601f03bc0278d2899c59515b9aa693360096561159bfe00949684b1d3ea66 |
|
MD5 | c533af04e5c17548acbd2ed488871b0d |
|
BLAKE2b-256 | 5b3ae6c95c31e518f61c0f60413319c2c235f0bd2c476ef2390c3e394cb350a4 |