Constructor usage
`javascript
import {XmlApi} from "homematic-js-xmlapi";
const xmlApi = new XmlApi("1.1.1.1", 80);
`

Api functions
`javascript
import { DeviceManager } from 'homematic-js-xmlapi';

// Get XML Addon Verion
// return Promise
xmlApi.getVersion().then((version) => {
console.log('XML Addon version: ', version);
});

// Get all devices ...
// return Promise
xmlApi.getDeviceList().then((deviceList) => {
if (deviceList) deviceMgr.updateDeviceList(deviceList);
});

// Get a single device state ...
// return Promise
xmlApi.getState('1481').then((deviceList) => {
if (deviceList) deviceMgr.updateDeviceList(deviceList);
});

// Get all device states ...
// return Promise
xmlApi.getStateList().then((deviceList) => {
if (deviceList) deviceMgr.updateDeviceList(deviceList);
});

// Get a single SystemVariable value ...
// return Promise
xmlApi.getSysVar('7264').then((sysVarList) => {
if (deviceList) deviceMgr.updateDeviceList(deviceList);
});

// Get all SystemVariable values ...
// return Promise
xmlApi.getSysVarList().then((sysVarList) => {
if (deviceList) deviceMgr.updateDeviceList(deviceList);
});
`
#### DeviceManager
Constructor usage
`javascript
import { DeviceManager } from 'homematic-js-xmlapi';
const devMgr = new DeviceManager();
`

Api functions
`javascript
// Add or Update a single Device
// Parameter: Device
devMgr.updateDevice(device);

// Add or Update a list of Devices
// Parameter: Device[]
devMgr.updateDeviceList(deviceList);

// Get actual count of known devices
devMgr.mapCount();

// Get the actual cached device with given device name
// Parameter: name: string
// return Device | null
devMgr.getDeviceByName(name);

// Get the actual cached Channel with given Channel name
// Parameter: name: string
// return Channel | null
devMgr.getDeviceByName(name);

// Get the actual cached Datapoint with given DataType from given Channel
// Parameter: channel : Channel
// Parameter: type : DataType
// return Channel | null
devMgr.getValueByTyp(name);

// print a complete list of all kown devices to console
devMgr.printDeviceList

// print a complete list of all kown devices grouped and counted by deviceType to console
devMgr.printDeviceTypes();
`

#### SystemVariableManager
Constructor usage
`javascript
import { SystemVariableManager } from 'homematic-js-xmlapi';
const sysMgr = new SystemVariableManager();
`

Api functions
`javascript
// Add or Update a single Variable
// Parameter: SystemVariable
sysMgr.updateDevice(sysVar);

// Add or Update a list of variables
// Parameter: SystemVariable[]
sysMgr.updateDeviceList(sysVarList);

// Get actual count of known variables
sysMgr.mapCount();

// Get the actual cached device with given variable name
// Parameter: name: string
// return SystemVariable | null
sysMgr.getVariableByName(name);

// print a complete list of all kown variables to console
sysMgr.printSysVarList();
`

$3

`javascript
import { Device, Channel, DataPoint, SystemVariable } from 'homematic-js-xmlapi'
import { DataType, ValueType } from 'homematic-js-xmlapi' //only if needed
`
`javascript
Device {
name: string;
iseId: string;
unreach: boolean;
stickyUnreach: boolean;
configPending: boolean;
address: string | null;
deviceType: string | null;
channel: Map = new Map();
}
`
`javascript
Channel {
name: string;
iseId: string;
address: string | null;
dataPoint: Map = new Map();
}
`
`javascript
DataPoint {
name: string;
iseId: string;
type: DataType;
value: string;
valueType: ValueType;
timestamp: Date | null;
}
`
`javascript
SystemVariable {
name: string;
iseId: string;
value: string | number | boolean | null;
valueList: string;
valueType: number;
timestamp: Date | null;
}
`

Development and build pipeline

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