3-axis MEMS ultra low power magnetometer
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
Dependents: X_NUCLEO_IKS01A3 X_NUCLEO_IKS01A3
Diff: LIS2MDLSensor.h
- Revision:
- 1:8562ae1a0534
- Parent:
- 0:671edf39d961
diff -r 671edf39d961 -r 8562ae1a0534 LIS2MDLSensor.h
--- a/LIS2MDLSensor.h Tue Mar 05 18:06:37 2019 +0000
+++ b/LIS2MDLSensor.h Wed Jul 24 14:18:39 2019 +0000
@@ -56,33 +56,30 @@
/* Typedefs ------------------------------------------------------------------*/
-typedef struct
-{
- int16_t x;
- int16_t y;
- int16_t z;
+typedef struct {
+ int16_t x;
+ int16_t y;
+ int16_t z;
} LIS2MDL_AxesRaw_t;
-typedef struct
-{
- int32_t x;
- int32_t y;
- int32_t z;
+typedef struct {
+ int32_t x;
+ int32_t y;
+ int32_t z;
} LIS2MDL_Axes_t;
/* Class Declaration ---------------------------------------------------------*/
-
+
/**
* Abstract class of an LIS2MDL Inertial Measurement Unit (IMU) 3 axes
* sensor.
*/
-class LIS2MDLSensor : public MagneticSensor
-{
- public:
+class LIS2MDLSensor : public MagneticSensor {
+public:
enum SPI_type_t {SPI3W, SPI4W};
- LIS2MDLSensor(SPI *spi, PinName cs_pin, PinName int_pin=NC, SPI_type_t spi_type=SPI4W);
- LIS2MDLSensor(DevI2C *i2c, uint8_t address=LIS2MDL_I2C_ADD, PinName int_pin=NC);
+ LIS2MDLSensor(SPI *spi, PinName cs_pin, PinName int_pin = NC, SPI_type_t spi_type = SPI4W);
+ LIS2MDLSensor(DevI2C *i2c, uint8_t address = LIS2MDL_I2C_ADD, PinName int_pin = NC);
virtual int init(void *init);
virtual int read_id(uint8_t *id);
virtual int get_m_axes(int32_t *magnetic_field);
@@ -118,7 +115,7 @@
{
_int_irq.enable_irq();
}
-
+
/**
* @brief Disabling the INT interrupt handling.
* @param None.
@@ -136,30 +133,32 @@
* @param NumByteToRead: number of bytes to be read.
* @retval 0 if ok, an error code otherwise.
*/
- uint8_t io_read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
+ uint8_t io_read(uint8_t *pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
{
if (_dev_spi) {
/* Write Reg Address */
_dev_spi->lock();
- _cs_pin = 0;
- if (_spi_type == SPI4W) {
+ _cs_pin = 0;
+ if (_spi_type == SPI4W) {
_dev_spi->write(RegisterAddr | 0x80);
- for (int i=0; i<NumByteToRead; i++) {
- *(pBuffer+i) = _dev_spi->write(0x00);
+ for (int i = 0; i < NumByteToRead; i++) {
+ *(pBuffer + i) = _dev_spi->write(0x00);
}
- } else if (_spi_type == SPI3W){
+ } else if (_spi_type == SPI3W) {
/* Write RD Reg Address with RD bit*/
- uint8_t TxByte = RegisterAddr | 0x80;
+ uint8_t TxByte = RegisterAddr | 0x80;
_dev_spi->write((char *)&TxByte, 1, (char *)pBuffer, (int) NumByteToRead);
- }
+ }
_cs_pin = 1;
- _dev_spi->unlock();
+ _dev_spi->unlock();
return 0;
- }
- if (_dev_i2c) return (uint8_t) _dev_i2c->i2c_read(pBuffer, _address, RegisterAddr, NumByteToRead);
+ }
+ if (_dev_i2c) {
+ return (uint8_t) _dev_i2c->i2c_read(pBuffer, _address, RegisterAddr, NumByteToRead);
+ }
return 1;
}
-
+
/**
* @brief Utility function to write data.
* @param pBuffer: pointer to data to be written.
@@ -167,22 +166,24 @@
* @param NumByteToWrite: number of bytes to write.
* @retval 0 if ok, an error code otherwise.
*/
- uint8_t io_write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
+ uint8_t io_write(uint8_t *pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
{
- if (_dev_spi) {
+ if (_dev_spi) {
_dev_spi->lock();
_cs_pin = 0;
- _dev_spi->write(RegisterAddr);
- _dev_spi->write((char *)pBuffer, (int) NumByteToWrite, NULL, 0);
- _cs_pin = 1;
+ _dev_spi->write(RegisterAddr);
+ _dev_spi->write((char *)pBuffer, (int) NumByteToWrite, NULL, 0);
+ _cs_pin = 1;
_dev_spi->unlock();
- return 0;
- }
- if (_dev_i2c) return (uint8_t) _dev_i2c->i2c_write(pBuffer, _address, RegisterAddr, NumByteToWrite);
+ return 0;
+ }
+ if (_dev_i2c) {
+ return (uint8_t) _dev_i2c->i2c_write(pBuffer, _address, RegisterAddr, NumByteToWrite);
+ }
return 1;
}
- private:
+private:
/* Helper classes. */
DevI2C *_dev_i2c;
@@ -190,23 +191,23 @@
/* Configuration */
uint8_t _address;
- DigitalOut _cs_pin;
+ DigitalOut _cs_pin;
InterruptIn _int_irq;
SPI_type_t _spi_type;
-
+
uint8_t _mag_is_enabled;
-
+
lis2mdl_ctx_t _reg_ctx;
-
+
};
#ifdef __cplusplus
- extern "C" {
+extern "C" {
#endif
-int32_t LIS2MDL_io_write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
-int32_t LIS2MDL_io_read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
+int32_t LIS2MDL_io_write(void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite);
+int32_t LIS2MDL_io_read(void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead);
#ifdef __cplusplus
- }
+}
#endif
#endif