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

Bindings for Jeedom API - https://jeedom.github.io/core/en_US/jsonrpc_api
https://github.com/guillaumearm/jeedom-node

api bindings home-automation jeedom types typescript typings

Last synced: 1 day ago
JSON representation

Bindings for Jeedom API - https://jeedom.github.io/core/en_US/jsonrpc_api

• Host: GitHub
• URL: https://github.com/guillaumearm/jeedom-node
• Owner: guillaumearm
• License: mit
• Created: 2018-11-02T19:42:30.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-05T20:25:09.000Z (about 6 years ago)
• Last Synced: 2024-10-06T17:48:40.772Z (about 1 month ago)
• Topics: api, bindings, home-automation, jeedom, types, typescript, typings
• Language: TypeScript
• Homepage:
• Size: 2.26 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Jeedom API :house:

[![CircleCI branch](https://img.shields.io/circleci/project/github/guillaumearm/jeedom-node/master.svg)](https://circleci.com/gh/guillaumearm/jeedom-node)

[![npm](https://img.shields.io/npm/v/jeedom.svg)](https://www.npmjs.com/package/jeedom)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/guillaumearm/jeedom-node/blob/master/CONTRIBUTING.md)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

This library provides [Jeedom jsonrpc API](https://jeedom.github.io/core/en_US/jsonrpc_api) bindings for node.

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

### Installation

```bash

$ npm install --save jeedom

```

### Basic Usage

```js

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:

```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

```bash

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

$ cd jeedom-node

$ npm install

$ npm run test:all

```