Giter VIP home page Giter VIP logo

km200-api's Introduction

km200-api

NPM

Release npm version Downloads Issues License

A nodejs module for connecting a buderus heater via km200 interface

It is released as npm module under km200-api

Usage

Install

npm install km200-api

Basic Usage

AES key generator for the KM200 web gateway: https://ssl-account.com/km200.andreashahn.info/

import { Km200 } from 'km200-api';

const key = '<INSERT YOUR KEY HERE>';
const km200 = new Km200('192.168.10.22', 80, key);

// Call a single Value from Buderus KM200
console.log('Get Km200 Firmware Verion ... ');
km200.getKM200('/gateway/versionFirmware').then((data) => {
  console.log('Km200 Firmware: ' + data.value);
});

// Print a single API with all provided sub calls
km200.printSingleApi('/gateway');

// Print all provided API calls
km200.printCompleteApi();

More Examples

More examples and details in exampe.ts

You can also check my own project for detailed usage example and inspiration https://github.com/jenszech/hm-node-runner

Dokumentation

Development and build pipeline

Release a new version

npm version major|minor|patch
npm publish

Further documentation

Step by step: Building and publishing an NPM Typescript package.
https://itnext.io/step-by-step-building-and-publishing-an-npm-typescript-package-44fe7164964c

License

See the LICENSE file for license rights and limitations (MIT).

km200-api's People

Contributors

jenszech avatar stelzo avatar

Forkers

ahein88

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.