node-red-contrib-lorawan-bacnet-server 1.2.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to node-red-contrib-lorawan-bacnet
+
+## Prerequisites
+
+- Docker installed and running
+- Git installed
+- Terminal access with necessary permissions
+
+## Clone the Repository
+
+Start by cloning the repository locally:
+
+```bash
+git clone https://github.com/SylvainMontagny/node-red-contrib-lorawan-bacnet.git
+cd node-red-contrib-lorawan-bacnet
+```
+
+## Run the Docker Container with the Code Mounted as a Volume
+
+Use the `montagny/node-red` image to start a container with your local code mounted:
+
+```bash
+docker run -d \
+  --name node-red-lorawan-bacnet \
+  -p 1880:1880 \
+  -v $(pwd):/data/node-red-contrib-lorawan-bacnet \
+  -u root \
+  montagny/node-red
+```
+
+> Replace `$(pwd)` with the full path if you’re not running the command from the project directory.
+
+## Link the Palette Locally with `npm link`
+
+Once the container is running, open a shell inside:
+
+```bash
+docker exec -it node-red-lorawan-bacnet bash
+```
+
+Inside the container, run the following:
+
+```bash
+npm uninstall @montagny/node-red-contrib-lorawan-bacnet
+npm link /data/node-red-contrib-lorawan-bacnet
+```
+
+This allows Node-RED to use the development version of the palette directly from the mounted volume.
+
+## Restart Node-RED
+
+Restart the container from the host machine:
+
+```bash
+docker restart node-red-lorawan-bacnet
+```
+
+## Testing
+
+Once linked, open the Node-RED editor in your browser:
+
+[http://localhost:1880](http://localhost:1880)
+
+You can now test your changes directly from the editor, you have to restart container to apply changes.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elias-qzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+# LoRaBAC, an open-source LoRaWAN to BACnet interface
+The [LoRaBAC node](https://flows.nodered.org/node/@montagny/node-red-contrib-lorawan-bacnet) is the configuration node of the [LoRaBAC application](https://github.com/SylvainMontagny/LoRaBAC).
+
+
+- [LoRaBAC, an open-source LoRaWAN to BACnet interface](#lorabac-an-open-source-lorawan-to-bacnet-interface)
+  - [**1. Overview**](#1-overview)
+    - [**1.1. What is LoRaBAC?**](#11-what-is-lorabac)
+      - [**Key Features:**](#key-features)
+    - [**1.2. What Makes LoRaBAC Unique?**](#12-what-makes-lorabac-unique)
+      - [**Drawbacks:**](#drawbacks)
+    - [**1.3. Support**](#13-support)
+  - [**2. Prerequisites**](#2-prerequisites)
+    - [**2.1. LoRaWAN End-Device**](#21-lorawan-end-device)
+    - [**2.2. MQTT Broker**](#22-mqtt-broker)
+    - [**2.3. Node-RED Setup**](#23-node-red-setup)
+      - [**Additional Packages for ChirpStackV4:**](#additional-packages-for-chirpstackv4)
+      - [**Quick Start with Docker:**](#quick-start-with-docker)
+  - [**3. Getting Started**](#3-getting-started)
+
+## **1. Overview**
+### **1.1. What is LoRaBAC?**
+LoRaBAC is open-source application built on **Node-RED**. It allows you to integrate LoRaWAN devices with BACnet controllers, making it ideal for **smart building applications**.
+
+![LoRaBAC](images/lorabac.png)
+#### **Key Features:**
+- **Universal Compatibility:**
+  - [x] Works with **all LoRaWAN end-devices** and **gateways**.
+  - [x] Supports **ChirpStack**, **Actility**, and **The Things Stack** (The Things Network / The Things Industries) Network Servers.
+  - [x] Integrates with **all BACnet controllers** using native BACnet protocols (or **Distech-Controls controllers** when using Rest API).
+
+- **Bidirectional Communication:**
+  - [x] **Uplink:** Writes LoRaWAN payloads to specific BACnet objects.
+  - [x] **Downlink:** Writes BACnet objects to specific LoRaWAN payload.
+
+- **Proven Use Cases:**
+  - [x] Thermostatic valves
+  - [x] Temperature and humidity sensors
+  - [x] Air quality sensors
+  - [x] Current monitoring sensors
+  - [x] Pilot wired electric heater controller
+
+
+### **1.2. What Makes LoRaBAC Unique?**
+LoRaBAC is designed with a **different approach** compared to other LoRaWAN-BACnet interfaces. Here’s why it stands out:
+
+**Advantages** :
+
+1. **BACnet Client Architecture:**
+   - Unlike most interfaces that act as **BACnet servers**, LoRaBAC operates as a **BACnet client**. It only interacts with the controller when a LoRaWAN payload is received, reducing unnecessary traffic.
+
+2. **Flexible Deployment:**
+   - LoRaBAC can be installed **anywhere**:
+     - On the **LoRaWAN Gateway**
+     - Within the **local network**
+     - Directly on the **BACnet controller**
+
+3. **Open Source and Free:**
+   - LoRaBAC is **free to use** and **open-source** under the **MIT License**, offering full transparency and customization.
+
+#### **Drawbacks:**
+1. **No "Who-is" Service Support:**
+   - LoRaBAC does not respond to the **"Who-is" service**, which can be useful for discovering BACnet devices in some setups.
+
+2. **Manual Configuration Required:**
+   - Each new LoRaWAN device type requires **manual configuration**. It is not a "Plug and Play" solution.
+
+### **1.3. Support**
+To get support on LoRaWAN or LoRaBAC, please refers to the following ressources, or [reach us](https://www.univ-smb.fr/lorawan/en/contact/) out.
+
+:tv: Webinar Replay: [LoRaWAN and BACnet interfaces for Smart Building]()
+
+:notebook: Free ebook:[LoRaWAN for beginers books](https://www.univ-smb.fr/lorawan/en/free-book/)
+
+:tv: E-learning platform: [LoRaWAN for beginers videos](https://www.udemy.com/course/lora-lorawan-internet-of-things/?referralCode=21DED0F1021F4E261955)
+
+:tv: E-learning platform for Advanced users: [LoRaWAN for Advanced users videos](https://www.udemy.com/course/lorawan-for-advanced-users/?referralCode=BA4A670560916E1AED77)
+
+:bulb: 2 days training sessions: [LoRaWAN and IoT Training](https://www.univ-smb.fr/lorawan/avada_portfolio/formation-distanciel/)
+
+## **2. Prerequisites**
+### **2.1. LoRaWAN End-Device**
+To use LoRaBAC you will need:
+- a LoRaWAN **Network Server** (ChirpStack, TTN or Actility).
+- The device **payload decoders** (for uplink).
+- the device **payload encoders** (for downlink, if needed).
+
+Payload decoder and encoders should be provided by your device manufacturer, however, in this repository you will find the payload codec of the tested devices.
+
+
+### **2.2. MQTT Broker**
+LoRaBAC relies on an **MQTT broker** for communication. You can use:
+- The built-in MQTT broker provided by **ChirpStack**, **Actility**, or **The Things Stack**.
+- Your own **custom MQTT broker**.
+
+
+### **2.3. Node-RED Setup**
+LoRaBAC is a **Node-RED flow**, so you need a **Node-RED instance** to run it. Ensure the following packages are installed:
+
+- @montagny/node-red-contrib-lorawan-bacnet
+
+#### **Additional Packages for ChirpStackV4:**
+If you’re using **ChirpStackV4** and want to enable the **"Flush Downlink Queue"** feature, install:
+- `@grpc/grpc-js`
+- `@chirpstack/chirpstack-api`
+
+#### **Quick Start with Docker:**
+A pre-configured **Node-RED Docker image** is available on [Docker Hub](https://hub.docker.com/r/montagny/node-red/tags). It includes all required packages for easy deployment.
+
+
+## **3. Getting Started**
+Please, follow the information given in the [LoRaBAC application](https://github.com/SylvainMontagny/LoRaBAC).

package/examples/BACnet-Server.json

@@ -0,0 +1,401 @@
+[
+    {
+        "id": "bacnet-server-example-flow",
+        "type": "tab",
+        "label": "BACnet Server Example",
+        "disabled": false,
+        "info": "# BACnet Server Example\n\nThis flow demonstrates how to use the BACnet Server functionality to expose Node-RED as a BACnet device on the network.\n\n## Components\n\n1. **BACnet Server** (configuration node): Manages the BACnet device identity and handles Who-Is/I-Am discovery.\n\n2. **BACnet Points**: Individual objects exposed to BACnet clients:\n   - Temperature (Analog Value): Simulated temperature sensor\n   - Humidity (Analog Value): Simulated humidity sensor\n   - Fan Status (Binary Value): Controllable fan state\n   - Operating Mode (Multi-State Value): HVAC mode selector\n\n3. **Simulators**: Inject nodes that simulate sensor data updates.\n\n4. **Output handlers**: Process writes from external BACnet clients.\n\n## Testing\n\n1. Install YABE (Yet Another BACnet Explorer) or a similar BACnet client\n2. Deploy this flow\n3. Scan the network - the Node-RED device should appear\n4. Read the exposed points\n5. Write to writable points and observe the debug output"
+    },
+    {
+        "id": "bacnet-server-config-1",
+        "type": "bacnet-server",
+        "name": "Node-RED BACnet Device",
+        "deviceId": "123456",
+        "deviceName": "Node-RED-BACnet",
+        "vendorId": "999",
+        "port": "47808",
+        "interface": "",
+        "broadcastAddress": "255.255.255.255"
+    },
+    {
+        "id": "bacnet-point-temp",
+        "type": "bacnet-point",
+        "z": "bacnet-server-example-flow",
+        "name": "Temperature",
+        "server": "bacnet-server-config-1",
+        "objectType": "analogValue",
+        "instanceNumber": "1",
+        "objectName": "Room_Temperature",
+        "initialValue": "21.5",
+        "units": "62",
+        "description": "Room temperature sensor",
+        "writable": false,
+        "usePriorityArray": false,
+        "relinquishDefault": "0",
+        "covIncrement": "0.5",
+        "numberOfStates": "3",
+        "stateText": "",
+        "outputOnRead": true,
+        "outputOnWrite": false,
+        "outputOnCov": false,
+        "x": 430,
+        "y": 100,
+        "wires": [
+            ["debug-read"]
+        ]
+    },
+    {
+        "id": "bacnet-point-humidity",
+        "type": "bacnet-point",
+        "z": "bacnet-server-example-flow",
+        "name": "Humidity",
+        "server": "bacnet-server-config-1",
+        "objectType": "analogValue",
+        "instanceNumber": "2",
+        "objectName": "Room_Humidity",
+        "initialValue": "45",
+        "units": "29",
+        "description": "Room humidity sensor",
+        "writable": false,
+        "usePriorityArray": false,
+        "relinquishDefault": "0",
+        "covIncrement": "1",
+        "numberOfStates": "3",
+        "stateText": "",
+        "outputOnRead": true,
+        "outputOnWrite": false,
+        "outputOnCov": false,
+        "x": 430,
+        "y": 160,
+        "wires": [
+            ["debug-read"]
+        ]
+    },
+    {
+        "id": "bacnet-point-fan",
+        "type": "bacnet-point",
+        "z": "bacnet-server-example-flow",
+        "name": "Fan Status",
+        "server": "bacnet-server-config-1",
+        "objectType": "binaryValue",
+        "instanceNumber": "1",
+        "objectName": "Fan_Status",
+        "initialValue": "0",
+        "units": "",
+        "description": "Fan on/off control",
+        "writable": true,
+        "usePriorityArray": true,
+        "relinquishDefault": "0",
+        "covIncrement": "0",
+        "numberOfStates": "3",
+        "stateText": "",
+        "outputOnRead": false,
+        "outputOnWrite": true,
+        "outputOnCov": false,
+        "x": 430,
+        "y": 240,
+        "wires": [
+            ["debug-write", "fan-control-handler"]
+        ]
+    },
+    {
+        "id": "bacnet-point-mode",
+        "type": "bacnet-point",
+        "z": "bacnet-server-example-flow",
+        "name": "Operating Mode",
+        "server": "bacnet-server-config-1",
+        "objectType": "multiStateValue",
+        "instanceNumber": "1",
+        "objectName": "HVAC_Mode",
+        "initialValue": "1",
+        "units": "",
+        "description": "HVAC operating mode",
+        "writable": true,
+        "usePriorityArray": false,
+        "relinquishDefault": "1",
+        "covIncrement": "0",
+        "numberOfStates": "4",
+        "stateText": "Off, Heating, Cooling, Auto",
+        "outputOnRead": false,
+        "outputOnWrite": true,
+        "outputOnCov": false,
+        "x": 430,
+        "y": 300,
+        "wires": [
+            ["debug-write", "mode-change-handler"]
+        ]
+    },
+    {
+        "id": "bacnet-point-setpoint",
+        "type": "bacnet-point",
+        "z": "bacnet-server-example-flow",
+        "name": "Temperature Setpoint",
+        "server": "bacnet-server-config-1",
+        "objectType": "analogValue",
+        "instanceNumber": "3",
+        "objectName": "Temp_Setpoint",
+        "initialValue": "22",
+        "units": "62",
+        "description": "Temperature setpoint",
+        "writable": true,
+        "usePriorityArray": true,
+        "relinquishDefault": "21",
+        "covIncrement": "0.5",
+        "numberOfStates": "3",
+        "stateText": "",
+        "outputOnRead": false,
+        "outputOnWrite": true,
+        "outputOnCov": false,
+        "x": 430,
+        "y": 360,
+        "wires": [
+            ["debug-write"]
+        ]
+    },
+    {
+        "id": "inject-temp-simulator",
+        "type": "inject",
+        "z": "bacnet-server-example-flow",
+        "name": "Simulate Temperature",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "10",
+        "crontab": "",
+        "once": true,
+        "onceDelay": "1",
+        "topic": "",
+        "payload": "$floor($random() * 100) / 10 + 18",
+        "payloadType": "jsonata",
+        "x": 180,
+        "y": 100,
+        "wires": [
+            ["bacnet-point-temp"]
+        ]
+    },
+    {
+        "id": "inject-humidity-simulator",
+        "type": "inject",
+        "z": "bacnet-server-example-flow",
+        "name": "Simulate Humidity",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "15",
+        "crontab": "",
+        "once": true,
+        "onceDelay": "2",
+        "topic": "",
+        "payload": "$floor($random() * 30) + 35",
+        "payloadType": "jsonata",
+        "x": 180,
+        "y": 160,
+        "wires": [
+            ["bacnet-point-humidity"]
+        ]
+    },
+    {
+        "id": "debug-read",
+        "type": "debug",
+        "z": "bacnet-server-example-flow",
+        "name": "Read Events",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 650,
+        "y": 130,
+        "wires": []
+    },
+    {
+        "id": "debug-write",
+        "type": "debug",
+        "z": "bacnet-server-example-flow",
+        "name": "Write Events",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 650,
+        "y": 270,
+        "wires": []
+    },
+    {
+        "id": "fan-control-handler",
+        "type": "function",
+        "z": "bacnet-server-example-flow",
+        "name": "Fan Control Handler",
+        "func": "// Handle fan control command from BACnet client\nif (msg.bacnet && msg.bacnet.event === 'write') {\n    const fanState = msg.payload === 1 ? 'ON' : 'OFF';\n    node.status({\n        fill: msg.payload === 1 ? 'green' : 'grey',\n        shape: 'dot',\n        text: `Fan ${fanState} (Priority: ${msg.bacnet.priority})`\n    });\n    \n    // Here you could send a command to actual hardware\n    // e.g., via MQTT, GPIO, or other Node-RED nodes\n    msg.fanCommand = {\n        action: fanState,\n        priority: msg.bacnet.priority,\n        source: msg.bacnet.source,\n        timestamp: new Date().toISOString()\n    };\n    \n    return msg;\n}\nreturn null;",
+        "outputs": 1,
+        "timeout": "",
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 670,
+        "y": 330,
+        "wires": [
+            ["debug-fan-action"]
+        ]
+    },
+    {
+        "id": "mode-change-handler",
+        "type": "function",
+        "z": "bacnet-server-example-flow",
+        "name": "Mode Change Handler",
+        "func": "// Handle mode change from BACnet client\nif (msg.bacnet && msg.bacnet.event === 'write') {\n    const modes = ['Off', 'Heating', 'Cooling', 'Auto'];\n    const modeName = modes[msg.payload - 1] || 'Unknown';\n    \n    node.status({\n        fill: 'blue',\n        shape: 'dot',\n        text: `Mode: ${modeName}`\n    });\n    \n    msg.modeChange = {\n        mode: msg.payload,\n        modeName: modeName,\n        source: msg.bacnet.source,\n        timestamp: new Date().toISOString()\n    };\n    \n    return msg;\n}\nreturn null;",
+        "outputs": 1,
+        "timeout": "",
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 680,
+        "y": 390,
+        "wires": [
+            ["debug-mode-action"]
+        ]
+    },
+    {
+        "id": "debug-fan-action",
+        "type": "debug",
+        "z": "bacnet-server-example-flow",
+        "name": "Fan Action",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "fanCommand",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 890,
+        "y": 330,
+        "wires": []
+    },
+    {
+        "id": "debug-mode-action",
+        "type": "debug",
+        "z": "bacnet-server-example-flow",
+        "name": "Mode Action",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "modeChange",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 890,
+        "y": 390,
+        "wires": []
+    },
+    {
+        "id": "comment-header",
+        "type": "comment",
+        "z": "bacnet-server-example-flow",
+        "name": "BACnet Server Example - Expose Node-RED as a BACnet Device",
+        "info": "This flow demonstrates the BACnet Server functionality.\n\nThe bacnet-server configuration node creates a BACnet device\nthat responds to Who-Is requests and allows external clients\nto read and write the exposed points.\n\nUse YABE or another BACnet client to test.",
+        "x": 280,
+        "y": 40,
+        "wires": []
+    },
+    {
+        "id": "comment-sensors",
+        "type": "comment",
+        "z": "bacnet-server-example-flow",
+        "name": "Sensor Simulation (Read-Only Points)",
+        "info": "",
+        "x": 190,
+        "y": 60,
+        "wires": []
+    },
+    {
+        "id": "comment-controls",
+        "type": "comment",
+        "z": "bacnet-server-example-flow",
+        "name": "Control Points (Writable)",
+        "info": "",
+        "x": 150,
+        "y": 200,
+        "wires": []
+    },
+    {
+        "id": "inject-manual-fan-on",
+        "type": "inject",
+        "z": "bacnet-server-example-flow",
+        "name": "Fan ON (Priority 16)",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "1",
+        "payloadType": "num",
+        "x": 180,
+        "y": 240,
+        "wires": [
+            ["bacnet-point-fan"]
+        ]
+    },
+    {
+        "id": "inject-manual-fan-off",
+        "type": "inject",
+        "z": "bacnet-server-example-flow",
+        "name": "Fan OFF (Priority 16)",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "0",
+        "payloadType": "num",
+        "x": 180,
+        "y": 280,
+        "wires": [
+            ["bacnet-point-fan"]
+        ]
+    },
+    {
+        "id": "comment-integration",
+        "type": "comment",
+        "z": "bacnet-server-example-flow",
+        "name": "Integration Example: LoRaWAN -> BACnet",
+        "info": "Connect LoRaBAC output to bacnet-point input\nto expose LoRaWAN sensor data as BACnet points.",
+        "x": 200,
+        "y": 440,
+        "wires": []
+    },
+    {
+        "id": "example-lorawan-input",
+        "type": "comment",
+        "z": "bacnet-server-example-flow",
+        "name": "[LoRaBAC] -> [Function: Extract Temp] -> [bacnet-point: Temperature]",
+        "info": "",
+        "x": 260,
+        "y": 480,
+        "wires": []
+    }
+]