LD2410Async
Asynchronous Arduino ESP32 library for the LD2410 mmWave radar sensor
Loading...
Searching...
No Matches
LD2410Types::ConfigData Struct Reference

#include <LD2410Types.h>

Public Member Functions

bool isValid () const
 Validates the configuration data for correctness.
 
bool equals (const ConfigData &other) const
 Compares this ConfigData with another for equality.
 
void print () const
 Debug helper: print configuration contents to Serial.
 

Public Attributes

byte numberOfGates = 0
 Number of distance gates (2-8). This member is read-only; changing its value will not influence the radar setting when configureAllConfigSettingsAsync() is called. It is not entirely clear what this value represents, but it seems to indicate the number of gates on the sensor.
 
byte maxMotionDistanceGate = 0
 Furthest gate used for motion detection.
 
byte maxStationaryDistanceGate = 0
 Furthest gate used for stationary detection.
 
byte distanceGateMotionSensitivity [9] = { 0 }
 Motion sensitivity values per gate (0-100).
 
byte distanceGateStationarySensitivity [9] = { 0 }
 Stationary sensitivity values per gate (0-100).
 
unsigned short noOneTimeout = 0
 Timeout (seconds) until "no presence" is declared.
 
DistanceResolution distanceResolution = DistanceResolution::NOT_SET
 Current distance resolution. A reboot is required to activate changes after configureAllConfigSettingsAsync() is called.
 
byte lightThreshold = 0
 Threshold for auxiliary light control (0-255).
 
LightControl lightControl = LightControl::NOT_SET
 Light-dependent auxiliary control mode.
 
OutputControl outputControl = OutputControl::NOT_SET
 Logic configuration of the OUT pin.
 

Detailed Description

@brief Stores the sensor's configuration parameters.

This structure represents both static capabilities (e.g. number of gates) and configurable settings (e.g. sensitivities, timeouts, resolution).

The values are typically filled by request commands such as requestAllConfigSettingsAsync() or requestGateParametersAsync() or requestAuxControlSettingsAsync() or requestDistanceResolutioncmAsync().

Definition at line 355 of file LD2410Types.h.

Member Function Documentation

◆ equals()

bool LD2410Types::ConfigData::equals ( const ConfigData & other) const
inline

Compares this ConfigData with another for equality.

Parameters
otherThe other ConfigData instance to compare against.
Returns
True if all fields are equal, false otherwise.

Definition at line 414 of file LD2410Types.h.

◆ isValid()

bool LD2410Types::ConfigData::isValid ( ) const
inline

Validates the configuration data for correctness.

Ensures that enum values are set and values are within valid ranges. This method is called internally before applying a config via configureAllConfigSettingsAsync().

Returns
True if the configuration is valid, false otherwise.

Definition at line 389 of file LD2410Types.h.

◆ print()

void LD2410Types::ConfigData::print ( ) const
inline

Debug helper: print configuration contents to Serial.

Definition at line 434 of file LD2410Types.h.

Member Data Documentation

◆ distanceGateMotionSensitivity

byte LD2410Types::ConfigData::distanceGateMotionSensitivity[9] = { 0 }

Motion sensitivity values per gate (0-100).

Definition at line 364 of file LD2410Types.h.

◆ distanceGateStationarySensitivity

byte LD2410Types::ConfigData::distanceGateStationarySensitivity[9] = { 0 }

Stationary sensitivity values per gate (0-100).

Definition at line 365 of file LD2410Types.h.

◆ distanceResolution

DistanceResolution LD2410Types::ConfigData::distanceResolution = DistanceResolution::NOT_SET

Current distance resolution. A reboot is required to activate changes after configureAllConfigSettingsAsync() is called.

Definition at line 371 of file LD2410Types.h.

◆ lightControl

LightControl LD2410Types::ConfigData::lightControl = LightControl::NOT_SET

Light-dependent auxiliary control mode.

Definition at line 375 of file LD2410Types.h.

◆ lightThreshold

byte LD2410Types::ConfigData::lightThreshold = 0

Threshold for auxiliary light control (0-255).

Definition at line 374 of file LD2410Types.h.

◆ maxMotionDistanceGate

byte LD2410Types::ConfigData::maxMotionDistanceGate = 0

Furthest gate used for motion detection.

Definition at line 360 of file LD2410Types.h.

◆ maxStationaryDistanceGate

byte LD2410Types::ConfigData::maxStationaryDistanceGate = 0

Furthest gate used for stationary detection.

Definition at line 361 of file LD2410Types.h.

◆ noOneTimeout

unsigned short LD2410Types::ConfigData::noOneTimeout = 0

Timeout (seconds) until "no presence" is declared.

Definition at line 368 of file LD2410Types.h.

◆ numberOfGates

byte LD2410Types::ConfigData::numberOfGates = 0

Number of distance gates (2-8). This member is read-only; changing its value will not influence the radar setting when configureAllConfigSettingsAsync() is called. It is not entirely clear what this value represents, but it seems to indicate the number of gates on the sensor.

Definition at line 357 of file LD2410Types.h.

◆ outputControl

OutputControl LD2410Types::ConfigData::outputControl = OutputControl::NOT_SET

Logic configuration of the OUT pin.

Definition at line 376 of file LD2410Types.h.


The documentation for this struct was generated from the following file: