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
  • Recommended decoder
  • TTN V3 Decoder (T-Valve for flow meter):
  • Chirpstack Decoder:

Was this helpful?

  1. Devices
  2. MClimate T-Valve LoRaWAN

T-Valve Uplink Decoder

Recommended decoder

function decodeUplink(input) {
	var bytes = input.bytes;
	var data = {};
	var messageTypes = ['keepalive', 'testButtonPressed', 'floodDetected', 'controlButtonPressed', 'fraudDetected'];

	function shortPackage(byteArray) {
		data.reason = 'keepalive',
			data.waterTemp = (byteArray[0] & 0xFF) / 2, // Extract all 8 bits (7:0) from byte 0 and divide by 2
			data.valveState = !!(byteArray[1] & 0b10000000), // Extract bit 7 from byte 1
			data.ambientTemp = ((byteArray[1] & 0b01111111) - 20) / 2; // Extract bits 6:0 from byte 1, subtract 20, and divide by 2
		return data
	}
	function longPackage(byteArray) {
		data.reason = messageTypes[(byteArray[0] >> 5) & 0b111],  // Extract bits 7:5 using right shift and mask
			data.boxTamper = !!(byteArray[0] & (1 << 3)),             // Extract bit 3
			data.floodDetectionWireState = !!(byteArray[0] & (1 << 2)), // Extract bit 2
			data.flood = !!(byteArray[0] & (1 << 1)),                 // Extract bit 1
			data.magnet = !!(byteArray[0] & 1),                       // Extract bit 0
			data.alarmValidated = !!(byteArray[1] & (1 << 7)),        // Extract bit 7
			data.manualOpenIndicator = !!(byteArray[1] & (1 << 6)),   // Extract bit 6
			data.manualCloseIndicator = !!(byteArray[1] & (1 << 5)),  // Extract bit 5
			data.softwareVersion = byteArray[1] & 0b11111,            // Extract bits 4:0
			data.closeTime = byteArray[2],                            // Byte 2
			data.openTime = byteArray[3],                             // Byte 3
			data.battery = ((byteArray[4] * 8) + 1600) / 1000;        // Byte 4, battery calculation
		return data;
	}

	const handleResponse = (bytes, data) => {
		var commands = bytes.map(function (byte) {
			return ("0" + byte.toString(16)).substr(-2);
		});
		var command_len = 0;
		commands.map(function (command, i) {
			switch (command) {
				case '0e':
					{
						command_len = 4;
						let openingTime = (parseInt(commands[i + 1], 16) << 8) | parseInt(commands[i + 2], 16)
						let closingTime = (parseInt(commands[i + 3], 16) << 8) | parseInt(commands[i + 4], 16)
						data.openCloseTimeExtended = { openingTime: Number(openingTime), closingTime: Number(closingTime) };
					}
					break;
				case '0f':
					{
						command_len = 1;
						data.emergencyOpenings = parseInt(commands[i + 1], 16);
					}
					break;
				case '10':
					{
						command_len = 1;
						data.floodAlarmTime = parseInt(commands[i + 1], 16);
					}
					break;
				case '11':
					{
						command_len = 1;
						data.workingVoltage = parseInt(`${commands[i + 1]}`, 16);
					}
					break;
				case '12':
					{
						command_len = 1;
						data.keepAliveTime = parseInt(`${commands[i + 1]}`, 16);
					}
					break;
				case '13':
					{
						command_len = 1;
						data.deviceFloodSensor = parseInt(`${commands[i + 1]}`, 16);
					}
					break;
				case '16':
					{
						command_len = 1;
						var commandResponse = parseInt(commands[i + 1], 16);
						var periodInMinutes = commandResponse * 5 / 60;
						data.joinRetryPeriod = periodInMinutes;
					}
					break;
				case '18':
					{
						command_len = 1;
						data.uplinkType = parseInt(commands[i + 1], 16);
					}
					break;
				case '1a':
					{
						command_len = 2;
						var wdpC = commands[i + 1] == '00' ? false : parseInt(commands[i + 1], 16);
						var wdpUc = commands[i + 2] == '00' ? false : parseInt(commands[i + 2], 16);
						data.watchDogParams = { wdpC: wdpC, wdpUc: wdpUc };
					}
					break;
				case 'a0':

					command_len = 4;
					var fuota_address = (parseInt(commands[i + 1], 16) << 24) | (parseInt(commands[i + 2], 16) << 16) | (parseInt(commands[i + 3], 16) << 8) | parseInt(commands[i + 4], 16);
					var fuota_address_raw = (parseInt(commands[i + 1], 16) << 24) | (parseInt(commands[i + 2], 16) << 16) | (parseInt(commands[i + 3], 16) << 8) | parseInt(commands[i + 4], 16);
					data.fuota = { fuota_address, fuota_address_raw };
					break;
				default:
					break;
			}
			commands.splice(i, command_len);
		});
		return data;
	}

	if (bytes.length == 5) {
		data = longPackage(bytes);
	} else if (bytes.length == 2) {
		data = shortPackage(bytes);
	} else {
		data = longPackage(bytes, data);
		bytes = bytes.slice(5);
		data = handleResponse(bytes, data);
	}
	return { data: data };
}

TTN V3 Decoder (T-Valve for flow meter):

function decodeUplink(input) {
	var bytes = input.bytes;
	var decbin = function(number) {
		return parseInt(number, 10).toString(2);
	};
	var hexData = bytes.map(function (byte) {
        var number = parseInt(byte).toString(16);
        if( (number.length % 2) > 0) { number= "0" + number }
        return number;
    });
	var byteArray = bytes.map(function(byte) {
		var number = decbin(byte);
		return Array(9 - number.length).join('0') + number;
	});

	var messageTypes = [ 'keepalive', 'testButtonPressed', 'floodDetected', 'controlButtonPressed', 'fraudDetected' ];
	toBool = function(value) {
		return value == '1';
	};
	periodicData = function(byteArray) {
		return {
			data: {
				reason: 'keepalive',
				waterTemp: parseInt(byteArray[0], 2)/2,
				valveState: toBool(byteArray[1][0]),
				ambientTemp: (parseInt(byteArray[1].slice(1, 8), 2)-20)/2,
				flow: parseInt(byteArray[2]+byteArray[3]+byteArray[4]+byteArray[5], 2)
			}
		};
	};
	fullDeviceData = function(byteArray) {
		return {
			data: {
				reason: messageTypes[parseInt(byteArray[0].slice(0, 3),2)],
				boxTamper: toBool(byteArray[0][4]),
				floodDetectionWireState: toBool(byteArray[0][5]),
				flood: toBool(byteArray[0][6]),
				magnet: toBool(byteArray[0][7]),
				alarmValidated: toBool(byteArray[1][0]),
				manualOpenIndicator: toBool(byteArray[1][1]),
				manualCloseIndicator: toBool(byteArray[1][2]),
				closeTime: parseInt(byteArray[2], 2),
				openTime: parseInt(byteArray[3], 2),
				battery: ((parseInt(byteArray[4], 2) * 8) + 1600)/1000,
			}
		};
	};
	if (byteArray.length > 5) {
		return periodicData(byteArray);
	} else {
		return fullDeviceData(byteArray);
	}
}

Chirpstack Decoder:

function decodeUplink(input) {
	var bytes = input.bytes;
	var decbin = function(number) {
		return parseInt(number, 10).toString(2);
	};
	var byteArray = bytes.map(function(byte) {
		var number = decbin(byte);
		return Array(9 - number.length).join('0') + number;
	});

	var messageTypes = [ 'keepalive', 'testButtonPressed', 'floodDetected', 'controlButtonPressed', 'fraudDetected' ];
	toBool = function(value) {
		return value == '1';
	};
	shortPackage = function(byteArray) {
		return {
			data: {
				reason: 'keepalive',
				waterTemp: parseInt(byteArray[0], 2)/2,
				valveState: toBool(byteArray[1][0]),
				ambientTemp: (parseInt(byteArray[1].slice(1, 8), 2)-20)/2,
			}
		};
	};
	longPackage = function(byteArray) {
		return {
			data: {
				reason: messageTypes[parseInt(byteArray[0].slice(0, 3),2)],
				boxTamper: toBool(byteArray[0][4]),
				floodDetectionWireState: toBool(byteArray[0][5]),
				flood: toBool(byteArray[0][6]),
				magnet: toBool(byteArray[0][7]),
				alarmValidated: toBool(byteArray[1][0]),
				manualOpenIndicator: toBool(byteArray[1][1]),
				manualCloseIndicator: toBool(byteArray[1][2]),
				closeTime: parseInt(byteArray[2], 2),
				openTime: parseInt(byteArray[3], 2),
				battery: ((parseInt(byteArray[4], 2) * 8) + 1600)/1000,
			}
		};
	};
	if (byteArray.length > 2) {
		return longPackage(byteArray);
	} else {
		return shortPackage(byteArray);
	}
}
PreviousRelease notesNextT-Valve LoRaWAN communication protocol

Last updated 10 months ago

Was this helpful?

⬆️