0.2.3 • Published 4 years ago

km200-api v0.2.3

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

km200-api

Release npm version 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).