# TelemetryOS Documentation Documentation

> Documentation for TelemetryOS Documentation

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Platform Overview](https://docs.telemetryos.com/docs/overview.md): Run reliable signage and kiosks today, with room to grow into custom, data‑driven experiences
- [Platform Architecture](https://docs.telemetryos.com/docs/platform-architecture.md): Deep technical dive into TelemetryOS's vertically integrated architecture and system design
- [Getting Started](https://docs.telemetryos.com/docs/getting-started.md): Complete guide to deploying TelemetryOS from first screen to production scale
- [Planning & Deployment](https://docs.telemetryos.com/docs/planning-deployment.md): Strategic planning, deployment checklists, and best practices for successful TelemetryOS implementations
- [Reference](https://docs.telemetryos.com/docs/reference.md): Technical specifications, terminology, and compatibility information for TelemetryOS
- [Studio Web Interface](https://docs.telemetryos.com/docs/studio-web-interface.md): Navigate the TelemetryOS Studio Web UI
- [Access Management](https://docs.telemetryos.com/docs/access-management.md): Configure access control in TelemetryOS
- [Authentication & Login](https://docs.telemetryos.com/docs/logging-in.md): Secure access methods and authentication options for TelemetryOS
- [Your Account](https://docs.telemetryos.com/docs/your-profile.md): Personal profile and security preference configuration
- [Billing & Pricing](https://docs.telemetryos.com/docs/billing.md): TelemetryOS pricing model, billing processes, and subscription management
- [Subscription Plans](https://docs.telemetryos.com/docs/subscription-plans.md): Comprehensive breakdown of TelemetryOS platform plans and feature tiers
- [Subscription Management](https://docs.telemetryos.com/docs/manage-subscription.md): Manage TelemetryOS subscriptions, billing cycles, and payment methods
- [Device Licenses](https://docs.telemetryos.com/docs/device-licenses.md): Understanding per-device license coverage and billing
- [Upgrade Plan](https://docs.telemetryos.com/docs/change-your-billing-plan.md): How to upgrade or change a TelemetryOS subscription plan
- [Security & Compliance](https://docs.telemetryos.com/docs/security-and-compliance.md): Enterprise security features, compliance certifications, and data protection capabilities
- [Firewalls & Network Access](https://docs.telemetryos.com/docs/firewalls.md): How to allow TelemetryOS device traffic through organizational firewalls using hostname-based rules
- [How To Get Our SOC Report](https://docs.telemetryos.com/docs/how-to-get-our-soc-report.md): Getting a SOC report
- [TelemetryOS Node Series](https://docs.telemetryos.com/docs/telemetryos-node-series.md): Purpose-built hardware for the TelemetryOS Platform
- [Node Pro](https://docs.telemetryos.com/docs/node-pro.md): Details about the Node Pro hardware
- [Node Mini](https://docs.telemetryos.com/docs/node-mini.md): Compact media player for single-display deployments
- [Purchasing](https://docs.telemetryos.com/docs/purchasing.md): TelemetryOS device purchasing options and hardware specifications
- [Warranty, RMA, and Shipping](https://docs.telemetryos.com/docs/warranty-rma-and-shipping.md): An overview of our Warranty, RMA, and Shipping Policies
- [Comparing Hardware Options](https://docs.telemetryos.com/docs/comparing-hardware-options.md): How TelemetryOS Node compares to SoC panels, Raspberry Pi, and ChromeOS for commercial screen deployments
- [TelemetryOS Edge](https://docs.telemetryos.com/docs/edge.md): Purpose-built OS for running the TelemetryOS Player in production.
- [Starting Up](https://docs.telemetryos.com/docs/starting-up-edge.md): TelemetryOS's Purpose Built Operating System
- [Setup](https://docs.telemetryos.com/docs/telemetryos-edge-setup.md): Configure device settings including network, display, audio, and system preferences
- [Wired Networks](https://docs.telemetryos.com/docs/wired-settings.md): Configure Ethernet connectivity settings for wired network connections
- [Wireless Networks](https://docs.telemetryos.com/docs/wireless-settings.md): Configure WiFi connectivity settings and wireless network connections
- [Bluetooth Settings](https://docs.telemetryos.com/docs/bluetooth-settings.md): Bluetooth device discovery and pairing configuration for TelemetryOS devices
- [Display Configuration](https://docs.telemetryos.com/docs/display-settings.md): Configure display resolution, orientation, and screen settings
- [Audio Configuration](https://docs.telemetryos.com/docs/audio-settings.md): Configure audio output settings and volume controls
- [Device Settings](https://docs.telemetryos.com/docs/device-settings-1.md): Configure general device settings and system preferences
- [System Information](https://docs.telemetryos.com/docs/system-information.md): View device system information, hardware details, and status
- [Deployment Checklist](https://docs.telemetryos.com/docs/checklist-for-customers-using-edge.md): Customer checklist for using Edge
- [Selecting Televisions](https://docs.telemetryos.com/docs/selecting-televisions.md): Choosing displays for TelemetryOS deployments
- [Selecting Kiosks](https://docs.telemetryos.com/docs/selecting-kiosks.md): Choosing kiosk hardware for interactive TelemetryOS deployments
- [Video Walls](https://docs.telemetryos.com/docs/video-walls.md): Video wall configuration and implementation with TelemetryOS
- [Connecting a Device](https://docs.telemetryos.com/docs/connecting-a-device.md): Onboard devices via provisioning (recommended) or pairing
- [Provisioning](https://docs.telemetryos.com/docs/provisioning.md): Device provisioning for TelemetryOS
- [Pairing](https://docs.telemetryos.com/docs/pairing.md): Manual device enrollment for small deployments
- [Pairing with Code](https://docs.telemetryos.com/docs/pairing-with-code.md): Alphanumeric code entry for device enrollment
- [Pairing with QR Code](https://docs.telemetryos.com/docs/pairing-with-qr-code.md): QR code scanning for device enrollment
- [Device Administration](https://docs.telemetryos.com/docs/device-administration.md): Operate at scale: organize devices, assign content, monitor health, and secure access
- [Organizing Devices](https://docs.telemetryos.com/docs/organizing-devices.md): Hierarchical device organization structure in TelemetryOS for managing media player devices
- [Grid vs. List of Devices](https://docs.telemetryos.com/docs/grid-vs-list-of-devices.md): View Devices as a list or in a grid
- [Geographic Map](https://docs.telemetryos.com/docs/geographic-map.md): Device location visualization
- [Device Reports](https://docs.telemetryos.com/docs/device-reports.md): How to export Device Reports using the Device menu
- [Debugging](https://docs.telemetryos.com/docs/debugging.md): Monitor, debug, and verify content displayed on devices
- [Error Logs](https://docs.telemetryos.com/docs/error-logs.md): Accessing device logs in the interface
- [Storage Degraded Errors](https://docs.telemetryos.com/docs/storage-degraded-errors.md): Understanding storage degraded errors
- [Keeping Up to Date](https://docs.telemetryos.com/docs/keeping-up-to-date.md): Platform maintenance and version management requirements
- [Device Warnings](https://docs.telemetryos.com/docs/hiding-device-warnings.md): Online, offline, and inactive device status icons
- [Security Reference](https://docs.telemetryos.com/docs/security-reference.md): Device password protection and security controls
- [Device Webhooks](https://docs.telemetryos.com/docs/device-webhooks.md): Real-time device data streaming via webhook integration
- [Serial Port & Commands](https://docs.telemetryos.com/docs/serial-port-commands.md): Programmatic serial command control for hardware automation
- [Scheduled Restarts](https://docs.telemetryos.com/docs/scheduled-restarts.md): Scheduled device restart configuration
- [Update Window](https://docs.telemetryos.com/docs/update-window.md): Scheduled software update time windows for devices
- [Device Tags](https://docs.telemetryos.com/docs/device-tags.md): Device categorization and organization through custom tagging
- [Interactive Button Menu](https://docs.telemetryos.com/docs/interactive-menu.md): Interactive button menu for kiosk and touchscreen navigation
- [Active Screenshots](https://docs.telemetryos.com/docs/active-screenshots.md): Capture on-device frames for remote verification and troubleshooting
- [Getting Started](https://docs.telemetryos.com/docs/sdk-getting-started.md): Install the Developer App, create your first project, and choose your development workflow
- [Developer App](https://docs.telemetryos.com/docs/developer-app.md): Tour the Developer App interface — canvas controls, tools, publishing, and preferences
- [Project Structure](https://docs.telemetryos.com/docs/project-structure.md): Templates, generated file layout, and build configuration
- [Core Concepts](https://docs.telemetryos.com/docs/core-concepts.md): How TelemetryOS applications work — the runtime, component model, storage, and deployment
- [Mount Points](https://docs.telemetryos.com/docs/mount-points.md): The URL entry points that define where each browser-based component of an application runs
- [Render](https://docs.telemetryos.com/docs/render.md): The visual component that displays on physical devices and in Studio preview
- [Settings](https://docs.telemetryos.com/docs/settings.md): The configuration interface that appears in the Studio sidebar for administrators
- [Web](https://docs.telemetryos.com/docs/web-mount-point.md): Build browser-accessible interfaces for staff dashboards, operator desks, and public forms using the TelemetryOS web mount point.
- [Storage Scopes](https://docs.telemetryos.com/docs/storage-scopes.md): The four storage scopes that control how data is shared across the fleet
- [Deployment Model](https://docs.telemetryos.com/docs/deployment-model.md): How code goes from Git to device screens — builds, versioning, branching, and rollback
- [Offline](https://docs.telemetryos.com/docs/offline.md): Understanding how TelemetryOS applications run locally on devices with graceful offline handling
- [Languages & Runtime](https://docs.telemetryos.com/docs/languages-and-runtime.md): The Chrome-based execution environment and supported web technologies
- [Guides](https://docs.telemetryos.com/docs/guides.md): The two development workflows plus practical how-to guides for TelemetryOS applications
- [Manual Development](https://docs.telemetryos.com/docs/local-development.md): Write TelemetryOS applications yourself — editor, hot module replacement, mock SDK, and debugging
- [AI Agent Development](https://docs.telemetryos.com/docs/ai-agent-development.md): Direct Claude Code or Codex to build TelemetryOS applications through the Developer App's MCP server
- [Code Examples](https://docs.telemetryos.com/docs/code-examples.md): Complete working examples demonstrating common patterns for building TelemetryOS applications with settings and render views.
- [Workers](https://docs.telemetryos.com/docs/workers.md): Background scripts that run continuously on TelemetryOS devices
- [Containers](https://docs.telemetryos.com/docs/containers.md): Run Docker containers alongside applications for backend services
- [CORS](https://docs.telemetryos.com/docs/cors.md): Critical information about Cross-Origin Resource Sharing (CORS) and how it affects applications running in browser contexts.
- [Integrating Hardware](https://docs.telemetryos.com/docs/integrating-hardware.md): Connect sensor and actuator data flows to TelemetryOS applications with MQTT messaging.
- [Deploying](https://docs.telemetryos.com/docs/deploying.md): Register, build, version, and deploy TelemetryOS applications through Studio
- [Defining Applications](https://docs.telemetryos.com/docs/defining-application.md): Register application code with TelemetryOS Studio to deploy to devices
- [GitHub Integration](https://docs.telemetryos.com/docs/github-integration.md): GitHub repository connection for automated Git-to-Screen deployment
- [Upload a ZIP File](https://docs.telemetryos.com/docs/upload-a-zip-file.md): Archive-based application creation and deployment
- [Deleting an Application](https://docs.telemetryos.com/docs/deleting-an-application.md): Permanently delete applications from TelemetryOS accounts
- [Reference](https://docs.telemetryos.com/docs/sdk-reference.md): Complete API reference for the TelemetryOS SDK, React library, and project configuration
- [Storage Methods](https://docs.telemetryos.com/docs/storage-methods.md): Complete reference for the TelemetryOS Storage Methods with four storage scopes for data persistence and real-time synchronization.
- [Client Methods](https://docs.telemetryos.com/docs/client-methods.md): Low-level messaging methods for advanced use cases. Most developers should use the higher-level resource methods instead.
- [Media Methods](https://docs.telemetryos.com/docs/media-methods.md): Access TelemetryOS media library content including images and videos. Query by folders, tags, or individual media items. Open a media picker for user selection.
- [Playlist Methods](https://docs.telemetryos.com/docs/playlist-methods.md): Control Studio playlist navigation. Advance pages, go back, or dynamically adjust page duration for interactive content.
- [Platform Methods](https://docs.telemetryos.com/docs/platform-methods.md): Access TelemetryOS platform features including accounts, users, devices, applications, and proxy services for external content fetching.
- [Proxy Methods](https://docs.telemetryos.com/docs/proxy-methods.md): Fetch external content through the TelemetryOS proxy service to handle CORS restrictions with intelligent caching and bandwidth management.
- [MQTT Methods](https://docs.telemetryos.com/docs/mqtt-methods.md): Connect to MQTT brokers from TelemetryOS apps for real-time publish/subscribe messaging and connection status monitoring.
- [Weather Methods](https://docs.telemetryos.com/docs/weather-methods.md): Access weather data including current conditions, daily forecasts, hourly forecasts, and severe weather alerts with dual-unit responses (metric and imperial).
- [React Hooks](https://docs.telemetryos.com/docs/react-hooks.md): React hooks for reactive store state management, UI scaling, and aspect ratio detection
- [React Components](https://docs.telemetryos.com/docs/react-components.md): React components for building Settings views that match the Studio design system
- [Configuration](https://docs.telemetryos.com/docs/configuration.md): Complete reference for telemetry.config.json
- [Account Logs](https://docs.telemetryos.com/docs/account-logs-1.md): How do account logs work in TelemetryOS?
- [Device Logs](https://docs.telemetryos.com/docs/device-logs-1.md): Accessing device logs in the interface
- [Log Severity](https://docs.telemetryos.com/docs/log-severity.md): All log severity levels
- [Playbacks](https://docs.telemetryos.com/docs/playbacks.md): Learn how to use Playbacks in TelemetryOS to automate and schedule content displays across devices
- [API Tokens](https://docs.telemetryos.com/docs/api-tokens.md): API token management for programmatic access and reseller account linking
- [Playlist Publishing](https://docs.telemetryos.com/docs/publishing.md): Enable draft/approval workflows and control who can publish
- [Provisioning Tokens](https://docs.telemetryos.com/docs/provisioning-tokens.md): Generate tokens or USB configs to enroll devices at scale
- [Notifications](https://docs.telemetryos.com/docs/notifications-2.md): Send alerts via Slack or webhooks for device and playlist events
- [User Management](https://docs.telemetryos.com/docs/users.md): Multi-user accounts, invitations, and role-based access control
- [Group Management](https://docs.telemetryos.com/docs/user-groups.md): Define role-based permissions and organize access by teams
- [Webhooks](https://docs.telemetryos.com/docs/webhooks.md): Configure device webhooks to stream logs, playbacks, and views
- [Using Playlists](https://docs.telemetryos.com/docs/using-playlists.md): Playlist creation and organization
- [Pages](https://docs.telemetryos.com/docs/pages-1.md): Playlists support adding, editing and changing Pages within Playlists
- [Assigning to a Device](https://docs.telemetryos.com/docs/aspect-ratios-1.md): Link playlists to devices
- [Content Folders](https://docs.telemetryos.com/docs/content-folders.md): Media folder organization and permissions
- [Default Pages](https://docs.telemetryos.com/docs/default-pages.md): Fallback content for playlists when scheduled content is unavailable
- [Embedding](https://docs.telemetryos.com/docs/embedding.md): Web content and external application integration in playlists
- [Persisting Zones](https://docs.telemetryos.com/docs/persisting-zones.md): Uninterrupted media playback across multiple playlist pages
- [Randomization](https://docs.telemetryos.com/docs/randomization.md): Random playback order for playlists and media
- [Scheduling](https://docs.telemetryos.com/docs/scheduling.md): Content scheduling and temporal display control
- [Shared Items](https://docs.telemetryos.com/docs/shared-items.md): Shared and hidden content organization
- [Tag Filtering](https://docs.telemetryos.com/docs/tag-filtering.md): Tag-based content organization and device targeting
- [Videos & Images](https://docs.telemetryos.com/docs/videos-images.md): What can you do with videos and images?
- [Upload Media](https://docs.telemetryos.com/docs/upload-media.md): Media management and supported file types
- [Image Generation](https://docs.telemetryos.com/docs/image-generation.md): AI-powered image creation capabilities
- [Video Compression](https://docs.telemetryos.com/docs/video-compression.md): Video compression options for TelemetryOS
- [Supported Formats](https://docs.telemetryos.com/docs/supported-formats.md): All of the supported media formats for TelemetryOS
- [Optimizing Videos](https://docs.telemetryos.com/docs/optimizing-videos.md): Video optimization for seamless performance
- [Transcoding Videos](https://docs.telemetryos.com/docs/transcoding-videos.md): How to speed up video upload time with transcoding.
- [Bandwidth Limits](https://docs.telemetryos.com/docs/bandwidth-limits.md): Bandwidth allocation and consumption management for TelemetryOS devices and accounts
- [Auto Advance](https://docs.telemetryos.com/docs/auto-advance.md): Automatic playlist progression based on content completion rather than fixed time intervals
- [Media Tags](https://docs.telemetryos.com/docs/media-tags.md): Content-level targeting system for fine-grained control over which media displays on specific devices
- [Editing Media](https://docs.telemetryos.com/docs/editing-media.md): Media editing and management
- [Overrides](https://docs.telemetryos.com/docs/overrides.md): Temporary content supersession for alerts and emergency communications
- [Ask AI in Documentation](https://docs.telemetryos.com/docs/ask-ai.md): Use the Ask AI menu for contextual explanations and examples grounded in the docs
- [Documentation MCP Server](https://docs.telemetryos.com/docs/mcp-server.md): Connect AI editors to the TelemetryOS documentation via MCP
- [Platform MCP Server](https://docs.telemetryos.com/docs/platform-mcp-server.md): Let AI agents act on your TelemetryOS account with scoped, least-privilege tokens
- [LLMS.txt](https://docs.telemetryos.com/docs/llmstxt.md): Description and function of LLMS.txt in the documentation
- [Generating Images](https://docs.telemetryos.com/docs/generating-images.md): Image creation methods and capabilities
- [User API](https://docs.telemetryos.com/docs/user-api.md): Get up and running with our API
- [Metrics API](https://docs.telemetryos.com/docs/metrics-api.md): Submit live KPI values to TelemetryOS dashboards over HTTPS

## API Reference
- [Getting Started with the TelemetryOS API](https://docs.telemetryos.com/reference/getting-started.md): Learn how to authenticate, make your first API call, and integrate with the TelemetryOS platform.
- [Introduction](https://docs.telemetryos.com/reference/introduction.md): Get started with the TelemetryOS User API
- [API Format](https://docs.telemetryos.com/reference/api-format.md): Request and response format specifications for the TelemetryOS API
- [Base URL](https://docs.telemetryos.com/reference/base-url.md): Base URL configuration and endpoints for TelemetryOS API requests
- [Authentication](https://docs.telemetryos.com/reference/authentication-1.md): API authentication methods and token-based access for TelemetryOS
- [Error Codes](https://docs.telemetryos.com/reference/error-codes.md): Our current error code explanations
- [Rate Limits](https://docs.telemetryos.com/reference/rate-limits-1.md): TelemetryOS rate limits
- [Submit a metric](https://docs.telemetryos.com/reference/submit-metric.md): POST live metric values to TelemetryOS dashboards
- [Retrieve all applications](https://docs.telemetryos.com/reference/getallapplications.md): Fetch a list of all applications.
- [Create a new application](https://docs.telemetryos.com/reference/createapplication.md): Create a new application with the provided details.
- [Upload application archive](https://docs.telemetryos.com/reference/uploadapplicationarchive.md): Upload a ZIP archive for an application.
- [Get application build details](https://docs.telemetryos.com/reference/getapplicationbuild.md): Retrieve build information for a specific application.
- [Update application](https://docs.telemetryos.com/reference/updateapplication.md): Update an existing application by its ID.
- [Retrieve all campaigns](https://docs.telemetryos.com/reference/getallcampaigns.md): Fetch a list of all campaigns.
- [Create a new campaign](https://docs.telemetryos.com/reference/createcampaign.md): Create a new campaign.
- [Delete a campaign by ID](https://docs.telemetryos.com/reference/deletecampaign.md): Delete a specific campaign by its ID.
- [Get campaign views](https://docs.telemetryos.com/reference/getcampaignviews.md): Fetch views for a specific campaign with filter options.
- [Export campaign data as CSV](https://docs.telemetryos.com/reference/exportcampaigncsv.md): Export the data of a specific campaign in CSV format.
- [Retrieve all contents](https://docs.telemetryos.com/reference/getallcontents.md): Fetch a list of contents with various filtering options.
- [Update content](https://docs.telemetryos.com/reference/updatecontent.md): Modify specific details of a content item by its ID.
- [Retrieve all content folders](https://docs.telemetryos.com/reference/getallcontentfolders.md): Fetch a list of all content folders.
- [Create a new content folder](https://docs.telemetryos.com/reference/createcontentfolder.md): Create a new folder for organizing content.
- [Modify a content folder](https://docs.telemetryos.com/reference/updatecontentfolder.md): Update the details of a specific content folder by its ID.
- [Delete a content folder](https://docs.telemetryos.com/reference/deletecontentfolder.md): Delete a specific content folder by its ID.
- [Retrieve all devices](https://docs.telemetryos.com/reference/getdevices.md): Fetch a list of devices, optionally paginated.
- [Retrieve a device by ID](https://docs.telemetryos.com/reference/getdevicebyid.md): Fetch details of a specific device by its ID.
- [Modify a device](https://docs.telemetryos.com/reference/modifydevice.md): Update specific fields of a device by its ID.
- [Delete a device](https://docs.telemetryos.com/reference/deletedevice.md): Delete a specific device by its ID.
- [Control a device by issuing a command](https://docs.telemetryos.com/reference/controldevice.md): Send a control command to a specific device, such as switching to the next page, restarting, or pausing/resuming playback.
- [Retrieve account logs](https://docs.telemetryos.com/reference/getaccountlogs.md): Fetch a list of account logs with pagination.
- [Retrieve device logs with filtering options](https://docs.telemetryos.com/reference/getdevicelogs.md): Fetch a list of device logs filtered by event and severity, with pagination.
- [Retrieve logs for a specific device](https://docs.telemetryos.com/reference/getlogsbydeviceid.md): Fetch a list of logs for a specific device by its ID.
- [Retrieve device report logs with filtering options](https://docs.telemetryos.com/reference/getdevicereportlogs.md): Fetch a report of logs for a specific device, playlist, or event type, with pagination.
- [Retrieve all overrides](https://docs.telemetryos.com/reference/getalloverrides.md): Fetch a list of all overrides.
- [Create a new override](https://docs.telemetryos.com/reference/createoverride.md): Create a new override with the provided details.
- [Retrieve a specific override by ID](https://docs.telemetryos.com/reference/getoverridebyid.md): Fetch a specific override by its ID.
- [Delete a specific override by ID](https://docs.telemetryos.com/reference/deleteoverride.md): Delete a specific override by its ID.
- [Modify an override](https://docs.telemetryos.com/reference/modifyoverride.md): Modify an override by its ID.
- [Retrieve all playlists](https://docs.telemetryos.com/reference/getallplaylists.md): Fetch a list of all playlists.
- [Create a new playlist](https://docs.telemetryos.com/reference/createplaylist.md): Create a new playlist with the provided details.
- [Retrieve a specific playlist by ID](https://docs.telemetryos.com/reference/getplaylistbyid.md): Fetch a specific playlist by its ID.
- [Modify a playlist](https://docs.telemetryos.com/reference/modifyplaylist.md): Modify a playlist by its ID.
- [Delete a playlist by ID](https://docs.telemetryos.com/reference/deleteplaylist.md): Delete a specific playlist by its ID.
- [Retrieve all webhooks](https://docs.telemetryos.com/reference/getallwebhooks.md): Fetch a list of all webhooks.
- [Create a new webhook](https://docs.telemetryos.com/reference/createwebhook.md): Create a new webhook with the provided details.
- [Retrieve a specific webhook by ID](https://docs.telemetryos.com/reference/getwebhookbyid.md): Fetch a specific webhook by its ID.
- [Modify a webhook](https://docs.telemetryos.com/reference/modifywebhook.md): Modify a specific webhook by its ID.
- [Delete a specific webhook by ID](https://docs.telemetryos.com/reference/deletewebhook.md): Delete a specific webhook by its ID.
- [Send a message to a webhook](https://docs.telemetryos.com/reference/callwebhookbyid.md): Send a message to a webhook
- [Create a tag webhook](https://docs.telemetryos.com/reference/createtagwebhook.md): Create a new tag-based webhook.