iNELS Wiki
iNELS Bus
iNELS Bus
  • Introduction
    • What is iNELS Bus
    • Key features of iNELS Bus
    • iNELS BUS Technology.
    • iNELS Bus communication
  • Technical manual: Products
    • Detectors
      • DLS3-1
      • MCD3-01
      • PMS3-01
    • Converters
      • ADC3-60M
      • DAC3-04M
      • IBWL3-20B-SL
    • Switching Actuators
      • SA3-01B/SA3-02B
      • SA3-04M
      • SA3-06M
      • SA3-014M
      • SA3-022M
      • EA3-022M
    • Shutter Actuators
      • JA3-014M
    • Dimming Actuators
      • DA3-22M
      • DA3-66M
      • DA3-03M/RGBW
    • Input Units
      • IM3-40B, IM3-80B
      • IM3-140M
      • TI3-40B
      • TI3-60M
    • Combined Units
      • FA3-612M
      • RC3-610M/DALI
      • IOU3 -108M
    • Controllers
      • GSB3-XX
      • GSB3 XX/SX
      • MSB3 XX/XX
      • WSB3-20, WSB3-20H
      • WSB3-40, WSB3-40H
      • WMR3-21
      • GCR3-30
    • Thermo-regulators
      • IDRT3-1
    • Integration
      • iNELS Bridge
  • How to get started
    • First run of Central unit
    • Firmware update of Units
    • Reset Central Unit CU3-XX
    • Exports for iNELS Cloud and APP
    • Controlling DALI Ballasts in iNELS Systems
    • What steps should be taken when a unit shows as disconnected?
    • iDM Bus Analysis and Troubleshooting Software
  • iNELS Design Manager: iDM3
    • Software Download
    • Troubleshooting Disconnected Units in iDM3 Software
    • Understanding Bits and Integers in iNELS Design Manager for Building Automation
    • Regulators
      • Two-point regulator
      • Three-point regulator
      • Fan-coil regulators
      • Cooling regulator
      • Heating regulator
    • Introduction to the iDM (iNELS Design Manager)
      • Main Screen Components
    • True state and Long State button
  • 3rd Party Integration
    • How to Integrate iNELS BUS with 3rd Party world.
    • MQTT payload description of iNELS BUS devices
    • MQTT Payload Manual for Bits and Integers
    • HVAC Control: How to Control HVAC from iNELS system using Tasmota IR Controller
    • How to Integrate iNELS BUS with Home Assistant
    • Integration : iNELS System with NETx BMS via MQTT Protocol
    • Integrating iNELS with Modbus, BACnet, ASCII, Z-Wave, etc.
  • Inspinia
    • Inspinia Touch Series
    • A-iBUS Slave Addon Module Manual for Inspinia Screens (INS4SQ, INS8SQ, INS10SQ)
    • iNELS BUS Add-On Module Manual for Inspinia Touch Panels
    • Adding iNELS Units to Inspinia via MQTT
    • SKY PLATFORM
Powered by GitBook
On this page
  • Topics and Payload Format
  • Commands
  • Limitations
  • Example
  • Conclusion
  1. 3rd Party Integration

MQTT Payload Manual for Bits and Integers

This manual provides guidance on the payload structure and commands for working with bits and integers in MQTT (Message Queuing Telemetry Transport). Bits and integers represent binary states and numerical values respectively in an iNELS environment.

Topics and Payload Format

Status Topic

The status topic is used to retrieve the current state of bits and integers.

Topic Structure:

inels/status/<mac_ID>/bits/<topic_ID>
inels/status/<mac_ID>/integers/<topic_ID>

Payload Format:

{
    "last_seen": "<timestamp>",
    "state": {
        "<ID_1>": <value_1>,
        "<ID_2>": <value_2>,
        ...
        "<ID_n>": <value_n>
    }
}
  • <timestamp>: Time when the status was last updated.

  • <ID>: Unique identifier for the bit or integer.

  • <value>: Binary state (for bits) or numerical value (for integers).

Set Topic

The set topic is used to send commands to control bits and integers.

Topic Structure:

inels/set/<mac_ID>/bits/<topic_ID>
inels/set/<mac_ID>/integers/<topic_ID>

Command Format:

{
    "cmd": {
        "<ID_1>": "<command_1>",
        "<ID_2>": "<command_2>",
        ...
        "<ID_n>": "<command_n>"
    }
}
  • <ID>: Unique identifier for the bit or integer.

  • <command>: Action to be performed on the corresponding bit or integer.

Commands

For Bits

  • 0: Turn off the bit.

  • 1: Turn on the bit.

  • toggle: Toggle the current state of the bit.

For Integers

  • Set a specific value for the integer.

Limitations

  • Maximum 40 bits or 20 integers can be included in one topic.

  • If there are more bits or integers, they will be displayed in additional topics.

Example

Status Topic Payload (Bits)

Topic: inels/status/2C6A6F104825/bits/000001

Payload:

{
    "last_seen": "2024-03-15T13:02:07.+0100Z",
    "state": {
        "000": 1,
        "001": 0,
        "002": 0,
        ...
        "040": 0
    }
}

Set Topic Command (Bits)

Topic: inels/set/2C6A6F104825/bits/000001

Command:

{
    "cmd": {
        "005": "toggle"
    }
}

Status Topic Payload (Integers)

Topic: inels/status/2C6A6F104825/integers/000001

Payload:

{
    "last_seen": "2024-03-15T13:11:33.+0100Z",
    "state": {
        "000": 2556,
        "001": 0,
        "002": 97,
        ...
        "020": 0
    }
}

Set Topic Command (Integers)

Topic: inels/set/2C6A6F104825/integers/000001

Command:

{
    "cmd": {
        "002": 97
    }
}

Conclusion

This manual provides a clear understanding of the payload structure and commands for interacting with bits and integers over MQTT. It facilitates efficient communication and control in IoT applications.

PreviousMQTT payload description of iNELS BUS devicesNextHVAC Control: How to Control HVAC from iNELS system using Tasmota IR Controller

Last updated 1 year ago