pyupm_bma250e module

class pyupm_bma250e.BMA250E(bus=0, addr=24, cs=-1)

Bases: object

API for the BMA250E 10 bit Triaxial Accelerometer.

ID: bma250e

Name: Digital Triaxial Acceleration Sensor

Category: accelerometer

Manufacturer: bosch

Connection: i2c spi gpio

Link:https://www.bosch-sensortec.com/bst/products/all_products/bma250e The BMA250E is a triaxial, low-g acceleration sensor with digital output for consumer applications. It allows measurements of acceleration in three perpendicular axes. An evaluation circuitry (ASIC) converts the output of a micromechanical acceleration-sensing structure (MEMS) that works according to the differential capacitance principle.

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 driver attempts to support verious flavors of this chip, such as the version on the BMX050, BMI050 (chipid 0xfa) and the version on the bmc050 (chipid 0x03). Not all functionality is appropriate, or even present on all chips. Consult the relevant datasheets.

This device requires 3.3v operation.

C++ includes: bma250e.hpp

clearInterruptLatches()

void clearInterruptLatches()

Clear all latched interrupts. See the datasheet for details.

std::runtime_error: on failure.

enableFIFO(useFIFO)

void enableFIFO(bool useFIFO)

Enable update() to read from the FIFO rather than the acceleration axis registers directly. init() enables this mode by default if the chip variant supports a FIFO. An advantage to this mode that all axis data is sampled from the same timeslice. When reading directly from the acceleration output registers, it’s possible for one axis to be updated while another is being read, causing a temporal anomaly that even Captain Picard can’t resolve. If there is no FIFO present, this call is ignored.

Using the FIFO removes this problem.

useFIFO: True to enable update() to read from the FIFO. When false, update will read from the acceleration output registers directly.

enableOutputFiltering(filter)

void enableOutputFiltering(bool filter)

Enable filtering of the accelerometer axis data. init() enables this by default. If disabled, then accelerometer data that is read will be raw and unfiltered (rated R). See the datasheet for details.

filter: True to enable filtering, false to disable.

std::runtime_error: on failure.

enableRegisterShadowing(shadow)

void enableRegisterShadowing(bool shadow)

Enable shadowing of the accelerometer output registers. When enabled, a read of an axis LSB register automatically locks the MSB register of that axis until it has been read. This is usually a good thing to have enabled. init() enables this by default. If disabled, then it becomes possible for part of an axis value to change while another part is being read, causing inconsistent data.

shadow: True to enable axis register shadowing, false otherwise.

std::runtime_error: on failure.

fifoConfig(mode, axes)

void fifoConfig(BMA250E_FIFO_MODE_T mode, BMA250E_FIFO_DATA_SEL_T axes)

Set the FIFO configuration. init() uses the FIFO_MODE_BYPASS mode with axes set to FIFO_DATA_SEL_XYZ by default. If there is no FIFO present, this call is ignored.

mode: One of the BMA250E_FIFO_MODE_T values.

axes: One of the BMA250E_FIFO_DATA_SEL_T values.

std::runtime_error: on failure.

fifoSetWatermark(wm)

void fifoSetWatermark(int wm)

Set the FIFO watermark. When the watermark is reached an interrupt (if enabled) will be generated. If there is no FIFO present, this call is ignored.

wm: The FIFO watermark to use. The maximum value is 63.

std::runtime_error: on failure.

getAccelerometer(*args)

std::vector< float > getAccelerometer()

Return accelerometer data in gravities 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.

getChipID()

uint8_t getChipID()

Return the chip ID.

The chip ID.

getInterruptEnable0()

uint8_t getInterruptEnable0()

Return the Interrupt Enables 0 register. These registers allow you to enable various interrupt conditions. See the datasheet for details.

A bitmask of BMA250E_INT_EN_0_BITS_T bits.

getInterruptEnable1()

uint8_t getInterruptEnable1()

Return the Interrupt Enables 1 register. See the datasheet for details.

A bitmask of BMA250E_INT_EN_1_BITS_T bits.

getInterruptEnable2()

uint8_t getInterruptEnable2()

Return the Interrupt Enables 2 register. See the datasheet for details.

A bitmask of BMA250E_INT_EN_2_BITS_T bits.

getInterruptLatchBehavior()

BMA250E_RST_LATCH_T getInterruptLatchBehavior()

Return the current interrupt latching behavior. See the datasheet for details.

One of the BMA250E_RST_LATCH_T values.

getInterruptMap0()

uint8_t getInterruptMap0()

Return the Interrupt Map 0 register. These registers allow you to map specific interrupts to the interrupt 1 or interrupt 2 pin. See the datasheet for details.

A bitmask of BMA250E_INT_MAP_0_BITS_T bits.

getInterruptMap1()

uint8_t getInterruptMap1()

Return the Interrupt Map 1 register. See the datasheet for details.

A bitmask of BMA250E_INT_MAP_1_BITS_T bits.

getInterruptMap2()

uint8_t getInterruptMap2()

Return the Interrupt Map 2 register. See the datasheet for details.

A bitmask of BMA250E_INT_MAP_2_BITS_T bits.

getInterruptOutputControl()

uint8_t getInterruptOutputControl()

Return the Interrupt output control 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.

A bitmask of BMA250E_INT_OUT_CTRL_BITS_T bits.

getInterruptSrc()

uint8_t getInterruptSrc()

Return the Interrupt source register. This register allows determining where data comes from (filtered/unfiltered) for those interrupt sources where this is selectable. See the datasheet for details.

A bitmask of BMA250E_INT_SRC_BITS_T bits.

getInterruptStatus0()

uint8_t getInterruptStatus0()

Return the interrupt status 0 register. These registers indicate which interrupts have been triggered. See the datasheet for details.

A bitmask of BMA250E_INT_STATUS_0_BITS_T bits.

getInterruptStatus1()

uint8_t getInterruptStatus1()

Return the interrupt status 1 register. See the datasheet for details.

A bitmask of BMA250E_INT_STATUS_1_BITS_T bits.

getInterruptStatus2()

uint8_t getInterruptStatus2()

Return the interrupt status 2 register. See the datasheet for details.

A bitmask of BMA250E_INT_STATUS_2_BITS_T bits.

getInterruptStatus3Bits()

uint8_t getInterruptStatus3Bits()

Return the interrupt status 3 register bitfields. See the datasheet for details. The Orientation value is not returned by this function, see getInterruptStatus3Orientation() for that information.

A bitmask of BMA250E_INT_STATUS_3_BITS_T bits ONLY.

getInterruptStatus3Orientation()

BMA250E_ORIENT_T getInterruptStatus3Orientation()

Return the interrupt status 3 register Orientation value. See the datasheet for details.

One of the BMA250E_ORIENT_T values.

getTemperature(fahrenheit=False)

float getTemperature(bool fahrenheit=false)

Return the current measured temperature. Note, this is not ambient temperature. update() must have been called prior to calling this method.

fahrenheit: true to return data in Fahrenheit, false for Celicus. Celsius is the default.

The temperature in degrees Celsius or Fahrenheit.

init(pwr=0, range=3, bw=13)

void init(BMA250E_POWER_MODE_T pwr=BMA250E_POWER_MODE_NORMAL, BMA250E_RANGE_T range=BMA250E_RANGE_2G, BMA250E_BW_T bw=BMA250E_BW_250)

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.

pwr: One of the BMA250E_POWER_MODE_T values. The default is BMA250E_POWER_MODE_NORMAL.

range: One of the BMA250E_RANGE_T values. The default is BMA250E_RANGE_2G.

bw: One of the filtering BMA250E_BW_T values. The default is BMA250E_BW_250.

std::runtime_error: on failure.

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

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

install an interrupt handler.

intr: One of the BMA250E_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()

Reset the device as if during a power on reset. All configured values are lost when this happens. You should call init() afterwards, or at least perform the same initialization init() does before continuing.

std::runtime_error: on failure.

setBandwidth(bw)

void setBandwidth(BMA250E_BW_T bw)

Set the output filtering bandwidth of the device.

bw: One of the BMA250E_BW_T values.

std::runtime_error: on failure.

setInterruptEnable0(bits)

void setInterruptEnable0(uint8_t bits)

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

bits: A bitmask of BMA250E_INT_EN_0_BITS_T bits.

std::runtime_error: on failure.

setInterruptEnable1(bits)

void setInterruptEnable1(uint8_t bits)

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

bits: A bitmask of BMA250E_INT_EN_1_BITS_T bits.

std::runtime_error: on failure.

setInterruptEnable2(bits)

void setInterruptEnable2(uint8_t bits)

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

bits: A bitmask of BMA250E_INT_EN_2_BITS_T bits.

std::runtime_error: on failure.

setInterruptLatchBehavior(latch)

void setInterruptLatchBehavior(BMA250E_RST_LATCH_T latch)

Set the current interrupt latching behavior. See the datasheet for details.

latch: One of the BMA250E_RST_LATCH_T values.

std::runtime_error: on failure.

setInterruptMap0(bits)

void setInterruptMap0(uint8_t bits)

Set the Interrupt Map 0 register. These registers allow you to map specific interrupts to the interrupt 1 or interrupt 2 pin. See the datasheet for details.

bits: A bitmask of BMA250E_INT_MAP_0_BITS_T bits.

std::runtime_error: on failure.

setInterruptMap1(bits)

void setInterruptMap1(uint8_t bits)

Set the Interrupt Map 1 register. See the datasheet for details.

bits: A bitmask of BMA250E_INT_MAP_1_BITS_T bits.

std::runtime_error: on failure.

setInterruptMap2(bits)

void setInterruptMap2(uint8_t bits)

Set the Interrupt Map 2 register. See the datasheet for details.

bits: A bitmask of BMA250E_INT_MAP_2_BITS_T bits.

std::runtime_error: on failure.

setInterruptOutputControl(bits)

void setInterruptOutputControl(uint8_t bits)

Set the Interrupt output control 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 BMA250E_INT_OUT_CTRL_BITS_T bits.

std::runtime_error: on failure.

setInterruptSrc(bits)

void setInterruptSrc(uint8_t bits)

Set the Interrupt source register. This register allows determining where data comes from (filtered/unfiltered) for those interrupt sources where this is selectable. See the datasheet for details.

bits: A bitmask of BMA250E_INT_SRC_BITS_T bits.

std::runtime_error: on failure.

setLowPowerMode2()

void setLowPowerMode2()

Make sure low power mode config (LPM2) is set in case we later go into the low power or suspend power modes. LPM1 mode (the default) requires drastically slowed register writes which we cannot handle.

std::runtime_error: on failure.

setPowerMode(power)

void setPowerMode(BMA250E_POWER_MODE_T power)

Set the power mode of the device. Care must be taken when setting a low power or suspend mode. By default init() calls setLowPowerMode2() to ensure that if any of these modes are entered we can still talk to the device. The default low power mode is LPM1, which requires slowing down register writes, which we cannot support. setLowPowerMode2() enables LPM2 which keeps the digital interface operational in low power or suspend modes. See the datasheet for details.

So if you reset your device and don’t call init() or setLowPowerMode2(), you could lose control of the device by calling this function with anything other than POWER_MODE_NORMAL. You’ve been warned :)

power: One of the BMA250E_POWER_MODE_T values.

std::runtime_error: on failure.

setRange(range)

void setRange(BMA250E_RANGE_T range)

Set the acceleration scaling range. This device supports 2, 4, 8, and 16g ranges.

range: One of the BMA250E_RANGE_T values.

std::runtime_error: on failure.

setSelfTest(sign, amp, axis)

void setSelfTest(bool sign, bool amp, BMA250E_SELFTTEST_AXIS_T axis)

Enable, disable, and configure the built in self test on a per axis basis. See the datasheet for details.

sign: True for a positive deflection, false for negative

amp: True for a high deflection, false for a low deflection

axis: One of the BMA250E_SELFTTEST_AXIS_T values. Note, only one axis at a time can be tested. Accelerometer output for other axes should be ignored.

std::runtime_error: on failure.

uninstallISR(intr)

void uninstallISR(BMA250E_INTERRUPT_PINS_T intr)

uninstall a previously installed interrupt handler

intr: One of the BMA250E_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_bma250e.SwigPyIterator(*args, **kwargs)

Bases: object

advance(n)

copy()

decr(n=1)

distance(x)

equal(x)

incr(n=1)

next()

previous()

value()

class pyupm_bma250e.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_bma250e.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_bma250e.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_bma250e.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_bma250e.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)