pyupm_bmm150 module

class pyupm_bmm150.BMM150(bus=0, addr=16, cs=-1)

Bases: object

API for the BMM150 3-Axis Geomagnetic Sensor.

ID: bmm150

Name: 3-axis Geomagnetic Sensor

Other Names: bmm050

Category: compass

Manufacturer: bosch

Connection: i2c spi gpio

Link:https://www.bosch-sensortec.com/bst/products/all_products/bmm150 The BMM150 is a standalone geomagnetic sensor for consumer market applications. It allows measurements of the magnetic field in three perpendicular axes. Based on Bosch’s proprietary FlipCore technology, performance and features of BMM150 are carefully tuned and perfectly match the demanding requirements of all 3-axis mobile applications such as electronic compass, navigation or augmented reality.

An evaluation circuitry (ASIC) converts the output of the geomagnetic sensor to digital results which can be read out over the industry standard digital interfaces (SPI and I2C).

Not all functionality of this chip has been implemented in this driver, however all the pieces are present to add any desired functionality. This driver supports both I2C (default) and SPI operation.

This device requires 3.3v operation.

C++ includes: bmm150.hpp

getChipID()

uint8_t getChipID()

Return the chip ID.

The chip ID.

getInterruptConfig()

uint8_t getInterruptConfig()

Return the Interrupt Config register. This register allows determining the electrical characteristics of the 2 interrupt pins (open-drain /push-pull and level/edge triggering) as well as other options. See the datasheet for details.

A bitmask of BMM150_INT_CONFIG_BITS_T bits.

getInterruptEnable()

uint8_t getInterruptEnable()

Return the Interrupt Enables register. This register allows you to enable various interrupt conditions. See the datasheet for details.

A bitmask of BMM150_INT_EN_BITS_T bits.

getInterruptStatus()

uint8_t getInterruptStatus()

Return the interrupt status register. This register indicates which interrupts have been triggered. See the datasheet for details.

a bitmask of BMM150_INT_STATUS_BITS_T bits.

getMagnetometer(*args)

std::vector< float > getMagnetometer()

Return magnetometer data in micro-Teslas (uT) in the form of a floating point vector. update() must have been called prior to calling this method.

A floating point vector containing x, y, and z in that order.

getOpmode()

BMM150_OPERATION_MODE_T getOpmode()

Get the current operating mode of the device. See the datasheet for details. The power bit must be one for this method to succeed.

One of the BMM150_OPERATION_MODE_T values.

init(usage=3)

void init(BMM150_USAGE_PRESETS_T usage=BMM150_USAGE_HIGH_ACCURACY)

Initialize the device and start operation. This function is called from the constructor so will not typically need to be called by a user unless the device is reset. This method will call setPresetMode() with the passed parameter.

usage: One of the BMM150_USAGE_PRESETS_T values. The default is BMM150_USAGE_HIGH_ACCURACY.

std::runtime_error: on failure.

installISR(intr, gpio, level, isr, arg)

void installISR(BMM150_INTERRUPT_PINS_T intr, int gpio, mraa::Edge level, void(*isr)(void *), void *arg)

Install an interrupt handler.

intr: One of the BMM150_INTERRUPT_PINS_T values specifying which interrupt pin you are installing.

gpio: GPIO pin to use as interrupt pin.

level: The interrupt trigger level (one of mraa::Edge values). Make sure that you have configured the interrupt pin properly for whatever level you choose.

isr: The interrupt handler, accepting a void * argument.

arg: The argument to pass the the interrupt handler.

std::runtime_error: on failure.

readReg(reg)

uint8_t readReg(uint8_t reg)

Read a register.

reg: The register to read.

The value of the register.

readRegs(reg, buffer, len)

int readRegs(uint8_t reg, uint8_t *buffer, int len)

Read contiguous registers into a buffer.

buffer: The buffer to store the results.

len: The number of registers to read.

The number of bytes read.

std::runtime_error: on failure.

reset()

void reset()

Perform a device soft-reset. The device will be placed in SUSPEND mode afterward with all configured setting lost, so some re-initialization will be required to get data from the sensor. Calling init() will get everything running again.

std::runtime_error: on failure.

setInterruptConfig(bits)

void setInterruptConfig(uint8_t bits)

Set the Interrupt Config register. This register allows determining the electrical characteristics of the 2 interrupt pins (open-drain /push-pull and level/edge triggering). See the datasheet for details.

bits: A bitmask of BMM150_INT_CONFIG_BITS_T bits.

std::runtime_error: on failure.

setInterruptEnable(bits)

void setInterruptEnable(uint8_t bits)

Set the Interrupt Enables register. See the datasheet for details.

bits: A bitmask of BMM150_INT_EN_BITS_T bits.

std::runtime_error: on failure.

setOpmode(opmode)

void setOpmode(BMM150_OPERATION_MODE_T opmode)

Set the operating mode of the device. See the datasheet for details.

opmode: One of the BMM150_OPERATION_MODE_T values.

std::runtime_error: on failure.

setOutputDataRate(odr)

void setOutputDataRate(BMM150_DATA_RATE_T odr)

Set the magnetometer Output Data Rate. See the datasheet for details.

odr: One of the BMM150_DATA_RATE_T values.

std::runtime_error: on failure.

setPowerBit(power)

void setPowerBit(bool power)

Set or clear the Power bit. When the power bit is cleared, the device enters a deep suspend mode where only the REG_POWER_CTRL register can be accessed. This bit needs to be enabled for the device to operate. See the datasheet for details. The constructor enables this by default. After a deep suspend mode has been entered, all configured data is lost and the device must be reconfigured (as via init()).

power: true to enable the bit, false otherwise.

std::runtime_error: on failure.

setPresetMode(usage)

void setPresetMode(BMM150_USAGE_PRESETS_T usage)

Set one of the Bosch recommended preset modes. These modes configure the sensor for varying use cases.

usage: One of the BMM150_USAGE_PRESETS_T values. The default is BMM150_USAGE_HIGH_ACCURACY.

std::runtime_error: on failure.

setRepetitionsXY(reps)

void setRepetitionsXY(uint8_t reps)

Set the repetition counter for the X and Y axes. This allows the device to average a number of measurements for a more stable output. See the datasheet for details.

reps: A coefficient for specifying the number of repititions to perform. (1 + 2(reps))

std::runtime_error: on failure.

setRepetitionsZ(reps)

void setRepetitionsZ(uint8_t reps)

Set the repetition counter for the Z axis. This allows the device to average a number of measurements for a more stable output. See the datasheet for details.

reps: A coefficient for specifying the number of repititions to perform. (1 + (reps))

std::runtime_error: on failure.

uninstallISR(intr)

void uninstallISR(BMM150_INTERRUPT_PINS_T intr)

Uninstall a previously installed interrupt handler.

intr: One of the BMM150_INTERRUPT_PINS_T values specifying which interrupt pin you are removing.

update()

void update()

Update the internal stored values from sensor data.

std::runtime_error: on failure.

writeReg(reg, val)

void writeReg(uint8_t reg, uint8_t val)

Write to a register.

reg: The register to write to.

val: The value to write.

std::runtime_error: on failure.

class pyupm_bmm150.SwigPyIterator(*args, **kwargs)

Bases: object

advance(n)

copy()

decr(n=1)

distance(x)

equal(x)

incr(n=1)

next()

previous()

value()

class pyupm_bmm150.byteVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_bmm150.doubleVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_bmm150.floatVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_bmm150.int16Vector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

class pyupm_bmm150.intVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)