Documentation

Understand the system you operate.

Documentation is part of the product. This public overview establishes the vocabulary and shape of Spark, devices, packets, and integrations while deployment-specific details remain in customer-controlled docs.

Overview

Field data with operating context.

Spark receives device data, validates and normalizes it, preserves the context needed to interpret it, and exposes operational views and interfaces for the customer’s systems and people.

Core concepts

Organization

A customer-defined boundary for sites, access, policies, integrations, and deployment context.

Site and topology

Physical and logical placement that explains where a device is installed and what it measures.

Device identity

A durable platform identity associated with radio identifiers, hardware, firmware, decoder, and lifecycle state.

Reading

A timestamped, typed, unit-aware measurement with source and validation context.

Devices

Spark is designed for mixed fleets. Each device integration defines:

  • identity and provisioning fields;
  • payload decoder version and expected measurements;
  • units, scaling, range, and validation rules;
  • health signals, reporting expectations, and lifecycle state;
  • commands or configuration behavior, when supported.

Packets

A normalized ingestion message separates transport metadata from measurements:

{
  "deviceId": "site-north.panel-12.scout-03",
  "observedAt": "2026-07-22T18:42:00Z",
  "receivedAt": "2026-07-22T18:42:03Z",
  "sequence": 184233,
  "measurements": [
    { "name": "power.active", "value": 14.82, "unit": "kW" },
    { "name": "energy.total", "value": 72184.44, "unit": "kWh" }
  ],
  "transport": {
    "type": "lorawan",
    "gatewayId": "sentinel-west-02"
  }
}

This example is illustrative. Public schemas will be versioned before external integration contracts are declared stable.

Integrations

Customer integrations may use versioned APIs, webhooks, exports, or direct customer-controlled data access depending on the architecture and security boundary.

Contracts define authentication, identifiers, units, timestamps, retry behavior, idempotency, limits, and ownership.

Operations

Deployment documentation includes health expectations, alert response, backups, restore exercises, capacity signals, release procedures, training, and support escalation.

The goal is not only to document what the system does. It is to make the next correct action easier for the person responsible.

Start here

Need a specific integration contract?

Start with the customer system, the data it needs, and the operational consequence of getting it wrong.

Start a conversation