-
Notifications
You must be signed in to change notification settings - Fork 25
/
driver_adxl345.h
1779 lines (1625 loc) · 58.6 KB
/
driver_adxl345.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright (c) 2015 - present LibDriver All rights reserved
*
* The MIT License (MIT)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @file driver_adxl345.h
* @brief driver adxl345 header file
* @version 2.0.0
* @author Shifeng Li
* @date 2021-04-20
*
* <h3>history</h3>
* <table>
* <tr><th>Date <th>Version <th>Author <th>Description
* <tr><td>2021/04/20 <td>2.0 <td>Shifeng Li <td>format the code
* <tr><td>2020/12/23 <td>1.0 <td>Shifeng Li <td>first upload
* </table>
*/
#ifndef DRIVER_ADXL345_H
#define DRIVER_ADXL345_H
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#ifdef __cplusplus
extern "C"{
#endif
/**
* @defgroup adxl345_driver adxl345 driver function
* @brief adxl345 driver modules
* @{
*/
/**
* @addtogroup adxl345_basic_driver
* @{
*/
/**
* @brief adxl345 interface enumeration definition
*/
typedef enum
{
ADXL345_INTERFACE_IIC = 0x00, /**< iic interface function */
ADXL345_INTERFACE_SPI = 0x01, /**< spi interface function */
} adxl345_interface_t;
/**
* @brief adxl345 address enumeration definition
*/
typedef enum
{
ADXL345_ADDRESS_ALT_0 = 0xA6, /**< addr pin connected to the GND */
ADXL345_ADDRESS_ALT_1 = 0x3A, /**< addr pin connected to the VCC */
} adxl345_address_t;
/**
* @brief adxl345 bool enumeration definition
*/
typedef enum
{
ADXL345_BOOL_FALSE = 0x00, /**< false */
ADXL345_BOOL_TRUE = 0x01, /**< true */
} adxl345_bool_t;
/**
* @brief adxl345 coupled enumeration definition
*/
typedef enum
{
ADXL345_COUPLED_DC = 0x00, /**< DC coupled */
ADXL345_COUPLED_AC = 0x01, /**< AC coupled */
} adxl345_coupled_t;
/**
* @brief adxl345 action inaction enumeration definition
*/
typedef enum
{
ADXL345_ACTION_X = 0x06, /**< x axis action */
ADXL345_ACTION_Y = 0x05, /**< y axis action */
ADXL345_ACTION_Z = 0x04, /**< z axis action */
ADXL345_INACTION_X = 0x02, /**< x axis inaction */
ADXL345_INACTION_Y = 0x01, /**< y axis inaction */
ADXL345_INACTION_Z = 0x00, /**< z axis inaction */
} adxl345_action_inaction_t;
/**
* @brief adxl345 tap axis enumeration definition
*/
typedef enum
{
ADXL345_TAP_AXIS_X = 0x02, /**< x axis tap */
ADXL345_TAP_AXIS_Y = 0x01, /**< y axis tap */
ADXL345_TAP_AXIS_Z = 0x00, /**< z axis tap */
} adxl345_tap_axis_t;
/**
* @brief adxl345 action tap status enumeration definition
*/
typedef enum
{
ADXL345_ACTION_TAP_STATUS_ACT_X = (1 << 6), /**< x axis action status */
ADXL345_ACTION_TAP_STATUS_ACT_Y = (1 << 5), /**< y axis action status */
ADXL345_ACTION_TAP_STATUS_ACT_Z = (1 << 4), /**< z axis action status */
ADXL345_ACTION_TAP_STATUS_ASLEEP = (1 << 3), /**< asleep status */
ADXL345_ACTION_TAP_STATUS_TAP_X = (1 << 2), /**< x axis tap status */
ADXL345_ACTION_TAP_STATUS_TAP_Y = (1 << 1), /**< y axis tap status */
ADXL345_ACTION_TAP_STATUS_TAP_Z = (1 << 0), /**< z axis tap status */
} adxl345_action_tap_status_t;
/**
* @brief adxl345 rate enumeration definition
*/
typedef enum
{
ADXL345_RATE_0P1 = 0x00, /**< 0.1Hz */
ADXL345_RATE_0P2 = 0x01, /**< 0.2Hz */
ADXL345_RATE_0P39 = 0x02, /**< 0.39Hz */
ADXL345_RATE_0P78 = 0x03, /**< 0.78Hz */
ADXL345_RATE_1P56 = 0x04, /**< 1.56Hz */
ADXL345_RATE_3P13 = 0x05, /**< 3.13Hz */
ADXL345_RATE_6P25 = 0x06, /**< 6.25Hz */
ADXL345_RATE_12P5 = 0x07, /**< 12.5Hz */
ADXL345_RATE_25 = 0x08, /**< 25Hz */
ADXL345_RATE_50 = 0x09, /**< 50Hz */
ADXL345_RATE_100 = 0x0A, /**< 100Hz */
ADXL345_RATE_200 = 0x0B, /**< 200Hz */
ADXL345_RATE_400 = 0x0C, /**< 400Hz */
ADXL345_RATE_800 = 0x0D, /**< 800Hz */
ADXL345_RATE_1600 = 0x0E, /**< 1600Hz */
ADXL345_RATE_3200 = 0x0F, /**< 3200Hz */
ADXL345_LOW_POWER_RATE_12P5 = 0x17, /**< low power 12.5Hz */
ADXL345_LOW_POWER_RATE_25 = 0x18, /**< low power 25Hz */
ADXL345_LOW_POWER_RATE_50 = 0x19, /**< low power 50Hz */
ADXL345_LOW_POWER_RATE_100 = 0x1A, /**< low power 100Hz */
ADXL345_LOW_POWER_RATE_200 = 0x1B, /**< low power 200Hz */
ADXL345_LOW_POWER_RATE_400 = 0x1C, /**< low power 400Hz */
} adxl345_rate_t;
/**
* @brief adxl345 spi wire enumeration definition
*/
typedef enum
{
ADXL345_SPI_WIRE_4 = 0x00, /**< wire 4 */
ADXL345_SPI_WIRE_3 = 0x01, /**< wire 3 */
} adxl345_spi_wire_t;
/**
* @brief adxl345 justify enumeration definition
*/
typedef enum
{
ADXL345_JUSTIFY_RIGHT = 0x00, /**< right justify */
ADXL345_JUSTIFY_LEFT = 0x01, /**< left justify */
} adxl345_justify_t;
/**
* @brief adxl345 range enumeration definition
*/
typedef enum
{
ADXL345_RANGE_2G = 0x00, /**< ±2G */
ADXL345_RANGE_4G = 0x01, /**< ±4G */
ADXL345_RANGE_8G = 0x02, /**< ±8G */
ADXL345_RANGE_16G = 0x03, /**< ±16G */
} adxl345_range_t;
/**
* @brief adxl345 sleep frequency enumeration definition
*/
typedef enum
{
ADXL345_SLEEP_FREQUENCY_8HZ = 0x00, /**< sleep 8Hz */
ADXL345_SLEEP_FREQUENCY_4HZ = 0x01, /**< sleep 4Hz */
ADXL345_SLEEP_FREQUENCY_2HZ = 0x02, /**< sleep 2Hz */
ADXL345_SLEEP_FREQUENCY_1HZ = 0x03, /**< sleep 1Hz*/
} adxl345_sleep_frequency_t;
/**
* @brief adxl345 mode enumeration definition
*/
typedef enum
{
ADXL345_MODE_BYPASS = 0x00, /**< bypass mode */
ADXL345_MODE_FIFO = 0x01, /**< fifo mode */
ADXL345_MODE_STREAM = 0x02, /**< stream mode */
ADXL345_MODE_TRIGGER = 0x03, /**< trigger mode */
} adxl345_mode_t;
/**
* @brief adxl345 trigger status enumeration definition
*/
typedef enum
{
ADXL345_TRIGGER_NOT_OCCURRED = 0x00, /**< not occurred */
ADXL345_TRIGGER_OCCURRED = 0x01, /**< occurred */
} adxl345_trigger_status_t;
/**
* @}
*/
/**
* @addtogroup adxl345_interrupt_driver
* @{
*/
/**
* @brief adxl345 interrupt enumeration definition
*/
typedef enum
{
ADXL345_INTERRUPT_DATA_READY = 0x07, /**< data ready */
ADXL345_INTERRUPT_SINGLE_TAP = 0x06, /**< single tap */
ADXL345_INTERRUPT_DOUBLE_TAP = 0x05, /**< double tap */
ADXL345_INTERRUPT_ACTIVITY = 0x04, /**< activity */
ADXL345_INTERRUPT_INACTIVITY = 0x03, /**< inactivity */
ADXL345_INTERRUPT_FREE_FALL = 0x02, /**< free fall */
ADXL345_INTERRUPT_WATERMARK = 0x01, /**< watermark */
ADXL345_INTERRUPT_OVERRUN = 0x00, /**< overrun */
} adxl345_interrupt_t;
/**
* @brief adxl345 interrupt pin enumeration definition
*/
typedef enum
{
ADXL345_INTERRUPT_PIN1 = 0x00, /**< interrupt pin 1 */
ADXL345_INTERRUPT_PIN2 = 0x01, /**< interrupt pin 2 */
} adxl345_interrupt_pin_t;
/**
* @brief adxl345 interrupt active_level enumeration definition
*/
typedef enum
{
ADXL345_INTERRUPT_ACTIVE_LEVEL_HIGH = 0x00, /**< interrupt active level high */
ADXL345_INTERRUPT_ACTIVE_LEVEL_LOW = 0x01, /**< interrupt active level low */
} adxl345_interrupt_active_level_t;
/**
* @}
*/
/**
* @addtogroup adxl345_basic_driver
* @{
*/
/**
* @brief adxl345 handle structure definition
*/
typedef struct adxl345_handle_s
{
uint8_t iic_addr; /**< iic address */
uint8_t (*iic_init)(void); /**< point to an iic_init function address */
uint8_t (*iic_deinit)(void); /**< point to an iic_deinit function address */
uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len); /**< point to an iic_read function address */
uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len); /**< point to an iic_write function address */
uint8_t (*spi_init)(void); /**< point to a spi_init function address */
uint8_t (*spi_deinit)(void); /**< point to a spi_deinit function address */
uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len); /**< point to a spi_read function address */
uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len); /**< point to a spi_write function address */
void (*receive_callback)(uint8_t type); /**< point to a receive_callback function address */
void (*delay_ms)(uint32_t ms); /**< point to a delay_ms function address */
void (*debug_print)(const char *const fmt, ...); /**< point to a debug_print function address */
uint8_t inited; /**< inited flag */
uint8_t iic_spi; /**< iic spi interface type */
} adxl345_handle_t;
/**
* @brief adxl345 information structure definition
*/
typedef struct adxl345_info_s
{
char chip_name[32]; /**< chip name */
char manufacturer_name[32]; /**< manufacturer name */
char interface[8]; /**< chip interface name */
float supply_voltage_min_v; /**< chip min supply voltage */
float supply_voltage_max_v; /**< chip max supply voltage */
float max_current_ma; /**< chip max current */
float temperature_min; /**< chip min operating temperature */
float temperature_max; /**< chip max operating temperature */
uint32_t driver_version; /**< driver version */
} adxl345_info_t;
/**
* @}
*/
/**
* @defgroup adxl345_link_driver adxl345 link driver function
* @brief adxl345 link driver modules
* @ingroup adxl345_driver
* @{
*/
/**
* @brief initialize adxl345_handle_t structure
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] STRUCTURE is adxl345_handle_t
* @note none
*/
#define DRIVER_ADXL345_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE))
/**
* @brief link iic_init function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to an iic_init function address
* @note none
*/
#define DRIVER_ADXL345_LINK_IIC_INIT(HANDLE, FUC) (HANDLE)->iic_init = FUC
/**
* @brief link iic_deinit function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to an iic_deinit function address
* @note none
*/
#define DRIVER_ADXL345_LINK_IIC_DEINIT(HANDLE, FUC) (HANDLE)->iic_deinit = FUC
/**
* @brief link iic_read function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to an iic_read function address
* @note none
*/
#define DRIVER_ADXL345_LINK_IIC_READ(HANDLE, FUC) (HANDLE)->iic_read = FUC
/**
* @brief link iic_write function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to an iic_write function address
* @note none
*/
#define DRIVER_ADXL345_LINK_IIC_WRITE(HANDLE, FUC) (HANDLE)->iic_write = FUC
/**
* @brief link spi_init function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a spi_init function address
* @note none
*/
#define DRIVER_ADXL345_LINK_SPI_INIT(HANDLE, FUC) (HANDLE)->spi_init = FUC
/**
* @brief link spi_deinit function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a spi_deinit function address
* @note none
*/
#define DRIVER_ADXL345_LINK_SPI_DEINIT(HANDLE, FUC) (HANDLE)->spi_deinit = FUC
/**
* @brief link spi_read function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a spi_read function address
* @note none
*/
#define DRIVER_ADXL345_LINK_SPI_READ(HANDLE, FUC) (HANDLE)->spi_read = FUC
/**
* @brief link spi_write function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a spi_write function address
* @note none
*/
#define DRIVER_ADXL345_LINK_SPI_WRITE(HANDLE, FUC) (HANDLE)->spi_write = FUC
/**
* @brief link delay_ms function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a delay_ms function address
* @note none
*/
#define DRIVER_ADXL345_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC
/**
* @brief link debug_print function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a debug_print function address
* @note none
*/
#define DRIVER_ADXL345_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC
/**
* @brief link receive_callback function
* @param[in] HANDLE points to an adxl345 handle structure
* @param[in] FUC points to a receive_callback function address
* @note none
*/
#define DRIVER_ADXL345_LINK_RECEIVE_CALLBACK(HANDLE, FUC) (HANDLE)->receive_callback = FUC
/**
* @}
*/
/**
* @defgroup adxl345_basic_driver adxl345 basic driver function
* @brief adxl345 basic driver modules
* @ingroup adxl345_driver
* @{
*/
/**
* @brief get chip's information
* @param[out] *info points to an adxl345 info structure
* @return status code
* - 0 success
* - 2 handle is NULL
* @note none
*/
uint8_t adxl345_info(adxl345_info_t *info);
/**
* @brief initialize the chip
* @param[in] *handle points to an adxl345 handle structure
* @return status code
* - 0 success
* - 1 spi or iic initialization failed
* - 2 handle is NULL
* - 3 linked functions is NULL
* - 4 id is invalid
* @note none
*/
uint8_t adxl345_init(adxl345_handle_t *handle);
/**
* @brief close the chip
* @param[in] *handle points to an adxl345 handle structure
* @return status code
* - 0 success
* - 1 iic or spi deinit failed
* - 2 handle is NULL
* - 3 handle is not initialized
* - 4 power down failed
* @note none
*/
uint8_t adxl345_deinit(adxl345_handle_t *handle);
/**
* @brief set the chip interface
* @param[in] *handle points to an adxl345 handle structure
* @param[in] interface is the chip interface
* @return status code
* - 0 success
* - 2 handle is NULL
* @note none
*/
uint8_t adxl345_set_interface(adxl345_handle_t *handle, adxl345_interface_t interface);
/**
* @brief get the chip interface
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *interface points to a chip interface buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* @note none
*/
uint8_t adxl345_get_interface(adxl345_handle_t *handle, adxl345_interface_t *interface);
/**
* @brief set the iic address pin
* @param[in] *handle points to an adxl345 handle structure
* @param[in] addr_pin is the address pin
* @return status code
* - 0 success
* - 2 handle is NULL
* @note none
*/
uint8_t adxl345_set_addr_pin(adxl345_handle_t *handle, adxl345_address_t addr_pin);
/**
* @brief get the iic address pin
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *addr_pin points to an address pin buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* @note none
*/
uint8_t adxl345_get_addr_pin(adxl345_handle_t *handle, adxl345_address_t *addr_pin);
/**
* @brief read the data
* @param[in] *handle points to an adxl345 handle structure
* @param[out] **raw points to a raw data buffer
* @param[out] **g points to a converted data buffer
* @param[in,out] *len points to a length buffer
* @return status code
* - 0 success
* - 1 read failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_read(adxl345_handle_t *handle, int16_t (*raw)[3], float (*g)[3], uint16_t *len);
/**
* @brief irq handler
* @param[in] *handle points to an adxl345 handle structure
* @return status code
* - 0 success
* - 1 run failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_irq_handler(adxl345_handle_t *handle);
/**
* @brief set the tap threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[in] threshold is the tap threshold
* @return status code
* - 0 success
* - 1 set tap threshold failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_tap_threshold(adxl345_handle_t *handle, uint8_t threshold);
/**
* @brief get the tap threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *threshold points to a tap threshold buffer
* @return status code
* - 0 success
* - 1 get tap threshold failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_tap_threshold(adxl345_handle_t *handle, uint8_t *threshold);
/**
* @brief convert the tap threshold to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] g is the tap threshold
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_tap_threshold_convert_to_register(adxl345_handle_t *handle, float g, uint8_t *reg);
/**
* @brief convert the register raw data to the tap threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *g points to a tap threshold buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_tap_threshold_convert_to_data(adxl345_handle_t *handle, uint8_t reg, float *g);
/**
* @brief set the axis offset
* @param[in] *handle points to an adxl345 handle structure
* @param[in] x is the x axis offset
* @param[in] y is the y axis offset
* @param[in] z is the z axis offset
* @return status code
* - 0 success
* - 1 set offset failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_offset(adxl345_handle_t *handle, int8_t x, int8_t y, int8_t z);
/**
* @brief get the axis offset
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *x points to an x axis offset
* @param[out] *y points to a y axis offset
* @param[out] *z points to a z axis offset
* @return status code
* - 0 success
* - 1 get offset failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_offset(adxl345_handle_t *handle, int8_t *x, int8_t *y, int8_t *z);
/**
* @brief convert the offset to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] g is the offset
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_offset_convert_to_register(adxl345_handle_t *handle, float g, int8_t *reg);
/**
* @brief convert the register raw data to the offset
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *g points to an offset buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_offset_convert_to_data(adxl345_handle_t *handle, int8_t reg, float *g);
/**
* @brief set the duration
* @param[in] *handle points to an adxl345 handle structure
* @param[in] t is the duration
* @return status code
* - 0 success
* - 1 set duration failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_duration(adxl345_handle_t *handle, uint8_t t);
/**
* @brief get the duration
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *t points to a duration buffer
* @return status code
* - 0 success
* - 1 get duration failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_duration(adxl345_handle_t *handle, uint8_t *t);
/**
* @brief convert the duration to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] us is the duration
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_duration_convert_to_register(adxl345_handle_t *handle, uint32_t us, uint8_t *reg);
/**
* @brief convert the register raw data to the duration
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *us points to a duration buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_duration_convert_to_data(adxl345_handle_t *handle, uint8_t reg, uint32_t *us);
/**
* @brief set the latent
* @param[in] *handle points to an adxl345 handle structure
* @param[in] t is the latent time
* @return status code
* - 0 success
* - 1 set latent failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_latent(adxl345_handle_t *handle, uint8_t t);
/**
* @brief get the latent
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *t points to a latent time buffer
* @return status code
* - 0 success
* - 1 get latent failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_latent(adxl345_handle_t *handle, uint8_t *t);
/**
* @brief convert the latent to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] ms is the time
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_latent_convert_to_register(adxl345_handle_t *handle, float ms, uint8_t *reg);
/**
* @brief convert the register raw data to the latent
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *ms points to a latent buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_latent_convert_to_data(adxl345_handle_t *handle, uint8_t reg, float *ms);
/**
* @brief set the window
* @param[in] *handle points to an adxl345 handle structure
* @param[in] t is the window time
* @return status code
* - 0 success
* - 1 set window failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_window(adxl345_handle_t *handle, uint8_t t);
/**
* @brief get the window
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *t points to a window time buffer
* @return status code
* - 0 success
* - 1 get window failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_window(adxl345_handle_t *handle, uint8_t *t);
/**
* @brief convert the window time to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] ms is the window time
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_window_convert_to_register(adxl345_handle_t *handle, float ms, uint8_t *reg);
/**
* @brief convert the register raw data to the window time
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *ms points to a window time buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_window_convert_to_data(adxl345_handle_t *handle, uint8_t reg, float *ms);
/**
* @brief set the action threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[in] threshold is the action threshold
* @return status code
* - 0 success
* - 1 set action threshold failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_action_threshold(adxl345_handle_t *handle, uint8_t threshold);
/**
* @brief get the action threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *threshold points to an action threshold buffer
* @return status code
* - 0 success
* - 1 get action threshold failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_action_threshold(adxl345_handle_t *handle, uint8_t *threshold);
/**
* @brief convert the action threshold to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] g is the action threshold
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_action_threshold_convert_to_register(adxl345_handle_t *handle, float g, uint8_t *reg);
/**
* @brief convert the register raw data to the action threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *g points to an action threshold buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_action_threshold_convert_to_data(adxl345_handle_t *handle, uint8_t reg, float *g);
/**
* @brief set the inaction threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[in] threshold is the inaction threshold
* @return status code
* - 0 success
* - 1 set inaction threshold failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_inaction_threshold(adxl345_handle_t *handle, uint8_t threshold);
/**
* @brief get the inaction threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *threshold points to an inaction threshold buffer
* @return status code
* - 0 success
* - 1 get inaction threshold failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_inaction_threshold(adxl345_handle_t *handle, uint8_t *threshold);
/**
* @brief convert the inaction threshold to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] g is the inaction threshold
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_inaction_threshold_convert_to_register(adxl345_handle_t *handle, float g, uint8_t *reg);
/**
* @brief convert the register raw data to the inaction threshold
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *g points to an inaction threshold buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_inaction_threshold_convert_to_data(adxl345_handle_t *handle, uint8_t reg, float *g);
/**
* @brief set the inaction time
* @param[in] *handle points to an adxl345 handle structure
* @param[in] t is the inaction time
* @return status code
* - 0 success
* - 1 set inaction time failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_inaction_time(adxl345_handle_t *handle, uint8_t t);
/**
* @brief get the inaction time
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *t points to an inaction time buffer
* @return status code
* - 0 success
* - 1 get inaction time failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_inaction_time(adxl345_handle_t *handle, uint8_t *t);
/**
* @brief convert the inaction time to the register raw data
* @param[in] *handle points to an adxl345 handle structure
* @param[in] s is the inaction time
* @param[out] *reg points to a register raw buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_inaction_time_convert_to_register(adxl345_handle_t *handle, uint8_t s, uint8_t *reg);
/**
* @brief convert the register raw data to the inaction time
* @param[in] *handle points to an adxl345 handle structure
* @param[in] reg is the register raw data
* @param[out] *s points to an inaction time buffer
* @return status code
* - 0 success
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_inaction_time_convert_to_data(adxl345_handle_t *handle, uint8_t reg, uint8_t *s);
/**
* @brief enable or disable the action or inaction
* @param[in] *handle points to an adxl345 handle structure
* @param[in] type is the action or inaction type
* @param[in] enable is a bool value
* @return status code
* - 0 success
* - 1 set action inaction failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_action_inaction(adxl345_handle_t *handle, adxl345_action_inaction_t type, adxl345_bool_t enable);
/**
* @brief get the action or inaction status
* @param[in] *handle points to an adxl345 handle structure
* @param[in] type is the action or inaction type
* @param[out] *enable points to a bool value buffer
* @return status code
* - 0 success
* - 1 get action inaction failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_get_action_inaction(adxl345_handle_t *handle, adxl345_action_inaction_t type, adxl345_bool_t *enable);
/**
* @brief set the action coupled
* @param[in] *handle points to an adxl345 handle structure
* @param[in] coupled is the action coupled
* @return status code
* - 0 success
* - 1 set action coupled failed
* - 2 handle is NULL
* - 3 handle is not initialized
* @note none
*/
uint8_t adxl345_set_action_coupled(adxl345_handle_t *handle, adxl345_coupled_t coupled);
/**
* @brief get the action coupled
* @param[in] *handle points to an adxl345 handle structure
* @param[out] *coupled points to an action coupled buffer
* @return status code