plexus-python 0.11.4__tar.gz → 0.11.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {plexus_python-0.11.4 → plexus_python-0.11.5}/API.md +4 -2
- {plexus_python-0.11.4 → plexus_python-0.11.5}/CHANGELOG.md +17 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/PKG-INFO +4 -2
- {plexus_python-0.11.4 → plexus_python-0.11.5}/README.md +3 -1
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/__init__.py +1 -1
- {plexus_python-0.11.4 → plexus_python-0.11.5}/pyproject.toml +1 -1
- {plexus_python-0.11.4 → plexus_python-0.11.5}/skills/plexus/SKILL.md +5 -6
- {plexus_python-0.11.4 → plexus_python-0.11.5}/uv.lock +1 -1
- {plexus_python-0.11.4 → plexus_python-0.11.5}/.github/ISSUE_TEMPLATE/bug_report.yml +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/.github/ISSUE_TEMPLATE/feature_request.yml +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/.github/workflows/ci.yml +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/.github/workflows/publish.yml +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/.gitignore +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/AGENTS.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/CODE_OF_CONDUCT.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/CONTRIBUTING.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/LICENSE +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/SECURITY.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/.python-version +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/README.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/basic.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/can.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/i2c_bme280.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/mac_metrics.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/mavlink.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/mqtt.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/pyproject.toml +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/thermal_camera.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/examples/uv.lock +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/_log.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/batching.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/buffer.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/cameras/__init__.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/cameras/thermal.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/cli.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/client.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/config.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/plexus/ws.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/scripts/release.sh +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/scripts/setup.sh +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/scripts/verify_skills.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/skills/README.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/skills/plexus-dashboard/SKILL.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/skills/plexus-firmware/SKILL.md +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/conftest.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_basic.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_batching.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_batching_wire.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_buffer.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_cli_diagnostics.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_config.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_isolation.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_rate_limit.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_retry.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_runs.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_skills.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_thermal.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_video.py +0 -0
- {plexus_python-0.11.4 → plexus_python-0.11.5}/tests/test_ws.py +0 -0
|
@@ -165,7 +165,7 @@ For real-time UI-controlled streaming, devices connect via WebSocket.
|
|
|
165
165
|
1. Device connects to the gateway
|
|
166
166
|
2. Device authenticates with API key (and advertises any registered commands)
|
|
167
167
|
3. Device streams `telemetry` frames
|
|
168
|
-
4.
|
|
168
|
+
4. Plexus invokes registered commands via `typed_command` (see the note under Commands)
|
|
169
169
|
|
|
170
170
|
### Device Authentication
|
|
171
171
|
|
|
@@ -227,7 +227,9 @@ Devices authenticate using an API key. The gateway echoes the declared `source_i
|
|
|
227
227
|
|
|
228
228
|
### Commands
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
Commands reach the device as a single `typed_command` envelope; the device replies with `command_result` frames. Register handlers with `px.on_command(...)` before the first `send()`.
|
|
231
|
+
|
|
232
|
+
> **Note:** the public API route for sending commands (`POST /v1/sources/{id}/commands`) was turned off on 2026-09-21 and returns `410 Gone`. Nothing in Plexus can currently trigger a custom handler.
|
|
231
233
|
|
|
232
234
|
```json
|
|
233
235
|
// Server → Device
|
|
@@ -2,6 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased]
|
|
4
4
|
|
|
5
|
+
## [0.11.5] - 2026-09-21 - The commands API is off
|
|
6
|
+
|
|
7
|
+
No code changes. The docs described a way to send commands to a device that
|
|
8
|
+
no longer exists.
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- **`POST /v1/sources/{id}/commands` is turned off, and the docs now say so.**
|
|
13
|
+
Plexus turned the endpoint off on 2026-09-21. It returns `410 Gone`.
|
|
14
|
+
Any API key of any scope could send any command name to any device in
|
|
15
|
+
the org, which is not safe for commands that reach hardware.
|
|
16
|
+
- The agent skill no longer offers to send commands, and it tells agents
|
|
17
|
+
not to call the endpoint.
|
|
18
|
+
- README and `API.md` say plainly that nothing in Plexus can currently
|
|
19
|
+
trigger an `on_command` handler.
|
|
20
|
+
- `on_command` itself is unchanged.
|
|
21
|
+
|
|
5
22
|
## [0.11.4] - 2026-09-08 - Docs that actually work
|
|
6
23
|
|
|
7
24
|
No code changes. Every edit here is documentation or dead weight, but the
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: plexus-python
|
|
3
|
-
Version: 0.11.
|
|
3
|
+
Version: 0.11.5
|
|
4
4
|
Summary: Thin Python SDK for Plexus — send telemetry in one line
|
|
5
5
|
Project-URL: Homepage, https://plexus.company
|
|
6
6
|
Project-URL: Documentation, https://docs.plexus.company
|
|
@@ -255,7 +255,7 @@ px.send("temperature", 72.5, timestamp=t) # your timestamp, used as-is, no cor
|
|
|
255
255
|
By default the SDK connects over a **WebSocket** to `/ws/device` on the gateway — the gateway's device wire protocol. This gives you:
|
|
256
256
|
|
|
257
257
|
- lower-latency streaming of telemetry,
|
|
258
|
-
-
|
|
258
|
+
- the channel that will carry actions triggered from a Plexus dashboard.
|
|
259
259
|
|
|
260
260
|
If the socket is unavailable, sends transparently fall back to `POST /ingest` so no data is lost.
|
|
261
261
|
|
|
@@ -283,6 +283,8 @@ px.send("temperature", 72.5) # opens the socket, waits for auth
|
|
|
283
283
|
|
|
284
284
|
The SDK sends an `ack` frame before invoking the handler, then a `result` frame with whatever the handler returns (or an `error` frame if it raises).
|
|
285
285
|
|
|
286
|
+
> **Note:** nothing in Plexus can currently trigger a custom handler. The API route for sending commands was turned off on 2026-09-21. Triggering handlers from a dashboard, with permissions and a record of every run, is being rebuilt.
|
|
287
|
+
|
|
286
288
|
## Environment Variables
|
|
287
289
|
|
|
288
290
|
| Variable | Description | Default |
|
|
@@ -218,7 +218,7 @@ px.send("temperature", 72.5, timestamp=t) # your timestamp, used as-is, no cor
|
|
|
218
218
|
By default the SDK connects over a **WebSocket** to `/ws/device` on the gateway — the gateway's device wire protocol. This gives you:
|
|
219
219
|
|
|
220
220
|
- lower-latency streaming of telemetry,
|
|
221
|
-
-
|
|
221
|
+
- the channel that will carry actions triggered from a Plexus dashboard.
|
|
222
222
|
|
|
223
223
|
If the socket is unavailable, sends transparently fall back to `POST /ingest` so no data is lost.
|
|
224
224
|
|
|
@@ -246,6 +246,8 @@ px.send("temperature", 72.5) # opens the socket, waits for auth
|
|
|
246
246
|
|
|
247
247
|
The SDK sends an `ack` frame before invoking the handler, then a `result` frame with whatever the handler returns (or an `error` frame if it raises).
|
|
248
248
|
|
|
249
|
+
> **Note:** nothing in Plexus can currently trigger a custom handler. The API route for sending commands was turned off on 2026-09-21. Triggering handlers from a dashboard, with permissions and a record of every run, is being rebuilt.
|
|
250
|
+
|
|
249
251
|
## Environment Variables
|
|
250
252
|
|
|
251
253
|
| Variable | Description | Default |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: plexus
|
|
3
|
-
description: Integrate with the Plexus telemetry API — send data, query metrics, subscribe to live streams
|
|
3
|
+
description: Integrate with the Plexus telemetry API — send data, query metrics, subscribe to live streams. Use when the user mentions Plexus, plexus.company, gateway.plexus.company, plexus-data-api.fly.dev, or plx_ API keys. ALSO USE when the request involves IoT/hardware telemetry, fleet observability, sending sensor data to a backend, querying device time-series, building a fleet dashboard, monitoring drones/satellites/robots/edge devices, or any phrase like "send my sensor readings somewhere", "store telemetry", "track a fleet", "ingest metrics", or "device observability" — even if "Plexus" is never said.
|
|
4
4
|
tools: Read, Write, Edit, Bash, WebFetch
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@ Plexus is a telemetry/observability platform for hardware fleets (drones, satell
|
|
|
13
13
|
Trigger on any of:
|
|
14
14
|
|
|
15
15
|
- The user mentions "Plexus", "plexus.company", `plx_` keys, `gateway.plexus.company`, or `plexus-data-api.fly.dev`
|
|
16
|
-
- The user wants to ingest telemetry, query device metrics, stream live points
|
|
16
|
+
- The user wants to ingest telemetry, query device metrics, or stream live points
|
|
17
17
|
- The user is building a dashboard, alert pipeline, or analysis on top of fleet telemetry
|
|
18
18
|
- The user pastes a Plexus curl example and asks for help
|
|
19
19
|
|
|
@@ -27,7 +27,7 @@ Two base URLs. Authenticate with an `x-api-key` header on HTTP.
|
|
|
27
27
|
| Purpose | Host |
|
|
28
28
|
| -------------------------------------------------- | -------------------------------- |
|
|
29
29
|
| Ingest | `https://gateway.plexus.company` |
|
|
30
|
-
| Read API (sources, metrics, logs, fleet,
|
|
30
|
+
| Read API (sources, metrics, logs, fleet, live stream) | `https://plexus-data-api.fly.dev` |
|
|
31
31
|
|
|
32
32
|
```
|
|
33
33
|
x-api-key: plx_...
|
|
@@ -141,9 +141,9 @@ You do **not** need to answer application-level pings on this endpoint; keepaliv
|
|
|
141
141
|
|
|
142
142
|
The gateway's own sockets (`/ws/device`, `/ws/browser`) are for the Python SDK and the Plexus app respectively. Don't write third-party clients against them. There is no `/v1/stream` on the gateway.
|
|
143
143
|
|
|
144
|
-
### Control
|
|
144
|
+
### Control
|
|
145
145
|
|
|
146
|
-
`POST /v1/sources/{id}/commands`
|
|
146
|
+
There is no API for sending commands to devices. `POST /v1/sources/{id}/commands` was turned off and returns `410 Gone`. Don't write code that calls it, and don't offer to trigger device behavior through the API.
|
|
147
147
|
|
|
148
148
|
## Standard scaffolding
|
|
149
149
|
|
|
@@ -216,7 +216,6 @@ let the pipeline settle first.
|
|
|
216
216
|
- **Telemetry frames are batched** — `points` is an array. Handling one frame as one point silently drops data.
|
|
217
217
|
- `start`/`end` are **ISO date-times on every endpoint** that takes them — `query`, `logs` and `fleet/metrics` alike. `last=1h` is easier and works on all three.
|
|
218
218
|
- `auto_downsampled: true` in a query response means the bucket size was picked for you — surface it in the UI so users understand what they're looking at.
|
|
219
|
-
- Commands queue on the device; they don't execute synchronously. Don't promise the user "it rebooted" — promise "reboot queued".
|
|
220
219
|
|
|
221
220
|
## When unsure
|
|
222
221
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|