jeedom

Bindings for Jeedom API

Usage no npm install needed!

<script type="module">
  import jeedom from 'https://cdn.skypack.dev/jeedom';
</script>

README

Jeedom API :house:

CircleCI branch npm contributions welcome Commitizen friendly

This library provides Jeedom jsonrpc API bindings for node.

Please note this was tested on Jeedom v3.2.1 and node v8.11.1.

Installation

$ npm install --save jeedom

Basic Usage

const Jeedom = require('jeedom');

const api = Jeedom({
  host: 'http://jeedomip',
  apikey: '__JEEDOM_API_KEY__',
});

api.ping()
  .then(pong => console.log(pong));

api.version()
  .then(version => console.log(version));

api.config.byKey({ key: 'name' })
  .then(jeedomName => console.log(jeedomName));

Typescript support

several useful jeedom types are available for typescript:

import { default as Jeedom, JeedomApi } from 'jeedom';

const api: JeedomApi = Jeedom({
  host: 'http://jeedomip',
  apikey: '__JEEDOM_API_KEY__',
});

Typescript Documentation

https://guillaumearm.github.io/jeedom-node/

Development

$ git clone https://github.com/guillaumearm/jeedom-node.git
$ cd jeedom-node

$ npm install
$ npm run test:all