innogy-smarthome-lib

Innogy SmartHome Client API Node.js Library

The JavaScript library for using the Innogy SmartHome system.

The library abstracts the RESTful Innogy SmartHome Client API in a platform independent JavaScript library, which is distributed for applications using Node.js or the browser.

HELP WANTED!

As this project is developed during my spare time, I*m actively looking for help to maintain and extend this lib! If you're willing to help, drop me a line!

Using the Library

const SmartHome = require("./lib/smarthome");

const config = {
    redirectHost: 'www.example.com',    // define your redirect host here (set by innogy, without http/https)
    id: '1234567890',                   // oAuth2 ID (to be requested from innogy)
    secret: 'SECRET',                   // oAuth2 secret (to be requested from innogy)

    // Local SHC connection (requires currently SHC 2 and Software Version > 8.17)
    // This SHC version is currently in BETA
    localShc: "192.168.100.100",        // Local SHC IPs
    localPassword: "PASSWORD",          // Local SHC Password
    localConnection: false,              // Set to true, if you want to use a local connection instead of a cloud one
};

const smartHome = new SmartHome(config);

smartHome.on("needsAuthorization", function (auth) {
    console.log(auth);
});

smartHome.on("needsMobileAccess", function () {
    console.log("YOU NEED TO BUY MOBILE ACCESS!");
});

smartHome.on("needsMobileAccess", function () {
    console.log("YOU NEED TO BUY MOBILE ACCESS!");
});

smartHome.on("stateChanged", function (aCapability) {
    console.log("stateChanged");

    console.log("    ID:", aCapability.id);
    console.log("    Type:", aCapability.type);

    if (aCapability.Config.length) {
        console.log("    - CONFIG:");

        aCapability.Config.forEach(function (aState) {
            console.log("        Name:", aState.name);
            console.log("        Type:", aState.type);
            console.log("        Access:", aState.access);
            console.log("        Value:", aState.value);
            console.log("        LastChanged:", aState.lastchanged);
            console.log("");
        });
    }

    if (aCapability.State.length) {
        console.log("    - STATES:");

        aCapability.State.forEach(function (aState) {
            console.log("        Name:", aState.name);
            console.log("        Type:", aState.type);
            console.log("        Access:", aState.access);
            console.log("        Value:", aState.value);
            console.log("        LastChanged:", aState.lastchanged);
            console.log("");
        });
    }
});

smartHome.on("initializationComplete", function () {
    console.log("INITIALIZATION SEQUENCE COMPLETED");

    if (smartHome.device && smartHome.device.length) {
        console.log("LIST OF ALL REGISTERED DEVICES:");

        smartHome.device.forEach(function (aDevice) {
            console.log("----------------------------------------");

            console.log("ID:", aDevice.id);
            console.log("Type:", aDevice.type);
            console.log("Name:", aDevice.getName()); // Helper needed, as name is stored within configuration!

            if (aDevice.Location)
                console.log("Location:", aDevice.Location.getName()); // Helper needed, as name is stored within configuration!

            console.log("- CAPABILITIES:");

            aDevice.Capabilities.forEach(function (aCapability) {
                console.log("    ID:", aCapability.id);
                console.log("    Type:", aCapability.type);

                if (aCapability.Config.length) {
                    console.log("    - CONFIG:");

                    aCapability.Config.forEach(function (aState) {
                        console.log("        Name:", aState.name);
                        console.log("        Type:", aState.type);
                        console.log("        Access:", aState.access);
                        console.log("        Value:", aState.value);
                        console.log("        LastChanged:", aState.lastchanged);
                        console.log("");
                    });
                }

                if (aCapability.State.length) {
                    console.log("    - STATES:");

                    aCapability.State.forEach(function (aState) {
                        console.log("        Name:", aState.name);
                        console.log("        Type:", aState.type);
                        console.log("        Access:", aState.access);
                        console.log("        Value:", aState.value);
                        console.log("        LastChanged:", aState.lastchanged);
                        console.log("");

                    });
                }

                console.log("");
            });
        });
    }

    // Get capapbility by ID
    var cap = smartHome.getCapabilityById("CAPABILITY ID");

    // setState accepts as first parameter the value you want to set
    // will be parsed automatically, so "true", true, 1 for a boolean value is allowed
    // the second parameter is the state you want to set (optional, if missing the first state is used)
    cap.setState(true, "OnState");

    // Close connection once everything is done
    smartHome.finalize();
});

console.log("Auth start uri (if auth missing)", smartHome.getAuthorizationUri());
smartHome.init();

Contributing

Any contributions are welcome. However, before filing a pull request (PR) an issue should be opened. The issue should contain:

• What improvement / fix is needed
• How the solution will look like
• If on-going: the current process
• Where the improvement is helping or how the bug can be reproduced

More information about our contribution guidelines can be found in the CONTRIBUTING file.

License

The library has been licensed under the MIT license. Details are given the distributed license file.

Changelog

0.10.1 (2022-12-31)

• Optimize Authentication server handling