MyLD2410.h

Go to the documentation of this file.

#ifndef MY_LD2410_H
#define MY_LD2410_H
 
/*
 
MyLD2410 library
An Arduino library for the LD2410 presence sensor, including HLK-LD2410B and HLK-LD2410C.
https://github.com/iavorvel/MyLD2410
 
*/

 
#include <Arduino.h>
#define LD2410_BAUD_RATE 256000
#define LD2410_BUFFER_SIZE 0x40
#define LD2410_LATEST_FIRMWARE "2.44"

enum class LightControl
{
  NOT_SET = -1,
  NO_LIGHT_CONTROL,
  LIGHT_BELOW_THRESHOLD,
  LIGHT_ABOVE_THRESHOLD
};

enum class OutputControl
{
  NOT_SET = -1,
  DEFAULT_LOW,
  DEFAULT_HIGH,
};

enum class AutoStatus
{
  NOT_SET = -1,
  NOT_IN_PROGRESS,
  IN_PROGRESS,
  COMPLETED
};
 
class MyLD2410
{
public:
  enum Response
  {
    FAIL = 0,
    ACK,
    DATA
  };
  struct ValuesArray
  {
    byte values[9];
    byte N = 0;
 
    void setN(byte n)
    {
      N = (n <= 8) ? n : 8;
    }
    ValuesArray &operator=(const ValuesArray &other)
    {
      if (this != &other)
      {
        N = other.N;
        for (byte i = 0; i <= N; i++)
          values[i] = other.values[i];
      }
      return *this;
    }
    template <typename ByteHandler>
    void forEach(ByteHandler func) const
    {
      for (byte i = 0; i <= N; i++)
        func(values[i]);
    }
  };
  struct SensorData
  {
    byte status;
    unsigned long timestamp;
    unsigned long mTargetDistance;
    byte mTargetSignal;
    unsigned long sTargetDistance;
    byte sTargetSignal;
    unsigned long distance;
    // Enhanced data
    ValuesArray mTargetSignals;
    ValuesArray sTargetSignals;
  };
 
private:
  SensorData sData;
  ValuesArray stationaryThresholds;
  ValuesArray movingThresholds;
  byte maxRange = 0;
  byte noOne_window = 0;
  byte lightLevel = 0;
  byte outLevel = 0;
  byte lightThreshold = 0;
  LightControl lightControl = LightControl::NOT_SET;
  OutputControl outputControl = OutputControl::NOT_SET;
  AutoStatus autoStatus = AutoStatus::NOT_SET;
  unsigned long version = 0;
  unsigned long bufferSize = 0;
  byte MAC[6];
  String MACstr = "";
  String firmware = "";
  byte firmwareMajor = 0;
  byte firmwareMinor = 0;
  int fineRes = -1;
  bool isEnhanced = false;
  bool isConfig = false;
  unsigned long timeout = 2000;
  unsigned long dataLifespan = 500;
  byte inBuf[LD2410_BUFFER_SIZE];
  byte inBufI = 0;
  byte headBuf[4];
  byte headBufI = 0;
  Stream *sensor;
  bool _debug = false;
  bool isDataValid();
  bool readFrame();
  bool sendCommand(const byte *command);
  bool processAck();
  bool processData();
 
public:
  MyLD2410(Stream &serial, bool debug = false);
 
  // CONTROLS

  bool begin();

  void end();

  void debugOn();

  void debugOff();

  Response check();
 
  // GETTERS

  bool inConfigMode();

  bool inBasicMode();

  bool inEnhancedMode();

  byte getStatus();

  const char *statusString();

  bool presenceDetected();

  bool stationaryTargetDetected();

  unsigned long stationaryTargetDistance();

  byte stationaryTargetSignal();

  const ValuesArray &getStationarySignals();

  bool movingTargetDetected();

  unsigned long movingTargetDistance();

  byte movingTargetSignal();

  const ValuesArray &getMovingSignals();

  unsigned long detectedDistance();

  const byte *getMAC();

  String getMACstr();

  String getFirmware();

  byte getFirmwareMajor();

  byte getFirmwareMinor();

  unsigned long getVersion();

  const SensorData &getSensorData();

  byte getResolution();
 
  // parameters

  const ValuesArray &getMovingThresholds();

  const ValuesArray &getStationaryThresholds();

  byte getRange();

  unsigned long getRange_cm();

  byte getNoOneWindow();
  // end parameters
 
  // REQUESTS

  bool configMode(bool enable = true);

  bool enhancedMode(bool enable = true);

  bool requestAuxConfig();

  bool autoThresholds(byte _timeout = 10);

  AutoStatus getAutoStatus();

  bool requestMAC();

  bool requestFirmware();

  bool requestResolution();

  bool setResolution(bool fine = false);

  bool requestParameters();

  bool setGateParameters(byte gate, byte movingThreshold, byte stationaryThreshold);

  bool setMovingThreshold(byte gate, byte movingThreshold);

  bool setStationaryThreshold(byte gate, byte stationaryThreshold);

  bool
  setGateParameters(const ValuesArray &moving_thresholds, const ValuesArray &stationary_thresholds, byte noOneWindow = 5);

  bool setMaxGate(byte movingGate, byte stationaryGate, byte noOneWindow = 5);

  bool setNoOneWindow(byte noOneWindow);

  bool setMaxMovingGate(byte movingGate);

  bool setMaxStationaryGate(byte stationaryGate);

  byte getMaxMovingGate();

  byte getMaxStationaryGate();

  bool requestReset();

  bool requestReboot();

  bool requestBTon();

  bool requestBToff();

  bool setBTpassword(const char *passwd);

  bool setBTpassword(const String &passwd);

  bool resetBTpassword();

  bool setBaud(byte baud);

  byte getLightLevel();

  LightControl getLightControl();

  bool setAuxControl(LightControl light_control, byte light_threshold, OutputControl output_control);

  bool resetAuxControl();

  byte getLightThreshold();

  OutputControl getOutputControl();

  byte getOutLevel();
};
 
#endif // MY_LD2410_H