BMM150 API

enum bmm150.bmm150_defs.PowerMode(value)

BMM150 power modes

Member Type

int

Valid values are as follows:

NORMAL = <PowerMode.NORMAL: 0>

Normal power mode

FORCED = <PowerMode.FORCED: 1>

Forced power mode

SLEEP = <PowerMode.SLEEP: 3>

Sleep mode

SUSPEND = <PowerMode.SUSPEND: 4>

Suspend power mode

enum bmm150.bmm150_defs.PresetMode(value)

BMM150 preset modes

Member Type

int

Valid values are as follows:

LOWPOWER = <PresetMode.LOWPOWER: 1>

Low power mode

REGULAR = <PresetMode.REGULAR: 2>

Normal mode

HIGHACCURACY = <PresetMode.HIGHACCURACY: 3>

High accuracy mode

ENHANCED = <PresetMode.ENHANCED: 4>

Enhanced mode

enum bmm150.bmm150_defs.PowerControl(value)

BMM150 power control modes

Member Type

int

Valid values are as follows:

DISABLE = <PowerControl.DISABLE: 0>

ENABLE = <PowerControl.ENABLE: 1>

class bmm150.BMM150(presetmode: bmm150.bmm150_defs.PresetMode = PresetMode.LOWPOWER, bus_number: int = 1, auto_init: bool = True)

BMM150’s object.

Parameters

• presetmode (PresetMode, optional) – Preset mode used. Defaults to PresetMode.LOWPOWER.

• bus_number (int, optional) – I²C bus number. Defaults to 1.

• auto_init (bool, optional) – Automatically start I²C init procedure. Defaults to True.

initialize() → None

Initializes the bmm150.

Returns

None

read_mag_data() → Tuple[int, int, int]

Reads and compensate the magnetic values for X, Y and Z.

Returns

A tuple containing raw (X, Y, Z) compensated data.

Return type

tuple[int, int, int]

read_raw_mag_data() → Tuple[int, int, int, int]

Reads registers containing X, Y, Z and R data from the device.

Returns

A tuple containing raw (X, Y, Z, R) data.

Return type

tuple[int, int, int, int]

read_trim_registers()

Reads the trim registers for calibration.

set_op_mode(pwr_mode: bmm150.bmm150_defs.PowerMode) → None

Sets power mode

Parameters

pwr_mode (PowerMode) – Desired power mode

set_presetmode(preset_mode: bmm150.bmm150_defs.PresetMode)

Sets preset mode

Parameters

preset_mode (PresetMode) – Desired preset mode

soft_reset()

Soft resets the module.