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
Advanced Pipeline Patterns in Pyvorin Edge
Multi-stage pipelines, fan-out and fan-in, EWMA custom windows, and backpressure tuning for production edge workloads.
22 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
AWS and Azure Integration
Wire Pyvorin Edge into AWS IoT Greengrass and Azure IoT Hub, with MQTT bridging and a worked egress cost comparison.
16 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
Cross-Compiling Pyvorin Edge Kernels for ARM64
Toolchain setup, cross-compiled kernels, manifest verification and CI pipelines for ARM64 edge targets.
18 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
Custom Cloud Endpoints
Build a receiver for Pyvorin Edge batches: payload schema, bearer auth, retry semantics, and Flask and FastAPI handler examples.
15 min read
Disaster Recovery and Data Integrity
A recovery playbook: WAL checkpointing, queue repair, automated backups, factory reset and how to test your restores.
18 min read
Docker Deployment Guide
A production Docker setup for EdgeAgent: multi-stage builds, Compose, networking modes and secrets management.
24 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 CLI Tools Reference
Every pyv-edge command with flags and exit codes, plus patterns for wiring the tools into CI pipelines.
15 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
Five-Minute Tour
A five-minute story: install Pyvorin Edge, start the agent, watch live data on the dashboard, add a rule and trigger an event.
14 min read
Fleet Management at Scale
Operating hundreds of gateways: provisioning, drift detection, bulk configuration, fleet-wide rollback and health aggregation.
26 min read
Frequently Asked Questions
Plain-language answers on installing, configuring, tuning and licensing Pyvorin Edge, plus where to go when stuck.
15 min read
GDPR and NIS2 Compliance
A practical route to GDPR and NIS2 compliance: records of processing, retention, erasure, breach timelines and audit evidence.
16 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
Health Monitoring and Prometheus Export
Health endpoints, Prometheus metrics, a ready Grafana dashboard and Alertmanager rules for EdgeAgent fleets.
20 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
LicenseValidator API Reference
Every LicenseValidator class, enum and environment variable, including local file format and the local-vs-remote validation cascade.
12 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
mTLS and Certificate Pinning
A full mTLS lifecycle for edge fleets: private CA, per-device certificates, adapter configuration, rotation and revocation.
20 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
Over-the-Air Update System
Signed bundles, version manifests, atomic swap and rollback: a safe OTA design for field gateways.
28 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
Production Deployment Checklist
The pre-flight and post-deployment checks that keep EdgeAgent gateways secure, backed up and observable.
22 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
Pyvorin Edge Plugin Architecture
How the entry-point plugin system works, from discovery to a complete custom adapter with configuration.
20 min read
Pyvorin Edge Runtime Library Internals
A deep dive into the runtime: typed containers, signature checks, guarded fallback and the ctypes ABI layer.
28 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
Running EdgeAgent Under Systemd
A hardened unit file for EdgeAgent, with graceful shutdown, resource limits, journald logging and socket activation caveats.
18 min read
Secure Boot and Runtime Integrity
Secure boot on the Pi, signed kernel modules, runtime integrity checks and hardware attestation for edge devices.
22 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
Structured Log Management and Shipping
Practical log management for gateways: structlog, rotation, shipping to Loki, Splunk or CloudWatch, and correlation IDs.
18 min read
Testing Pyvorin Edge Pipelines
The testing pyramid for edge pipelines: unit tests, property tests, integration runs, coverage gates and mutation testing.
18 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 GIL and Threading in Pyvorin Edge
Where the GIL bites, when compiled kernels release it, and how to choose thread versus process pools for edge workloads.
20 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
Troubleshooting Installation
A diagnostic manual for installation failures: permission errors, missing Python headers, NEON build failures, port conflicts and more.
16 min read
Tutorial: Cold Chain Monitoring for Pharmaceuticals
A complete GDP cold-chain pipeline: excursion rules, patient-field redaction, signed audit records and offline buffering.
25 min read
Tutorial: Precision Agriculture and Smart Irrigation
Soil-moisture rules, weather-driven irrigation, a solar power budget and fleet rollout for remote fields.
25 min read
Tutorial: Predictive Maintenance with Vibration Analysis
Vibration baselines, a NEON-compiled hot-path, threshold tuning and the business case for early fault detection.
25 min read
Tutorial: Smart Building Energy Monitor
From Modbus meters to a live dashboard: pipeline configuration, cloud sync and the readings behind each panel.
30 min read
Tutorial: Telecom Tower Monitoring and Safety
SNMP telemetry, multi-sensor pipelines, tower-climb safety rules and MQTT integration with the NOC.
35 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
What Is Pyvorin Edge?
What Pyvorin Edge is, how its three pillars work, and when a gateway-native runtime beats shipping every reading to the cloud.
18 min read
Window Aggregation — Rolling, Tumbling, and Custom Functions
How rolling, tumbling and session windows aggregate sensor streams, which built-in functions exist, and the performance caveats.
14 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
Writing Custom C Kernels for Pyvorin Edge
The full path from C source to loaded kernel: ABI contract, NEON intrinsics, the shared object, and verification at load time.
25 min read