luxtronik2-ws-api
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

Luxtronik2 WebSocket API

Luxtronik2 WebSocket API is the result of reverse engineering of Luxtronik2 web interface.

How to use

Establish Connection

    const lx = await Luxtronik2.connect("192.168.178.29", "012345"); // Heating Pump IP and Password 

Traverse Items

The original web interface api repeats the menu hirarchy. So either you follow this hirarchy in you business logic or you flatten it by you own.

Following example shows how to get outdoor temperature.

    console.log("Outdoor temperature: " + (await (await (await lx.access.get("Informationen")).get("Temperaturen")).get("Aussentemperatur")).value());

At least ones you will need to list names of all menu items to get them know.

    console.log((await (await lx.access.get("Informationen")).get("Temperaturen")).names());

Close Connection

Successfully opened connection should be properly closed otherwise your program will never stop.

    const lx = await Luxtronik2.connect(wpIp, PW);

    try{
        // print first level of menu
        console.log(lx.access.names());
    }finally{
        lx.disconnect();
    }

Change log

  • 1.0.3 Added timeout parameters for connection

Readme

Keywords

Package Sidebar

Install

npm i luxtronik2-ws-api

Weekly Downloads

1

Version

1.1.0

License

ISC

Unpacked Size

18.8 kB

Total Files

14

Last publish

Collaborators

  • sieukrem