Reference

API reference for the TelemetryOS SDK (@telemetryos/sdk), its React bindings, and project configuration.

Installation

npm install @telemetryos/sdk

SDK Methods

The SDK provides JavaScript APIs for storage, media, playlists, hardware, and platform integration. All methods are available after calling configure().

import { configure, store, media, proxy } from '@telemetryos/sdk';

configure();

Core

• Storage Methods — Read and write data across four storage scopes (application, instance, device, shared)
• Client Methods — Low-level message passing for advanced use cases

Content

• Media Methods — Access images and videos from the TelemetryOS media library
• Playlist Methods — Control playlist navigation (next page, previous, duration)
• Overrides Methods — Emergency alerts and priority content

Platform

• Platform Methods — Account, user, device, and application information
• Proxy Methods — Fetch external APIs with CORS handling and fleet-wide caching
• MQTT Methods — Publish and subscribe to MQTT topics for hardware integration
• Weather Methods — Current conditions and forecasts

React Library

React-specific hooks and components imported from @telemetryos/sdk/react.

• React Hooks — useStoreState, createUseInstanceStoreState, UI scale hooks, and aspect ratio hooks
• React Components — Pre-styled Settings view components that match the Studio design system

Configuration

• Configuration — Complete telemetry.config.json reference (mount points, workers, containers, dev server)