SEN5XSensor.cpp

#include "configuration.h"

#if !MESHTASTIC_EXCLUDE_AIR_QUALITY_SENSOR

#include "../mesh/generated/meshtastic/telemetry.pb.h"
#include "FSCommon.h"
#include "SEN5XSensor.h"
#include "SPILock.h"
#include "SafeFile.h"
#include "TelemetrySensor.h"
#include <float.h> // FLT_MAX
#include <pb_decode.h>
#include <pb_encode.h>

SEN5XSensor::SEN5XSensor() : TelemetrySensor(meshtastic_TelemetrySensorType_SEN5X, "SEN5X") {}

bool SEN5XSensor::getVersion()
{
    if (!sendCommand(SEN5X_GET_FIRMWARE_VERSION)) {
        LOG_ERROR("%s: Error sending version command", sensorName);
        return false;
    }
    delay(20); // From Sensirion Datasheet

    uint8_t versionBuffer[12]{};
    size_t charNumber = readBuffer(&versionBuffer[0], 3);
    if (charNumber == 0) {
        LOG_ERROR("%s: Error getting data ready flag value", sensorName);
        return false;
    }

    firmwareVer = versionBuffer[0] + (versionBuffer[1] / 10);
    hardwareVer = versionBuffer[3] + (versionBuffer[4] / 10);
    protocolVer = versionBuffer[5] + (versionBuffer[6] / 10);

    LOG_INFO("%s: Firmware Version: %0.2f", sensorName, firmwareVer);
    LOG_INFO("%s: Hardware Version: %0.2f", sensorName, hardwareVer);
    LOG_INFO("%s: Protocol Version: %0.2f", sensorName, protocolVer);

    return true;
}

bool SEN5XSensor::findModel()
{
    if (!sendCommand(SEN5X_GET_PRODUCT_NAME)) {
        LOG_ERROR("%s: Error asking for product name", sensorName);
        return false;
    }
    delay(50); // From Sensirion Datasheet

    const uint8_t nameSize = 48;
    uint8_t name[nameSize];
    size_t charNumber = readBuffer(&name[0], nameSize);
    if (charNumber == 0) {
        LOG_ERROR("%s: Error getting device name", sensorName);
        return false;
    }

    // We only check the last character that defines the model SEN5X
    switch (name[4]) {
    case 48:
        model = SEN50;
        LOG_INFO("%s: found sensor model SEN50", sensorName);
        break;
    case 52:
        model = SEN54;
        LOG_INFO("%s: found sensor model SEN54", sensorName);
        break;
    case 53:
        model = SEN55;
        LOG_INFO("%s: found sensor model SEN55", sensorName);
        break;
    }

    return true;
}

bool SEN5XSensor::probe(TwoWire *bus, uint8_t address, ScanI2C::I2CPort port)
{
    LOG_INFO("SEN5X: probing sensor");

    _bus = bus;
    _address = address;
#ifdef SEN5X_I2C_CLOCK_SPEED
    _port = port;
    reClockI2C.setup(_bus, _port);
#endif /* SEN5X_I2C_CLOCK_SPEED */

    if (!findModel()) {
        LOG_DEBUG("SEN5X: can't find SEN5X model");
        return false;
    }
    return true;
}

bool SEN5XSensor::sendCommand(uint16_t command)
{
    uint8_t nothing;
    return sendCommand(command, &nothing, 0);
}

bool SEN5XSensor::sendCommand(uint16_t command, uint8_t *buffer, uint8_t byteNumber)
{
    // At least we need two bytes for the command
    uint8_t bufferSize = 2;

    // Add space for CRC bytes (one every two bytes)
    if (byteNumber > 0)
        bufferSize += byteNumber + (byteNumber / 2);

    uint8_t toSend[bufferSize];
    uint8_t i = 0;
    toSend[i++] = static_cast<uint8_t>((command & 0xFF00) >> 8);
    toSend[i++] = static_cast<uint8_t>((command & 0x00FF) >> 0);

    // Prepare buffer with CRC every third byte
    uint8_t bi = 0;
    if (byteNumber > 0) {
        while (bi < byteNumber) {
            toSend[i++] = buffer[bi++];
            toSend[i++] = buffer[bi++];
            uint8_t calcCRC = sen5xCRC(&buffer[bi - 2]);
            toSend[i++] = calcCRC;
        }
    }

#ifdef SEN5X_I2C_CLOCK_SPEED
    LOG_DEBUG("%s: Attempting to reclock speed to %uHz", sensorName, SEN5X_I2C_CLOCK_SPEED);
    reClockI2C.setClock(SEN5X_I2C_CLOCK_SPEED);
#endif /* SEN5X_I2C_CLOCK_SPEED */

    // Transmit the data
    // LOG_DEBUG("Beginning connection to SEN5X: 0x%x. Size: %u", address, bufferSize);
    // Note: this delay is necessary to allow for long-buffers
    delay(20);
    _bus->beginTransmission(_address);
    size_t writtenBytes = _bus->write(toSend, bufferSize);
    uint8_t i2c_error = _bus->endTransmission();

#ifdef SEN5X_I2C_CLOCK_SPEED
    LOG_DEBUG("%s: restoring clock speed", sensorName);
    reClockI2C.restoreClock();
#endif /* SEN5X_I2C_CLOCK_SPEED */

    if (writtenBytes != bufferSize) {
        LOG_ERROR("%s: Error writing on I2C bus", sensorName);
        return false;
    }

    if (i2c_error != 0) {
        LOG_ERROR("%s: Error on I2C communication: %x", sensorName, i2c_error);
        return false;
    }
    return true;
}

uint8_t SEN5XSensor::readBuffer(uint8_t *buffer, uint8_t byteNumber)
{
#ifdef SEN5X_I2C_CLOCK_SPEED
    LOG_DEBUG("%s: Attempting to reclock speed to %uHz", sensorName, SEN5X_I2C_CLOCK_SPEED);
    reClockI2C.setClock(SEN5X_I2C_CLOCK_SPEED);
#endif /* SEN5X_I2C_CLOCK_SPEED */

    size_t readBytes = _bus->requestFrom(_address, byteNumber);
    if (readBytes != byteNumber) {
        LOG_ERROR("%s: Error reading I2C bus", sensorName);
#ifdef SEN5X_I2C_CLOCK_SPEED
        LOG_DEBUG("%s: restoring clock speed", sensorName);
        reClockI2C.restoreClock();
#endif /* SEN5X_I2C_CLOCK_SPEED */
        return 0;
    }

    uint8_t i = 0;
    uint8_t receivedBytes = 0;
    while (readBytes > 0) {
        buffer[i++] = _bus->read(); // Just as a reminder: i++ returns i and after that increments.
        buffer[i++] = _bus->read();
        uint8_t recvCRC = _bus->read();
        uint8_t calcCRC = sen5xCRC(&buffer[i - 2]);
        if (recvCRC != calcCRC) {
            LOG_ERROR("%s: Checksum error while receiving msg", sensorName);
#ifdef SEN5X_I2C_CLOCK_SPEED
            LOG_DEBUG("%s: restoring clock speed", sensorName);
            reClockI2C.restoreClock();
#endif /* SEN5X_I2C_CLOCK_SPEED */
            return 0;
        }
        readBytes -= 3;
        receivedBytes += 2;
    }

#ifdef SEN5X_I2C_CLOCK_SPEED
    LOG_DEBUG("%s: restoring clock speed", sensorName);
    reClockI2C.restoreClock();
#endif /* SEN5X_I2C_CLOCK_SPEED */

    return receivedBytes;
}

uint8_t SEN5XSensor::sen5xCRC(const uint8_t *buffer)
{
    // This code is based on Sensirion's own implementation
    // https://github.com/Sensirion/arduino-core/blob/41fd02cacf307ec4945955c58ae495e56809b96c/src/SensirionCrc.cpp
    uint8_t crc = 0xff;

    for (uint8_t i = 0; i < 2; i++) {

        crc ^= buffer[i];

        for (uint8_t bit = 8; bit > 0; bit--) {
            if (crc & 0x80)
                crc = (crc << 1) ^ 0x31;
            else
                crc = (crc << 1);
        }
    }

    return crc;
}

void SEN5XSensor::sleep()
{
    idle(true);
}

bool SEN5XSensor::idle(bool checkState)
{
    // From the datasheet:
    // By default, the VOC algorithm resets its state to initial
    // values each time a measurement is started,
    // even if the measurement was stopped only for a short
    // time. So, the VOC index output value needs a long time
    // until it is stable again. This can be avoided by
    // restoring the previously memorized algorithm state before
    // starting the measure mode

    if (checkState) {
        // If the stabilisation period is not passed for SEN54 or SEN55, don't go to idle
        if (model != SEN50) {
            // Get VOC state before going to idle mode
            vocValid = false;
            if (vocStateFromSensor()) {
                vocValid = vocStateValid();
                // Check if we have time, and store it
                uint32_t now; // If time is RTCQualityNone, it will return zero
                now = getValidTime(RTCQuality::RTCQualityDevice);
                // Check if state is valid (non-zero)
                if (now) {
                    vocTime = now;
                }
            }

            if (!(vocStateStable() && vocValid)) {
                LOG_INFO("%s: Not stopping measurement, vocState is not stable yet!", sensorName);
                return true;
            }
        }
        // Save state and prefs (on all models)
        saveState();
    }

    if (!oneShotMode) {
        LOG_INFO("%s: Not stopping measurement, continuous mode!", sensorName);
        return true;
    } else {
        LOG_INFO("%s: One shot mode enabled", sensorName);
    }

    // Switch to low-power based on the model
    if (model == SEN50) {
        if (!sendCommand(SEN5X_STOP_MEASUREMENT)) {
            LOG_ERROR("%s: Error stopping measurement", sensorName);
            return false;
        }
        state = SEN5X_IDLE;
        LOG_INFO("%s: Stop measurement mode", sensorName);
    } else {
        if (!sendCommand(SEN5X_START_MEASUREMENT_RHT_GAS)) {
            LOG_ERROR("%s: Error switching to RHT/Gas measurement", sensorName);
            return false;
        }
        state = SEN5X_RHTGAS_ONLY;
        LOG_INFO("%s: Switch to RHT/Gas only measurement mode", sensorName);
    }

    delay(200); // From Sensirion Datasheet
    pmMeasureStarted = 0;
    return true;
}

bool SEN5XSensor::vocStateRecent(uint32_t now)
{
    if (now) {
        uint32_t passed = now - vocTime; // in seconds

        // Check if state is recent, less than 10 minutes (600 seconds)
        if (passed < SEN5X_VOC_VALID_TIME && (now > SEN5X_VOC_VALID_DATE)) {
            return true;
        }
    }
    return false;
}

bool SEN5XSensor::vocStateValid()
{
    if (!vocState[0] && !vocState[1] && !vocState[2] && !vocState[3] && !vocState[4] && !vocState[5] && !vocState[6] &&
        !vocState[7]) {
        LOG_DEBUG("%s: VOC state is all 0, invalid", sensorName);
        return false;
    } else {
        LOG_DEBUG("%s: VOC state is valid", sensorName);
        return true;
    }
}

bool SEN5XSensor::vocStateToSensor()
{
    if (model == SEN50) {
        return true;
    }

    if (!vocStateValid()) {
        LOG_INFO("%s: VOC state is invalid, not sending", sensorName);
        return true;
    }

    if (!sendCommand(SEN5X_STOP_MEASUREMENT)) {
        LOG_ERROR("%s: Error stopping measurement", sensorName);
        return false;
    }
    delay(200); // From Sensirion Datasheet

    LOG_DEBUG("%s: Sending VOC state to sensor", sensorName);
    LOG_DEBUG("[%u, %u, %u, %u, %u, %u, %u, %u]", vocState[0], vocState[1], vocState[2], vocState[3], vocState[4], vocState[5],
              vocState[6], vocState[7]);

    // Note: send command already takes into account the CRC
    // buffer size increment needed
    if (!sendCommand(SEN5X_RW_VOCS_STATE, vocState, SEN5X_VOC_STATE_BUFFER_SIZE)) {
        LOG_ERROR("%s: Error sending VOC's state command", sensorName);
        return false;
    }

    return true;
}

bool SEN5XSensor::vocStateFromSensor()
{
    if (model == SEN50) {
        return true;
    }

    LOG_INFO("%s: Getting VOC state from sensor", sensorName);
    //  Ask VOCs state from the sensor
    if (!sendCommand(SEN5X_RW_VOCS_STATE)) {
        LOG_ERROR("%s: Error sending VOC's state command", sensorName);
        return false;
    }

    delay(20); // From Sensirion Datasheet

    // Retrieve the data
    // Allocate buffer to account for CRC
    size_t receivedNumber = readBuffer(&vocState[0], SEN5X_VOC_STATE_BUFFER_SIZE + (SEN5X_VOC_STATE_BUFFER_SIZE / 2));
    delay(20); // From Sensirion Datasheet

    if (receivedNumber == 0) {
        LOG_DEBUG("%s: Error getting VOC's state", sensorName);
        return false;
    }

    // Print the state (if debug is on)
    LOG_DEBUG("%s: VOC state retrieved from sensor: [%u, %u, %u, %u, %u, %u, %u, %u]", sensorName, vocState[0], vocState[1],
              vocState[2], vocState[3], vocState[4], vocState[5], vocState[6], vocState[7]);

    return true;
}

bool SEN5XSensor::loadState()
{
#ifdef FSCom
    spiLock->lock();
    auto file = FSCom.open(sen5XStateFileName, FILE_O_READ);
    bool okay = false;
    if (file) {
        LOG_INFO("%s: state read from %s", sensorName, sen5XStateFileName);
        pb_istream_t stream = {&readcb, &file, meshtastic_SEN5XState_size};

        if (!pb_decode(&stream, &meshtastic_SEN5XState_msg, &sen5xstate)) {
            LOG_ERROR("%s: can't decode protobuf %s", sensorName, PB_GET_ERROR(&stream));
        } else {
            lastCleaning = sen5xstate.last_cleaning_time;
            lastCleaningValid = sen5xstate.last_cleaning_valid;
            oneShotMode = sen5xstate.one_shot_mode;

            if (model != SEN50) {
                vocTime = sen5xstate.voc_state_time;
                vocValid = sen5xstate.voc_state_valid;
                // Unpack state
                vocState[7] = (uint8_t)(sen5xstate.voc_state_array >> 56);
                vocState[6] = (uint8_t)(sen5xstate.voc_state_array >> 48);
                vocState[5] = (uint8_t)(sen5xstate.voc_state_array >> 40);
                vocState[4] = (uint8_t)(sen5xstate.voc_state_array >> 32);
                vocState[3] = (uint8_t)(sen5xstate.voc_state_array >> 24);
                vocState[2] = (uint8_t)(sen5xstate.voc_state_array >> 16);
                vocState[1] = (uint8_t)(sen5xstate.voc_state_array >> 8);
                vocState[0] = (uint8_t)sen5xstate.voc_state_array;
            }

            // LOG_DEBUG("Loaded lastCleaning %u", lastCleaning);
            // LOG_DEBUG("Loaded lastCleaningValid %u", lastCleaningValid);
            // LOG_DEBUG("Loaded oneShotMode %s", oneShotMode ? "true" : "false");
            // LOG_DEBUG("Loaded vocTime %u", vocTime);
            // LOG_DEBUG("Loaded [%u, %u, %u, %u, %u, %u, %u, %u]",
            // vocState[7], vocState[6], vocState[5], vocState[4], vocState[3], vocState[2], vocState[1], vocState[0]);
            // LOG_DEBUG("Loaded %svalid VOC state", vocValid ? "" : "in");

            okay = true;
        }
        file.close();
    } else {
        LOG_INFO("%s: No state found (File: %s)", sensorName, sen5XStateFileName);
    }
    spiLock->unlock();
    return okay;
#else
    LOG_ERROR("%s: Filesystem not implemented", sensorName);
#endif
}

bool SEN5XSensor::saveState()
{
#ifdef FSCom
    auto file = SafeFile(sen5XStateFileName);

    sen5xstate.last_cleaning_time = lastCleaning;
    sen5xstate.last_cleaning_valid = lastCleaningValid;
    sen5xstate.one_shot_mode = oneShotMode;

    if (model != SEN50) {
        sen5xstate.has_voc_state_time = true;
        sen5xstate.has_voc_state_valid = true;
        sen5xstate.has_voc_state_array = true;

        sen5xstate.voc_state_time = vocTime;
        sen5xstate.voc_state_valid = vocValid;
        // Unpack state (8 bytes)
        sen5xstate.voc_state_array = (((uint64_t)vocState[7]) << 56) | ((uint64_t)vocState[6] << 48) |
                                     ((uint64_t)vocState[5] << 40) | ((uint64_t)vocState[4] << 32) |
                                     ((uint64_t)vocState[3] << 24) | ((uint64_t)vocState[2] << 16) |
                                     ((uint64_t)vocState[1] << 8) | ((uint64_t)vocState[0]);
    }

    bool okay = false;

    LOG_INFO("%s: state write to %s", sensorName, sen5XStateFileName);
    pb_ostream_t stream = {&writecb, static_cast<Print *>(&file), meshtastic_SEN5XState_size};

    if (!pb_encode(&stream, &meshtastic_SEN5XState_msg, &sen5xstate)) {
        LOG_ERROR("%s: can't encode protobuf %s", sensorName, PB_GET_ERROR(&stream));
    } else {
        okay = true;
    }

    okay &= file.close();

    if (okay)
        LOG_INFO("%s: state write to %s successful", sensorName, sen5XStateFileName);

    return okay;
#else
    LOG_ERROR("%s: Filesystem not implemented", sensorName);
#endif
}

bool SEN5XSensor::isActive()
{
    return state == SEN5X_MEASUREMENT || state == SEN5X_MEASUREMENT_2;
}

uint32_t SEN5XSensor::wakeUp()
{

    LOG_DEBUG("%s: Waking up sensor", sensorName);

    if (!sendCommand(SEN5X_START_MEASUREMENT)) {
        LOG_ERROR("%s: Error starting measurement", sensorName);
        // TODO - what should this return?? Something actually on the default interval?
        return DEFAULT_SENSOR_MINIMUM_WAIT_TIME_BETWEEN_READS;
    }
    delay(50); // From Sensirion Datasheet

    // TODO - This is currently "problematic"
    // If time is updated in between reads, there is no way to
    // keep track of how long it has passed
    pmMeasureStarted = getTime();
    state = SEN5X_MEASUREMENT;
    if (state == SEN5X_MEASUREMENT)
        LOG_INFO("%s: Started measurement mode", sensorName);
    return SEN5X_WARMUP_MS_1;
}

bool SEN5XSensor::vocStateStable()
{
    uint32_t now;
    now = getTime();
    uint32_t sinceFirstMeasureStarted = (now - rhtGasMeasureStarted);
    LOG_DEBUG("%s: sinceFirstMeasureStarted: %us", sensorName, sinceFirstMeasureStarted);
    return sinceFirstMeasureStarted > SEN5X_VOC_STATE_WARMUP_S;
}

bool SEN5XSensor::startCleaning()
{
    // Note: we only should enter here if we have a valid RTC with at least
    // RTCQuality::RTCQualityDevice
    state = SEN5X_CLEANING;

    // Note that cleaning command can only be run when the sensor is in measurement mode
    if (!sendCommand(SEN5X_START_MEASUREMENT)) {
        LOG_ERROR("%s: Error starting measurement mode", sensorName);
        return false;
    }
    delay(50); // From Sensirion Datasheet

    if (!sendCommand(SEN5X_START_FAN_CLEANING)) {
        LOG_ERROR("%s: Error starting fan cleaning", sensorName);
        return false;
    }
    delay(20); // From Sensirion Datasheet

    // This message will be always printed so the user knows the device it's not hung
    LOG_INFO("%s: Started fan cleaning it will take 10 seconds...", sensorName);

    uint16_t started = millis();
    while (millis() - started < 10500) {
        delay(500);
    }
    LOG_INFO("%s: Cleaning done", sensorName);

    // Save timestamp in flash so we know when a week has passed
    uint32_t now;
    now = getValidTime(RTCQuality::RTCQualityDevice);
    // If time is not RTCQualityNone, it will return non-zero
    lastCleaning = now;
    lastCleaningValid = true;
    saveState();

    idle();
    return true;
}

bool SEN5XSensor::initDevice(TwoWire *bus, ScanI2C::FoundDevice *dev)
{
    state = SEN5X_NOT_DETECTED;
    LOG_INFO("%s: Init sensor", sensorName);

    _bus = bus;
    _address = dev->address.address;
#ifdef SEN5X_I2C_CLOCK_SPEED
    _port = dev->address.port;
    reClockI2C.setup(_bus, _port);
#endif /* SEN5X_I2C_CLOCK_SPEED */

    delay(50); // without this there is an error on the deviceReset function

    if (!sendCommand(SEN5X_RESET)) {
        LOG_ERROR("%s: error resetting device", sensorName);
        return false;
    }
    delay(200); // From Sensirion Datasheet

    if (!findModel()) {
        LOG_ERROR("%s: error finding sensor model", sensorName);
        return false;
    }

    // Check the firmware version
    if (!getVersion())
        return false;
    if (firmwareVer < 2) {
        LOG_ERROR("%s: firmware is too old and will not work with this implementation", sensorName);
        return false;
    }
    delay(200); // From Sensirion Datasheet

    // Detection succeeded
    state = SEN5X_IDLE;
    status = 1;

    // Load state
    loadState();

    // Check if it is time to do a cleaning
    uint32_t now;
    int32_t passed = 0;
    now = getValidTime(RTCQuality::RTCQualityDevice);

    // If time is not RTCQualityNone, it will return non-zero
    if (now) {
        if (lastCleaningValid) {

            passed = now - lastCleaning; // in seconds

            if (passed > ONE_WEEK_IN_SECONDS && (now > SEN5X_VOC_VALID_DATE)) {
                // If current date greater than 01/01/2018 (validity check)
                LOG_INFO("%s: More than a week (%us) since last cleaning in epoch (%us). Trigger, cleaning...", sensorName,
                         passed, lastCleaning);
                startCleaning();
            } else {
                LOG_INFO("%s: Cleaning not needed (%ds passed). Last cleaning date (in epoch): %us", sensorName, passed,
                         lastCleaning);
            }
        } else {
            // We assume the device has just been updated or it is new,
            // so no need to trigger a cleaning.
            // Just save the timestamp to do a cleaning one week from now.
            // Otherwise, we will never trigger cleaning in some cases
            lastCleaning = now;
            lastCleaningValid = true;
            LOG_INFO("%s: No valid last cleaning date found, saving it now: %us", sensorName, lastCleaning);
            saveState();
        }

        if (model != SEN50) {
            if (!vocValid) {
                LOG_INFO("%s: No valid VOC's state found", sensorName);
            } else {
                // Check if state is recent
                if (vocStateRecent(now)) {
                    // If current date greater than 01/01/2018 (validity check)
                    // Send it to the sensor
                    LOG_INFO("%s: VOC state is valid and recent", sensorName);
                    vocStateToSensor();
                } else {
                    LOG_INFO("%s: VOC state is too old or date is invalid", sensorName);
                    LOG_DEBUG("%s: vocTime %u, Passed %u, and now %u", sensorName, vocTime, passed, now);
                }
            }
        }
    } else {
        // TODO - Should this actually ignore? We could end up never cleaning...
        LOG_INFO("%s: Not enough RTCQuality, ignoring saved cleaning and VOC state", sensorName);
    }

    idle(false);
    rhtGasMeasureStarted = now;

    initI2CSensor();
    return true;
}

bool SEN5XSensor::readValues()
{
    if (!sendCommand(SEN5X_READ_VALUES)) {
        LOG_ERROR("%s: Error sending read command", sensorName);
        return false;
    }
    LOG_DEBUG("%s: Reading PM Values", sensorName);
    delay(20); // From Sensirion Datasheet

    uint8_t dataBuffer[16]{};
    size_t receivedNumber = readBuffer(&dataBuffer[0], 24);
    if (receivedNumber == 0) {
        LOG_ERROR("%s: Error getting values", sensorName);
        return false;
    }

    // Get the integers
    uint16_t uint_pM1p0 = static_cast<uint16_t>((dataBuffer[0] << 8) | dataBuffer[1]);
    uint16_t uint_pM2p5 = static_cast<uint16_t>((dataBuffer[2] << 8) | dataBuffer[3]);
    uint16_t uint_pM4p0 = static_cast<uint16_t>((dataBuffer[4] << 8) | dataBuffer[5]);
    uint16_t uint_pM10p0 = static_cast<uint16_t>((dataBuffer[6] << 8) | dataBuffer[7]);

    int16_t int_humidity = static_cast<int16_t>((dataBuffer[8] << 8) | dataBuffer[9]);
    int16_t int_temperature = static_cast<int16_t>((dataBuffer[10] << 8) | dataBuffer[11]);
    int16_t int_vocIndex = static_cast<int16_t>((dataBuffer[12] << 8) | dataBuffer[13]);
    int16_t int_noxIndex = static_cast<int16_t>((dataBuffer[14] << 8) | dataBuffer[15]);

    // Convert values based on Sensirion Arduino lib
    sen5xmeasurement.pM1p0 = !isnan(uint_pM1p0) ? uint_pM1p0 / 10 : UINT16_MAX;
    sen5xmeasurement.pM2p5 = !isnan(uint_pM2p5) ? uint_pM2p5 / 10 : UINT16_MAX;
    sen5xmeasurement.pM4p0 = !isnan(uint_pM4p0) ? uint_pM4p0 / 10 : UINT16_MAX;
    sen5xmeasurement.pM10p0 = !isnan(uint_pM10p0) ? uint_pM10p0 / 10 : UINT16_MAX;
    sen5xmeasurement.humidity = !isnan(int_humidity) ? int_humidity / 100.0f : FLT_MAX;
    sen5xmeasurement.temperature = !isnan(int_temperature) ? int_temperature / 200.0f : FLT_MAX;
    sen5xmeasurement.vocIndex = !isnan(int_vocIndex) ? int_vocIndex / 10.0f : FLT_MAX;
    sen5xmeasurement.noxIndex = !isnan(int_noxIndex) ? int_noxIndex / 10.0f : FLT_MAX;

    LOG_DEBUG("%s: Got readings: pM1p0=%u, pM2p5=%u, pM4p0=%u, pM10p0=%u", sensorName, sen5xmeasurement.pM1p0,
              sen5xmeasurement.pM2p5, sen5xmeasurement.pM4p0, sen5xmeasurement.pM10p0);

    if (model != SEN50) {
        LOG_DEBUG("%s: Got readings: humidity=%.2f, temperature=%.2f, vocIndex=%.2f", sensorName, sen5xmeasurement.humidity,
                  sen5xmeasurement.temperature, sen5xmeasurement.vocIndex);
    }

    if (model == SEN55) {
        LOG_DEBUG("%s: Got readings: noxIndex=%.2f", sensorName, sen5xmeasurement.noxIndex);
    }

    return true;
}

bool SEN5XSensor::readPNValues(bool cumulative)
{
    if (!sendCommand(SEN5X_READ_PM_VALUES)) {
        LOG_ERROR("%s: Error sending read command", sensorName);
        return false;
    }

    LOG_DEBUG("%s: Reading PN Values", sensorName);
    delay(20); // From Sensirion Datasheet

    uint8_t dataBuffer[20]{};
    size_t receivedNumber = readBuffer(&dataBuffer[0], 30);
    if (receivedNumber == 0) {
        LOG_ERROR("%s: Error getting PN values", sensorName);
        return false;
    }

    // Get the integers
    // uint16_t uint_pM1p0   = static_cast<uint16_t>((dataBuffer[0]   << 8) | dataBuffer[1]);
    // uint16_t uint_pM2p5   = static_cast<uint16_t>((dataBuffer[2]   << 8) | dataBuffer[3]);
    // uint16_t uint_pM4p0   = static_cast<uint16_t>((dataBuffer[4]   << 8) | dataBuffer[5]);
    // uint16_t uint_pM10p0  = static_cast<uint16_t>((dataBuffer[6]   << 8) | dataBuffer[7]);
    uint16_t uint_pN0p5 = static_cast<uint16_t>((dataBuffer[8] << 8) | dataBuffer[9]);
    uint16_t uint_pN1p0 = static_cast<uint16_t>((dataBuffer[10] << 8) | dataBuffer[11]);
    uint16_t uint_pN2p5 = static_cast<uint16_t>((dataBuffer[12] << 8) | dataBuffer[13]);
    uint16_t uint_pN4p0 = static_cast<uint16_t>((dataBuffer[14] << 8) | dataBuffer[15]);
    uint16_t uint_pN10p0 = static_cast<uint16_t>((dataBuffer[16] << 8) | dataBuffer[17]);
    uint16_t uint_tSize = static_cast<uint16_t>((dataBuffer[18] << 8) | dataBuffer[19]);

    // Convert values based on Sensirion Arduino lib
    // Multiply by 100 for converting from #/cm3 to #/0.1l for PN values
    sen5xmeasurement.pN0p5 = !isnan(uint_pN0p5) ? uint_pN0p5 / 10 * 100 : UINT32_MAX;
    sen5xmeasurement.pN1p0 = !isnan(uint_pN1p0) ? uint_pN1p0 / 10 * 100 : UINT32_MAX;
    sen5xmeasurement.pN2p5 = !isnan(uint_pN2p5) ? uint_pN2p5 / 10 * 100 : UINT32_MAX;
    sen5xmeasurement.pN4p0 = !isnan(uint_pN4p0) ? uint_pN4p0 / 10 * 100 : UINT32_MAX;
    sen5xmeasurement.pN10p0 = !isnan(uint_pN10p0) ? uint_pN10p0 / 10 * 100 : UINT32_MAX;
    sen5xmeasurement.tSize = !isnan(uint_tSize) ? uint_tSize / 1000.0f : FLT_MAX;

    // Remove accumuluative values:
    // https://github.com/fablabbcn/smartcitizen-kit-2x/issues/85
    if (!cumulative) {
        sen5xmeasurement.pN10p0 -= sen5xmeasurement.pN4p0;
        sen5xmeasurement.pN4p0 -= sen5xmeasurement.pN2p5;
        sen5xmeasurement.pN2p5 -= sen5xmeasurement.pN1p0;
        sen5xmeasurement.pN1p0 -= sen5xmeasurement.pN0p5;
    }

    LOG_DEBUG("%s: Got readings: pN0p5=%u, pN1p0=%u, pN2p5=%u, pN4p0=%u, pN10p0=%u, tSize=%.2f", sensorName,
              sen5xmeasurement.pN0p5, sen5xmeasurement.pN1p0, sen5xmeasurement.pN2p5, sen5xmeasurement.pN4p0,
              sen5xmeasurement.pN10p0, sen5xmeasurement.tSize);

    return true;
}

uint8_t SEN5XSensor::getMeasurements()
{
    uint32_t now;
    now = getTime();

    // Try to get new data
    if (!sendCommand(SEN5X_READ_DATA_READY)) {
        LOG_ERROR("%s: Error sending command data ready flag", sensorName);
        return 2;
    }
    delay(20); // From Sensirion Datasheet

    uint8_t dataReadyBuffer[3];
    size_t charNumber = readBuffer(&dataReadyBuffer[0], 3);
    if (charNumber == 0) {
        LOG_ERROR("%s: Error getting device version value", sensorName);
        return 2;
    }

    bool dataReady = dataReadyBuffer[1];
    uint32_t sinceLastDataPollMs = (now - lastDataPoll) * 1000;
    // Check if data is ready, and if since last time we requested is less than SEN5X_POLL_INTERVAL
    if (!dataReady && (sinceLastDataPollMs > SEN5X_POLL_INTERVAL)) {
        LOG_INFO("%s: Data is not ready", sensorName);
        return 1;
    }

    if (!readValues()) {
        LOG_ERROR("%s: Error getting readings", sensorName);
        return 2;
    }

    if (!readPNValues(false)) {
        LOG_ERROR("%s: Error getting PN readings", sensorName);
        return 2;
    }

    lastDataPoll = now;

    return 0;
}

int32_t SEN5XSensor::wakeUpTimeMs()
{
    return SEN5X_WARMUP_MS_2;
}

int32_t SEN5XSensor::pendingForReadyMs()
{
    uint32_t now;
    now = getTime();
    uint32_t sincePmMeasureStarted = (now - pmMeasureStarted) * 1000;
    LOG_DEBUG("%s: Since measure started: %ums", sensorName, sincePmMeasureStarted);

    switch (state) {
    case SEN5X_MEASUREMENT: {

        if (sincePmMeasureStarted < SEN5X_WARMUP_MS_1) {
            LOG_INFO("%s: not enough time passed since starting measurement", sensorName);
            return SEN5X_WARMUP_MS_1 - sincePmMeasureStarted;
        }

        if (!pmMeasureStarted) {
            pmMeasureStarted = now;
        }

        // Get PN values to check if we are above or below threshold
        readPNValues(true);
        lastDataPoll = now;

        // If the reading is low (the tyhreshold is in #/cm3) and second warmUp hasn't passed we return to come back later
        if ((sen5xmeasurement.pN4p0 / 100) < SEN5X_PN4P0_CONC_THD && sincePmMeasureStarted < SEN5X_WARMUP_MS_2) {
            LOG_INFO("%s: Concentration is low, we will ask again in the second warm up period", sensorName);
            state = SEN5X_MEASUREMENT_2;
            // Report how many seconds are pending to cover the first warm up period
            return SEN5X_WARMUP_MS_2 - sincePmMeasureStarted;
        }
        return 0;
    }
    case SEN5X_MEASUREMENT_2: {
        if (sincePmMeasureStarted < SEN5X_WARMUP_MS_2) {
            // Report how many seconds are pending to cover the first warm up period
            return SEN5X_WARMUP_MS_2 - sincePmMeasureStarted;
        }
        return 0;
    }
    default: {
        return -1;
    }
    }
}

bool SEN5XSensor::getMetrics(meshtastic_Telemetry *measurement)
{
    LOG_INFO("%s: Attempting to get metrics", sensorName);
    if (!isActive()) {
        LOG_INFO("%s: not in measurement mode", sensorName);
        return false;
    }

    uint8_t response;
    response = getMeasurements();

    if (response == 0) {
        if (sen5xmeasurement.pM1p0 != UINT16_MAX) {
            measurement->variant.air_quality_metrics.has_pm10_standard = true;
            measurement->variant.air_quality_metrics.pm10_standard = sen5xmeasurement.pM1p0;
        }
        if (sen5xmeasurement.pM2p5 != UINT16_MAX) {
            measurement->variant.air_quality_metrics.has_pm25_standard = true;
            measurement->variant.air_quality_metrics.pm25_standard = sen5xmeasurement.pM2p5;
        }
        if (sen5xmeasurement.pM4p0 != UINT16_MAX) {
            measurement->variant.air_quality_metrics.has_pm40_standard = true;
            measurement->variant.air_quality_metrics.pm40_standard = sen5xmeasurement.pM4p0;
        }
        if (sen5xmeasurement.pM10p0 != UINT16_MAX) {
            measurement->variant.air_quality_metrics.has_pm100_standard = true;
            measurement->variant.air_quality_metrics.pm100_standard = sen5xmeasurement.pM10p0;
        }
        if (sen5xmeasurement.pN0p5 != UINT32_MAX) {
            measurement->variant.air_quality_metrics.has_particles_05um = true;
            measurement->variant.air_quality_metrics.particles_05um = sen5xmeasurement.pN0p5;
        }
        if (sen5xmeasurement.pN1p0 != UINT32_MAX) {
            measurement->variant.air_quality_metrics.has_particles_10um = true;
            measurement->variant.air_quality_metrics.particles_10um = sen5xmeasurement.pN1p0;
        }
        if (sen5xmeasurement.pN2p5 != UINT32_MAX) {
            measurement->variant.air_quality_metrics.has_particles_25um = true;
            measurement->variant.air_quality_metrics.particles_25um = sen5xmeasurement.pN2p5;
        }
        if (sen5xmeasurement.pN4p0 != UINT32_MAX) {
            measurement->variant.air_quality_metrics.has_particles_40um = true;
            measurement->variant.air_quality_metrics.particles_40um = sen5xmeasurement.pN4p0;
        }
        if (sen5xmeasurement.pN10p0 != UINT32_MAX) {
            measurement->variant.air_quality_metrics.has_particles_100um = true;
            measurement->variant.air_quality_metrics.particles_100um = sen5xmeasurement.pN10p0;
        }
        if (sen5xmeasurement.tSize != FLT_MAX) {
            measurement->variant.air_quality_metrics.has_particles_tps = true;
            measurement->variant.air_quality_metrics.particles_tps = sen5xmeasurement.tSize;
        }

        if (model != SEN50) {
            if (sen5xmeasurement.humidity != FLT_MAX) {
                measurement->variant.air_quality_metrics.has_pm_humidity = true;
                measurement->variant.air_quality_metrics.pm_humidity = sen5xmeasurement.humidity;
            }
            if (sen5xmeasurement.temperature != FLT_MAX) {
                measurement->variant.air_quality_metrics.has_pm_temperature = true;
                measurement->variant.air_quality_metrics.pm_temperature = sen5xmeasurement.temperature;
            }
            if (sen5xmeasurement.noxIndex != FLT_MAX) {
                measurement->variant.air_quality_metrics.has_pm_voc_idx = true;
                measurement->variant.air_quality_metrics.pm_voc_idx = sen5xmeasurement.vocIndex;
            }
        }

        if (model == SEN55) {
            if (sen5xmeasurement.noxIndex != FLT_MAX) {
                measurement->variant.air_quality_metrics.has_pm_nox_idx = true;
                measurement->variant.air_quality_metrics.pm_nox_idx = sen5xmeasurement.noxIndex;
            }
        }

        return true;
    } else if (response == 1) {
        // TODO return because data was not ready yet
        // Should this return false?
        idle();
        return false;
    } else if (response == 2) {
        // Return with error for non-existing data
        idle();
        return false;
    }

    return true;
}

void SEN5XSensor::setMode(bool setOneShot)
{
    oneShotMode = setOneShot;
    if (oneShotMode) {
        LOG_INFO("%s: setting mode to one shot mode", sensorName);
    } else {
        LOG_INFO("%s: setting mode to continuous mode", sensorName);
    }
}

AdminMessageHandleResult SEN5XSensor::handleAdminMessage(const meshtastic_MeshPacket &mp, meshtastic_AdminMessage *request,
                                                         meshtastic_AdminMessage *response)
{
    AdminMessageHandleResult result;
    result = AdminMessageHandleResult::NOT_HANDLED;

    switch (request->which_payload_variant) {
    case meshtastic_AdminMessage_sensor_config_tag:
        if (!request->sensor_config.has_sen5x_config) {
            result = AdminMessageHandleResult::NOT_HANDLED;
            break;
        }

        // Check for one-shot/continuous mode request
        if (request->sensor_config.sen5x_config.has_set_one_shot_mode) {
            this->setMode(request->sensor_config.sen5x_config.set_one_shot_mode);
        }

        // TODO - Add admin command to set temperature offset?
        // Check for temperature offset
        // if (request->sensor_config.sen5x_config.has_set_temperature) {
        //     this->setTemperature(request->sensor_config.sen5x_config.set_temperature);
        // }

        // TODO - Add admin command to trigger fan cleaning?
        // Check for one-shot/continuous mode request
        // if (request->sensor_config.sen5x_config.has_fan_cleaning && request->sensor_config.sen5x_config.fan_cleaning) {
        //     this->startCleaning();
        // }

        result = AdminMessageHandleResult::HANDLED;
        break;

    default:
        result = AdminMessageHandleResult::NOT_HANDLED;
    }

    return result;
}
#endif