Documentation
Guides, API references, and troubleshooting for the Pyvorin platform.
"Frequently Asked Questions"
Concise answers to the most common questions about installing, configuring, tuning, and securing Pyvorin Edge.
15 min read
"Health Monitoring and Prometheus Export"
Deep dive into the /health and /metrics endpoints, Prometheus export, Grafana dashboards, and Alertmanager rules for the Pyvorin Edge Agent.
20 min read
"Structured Log Management and Shipping"
Integrate structlog with Pyvorin Edge, configure log rotation, and ship logs to Loki, Splunk, and CloudWatch with correlation IDs.
18 min read
"Tutorial: Cold Chain Monitoring for Pharmaceuticals"
Build a GDP-compliant cold chain monitor with privacy redaction, signed audit reports, and offline-capable cloud sync.
25 min read
"Tutorial: Precision Agriculture and Smart Irrigation"
Build a solar-powered precision agriculture station with soil moisture, temperature, and light sensors, weather API integration, and fleet-wide deployment.
25 min read
"Tutorial: Predictive Maintenance with Vibration Analysis"
Build a vibration-based predictive maintenance pipeline on the edge using accelerometers, compiled anomaly detection hot-paths, and cost modelling.
25 min read
"Tutorial: Smart Building Energy Monitor"
Complete end-to-end tutorial for building a smart building energy monitor with Raspberry Pi 4, temperature/humidity sensors, and an energy meter using Pyvorin Edge.
30 min read
"Tutorial: Telecom Tower Monitoring and Safety"
Advanced multi-sensor edge pipeline for telecom towers featuring SNMP adapters, tower-climb safety rules, and MQTT integration to the NOC.
35 min read
Actions and Events — Responding to the Edge
Writing action functions, the Event dataclass, logging, webhooks, local file output, and robust action error handling.
13 min read
Advanced Pipeline Patterns in Pyvorin Edge
Design multi-stage pipelines, implement fan-out/fan-in, build custom window functions like EWMA and percentile, and tune backpressure for production edge workloads.
22 min read
ARM64 NEON Vectorization in Pyvorin Edge
A primer on ARM64 NEON SIMD, how Pyvorin uses it for vector math, automatic vs manual kernel dispatch, and benchmarking on Raspberry Pi 5.
14 min read
Audit Chain and Signed Reports
The Ed25519-signed audit chain, how every outbound batch gets signed, signature verification, the prove-benchmark.sh attestation system, hardware fingerprinting, and generating compliance reports.
18 min read
AWS and Azure Integration
Bridging Pyvorin Edge to AWS IoT Greengrass and Azure IoT Hub, MQTT bridge setup, cost comparison of raw versus filtered egress, and savings calculation examples in GBP.
16 min read
Benchmarking with the Pyvorin Edge SDK
Complete guide to the built-in benchmark suite, run-pi-benchmarks.sh, the 8 verticals, attested reports, prove-benchmark.sh, and creating custom benchmarks.
13 min read
CloudSyncQueue API Reference
Complete reference for CloudSyncQueue, including enqueue, dequeue, peek, ack, nack, maybe_flush, SQLite schema, locking, and configuration.
13 min read
Cross-Compiling Pyvorin Edge Kernels for ARM64
Build ARM64-native shared objects from an x86 machine using Docker buildx, verify artifacts with the file command, and automate everything in GitHub Actions.
18 min read
Custom Adapters — Extending the Ingest Layer
Implement the adapter plugin interface, build a custom Modbus adapter, register it with the runtime, and write unit tests.
15 min read
Custom Cloud Endpoints
Building custom cloud receivers for Pyvorin Edge: expected JSON payload format, Bearer token authentication, batch schema, and webhook handler examples in Flask and FastAPI.
15 min read
Disaster Recovery and Data Integrity
SQLite WAL recovery, queue corruption repair, factory reset procedures, automated backup and restore scripts, and recovery testing for Pyvorin Edge gateways.
18 min read
Docker Deployment Guide
Deploy the Pyvorin Edge Agent with Docker and Docker Compose, including multi-stage builds, health checks, secrets management, and ARM64 cross-compilation.
24 min read
Ed25519 Trust Anchors
How trust_on_first_use() and load_trust_anchor() establish device identity, public key storage formats, migrating legacy anchors, key rotation, and the trust model for Pyvorin Edge bundles.
14 min read
Edge CLI Tools Reference
Complete reference for pyv-edge-benchmark, pyv-edge-generate, pyv-edge-inspect, and pyv-edge-sign with every subcommand, flag, and example output.
15 min read
Edge Configuration Reference
A complete reference for every section and key in config.toml, with annotated examples.
22 min read
Edge Dashboard Overview
How to access the dashboard, what each view shows, and how to configure the Pi endpoint and settings.
12 min read
Edge Project Structure
A tour of the directory layout after installation and what each file and folder does.
10 min read
Edge Quick Start
A complete "Hello World" walkthrough from installation to live sensor output in under ten minutes.
14 min read
Edge System Requirements
Hardware, software, and network requirements for running Pyvorin Edge on ARM64 gateways.
12 min read
EdgeAgent API Reference
Complete reference for the EdgeAgent class, including constructor, lifecycle methods, health checks, threading model, and all public properties.
14 min read
Field Redaction Patterns
How to redact specific metadata fields before cloud sync using sensor pattern matching, regex-style wildcards, and both TOML configuration and programmatic APIs.
16 min read
FileReplayAdapter — Time-Travel for Sensor Data
Replay CSV and JSONL log files with timestamp parsing, real-time pacing, speed control, and loop mode for testing and regression.
12 min read
Five-Minute Tour
A narrative walkthrough from installation to live data, rules, and events in five minutes.
14 min read
Fleet Management at Scale
Manage hundreds of Pyvorin Edge devices with device provisioning, configuration drift detection, bulk config push, fleet-wide rollback, and health aggregation.
26 min read
GDPR and NIS2 Compliance
Implement GDPR Article 30 records of processing, data retention policies, right to erasure, breach notification, and NIS2 technical measures using Pyvorin Edge privacy and audit APIs.
16 min read
Hashing Strategies for Correlation
One-way hashing with SHA-256 and HMAC, salting strategies, deterministic pseudonymisation for device fingerprinting, and full code examples for the Pyvorin Edge Runtime.
15 min read
HTTPAdapter — REST, Webhooks, and Polling Ingest
Receive POST webhooks, poll REST endpoints, handle auth headers, rate limiting, and JSON/CSV parsing with FastAPI/Flask examples.
14 min read
HTTPCloudUploader Configuration
Complete guide to the HTTPCloudUploader class: endpoint configuration, API key management, timeouts, retries, exponential backoff, and the post_batch() method with production-ready code examples.
13 min read
Installing Pyvorin Edge
Step-by-step installation using the curl script, manual pip install, verification, and post-install checks.
15 min read
LicenseValidator API Reference
Complete reference for LicenseValidator, LicenseInfo, LicenseStatus, DevModeValidator, environment variables, local vs remote validation, and trust anchor integration.
12 min read
MQTTAdapter — Broker Subscriptions and Resilient Ingest
Connect to MQTT brokers, manage QoS, TLS, authentication, topic wildcards, and automatic reconnection with full working examples.
14 min read
mTLS and Certificate Pinning
Generate a private CA with OpenSSL, create per-device client certificates, configure MQTTAdapter and HTTPAdapter for mutual TLS, and implement certificate rotation and revocation on Pyvorin Edge gateways.
20 min read
Offline-First Operation
Designing Pyvorin Edge pipelines for intermittent connectivity using SQLite WAL buffering, retry with exponential backoff, graceful degradation, connectivity detection, and queue persistence across reboots.
16 min read
Over-the-Air Update System
Design and implement secure OTA updates for Pyvorin Edge using Ed25519 bundle signing, atomic symlink swaps, automatic rollback, and channel-based release management.
28 min read
Pipeline API Reference
Complete reference for the Pipeline class, WindowConfig, RuleConfig, PipelineResult, and all public methods with parameters, return types, exceptions, and usage examples.
16 min read
Privacy Filtering Overview
Why the Pyvorin Edge Runtime filters sensitive data at the edge before it ever reaches the cloud, and how the PrivacyPolicy class enforces mask, drop, hash, and allow rules.
14 min read
Production Deployment Checklist
A complete go-live checklist for Pyvorin Edge deployments covering hardware validation, security hardening, systemd setup, log rotation, SQLite backups, and monitoring alerts.
22 min read
Profiling Edge Pipelines and System Metrics
How to profile edge pipelines with cProfile, interpret memory usage, identify bottlenecks, and use the SystemMetrics class and HTTP health endpoints.
12 min read
Pyvorin Edge Plugin Architecture
Build discoverable plugins with lifecycle hooks, register custom adapters, window functions, and action handlers, and configure everything from config.toml.
20 min read
Pyvorin Edge Runtime Library Internals
Deep dive into the runtime shared objects, typed object model, inline caches, ABIContract ctypes binding, ModuleLoader.verify_signature, and ExplicitFallback.run_with_guard.
28 min read
Queue Management and Backpressure
Deep dive into CloudSyncQueue: SQLite-backed persistence, enqueue and dequeue semantics, maybe_flush with optional uploader, queue depth monitoring, batch sizing, and ack/nack handling.
17 min read
Rules and Conditions — Logic at the Edge
Write lambda conditions, composite AND/OR rules, stateful evaluations, and priority ordering with ten complete production examples.
16 min read
Running EdgeAgent Under Systemd
A complete guide to systemd unit configuration for the Pyvorin Edge Agent, including restart policies, resource limits, graceful shutdown, and optional socket activation.
18 min read
Secure Boot and Runtime Integrity
Raspberry Pi secure boot chain deep dive, signing kernel modules with pyv-edge-sign, runtime bundle verification, hardware attestation, and tamper detection for Pyvorin Edge deployments.
22 min read
SensorReading API Reference
Complete reference for SensorReading, including fields, serialization, batch operations, timestamp handling, and unit conversion helpers.
10 min read
SensorReadings — The Data Currency of the Edge
Deep dive into the SensorReading dataclass, batch operations, unit conversion, and serialization patterns.
12 min read
SimulatorAdapter — Synthetic Data for Real Testing
Configure the SimulatorAdapter, model noise and drift, inject anomalies, and run scenario-based simulations before touching hardware.
14 min read
Testing Pyvorin Edge Pipelines
Unit testing with pytest, mocking adapters with SimulatorAdapter, property-based testing with Hypothesis, end-to-end integration tests, and CI/CD pipeline configuration for Pyvorin Edge.
18 min read
The @edge Decorator — Under the Hood
Deep dive into the @edge decorator, AST parsing, type inference, compilation routing, limitations, and best practices.
15 min read
The GIL and Threading in Pyvorin Edge
Understand how the GIL interacts with compiled kernels, keep Pipeline.run() single-threaded, and safely use ThreadPoolExecutor and ProcessPoolExecutor for I/O and CPU parallelism.
20 min read
The Pipeline Class — Ingest, Window, Evaluate, Act
Complete guide to the Pipeline class, its execution loop, latency tracking, and the PipelineResult API.
15 min read
Troubleshooting Installation
Common installation problems, their root causes, and step-by-step solutions with commands.
16 min read
Understanding the EdgeAgent
A deep dive into the EdgeAgent class, its lifecycle, threads, health endpoint, ingest adapters, buffers, and cloud queue.
20 min read
What Is Pyvorin Edge?
An introduction to Pyvorin Edge, the problems it solves, and the core concepts every beginner needs to understand.
18 min read
Window Aggregation — Rolling, Tumbling, and Custom Functions
Configure sliding, tumbling, and session windows. Compute mean, max, min, sum, count, and stddev with real code examples.
14 min read
Writing Compiler-Friendly Python for Pyvorin Edge
Best practices for writing Python that compiles well with the Pyvorin Edge compiler, including supported types, control flow, and anti-patterns to avoid.
12 min read
Writing Custom C Kernels for Pyvorin Edge
Learn the C ABI contract, write a hand-optimized NEON kernel, build a shared object, and register it with CompilerBridge for edge-native execution.
25 min read