Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDED

ME11B Sample Code in Maxim Integrated Team

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Fork of Host_Software_MAX32664GWEB_HR_EXTENDED by Seyhmus Cacina

SHMAX8614X/HostAccelHelper.h@3:b8989dab0f88, 2019-03-25 (annotated)

Committer:
seyhmuscacina
Date:
Mon Mar 25 07:40:37 2019 +0000
Revision:
3:b8989dab0f88
Parent:
0:ac4dea3e2894 
Fork the repository

Who changed what in which revision?

UserRevisionLine numberNew contents of line
seyhmus.cacina 0:ac4dea3e2894 1 /*******************************************************************************
seyhmus.cacina 0:ac4dea3e2894 2 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
seyhmus.cacina 0:ac4dea3e2894 3 *
seyhmus.cacina 0:ac4dea3e2894 4 * Permission is hereby granted, free of charge, to any person obtaining a
seyhmus.cacina 0:ac4dea3e2894 5 * copy of this software and associated documentation files (the "Software"),
seyhmus.cacina 0:ac4dea3e2894 6 * to deal in the Software without restriction, including without limitation
seyhmus.cacina 0:ac4dea3e2894 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
seyhmus.cacina 0:ac4dea3e2894 8 * and/or sell copies of the Software, and to permit persons to whom the
seyhmus.cacina 0:ac4dea3e2894 9 * Software is furnished to do so, subject to the following conditions:
seyhmus.cacina 0:ac4dea3e2894 10 *
seyhmus.cacina 0:ac4dea3e2894 11 * The above copyright notice and this permission notice shall be included
seyhmus.cacina 0:ac4dea3e2894 12 * in all copies or substantial portions of the Software.
seyhmus.cacina 0:ac4dea3e2894 13 *
seyhmus.cacina 0:ac4dea3e2894 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
seyhmus.cacina 0:ac4dea3e2894 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
seyhmus.cacina 0:ac4dea3e2894 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
seyhmus.cacina 0:ac4dea3e2894 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
seyhmus.cacina 0:ac4dea3e2894 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
seyhmus.cacina 0:ac4dea3e2894 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
seyhmus.cacina 0:ac4dea3e2894 20 * OTHER DEALINGS IN THE SOFTWARE.
seyhmus.cacina 0:ac4dea3e2894 21 *
seyhmus.cacina 0:ac4dea3e2894 22 * Except as contained in this notice, the name of Maxim Integrated
seyhmus.cacina 0:ac4dea3e2894 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
seyhmus.cacina 0:ac4dea3e2894 24 * Products, Inc. Branding Policy.
seyhmus.cacina 0:ac4dea3e2894 25 *
seyhmus.cacina 0:ac4dea3e2894 26 * The mere transfer of this software does not imply any licenses
seyhmus.cacina 0:ac4dea3e2894 27 * of trade secrets, proprietary technology, copyrights, patents,
seyhmus.cacina 0:ac4dea3e2894 28 * trademarks, maskwork rights, or any other form of intellectual
seyhmus.cacina 0:ac4dea3e2894 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
seyhmus.cacina 0:ac4dea3e2894 30 * ownership rights.
seyhmus.cacina 0:ac4dea3e2894 31 *******************************************************************************
seyhmus.cacina 0:ac4dea3e2894 32 */
seyhmus.cacina 0:ac4dea3e2894 33
seyhmus.cacina 0:ac4dea3e2894 34 #ifndef _HOST_ACCEL_HELPER_H_
seyhmus.cacina 0:ac4dea3e2894 35 #define _HOST_ACCEL_HELPER_H_
seyhmus.cacina 0:ac4dea3e2894 36
seyhmus.cacina 0:ac4dea3e2894 37 #include <stdint.h>
seyhmus.cacina 0:ac4dea3e2894 38
seyhmus.cacina 0:ac4dea3e2894 39 /* Struct defining the sample of accelerometer
seyhmus.cacina 0:ac4dea3e2894 40 * Note: as alogorithms expect data as mg or g ; calculations needs to be done over raws accel sensordata and convert to mg or g
seyhmus.cacina 0:ac4dea3e2894 41 * acceld data is feed to sensor hub in mg or g format for all 3 axis,s data. Float definitions below are for mg and g
seyhmus.cacina 0:ac4dea3e2894 42 * calculations and can be modified to work with fixed point data type.
seyhmus.cacina 0:ac4dea3e2894 43 *
seyhmus.cacina 0:ac4dea3e2894 44 * */
seyhmus.cacina 0:ac4dea3e2894 45 typedef struct _accel_data_t {
seyhmus.cacina 0:ac4dea3e2894 46 float x;
seyhmus.cacina 0:ac4dea3e2894 47 float y;
seyhmus.cacina 0:ac4dea3e2894 48 float z;
seyhmus.cacina 0:ac4dea3e2894 49 int16_t x_raw;
seyhmus.cacina 0:ac4dea3e2894 50 int16_t y_raw;
seyhmus.cacina 0:ac4dea3e2894 51 int16_t z_raw;
seyhmus.cacina 0:ac4dea3e2894 52 } accel_data_t;
seyhmus.cacina 0:ac4dea3e2894 53
seyhmus.cacina 0:ac4dea3e2894 54 /**
seyhmus.cacina 0:ac4dea3e2894 55 * @brief Initialize the accelerometer on the host device
seyhmus.cacina 0:ac4dea3e2894 56 */
seyhmus.cacina 0:ac4dea3e2894 57 void CSTMR_SH_HostAccelerometerInitialize();
seyhmus.cacina 0:ac4dea3e2894 58
seyhmus.cacina 0:ac4dea3e2894 59 /**
seyhmus.cacina 0:ac4dea3e2894 60 * @brief Set default parameters for the accelerometer
seyhmus.cacina 0:ac4dea3e2894 61 */
seyhmus.cacina 0:ac4dea3e2894 62 void CSTMR_SH_HostAccelerometerSetDefaults();
seyhmus.cacina 0:ac4dea3e2894 63
seyhmus.cacina 0:ac4dea3e2894 64 /**
seyhmus.cacina 0:ac4dea3e2894 65 * @brief Set the sampling rate of the accelerometer
seyhmus.cacina 0:ac4dea3e2894 66 *
seyhmus.cacina 0:ac4dea3e2894 67 *
seyhmus.cacina 0:ac4dea3e2894 68 * @return 0 on SUCCESS
seyhmus.cacina 0:ac4dea3e2894 69 */
seyhmus.cacina 0:ac4dea3e2894 70 int CSTMR_SH_HostAccelerometerSetSampleRate(int sampleRate);
seyhmus.cacina 0:ac4dea3e2894 71
seyhmus.cacina 0:ac4dea3e2894 72 /**
seyhmus.cacina 0:ac4dea3e2894 73 * @brief Enable data ready interrupt of the accelerometer
seyhmus.cacina 0:ac4dea3e2894 74 *
seyhmus.cacina 0:ac4dea3e2894 75 *
seyhmus.cacina 0:ac4dea3e2894 76 * @return 0 on SUCCESS
seyhmus.cacina 0:ac4dea3e2894 77 */
seyhmus.cacina 0:ac4dea3e2894 78 int CSTMR_SH_HostAccelerometerEnableDataReadyInterrupt();
seyhmus.cacina 0:ac4dea3e2894 79
seyhmus.cacina 0:ac4dea3e2894 80 /**
seyhmus.cacina 0:ac4dea3e2894 81 * @brief Gets a sample from the accelerometer if the sample is ready
seyhmus.cacina 0:ac4dea3e2894 82 *
seyhmus.cacina 0:ac4dea3e2894 83 *
seyhmus.cacina 0:ac4dea3e2894 84 * @return 0 on SUCCESS
seyhmus.cacina 0:ac4dea3e2894 85 */
seyhmus.cacina 0:ac4dea3e2894 86 int CSTMR_SH_HostAccelerometerGet_sensor_xyz(accel_data_t *accel_data);
seyhmus.cacina 0:ac4dea3e2894 87
seyhmus.cacina 0:ac4dea3e2894 88 /**
seyhmus.cacina 0:ac4dea3e2894 89 * @brief Add the given sample to the accelerometer queue
seyhmus.cacina 0:ac4dea3e2894 90 *
seyhmus.cacina 0:ac4dea3e2894 91 *
seyhmus.cacina 0:ac4dea3e2894 92 * @return 0 on SUCCESS
seyhmus.cacina 0:ac4dea3e2894 93 */
seyhmus.cacina 0:ac4dea3e2894 94 int CSTMR_SH_HostAccelerometerEnqueueData(accel_data_t *accel_data);
seyhmus.cacina 0:ac4dea3e2894 95
seyhmus.cacina 0:ac4dea3e2894 96 /**
seyhmus.cacina 0:ac4dea3e2894 97 * @brief Get the sample count in the accelerometer queue
seyhmus.cacina 0:ac4dea3e2894 98 *
seyhmus.cacina 0:ac4dea3e2894 99 *
seyhmus.cacina 0:ac4dea3e2894 100 * @return 0 on SUCCESS
seyhmus.cacina 0:ac4dea3e2894 101 */
seyhmus.cacina 0:ac4dea3e2894 102 int CSTMR_SH_HostAccelerometerGetDataCount();
seyhmus.cacina 0:ac4dea3e2894 103
seyhmus.cacina 0:ac4dea3e2894 104 /**
seyhmus.cacina 0:ac4dea3e2894 105 * @brief Get a sample from the accelerometer queue
seyhmus.cacina 0:ac4dea3e2894 106 *
seyhmus.cacina 0:ac4dea3e2894 107 *
seyhmus.cacina 0:ac4dea3e2894 108 * @return 0 on SUCCESS
seyhmus.cacina 0:ac4dea3e2894 109 */
seyhmus.cacina 0:ac4dea3e2894 110 int CSTMR_SH_HostAccelerometerDequeuData(accel_data_t *accel_data);
seyhmus.cacina 0:ac4dea3e2894 111
seyhmus.cacina 0:ac4dea3e2894 112
seyhmus.cacina 0:ac4dea3e2894 113
seyhmus.cacina 0:ac4dea3e2894 114
seyhmus.cacina 0:ac4dea3e2894 115
seyhmus.cacina 0:ac4dea3e2894 116
seyhmus.cacina 0:ac4dea3e2894 117 #endif
seyhmus.cacina 0:ac4dea3e2894 118