View source for Component: Accel / Mag 6-Axis (EBM015) (EBM Modules)

From Flowcode Help

← Component: Accel / Mag 6-Axis (EBM015) (EBM Modules)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 2.0 |- | width="20%" style="color:gray;" | Category | EBM Modules |} ==Accel / Mag 6-Axis component== EBM015 Combined 6-Axis Accelerometer and Magnetometer sensors Useful for working out data such as Pitch and Yaw. ==Component Source Code== Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM015v1_Magnetometer.fcfx FC_Comp_Source_EBM015v1_Magnetometer.fcfx] Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM015v1_Magnetometer.fcfx FC_Comp_Source_EBM015v1_Magnetometer.fcfx] ==Detailed description== ''No detailed description exists yet for this component'' ==Examples== Sample program using the EBM015 - Magnetometer sensor. Reads either the accelerometer or compass data and displays on the LCD. {{Fcfile|EBM015 - Test Program.fcfx|EBM015 Example}} ==Macro reference== ===CollectXYZData=== {| 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;" | '''CollectXYZData''' |- | colspan="2" | Collect the data from the local accelerometer buffers. The Axis parameter specifies the Axis to be read. 0 / 'x' / 'X' - X axis 1 / 'y' / 'Y' - Y axis 2 / 'z' / 'Z' - Z axis  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Axis |- | colspan="2" |   |- | 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'' |} ===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" | Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.  |- |- | 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'' |} ===SimReset1G=== {| 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;" | '''SimReset1G''' |- | 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'' |} ===SimSetAccelerometer=== {| 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;" | '''SimSetAccelerometer''' |- | colspan="2" | Allows the XYZ slider values to be set via the simulation  |- |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | X |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | Y |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | Z |- | 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'' |} ===SimSetCompass=== {| 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;" | '''SimSetCompass''' |- | colspan="2" | Allows the XYZ slider values to be set via the simulation  |- |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | X |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | Y |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | Z |- | 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'' |} ===UpdateAccelerometerData=== {| 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;" | '''UpdateAccelerometerData''' |- | colspan="2" | Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data  |- |- | 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'' |} ===UpdateCompassData=== {| 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;" | '''UpdateCompassData''' |- | colspan="2" | Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data  |- |- | 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'' |} ==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;" | Sensor Options |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Power Mode |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Accel Data Rate |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Accel Scale |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Compass Data Rate |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Compass Scale |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Comms Mode |- | colspan="2" | Specifies the communications mode. Interrupt - Wait for the interrupt pin to go high before allowing new data to be sampled. Polling - New data is sampled without needing to check the interrupt pin.  |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Bit Depth |- | colspan="2" |   |- | 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-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" | [[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-5-icon.png]] | width="90%" | SCL |- | colspan="2" | Pin used for SCL (clock signal)  |- | 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-5-icon.png]] | width="90%" | Interrupt Pin |- | colspan="2" |   |- | 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-16-icon.png]] | width="90%" | Simulate Comms |- | colspan="2" | Controls how the simulation data is generated, via the component GUI or via a I2C injector.  |}

Return to Component: Accel / Mag 6-Axis (EBM015) (EBM Modules).