Inheritance diagram for qwiic_mmc5983ma.QwiicMMC5983MA:

Classes
class	MemoryShadow

Public Member Functions
def	__init__ (self, address=None, i2c_driver=None)
	Constructor. More...

def	is_connected (self)
	Determines if this device is connected. More...

def	begin (self)
	Initializes this device with default parameters. More...

def	is_bit_set (self, register_address, bit_mask)
	Checks if a bit is set in a register. More...

def	set_register_bit (self, register_address, bit_mask)
	Sets a bit in a register. More...

def	set_shadow_bit (self, register_address, bit_mask, do_write=True)
	Sets a bit in the shadow register and optionally writes the value to the device. More...

def	clear_shadow_bit (self, register_address, bit_mask, do_write=True)
	Clears a bit in the shadow register and optionally writes the value to the device. More...

def	is_shadow_bit_set (self, register_address, bit_mask)
	Checks if a bit is set in the shadow register. More...

def	get_temperature (self)
	Gets the temperature in degrees Celsius. More...

def	soft_reset (self)
	Performs a software reset. More...

def	enable_interrupt (self)
	Enables interrupts. More...

def	disable_interrupt (self)
	Disables interrupts. More...

def	is_interrupt_enabled (self)
	Checks if interrupts are enabled. More...

def	enable_3_wire_spi (self)
	Enables 3-wire SPI. More...

def	disable_3_wire_spi (self)
	Disables 3-wire SPI. More...

def	is_3_wire_spi_enabled (self)
	Checks if 3-wire SPI is enabled. More...

def	perform_set_operation (self)
	Performs a SET operation. More...

def	perform_reset_operation (self)
	Performs a RESET operation. More...

def	enable_automatic_set_reset (self)
	Enables automatic SET/RESET operations, which needs to be done in conjuction with enable_periodic_set() and set_periodic_set_samples() More...

def	disable_automatic_set_reset (self)
	Disables automatic SET/RESET operations. More...

def	is_automatic_set_reset_enabled (self)
	Checks if automatic SET/RESET operations are enabled. More...

def	enable_x_channel (self)
	Enables the X channel. More...

def	disable_x_channel (self)
	Disables the X channel. More...

def	is_x_channel_enabled (self)
	Checks if the X channel is enabled. More...

def	enable_yz_channels (self)
	Enables the Y and Z channels. More...

def	disable_yz_channels (self)
	Disables the Y and Z channels. More...

def	are_yz_channels_enabled (self)
	Checks if the Y and Z channels are enabled. More...

def	set_filter_bandwidth (self, bandwidth)
	Sets the filter bandwidth. More...

def	get_filter_bandwidth (self)
	Gets the filter bandwidth. More...

def	enable_continuous_mode (self)
	Enables continuous mode. More...

def	disable_continuous_mode (self)
	Disables continuous mode. More...

def	is_continuous_mode_enabled (self)
	Checks if continuous mode is enabled. More...

def	set_continuous_mode_frequency (self, frequency)
	Sets the continuous mode frequency. More...

def	get_continuous_mode_frequency (self)
	Gets the continuous mode frequency. More...

def	enable_periodic_set (self)
	Enables periodic SET operations, which needs to be done in conjuction with enable_automatic_set_reset() and set_periodic_set_samples() More...

def	disable_periodic_set (self)
	Disables periodic SET operations. More...

def	is_periodic_set_enabled (self)
	Checks if periodic SET operations are enabled. More...

def	set_periodic_set_samples (self, number_of_samples)
	Sets the number of samples between each SET operation when periodic SET operations are enabled. More...

def	get_periodic_set_samples (self)
	Gets the number of samples between each SET operation when periodic SET operations are enabled. More...

def	apply_extra_current_pos_to_neg (self)
	Applies extra current "forward" through the coils to change the magnetic field strength. More...

def	remove_extra_current_pos_to_neg (self)
	Removes extra current "forward" through the coils. More...

def	is_extra_current_applied_pos_to_neg (self)
	Checks if extra current is applied "forward" through the coils. More...

def	apply_extra_current_neg_to_pos (self)
	Applies extra current "reverse" through the coils to change the magnetic field strength. More...

def	remove_extra_current_neg_to_pos (self)
	Removes extra current "reverse" through the coils. More...

def	is_extra_current_applied_neg_to_pos (self)
	Checks if extra current is applied "reverse" through the coils. More...

def	clear_meas_done_interrupt (self, meas_mask=MEAS_T_DONE\|MEAS_M_DONE)
	Clears the measurement done interrupt. More...

def	get_measurement_x (self)
	Gets the raw x-axis measurement. More...

def	get_measurement_y (self)
	Gets the raw y-axis measurement. More...

def	get_measurement_z (self)
	Gets the raw z-axis measurement. More...

def	get_measurement_xyz (self)
	Gets the raw x, y, and z-axis measurements. More...

def	read_fields_xyz (self)
	Internal function to get the raw x, y, and z-axis measurements, should not be called directly. More...

def	calibrate_offsets (self)
	Calibrates the offsets for all axes. More...

def	get_offsets (self)
	Gets the raw offsets for all axes. More...

def	get_measurement_x_gauss (self, offset=None, gain=8)
	Gets the x-axis measurement in gauss. More...

def	get_measurement_y_gauss (self, offset=None, gain=8)
	Gets the y-axis measurement in gauss. More...

def	get_measurement_z_gauss (self, offset=None, gain=8)
	Gets the z-axis measurement in gauss. More...

def	get_measurement_xyz_gauss (self, offsets=None, gains=[8] *3)
	Gets the x, y, and z-axis measurements in gauss. More...

Public Attributes
	address

	x_offset

	y_offset

	z_offset

	memory_shadow

Static Public Attributes
	device_name = _DEFAULT_NAME

	available_addresses = _AVAILABLE_I2C_ADDRESS

int	X_OUT_0_REG = 0x0

int	X_OUT_1_REG = 0x01

int	Y_OUT_0_REG = 0x02

int	Y_OUT_1_REG = 0x03

int	Z_OUT_0_REG = 0x04

int	Z_OUT_1_REG = 0x05

int	XYZ_OUT_2_REG = 0x06

int	T_OUT_REG = 0x07

int	STATUS_REG = 0x08

int	INT_CTRL_0_REG = 0x09

int	INT_CTRL_1_REG = 0x0a

int	INT_CTRL_2_REG = 0x0b

int	INT_CTRL_3_REG = 0x0c

int	PROD_ID_REG = 0x2f

int	DUMMY = 0x0

int	I2C_ADDR = 0x30

int	PROD_ID = 0x30

tuple	MEAS_M_DONE = (1 << 0)

tuple	MEAS_T_DONE = (1 << 1)

tuple	OTP_READ_DONE = (1 << 4)

tuple	TM_M = (1 << 0)

tuple	TM_T = (1 << 1)

tuple	INT_MEAS_DONE_EN = (1 << 2)

tuple	SET_OPERATION = (1 << 3)

tuple	RESET_OPERATION = (1 << 4)

tuple	AUTO_SR_EN = (1 << 5)

tuple	OTP_READ = (1 << 6)

tuple	BW0 = (1 << 0)

tuple	BW1 = (1 << 1)

tuple	X_INHIBIT = (1 << 2)

tuple	YZ_INHIBIT = (3 << 3)

tuple	SW_RST = (1 << 7)

tuple	CM_FREQ_0 = (1 << 0)

tuple	CM_FREQ_1 = (1 << 1)

tuple	CM_FREQ_2 = (1 << 2)

tuple	CMM_EN = (1 << 3)

tuple	PRD_SET_0 = (1 << 4)

tuple	PRD_SET_1 = (1 << 5)

tuple	PRD_SET_2 = (1 << 6)

tuple	EN_PRD_SET = (1 << 7)

tuple	ST_ENP = (1 << 1)

tuple	ST_ENM = (1 << 2)

tuple	SPI_3W = (1 << 6)

tuple	X2_MASK = (3 << 6)

tuple	Y2_MASK = (3 << 4)

tuple	Z2_MASK = (3 << 2)

int	XYZ_0_SHIFT = 10

int	XYZ_1_SHIFT = 2

Properties
	connected = property(is_connected)

Constructor & Destructor Documentation

◆ init()

def qwiic_mmc5983ma.QwiicMMC5983MA.__init__	(	self,
		address = `None`,
		i2c_driver = `None`
	)

Constructor.

Parameters

int,optional	address: The I2C address to use for the device If not provided, the default address is used
I2CDriver,optional	i2c_driver: An existing i2c driver object If not provided, a driver object is created

Member Function Documentation

◆ apply_extra_current_neg_to_pos()

def qwiic_mmc5983ma.QwiicMMC5983MA.apply_extra_current_neg_to_pos ( self )

Applies extra current "reverse" through the coils to change the magnetic field strength.

This can be used to check if the sensor has been saturated.

Returns: bool True if successful, otherwise False

◆ apply_extra_current_pos_to_neg()

def qwiic_mmc5983ma.QwiicMMC5983MA.apply_extra_current_pos_to_neg ( self )

Applies extra current "forward" through the coils to change the magnetic field strength.

This can be used to check if the sensor has been saturated.

Returns: bool True if successful, otherwise False

◆ are_yz_channels_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.are_yz_channels_enabled ( self )

Checks if the Y and Z channels are enabled.

Returns: bool True if enabled, otherwise False

◆ begin()

def qwiic_mmc5983ma.QwiicMMC5983MA.begin ( self )

Initializes this device with default parameters.

Returns: bool Returns True if successful, otherwise False

◆ calibrate_offsets()

def qwiic_mmc5983ma.QwiicMMC5983MA.calibrate_offsets ( self )

Calibrates the offsets for all axes.

This will also degauss the sensor if it was previously exposed to a strong magnetic field.

◆ clear_meas_done_interrupt()

def qwiic_mmc5983ma.QwiicMMC5983MA.clear_meas_done_interrupt	(	self,
		meas_mask = `MEAS_T_DONE \| MEAS_M_DONE`
	)

Clears the measurement done interrupt.

Parameters

int,optional meas_mask: Measurement mask, defaults to MEAS_T_DONE | MEAS_M_DONE

◆ clear_shadow_bit()

def qwiic_mmc5983ma.QwiicMMC5983MA.clear_shadow_bit	(	self,
		register_address,
		bit_mask,
		do_write = `True`
	)

Clears a bit in the shadow register and optionally writes the value to the device.

Parameters

int	register_address: Register address
int	bit_mask: Bit mask
bool,optional	do_write: Whether to write the value to the device, defaults to True

Returns: bool True if successful, otherwise False

◆ disable_3_wire_spi()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_3_wire_spi ( self )

Disables 3-wire SPI.

Returns: bool True if successful, otherwise False

◆ disable_automatic_set_reset()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_automatic_set_reset ( self )

Disables automatic SET/RESET operations.

Returns: bool True if successful, otherwise False

◆ disable_continuous_mode()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_continuous_mode ( self )

Disables continuous mode.

Returns: bool True if successful, otherwise False

◆ disable_interrupt()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_interrupt ( self )

Disables interrupts.

Returns: bool True if successful, otherwise False

◆ disable_periodic_set()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_periodic_set ( self )

Disables periodic SET operations.

Returns: bool True if successful, otherwise False

◆ disable_x_channel()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_x_channel ( self )

Disables the X channel.

Returns: bool True if successful, otherwise False

◆ disable_yz_channels()

def qwiic_mmc5983ma.QwiicMMC5983MA.disable_yz_channels ( self )

Disables the Y and Z channels.

Returns: bool True if successful, otherwise False

◆ enable_3_wire_spi()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_3_wire_spi ( self )

Enables 3-wire SPI.

Returns: bool True if successful, otherwise False

◆ enable_automatic_set_reset()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_automatic_set_reset ( self )

Enables automatic SET/RESET operations, which needs to be done in conjuction with enable_periodic_set() and set_periodic_set_samples()

Returns: bool True if successful, otherwise False

◆ enable_continuous_mode()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_continuous_mode ( self )

Enables continuous mode.

Returns: bool True if successful, otherwise False

◆ enable_interrupt()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_interrupt ( self )

Enables interrupts.

Returns: bool True if successful, otherwise False

◆ enable_periodic_set()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_periodic_set ( self )

Enables periodic SET operations, which needs to be done in conjuction with enable_automatic_set_reset() and set_periodic_set_samples()

Returns: bool True if successful, otherwise False

◆ enable_x_channel()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_x_channel ( self )

Enables the X channel.

Returns: bool True if successful, otherwise False

◆ enable_yz_channels()

def qwiic_mmc5983ma.QwiicMMC5983MA.enable_yz_channels ( self )

Enables the Y and Z channels.

Returns: bool True if successful, otherwise False

◆ get_continuous_mode_frequency()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_continuous_mode_frequency ( self )

Gets the continuous mode frequency.

Returns: int Frequency in Hz

◆ get_filter_bandwidth()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_filter_bandwidth ( self )

Gets the filter bandwidth.

Returns: int Bandwidth in Hz

◆ get_measurement_x()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_x ( self )

Gets the raw x-axis measurement.

Returns: int Raw x-axis measurement, 18-bit unsigned integer

◆ get_measurement_x_gauss()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_x_gauss	(	self,
		offset = `None`,
		gain = `8`
	)

Gets the x-axis measurement in gauss.

Parameters

int,optional	offset: Offset to apply to the measurement, defaults to None, which will instead use stored offset
float,optional	gain: Gain to apply to the measurement, defaults to 8 (full scale range of the MMC5983MA)

Returns: float x-axis measurement in gauss

◆ get_measurement_xyz()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_xyz ( self )

Gets the raw x, y, and z-axis measurements.

Returns: tuple(int, int, int) Raw x, y, and z-axis measurements, 18-bit unsigned integers

◆ get_measurement_xyz_gauss()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_xyz_gauss	(	self,
		offsets = `None`,
		gains = `[8] * 3`
	)

Gets the x, y, and z-axis measurements in gauss.

Parameters

tuple(int,int,int),optional	offsets: Offsets to apply to the measurements, defaults to None, which will instead use stored offsets
list(float),optional	gains: Gains to apply to the measurements, defaults to 8 (full scale range of the MMC5983MA)

Returns: tuple(float, float, float) x, y, and z-axis measurements in gauss

◆ get_measurement_y()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_y ( self )

Gets the raw y-axis measurement.

Returns: int Raw y-axis measurement, 18-bit unsigned integer

◆ get_measurement_y_gauss()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_y_gauss	(	self,
		offset = `None`,
		gain = `8`
	)

Gets the y-axis measurement in gauss.

Parameters

int,optional	offset: Offset to apply to the measurement, defaults to None, which will instead use stored offset
float,optional	gain: Gain to apply to the measurement, defaults to 8 (full scale range of the MMC5983MA)

Returns: float y-axis measurement in gauss

◆ get_measurement_z()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_z ( self )

Gets the raw z-axis measurement.

Returns: int Raw z-axis measurement, 18-bit unsigned integer

◆ get_measurement_z_gauss()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_measurement_z_gauss	(	self,
		offset = `None`,
		gain = `8`
	)

Gets the z-axis measurement in gauss.

Parameters

int,optional	offset: Offset to apply to the measurement, defaults to None, which will instead use stored offset
float,optional	gain: Gain to apply to the measurement, defaults to 8 (full scale range of the MMC5983MA)

Returns: float z-axis measurement in gauss

◆ get_offsets()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_offsets ( self )

Gets the raw offsets for all axes.

Returns: tuple(int, int, int) Raw offsets for all axes

◆ get_periodic_set_samples()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_periodic_set_samples ( self )

Gets the number of samples between each SET operation when periodic SET operations are enabled.

Returns: int Number of samples between each SET operation

◆ get_temperature()

def qwiic_mmc5983ma.QwiicMMC5983MA.get_temperature ( self )

Gets the temperature in degrees Celsius.

Returns: float Temperature in degrees Celsius

◆ is_3_wire_spi_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_3_wire_spi_enabled ( self )

Checks if 3-wire SPI is enabled.

Returns: bool True if 3-wire SPI is enabled, otherwise False

◆ is_automatic_set_reset_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_automatic_set_reset_enabled ( self )

Checks if automatic SET/RESET operations are enabled.

Returns: bool True if enabled, otherwise False

◆ is_bit_set()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_bit_set	(	self,
		register_address,
		bit_mask
	)

Checks if a bit is set in a register.

Parameters

int	register_address: Register address
int	bit_mask: Bit mask

Returns: bool True if bit is set, otherwise False

◆ is_connected()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_connected ( self )

Determines if this device is connected.

Returns: bool True if connected, otherwise False

◆ is_continuous_mode_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_continuous_mode_enabled ( self )

Checks if continuous mode is enabled.

Returns: bool True if enabled, otherwise False

◆ is_extra_current_applied_neg_to_pos()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_extra_current_applied_neg_to_pos ( self )

Checks if extra current is applied "reverse" through the coils.

Returns: bool True if extra current is applied, otherwise False

◆ is_extra_current_applied_pos_to_neg()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_extra_current_applied_pos_to_neg ( self )

Checks if extra current is applied "forward" through the coils.

Returns: bool True if extra current is applied, otherwise False

◆ is_interrupt_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_interrupt_enabled ( self )

Checks if interrupts are enabled.

Returns: bool True if interrupts are enabled, otherwise False

◆ is_periodic_set_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_periodic_set_enabled ( self )

Checks if periodic SET operations are enabled.

Returns: bool True if enabled, otherwise False

◆ is_shadow_bit_set()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_shadow_bit_set	(	self,
		register_address,
		bit_mask
	)

Checks if a bit is set in the shadow register.

Parameters

int	register_address: Register address
int	bit_mask: Bit mask

Returns: bool True if bit is set, otherwise False

◆ is_x_channel_enabled()

def qwiic_mmc5983ma.QwiicMMC5983MA.is_x_channel_enabled ( self )

Checks if the X channel is enabled.

Returns: bool True if enabled, otherwise False

◆ perform_reset_operation()

def qwiic_mmc5983ma.QwiicMMC5983MA.perform_reset_operation ( self )

Performs a RESET operation.

This resets the internal magnetization using coils built into the MMC5983MA, which can be used to degauss the sensor after it has been exposed to a strong magnetic field, or to compute the offset of each axis in conjuction with the SET operation.

Returns: bool True if successful, otherwise False

◆ perform_set_operation()

def qwiic_mmc5983ma.QwiicMMC5983MA.perform_set_operation ( self )

Performs a SET operation.

This sets the internal magnetization using coils built into the MMC5983MA, which can be used to degauss the sensor after it has been exposed to a strong magnetic field, or to compute the offset of each axis in conjuction with the RESET operation.

Returns: bool True if successful, otherwise False

◆ read_fields_xyz()

def qwiic_mmc5983ma.QwiicMMC5983MA.read_fields_xyz ( self )

Internal function to get the raw x, y, and z-axis measurements, should not be called directly.

Returns: tuple(int, int, int) Raw x, y, and z-axis measurements, 18-bit unsigned integers

◆ remove_extra_current_neg_to_pos()

def qwiic_mmc5983ma.QwiicMMC5983MA.remove_extra_current_neg_to_pos ( self )

Removes extra current "reverse" through the coils.

Returns: bool True if successful, otherwise False

◆ remove_extra_current_pos_to_neg()

def qwiic_mmc5983ma.QwiicMMC5983MA.remove_extra_current_pos_to_neg ( self )

Removes extra current "forward" through the coils.

Returns: bool True if successful, otherwise False

◆ set_continuous_mode_frequency()

def qwiic_mmc5983ma.QwiicMMC5983MA.set_continuous_mode_frequency	(	self,
		frequency
	)

Sets the continuous mode frequency.

Parameters

int	frequency: Frequency in Hz, can be 1, 10, 20, 50, 100, 200, or Pass 0 to disable continuous mode.

Returns: bool True if successful, otherwise False

◆ set_filter_bandwidth()

def qwiic_mmc5983ma.QwiicMMC5983MA.set_filter_bandwidth	(	self,
		bandwidth
	)

Sets the filter bandwidth.

Parameters

int	bandwidth: Bandwidth in Hz, can be 100, 200, 400, or 800

Returns: bool True if successful, otherwise False

◆ set_periodic_set_samples()

def qwiic_mmc5983ma.QwiicMMC5983MA.set_periodic_set_samples	(	self,
		number_of_samples
	)

Sets the number of samples between each SET operation when periodic SET operations are enabled.

Parameters

int	number_of_samples: Number of samples, can be 1, 25, 75, 100, 250, 500, 1000, or 2000

Returns: bool True if successful, otherwise False

◆ set_register_bit()

def qwiic_mmc5983ma.QwiicMMC5983MA.set_register_bit	(	self,
		register_address,
		bit_mask
	)

Sets a bit in a register.

Parameters

int	register_address: Register address
int	bit_mask: Bit mask

◆ set_shadow_bit()

def qwiic_mmc5983ma.QwiicMMC5983MA.set_shadow_bit	(	self,
		register_address,
		bit_mask,
		do_write = `True`
	)

Sets a bit in the shadow register and optionally writes the value to the device.

Parameters

int	register_address: Register address
int	bit_mask: Bit mask
bool,optional	do_write: Whether to write the value to the device, defaults to True

Returns: bool True if successful, otherwise False

◆ soft_reset()

def qwiic_mmc5983ma.QwiicMMC5983MA.soft_reset ( self )

Performs a software reset.

Returns: bool True if successful, otherwise False

Member Data Documentation

◆ address

qwiic_mmc5983ma.QwiicMMC5983MA.address

◆ AUTO_SR_EN

tuple qwiic_mmc5983ma.QwiicMMC5983MA.AUTO_SR_EN = (1 << 5)

static

◆ available_addresses

qwiic_mmc5983ma.QwiicMMC5983MA.available_addresses = _AVAILABLE_I2C_ADDRESS

static

◆ BW0

tuple qwiic_mmc5983ma.QwiicMMC5983MA.BW0 = (1 << 0)

static

◆ BW1

tuple qwiic_mmc5983ma.QwiicMMC5983MA.BW1 = (1 << 1)

static

◆ CM_FREQ_0

tuple qwiic_mmc5983ma.QwiicMMC5983MA.CM_FREQ_0 = (1 << 0)

static

◆ CM_FREQ_1

tuple qwiic_mmc5983ma.QwiicMMC5983MA.CM_FREQ_1 = (1 << 1)

static

◆ CM_FREQ_2

tuple qwiic_mmc5983ma.QwiicMMC5983MA.CM_FREQ_2 = (1 << 2)

static

◆ CMM_EN

tuple qwiic_mmc5983ma.QwiicMMC5983MA.CMM_EN = (1 << 3)

static

◆ device_name

qwiic_mmc5983ma.QwiicMMC5983MA.device_name = _DEFAULT_NAME

static

◆ DUMMY

int qwiic_mmc5983ma.QwiicMMC5983MA.DUMMY = 0x0

static

◆ EN_PRD_SET

tuple qwiic_mmc5983ma.QwiicMMC5983MA.EN_PRD_SET = (1 << 7)

static

◆ I2C_ADDR

int qwiic_mmc5983ma.QwiicMMC5983MA.I2C_ADDR = 0x30

static

◆ INT_CTRL_0_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.INT_CTRL_0_REG = 0x09

static

◆ INT_CTRL_1_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.INT_CTRL_1_REG = 0x0a

static

◆ INT_CTRL_2_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.INT_CTRL_2_REG = 0x0b

static

◆ INT_CTRL_3_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.INT_CTRL_3_REG = 0x0c

static

◆ INT_MEAS_DONE_EN

tuple qwiic_mmc5983ma.QwiicMMC5983MA.INT_MEAS_DONE_EN = (1 << 2)

static

◆ MEAS_M_DONE

tuple qwiic_mmc5983ma.QwiicMMC5983MA.MEAS_M_DONE = (1 << 0)

static

◆ MEAS_T_DONE

tuple qwiic_mmc5983ma.QwiicMMC5983MA.MEAS_T_DONE = (1 << 1)

static

◆ memory_shadow

qwiic_mmc5983ma.QwiicMMC5983MA.memory_shadow

◆ OTP_READ

tuple qwiic_mmc5983ma.QwiicMMC5983MA.OTP_READ = (1 << 6)

static

◆ OTP_READ_DONE

tuple qwiic_mmc5983ma.QwiicMMC5983MA.OTP_READ_DONE = (1 << 4)

static

◆ PRD_SET_0

tuple qwiic_mmc5983ma.QwiicMMC5983MA.PRD_SET_0 = (1 << 4)

static

◆ PRD_SET_1

tuple qwiic_mmc5983ma.QwiicMMC5983MA.PRD_SET_1 = (1 << 5)

static

◆ PRD_SET_2

tuple qwiic_mmc5983ma.QwiicMMC5983MA.PRD_SET_2 = (1 << 6)

static

◆ PROD_ID

int qwiic_mmc5983ma.QwiicMMC5983MA.PROD_ID = 0x30

static

◆ PROD_ID_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.PROD_ID_REG = 0x2f

static

◆ RESET_OPERATION

tuple qwiic_mmc5983ma.QwiicMMC5983MA.RESET_OPERATION = (1 << 4)

static

◆ SET_OPERATION

tuple qwiic_mmc5983ma.QwiicMMC5983MA.SET_OPERATION = (1 << 3)

static

◆ SPI_3W

tuple qwiic_mmc5983ma.QwiicMMC5983MA.SPI_3W = (1 << 6)

static

◆ ST_ENM

tuple qwiic_mmc5983ma.QwiicMMC5983MA.ST_ENM = (1 << 2)

static

◆ ST_ENP

tuple qwiic_mmc5983ma.QwiicMMC5983MA.ST_ENP = (1 << 1)

static

◆ STATUS_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.STATUS_REG = 0x08

static

◆ SW_RST

tuple qwiic_mmc5983ma.QwiicMMC5983MA.SW_RST = (1 << 7)

static

◆ T_OUT_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.T_OUT_REG = 0x07

static

◆ TM_M

tuple qwiic_mmc5983ma.QwiicMMC5983MA.TM_M = (1 << 0)

static

◆ TM_T

tuple qwiic_mmc5983ma.QwiicMMC5983MA.TM_T = (1 << 1)

static

◆ X2_MASK

tuple qwiic_mmc5983ma.QwiicMMC5983MA.X2_MASK = (3 << 6)

static

◆ X_INHIBIT

tuple qwiic_mmc5983ma.QwiicMMC5983MA.X_INHIBIT = (1 << 2)

static

◆ x_offset

qwiic_mmc5983ma.QwiicMMC5983MA.x_offset

◆ X_OUT_0_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.X_OUT_0_REG = 0x0

static

◆ X_OUT_1_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.X_OUT_1_REG = 0x01

static

◆ XYZ_0_SHIFT

int qwiic_mmc5983ma.QwiicMMC5983MA.XYZ_0_SHIFT = 10

static

◆ XYZ_1_SHIFT

int qwiic_mmc5983ma.QwiicMMC5983MA.XYZ_1_SHIFT = 2

static

◆ XYZ_OUT_2_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.XYZ_OUT_2_REG = 0x06

static

◆ Y2_MASK

tuple qwiic_mmc5983ma.QwiicMMC5983MA.Y2_MASK = (3 << 4)

static

◆ y_offset

qwiic_mmc5983ma.QwiicMMC5983MA.y_offset

◆ Y_OUT_0_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.Y_OUT_0_REG = 0x02

static

◆ Y_OUT_1_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.Y_OUT_1_REG = 0x03

static

◆ YZ_INHIBIT

tuple qwiic_mmc5983ma.QwiicMMC5983MA.YZ_INHIBIT = (3 << 3)

static

◆ Z2_MASK

tuple qwiic_mmc5983ma.QwiicMMC5983MA.Z2_MASK = (3 << 2)

static

◆ z_offset

qwiic_mmc5983ma.QwiicMMC5983MA.z_offset

◆ Z_OUT_0_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.Z_OUT_0_REG = 0x04

static

◆ Z_OUT_1_REG

int qwiic_mmc5983ma.QwiicMMC5983MA.Z_OUT_1_REG = 0x05

static

Property Documentation

◆ connected

qwiic_mmc5983ma.QwiicMMC5983MA.connected = property(is_connected)

static

The documentation for this class was generated from the following file:

qwiic_mmc5983ma.py

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ apply_extra_current_neg_to_pos()

◆ apply_extra_current_pos_to_neg()

◆ are_yz_channels_enabled()

◆ begin()

◆ calibrate_offsets()

◆ clear_meas_done_interrupt()

◆ clear_shadow_bit()

◆ disable_3_wire_spi()

◆ disable_automatic_set_reset()

◆ disable_continuous_mode()

◆ disable_interrupt()

◆ disable_periodic_set()

◆ disable_x_channel()

◆ disable_yz_channels()

◆ enable_3_wire_spi()

◆ enable_automatic_set_reset()

◆ enable_continuous_mode()

◆ enable_interrupt()

◆ enable_periodic_set()

◆ enable_x_channel()

◆ enable_yz_channels()

◆ get_continuous_mode_frequency()

◆ get_filter_bandwidth()

◆ get_measurement_x()

◆ get_measurement_x_gauss()

◆ get_measurement_xyz()

◆ get_measurement_xyz_gauss()

◆ get_measurement_y()

◆ get_measurement_y_gauss()

◆ get_measurement_z()

◆ get_measurement_z_gauss()

◆ get_offsets()

◆ get_periodic_set_samples()

◆ get_temperature()

◆ is_3_wire_spi_enabled()

◆ is_automatic_set_reset_enabled()

◆ is_bit_set()

◆ is_connected()

◆ is_continuous_mode_enabled()

◆ is_extra_current_applied_neg_to_pos()

◆ is_extra_current_applied_pos_to_neg()

◆ is_interrupt_enabled()

◆ is_periodic_set_enabled()

◆ is_shadow_bit_set()

◆ is_x_channel_enabled()

◆ perform_reset_operation()

◆ perform_set_operation()

◆ read_fields_xyz()

◆ remove_extra_current_neg_to_pos()

◆ remove_extra_current_pos_to_neg()

◆ set_continuous_mode_frequency()

◆ set_filter_bandwidth()

◆ set_periodic_set_samples()

◆ set_register_bit()

◆ set_shadow_bit()

◆ soft_reset()

Member Data Documentation

◆ address

◆ AUTO_SR_EN

◆ available_addresses

◆ BW0

◆ BW1

◆ CM_FREQ_0

◆ CM_FREQ_1

◆ CM_FREQ_2

◆ CMM_EN

◆ device_name

◆ DUMMY

◆ EN_PRD_SET

◆ I2C_ADDR

◆ INT_CTRL_0_REG

◆ INT_CTRL_1_REG

◆ init()