forked from boschsensortec/BMA456_SensorAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bma456w.h
1205 lines (1094 loc) · 47.2 KB
/
bma456w.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) 2022 Bosch Sensortec GmbH. All rights reserved.
*
* BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @file bma456w.h
* @date 2022-07-01
* @version V2.24.1
*
*/
/**
* \ingroup bma4xy
* \defgroup bma456w BMA456W
* @brief Sensor driver for BMA456W sensor
*/
#ifndef BMA456W_H
#define BMA456W_H
#ifdef __cplusplus
extern "C" {
#endif
#include "bma4.h"
/**\name Chip ID of BMA456W sensor */
#define BMA456W_CHIP_ID UINT8_C(0x16)
/**\ Configuration ID start position of BMA456W sensor */
#define BMA456W_CONFIG_ID_START_ADDR UINT8_C(72)
/**\name Sensor feature size */
#define BMA456W_FEATURE_SIZE UINT8_C(76)
#define BMA456W_ANY_MOT_LEN UINT8_C(4)
/**\name Feature offset address */
#define BMA456W_ANY_MOT_OFFSET UINT8_C(0x00)
#define BMA456W_NO_MOT_OFFSET UINT8_C(0x04)
#define BMA456W_STEP_CNTR_PARAM_OFFSET UINT8_C(0x08)
#define BMA456W_STEP_CNTR_OFFSET UINT8_C(0x3A)
#define BMA456W_WRIST_WEAR_WAKEUP_OFFSET UINT8_C(0x3C)
#define BMA456W_WRIST_WEAR_WAKEUP_PARAM_OFFSET UINT8_C(0x3E)
#define BMA456W_CONFIG_ID_OFFSET UINT8_C(0x48)
#define BMA456W_AXES_REMAP_OFFSET UINT8_C(0x4A)
/**\name Read/Write Lengths */
#define BMA456W_RD_WR_MIN_LEN UINT8_C(2)
#define BMA456W_NO_MOT_RD_WR_LEN (BMA456W_ANY_MOT_LEN + BMA456W_NO_MOT_OFFSET)
/*! @name Maximum valid read write length is size of config file array */
#define BMA456W_RD_WR_MAX_LEN ((uint16_t)sizeof(bma456w_config_file))
/**************************************************************/
/**\name Step Counter/Detector/Activity */
/**************************************************************/
/**\name Step counter/activity enable macros */
#define BMA456W_STEP_CNTR_EN_MSK UINT8_C(0x10)
#define BMA456W_STEP_ACT_EN_MSK UINT8_C(0x20)
/**\name Step counter water-mark macros */
#define BMA456W_STEP_CNTR_WM_MSK UINT16_C(0x03FF)
/**\name Step counter reset macros */
#define BMA456W_STEP_CNTR_RST_POS UINT8_C(2)
#define BMA456W_STEP_CNTR_RST_MSK UINT8_C(0x04)
/**\name Step detector enable macros */
#define BMA456W_STEP_DETECTOR_EN_POS UINT8_C(3)
#define BMA456W_STEP_DETECTOR_EN_MSK UINT8_C(0x08)
/**\name Wrist-wear enable macros */
#define BMA456W_WRIST_WEAR_WAKEUP_EN_MSK UINT8_C(0x10)
#define BMA456W_WRIST_WEAR_WAKEUP_EN_POS UINT8_C(4)
/**\name Step count output length */
#define BMA456W_STEP_CNTR_DATA_SIZE UINT8_C(4)
/**************************************************************/
/**\name Any/No-Motion */
/**************************************************************/
/**\name Any/No-motion threshold macros */
#define BMA456W_ANY_NO_MOT_THRES_MSK UINT16_C(0x07FF)
/**\name Any/No-motion duration macros */
#define BMA456W_ANY_NO_MOT_DUR_MSK UINT16_C(0x1FFF)
/**\name Any/No-motion enable macros */
#define BMA456W_ANY_NO_MOT_AXIS_EN_POS UINT8_C(0x0D)
#define BMA456W_ANY_NO_MOT_AXIS_EN_MSK UINT16_C(0xE000)
/**************************************************************/
/**\name Wrist wear wakeup */
/**************************************************************/
/**\name Mask definition for minimum angle focus */
#define BMA456W_WRIST_WEAR_WAKEUP_MIN_ANG_FOCUS_MSK UINT16_C(0xFFFF)
/**\name Mask definition for minimum angle non focus */
#define BMA456W_WRIST_WEAR_WAKEUP_MIN_ANG_NON_FOCUS_MSK UINT16_C(0xFFFF)
/**\name Mask definition for angle landscape right */
#define BMA456W_WRIST_WEAR_WAKEUP_ANG_LSCAPE_RHT_MSK UINT8_C(0xFF)
/**\name Mask definition for angle landscape left */
#define BMA456W_WRIST_WEAR_WAKEUP_ANG_LSCAPE_LEFT_MSK UINT16_C(0XFF00)
/**\name Position definition for angle landscape left */
#define BMA456W_WRIST_WEAR_WAKEUP_ANG_LSCAPE_LEFT_POS UINT8_C(8)
/**\name Mask definition for angle portrait down */
#define BMA456W_WRIST_WEAR_WAKEUP_ANG_PORTRAIT_DOWN_MSK UINT8_C(0xFF)
/**\name Mask definition for angle portrait up */
#define BMA456W_WRIST_WEAR_WAKEUP_ANG_PORTRAIT_UP_MSK UINT16_C(0xFF00)
/**\name Position definition for angle portrait up */
#define BMA456W_WRIST_WEAR_WAKEUP_ANG_PORTRAIT_UP_POS UINT8_C(8)
/**\name Mask definition for minimum duration moved */
#define BMA456W_WRIST_WEAR_WAKEUP_MIN_DUR_MOVED_MSK UINT8_C(0xFF)
/**\name Mask definition for minimum duration quite */
#define BMA456W_WRIST_WEAR_WAKEUP_MIN_DUR_QUITE_MSK UINT16_C(0xFF00)
/**\name Position definition for minimum duration quite */
#define BMA456W_WRIST_WEAR_WAKEUP_MIN_DUR_QUITE_POS UINT8_C(8)
/**************************************************************/
/**\name User macros */
/**************************************************************/
/**\name Any-motion/No-motion axis enable macros */
#define BMA456W_X_AXIS_EN UINT8_C(0x01)
#define BMA456W_Y_AXIS_EN UINT8_C(0x02)
#define BMA456W_Z_AXIS_EN UINT8_C(0x04)
#define BMA456W_EN_ALL_AXIS UINT8_C(0x07)
#define BMA456W_DIS_ALL_AXIS UINT8_C(0x00)
/**\name Feature enable macros for the sensor */
#define BMA456W_STEP_CNTR UINT8_C(0x01)
#define BMA456W_STEP_ACT UINT8_C(0x02)
#define BMA456W_WRIST_WEAR_WAKEUP UINT8_C(0x04)
/**\name Interrupt status macros */
#define BMA456W_STEP_CNTR_INT UINT8_C(0x02)
#define BMA456W_ACTIVITY_INT UINT8_C(0x04)
#define BMA456W_WRIST_WEAR_WAKEUP_INT UINT8_C(0x08)
#define BMA456W_ANY_MOT_INT UINT8_C(0x20)
#define BMA456W_NO_MOT_INT UINT8_C(0x40)
#define BMA456W_ERROR_INT UINT8_C(0x80)
/**\name Activity recognition macros */
#define BMA456W_USER_STATIONARY UINT8_C(0x00)
#define BMA456W_USER_WALKING UINT8_C(0x01)
#define BMA456W_USER_RUNNING UINT8_C(0x02)
#define BMA456W_STATE_INVALID UINT8_C(0x03)
/******************************************************************************/
/*! @name Structure Declarations */
/******************************************************************************/
/*!
* @brief Any/No-motion configuration
*/
struct bma456w_any_no_mot_config
{
/*! Expressed in 50 Hz samples (20 ms) */
uint16_t duration;
/*! Threshold value for Any-motion/No-motion detection in
* 5.11g format
*/
uint16_t threshold;
/*! To enable selected axes */
uint8_t axes_en;
};
/*!
* @brief Step counter param settings
*/
struct bma456w_stepcounter_settings
{
/*! Step Counter param 1 */
uint16_t param1;
/*! Step Counter param 2 */
uint16_t param2;
/*! Step Counter param 3 */
uint16_t param3;
/*! Step Counter param 4 */
uint16_t param4;
/*! Step Counter param 5 */
uint16_t param5;
/*! Step Counter param 6 */
uint16_t param6;
/*! Step Counter param 7 */
uint16_t param7;
/*! Step Counter param 8 */
uint16_t param8;
/*! Step Counter param 9 */
uint16_t param9;
/*! Step Counter param 10 */
uint16_t param10;
/*! Step Counter param 11 */
uint16_t param11;
/*! Step Counter param 12 */
uint16_t param12;
/*! Step Counter param 13 */
uint16_t param13;
/*! Step Counter param 14 */
uint16_t param14;
/*! Step Counter param 15 */
uint16_t param15;
/*! Step Counter param 16 */
uint16_t param16;
/*! Step Counter param 17 */
uint16_t param17;
/*! Step Counter param 18 */
uint16_t param18;
/*! Step Counter param 19 */
uint16_t param19;
/*! Step Counter param 20 */
uint16_t param20;
/*! Step Counter param 21 */
uint16_t param21;
/*! Step Counter param 22 */
uint16_t param22;
/*! Step Counter param 23 */
uint16_t param23;
/*! Step Counter param 24 */
uint16_t param24;
/*! Step Counter param 25 */
uint16_t param25;
};
/*!
* @brief Wrist wear wakeup param settings
*/
struct bma456w_wrist_wear_wakeup_params
{
/*! Cosine of minimum expected attitude change of the
* device within 1 second time window
* when moving within focus position. */
uint16_t min_angle_focus;
/*!Cosine of minimum expected attitude change of the
* device within 1 second time window
* when moving from non-focus to focus position.*/
uint16_t min_angle_non_focus;
/*! Sine of the maximum allowed tilt angle in
* landscape right direction of the device,
* when it is in focus position */
uint8_t angle_landscape_right;
/*! Sine of the maximum allowed tilt angle in
* landscape left direction of the device,
* when it is in focus position */
uint8_t angle_landscape_left;
/*! Sine of the maximum allowed forward
* tilt angle in portrait up direction
* of the device, when it is in focus position */
uint8_t angle_portrait_up;
/*! Sine of the maximum allowed backward tilt
* angle in portrait down direction of
* the device, when it is in focus position */
uint8_t angle_portrait_down;
/*! Minimum duration the arm should
* be moved while performing gesture.*/
uint8_t min_dur_moved;
/*! Minimum duration the arm should be
* static between two consecutive gestures */
uint8_t min_dur_quite;
};
/***************************************************************************/
/*! BMA456W User Interface function prototypes
****************************************************************************/
/**
* \ingroup bma456w
* \defgroup bma456wApiInit Initialization
* @brief Initialize the sensor and device structure
*/
/*!
* \ingroup bma456wApiInit
* \page bma456w_api_bma456w_init bma456w_init
* \code
* int8_t bma456w_init(struct bma4_dev *dev);
* \endcode
* @details This API is the entry point.
* Call this API before using all other APIs.
* This API reads the chip-id of the sensor and sets the resolution.
*
* @param[in,out] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_init(struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiConfig ConfigFile
* @brief Write binary configuration in the sensor
*/
/*!
* \ingroup bma456wApiConfig
* \page bma456w_api_bma456w_write_config_file bma456w_write_config_file
* \code
* int8_t bma456w_write_config_file(struct bma4_dev *dev);
* \endcode
* @details This API is used to upload the config file to enable the features of
* the sensor.
*
* @param[in] dev : Structure instance of bma4_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_write_config_file(struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiConfigId ConfigId
* @brief Get Configuration ID of the sensor
*/
/*!
* \ingroup bma456wApiConfig
* \page bma456w_api_bma456w_get_config_id bma456w_get_config_id
* \code
* int8_t bma456w_get_config_id(uint16_t *config_id, struct bma4_dev *dev);
* \endcode
* @details This API is used to get the configuration id of the sensor.
*
* @param[out] config_id : Pointer variable used to store the configuration id.
* @param[in] dev : Structure instance of bma4_dev.
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_get_config_id(uint16_t *config_id, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiMapInt Map / Unmap Interrupt
* @brief Map / Unmap user provided interrupt to interrupt pin1 or pin2 of the sensor
*/
/*!
* \ingroup bma456wApiMapInt
* \page bma456w_api_bma456w_map_interrupt bma456w_map_interrupt
* \code
* int8_t bma456w_map_interrupt(uint8_t int_line, uint16_t int_map, uint8_t enable, struct bma4_dev *dev);
* \endcode
* @details This API sets/unsets the user provided interrupt to either
* interrupt pin1 or pin2 in the sensor.
*
* @param[in] int_line: Variable to select either interrupt pin1 or pin2.
*
*@verbatim
* int_line | Macros
* ------------|-------------------
* 0x00 | BMA4_INTR1_MAP
* 0x01 | BMA4_INTR2_MAP
*@endverbatim
*
* @param[in] int_map : Variable to specify the interrupts.
* @param[in] enable : Variable to specify mapping or unmapping of interrupts.
*
*@verbatim
* enable | Macros
* --------|-------------------
* 0x00 | BMA4_DISABLE
* 0x01 | BMA4_ENABLE
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev.
*
* @note Below macros specify the interrupts.
*
* Feature Interrupts
* - BMA456W_STEP_CNTR_INT
* - BMA456W_ACTIVITY_INT
* - BMA456W_WRIST_WEAR_INT
* - BMA456W_ANY_MOT_INT
* - BMA456W_NO_MOT_INT
* - BMA456W_ERROR_INT
*
* Hardware Interrupts
* - BMA4_FIFO_FULL_INT
* - BMA4_FIFO_WM_INT
* - BMA4_DATA_RDY_INT
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_map_interrupt(uint8_t int_line, uint16_t int_map, uint8_t enable, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiIntS Interrupt Status
* @brief Read interrupt status of the sensor
*/
/*!
* \ingroup bma456wApiIntS
* \page bma456w_api_bma456w_read_int_status bma456w_read_int_status
* \code
* int8_t bma456w_read_int_status(uint16_t *int_status, struct bma4_dev *dev);
* \endcode
* @details This API reads the bma456w interrupt status from the sensor.
*
* @param[out] int_status : Variable to store the interrupt status read from
* the sensor.
* @param[in] dev : Structure instance of bma4_dev.
*
* @note Below macros are used to check the interrupt status.
*
* Feature Interrupts
* - BMA456W_STEP_CNTR_INT
* - BMA456W_ACTIVITY_INT
* - BMA456W_WRIST_WEAR_INT
* - BMA456W_ANY_MOT_INT
* - BMA456W_NO_MOT_INT
* - BMA456W_ERROR_INT
*
* Hardware Interrupts
* - BMA4_FIFO_FULL_INT
* - BMA4_FIFO_WM_INT
* - BMA4_DATA_RDY_INT
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_read_int_status(uint16_t *int_status, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiFeat Sensor Feature
* @brief Enables / Disables features of the sensor
*/
/*!
* \ingroup bma456wApiFeat
* \page bma456w_api_bma456w_feature_enable bma456w_feature_enable
* \code
* int8_t bma456w_feature_enable(uint8_t feature, uint8_t enable, struct bma4_dev *dev);
* \endcode
* @details This API enables/disables the features of the sensor.
*
* @param[in] feature : Variable to specify the features which are to be set in
* bma456w sensor.
* @param[in] enable : Variable which specifies whether to enable or disable the
* features in the bma456w sensor.
*
*@verbatim
* enable | Macros
* --------|-------------------
* 0x00 | BMA4_DISABLE
* 0x01 | BMA4_ENABLE
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev.
*
* @note User should use the below macros to enable or disable the
* features of bma456w sensor
*
* - BMA456W_STEP_CNTR
* - BMA456W_ACTIVITY
* - BMA456W_WAKEUP
* - BMA456W_WRIST_WEAR
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_feature_enable(uint8_t feature, uint8_t enable, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiRemap Remap Axes
* @brief Set / Get x, y and z axis re-mapping in the sensor
*/
/*!
* \ingroup bma456wApiRemap
* \page bma456w_api_bma456w_set_remap_axes bma456w_set_remap_axes
* \code
* int8_t bma456w_set_remap_axes(const struct bma4_remap *remap_data, struct bma4_dev *dev);
* \endcode
* @details This API performs x, y and z axis remapping in the sensor.
*
* @param[in] remap_axes : Structure instance of bma4_remap
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_set_remap_axes(const struct bma4_remap *remap_axes, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiRemap
* \page bma456w_api_bma456w_get_remap_axes bma456w_get_remap_axes
* \code
* int8_t bma456w_get_remap_axes(struct bma4_remap *remap_data, struct bma4_dev *dev);
* \endcode
* @details This API reads the x, y and z axis remap data from the sensor.
*
* @param[out] remap_axes : Structure instance of bma4_remap
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_get_remap_axes(struct bma4_remap *remap_axes, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiStepC Step counter
* @brief Operations of step counter feature of the sensor
*/
/*!
* \ingroup bma456wApiStepC
* \page bma456w_api_bma456w_step_counter_set_watermark bma456w_step_counter_set_watermark
* \code
* int8_t bma456w_step_counter_set_watermark(uint16_t step_counter_wm, struct bma4_dev *dev);
* \endcode
* @details This API sets the watermark level for step counter interrupt in
* the sensor.
*
* @param[in] step_counter_wm : Variable which specifies watermark level
* count
* @note Valid values are from 1 to 1023
* @note Value 0 is used for step detector interrupt
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_step_counter_set_watermark(uint16_t step_counter_wm, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiStepC
* \page bma456w_api_bma456w_step_counter_get_watermark bma456w_step_counter_get_watermark
* \code
* int8_t bma456w_step_counter_get_watermark(uint16_t *step_counter_wm, struct bma4_dev *dev);
* \endcode
* @details This API gets the water mark level set for step counter interrupt
* in the sensor
*
* @param[out] step_counter_wm : Pointer variable which stores the water mark
* level read from the sensor.
* @note valid values are from 1 to 1023
* @note value 0 is used for step detector interrupt
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_step_counter_get_watermark(uint16_t *step_counter_wm, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiStepC
* \page bma456w_api_bma456w_reset_step_counter bma456w_reset_step_counter
* \code
* int8_t bma456w_reset_step_counter(struct bma4_dev *dev);
* \endcode
* @details This API resets the counted steps of step counter.
*
* @param[in] dev : structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_reset_step_counter(struct bma4_dev *dev);
/*!
* \ingroup bma456wApiStepC
* \page bma456w_api_bma456w_step_counter_output bma456w_step_counter_output
* \code
* int8_t bma456w_step_counter_output(uint32_t *step_count, struct bma4_dev *dev);
* \endcode
* @details This API gets the number of counted steps of the step counter
* feature from the sensor.
*
* @param[out] step_count : Pointer variable which stores counted steps
* read from the sensor.
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_step_counter_output(uint32_t *step_count, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiAct Activity Feature
* @brief Get output for activity feature of the sensor
*/
/*!
* \ingroup bma456wApiAct
* \page bma456w_api_bma456w_activity_output bma456w_activity_output
* \code
* int8_t bma456w_activity_output(uint8_t *activity, struct bma4_dev *dev);
* \endcode
* @details This API gets the output for activity feature.
*
* @param[out] activity : Pointer variable which stores activity output read
* from the sensor.
*
*@verbatim
* activity | State
* --------------|------------------------
* 0x00 | BMA456W_USER_STATIONARY
* 0x01 | BMA456W_USER_WALKING
* 0x02 | BMA456W_USER_RUNNING
* 0x03 | BMA456W_STATE_INVALID
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_activity_output(uint8_t *activity, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiStepC
* \page bma456w_api_bma456w_stepcounter_get_parameter bma456w_stepcounter_get_parameter
* \code
* int8_t bma456w_stepcounter_get_parameter(struct bma456w_stepcounter_settings *setting, struct bma4_dev *dev);
* \endcode
* @details This API gets the parameter1 to parameter7 settings of the step
* counter feature.
*
* @param[out] setting : Pointer to structure variable which stores the
* parameter1 to parameter7 read from the sensor.
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_stepcounter_get_parameter(struct bma456w_stepcounter_settings *setting, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiStepC
* \page bma456w_api_bma456w_stepcounter_set_parameter bma456w_stepcounter_set_parameter
* \code
* int8_t bma456w_stepcounter_set_parameter(const struct bma456w_stepcounter_settings *setting, struct bma4_dev *dev);
* \endcode
* @details This API sets the parameter1 to parameter7 settings of the step
* counter feature in the sensor.
*
* @param[in] setting : Pointer to structure variable which stores the
* parameter1 to parameter7 settings read from the sensor.
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_stepcounter_set_parameter(const struct bma456w_stepcounter_settings *setting, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiStepD Step detector
* @brief Operations of step detector feature of the sensor
*/
/*!
* \ingroup bma456wApiStepD
* \page bma456w_api_bma421_step_detector_enable bma456w_step_detector_enable
* \code
* int8_t bma456w_step_detector_enable(uint8_t enable, struct bma4_dev *dev);
* \endcode
* @details This API enables or disables the step detector feature in the
* sensor.
*
* @param[in] enable : Variable used to enable or disable step detector
*
*@verbatim
* enable | Macros
* --------|-------------------
* 0x00 | BMA4_DISABLE
* 0x01 | BMA4_ENABLE
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_step_detector_enable(uint8_t enable, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiAnyMot Any motion Feature
* @brief Functions of Any motion feature of the sensor
*/
/*!
* \ingroup bma456wApiAnyMot
* \page bma456w_api_bma456w_set_any_motion_config bma456w_set_any_motion_config
* \code
* int8_t bma456w_set_any_motion_config(const struct bma456w_anymotion_config *any_motion, struct bma4_dev *dev);
* \endcode
* @details This API sets the configuration of any-motion feature in the sensor
* This API enables/disables the any-motion feature according to the axis set.
*
* @param[in] any_mot : Pointer to structure variable to configure
* any-motion.
*
* @verbatim
* -------------------------------------------------------------------------
* Structure parameters | Description
* --------------------------------|----------------------------------------
* | Defines the number of
* | consecutive data points for
* | which the threshold condition
* duration | must be respected, for interrupt
* | assertion. It is expressed in
* | 50 Hz samples (20 ms).
* | Range is 0 to 163sec.
* | Default value is 5 = 100ms.
* --------------------------------|----------------------------------------
* | Slope threshold value for
* | Any-motion detection
* threshold | in 5.11g format.
* | Range is 0 to 1g.
* | Default value is 0xAA = 83mg.
* --------------------------------|----------------------------------------
* | Enables the feature on a per-axis
* axis_en | basis.
* ---------------------------------------------------------------------------
* @endverbatim
*
*@verbatim
* Value | axis_en
* ---------|-------------------------
* 0x00 | BMA456W_ANY_NO_MOT_ALL_AXIS_DIS
* 0x01 | BMA456W_ANY_NO_MOT_X_AXIS_EN
* 0x02 | BMA456W_ANY_NO_MOT_Y_AXIS_EN
* 0x04 | BMA456W_ANY_NO_MOT_Z_AXIS_EN
* 0x07 | BMA456W_ANY_NO_MOT_ALL_AXIS_EN
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_set_any_mot_config(const struct bma456w_any_no_mot_config *any_mot, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiAnyMot
* \page bma456w_api_bma456w_get_any_motion_config bma456w_get_any_motion_config
* \code
* int8_t bma456w_get_any_motion_config(struct bma456w_anymotion_config *any_motion, struct bma4_dev *dev);
* \endcode
* @details This API gets the configuration of any-motion feature from the
* sensor.
*
* @param[out] any_mot : Pointer to structure variable to configure
* any-motion.
*
* @verbatim
* -------------------------------------------------------------------------
* Structure parameters | Description
* --------------------------------|----------------------------------------
* | Defines the number of
* | consecutive data points for
* | which the threshold condition
* duration | must be respected, for interrupt
* | assertion. It is expressed in
* | 50 Hz samples (20 ms).
* | Range is 0 to 163sec.
* | Default value is 5 = 100ms.
* --------------------------------|----------------------------------------
* | Slope threshold value for
* | Any-motion detection
* threshold | in 5.11g format.
* | Range is 0 to 1g.
* | Default value is 0xAA = 83mg.
* --------------------------------|-----------------------------------------
* | Enables the feature on a per-axis
* axis_en | basis.
* ---------------------------------------------------------------------------
* @endverbatim
*
*@verbatim
* Value | axis_en
* ---------|-------------------------
* 0x00 | BMA456W_ANY_NO_MOT_ALL_AXIS_DIS
* 0x01 | BMA456W_ANY_NO_MOT_X_AXIS_EN
* 0x02 | BMA456W_ANY_NO_MOT_Y_AXIS_EN
* 0x04 | BMA456W_ANY_NO_MOT_Z_AXIS_EN
* 0x07 | BMA456W_ANY_NO_MOT_ALL_AXIS_EN
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_get_any_mot_config(struct bma456w_any_no_mot_config *any_mot, struct bma4_dev *dev);
/**
* \ingroup bma456w
* \defgroup bma456wApiNomot No-Motion Feature
* @brief Operations of no-motion feature of the sensor
*/
/*!
* \ingroup bma456wApiNomot
* \page bma456w_api_bma456w_set_no_motion_config bma456w_set_no_motion_config
* \code
* int8_t bma456w_set_no_motion_config(const struct bma456w_nomotion_config *no_motion, struct bma4_dev *dev);
* \endcode
* @details This API sets the configuration of no-motion feature in the sensor
* This API enables/disables the no-motion feature according to the axis set.
*
* @param[in] no_mot : Pointer to structure variable to configure
* no-motion.
*
* @verbatim
* -------------------------------------------------------------------------
* Structure parameters | Description
* --------------------------------|----------------------------------------
* | Defines the number of
* | consecutive data points for
* | which the threshold condition
* duration | must be respected, for interrupt
* | assertion. It is expressed in
* | 50 Hz samples (20 ms).
* | Range is 0 to 163sec.
* | Default value is 5 = 100ms.
* --------------------------------|----------------------------------------
* | Slope threshold value for
* | No-motion detection
* threshold | in 5.11g format.
* | Range is 0 to 1g.
* | Default value is 0xAA = 83mg.
* --------------------------------|----------------------------------------
* | Enables the feature on a per-axis
* axis_en | basis.
* ---------------------------------------------------------------------------
* @endverbatim
*
*@verbatim
* Value | axis_en
* ---------|-------------------------
* 0x00 | BMA456W_ANY_NO_MOT_ALL_AXIS_DIS
* 0x01 | BMA456W_ANY_NO_MOT_X_AXIS_EN
* 0x02 | BMA456W_ANY_NO_MOT_Y_AXIS_EN
* 0x04 | BMA456W_ANY_NO_MOT_Z_AXIS_EN
* 0x07 | BMA456W_ANY_NO_MOT_ALL_AXIS_EN
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_set_no_mot_config(const struct bma456w_any_no_mot_config *no_mot, struct bma4_dev *dev);
/*!
* \ingroup bma456wApiNomot
* \page bma456w_api_bma456w_get_no_motion_config bma456w_get_no_motion_config
* \code
* int8_t bma456w_get_no_motion_config(struct bma456w_nomotion_config *no_motion, struct bma4_dev *dev);
* \endcode
* @details This API gets the configuration of no-motion feature from the
* sensor.
*
* @param[out] no_mot : Pointer to structure variable to configure
* no-motion.
*
* @verbatim
* -------------------------------------------------------------------------
* Structure parameters | Description
* --------------------------------|----------------------------------------
* | Defines the number of
* | consecutive data points for
* | which the threshold condition
* duration | must be respected, for interrupt
* | assertion. It is expressed in
* | 50 Hz samples (20 ms).
* | Range is 0 to 163sec.
* | Default value is 5 = 100ms.
* --------------------------------|----------------------------------------
* | Slope threshold value for
* | No-motion detection
* threshold | in 5.11g format.
* | Range is 0 to 1g.
* | Default value is 0xAA = 83mg.
* --------------------------------|-----------------------------------------
* | Enables the feature on a per-axis
* axis_en | basis.
* ---------------------------------------------------------------------------
* @endverbatim
*
*@verbatim
* Value | axis_en
* ---------|-------------------------
* 0x00 | BMA456W_ANY_NO_MOT_ALL_AXIS_DIS
* 0x01 | BMA456W_ANY_NO_MOT_X_AXIS_EN
* 0x02 | BMA456W_ANY_NO_MOT_Y_AXIS_EN
* 0x04 | BMA456W_ANY_NO_MOT_Z_AXIS_EN
* 0x07 | BMA456W_ANY_NO_MOT_ALL_AXIS_EN
*@endverbatim
*
* @param[in] dev : Structure instance of bma4_dev
*
* @return Result of API execution status
* @retval 0 -> Success
* @retval < 0 -> Fail
*/
int8_t bma456w_get_no_mot_config(struct bma456w_any_no_mot_config *no_mot, struct bma4_dev *dev);
/**
* \ingroup bma456w