Skip to content

Commit 586d856

Browse files
MadisonC-SparkFunMadisonC-SparkFun
committed
Fixed keywords and library.prop files; small adjustments
Made small adjustments for some function names to correct the placement/funcitonality. Fixed keywords.txt and library.prop files for the Arduino IDE to work correctly with this library.
1 parent 2a668cb commit 586d856

File tree

5 files changed

+230
-58
lines changed

5 files changed

+230
-58
lines changed

‎keywords.txt‎

Lines changed: 217 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,238 @@
11
#########################################################
22
# Syntax Coloring Map for SparkFun XM125 #
33
#########################################################
4-
# Class
4+
# Datatypes
55
#########################################################
66

7-
XM125 KEYWORD1
8-
sfeTkArdI2C KEYWORD1
7+
sfe_xm125_distance_profile_t KEYWORD1
8+
sfe_xm125_distance_threshold_method_t KEYWORD1
9+
sfe_xm125_distance_peak_sorting_t KEYWORD1
10+
sfe_xm125_distance_reflector_shape_t KEYWORD1
11+
sfe_xm125_distance_command_t KEYWORD1
12+
sfe_xm125_presence_manual_profile_t KEYWORD1
13+
sfe_xm125_presence_command_t KEYWORD1
914

1015
#########################################################
1116
# Methods and Functions
1217
#########################################################
1318

1419
begin KEYWORD2
15-
acconeerBegin KEYWORD2
16-
disableInterrupts KEYWORD2
17-
enableInterrupts KEYWORD2
18-
preparePowerDown KEYWORD2
19-
resumePowerDown KEYWORD2
20-
getRTCTick KEYWORD2
21-
rtcTickToTime KEYWORD2
22-
setRTCWakeupTime KEYWORD2
23-
waitForI2CIdle KEYWORD2
24-
prepareRegisterData KEYWORD2
25-
initI2CApplicationSystem KEYWORD2x
26-
resetI2CApplicationSystem KEYWORD2
27-
i2cApplicationSystemWaitForInterrupt KEYWORD2
28-
i2cApplicationSystemTestWakeupPin KEYWORD2
29-
setI2CApplicationSystemReadyPin KEYWORD2
30-
configureI2CApplicationGPIO0Pin KEYWORD2
31-
setI2CApplicationGPIO0Pin KEYWORD2
32-
enterI2CApplicationLowerPowerState KEYWORD2
33-
setI2CApplicationPeriodicWakeup KEYWORD2
34-
errorI2CCallback KEYWORD2
35-
getI2CDistanceDetectorConfig KEYWORD2
36-
distanceDetectorCommand KEYWORD2
20+
distanceBegin KEYWORD2
21+
getDistanceDetectorVersion KEYWORD2
22+
getDistanceDetectorError KEYWORD2
23+
getDistanceMeasureCounter KEYWORD2
3724
getDistanceDetectorStatus KEYWORD2
38-
getDistanceDetectorResult KEYWORD2
39-
getDistanceDetectorCounter KEYWORD2
40-
getDistanceDetectorPeakDistance KEYWORD2
41-
getDistanceDetectorPeakStrength KEYWORD2
42-
setDistanceDetectorMeasureOnWakeup KEYWORD2
43-
getDistanceDetectorMeasureOnWakeup KEYWORD2
44-
presenceDetectorCommand KEYWORD2
45-
getpresenceDetectorConfig KEYWORD2
25+
getDistanceNumberDistances KEYWORD2
26+
getDistanceNearStartEdge KEYWORD2
27+
getDistanceCalibrationNeeded KEYWORD2
28+
getDistanceMeasureDistanceError KEYWORD2
29+
getDistanceTemperature KEYWORD2
30+
getDistancePeak0Distance KEYWORD2
31+
getDistancePeak1Distance KEYWORD2
32+
getDistancePeak2Distance KEYWORD2
33+
getDistancePeak3Distance KEYWORD2
34+
getDistancePeak4Distance KEYWORD2
35+
getDistancePeak5Distance KEYWORD2
36+
getDistancePeak6Distance KEYWORD2
37+
getDistancePeak7Distance KEYWORD2
38+
getDistancePeak8Distance KEYWORD2
39+
getDistancePeak9Distance KEYWORD2
40+
getDistancePeak0Strength KEYWORD2
41+
getDistancePeak1Strength KEYWORD2
42+
getDistancePeak2Strength KEYWORD2
43+
getDistancePeak3Strength KEYWORD2
44+
getDistancePeak4Strength KEYWORD2
45+
getDistancePeak5Strength KEYWORD2
46+
getDistancePeak6Strength KEYWORD2
47+
getDistancePeak7Strength KEYWORD2
48+
getDistancePeak8Strength KEYWORD2
49+
getDistancePeak9Strength KEYWORD2
50+
getDistanceStart KEYWORD2
51+
setDistanceStart KEYWORD2
52+
getDistanceEnd KEYWORD2
53+
setDistanceEnd KEYWORD2
54+
getDistanceMaxStepLength KEYWORD2
55+
setDistanceMaxStepLength KEYWORD2
56+
getDistanceCloseRangeLeakageCancellation KEYWORD2
57+
setDistanceCloseRangeLeakageCancellation KEYWORD2
58+
getDistanceSignalQuality KEYWORD2
59+
setDistanceSignalQuality KEYWORD2
60+
getDistanceMaxProfile KEYWORD2
61+
setDistanceMaxProfile KEYWORD2
62+
getDistanceThresholdMethod KEYWORD2
63+
setDistanceThresholdMethod KEYWORD2
64+
getDistancePeakSorting KEYWORD2
65+
setDistancePeakSorting KEYWORD2
66+
getDistanceNumFramesRecordedThreshold KEYWORD2
67+
setDistanceNumFramesRecordedThreshold KEYWORD2
68+
getDistanceFixedAmpThreshold KEYWORD2
69+
setDistanceFixedAmpThreshold KEYWORD2
70+
getDistanceThresholdSensitivity KEYWORD2
71+
setDistanceThresholdSensitivity KEYWORD2
72+
getDistanceReflectorShape KEYWORD2
73+
setDistanceReflectorShape KEYWORD2
74+
getDistanceFixedStrengthThresholdValue KEYWORD2
75+
setDistanceFixedStrengthThresholdValue KEYWORD2
76+
getDistanceMeasureOneWakeup KEYWORD2
77+
setDistanceMeasureOneWakeup KEYWORD2
78+
setDistanceCommand KEYWORD2
79+
presenceBegin KEYWORD2
80+
getPresenceDetectorVersion KEYWORD2
81+
getPresenceDetectorError KEYWORD2
82+
getPresenceMeasureCounter KEYWORD2
4683
getPresenceDetectorStatus KEYWORD2
47-
getPresenceDetectorResult KEYWORD2
48-
getPresenceDetectorDistance KEYWORD2
49-
getPresenceDetectorIntraPresenceScore KEYWORD2
50-
getPresenceDetectorInterPresenceScore KEYWORD2
51-
getPresenceDetectorCounter KEYWORD2
52-
getPresenceDetectorGPIODetection KEYWORD2
53-
getPresenceDetectorPresenceDetection KEYWORD2
84+
getPresenceDistanceResult KEYWORD2
85+
getPresenceNearStartEdge KEYWORD2
86+
getPresenceDetectorRegError KEYWORD2
87+
getPresenceTemperature KEYWORD2
88+
getPresenceDistance KEYWORD2
89+
getPresenceIntraPresenceScore KEYWORD2
90+
getPresenceInterPresenceScore KEYWORD2
91+
getPresenceSweepsPerFrame KEYWORD2
92+
setPresenceSweepsPerFrame KEYWORD2
93+
getPresenceInterFramePresenceTimeout KEYWORD2
94+
setPresenceInterFramePresenceTimeout KEYWORD2
95+
getPresenceInterPhaseBoostEnabled KEYWORD2
96+
setPresenceInterPhaseBoostEnabled KEYWORD2
97+
getPresenceIntraDetectionEnabled KEYWORD2
98+
setPresenceInterDetectionEnabled KEYWORD2
99+
getPresenceFrameRate KEYWORD2
100+
setPresenceFrameRate KEYWORD2
101+
getPresenceIntraDetectionThreshold KEYWORD2
102+
setPresenceIntraDetectionThreshold KEYWORD2
103+
getPresenceInterDetectionThreshold KEYWORD2
104+
setPresenceInterDetectionThreshold KEYWORD2
105+
getPresenceInterFrameDeviationTime KEYWORD2
106+
setPresenceInterFrameDeviationTime KEYWORD2
107+
getPresenceInterFrameFastCutoff KEYWORD2
108+
setPresenceInterFrameFastCutoff KEYWORD2
109+
getPresenceInterFrameSlowCutoff KEYWORD2
110+
setPresenceInterFrameSlowCutoff KEYWORD2
111+
getPresenceIntraFrameTimeConst KEYWORD2
112+
setPresenceIntraFrameTimeConst KEYWORD2
113+
getPresenceIntraOutputTimeConst KEYWORD2
114+
setPresenceIntraOutputTimeConst KEYWORD2
115+
getPresenceInterOutputTimeConst KEYWORD2
116+
setPresenceInterOutputTimeConst KEYWORD2
117+
getPresenceAutoProfileEn KEYWORD2
118+
setPresenceAutoProfileEn KEYWORD2
119+
getPresenceAutoStepLengthEn KEYWORD2
120+
setPresenceAutoStepLengthEn KEYWORD2
121+
getPresenceManualProfile KEYWORD2
122+
setPresenceManualProfile KEYWORD2
123+
getPresenceManualStepLength KEYWORD2
124+
setPresenceManualStepLength KEYWORD2
125+
getPresenceStart KEYWORD2
126+
setPresenceStart KEYWORD2
127+
getPresenceEnd KEYWORD2
128+
setPresenceEnd KEYWORD2
129+
getPresenceResetFilters KEYWORD2
130+
setPresenceResetFilters KEYWORD2
131+
getPresenceHWAAS KEYWORD2
132+
setPresenceHWAAS KEYWORD2
133+
getPresenceDetectionOnGPIO KEYWORD2
134+
setPresenceDetectionOnGPIO KEYWORD2
135+
setPresenceCommand KEYWORD2
54136

55137
#########################################################
56-
# Constants
138+
# Structs
57139
#########################################################
58140

59-
# TODO: Add these
60-
TEMPALTE_CONSTANT LITERAL1
141+
sfe_xm125_distance_version_t KEYWORD3
142+
sfe_xm125_distance_protocol_status_t KEYWORD3
143+
sfe_xm125_distance_detector_status_t KEYWORD3
144+
sfe_xm125_distance_result_t KEYWORD3
145+
sfe_xm125_presence_version_t KEYWORD3
146+
sfe_xm125_presence_protocol_status_t KEYWORD3
147+
sfe_xm125_presence_detector_status_t KEYWORD3
148+
sfe_xm125_presence_result_t KEYWORD3
61149

62150
#########################################################
63-
# Structs
151+
# Constants
64152
#########################################################
65153

66-
# TODO: Add these
67-
template_struct_t LITERAL3
154+
SFE_XM125_I2C_ADDRESS LITERAL1
155+
SFE_XM125_DISTANCE_VERSION LITERAL1
156+
SFE_XM125_DISTANCE_PROTOCOL_STATUS LITERAL1
157+
SFE_XM125_DISTANCE_MEASURE_COUNTER LITERAL1
158+
SFE_XM125_DISTANCE_DETECTOR_STATUS LITERAL1
159+
SFE_XM125_DISTANCE_RESULT LITERAL1
160+
SFE_XM125_DISTANCE_START LITERAL1
161+
sfe_xm125_distance_start_default LITERAL1
162+
SFE_XM125_DISTANCE_END LITERAL1
163+
sfe_xm125_distance_end_default LITERAL1
164+
SFE_XM125_DISTANCE_MAX_STEP_LENGTH LITERAL1
165+
sfe_xm125_distance_max_step_length_default LITERAL1
166+
SFE_XM125_DISTANCE_CLOSE_RANGE_LEAKAGE LITERAL1
167+
sfe_xm125_distance_close_range_leakage_default LITERAL1
168+
SFE_XM125_DISTANCE_SIGNAL_QUALITY LITERAL1
169+
sfe_xm125_distance_signal_quality_default LITERAL1
170+
SFE_XM125_DISTANCE_MAX_PROFILE LITERAL1
171+
SFE_XM125_DISTANCE_THRESHOLD_METHOD LITERAL1
172+
SFE_XM125_DISTANCE_PEAK_SORTING LITERAL1
173+
SFE_XM125_DISTANCE_NUM_FRAMES_RECORDED_THRESH LITERAL1
174+
sfe_xm125_distance_num_frames_recorded_thresh_default LITERAL1
175+
SFE_XM125_DISTANCE_FIXED_AMPLITUDE_THRESHOLD_VAL LITERAL1
176+
sfe_xm125_distance_fixed_amp_thresh_val_default LITERAL1
177+
SFE_XM125_DISTANCE_THREHSOLD_SENSITIVITY LITERAL1
178+
sfe_xm125_distance_threshold_sensitivity_default LITERAL1
179+
SFE_XM125_DISTANCE_REFLECTOR_SHAPE LITERAL1
180+
SFE_XM125_DISTANCE_FIXED_STRENGTH_THRESHOLD_VAL LITERAL1
181+
sfe_xm125_distance_fixed_strength_threshold_val_default LITERAL1
182+
SFE_XM125_DISTANCE_MEASURE_ON_WAKEUP LITERAL1
183+
sfe_xm125_distance_measure_on_wakup LITERAL1
184+
SFE_XM125_DISTANCE_COMMAND LITERAL1
185+
SFE_XM125_PRESENCE_VERSION LITERAL1
186+
SFE_XM125_PRESENCE_PROTOCOL_STATUS LITERAL1
187+
SFE_XM125_PRESENCE_MEASURE_COUNTER LITERAL1
188+
SFE_XM125_PRESENCE_DETECTOR_STATUS LITERAL1
189+
SFE_XM125_PRESENCE_RESULT LITERAL1
190+
SFE_XM125_PRESENCE_DISTANCE LITERAL1
191+
SFE_XM125_INTRA_PRESENCE_SCORE LITERAL1
192+
SFE_XM125_INTER_PRESENCE LITERAL1
193+
SFE_XM125_PRESENCE_SWEEPS_PER_FRAME LITERAL1
194+
sfe_xm125_presence_sweeps_per_frame_default LITERAL1
195+
SFE_XM125_PRESENCE_INTER_FRAME_TIMEOUT LITERAL1
196+
sfe_xm125_presence_inter_frame_timeout_default LITERAL1
197+
SFE_XM125_PRESENCE_INTER_PHASE_BOOST_ENABLED LITERAL1
198+
sfe_xm125_presence_inter_phase_boost_enabled_default LITERAL1
199+
SFE_XM125_PRESENCE_INTRA_DETECTION_ENABLED LITERAL1
200+
sfe_xm125_presence_intra_detection_enabled_default LITERAL1
201+
SFE_XM125_PRESENCE_INTER_DETECTION_ENABLED LITERAL1
202+
sfe_xm125_presence_inter_detection_enabled_default LITERAL1
203+
SFE_XM125_PRESENCE_FRAME_RATE LITERAL1
204+
sfe_xm125_presence_frame_rate_default LITERAL1
205+
SFE_XM125_PRESENCE_INTRA_DETECTION_THRESHOLD LITERAL1
206+
sfe_xm125_presence_intra_detection_threshold_default LITERAL1
207+
SFE_XM125_PRESENCE_INTER_DETECTION_THRESHOLD LITERAL1
208+
sfe_xm125_presence_inter_detection_threshold_default LITERAL1
209+
SFE_XM125_PRESENCE_INTER_FRAME_DEVIATION LITERAL1
210+
sfe_xm125_presence_inter_frame_deviation_default LITERAL1
211+
SFE_XM125_PRESENCE_INTER_FRAME_FAST_CUTOFF LITERAL1
212+
sfe_xm125_presence_inter_frame_fast_cutoff_default LITERAL1
213+
SFE_XM125_PRESENCE_INTER_FRAME_SLOW_CUTOFF LITERAL1
214+
sfe_xm125_presence_inter_frame_slow_cutoff_default LITERAL1
215+
SFE_XM125_PRESENCE_INTRA_FRAME_TIME_CONST LITERAL1
216+
sfe_xm125_presence_intra_frame_time_const_default LITERAL1
217+
SFE_XM125_PRESENCE_INTRA_OUTPUT_TIME_CONST LITERAL1
218+
sfe_xm125_presence_intra_output_time_const_default LITERAL1
219+
SFE_XM125_PRESENCE_INTER_OUTPUT_TIME_CONST LITERAL1
220+
sfe_xm125_presence_inter_output_time_const_default LITERAL1
221+
SFE_XM125_PRESENCE_AUTO_PROFILE_ENABLED LITERAL1
222+
sfe_xm125_presence_auto_profile_enabled_default LITERAL1
223+
SFE_XM125_PRESENCE_AUTO_STEP_LENGTH_ENABLED LITERAL1
224+
sfe_xm125_presence_auto_step_length_enabled_default LITERAL1
225+
SFE_XM125_PRESENCE_MANUAL_PROFILE LITERAL1
226+
SFE_XM125_PRESENCE_MANUAL_STEP_LENGTH LITERAL1
227+
sfe_xm125_presence_manual_step_length_default LITERAL1
228+
SFE_XM125_PRESENCE_START LITERAL1
229+
sfe_xm125_presence_start_default LITERAL1
230+
SFE_XM125_PRESENCE_END LITERAL1
231+
sfe_xm125_presence_end_default LITERAL1
232+
SFE_XM125_PRESENCE_RESET_FILTERS_ON_PREPARE LITERAL1
233+
sfe_xm125_presence_reset_filters_on_prepare_default LITERAL1
234+
SFE_XM125_PRESENCE_HWAAS LITERAL1
235+
sfe_xm125_presence_hwaas_default LITERAL1
236+
SFE_XM125_PRESENCE_DETECTION_ON_GPIO LITERAL1
237+
sfe_xm125_presence_detection_on_gpio_default LITERAL1
238+
SFE_XM125_PRESENCE_COMMAND LITERAL1

‎library.properties‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
name=SparkFun Template Arduino Library
1+
name=SparkFun XM125 Arduino Library
22
version=1.0.0
33
author=SparkFun Electronics <techsupport@sparkfun.com>
44
maintainer=SparkFun Electronics <sparkfun.com>
5-
sentence=TODO: Add short description
6-
paragraph=TODO: Add long description
7-
category=TODO: Add category (Sensors, Display, Communication, etc.)
8-
url=TODO: Add URL
9-
architectures=TODO: Add architectures (*, esp32, teensy, stm32, megaavr, etc.)
5+
sentence=An Arduino library to make use of the Qwiic XM125 A121 Pulsed Radar Module from Acconeer.
6+
paragraph=This is the SparkFun library for the Acconeer Entry+ Module XM125 with the A121 60GHz Pulsed Coherent Radar sensor and I2C interface.
7+
category=Sensors
8+
url=https://github.com/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library
9+
architectures=*
10+
depends=SparkFun Toolkit
11+
includes=SparkFun_Qwiic_XM125_Arduino_Library.h, sfeQwiicXM125.h, sfeXM125Regs.h

‎src/sfeQwiicXM125.cpp‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ bool QwDevXM125::begin(sfeTkII2C *theBus)
2828
// TODO: Initialize hardware
2929

3030

31-
// Replicate what is in the main() funciton (without print)
32-
3331
// Turn the sensor on
3432
//acc_hal_integration_sensor_supply_on(SENSOR_ID);
33+
3534

3635
// Create the sensor
3736
//create_sensor(&detector_resources);
@@ -399,7 +398,7 @@ int32_t QwDevXM125::setDistanceMeasureOneWakeup(bool measure)
399398
return _theBus->write16BitRegisterRegion(SFE_XM125_DISTANCE_MEASURE_ON_WAKEUP, (uint8_t*)measure, 4);
400399
}
401400

402-
int32_t QwDevXM125::setCommand(sfe_xm125_distance_command_t *command)
401+
int32_t QwDevXM125::setDistanceCommand(sfe_xm125_distance_command_t *command)
403402
{
404403
return _theBus->read16BitRegisterRegion(SFE_XM125_DISTANCE_COMMAND, (uint8_t*)command, 4);
405404
}

‎src/sfeQwiicXM125.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ class QwDevXM125
348348
/// datasheet on Page 25, Section 6.2.40 Command.
349349
/// @param apply Enable configuration and calibrate
350350
/// @return Error code (0 no error)
351-
int32_t setCommand(sfe_xm125_distance_command_t *command);
351+
int32_t setDistanceCommand(sfe_xm125_distance_command_t *command);
352352

353353
// --------------------- I2C Presence Detector Functions ---------------------
354354

‎src/sfeXM125Regs.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ typedef enum
168168
XM125_DISTANCE_RECORDED = 2,
169169
XM125_DISTANCE_CFAR = 3,
170170
XM125_DISTANCE_FIXED_STRENGTH = 4,
171-
} sfe_xm125_threshold_method_t;
171+
} sfe_xm125_distance_threshold_method_t;
172172

173173
// Default Value: STRONGEST (enum)
174174
const uint16_t SFE_XM125_DISTANCE_PEAK_SORTING = 0x47;
@@ -291,7 +291,7 @@ const uint16_t SFE_XM125_PRESENCE_INTER_FRAME_TIMEOUT = 0x41;
291291
const uint16_t sfe_xm125_presence_inter_frame_timeout_default = 3;
292292

293293
const uint16_t SFE_XM125_PRESENCE_INTER_PHASE_BOOST_ENABLED = 0x42;
294-
const bool sfe_xm125_presence_inter_phase_boost_enabled_defaultS = false;
294+
const bool sfe_xm125_presence_inter_phase_boost_enabled_default = false;
295295

296296
const uint16_t SFE_XM125_PRESENCE_INTRA_DETECTION_ENABLED = 0x43;
297297
const bool sfe_xm125_presence_intra_detection_enabled_default = true;

0 commit comments

Comments
 (0)