Component: Magnetometer (BMM150) (Environmental) - Revision history

SteveT: Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""

2026-07-13T14:37:00Z

Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""

← Older revision		Revision as of 14:37, 13 July 2026
Line 172:		Line 172:
	\|-		\|-
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#EAE1EA;~~" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" class="mtx-class-propfolder" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" class="mtx-class-propfolder" \| Component Properties		\| width="90%" class="mtx-class-propfolder" \| Component Properties
	\|-		\|-
Line 186:		Line 186:
	\| colspan="2" \| Sets the default preset for the module. Can be overridden by calling the SetPresetMode component macro.		\| colspan="2" \| Sets the default preset for the module. Can be overridden by calling the SetPresetMode component macro.
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#EAE1EA;~~" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" class="mtx-class-propfolder" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" class="mtx-class-propfolder" \| I2C Properties		\| width="90%" class="mtx-class-propfolder" \| I2C Properties
	\|-		\|-
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#EAE1EA;~~" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" class="mtx-class-propfolder" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" class="mtx-class-propfolder" \| Connections		\| width="90%" class="mtx-class-propfolder" \| Connections
	\|-		\|-
Line 219:		Line 219:
	\| colspan="2" \|		\| colspan="2" \|
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#EAE1EA;~~" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" class="mtx-class-propfolder" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" class="mtx-class-propfolder" \| Options		\| width="90%" class="mtx-class-propfolder" \| Options
	\|-		\|-
Line 238:		Line 238:
	\| colspan="2" \| Baud rate to be used		\| colspan="2" \| Baud rate to be used
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#EAE1EA;~~" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" class="mtx-class-propfolder" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" class="mtx-class-propfolder" \| Simulation		\| width="90%" class="mtx-class-propfolder" \| Simulation
	\|-		\|-

SteveT: Text replacement - "style="background-color:#EAE1EA; color:#4B008D;"" to "class="mtx-class-propfolder""

2026-07-13T14:35:48Z

Text replacement - "style="background-color:#EAE1EA; color:#4B008D;"" to "class="mtx-class-propfolder""

← Older revision		Revision as of 14:35, 13 July 2026
Line 173:		Line 173:
	\|-		\|-
	\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#EAE1EA; color:#4B008D;~~" \| Component Properties		\| width="90%" class="mtx-class-propfolder" \| Component Properties
	\|-		\|-
	\|-		\|-
Line 187:		Line 187:
	\|-		\|-
	\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#EAE1EA; color:#4B008D;~~" \| I2C Properties		\| width="90%" class="mtx-class-propfolder" \| I2C Properties
	\|-		\|-
	\|-		\|-
	\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#EAE1EA; color:#4B008D;~~" \| Connections		\| width="90%" class="mtx-class-propfolder" \| Connections
	\|-		\|-
	\|-		\|-
Line 220:		Line 220:
	\|-		\|-
	\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#EAE1EA; color:#4B008D;~~" \| Options		\| width="90%" class="mtx-class-propfolder" \| Options
	\|-		\|-
	\|-		\|-
Line 239:		Line 239:
	\|-		\|-
	\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]		\| width="10%" align="center" style="background-color:#EAE1EA;" \| [[File:Fc9-conn-icon.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#EAE1EA; color:#4B008D;~~" \| Simulation		\| width="90%" class="mtx-class-propfolder" \| Simulation
	\|-		\|-
	\|-		\|-

SteveT: Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""

2026-07-13T14:23:43Z

Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""

← Older revision		Revision as of 14:23, 13 July 2026
Line 35:		Line 35:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''Initialise'''		\| width="90%" class="mtx-class-macrohead" \| '''Initialise'''
	\|-		\|-
	\| colspan="2" \| Startup communications to the sensor module. Puts the device into normal operating and preset modes. Returns 1 if module found and communicating.		\| colspan="2" \| Startup communications to the sensor module. Puts the device into normal operating and preset modes. Returns 1 if module found and communicating.
Line 49:		Line 49:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''ReadRegister'''		\| width="90%" class="mtx-class-macrohead" \| '''ReadRegister'''
	\|-		\|-
	\| colspan="2" \| A simple example showing a generic way to read a register using I2C.		\| colspan="2" \| A simple example showing a generic way to read a register using I2C.
Line 68:		Line 68:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''ReadSample'''		\| width="90%" class="mtx-class-macrohead" \| '''ReadSample'''
	\|-		\|-
	\| colspan="2" \| Collect a sample fromt he last SampleMag operation		\| colspan="2" \| Collect a sample fromt he last SampleMag operation
Line 87:		Line 87:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''SampleMagData'''		\| width="90%" class="mtx-class-macrohead" \| '''SampleMagData'''
	\|-		\|-
	\| colspan="2" \| Samples the magnetometer and processes the data ready to be read out using the read sample macro.		\| colspan="2" \| Samples the magnetometer and processes the data ready to be read out using the read sample macro.
Line 106:		Line 106:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''SetOperatingMode'''		\| width="90%" class="mtx-class-macrohead" \| '''SetOperatingMode'''
	\|-		\|-
	\| colspan="2" \| Select the operating mode and power level used by the device		\| colspan="2" \| Select the operating mode and power level used by the device
Line 125:		Line 125:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''SetPresetMode'''		\| width="90%" class="mtx-class-macrohead" \| '''SetPresetMode'''
	\|-		\|-
	\| colspan="2" \| Controls the device sample rate and accuracy		\| colspan="2" \| Controls the device sample rate and accuracy
Line 144:		Line 144:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''WriteRegister'''		\| width="90%" class="mtx-class-macrohead" \| '''WriteRegister'''
	\|-		\|-
	\| colspan="2" \| A simple example showing a generic way to write a register using I2C.		\| colspan="2" \| A simple example showing a generic way to write a register using I2C.
Line 169:		Line 169:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-prop-icon.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-prop-icon.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''Properties'''		\| width="90%" class="mtx-class-macrohead" \| '''Properties'''
	\|-		\|-
	\|-		\|-

SteveT: Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;"" to "width="10%" align="center" class="mtx-class-macrohead""

2026-07-13T14:21:21Z

Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;"" to "width="10%" align="center" class="mtx-class-macrohead""

← Older revision		Revision as of 14:21, 13 July 2026
Line 168:		Line 168:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;~~" \| [[File:Fc9-prop-icon.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-prop-icon.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''Properties'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''Properties'''
	\|-		\|-

SteveT: Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead""

2026-07-13T14:17:08Z

Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead""

← Older revision		Revision as of 14:17, 13 July 2026
Line 34:		Line 34:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''Initialise'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''Initialise'''
	\|-		\|-
Line 48:		Line 48:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''ReadRegister'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''ReadRegister'''
	\|-		\|-
Line 67:		Line 67:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''ReadSample'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''ReadSample'''
	\|-		\|-
Line 86:		Line 86:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''SampleMagData'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''SampleMagData'''
	\|-		\|-
Line 105:		Line 105:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''SetOperatingMode'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''SetOperatingMode'''
	\|-		\|-
Line 124:		Line 124:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''SetPresetMode'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''SetPresetMode'''
	\|-		\|-
Line 143:		Line 143:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''WriteRegister'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''WriteRegister'''
	\|-		\|-

SteveT: Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable""

2026-07-13T14:15:54Z

Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable""

← Older revision		Revision as of 14:15, 13 July 2026
Line 32:		Line 32:

	===Initialise===		===Initialise===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 46:		Line 46:

	===ReadRegister===		===ReadRegister===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 65:		Line 65:

	===ReadSample===		===ReadSample===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 84:		Line 84:

	===SampleMagData===		===SampleMagData===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 103:		Line 103:

	===SetOperatingMode===		===SetOperatingMode===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 122:		Line 122:

	===SetPresetMode===		===SetPresetMode===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 141:		Line 141:

	===WriteRegister===		===WriteRegister===
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]
Line 166:		Line 166:
	==Property reference==		==Property reference==

	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" \| [[File:Fc9-prop-icon.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" \| [[File:Fc9-prop-icon.png]]

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;..."

2023-10-20T10:26:49Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Environmental
|}

==Magnetometer (BMM150) component==
A low-power, low-noise 3-axis digital geomagnetic sensor that perfectly matches the requirements of compass applications.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Magnetometer_BMM150.fcfx FC_Comp_Source_Magnetometer_BMM150.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Magnetometer_BMM150.fcfx FC_Comp_Source_Magnetometer_BMM150.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''<span style="color:red;">No additional examples</span>''

==Macro reference==

===Initialise===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
|-
| colspan="2" | Startup communications to the sensor module. Puts the device into normal operating and preset modes. Returns 1 if module found and communicating. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadRegister===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRegister'''
|-
| colspan="2" | A simple example showing a generic way to read a register using I2C. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadSample===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadSample'''
|-
| colspan="2" | Collect a sample fromt he last SampleMag operation 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Axis
|-
| colspan="2" | 0=X, 1=Y, 2=Z 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleMagData===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SampleMagData'''
|-
| colspan="2" | Samples the magnetometer and processes the data ready to be read out using the read sample macro. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | ApplyTrim
|-
| colspan="2" | 0=ReadRawValues, 1=ApplyCalibrationTrim 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetOperatingMode===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOperatingMode'''
|-
| colspan="2" | Select the operating mode and power level used by the device 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | 0=Normal, 1=Forced, 3=Sleep, 4=Suspend 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetPresetMode===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPresetMode'''
|-
| colspan="2" | Controls the device sample rate and accuracy 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | 0=LowPower, 1=Normal, 2=HighAccuracy, 3=Enhanced 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===WriteRegister===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRegister'''
|-
| colspan="2" | A simple example showing a generic way to write a register using I2C. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Component Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Device Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Preset
|-
| colspan="2" | Sets the default preset for the module. Can be overridden by calling the SetPresetMode component macro. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | I2C Properties
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | Channel selection 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SDA
|-
| colspan="2" | Pin used for SDA (data signal) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | SDA Remap Pin
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SCL
|-
| colspan="2" | Pin used for SCL (clock signal) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | SCL Remap Pin
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Options
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Stop Delay
|-
| colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Select
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" | Baud rate to be used 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulate Comms
|-
| colspan="2" |  
|}