MClimate LoRaWAN Devices
  • Overview
  • FAQ
  • Firmware Upgrade Over The Air (FUOTA)
  • Devices
    • 🆕МClimate 16A Dry Switch (16ADS)
      • 🥳Release notes
      • 🛠️How to use
      • ⬆️MClimate 16ADS Uplink decoder
      • ⬇️MClimate 16ADS Downlink encoder
      • 📖MClimate 16ADS Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • Overheating protection
        • Relay state 16ADS
        • LED indication mode
        • Network-related settings
        • Get Firmware & Hardware version
        • Restart device
    • 🆕МClimate 16A Switch & Power Meter LoRaWAN (16ASPM)
      • 🥳Release notes
      • 🛠️How to use
      • ⬆️MClimate 16ASPM Uplink decoder
      • ⬇️MClimate 16ASPM Downlink encoder
      • 📖MClimate 16ASPM Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • Protections
        • Relay state 16ASPM
        • Clear accumulated energy
        • LED indication mode
        • Network-related settings
        • Get Firmware & Hardware version
        • Restart device
    • 😲MClimate Fan Coil Thermostat (FCT)
      • 🥳Release notes
      • ⭐Getting started
      • ⚡Wiring Diagrams (Applications) & Operational Modes
      • ⬆️MClimate Fan Coil Thermostat Uplink decoder
      • ⬇️MClimate Fan Coil Thermostat Downlink encoder
      • 📖MClimate Fan Coil Thermostat Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Keep-alive
        • ON/OFF & Target temperature
          • Valve(s) operation
          • Target temperature ranges
        • Fan Settings
          • Auto Fan - Δ settings
        • 🔓Keys lock
        • External temperature measurement
        • Power module communication status
        • Function of digital input/output (IO1 and IO2 ports)
          • Automatic changeover
          • Occupancy sensor
        • General, Display & Power recovery
          • Hiding data from the display & settings
          • Frost Protection
          • Temperature sensor errors
          • Network-related settings
            • Uplink types
          • User interface language
        • Restart device
    • ♨️MClimate Vicki LoRaWAN
      • 🥳Release notes
      • ⬆️Vicki Uplink Decoder
      • ⬇️Vicki Downlink Encoder
      • 📖Vicki LoRaWAN Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • Manual target temperature change
        • Operational modes & temperature control algorithms
          • Algorithm 1 - Equal directional control
          • Algorithm 2 - Proportional control
          • Algorithm 3 - Proportional Integral
        • External temperature measurement and internal temperature offset
        • Control target temperature and/or motor position and range
        • Recalibrate motor command explanation
        • Read device hardware and software version command explanation.
        • Anti-freeze functionality
        • Open window detection
        • Child lock
        • Target temperature ranges
        • Temperature units
        • Force-close & Force-attach
        • Network-related settings
        • Appendix (examples)
      • 📺Technical Deepdive Webinar
    • 🆕MClimate CO2 Display lite
      • 🥳Release notes
      • ⬆️MClimate CO2 Display lite Uplink decoder
      • 📖CO2 Display lite Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • CO2 measurement settings
        • Hiding data from the display
        • Child lock
        • Network-related settings & Others
        • Get Firmware & Hardware version
        • Restart device
    • MClimate CO2 Display
      • 🥳Release notes
      • ⬆️MClimate CO2 Display Uplink decoder
      • 📖CO2 Display Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • CO2 measurement settings
        • Hiding data from the display
        • Child lock
        • PIR (Motion sensor)
        • Network-related settings & Others
        • Get Firmware & Hardware version
    • MClimate Wireless Thermostat
      • 🥳Release notes
      • ⬆️MClimate Wireless Thermostat Uplink decoder
      • ⬇️MClimate Wireless Thermostat Uplink encoder
      • 📖Wireless Thermostat Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • Target Temperature & Temperature range
        • Sensor mode & hiding data from the display
        • Heating status flag
        • Child lock
        • PIR (Motion sensor)
        • Get Firmware & Hardware version
        • Network-related settings & Others
    • MClimate HT Sensor LoRaWAN
      • 🥳Release notes
      • ⬆️HT Sensor Uplink Decoder
      • 📖HT Sensor LoRaWAN Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Temperature and humidity compensation
        • Keep-alive
        • Read device hardware and software version command explanation.
        • Network-related settings
        • Uplink types
        • Appendix (examples)
    • MClimate CO2 Sensor and Notifier LoRaWAN
      • 🥳Release notes
      • ⬆️CO2 Sensor Uplink Decoder
      • 📖CO2 Sensor LoRaWAN Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Keep-alive
        • Read device hardware and software version command explanation.
        • Network-related settings
        • Uplink types
        • CO2 boundary levels
        • CO2 auto-zero value
        • CO2 auto-zero period
        • CO2 Measurement period
        • Notifications configuration
    • MClimate Open/Close Sensor LoRaWAN
      • 🥳Release notes
      • ⬆️Open/Close Sensor uplink decoder
      • 📖Open/Close sensor LoRaWAN communication protocol
        • Commands cheat sheet
        • Keep-alive
        • Read device hardware and software version command explanation
        • Uplink types
        • Network-related settings
        • Event notification
        • Notification Blind Time
        • LED control command explanation
        • Restart device
    • MClimate Multipurpose Button LoRaWAN
      • 🥳Release notes
      • ⬆️Multipurpose Button Uplink decoder
      • 📖MClimate Button LoRaWAN Device communication protocol
        • Commands cheat sheet
        • Keep-alive
        • LEDs, button press types and behaviour
        • Read device hardware and software version command explanation
        • Network-related settings
        • Uplink types
        • Button press event counters
        • LED control command explanation
        • Restart device
    • MClimate T-Valve LoRaWAN
      • 🥳Release notes
      • ⬆️T-Valve Uplink Decoder
      • T-Valve LoRaWAN communication protocol
        • Commands cheat sheet
        • Uplink types
        • Keep-alive
        • Valve state control
        • Set LED behavior
        • Buzzer control
        • Emergency openings
        • Enable/disable manual valve open/close
        • Flood alarm time
        • Keep-alive period
        • Request Long data packet
        • Device allowed working voltage
        • Enable/Disable device flood sensor
        • Network related settings
        • Deactivate device (non-operational mode, save power)
    • MClimate Flood Sensor LoRaWAN
      • 🥳Release notes
      • ⬆️Flood Sensor Uplink Decoder
      • 📖Flood Sensor LoRaWAN communication protocol
        • Commands cheat sheet
        • Keep-alive
        • Flood event - Available configurations
        • Uplink types
        • Network-related settings
        • Read Firmware & Hardware version
        • Custom control of LED and Acoustic Buzzer
        • Read device parameters command
        • Restart device
    • MClimate AQI Sensor and Notifier LoRaWAN
      • 🥳Release notes
      • AQI Sensor Uplink Decoder
      • AQI Sensor Downlink encoder
      • AQI Sensor LoRaWAN Device communication protocol
        • Communication concepts
        • Commands cheat sheet
        • Keep-alive
        • Read device hardware and software version command explanation.
        • Network-related settings
        • Uplink types
        • Device buzzer control command
        • Device LED’s control
        • Appendix (examples)
  • Others
    • Application of MClimate Vicki to One-pipe steam heating systems
    • Battery Lifetime Estimation Methodology
    • Discover Smart Buildings solutions
    • How to solve Large space heating issues
    • Device Firmware upgrade via a Field Programming Kit (FPK)
      • Vicki Firmware Upgrade
  • Integrations
    • The Things Industries / TTN V3
    • ThingPark Enterprise
    • ThingPark Community
    • Tektelic
    • Helium
    • Chirpstack
    • Loriot
    • Kerlink
    • Melita
    • MachineQ
    • Orbiwise
    • Firefly
    • B-One
    • Milesight
    • Akenza
    • Element-IoT
    • Senet
    • Wattsense
    • RAK WisGateOS2
    • Netmore
Powered by GitBook
On this page

Was this helpful?

  1. Devices
  2. MClimate Wireless Thermostat

MClimate Wireless Thermostat Uplink encoder

Encoder:

function encodeDownlink(input) {
  var bytes = [];

  for (let key of Object.keys(input.data)) {
    switch (key) {
      case "setKeepAlive": {
        bytes.push(0x02);
        bytes.push(input.data.setKeepAlive);
        break;
      }
      case "getKeepAliveTime": {
        bytes.push(0x12);
        break;
      }
      case "getDeviceVersions": {
        bytes.push(0x04);
        break;
      }
      case "setTargetTemperature": {
        var temp = input.data.setTargetTemperature;
        bytes.push(0x2E);
        bytes.push(temp);
        break;
      }
      case "getTargetTemperature": {
        bytes.push(0x2F);
        break;
      }

      case "setKeysLock": {
        bytes.push(0x07);
        bytes.push(input.data.setKeysLock);
        break;
      }
      case "getKeysLock": {
        bytes.push(0x14);
        break;
      }
      case "setTemperatureRange": {
        bytes.push(0x08);
        bytes.push(input.data.setTemperatureRange.min);
        bytes.push(input.data.setTemperatureRange.max);
        break;
      }
      case "getTemperatureRange": {
        bytes.push(0x15);
        break;
      }
      case "setJoinRetryPeriod": {
        // period should be passed in minutes
        let periodToPass = (input.data.setJoinRetryPeriod * 60) / 5;
        periodToPass = int(periodToPass);
        bytes.push(0x10);
        bytes.push(periodToPass);
        break;
      }
      case "getJoinRetryPeriod": {
        bytes.push(0x19);
        break;
      }
      
      case "setUplinkType": {
        bytes.push(0x11);
        bytes.push(input.data.setUplinkType);
        break;
      }
      case "getUplinkType": {
        bytes.push(0x1B);
        break;
      }
      case "setWatchDogParams": {
          bytes.push(0x1C);
          bytes.push(input.data.SetWatchDogParams.confirmedUplinks);
          bytes.push(input.data.SetWatchDogParams.unconfirmedUplinks);
          break;
        }
        case "getWatchDogParams": {
            bytes.push(0x1D);
            break;
        }
        case "SetHeatingStatus": {
          bytes.push(0x31);
          bytes.push(input.data.SetHeatingStatus);
          break;
        }
        case "GetHeatingStatus": {
          bytes.push(0x32);
          break;
        }
        case "SetDisplayRefreshPeriod": {
          bytes.push(0x33);
          bytes.push(input.data.SetDisplayRefreshPeriod);
          break;
        }
        case "GetDisplayRefreshPeriod": {
          bytes.push(0x34);
          break;
        }
        case "SetTargetSendDelay": {
          bytes.push(0x35);
          bytes.push(input.data.SetTargetSendDelay);
          break;
        }
        case "GetTargetSendDelay": {
          bytes.push(0x36);
          break;
        }
        case "SetAutomaticHeatingStatus": {
          bytes.push(0x37);
          bytes.push(input.data.SetAutomaticHeatingStatus);
          break;
        }
        case "GetAutomaticHeatingStatus": {
          bytes.push(0x38);
          break;
        }
        case "SetSensorMode": {
          bytes.push(0x39);
          bytes.push(input.data.SetSensorMode);
          break;
        }
        case "GetSensorMode": {
          bytes.push(0x3a);
          break;
        }
        case "SetPIRSensorStatus": {
          bytes.push(0x3c);
          bytes.push(input.data.SetPIRSensorStatus);
          break;
        }
        case "GetPIRSensorStatus": {
          bytes.push(0x3d);
          break;
        }
        case "SetPIRSensorSensitivity": {
          bytes.push(0x3e);
          bytes.push(input.data.SetPIRSensorSensitivity);
          break;
        }
        case "GetPIRSensorSensitivity": {
          bytes.push(0x3f);
          break;
        }
        case "SetCurrentTemperatureVisibility": {
          bytes.push(0x40);
          bytes.push(input.data.SetCurrentTemperatureVisibility);
          break;
        }
        case "GetCurrentTemperatureVisibility": {
          bytes.push(0x41);
          break;
        }
        case "SetHumidityVisibility": {
          bytes.push(0x42);
          bytes.push(input.data.SetHumidityVisibility);
          break;
        }
        case "GetHumidityVisibility": {
          bytes.push(0x43);
          break;
        }
        case "SetLightIntensityVisibility": {
          bytes.push(0x44);
          bytes.push(input.data.SetLightIntensityVisibility);
          break;
        }
        case "GetLightIntensityVisibility": {
          bytes.push(0x45);
          break;
        }
        case "SetPIRInitPeriod": {
          bytes.push(0x46);
          bytes.push(input.data.SetPIRInitPeriod);
          break;
        }
        case "GetPIRInitPeriod": {
          bytes.push(0x47);
          break;
        }
        case "SetPIRMeasurementPeriod": {
          bytes.push(0x48);
          bytes.push(input.data.SetPIRMeasurementPeriod);
          break;
        }
        case "GetPIRMeasurementPeriod": {
          bytes.push(0x49);
          break;
        }
        case "SetPIRCheckPeriod": {
          var time = input.data.SetPIRCheckPeriod;
          var timeLowByte = time & 0xFF;  
          var timeHighByte = (time >> 8) & 0xFF; 
          bytes.push(0x4A);
          bytes.push(timeHighByte);
          bytes.push(timeLowByte);
          break;
        }
        case "GetPIRCheckPeriod": {
          bytes.push(0x4B);
          break;
        }
        case "SetPIRBlindPeriod": {
          var time = input.data.SetPIRBlindPeriod;
          var timeLowByte = time & 0xFF;  
          var timeHighByte = (time >> 8) & 0xFF; 
          bytes.push(0x4C);
          bytes.push(timeHighByte);
          bytes.push(timeLowByte);
          break;
        }
        case "GetPIRBlindPeriod": {
          bytes.push(0x4D);
          break;
        }
        case "SetTemperatureHysteresis": {
          bytes.push(0x4E);
          bytes.push(input.data.SetTemperatureHysteresis * 10);
          break;
        }
        case "GetTemperatureHysteresis": {
          bytes.push(0x4F);
          break;
        }
        case "SetTargetTemperaturePrecisely": {
          var targetTemperature = input.data.SetTargetTemperaturePrecisely * 10;
          var targetTemperatureLowByte = targetTemperature & 0xFF;  
          var targetTemperatureHighByte = (targetTemperature >> 8) & 0xFF; 
          bytes.push(0x50);
          bytes.push(targetTemperatureHighByte);
          bytes.push(targetTemperatureLowByte);
          break;
        }
        case "GetTargetTemperaturePrecisely": {
          bytes.push(0x51);
          break;
        }
        case "setTargetTemperatureStep": {
          bytes.push(0x52);
          bytes.push(input.data.setTargetTemperatureStep * 10);
          break;
        }
        case "getTargetTemperatureStep": {
          bytes.push(0x53);
          break;
        }
        case "setTempSensorCompensation": {
          bytes.push(0x55);
          bytes.push(input.data.setTempSensorCompensation.compensation);
          bytes.push(input.data.setTempSensorCompensation.temperature * 10);
          break;
        }
        case "getTempSensorCompensation": {
          bytes.push(0x56);
          break;
        }
        case "restartDevice": {
          bytes.push(0xA5);
          break;
        }
      case "sendCustomHexCommand": {
        let sendCustomHexCommand = input.data.sendCustomHexCommand;
        for (let i = 0; i < sendCustomHexCommand.length; i += 2) {
          const byte = parseInt(sendCustomHexCommand.substr(i, 2), 16);
          bytes.push(byte);
        }
        break;
      }
      default: {
      }
    }
  }

  return {
    bytes: bytes,
    fPort: 1,
    warnings: [],
    errors: [],
  };
}

function decodeDownlink(input) {
  return {
    data: {
      bytes: input.bytes,
    },
    warnings: [],
    errors: [],
  };
}

// example downlink commands
// {"setTargetTemperature":20} --> 0x2E14
// {"setTemperatureRange":{"min":15,"max":21}} --> 0x080F15
// {"sendCustomHexCommand":"080F15"} --> 0x080F15
PreviousMClimate Wireless Thermostat Uplink decoderNextWireless Thermostat Device communication protocol

Last updated 1 month ago

Was this helpful?

⬇️