mag3110_oneshot.c File Reference

The mag3110_oneshot.c file implements the ISSDK MAG3110 sensor driver example demonstration with polling mode. More...

#include "board.h"
#include "pin_mux.h"
#include "clock_config.h"
#include "fsl_debug_console.h"
#include "Driver_I2C.h"
#include "issdk_hal.h"
#include "mag3110_drv.h"

Include dependency graph for mag3110_oneshot.c:

Go to the source code of this file.

Macros
#define	MAG3110_DATA_SIZE   (6) /* 2 byte X,Y,Z Axis Data each. */

Functions
int	main (void)
	Main function. More...

Variables
const registerwritelist_t	cMag3110ConfigOneShot []
	Register settings for Magnetic Strength readings in One-Shot mode. More...
const registerwritelist_t	cMag3110SetOST []
	Register settings for Triggring One-Shot Sampling. More...
const registerreadlist_t	cMag3110GetOST [] = {{.readFrom = MAG3110_CTRL_REG1, .numBytes = 1}, __END_READ_DATA__}
	Address of Register containing OST Bit. More...
const registerreadlist_t	cMag3110OutputNormal []
	Address and size of Raw Magnetic Strength Data. More...

Detailed Description

The mag3110_oneshot.c file implements the ISSDK MAG3110 sensor driver example demonstration with polling mode.

Definition in file mag3110_oneshot.c.

Macro Definition Documentation

MAG3110_DATA_SIZE

#define MAG3110_DATA_SIZE   (6) /* 2 byte X,Y,Z Axis Data each. */

Definition at line 61 of file mag3110_oneshot.c.

Referenced by main().

Function Documentation

main()

int main

(

void

)

Main function.

Initialize the I2C driver.

Set the I2C Power mode.

Set the I2C bus speed.

Initialize MAG3110 sensor driver.

We do not need to call MAG3110_I2C_Configure() in this case as we are going to read samples on demand. Instead we directly write register settings for One-Shot Mode...

The code contained withing the braces illustrate steps to read one-sample. These can be repated at desired intervals to acquire more samples.

Keep checking the OST FLAG for completion.

Read raw sensor data from the MAG3110.

Process the sample and convert the raw sensor data to signed 16-bit container.

Definition at line 92 of file mag3110_oneshot.c.

References ASK_USER_TO_RESUME, BOARD_BootClockRUN, BOARD_InitDebugConsole(), BOARD_InitPins(), data, PhysicalSensor::deviceInfo, registerDeviceInfo_t::deviceInstance, registerDeviceInfo_t::functionParam, I2C_S_DEVICE_INDEX, I2C_S_DRIVER, I2C_S_SIGNAL_EVENT, registerDeviceInfo_t::idleFunction, int32_t(), mag3110_magdata_t::mag, MAG3110_CTRL_REG1_TM_MASK, MAG3110_DATA_SIZE, MAG3110_I2C_ADDR, MAG3110_I2C_Initialize(), MAG3110_I2C_ReadData(), MAG3110_WHOAMI_VALUE, mag3110_i2c_sensorhandle_t::pCommDrv, rawData, SENSOR_ERROR_NONE, SENSOR_ERROR_WRITE, Sensor_I2C_Write(), mag3110_i2c_sensorhandle_t::slaveAddress, SMC, SMC_SetPowerModeWait(), and status.

Here is the call graph for this function:

Variable Documentation

cMag3110ConfigOneShot

const registerwritelist_t cMag3110ConfigOneShot[]

Initial value:

= {
    
    {MAG3110_CTRL_REG2, MAG3110_CTRL_REG2_MAG_RST_EN | MAG3110_CTRL_REG2_AUTO_MSRT_EN_EN | MAG3110_CTRL_REG2_RAW_RAW,
                        MAG3110_CTRL_REG2_MAG_RST_MASK | MAG3110_CTRL_REG2_AUTO_MSRT_EN_MASK | MAG3110_CTRL_REG2_RAW_MASK},
    __END_WRITE_DATA__}

Register settings for Magnetic Strength readings in One-Shot mode.

Definition at line 67 of file mag3110_oneshot.c.

cMag3110GetOST

const registerreadlist_t cMag3110GetOST[] = {{.readFrom = MAG3110_CTRL_REG1, .numBytes = 1}, __END_READ_DATA__}

Address of Register containing OST Bit.

Definition at line 80 of file mag3110_oneshot.c.

cMag3110OutputNormal

const registerreadlist_t cMag3110OutputNormal[]

Initial value:

= {{.readFrom = MAG3110_OUT_X_MSB, .numBytes = MAG3110_DATA_SIZE},
                                                   __END_READ_DATA__}

Address and size of Raw Magnetic Strength Data.

Definition at line 83 of file mag3110_oneshot.c.

cMag3110SetOST

const registerwritelist_t cMag3110SetOST[]

Initial value:

= {
    
    {MAG3110_CTRL_REG1, MAG3110_CTRL_REG1_TM_TRIGGER, MAG3110_CTRL_REG1_TM_MASK},
    __END_WRITE_DATA__}

Register settings for Triggring One-Shot Sampling.

Definition at line 74 of file mag3110_oneshot.c.