| ISF 2.1 Intelligent Sensing Framework for Kinetis with Processor Expert

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
isf_magnetometer_types.h
Go to the documentation of this file.
1 /**
2 * @file isf_magnetometer_types.h
3 *
4 * @brief The \b isf_magnetometer_types.h file contains the ISF data type definitions for use with the
5 * ISF generic magnetometer fixed and floating point interface
6 *
7 * @copyright Copyright (c) 2014, Freescale Semiconductor, Inc.
8 */
9
10 #ifndef ISF_MAGNETOMETER_TYPES_H_
11 #define ISF_MAGNETOMETER_TYPES_H_
12
13 #include <isf_sensor_base_types.h>
14
15 /** @brief ISF sensors standard fixed point magnetometer type in microTeslas
16 * using AC_Fixed(32,14,1) notation
17 * This means of 32 total bits, 14 are used to represent
18 * the integer portion with the MSB as a sign bit.
19 * This leaves 17 bits for the fractional component. The
20 * LSB is therefore ~ 7.62939453125e-6 uT.
21 * The type can contain field strengths in the
22 * +/-8192 uT range.
23 */
24 /** @brief Fixed Point magnetometer field strength type definition */
25 typedef int32 isf_microTeslas_fixed_32s1i14_t;
26
27 /** @brief isf_SensorDataTypes_t TYPE_MAGNETIC_FIELD_STRENGTH_1D */
28 typedef struct {
29 isf_timestamp_t timestamp;
30 isf_microTeslas_fixed_32s1i14_t fieldStrength[1];
31 } isf_MagneticFieldStrength1D_EngFixed_t;
32
33 /** @brief isf_SensorDataTypes_t TYPE_MAGNETIC_FIELD_STRENGTH_2D */
34 typedef struct {
35 isf_timestamp_t timestamp;
36 isf_microTeslas_fixed_32s1i14_t fieldStrength[2];
37 } isf_MagneticFieldStrength2D_EngFixed_t;
38
39 /** @brief isf_SensorDataTypes_t TYPE_MAGNETIC_FIELD_STRENGTH_3D */
40 typedef struct {
41 isf_timestamp_t timestamp;
42 isf_microTeslas_fixed_32s1i14_t fieldStrength[3];
43 } isf_MagneticFieldStrength3D_EngFixed_t;
44
45 /* ISF sensors standard floating point magnetometer type in microTeslas
46 */
47 typedef float isf_fieldStrength_uT_float_t;
48
49 /** @brief Standard fixed type for single axis accelerometers */
50 typedef struct {
51 isf_timestamp_t timestamp;
52 isf_fieldStrength_uT_float_t fieldStrength;
53 } isf_MagneticFieldStrength1D_float_t;
54
55 /** @brief Standard fixed type for two axis accelerometers */
56 typedef struct {
57 isf_timestamp_t timestamp;
58 isf_fieldStrength_uT_float_t fieldStrength[2];
59 } isf_MagneticFieldStrength2D_float_t;
60
61 /** @brief Standard fixed type for three axis accelerometers */
62 typedef struct {
63 isf_timestamp_t timestamp;
64 isf_fieldStrength_uT_float_t fieldStrength[3];
65 } isf_MagneticFieldStrength3D_float_t;
66
67 #endif /* ISF_MAGNETOMETER_TYPES_H_ */
isf_MagneticFieldStrength2D_float_t
Standard fixed type for two axis accelerometers.
Definition: isf_magnetometer_types.h:56
isf_MagneticFieldStrength3D_float_t
Standard fixed type for three axis accelerometers.
Definition: isf_magnetometer_types.h:62
isf_MagneticFieldStrength1D_EngFixed_t::timestamp
isf_timestamp_t timestamp
Definition: isf_magnetometer_types.h:29
isf_MagneticFieldStrength2D_EngFixed_t::timestamp
isf_timestamp_t timestamp
Definition: isf_magnetometer_types.h:35
isf_MagneticFieldStrength1D_float_t
Standard fixed type for single axis accelerometers.
Definition: isf_magnetometer_types.h:50
isf_MagneticFieldStrength2D_EngFixed_t
isf_SensorDataTypes_t TYPE_MAGNETIC_FIELD_STRENGTH_2D
Definition: isf_magnetometer_types.h:34
isf_fieldStrength_uT_float_t
float isf_fieldStrength_uT_float_t
Definition: isf_magnetometer_types.h:47
isf_MagneticFieldStrength1D_float_t::fieldStrength
isf_fieldStrength_uT_float_t fieldStrength
Definition: isf_magnetometer_types.h:52
isf_MagneticFieldStrength1D_float_t::timestamp
isf_timestamp_t timestamp
Definition: isf_magnetometer_types.h:51
isf_MagneticFieldStrength3D_EngFixed_t::timestamp
isf_timestamp_t timestamp
Definition: isf_magnetometer_types.h:41
isf_MagneticFieldStrength2D_float_t::timestamp
isf_timestamp_t timestamp
Definition: isf_magnetometer_types.h:57
isf_sensor_base_types.h
The isf_sensor_base_types.h file contains declarations for the general base types used in the isf sen...
isf_timestamp_t
uint32 isf_timestamp_t
Standard timestamp.
Definition: isf_sensor_base_types.h:15
int32
long int32
This defines int32 as long.
Definition: isf_types.h:32
isf_MagneticFieldStrength3D_float_t::timestamp
isf_timestamp_t timestamp
Definition: isf_magnetometer_types.h:63
isf_MagneticFieldStrength1D_EngFixed_t
isf_SensorDataTypes_t TYPE_MAGNETIC_FIELD_STRENGTH_1D
Definition: isf_magnetometer_types.h:28
isf_MagneticFieldStrength3D_EngFixed_t
isf_SensorDataTypes_t TYPE_MAGNETIC_FIELD_STRENGTH_3D
Definition: isf_magnetometer_types.h:40
isf_microTeslas_fixed_32s1i14_t
int32 isf_microTeslas_fixed_32s1i14_t
ISF sensors standard fixed point magnetometer type in microTeslas using AC_Fixed(32,14,1) notation This means of 32 total bits, 14 are used to represent the integer portion with the MSB as a sign bit. This leaves 17 bits for the fractional component. The LSB is therefore ~ 7.62939453125e-6 uT. The type can contain field strengths in the +/-8192 uT range.
Definition: isf_magnetometer_types.h:25
- © Freescale Semiconductor, Inc. 2015. All Rights Reserved.