Skip to content

jessedp/tablo-api-js

Repository files navigation

tablo-api

tablo-api provides a simple API module to interact with Tablo DVRs. It was developed to be used with Node/Electron - it may work in the browser, though ymmv.

Installation

Install with npm

  npm install tablo-api

or with yarn

  yarn add tablo-api

Usage

In Node:

const {Tablo} = require('tablo-api');

const Api = new Tablo();

const devices = Api.discover();

Api.device = { private_ip: "192.168.1.100" }
 
const serverInfo = Api.getServerInfo();

const recordings = Api.get('/recordings/airings');

Development

After you've cloned this repo, there are some built-in commands to aid in development:

Build the package - outputs built files to ./dist/. These are the ones that will ultimately end up in the pacakage.

npm run-script build

or

yarn build

Linter - runs standard lint checks to keep code clean.

npm run-script lint

or

yarn lint

Formatter - formats the code in place for consistency.

npm run-script format

or

yarn format

Licence

MIT