Documentation

Guides, API references, and troubleshooting for the Pyvorin platform.

Filtered by intermediateClear filter
Tagged edgeClear filter
edge intermediate

Actions and Events — Responding to the Edge

Attach callables to edge rules and handle Event objects safely: fail-open semantics, retries, and idempotent actions that survive crashes.

13 min read

edge intermediate

Benchmarking with the Pyvorin Edge SDK

Benchmark Pyvorin Edge pipelines honestly: cost-model assumptions, warm-up discipline, a CI regression example, and micro-benchmark limits.

13 min read

guides intermediate

Edge and IoT Deployment

What pyvorin-native 1.0.9 can and cannot do at the edge: platform support, compile-then-deploy, offline licensing, and measured IoT benchmark numbers.

edge intermediate

Edge Configuration Reference

Every EdgeAgent configuration key explained: polling, storage, upload, dashboard, and licence settings, with reload caveats and examples.

22 min read

edge intermediate

Field Redaction Patterns

Five field-level redaction actions for edge telemetry — drop, mask, hash, generalise, tokenise — with performance notes and ordering pitfalls.

16 min read

edge intermediate

FileReplayAdapter — Time-Travel for Sensor Data

Replay recorded sensor data through a live pipeline with FileReplayAdapter: pacing modes, loop behaviour, and reproducible tests.

12 min read

edge intermediate

HTTPAdapter — REST, Webhooks, and Polling Ingest

HTTPAdapter for edge pipelines: inbound REST and webhook ingest, outbound polling, authentication headers, TLS, and key security notes.

14 min read

edge intermediate

HTTPCloudUploader Configuration

Configure HTTPCloudUploader end to end: retry internals, backoff, TLS verification, batch sizing, and draining the local sync queue.

13 min read

implementation intermediate

Implementing Pyvorin at the Edge

Edge deployment with Pyvorin Native 1.0.9: compile on an x86_64 build host, ship the compiled cache, and activate per device within its offline grace window.

edge intermediate

MQTTAdapter — Broker Subscriptions and Resilient Ingest

MQTTAdapter for resilient edge ingest: QoS semantics, TLS, reconnect and back-off behaviour, and durable local buffering during outages.

14 min read

edge intermediate

Privacy Filtering Overview

Privacy filtering for edge telemetry: regulatory context (GDPR, NIS2), filtering stages, measured overhead, and field-level options.

14 min read

edge intermediate

Profiling Edge Pipelines and System Metrics

Profile edge pipelines in place: cProfile on hot rules, memory measurement, system metrics, and how to read results without fooling yourself.

12 min read

edge intermediate

Rules and Conditions — Logic at the Edge

Ten concrete rule and condition examples for edge pipelines: thresholds, hysteresis, isolation tests, and the patterns that avoid false alarms.

16 min read

edge intermediate

SensorReading API Reference

SensorReading API reference: constructor fields, unit handling, the dual-definition caveat, and validation behaviour at the edge.

10 min read

edge intermediate

The Pipeline Class — Ingest, Window, Evaluate, Act

How the Pipeline class works conceptually: dataflow from ingest through windowing and rules to actions, and where the API reference takes over.

15 min read

edge intermediate

Writing Compiler-Friendly Python for Pyvorin Edge

Patterns that compile well on the edge device: stable types, simple control flow, and the habits that force the compiler to bail out.

12 min read