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

Latest revision as of 17:23, 9 November 2022

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 Pack

SENSORS

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

Downloadable macro reference

	GetZ
Returns the previously sampled Z axis data
- INT	Return

	GetY
Returns the previously sampled Y axis data
- INT	Return

	GetX
Returns the previously sampled X axis data
- INT	Return

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

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

	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

	Initialise
Initialise the component. Returns 0 if successful
- 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

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

Latest revision as of 17:23, 9 November 2022

Contents

Gyroscope component

Component Pack

Detailed description

Examples

Downloadable macro reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | Matrix TSL
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 2.0 (Release)
+| 2.0
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | Category
 | EBM Modules
 |}
+==Gyroscope component==
+Interface to the L3G4200D three axis digital gyroscope.  Panel GUI can be used to simulate incoming data for testing.
-==[[File:Component Icon 7b1edf74_d0c8_4b1d_a8b3_54580ed79f64.png|Image]] Gyroscope (EBM009) component==
+==Component Pack==
-Interface to the L3G4200D three axis digital gyroscope.  Panel GUI can be used to simulate
-incoming data for testing.
-==Examples==
+SENSORS
-''<span style="color:red;">No additional examples</span>''
+==Detailed description==
-==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>GetZ</tt></u></span>===
-Returns the previously sampled Z axis data
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|INT]]
-===<span style="font-weight: normal;"><u><tt>GetY</tt></u></span>===
-Returns the previously sampled Y axis data
-'''Parameters'''
-:''This macro has no parameters''
+''No detailed description exists yet for this component''
+==Examples==
-'''Return value'''
-:[[Variable Types|INT]]
-===<span style="font-weight: normal;"><u><tt>GetX</tt></u></span>===
-Returns the previously sampled X axis data
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|INT]]
-===<span style="font-weight: normal;"><u><tt>SampleDevice</tt></u></span>===
-Reads the Axis data from the device. Returns 0 if successful
-'''Parameters'''
-:''This macro has no parameters''
+Sample program demonstrating the EBM009 Gyroscope Sensor.
+The program plots X, Y and Z data onto the LCD screen.
-'''Return value'''
+{{Fcfile|EBM009 - Test Program.fcfx|EBM009 Example}}
-:[[Variable Types|BYTE]]
+==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>ReadRegister</tt></u></span>===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Read the data byte at the given address of the device
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetZ'''
+|-
+| colspan="2" | Returns the previously sampled Z axis data&nbsp;
+|-
+|-
+| 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''
+|}
-'''Parameters'''
-:[[Variable Types|BYTE]] ''address''
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-::address of the register to be read
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetY'''
+|-
+| colspan="2" | Returns the previously sampled Y axis data&nbsp;
+|-
+|-
+| 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''
+|}
-'''Return value'''
+{| 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'''
+|-
+| colspan="2" | Returns the previously sampled X axis data&nbsp;
+|-
+|-
+| 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''
+|}
-:[[Variable Types|BYTE]]
+{| 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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===<span style="font-weight: normal;"><u><tt>WriteRegister</tt></u></span>===
-Writes the data byte to the given address of the device.
-Returns 0 if successful
+{| 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" | Read the data byte at the given address of the device&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Reg
+|-
+| 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''
+|}
-'''Parameters'''
-:[[Variable Types|BYTE]] ''address''
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-::address of register to be written with data byte
+|-
+| 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" | Writes the data byte to the given address of the device. Returns 0 if successful&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Reg
+|-
+| colspan="2" | address of register to be written with data byte&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | data
+|-
+| colspan="2" | data byte to be written to device register&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''
+|}
-:[[Variable Types|BYTE]] ''data''
-::data byte to be written to device register
-'''Return value'''
-:[[Variable Types|BYTE]]
-===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
-Initialise the component.
-Returns 0 if successful
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|BYTE]]
+{| 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''
+|}
-==Simulation macro reference==
-''This component does not contain any simulation macros''
 ==Property reference==
-<span style="font-weight: normal;"><u>Output Data Rate</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ODR''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
-<span style="font-weight: normal;"><u>Full Scale Selection</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Output Data Rate
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''FSS''.
+|-
+| colspan="2" | &nbsp;
-Specifies the maximum angular speed which the sensor can measure in degrees per second
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-<span style="font-weight: normal;"><u>X Axis</u></span>
+| width="90%" | Full Scale Selection
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''XEN''.
+| colspan="2" | Specifies the maximum angular speed which the sensor can measure in degrees per second&nbsp;
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | X Axis
+|-
+| colspan="2" | &nbsp;
-<span style="font-weight: normal;"><u>Y Axis</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''YEN''.
+| width="90%" | Y Axis
+|-
-''<span style="color:red;">No additional information</span>''
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Z Axis
-<span style="font-weight: normal;"><u>Z Axis</u></span>
+|-
+| colspan="2" | &nbsp;
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ZEN''.
+|-
+| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
-''<span style="color:red;">No additional information</span>''
+| width="90%" | Label
+|-
+| colspan="2" | &nbsp;
+|-
-<span style="font-weight: normal;"><u>Label</u></span>
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connection
-This property is of type ''Line of text'' and can be referenced with the variable name ''label_text''.
+|-
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Channel
+|-
+| colspan="2" | Channel selection&nbsp;
-<span style="font-weight: normal;"><u>Channel</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::CHANNEL''.
+| width="90%" | SDA
+|-
-Channel selection
+| colspan="2" | Pin used for SDA (data signal)&nbsp;
+|-
-<span style="font-weight: normal;"><u>SDA</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | SDA Remap Pin
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SDA''.
+|-
+| colspan="2" | &nbsp;
-Pin used for SDA (data signal)
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-<span style="font-weight: normal;"><u>SDA Remap Pin</u></span>
+| width="90%" | SCL
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::SDAPins''.
+| colspan="2" | Pin used for SCL (clock signal)&nbsp;
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | SCL Remap Pin
+|-
+| colspan="2" | &nbsp;
-<span style="font-weight: normal;"><u>SCL</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SCL''.
+| width="90%" | Baud Select
+|-
-Pin used for SCL (clock signal)
+| colspan="2" | Baud rate option selector&nbsp;
+|-
-<span style="font-weight: normal;"><u>SCL Remap Pin</u></span>
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Baud Rate
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::SCLPins''.
+|-
+| colspan="2" | Baud rate to be used&nbsp;
-''<span style="color:red;">No additional information</span>''
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Stop Delay
+|-
-<span style="font-weight: normal;"><u>Baud Select</u></span>
+| 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. &nbsp;
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::BAUD_LIST''.
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
-Baud rate option selector
+|-
+|-
-<span style="font-weight: normal;"><u>Baud Rate</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Simulate Comms
-This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_i2c1::BAUD''.
+|-
+| colspan="2" | &nbsp;
-Baud rate to be used
+|}
-<span style="font-weight: normal;"><u>Stop Delay</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::StopDel''.
-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.
-<span style="font-weight: normal;"><u>Simulation Type</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimType''.
-''<span style="color:red;">No additional information</span>''
-<span style="font-weight: normal;"><u>Scope Traces</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ScopeTraces''.
-Selects if the component pin connections are automatically generated on the data recorder window or not.
-Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion.
-No: Do not show the pin signals on the data recorder window.
-<span style="font-weight: normal;"><u>Console Data</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ConsoleData''.
-Selects if the console data is automatically generated or not
-<span style="font-weight: normal;"><u>Injector</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::Injector''.
-''<span style="color:red;">No additional information</span>''