> For the complete documentation index, see [llms.txt](https://droneforge.gitbook.io/droneforge-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://droneforge.gitbook.io/droneforge-docs/nimbusos-sdk/python-api.md).

# Python API

## Table of Contents

* [Setup](/droneforge-docs/nimbusos-sdk/python-api/setup.md)
* [Quick Start](/droneforge-docs/nimbusos-sdk/python-api/quick-start.md)
* [Publishing](/droneforge-docs/nimbusos-sdk/python-api/publishing.md)
* [API](/droneforge-docs/nimbusos-sdk/python-api/api.md)
* [Subscriptions](/droneforge-docs/nimbusos-sdk/python-api/subscriptions.md)
* [CLI](/droneforge-docs/nimbusos-sdk/python-api/cli.md)

The NimbusOS Python SDK is a small public wrapper around supported NimbusOS V1 ZeroMQ pub/sub topics.

Use it when a Python application, demo, smoke test, or integration needs to observe NimbusOS state or send supported high-level commands.

## What you get

The package includes:

* `NimbusClient`, the main class for publishing commands and subscribing to messages.
* Typed Python dataclasses for common receive workflows.
* Command-line tools for smoke testing and manual command publishing.

## Supported subscriptions

Use typed helpers for application code. They return stable Python dataclasses.

| Topic             | Helper                        | Description                                                      |
| ----------------- | ----------------------------- | ---------------------------------------------------------------- |
| `telemetry`       | `client.telemetry()`          | Battery, attitude, and link telemetry.                           |
| `selected_state`  | `client.selected_state()`     | Local-frame position, velocity, attitude, and orientation state. |
| `camera`          | `client.camera_frames()`      | Core-selected JPEG camera stream.                                |
| `live_camera`     | `client.live_camera_frames()` | Raw live camera JPEG stream before core camera-source selection. |
| `waypoint_status` | `client.waypoint_status()`    | Active waypoint progress and reached/held status.                |
| `autonomy_status` | `client.autonomy_status()`    | Current autonomy state such as landing or stopped states.        |

## Supported publications

Publishing methods encode NimbusOS command messages and send them to the configured publish endpoint.

| Topic              | Method                               | Description                                                       |
| ------------------ | ------------------------------------ | ----------------------------------------------------------------- |
| `arm_state`        | `client.publish_arm_state()`         | Publish armed or disarmed state.                                  |
| `autonomy_request` | `client.publish_autonomy_request()`  | Request `takeoff`, `land`, `return_home`, or a relative waypoint. |
| `autonomy_request` | `client.publish_relative_waypoint()` | Convenience helper for body-frame relative waypoints.             |
| `waypoint_speed`   | `client.publish_waypoint_speed()`    | Set waypoint path speed from `0.05` to `0.75` meters per second.  |
| `yaw_turn_command` | `client.publish_yaw_turn_command()`  | Publish a relative yaw turn in radians.                           |
| `camera_overlay`   | `client.publish_camera_overlay()`    | Publish drawing instructions for camera inference overlays.       |

## Connection model

NimbusOS publishes and receives messages over ZeroMQ. By default, the SDK connects to a local NimbusOS instance.

| Direction | Default endpoint       |
| --------- | ---------------------- |
| Publish   | `tcp://127.0.0.1:7771` |
| Subscribe | `tcp://127.0.0.1:7772` |

Override these endpoints with environment variables or explicit `NimbusClient` constructor arguments.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://droneforge.gitbook.io/droneforge-docs/nimbusos-sdk/python-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.