SparkFun Pulsed Coherent Radar Sensor  v2.0.0-3-g4d2d89c
Library for the SparkFun Pulsed Coherent Radar Sensor
Loading...
Searching...
No Matches
sfDevXM125PresenceV1.h
Go to the documentation of this file.
1
13#pragma once
14
15#include "sfDevXM125Presence.h"
16
17
18// Presence class definition
19
21{
22 public:
32 sfTkError_t begin(sfTkII2C *theBus = nullptr)
33 {
34 return sfDevXM125Presence::begin(theBus);
35 }
41 sfTkError_t presenceDetectorStart(uint32_t start = 1000, uint32_t end = 5000)
42 {
44 }
45
49 sfTkError_t getPresenceDistanceValuemm(uint32_t &presenceVal)
50 {
52 }
53
58 sfTkError_t getPresenceDetectorVersion(uint32_t &major, uint32_t &minor, uint32_t &patch)
59 {
60 return sfDevXM125Presence::getDetectorVersion(major, minor, patch);
61 }
62
71 sfTkError_t getPresenceDetectorError(uint32_t &error)
72 {
74 }
75
80 sfTkError_t getPresenceMeasureCounter(uint32_t &counter)
81 {
83 }
84
89 sfTkError_t getPresenceDetectorStatus(uint32_t &status)
90 {
92 }
93
98 sfTkError_t getPresenceDetectorErrorStatus(uint32_t &status)
99 {
101 }
102
106 sfTkError_t getPresenceDetectorPresenceDetected(uint32_t &detected)
107 {
109 }
110
115 sfTkError_t getPresenceDetectorPresenceStickyDetected(uint32_t &sticky)
116 {
118 }
119
124 sfTkError_t getPresenceDetectorRegError(uint32_t &error)
125 {
127 }
128
134 sfTkError_t getPresenceTemperature(uint32_t &temp)
135 {
137 }
138
143 sfTkError_t getPresenceDistance(uint32_t &distance)
144 {
145 return sfDevXM125Presence::getDistance(distance);
146 }
147
151 sfTkError_t getPresenceIntraPresenceScore(uint32_t &intra)
152 {
154 }
155
159 sfTkError_t getPresenceInterPresenceScore(uint32_t &inter)
160 {
162 }
163
169 sfTkError_t getPresenceSweepsPerFrame(uint32_t &sweeps)
170 {
172 }
173
179 sfTkError_t setPresenceSweepsPerFrame(uint32_t sweeps)
180 {
182 }
183
190 sfTkError_t getPresenceInterFramePresenceTimeout(uint32_t &time)
191 {
193 }
194
201 sfTkError_t setPresenceInterFramePresenceTimeout(uint32_t time)
202 {
204 }
205
212 {
214 }
215
222 {
224 }
225
232 {
234 }
235
242 {
244 }
245
251 sfTkError_t getPresenceFrameRate(uint32_t &rate)
252 {
254 }
255
261 sfTkError_t setPresenceFrameRate(uint32_t rate)
262 {
264 }
265
272 sfTkError_t getPresenceIntraDetectionThreshold(uint32_t &thresh)
273 {
275 }
276
283 sfTkError_t setPresenceIntraDetectionThreshold(uint32_t thresh)
284 {
286 }
287
294 sfTkError_t getPresenceInterDetectionThreshold(uint32_t &thresh)
295 {
297 }
298
305 sfTkError_t setPresenceInterDetectionThreshold(uint32_t thresh)
306 {
308 }
309
316 sfTkError_t getPresenceInterFrameDeviationTime(uint32_t &time)
317 {
319 }
320
327 sfTkError_t setPresenceInterFrameDeviationTime(uint32_t time)
328 {
330 }
331
338 sfTkError_t getPresenceInterFrameFastCutoff(uint32_t &cut)
339 {
341 }
342
349 sfTkError_t setPresenceInterFrameFastCutoff(uint32_t cut)
350 {
352 }
353
360 sfTkError_t getPresenceInterFrameSlowCutoff(uint32_t &cut)
361 {
363 }
364
371 sfTkError_t setPresenceInterFrameSlowCutoff(uint32_t cut)
372 {
374 }
375
382 sfTkError_t getPresenceIntraFrameTimeConst(uint32_t &time)
383 {
385 }
386
393 sfTkError_t setPresenceIntraFrameTimeConst(uint32_t time)
394 {
396 }
397
404 sfTkError_t getPresenceIntraOutputTimeConst(uint32_t &time)
405 {
407 }
408
415 sfTkError_t setPresenceIntraOutputTimeConst(uint32_t time)
416 {
418 }
419
426 sfTkError_t getPresenceInterOutputTimeConst(uint32_t &time)
427 {
429 }
430
437 sfTkError_t setPresenceInterOutputTimeConst(uint32_t time)
438 {
440 }
441
447 sfTkError_t getPresenceAutoProfileEn(bool &en)
448 {
450 }
451
457 sfTkError_t setPresenceAutoProfileEn(bool en)
458 {
460 }
461
466 sfTkError_t getPresenceAutoStepLengthEn(bool &en)
467 {
469 }
470
475 sfTkError_t setPresenceAutoStepLengthEn(bool en)
476 {
478 }
479
484 sfTkError_t getPresenceManualProfile(uint32_t &prof)
485 {
487 }
488
493 sfTkError_t setPresenceManualProfile(uint32_t prof)
494 {
496 }
497
504 sfTkError_t getPresenceManualStepLength(uint32_t &length)
505 {
507 }
508
515 sfTkError_t setPresenceManualStepLength(uint32_t length)
516 {
518 }
519
525 sfTkError_t getPresenceStart(uint32_t &start)
526 {
528 }
529
535 sfTkError_t setPresenceStart(uint32_t start)
536 {
538 }
539
546 sfTkError_t getPresenceEnd(uint32_t &end)
547 {
548 return sfDevXM125Presence::getEnd(end);
549 }
550
557 sfTkError_t setPresenceEnd(uint32_t end)
558 {
559 return sfDevXM125Presence::setEnd(end);
560 }
561
568 {
570 }
571
578 {
580 }
581
587 sfTkError_t getPresenceHWAAS(uint32_t &avg)
588 {
590 }
591
597 sfTkError_t setPresenceHWAAS(uint32_t avg)
598 {
600 }
601
606 sfTkError_t getPresenceDetectionOnGPIO(uint32_t &detected)
607 {
609 }
610
615 sfTkError_t setPresenceDetectionOnGPIO(uint32_t detected)
616 {
618 }
619
623 sfTkError_t setPresenceCommand(uint32_t cmd)
624 {
626 }
627
632 {
634 }
635
639 sfTkError_t presenceStart()
640 {
642 }
643
647 sfTkError_t presenceStop()
648 {
650 }
651
656 {
658 }
659
664 {
666 }
667
672 {
674 }
675
679 sfTkError_t presenceReset()
680 {
682 }
683
687 sfTkError_t getPresenceBusy(uint32_t &busy)
688 {
689 return sfDevXM125Presence::getBusy(busy);
690 }
691
696 sfTkError_t presenceBusyWait()
697 {
699 }
700};
Definition: sfDevXM125Presence.h:235
sfTkError_t getIntraPresenceScore(uint32_t &intra)
This function returns the measure of amount of fast motion detected.
Definition: sfDevXM125Presence.cpp:269
sfTkError_t getInterPhaseBoostEnabled(bool &en)
This function returns the enable to increase detection of slow motions by utilizing the phase informa...
Definition: sfDevXM125Presence.cpp:302
sfTkError_t enableUartLogs()
This function enables the uart logs of the device by writing the defined value to the presence comman...
Definition: sfDevXM125Presence.cpp:595
sfTkError_t getDetectorRegError(uint32_t &error)
This function returns the indication that the presence detector failed.
Definition: sfDevXM125Presence.cpp:243
sfTkError_t getInterFrameSlowCutoff(uint32_t &cut)
This function returns the cutoff frequency of the low pass filter for the slow filtered absolute swee...
Definition: sfDevXM125Presence.cpp:397
sfTkError_t setInterFrameSlowCutoff(uint32_t cut)
This function sets the cutoff frequency of the low pass filter for the slow filtered absolute sweep m...
Definition: sfDevXM125Presence.cpp:403
sfTkError_t getInterOutputTimeConst(uint32_t &time)
This function returns time constant for the output in the inter-frame part Note: This value is a fact...
Definition: sfDevXM125Presence.cpp:433
sfTkError_t getDetectionOnGPIO(uint32_t &detected)
This function returns the output presence detection on generic GPIO.
Definition: sfDevXM125Presence.cpp:560
sfTkError_t getHWAAS(uint32_t &avg)
This function returns the hardware accelerated average sampled (HWAAS). Default Value: 32.
Definition: sfDevXM125Presence.cpp:548
sfTkError_t getInterPresenceScore(uint32_t &inter)
This function returns the measure of amount of slow motion detected.
Definition: sfDevXM125Presence.cpp:274
sfTkError_t setInterFramePresenceTimeout(uint32_t time)
Sets the number of seconds the inter-frame presence score needs to decrease before exponential scalin...
Definition: sfDevXM125Presence.cpp:296
sfTkError_t getEnd(uint32_t &end)
This function returns the end point of measurement interval in millimeters. Note: This value is a fac...
Definition: sfDevXM125Presence.cpp:517
sfTkError_t detectorStart(uint32_t start=1000, uint32_t end=5000)
This function sets all the beginning values for a basic I2C example to be run on the device for prese...
Definition: sfDevXM125Presence.cpp:35
sfTkError_t getResetFilters(bool &reset)
This function returns if the device is enabled/disabled for the reset of the presence filters during ...
Definition: sfDevXM125Presence.cpp:529
sfTkError_t setInterDetectionThreshold(uint32_t thresh)
This function sets the threshold for detecting slower movements inside frames. Note: This value is a ...
Definition: sfDevXM125Presence.cpp:367
sfTkError_t setResetFilters(bool reset)
This function sets if the device is enabled/disabled for the reset of the presence filters during sta...
Definition: sfDevXM125Presence.cpp:541
sfTkError_t logConfiguration()
This function enables the configuration log of the device by writing the defined value to the presenc...
Definition: sfDevXM125Presence.cpp:607
sfTkError_t getDetectorError(uint32_t &error)
This function returns the protocol state erorr.
Definition: sfDevXM125Presence.cpp:149
sfTkError_t setIntraFrameTimeConst(uint32_t time)
This functions sets time constant for the depthwise filtering in the intra-frame part Note: This valu...
Definition: sfDevXM125Presence.cpp:415
sfTkError_t setIntraOutputTimeConst(uint32_t time)
This function sets the time constant for the output in the intra-frame part Note: This value is a fac...
Definition: sfDevXM125Presence.cpp:427
sfTkError_t setCommand(uint32_t cmd)
This function sets the execute command.
Definition: sfDevXM125Presence.cpp:571
sfTkError_t getIntraFrameTimeConst(uint32_t &time)
This functions returns time constant for the depthwise filtering in the intra-frame part Note: This v...
Definition: sfDevXM125Presence.cpp:409
sfTkError_t getMeasureCounter(uint32_t &counter)
This function returns the measure counter; the number of measurements performed since restart.
Definition: sfDevXM125Presence.cpp:154
sfTkError_t applyConfiguration()
This function applies the configuration to the device by writing the defined value to the presence co...
Definition: sfDevXM125Presence.cpp:577
sfTkError_t setSweepsPerFrame(uint32_t sweeps)
This function sets the number of sweeps that will be captured in each frame (measurement)....
Definition: sfDevXM125Presence.cpp:284
sfTkError_t getManualStepLength(uint32_t &length)
THis function returns the number of steps between each data point. NOTE: The manual step length will ...
Definition: sfDevXM125Presence.cpp:493
sfTkError_t getIntraDetectionThreshold(uint32_t &thresh)
This function returns the threshold for detecting faster movements inside frames. Note: This value is...
Definition: sfDevXM125Presence.cpp:349
sfTkError_t getIntraOutputTimeConst(uint32_t &time)
This function returns time constant for the output in the intra-frame part Note: This value is a fact...
Definition: sfDevXM125Presence.cpp:421
sfTkError_t busyWait()
Completes a busy wait loop while the device is uploading information by waiting for the status....
Definition: sfDevXM125Presence.cpp:626
sfTkError_t getIntraDetectionEnabled(bool &en)
This function returns the bit to enable to detect faster movements inside frames. Default Value: true...
Definition: sfDevXM125Presence.cpp:320
sfTkError_t reset()
This function resets the presence detector settings of the device.
sfTkError_t getInterFrameFastCutoff(uint32_t &cut)
This function returns the cutoff frequency of the low pass filter for the fast filtered absolute swee...
Definition: sfDevXM125Presence.cpp:385
sfTkError_t stop()
This function stops the device by writing the defined stop value to the presence command register.
Definition: sfDevXM125Presence.cpp:589
sfTkError_t disableUartLogs()
This function disables the uart logs of the device by writing the defined value to the presence comma...
Definition: sfDevXM125Presence.cpp:601
sfTkError_t setManualStepLength(uint32_t length)
THis function returns the number of steps between each data point. NOTE: The manual step length will ...
Definition: sfDevXM125Presence.cpp:499
sfTkError_t getDistanceValuemm(uint32_t &presenceVal)
This function returns the presence value of the register with all the checks in place as per the I2C ...
Definition: sfDevXM125Presence.cpp:89
sfTkError_t setHWAAS(uint32_t avg)
This function sets the hardware accelerated average sampled (HWAAS). Default Value: 32.
Definition: sfDevXM125Presence.cpp:554
sfTkError_t setAutoStepLengthEn(bool en)
This function Enables/Disables automatic selection of step length based on the profile.
Definition: sfDevXM125Presence.cpp:474
sfTkError_t setIntraDetectionThreshold(uint32_t thresh)
This function sets the threshold for detecting faster movements inside frames. Note: This value is a ...
Definition: sfDevXM125Presence.cpp:355
sfTkError_t getTemperature(uint32_t &temp)
This function returns the temperature in sensor during measurement (in degree Celsius)....
Definition: sfDevXM125Presence.cpp:254
sfTkError_t setInterOutputTimeConst(uint32_t time)
This function sets the time constant for the output in the inter-frame part Note: This value is a fac...
Definition: sfDevXM125Presence.cpp:439
sfTkError_t getFrameRate(uint32_t &rate)
This function returns the presence detector frame rate. Note: This value is a factor 1000 larger than...
Definition: sfDevXM125Presence.cpp:337
sfTkError_t setFrameRate(uint32_t rate)
This function sets the presence detector frame rate. Note: This value is a factor 1000 larger than th...
Definition: sfDevXM125Presence.cpp:343
sfTkError_t getAutoProfileEn(bool &en)
This function returns if enable/disable for the automatic selection of profile based on start point o...
Definition: sfDevXM125Presence.cpp:445
sfTkError_t getDetectorVersion(uint32_t &major, uint32_t &minor, uint32_t &patch)
This function returns the RSS version number.
Definition: sfDevXM125Presence.cpp:132
sfTkError_t getAutoStepLengthEn(bool &en)
This function returns the Enable/Disable automatic selection of step length based on the profile.
Definition: sfDevXM125Presence.cpp:463
sfTkError_t start()
This function starts the device by writing the defined start value to the presence command register.
Definition: sfDevXM125Presence.cpp:583
sfTkError_t setInterDetectionEnabled(bool en)
This function returns the bit to enable to detect slower movements between frames....
Definition: sfDevXM125Presence.cpp:330
sfTkError_t getDistance(uint32_t &distance)
This function returns the distance, in millimeters, for the detected presence.
Definition: sfDevXM125Presence.cpp:264
sfTkError_t getInterFramePresenceTimeout(uint32_t &time)
Returns the number of seconds the inter-frame presence score needs to decrease before exponential sca...
Definition: sfDevXM125Presence.cpp:290
sfTkError_t getDetectorPresenceDetected(uint32_t &detected)
This function returns if there was presence detected.
Definition: sfDevXM125Presence.cpp:218
sfTkError_t setStart(uint32_t start)
This function sets the start of measured interval in mm. Note: This value is a factor 1000 larger tha...
Definition: sfDevXM125Presence.cpp:511
sfTkError_t getDetectorPresenceStickyDetected(uint32_t &sticky)
This function returns if there was presence detected, sticky bit with clear on read.
Definition: sfDevXM125Presence.cpp:230
sfTkError_t getBusy(uint32_t &busy)
This function returns the busy bit of the presence status register.
Definition: sfDevXM125Presence.cpp:613
sfTkError_t setInterPhaseBoostEnabled(bool en)
This function sets the enable to increase detection of slow motions by utilizing the phase informatio...
Definition: sfDevXM125Presence.cpp:313
sfTkError_t setEnd(uint32_t end)
This function returns the end point of measurement interval in millimeters. Note: This value is a fac...
Definition: sfDevXM125Presence.cpp:523
sfTkError_t getSweepsPerFrame(uint32_t &sweeps)
This function returns the number of sweeps that will be captured in each frame (measurement)....
Definition: sfDevXM125Presence.cpp:279
sfTkError_t setDetectionOnGPIO(uint32_t detected)
This function returns the output presence detection on generic GPIO.
Definition: sfDevXM125Presence.cpp:566
sfTkError_t getStart(uint32_t &start)
This function returns the start of measured interval in mm. Note: This value is a factor 1000 larger ...
Definition: sfDevXM125Presence.cpp:505
sfTkError_t getInterFrameDeviationTime(uint32_t &time)
This function returns the time constant of the low pass filter for the inter-frame deviation between ...
Definition: sfDevXM125Presence.cpp:373
sfTkError_t setManualProfile(uint32_t prof)
This function sets the profile to use. The profile will only be used if profile auto selection was di...
Definition: sfDevXM125Presence.cpp:487
sfTkError_t setAutoProfileEn(bool en)
This function enables/disables the automatic selection of profile based on start point of measurement...
Definition: sfDevXM125Presence.cpp:456
sfTkError_t setInterFrameDeviationTime(uint32_t time)
This function sets the time constant of the low pass filter for the inter-frame deviation between fas...
Definition: sfDevXM125Presence.cpp:379
sfTkError_t getDetectorErrorStatus(uint32_t &status)
This function returns the error status according to the bit mask value for the presence devices error...
Definition: sfDevXM125Presence.cpp:164
sfTkError_t getInterDetectionThreshold(uint32_t &thresh)
This function returns the threshold for detecting slower movements inside frames. Note: This value is...
Definition: sfDevXM125Presence.cpp:361
sfTkError_t getDetectorStatus(uint32_t &status)
This function returns the detector status flags. See page 17, section 6.2.4 Detector Status.
Definition: sfDevXM125Presence.cpp:159
sfTkError_t setInterFrameFastCutoff(uint32_t cut)
This function sets the cutoff frequency of the low pass filter for the fast filtered absolute sweep m...
Definition: sfDevXM125Presence.cpp:391
sfTkError_t begin(sfTkII2C *theBus=nullptr)
Initializes the Presence detector device.
Definition: sfDevXM125Presence.cpp:15
sfTkError_t getManualProfile(uint32_t &prof)
This function returns the profile in use. The profile will only be used if profile auto selection was...
Definition: sfDevXM125Presence.cpp:481
Definition: sfDevXM125PresenceV1.h:21
sfTkError_t getPresenceInterFrameSlowCutoff(uint32_t &cut)
This function returns the cutoff frequency of the low pass filter for the slow filtered absolute swee...
Definition: sfDevXM125PresenceV1.h:360
sfTkError_t getPresenceInterPhaseBoostEnabled(bool &en)
This function returns the enable to increase detection of slow motions by utilizing the phase informa...
Definition: sfDevXM125PresenceV1.h:211
sfTkError_t getPresenceDetectionOnGPIO(uint32_t &detected)
This function returns the output presence detection on generic GPIO.
Definition: sfDevXM125PresenceV1.h:606
sfTkError_t getPresenceBusy(uint32_t &busy)
This function returns the busy bit of the presence status register.
Definition: sfDevXM125PresenceV1.h:687
sfTkError_t getPresenceDistanceValuemm(uint32_t &presenceVal)
This function returns the presence value of the register with all the checks in place as per the I2C ...
Definition: sfDevXM125PresenceV1.h:49
sfTkError_t setPresenceIntraDetectionThreshold(uint32_t thresh)
This function sets the threshold for detecting faster movements inside frames. Note: This value is a ...
Definition: sfDevXM125PresenceV1.h:283
sfTkError_t presenceBusyWait()
Completes a busy wait loop while the device is uploading information by waiting for the status....
Definition: sfDevXM125PresenceV1.h:696
sfTkError_t setPresenceCommand(uint32_t cmd)
This function sets the execute command.
Definition: sfDevXM125PresenceV1.h:623
sfTkError_t getPresenceInterOutputTimeConst(uint32_t &time)
This function returns time constant for the output in the inter-frame part Note: This value is a fact...
Definition: sfDevXM125PresenceV1.h:426
sfTkError_t getPresenceDetectorPresenceStickyDetected(uint32_t &sticky)
This function returns if there was presence detected, sticky bit with clear on read.
Definition: sfDevXM125PresenceV1.h:115
sfTkError_t getPresenceDetectorPresenceDetected(uint32_t &detected)
This function returns if there was presence detected.
Definition: sfDevXM125PresenceV1.h:106
sfTkError_t getPresenceDistance(uint32_t &distance)
This function returns the distance, in millimeters, for the detected presence.
Definition: sfDevXM125PresenceV1.h:143
sfTkError_t getPresenceHWAAS(uint32_t &avg)
This function returns the hardware accelerated average sampled (HWAAS). Default Value: 32.
Definition: sfDevXM125PresenceV1.h:587
sfTkError_t getPresenceFrameRate(uint32_t &rate)
This function returns the presence detector frame rate. Note: This value is a factor 1000 larger than...
Definition: sfDevXM125PresenceV1.h:251
sfTkError_t setPresenceAutoProfileEn(bool en)
This function enables/disables the automatic selection of profile based on start point of measurement...
Definition: sfDevXM125PresenceV1.h:457
sfTkError_t setPresenceFrameRate(uint32_t rate)
This function sets the presence detector frame rate. Note: This value is a factor 1000 larger than th...
Definition: sfDevXM125PresenceV1.h:261
sfTkError_t getPresenceManualProfile(uint32_t &prof)
This function returns the profile in use. The profile will only be used if profile auto selection was...
Definition: sfDevXM125PresenceV1.h:484
sfTkError_t setPresenceInterFramePresenceTimeout(uint32_t time)
Sets the number of seconds the inter-frame presence score needs to decrease before exponential scalin...
Definition: sfDevXM125PresenceV1.h:201
sfTkError_t presenceApplyConfiguration()
This function applies the configuration to the device by writing the defined value to the presence co...
Definition: sfDevXM125PresenceV1.h:631
sfTkError_t getPresenceInterDetectionThreshold(uint32_t &thresh)
This function returns the threshold for detecting slower movements inside frames. Note: This value is...
Definition: sfDevXM125PresenceV1.h:294
sfTkError_t getPresenceIntraDetectionThreshold(uint32_t &thresh)
This function returns the threshold for detecting faster movements inside frames. Note: This value is...
Definition: sfDevXM125PresenceV1.h:272
sfTkError_t getPresenceStart(uint32_t &start)
This function returns the start of measured interval in mm. Note: This value is a factor 1000 larger ...
Definition: sfDevXM125PresenceV1.h:525
sfTkError_t setPresenceResetFilters(bool reset)
This function sets if the device is enabled/disabled for the reset of the presence filters during sta...
Definition: sfDevXM125PresenceV1.h:577
sfTkError_t getPresenceInterFrameFastCutoff(uint32_t &cut)
This function returns the cutoff frequency of the low pass filter for the fast filtered absolute swee...
Definition: sfDevXM125PresenceV1.h:338
sfTkError_t setPresenceEnd(uint32_t end)
This function returns the end point of measurement interval in millimeters. Note: This value is a fac...
Definition: sfDevXM125PresenceV1.h:557
sfTkError_t setPresenceStart(uint32_t start)
This function sets the start of measured interval in mm. Note: This value is a factor 1000 larger tha...
Definition: sfDevXM125PresenceV1.h:535
sfTkError_t getPresenceIntraOutputTimeConst(uint32_t &time)
This function returns time constant for the output in the intra-frame part Note: This value is a fact...
Definition: sfDevXM125PresenceV1.h:404
sfTkError_t getPresenceTemperature(uint32_t &temp)
This function returns the temperature in sensor during measurement (in degree Celsius)....
Definition: sfDevXM125PresenceV1.h:134
sfTkError_t getPresenceDetectorStatus(uint32_t &status)
This function returns the detector status flags. See page 17, section 6.2.4 Detector Status.
Definition: sfDevXM125PresenceV1.h:89
sfTkError_t getPresenceIntraPresenceScore(uint32_t &intra)
This function returns the measure of amount of fast motion detected.
Definition: sfDevXM125PresenceV1.h:151
sfTkError_t presenceReset()
This function resets the presence detector settings of the device.
Definition: sfDevXM125PresenceV1.h:679
sfTkError_t setPresenceInterDetectionEnabled(bool en)
This function returns the bit to enable to detect slower movements between frames....
Definition: sfDevXM125PresenceV1.h:241
sfTkError_t presenceLogConfiguration()
This function enables the configuration log of the device by writing the defined value to the presenc...
Definition: sfDevXM125PresenceV1.h:671
sfTkError_t setPresenceHWAAS(uint32_t avg)
This function sets the hardware accelerated average sampled (HWAAS). Default Value: 32.
Definition: sfDevXM125PresenceV1.h:597
sfTkError_t getPresenceInterPresenceScore(uint32_t &inter)
This function returns the measure of amount of slow motion detected.
Definition: sfDevXM125PresenceV1.h:159
sfTkError_t getPresenceResetFilters(bool &reset)
This function returns if the device is enabled/disabled for the reset of the presence filters during ...
Definition: sfDevXM125PresenceV1.h:567
sfTkError_t setPresenceInterFrameSlowCutoff(uint32_t cut)
This function sets the cutoff frequency of the low pass filter for the slow filtered absolute sweep m...
Definition: sfDevXM125PresenceV1.h:371
sfTkError_t setPresenceInterDetectionThreshold(uint32_t thresh)
This function sets the threshold for detecting slower movements inside frames. Note: This value is a ...
Definition: sfDevXM125PresenceV1.h:305
sfTkError_t setPresenceIntraFrameTimeConst(uint32_t time)
This functions sets time constant for the depthwise filtering in the intra-frame part Note: This valu...
Definition: sfDevXM125PresenceV1.h:393
sfTkError_t getPresenceDetectorError(uint32_t &error)
This function returns the protocol state error.
Definition: sfDevXM125PresenceV1.h:71
sfTkError_t getPresenceAutoStepLengthEn(bool &en)
This function returns the Enable/Disable automatic selection of step length based on the profile.
Definition: sfDevXM125PresenceV1.h:466
sfTkError_t getPresenceManualStepLength(uint32_t &length)
THis function returns the number of steps between each data point. NOTE: The manual step length will ...
Definition: sfDevXM125PresenceV1.h:504
sfTkError_t setPresenceSweepsPerFrame(uint32_t sweeps)
This function sets the number of sweeps that will be captured in each frame (measurement)....
Definition: sfDevXM125PresenceV1.h:179
sfTkError_t presenceStart()
This function starts the device by writing the defined start value to the presence command register.
Definition: sfDevXM125PresenceV1.h:639
sfTkError_t setPresenceInterFrameFastCutoff(uint32_t cut)
This function sets the cutoff frequency of the low pass filter for the fast filtered absolute sweep m...
Definition: sfDevXM125PresenceV1.h:349
sfTkError_t setPresenceIntraOutputTimeConst(uint32_t time)
This function sets the time constant for the output in the intra-frame part Note: This value is a fac...
Definition: sfDevXM125PresenceV1.h:415
sfTkError_t setPresenceInterOutputTimeConst(uint32_t time)
This function sets the time constant for the output in the inter-frame part Note: This value is a fac...
Definition: sfDevXM125PresenceV1.h:437
sfTkError_t presenceStop()
This function stops the device by writing the defined stop value to the presence command register.
Definition: sfDevXM125PresenceV1.h:647
sfTkError_t getPresenceInterFrameDeviationTime(uint32_t &time)
This function returns the time constant of the low pass filter for the inter-frame deviation between ...
Definition: sfDevXM125PresenceV1.h:316
sfTkError_t setPresenceDetectionOnGPIO(uint32_t detected)
This function sets the output presence detection on generic GPIO.
Definition: sfDevXM125PresenceV1.h:615
sfTkError_t getPresenceDetectorErrorStatus(uint32_t &status)
This function returns the error status according to the bit mask value for the presence devices error...
Definition: sfDevXM125PresenceV1.h:98
sfTkError_t getPresenceInterFramePresenceTimeout(uint32_t &time)
Returns the number of seconds the inter-frame presence score needs to decrease before exponential sca...
Definition: sfDevXM125PresenceV1.h:190
sfTkError_t presenceEnableUartLogs()
This function enables the uart logs of the device by writing the defined value to the presence comman...
Definition: sfDevXM125PresenceV1.h:655
sfTkError_t getPresenceSweepsPerFrame(uint32_t &sweeps)
This function returns the number of sweeps that will be captured in each frame (measurement)....
Definition: sfDevXM125PresenceV1.h:169
sfTkError_t getPresenceEnd(uint32_t &end)
This function returns the end point of measurement interval in millimeters. Note: This value is a fac...
Definition: sfDevXM125PresenceV1.h:546
sfTkError_t getPresenceIntraDetectionEnabled(bool &en)
This function returns the bit to enable to detect faster movements inside frames. Default Value: true...
Definition: sfDevXM125PresenceV1.h:231
sfTkError_t setPresenceAutoStepLengthEn(bool en)
This function Enables/Disables automatic selection of step length based on the profile.
Definition: sfDevXM125PresenceV1.h:475
sfTkError_t presenceDisableUartLogs()
This function disables the uart logs of the device by writing the defined value to the presence comma...
Definition: sfDevXM125PresenceV1.h:663
sfTkError_t begin(sfTkII2C *theBus=nullptr)
Initializes the Presence detector device.
Definition: sfDevXM125PresenceV1.h:32
sfTkError_t getPresenceMeasureCounter(uint32_t &counter)
This function returns the measure counter; the number of measurements performed since restart.
Definition: sfDevXM125PresenceV1.h:80
sfTkError_t setPresenceInterPhaseBoostEnabled(bool en)
This function sets the enable to increase detection of slow motions by utilizing the phase informatio...
Definition: sfDevXM125PresenceV1.h:221
sfTkError_t setPresenceManualProfile(uint32_t prof)
This function sets the profile to use. The profile will only be used if profile auto selection was di...
Definition: sfDevXM125PresenceV1.h:493
sfTkError_t getPresenceIntraFrameTimeConst(uint32_t &time)
This functions returns time constant for the depthwise filtering in the intra-frame part Note: This v...
Definition: sfDevXM125PresenceV1.h:382
sfTkError_t setPresenceInterFrameDeviationTime(uint32_t time)
This function sets the time constant of the low pass filter for the inter-frame deviation between fas...
Definition: sfDevXM125PresenceV1.h:327
sfTkError_t getPresenceAutoProfileEn(bool &en)
This function returns if enable/disable for the automatic selection of profile based on start point o...
Definition: sfDevXM125PresenceV1.h:447
sfTkError_t getPresenceDetectorVersion(uint32_t &major, uint32_t &minor, uint32_t &patch)
This function returns the RSS version number.
Definition: sfDevXM125PresenceV1.h:58
sfTkError_t getPresenceDetectorRegError(uint32_t &error)
This function returns the indication that the presence detector failed.
Definition: sfDevXM125PresenceV1.h:124
sfTkError_t setPresenceManualStepLength(uint32_t length)
THis function returns the number of steps between each data point. NOTE: The manual step length will ...
Definition: sfDevXM125PresenceV1.h:515
sfTkError_t presenceDetectorStart(uint32_t start=1000, uint32_t end=5000)
This function sets all the beginning values for a basic I2C example to be run on the device for prese...
Definition: sfDevXM125PresenceV1.h:41
Header of the SparkFun Qwiic XM125 Library.