Base URL

TelemetryOS is a REST JSON API.

You must send data to the TelemetryOS API encoding the body in JSON format. XML is not supported.

Transport/Communication

Secure message-passing between sandboxed app iframes and the TelemetryOS platform (validated structured messages, ~30s timeout, real-time subscriptions).

JavaScript/TypeScript package (@telemetryos/sdk) — promise-based methods (e.g., await sdk.functions.call('name', data)), storage APIs, media/playlist controls, hardware access.

Components

Standard web files:

  • Display: /index.html (render)
  • Settings: /settings.html (admin UI)
  • Background workers: long-running scripts
  • Serverless functions: TypeScript cloud functions
  • Configuration: telemetry.config.json defines app metadata, components, versions, and permissions.
  • Data formats: JSON for messages, storage, and SDK calls (structured payloads with device/context metadata supplied by platform).
  • Storage scopes: Application, Instance, Device, Account (each scoped JSON storage).
  • Security: Sandbox isolation, scoped permissions, encrypted transport, serverless functions for secret-bearing operations (credentials never sent to edge).