Getting Started
Getting Started
What Voke is, who this doc is for, how to pick an integration track.
What Voke is
Voke is a multi-tenant IoT platform for energy management. It brokers between:
- Field equipment — plants (PLCs, controllers) publishing telemetry snapshots and receiving commands over MQTT.
- Energy-system-management (ESM) partners — third-party operators (Obzor, CPI Energo) reading telemetry and dispatching commands over AMQP using the Voke Communication Protocol (VCP), via a partner-owned adapter.
Who this documentation is for
Two integrator audiences:
- ESM partners. You own an ESM platform, you have a VCP-translating adapter (or will build one), and you want to connect your system to Voke over AMQP. → ESM Partners.
- PLC / device programmers. You ship firmware or controller software for plants or sub-devices. You need to publish telemetry and accept commands over MQTT. → PLC / Devices.
If you are an org admin or internal operator setting up partner credentials, start with Organization Settings Quick Start. It maps the production Lovinka admin routes for organization settings, Connections, API keys, and the Connect Partner wizard.
If you are an end-user of the Voke admin dashboard, this site is not for you — use the app's in-product help.
If you are an internal Voke engineer, the architecture deep-dives live in .claude/docs/ in the repository.
Before you start
- Read Concepts once. Both tracks assume organizations, plants, sub-devices, device templates, and signals are familiar.
- Have a sandbox ready. Every code sample is runnable against a local
bun run docker:upstack + the built-in Voke ESM (superadmin-enabled, no external partner infrastructure required).