RAK7437 BACnet Profiles

English | 中文

A repository of BACnet configuration profiles for LoRaWAN devices used with RAKwireless gateways. This repository contains mapping configuration files that convert LoRaWAN sensor/actuator data from multiple vendors to BACnet objects.

📋 Table of Contents

• Introduction
• Project Structure
• Profile Format
• Usage
• Contributing

📖 Introduction

This repository provides conversion configuration files from LoRaWAN devices to BACnet protocol. These profile files enable RAK gateways to map LoRaWAN device data to standard BACnet objects (such as Analog Input, Binary Input, Analog Output, etc.), achieving seamless integration with Building Management Systems (BMS).

Key Features

• 🔄 Automatic LoRaWAN data encoding and decoding
• 📊 Mapping LoRaWAN data to standard BACnet objects
• 🏢 Support for various building sensors and actuators
• ⚙️ Configurable object properties (update interval, COV increment, etc.)
• 🔌 Support for bidirectional communication (read sensor data and control actuators)

📁 Project Structure

RAK-BACnet-Profiles/
├── profiles/                   # Real device profiles
│   ├── Carrier/               # Carrier devices
│   ├── Dragino/               # Dragino devices
│   ├── Milesight/             # Milesight devices
│   └── Senso8/                # Senso8 devices
│       ├── *.yaml             # Profile files
│       └── tests/             # Test data (optional)
├── examples/                  # Example profiles
│   ├── minimal-profile/       # Minimal example
│   └── standard-profile/      # Complete example
├── scripts/                   # Validation scripts
│   ├── validate-profile.js    # Profile validator
│   ├── test-codec.js          # Codec tester
│   └── utils/                 # Utilities
├── docs/                      # Documentation
├── .github/                   # GitHub templates
├── registry.json              # Profile registry 🆕
├── registry-schema.json       # Registry schema
└── README.md

📚 Profile Registry

The project includes an auto-generated registry.json file that provides an index and statistics for all available Profiles.

Registry Content

{
  "version": "1.0.0",
  "lastUpdate": "2026-01-16",
  "totalProfiles": 19,
  "profiles": [
    {
      "id": "senso8-lrs20310",
      "vendor": "Senso8",
      "model": "LRS20310",
      "version": "1.0.0",
      "path": "profiles/Senso8/Senso8-LRS20310.yaml",
      "verified": true,
      "hasTests": true,
      "description": "Senso8 LRS20310 Water Leak Detection Sensor",
      "deviceType": "Water Leak Sensor",
      "lorawanClass": ["A"],
      "lastUpdate": "2026-01-16"
    }
  ],
  "statistics": {
    "byVendor": { "Senso8": 9, "Dragino": 4, "Carrier": 2, ... },
    "withTests": 10,
    "withoutTests": 9
  }
}

Updating the Registry

After adding or modifying Profiles, run the following command to update the registry:

cd scripts
node update-registry.js

📝 Profile Format

Each YAML configuration file contains the following main sections:

1. Codec (Encoder/Decoder)

Defines JavaScript functions for encoding and decoding LoRaWAN data:

codec: |
  function Decode(fPort, data, variables) {
    // Decode LoRaWAN uplink data
    var values = [];
    // ... parse data and populate values array
    return values;
  }

  function Encode(data, variables) {
    // Encode LoRaWAN downlink data
    var bytes = [];
    // ... encode data
    return bytes;
  }

2. Datatype (BACnet Object Definition)

Defines BACnet object types, properties, and mapping relationships:

datatype:
  "1":                              # Channel ID
    name: Temperature               # Object name
    type: AnalogInputObject         # BACnet object type
    units: degreesCelsius          # Units
    covIncrement: 0.1              # COV increment
    updateInterval: 600            # Update interval (seconds)
    channel: 1                     # LoRaWAN channel number

Supported BACnet Object Types:

• AnalogInputObject - Analog input (sensor readings)
• AnalogOutputObject - Analog output (controllable analog values)
• AnalogValueObject - Analog value (general analog values)
• BinaryInputObject - Binary input (switch states, alarms)
• BinaryOutputObject - Binary output (controllable switches)
• BinaryValueObject - Binary value (general binary values)
• OctetStringValueObject - Octet string value (strings, special data)

3. LoRaWAN Configuration

Defines LoRaWAN related parameters:

lorawan:
  adrAlgorithm: LoRa Only           # ADR algorithm
  classCDownlinkTimeout: 5          # Class C downlink timeout
  macVersion: LORAWAN_1_0_3         # LoRaWAN MAC version
  regionalParametersRevision: A      # Regional parameters revision
  supportClassB: false              # Class B support
  supportClassC: false              # Class C support
  supportOTAA: true                 # OTAA support

4. Metadata

Device basic information:

model: Senso8-LRS20310              # Device model
profileVersion: 1.0.0               # Profile version
name: LRS20310                      # Device name
vendor: RAKwireless                 # Vendor name
id: uuid-string                     # Unique identifier (optional)

🚀 Usage

1. Import Configuration File

Import the corresponding device YAML configuration file into the RAK gateway's BACnet service.

2. Device Join

Ensure the LoRaWAN device has successfully joined the RAK gateway (supports OTAA or ABP mode).

3. BACnet Object Mapping

The gateway will automatically create corresponding BACnet objects according to the configuration file and map LoRaWAN data to these objects.

4. BMS System Integration

In the Building Management System (BMS), access these objects through standard BACnet protocol to achieve device monitoring and control.

Example: Reading Temperature Data

Device uplink data (LoRaWAN)
    ↓
Decode function parses
    ↓
Map to BACnet object (AnalogInputObject)
    ↓
BMS system reads (via BACnet protocol)

Example: Controlling Air Conditioner

BMS system writes command (via BACnet protocol)
    ↓
BACnet object receives (AnalogOutputObject)
    ↓
Encode function encodes
    ↓
Downlink data sent (LoRaWAN)

🤝 Contributing

Contributions of new device configuration files are welcome!

Adding New Device Profiles

1. Fork this repository

2. Create device configuration file

   • Create a new YAML file in the corresponding vendor directory under profiles/
   • If it's a new vendor, create a new vendor directory under profiles/
   • File naming format: Vendor-Model.yaml
   • Example: profiles/YourVendor/YourVendor-Model.yaml

3. Write configuration file

   • Implement Decode and Encode functions
   • Define BACnet object mappings
   • Configure LoRaWAN parameters
   • Add complete metadata information

4. Testing and Validation

   Create test data for your Profile:

   # Create test directory
   mkdir -p profiles/YourVendor/tests
   
   # Add test input data
   # Create profiles/YourVendor/tests/test-data.json
   # Create profiles/YourVendor/tests/expected-output.json

   Run validation:

   # Install dependencies (first time only)
   cd scripts && npm install && cd ..
   
   # Run full validation (including output verification)
   node scripts/validate-profile.js profiles/YourVendor/YourVendor-Model.yaml

   Ensure all tests pass:

   • ✅ YAML syntax valid
   • ✅ Profile structure correct
   • ✅ Codec functions executable
   • ✅ BACnet object types supported
   • ✅ Test data decodes successfully
   • ✅ Output matches expected results [输出匹配]

   See docs/TESTING-GUIDE.md for detailed testing instructions.

5. Submit Pull Request

   • Provide detailed device description
   • Include test data and expected outputs
   • Ensure validation passes
   • Update device list in this README

Configuration File Specifications

• Use standard YAML format
• Clear code comments (JavaScript functions)
• Object naming follows BACnet specifications
• Units use standard BACnet unit enumerations
• Provide complete metadata information

📄 License

The configuration files in this project are for use with the RAKwireless ecosystem.

📧 Contact

For questions or suggestions, please contact us through:

• Submit a GitHub Issue
• Visit RAKwireless Official Website
• Visit RAKwireless Forum

---

Note: Before using these configuration files, please ensure your RAK gateway firmware version supports BACnet functionality. Refer to the product documentation for specific support details.