@telemetrytv/sdk

Telemetry Applications SDK

Hi there, the Telemetry team would like to welcome you on your journey to build a Telemetry application!

Telemetry Applications are just like any other web application or website, but can be enhanced by integrating with our platform. We provide additional features and capabilities that can be used to build a wide range of applications. Features such as offline capabilities, key value storage, both at the device or application level, and the ability to interact with hardware attached to your device.

In order to use these features you simply have to add our SDK to your project. This can be done by installing it as an npm package. It is also available as a script embed via jsDelivr.

Getting Started

To get started add the SDK to your project. If you are using npm you can install it by running:

npm install @telemetrytv/sdk

If you are not using npm you can include the script in your HTML file:

<script src="https://cdn.jsdelivr.net/npm/@telemetrytv/sdk"></script>

Once installed you should be able to import it into your project. If you installed it via npm you can import it like so:

import { configure } from '@telemetrytv/sdk';

configure('myAppName')

If you included the script in your HTML file you can access it via the global telemetry object.

telemetry.configure('myAppName')

Documentation