@essenius/node-red-openhab4/nodes/controller.js

OpenHAB 4 integration nodes for Node-RED

// Copyright 2025 Rik Essenius
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License is
// distributed on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and limitations under the License.


"use strict";

const { httpRequest, getConnectionString, setDefaults } = require("../lib/connectionUtils");
const { setupControllerNode } = require('../lib/controllerLogic');
const { ENDPOINTS } = require("../lib/constants");

/** Handler for the httpAdmin request to get all OpenHAB items. This is used to populate the dropdowns in the controller and other nodes */
function createItemsHandler() {
    return async function (request, response) {
        // request.query also contains the credentials, so we can use it to fetch items
        const config = setDefaults(request.query);
        const url = getConnectionString(config) + ENDPOINTS.ITEMS;
        try {
            const result = await httpRequest(url, config);
            if (result.data) {
                response.send(result.data); // implicitly returns 200 OK
                return;
            }
            response.sendStatus(204); // No content. This is not expected, but we handle it nonetheless
        } catch (error) {
            // if we get an error, we return the error message and status code. 
            // We need to make sure the errors are valid, so we replace negative numbers by 500.
            const status = !error.status || error.status < 0 ? 500 : error.status;
            return response.status(status).send(error.message);
        }
    };
}

/** Controller module for OpenHAB, which sets up the controller node and handles the items request */
function controllerModule(RED) {
    const maybeFn = require("./admin");
    maybeFn(RED);

    // start a web service for enabling the node configuration ui to retrieve the available openHAB items

    RED.httpAdmin.get("/openhab4/items", createItemsHandler());

    function createControllerNode(config) {
        RED.nodes.createNode(this, config);
        const mergedConfig = setDefaults({ ...config, ...(this.credentials || {}) });
        this.name = config.name || `${config.host}:${config.port}`;
        setupControllerNode(this, mergedConfig);
    }

    RED.nodes.registerType("openhab4-controller", createControllerNode, {
        credentials: {
            username: { type: "text" },
            password: { type: "password" }
        }
    });
}

controllerModule.createItemsHandler = createItemsHandler;
module.exports = controllerModule;