Building Applications for TelemetryOS

Build custom web applications for digital signage, kiosks, and interactive displays using standard web technologies and the TelemetryOS SDK.

Development Paths

Development documentation is organized by learning path and use case:

SDK Getting Started

Fundamentals of TelemetryOS application development, platform architecture, offline capabilities, and use cases. Designed for first-time developers.

SDK Documentation

Comprehensive SDK reference including installation, APIs, mount points, and development tools. Complete technical reference for application development.

Application Creation

Application creation workflows in Studio using GitHub integration, templates, or zip uploads. Platform-level application management.

Application Components

Modular architecture of TelemetryOS applications including render views, settings, workers, and containers.

Quick Links

For New Developers

SDK Getting Started - Understand TelemetryOS applications
Offline Capabilities - Learn how apps run locally on devices
SDK Quick Start - Build your first application
Mount Points - Learn the application structure
Storage Methods - Persist and sync data

For Experienced Developers

SDK Method Reference - Complete SDK method documentation
Code Examples - Working application examples
Local Development - Development workflow and tools
CORS Guide - External API integration

Platform Overview

What are TelemetryOS Applications?

TelemetryOS applications are web applications built with standard technologies (HTML, CSS, JavaScript/TypeScript) that run on digital signage devices, kiosks, and displays. Applications can:

Display dynamic content on physical devices
Provide configuration interfaces in the admin portal
Run background tasks with workers
Deploy Docker containers for backend services
Access platform features through the SDK

Architecture

Applications consist of up to four components:

Render View (/render) - Content displayed on devices
Settings View (/settings) - Configuration UI in admin portal
Workers - Background scripts for data synchronization
Containers - Docker containers for backend services

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

Development Workflow

Application development follows a structured workflow:

SDK installation
Local build and testing
CLI-based testing
Git-based deployment
Studio management

Git-to-Screen: Code pushes to GitHub trigger automatic builds and deployments to devices.

Key Features

Standard Web Technologies

Build with familiar tools: JavaScript, TypeScript, React, Vue, HTML, and CSS. No proprietary languages required.

Four Storage Scopes

application - Shared across all instances
instance - Specific to current instance
device - Only on current physical device
shared - Inter-application communication

Real-Time Synchronization

Changes propagate instantly from settings to devices. Subscribe to data changes for reactive updates.

Offline Support

Applications run entirely from local device storage with graceful offline handling. Built on TelemetryOS servers, downloaded to devices, and executed locally. See Offline Capabilities for comprehensive guidance.

Hardware Integration

Access device features: cameras, serial devices, GPIO, sensors, and custom peripherals.

Platform APIs

Media - Access media library content
Playlist - Control playlist navigation
Overrides - Emergency content alerts
Devices - Hardware information
Proxy - External API fetching with CORS handling

Use Cases

TelemetryOS applications power diverse digital experiences:

Interactive Kiosks - Wayfinding, check-in, product browsing
Menu Boards - Dynamic pricing, real-time inventory integration
Dashboards - Live KPIs, metrics, operational data
Digital Signage - Personalized content, targeted promotions
Emergency Systems - Critical alerts and messaging
Retail Displays - Product information, upsells, promotions

Getting Help

Documentation Sections

SDK Getting Started - Platform fundamentals and concepts
SDK Documentation - Complete technical reference
Application Creation - Platform workflow in Studio
Application Components - Architecture deep dive

Support Resources

SDK Version: 1.2.0
GitHub: Neo-Application-SDK Repository
Community: TelemetryOS Developer Forum

Next Steps

First-Time Developers

SDK Getting Started provides TelemetryOS application fundamentals and offline capabilities. SDK Quick Start demonstrates building your first application.

Ready to Code

Development provides guides and tools. SDK Method Reference has complete method documentation.

Platform Operations

Application Creation covers Studio workflows using GitHub integration or templates.

Quick Development: The SDK Quick Start Guide enables first application deployment in minutes.