Difference between revisions of "Component: Gyroscope (EBM009) (EBM Modules)"

Latest revision as of 13:09, 7 February 2023

Author	Matrix TSL
Version	2.0
Category	EBM Modules

Gyroscope component

Interface to the L3G4200D three axis digital gyroscope. Panel GUI can be used to simulate incoming data for testing.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_EBM009v1.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_EBM009v1.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Sample program demonstrating the EBM009 Gyroscope Sensor.

The program plots X, Y and Z data onto the LCD screen.

EBM009 Example

Macro reference

GetX

	GetX
Returns the previously sampled X axis data
- INT	Return

GetY

	GetY
Returns the previously sampled Y axis data
- INT	Return

GetZ

	GetZ
Returns the previously sampled Z axis data
- INT	Return

Initialise

	Initialise
Initialise the component. Returns 0 if successful
- BYTE	Return

ReadRegister

	ReadRegister
Read the data byte at the given address of the device
- BYTE	Reg
address of the register to be read
- BYTE	Return

SampleDevice

	SampleDevice
Reads the Axis data from the device. Returns 0 if successful
- BYTE	Return

WriteRegister

	WriteRegister
Writes the data byte to the given address of the device. Returns 0 if successful
- BYTE	Reg
address of register to be written with data byte
- BYTE	data
data byte to be written to device register
- BYTE	Return

Property reference

	Properties
	Output Data Rate

	Full Scale Selection
Specifies the maximum angular speed which the sensor can measure in degrees per second
	X Axis

	Y Axis

	Z Axis

	Label

	Connection
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin

	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin

	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
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.
	Simulation
	Simulate Comms

@@ Line 78: / Line 78: @@
 {{Fcfile|EBM009 - Test Program.fcfx|EBM009 Example}}
@@ Line 86: / Line 92: @@
 ==Macro reference==
-===GetZ===
+===GetX===
 {| 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;" | '''GetZ'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetX'''
 |-
-| colspan="2" | Returns the previously sampled Z axis data&nbsp;
+| colspan="2" | Returns the previously sampled X axis data&nbsp;
 |-
 |-
@@ Line 114: / Line 120: @@
-===GetX===
+===GetZ===
 {| 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;" | '''GetX'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetZ'''
 |-
-| colspan="2" | Returns the previously sampled X axis data&nbsp;
+| colspan="2" | Returns the previously sampled Z axis data&nbsp;
 |-
 |-
@@ Line 128: / Line 134: @@
-===SampleDevice===
+===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;" | '''SampleDevice'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Reads the Axis data from the device. Returns 0 if successful&nbsp;
+| colspan="2" | Initialise the component. Returns 0 if successful&nbsp;
 |-
 |-
@@ Line 155: / Line 161: @@
 |-
 | colspan="2" | address of the register to be read&nbsp;
+|-
+| 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''
+|}
+===SampleDevice===
+{| 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;" | '''SampleDevice'''
+|-
+| colspan="2" | Reads the Axis data from the device. Returns 0 if successful&nbsp;
+|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 183: / Line 203: @@
 | 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" | Initialise the component. Returns 0 if successful&nbsp;
-|-
-|-
-| 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''
-|}

Difference between revisions of "Component: Gyroscope (EBM009) (EBM Modules)"

Latest revision as of 13:09, 7 February 2023

Contents