Support

Here you will find important documents on our products as PDF downloads, our current Payload Formatter and a link to our Downlink Generator.

Phone: +49 2171 9047911
Email: support@enerthing.com

Downlink Generator

Use our downlink generator to operate your sensors with individual settings.

You need the DevEUI of your devices to use the downlink generator, as the available downlinks depend on the device type and the firmware version on the sensor.

Attention: When opening the downlink configurator for the first time, loading times of up to 30 seconds may occur.

Open Downlink Generator

Payload formatter

Here you will find the payload formatter for our products. If you have any questions or need customizations for specific LoRa Network Servers, please contact our support.

DOWNLOAD TXT.DATEI

Copy to Clipboard

/*
MIT License
 
Copyright (c) 2023 Michael Niggemann, Enerthing GmbH
 
An der Schusterinsel 3a
51379 Leverkusen
North Rhine-Westphalia
Germany
 
Phone: +49 (0)2171-9047910
Email: info(at)enerthing.com
Contact: Michael Niggemann
 
Version: 2.0.0
 
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.
*/
 
var INT_8_LEN = 1;
var INT_16_LEN = 2;
var INT_24_LEN = 3;
var INT_32_LEN = 4;
var BIT_PER_BYTE = 8;
var TEMPERATURE_CONVERSION_FACTOR = 1 / 100;
var HUMIDITY_CONVERSION_FACTOR = 1 / 100;
var PRESSURE_CONVERSION_FACTOR = 1 / 100;
var MIN_TO_SEC = 60;
 
var combinedPort = {
    portNumber: 2,
    maskBytes: 3,
    decoders: [
        { mask: 0, key: 'battery', length: INT_16_LEN, signed: false },
        { mask: 1, key: 'photovoltaic', length: INT_16_LEN, signed: false },
        { mask: 2, key: 'impp_pv', length: INT_16_LEN, signed: false },
        { mask: 3, key: 'photovoltaic_power', length: INT_16_LEN, signed: false },
        { mask: 4, key: 'temperature', length: INT_16_LEN, signed: true, factor: TEMPERATURE_CONVERSION_FACTOR },
        { mask: 5, key: 'humidity', length: INT_16_LEN, signed: false, factor: HUMIDITY_CONVERSION_FACTOR },
        { mask: 7, key: 'co2', length: INT_16_LEN, signed: false },
        { mask: 8, key: 'co2_calibration', length: INT_8_LEN, signed: false },
        { mask: 9, key: 'motion', length: INT_8_LEN, signed: false },
        { mask: 10, key: 'event_motion', isEvent: true },
        { mask: 11, key: 'event_heating', length: INT_8_LEN, signed: true },
        { mask: 12, key: 'records_gate_state', shift: 0, length: 2, signed: false },
        { mask: 13, key: 'event_manipulation', length: INT_8_LEN, signed: false },
        { mask: 14, key: 'validation_test_current_power_monitor', length: INT_8_LEN, signed: false },
        { mask: 15, key: 'validation_test_barometer', length: INT_8_LEN, signed: false },
        { mask: 16, key: 'validation_test_accelerometer', length: INT_8_LEN, signed: false },
        { mask: 17, key: 'validation_test_co2', length: INT_8_LEN, signed: false },
        { mask: 18, key: 'validation_test_pyd', length: INT_8_LEN, signed: false },
        { mask: 19, key: 'validation_test_nfc', length: INT_8_LEN, signed: false },
        { mask: 20, key: 'validation_test_battery', length: INT_8_LEN, signed: false }
    ]
};
 
var validationsPort = {
    portNumber: 3,
    maskBytes: 3,
    decoders: [
        { maskPos: 1, key: 'validation_test_current_power_monitor', length: INT_8_LEN, signed: false },
        { maskPos: 2, key: 'validation_test_barometer', length: INT_8_LEN, signed: false },
        { maskPos: 3, key: 'validation_test_accelerometer', length: INT_8_LEN, signed: false },
        { maskPos: 4, key: 'validation_test_co2', length: INT_8_LEN, signed: false },
        { maskPos: 5, key: 'validation_test_pyd', length: INT_8_LEN, signed: false },
        { maskPos: 6, key: 'validation_test_nfc', length: INT_8_LEN, signed: false },
        { maskPos: 7, key: 'validation_test_battery', length: INT_8_LEN, signed: false },
        { maskPos: 8, key: 'reboot_reason', length: INT_16_LEN, signed: false }
    ]
};
 
var eventsPort = {
    portNumber: 4,
    maskLength: 1,
    decoders: [
        { mask: 0x01, key: 'event_downlink_confirmation', length: INT_8_LEN, signed: false },
        { mask: 0x02, key: 'event_motion', length: INT_8_LEN, signed: false },
        { mask: 0x03, key: 'event_heating', length: INT_8_LEN, signed: true },
        { mask: 0x04, key: 'event_manipulation', length: INT_8_LEN, signed: false },
        { mask: 0x05, key: 'co2_calibration', length: INT_8_LEN, signed: false },
        { mask: 0x06, key: 'co2', length: INT_16_LEN, signed: false },
        { mask: 0x08, key: 'event_desk', length: INT_8_LEN, signed: false }
    ]
};
 
var measurementsPort = {
    portNumber: 5,
    maskBytes: 3,
    decoders: [
        { maskPos: 1, key: 'battery', length: INT_16_LEN, signed: false },
        { maskPos: 2, key: 'photovoltaic', length: INT_16_LEN, signed: false },
        { maskPos: 3, key: 'impp_pv', length: INT_16_LEN, signed: true },
        { maskPos: 4, key: 'photovoltaic_power', length: INT_16_LEN, signed: true },
        { maskPos: 5, key: 'temperature', length: INT_16_LEN, signed: true, factor: TEMPERATURE_CONVERSION_FACTOR },
        { maskPos: 6, key: 'humidity', length: INT_16_LEN, signed: false, factor: HUMIDITY_CONVERSION_FACTOR },
        { maskPos: 7, key: 'pressure', length: INT_24_LEN, signed: false, factor: PRESSURE_CONVERSION_FACTOR },
        { maskPos: 8, key: 'co2', length: INT_16_LEN, signed: false },
        { maskPos: 9, key: 'motion', length: INT_8_LEN, signed: false }
    ]
};
 
function extractValue(number, bitLength, offset, signed) {
    var value = (number >> offset) & ((1 << bitLength) - 1);
    if (signed || false) {
        value = uintToInt(value, bitLength);
    }
    return parseInt(value);
}
 
function uintToInt(value, bitLength) {
    var signBit = value & (1 << (bitLength - 1));
    if (signBit) {
        var mask = ~((1 << bitLength) - 1);
        value = value | mask;
    }
    return value;
}
 
function getIntFromBytes(bytes, signed, bitLength) {
    var result = 0;
    var tmpSigned = signed || false;
    var tmpBitLength = bitLength || parseInt(0);
    for (var i = 0; i < bytes.length; i++) {
        result = (result << 8) | bytes[i];
    }
    if (tmpSigned) {
        result = uintToInt(result, tmpBitLength);
    }
    return result;
}
 
function checkMask(data, position, maskLength) {
    var result = 0;
    for (var i = 0; i < maskLength; i++) {
        result = (result << 8) | data[i];
    }
    return (result & (1 << position)) !== 0;
}
 
function checkPrefix(data, mask) {
    if (data[0] === mask) {
        data = data.splice(0, 1);
        return true;
    }
    return false;
}
 
function applyFactor(value, factor) {
    value *= factor || 1;
    return parseFloat(value.toFixed(2));
}
 
function handleCombined(data, decodedData) {
    combinedPort.decoders.forEach(function (decoder) {
        if (checkMask(data, decoder.mask, combinedPort.maskBytes)) {
            var value = getIntFromBytes(data.splice(combinedPort.maskBytes, decoder.length), decoder.signed, decoder.length * BIT_PER_BYTE);
            value = applyFactor(value, decoder.factor);
            if (decoder.isEvent) {
                value = 1;
            }
            decodedData[decoder.key] = value;
        }
    });
}
 
function handleValidations(data, decodedData) {
    validationsPort.decoders.forEach(function (decoder) {
        if (checkMask(data, decoder.maskPos - 1, measurementsPort.maskBytes)) {
            decodedData[decoder.key] = getIntFromBytes(data.splice(validationsPort.maskBytes, decoder.length), decoder.signed);
        }
    });
}
 
function handleEvents(data, decodedData) {
    eventsPort.decoders.forEach(function (decoder) {
        if (checkPrefix(data, decoder.mask)) {
            var value = getIntFromBytes(data.splice(0, decoder.length), decoder.signed, decoder.length * BIT_PER_BYTE);
            decodedData[decoder.key] = applyFactor(value, decoder.factor);
        }
    });
}
 
function handleMeasurements(data, decodedData) {
    measurementsPort.decoders.forEach(function (decoder) {
        if (checkMask(data, decoder.maskPos - 1, measurementsPort.maskBytes)) {
            var value = getIntFromBytes(data.splice(validationsPort.maskBytes, decoder.length), decoder.signed);
            decodedData[decoder.key] = applyFactor(value, decoder.factor);
        }
    })
}
 
function decodeUplink(input) {
    var data = Array.prototype.slice.call(input.bytes);
    var decodedData = {};
    switch (input.fPort) {
        case combinedPort.portNumber:
            handleCombined(data, decodedData);
            break;
        case validationsPort.portNumber:
            handleValidations(data, decodedData);
            break;
        case eventsPort.portNumber:
            handleEvents(data, decodedData);
            break;
        case measurementsPort.portNumber:
            handleMeasurements(data, decodedData);
            break;
        default:
            break;
    }
    return {
        data: decodedData,
        warnings: [],
        errors: [],
    };
}

Support

enerSENSE Basic

enerSENSE Plus

enerSENSE CO2

enerSENSE Industry

Downlink Generator

Payload formatter

enerSENSE CO₂