1.0.0 • Published 6 years ago

brematic v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Brematic Package for Node.js

npm version Beerpay Beerpay

This project is a Node.js package to control devices via for Brennenstuhl Brematic Gateway and compatible Gateways like "Conn Air".

If you are not creating a new project, you might be more interested in the following packages:

Installing

The plugin is published through NPM and should be installed "globally" by typing:

To you want use this package in your project, you can install it via NPM or Yarn:

npm install brematic --save
yarn add brematic

Using

Below you can find a small example of how this package can be used.

let Brematic = require('brematic');

let configuration = {
  // See configuration section
};
let myDevice = new Brematic(configuration);

myDevice.setValue(false);
console.log(myDevice.getValue();)

Configuration

NameOptionalTypeDescription
hostnoStringHostname or IP Address of your gateway
portyesintPort of your gateway (Usually 49880)
deviceTypenoStringType of Device (See: List of Device Types)
deviceConfignoStringDevice Type specific Configuration (See: Device Types)

Device Types

Device types are drivers for the different kind of devices that can be controlled via Brennenstuhl Brematic Gateway and compatible Garteways like "Conn Air". The apropriate configuration for each device type can be found in the specific configruation linked below.

The devices listed below have been successfully tested with this package:

VendorDevice NameDevice TypeComment
BrennerstuhlRCS1000NDefault-
Pollin2605Default-

Contributing

I'm more than happy for any kind fo feedback! If you'd like to participate in this project, feel free to contact me. You can reach me directly either via Twitter or E-Mail.

More Details about Contributing can be found here.