Guides
Start typing to search…

Getting Started

Build custom screen applications for TelemetryOS with modern web technologies

Getting Started with TelemetryOS Applications

TelemetryOS applications are web applications that run on digital signage, kiosks, and interactive displays. Built with standard web technologies (HTML, CSS, JavaScript, React), they transform screens into intelligent endpoints that integrate with your existing systems while maintaining centralized management across device fleets.

What are TelemetryOS Applications?

Applications run in a Chrome browser on devices, executed within a secure iframe with full access to browser APIs. They can:

  • Display dynamic content - Real-time data, interactive interfaces, responsive layouts
  • Integrate with hardware - Cameras, sensors, serial devices, GPIO
  • Connect to external APIs - REST, GraphQL, WebSocket for live data
  • Provide configuration UIs - Settings interfaces in the Studio admin portal
  • Run background tasks - Workers for continuous data sync
  • Deploy backend services - Docker containers on devices

Applications communicate with the platform through the TelemetryOS SDK, which provides JavaScript APIs for storage, media, playlists, hardware access, and more.

Who Should Build TelemetryOS Applications?

Frontend Developers - If you know React, Vue, or vanilla JavaScript, you can build TelemetryOS applications. No proprietary languages or tools required.

Full-Stack Teams - Leverage containers to run Node.js, Python, or Go services directly on devices alongside your frontend code.

Digital Signage Teams - Replace static content with dynamic applications that integrate with inventory, POS, CRM, and other business systems.

IoT Developers - Build edge applications that process sensor data locally and sync with cloud services.

Quick Start Paths

Path 1: Start Coding Immediately

Use the CLI to scaffold a complete application in seconds:

npm install -g @telemetryos/cli
tos init my-app
cd my-app
tos serve

Next: Generate New Application - Complete CLI guide

Path 2: Understand the Platform First

Explore what's possible and how the runtime works:

  1. Use Cases - Real-world applications across industries
  2. Languages Supported - Chrome runtime and browser APIs
  3. Offline Capabilities - Local execution and graceful offline handling

Next: SDK Quick Start - Build your first application step-by-step

Path 3: Dive into Technical Details

Jump straight to the comprehensive documentation:

Key Concepts

Git-to-Screen Deployment

Push code to GitHub, and TelemetryOS automatically builds and deploys to devices:

git push → TelemetryOS builds → Devices update

Changes propagate fleet-wide in minutes. Version control built in. Instant rollback if needed.

Four Application Components

  1. Render - Visual content on devices (required)
  2. Settings - Configuration UI in Studio (optional)
  3. Workers - Background scripts (optional)
  4. Containers - Docker services (optional)

All components communicate via the SDK's storage and messaging APIs.

Storage Scopes

Choose the right persistence level:

  • application - Shared across all instances everywhere
  • instance - Specific to one playlist placement
  • device - Only on the physical device
  • shared - Communication between different applications

Real-time synchronization: changes in Settings instantly appear on devices.

Development Workflow

1. tos init → scaffold project
2. tos serve → develop locally
3. git push → deploy to GitHub
4. Studio → define application
5. Playlist → assign to devices

The CLI provides a development server that simulates the device environment, letting you test locally before deployment.

What Makes TelemetryOS Different?

Standard Web Technologies - React, TypeScript, Vite, npm. Use the tools you already know.

Chrome Runtime - Applications run in a version-controlled Chrome browser managed by TelemetryOS. No cross-browser compatibility concerns.

Hardware Access - SDK provides JavaScript APIs for cameras, serial devices, GPIO, and sensors.

Edge Computing - Run containers on devices for local processing, databases, and machine learning inference.

Centralized Management - Deploy once, update everywhere. Monitor devices, view screenshots, access logs remotely.

Next Steps

New to TelemetryOS?

  1. Use Cases - See what's possible across different industries
  2. Languages Supported - Understand the Chrome runtime environment
  3. Offline Capabilities - Learn how applications run locally on devices
  4. Generate New Application - Get started with the CLI

Ready to Build?

  1. SDK Quick Start - Build your first application in 15 minutes
  2. Mount Points - Learn application architecture
  3. SDK Method Reference - Explore all available methods

Need Platform Details?

  1. Application Creation - Studio workflows and Git integration
  2. Application Components - Deep dive into render, settings, workers, containers
  3. Local Development - Development server and testing tools

Ready to start? Install the CLI and scaffold your first application:

npm install -g @telemetryos/cli
tos init my-app

Updated 21 days ago

What’s Next