Python SDK for NimbusOS.
Project description
NimbusOS Python SDK
This is the first narrow Python SDK surface for NimbusOS pubsub.
V1 supports:
- Subscribe to
telemetry - Subscribe to
state - Subscribe to
camera - Publish
guidance_request - Publish
waypoint_command
It does not expose raw pubsub publishing, all-topic subscription, legacy route messages, navigation request messages, or internal control topics.
Install
cd NimbusOS/sdk
uv sync
Subscribe
cd NimbusOS/sdk
uv run nimbusos-subscribe telemetry
uv run nimbusos-subscribe state
uv run nimbusos-subscribe camera
Publish Guidance Requests
cd NimbusOS/sdk
uv run nimbusos-guidance-request go
uv run nimbusos-guidance-request land
uv run nimbusos-guidance-request return_home
Guidance can also request a relative waypoint:
cd NimbusOS/sdk
uv run nimbusos-guidance-request relative_waypoint --forward 1.5 --right 0.0 --down -1.0
Publish Waypoint Commands
cd NimbusOS/sdk
uv run nimbusos-waypoint-command --mode override --forward 1.5 --right 0.0 --down -1.0
uv run nimbusos-waypoint-command --mode queue --forward 1.0 --right 0.5 --down -1.0
Waypoint command fields match the core schema:
forward: meters forward/back in the drone's current body headingright: meters right/left in the drone's current body headingdown: absolute local-frame down targetmode=override: replace the active waypointmode=queue: append after the active waypoint
Endpoints
The client uses these defaults:
- publish:
tcp://127.0.0.1:7771 - subscribe:
tcp://127.0.0.1:7772
You can override them with:
DF_ZMQ_PUB_ENDPOINTDF_ZMQ_SUB_ENDPOINT
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nimbusos_sdk-0.1.0.tar.gz.
File metadata
- Download URL: nimbusos_sdk-0.1.0.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
257108ddc55a84671798d7b1026e6fe727f800402bfca58035bed06658a008af
|
|
| MD5 |
399d659328836c6071c7ac8a1f697e42
|
|
| BLAKE2b-256 |
886731a88e084bab62a5e74b5a8cbeedde2dbd2d7c9cd2f6deb6dc86f877a627
|
File details
Details for the file nimbusos_sdk-0.1.0-py3-none-any.whl.
File metadata
- Download URL: nimbusos_sdk-0.1.0-py3-none-any.whl
- Upload date:
- Size: 31.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e0045f261fe606072f2f3e075728dc6c76462544222a53561283d1870e55e4b7
|
|
| MD5 |
eebd6532a7f1e7c70ee59e2e2ff3fe0a
|
|
| BLAKE2b-256 |
efeb4cbd0f36484026eeddfd914addf685758808ed626221b38af36ef739b9d7
|