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
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
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
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
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
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
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
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
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
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
SensorReading API Reference
SensorReading API reference: constructor fields, unit handling, the dual-definition caveat, and validation behaviour at the edge.
10 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 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
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
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