Documentation
Guides, API references, and troubleshooting for the Pyvorin platform.
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
ARM64 NEON Vectorization in Pyvorin Edge
How Pyvorin Edge uses ARM64 NEON: which loops vectorise, realistic 2–8x expectations with caveats, and kernels the backend accepts.
14 min read
Audit Chain and Signed Reports
Build a tamper-evident audit chain on the edge: append-only logs, signed reports, lock scope, and the honest limits of tamper resistance.
18 min read
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
CloudSyncQueue API Reference
Full CloudSyncQueue API: SQLite schema, ack/nack semantics, priority and TTL, locking caveats, and store-and-forward telemetry patterns.
13 min read
Custom Adapters — Extending the Ingest Layer
Write duck-typed ingest adapters for Modbus, serial, or proprietary protocols: the read() contract, failure semantics, and a checklist.
15 min read
Ed25519 Trust Anchors
Ed25519 trust anchors for edge devices: key generation, signing, rotation schedules, and chaining into OTA updates and secure boot.
14 min read
Edge Configuration Reference
Every EdgeAgent configuration key explained: polling, storage, upload, dashboard, and licence settings, with reload caveats and examples.
22 min read
Edge Dashboard Overview
The built-in EdgeAgent dashboard: access options on :8080, the security warning that matters, per-view metrics, and reverse-proxy placement.
12 min read
Edge Project Structure
A directory map of a production Pyvorin Edge deployment: config, adapters, queues, logs, and keys — what lives where and what to back up.
10 min read
Edge Quick Start
A working Pyvorin Edge pipeline in fifteen minutes: install, first sensor feed, first rule, and verified expected output at every step.
14 min read
Edge System Requirements
Hardware and OS requirements for Pyvorin Edge on x86_64 and ARM64: device-class tables, storage budgets, and deployment constraints.
12 min read
EdgeAgent API Reference
Complete EdgeAgent API: lifecycle methods, threading model, signal handling, and graceful shutdown — the operational counterpart to the tour.
14 min read
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
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
Hashing Strategies for Correlation
SHA-256, HMAC, and salted hashing for privacy-safe correlation on the edge: production examples, brute-force limits, and when to avoid it.
15 min read
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
HTTPCloudUploader Configuration
Configure HTTPCloudUploader end to end: retry internals, backoff, TLS verification, batch sizing, and draining the local sync queue.
13 min read
Installing Pyvorin Edge
Install Pyvorin Edge on x86_64 or ARM64 Linux: prerequisites, verified steps, expected output at each stage, and fixes for common failures.
15 min read
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
Offline-First Operation
Run edge pipelines through WAN outages: SQLite WAL, circuit breakers, store-and-forward queues, and recovery behaviour that prevents data loss.
16 min read
Pipeline API Reference
Complete Pipeline API: ingest, window, rule, and action methods with signatures, return types, and the locking behaviour to plan around in production.
16 min read
Privacy Filtering Overview
Privacy filtering for edge telemetry: regulatory context (GDPR, NIS2), filtering stages, measured overhead, and field-level options.
14 min read
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
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
SensorReading API Reference
SensorReading API reference: constructor fields, unit handling, the dual-definition caveat, and validation behaviour at the edge.
10 min read
SensorReadings — The Data Currency of the Edge
SensorReading objects carry every measurement through a Pyvorin Edge pipeline: fields, units, timestamps, and how they differ from the raw API type.
12 min read
SimulatorAdapter — Synthetic Data for Real Testing
SimulatorAdapter generates realistic sensor traffic — noise, drift, anomalies — so you can test pipelines before any hardware exists.
14 min read
The @edge Decorator — Under the Hood
How @edge compiles decorated functions on the device: AST parsing, signature inference, scalar versus kernel routing, and known limitations.
15 min read
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
Understanding the EdgeAgent
The EdgeAgent lifecycle deep-dive: startup, pipeline supervision, signal handling, and shutdown — the concepts behind the API reference.
20 min read
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