Component: Gyroscope (EBM009) (EBM Modules)
| 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.
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.
Downloadable macro reference
|
GetZ |
| Returns the previously sampled Z axis data | |
| [[File:]] - | Return |
|
|
GetY |
| Returns the previously sampled Y axis data | |
| [[File:]] - | Return |
|
|
GetX |
| Returns the previously sampled X axis data | |
| [[File:]] - | 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 |
|
|
Initialise |
| Set up the thermocouple sensor ready for use. | |
 - VOID
|
Return |
|
|
Initialise |
| Initialise the sensor configuration as set by the component properties | |
| - VOID
|
Return |
|
|
Initialise |
| Stes up the I2C bus and initialises the termperature sensor ready for use. | |
| - VOID
|
Return |
|
|
SimSetGyro |
| Allows the XYZ slider values to be set via the simulation | |
| [[File:]] - | X |
| [[File:]] - | Y |
| [[File:]] - | Z |
| - VOID
|
Return |
|
|
UpdateAccelerometerData |
| Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data | |
| - BYTE
|
Return |
|
|
SimSetCompass |
| Allows the XYZ slider values to be set via the simulation | |
| [[File:]] - | X |
| [[File:]] - | Y |
| [[File:]] - | Z |
| - VOID
|
Return |
|
|
Read_Bearing |
| Reads the current sensor compass bearing based on degrees CW from magnetic north. Returns 0-359 where 0 = North, 90 = East, 180 = South, 270 = West Requires the ArcTan floating point function to be available to work correctly. Supported on AVR, 16-bit | |
| - BYTE
|
NumSamples |
| The number of readings to base the bearing on | |
 - UINT
|
Return |
|
|
Initialise |
| Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail. | |
| - BYTE
|
Return |
|
|
IOSetOutputPin |
| Sets the selected digital pin to an output and assigns the output state. | |
| - BYTE
|
Pin |
| Range: 0-29 | |
| [[File:]] - | State |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
UARTReceive |
| Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available. | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - UART Bus Count - 1 | |
| - BYTE
|
Return |
|
|
ADCSampleAverage10 |
| Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples | |
| - BYTE
|
ADCChannel |
| Range: 0, 3-7 | |
| - BYTE
|
SampleCount |
| Range: 1- 100 | |
| - BYTE
|
SampleDelay |
| Delay in us between each sample | |
| - UINT
|
Return |
|
|
OneWireScanBus |
| Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found. | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
Return |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - SPI Bus Count - 1 | |
| - VOID
|
Return |
|
|
OneWireReceiveByte |
| Receives a byte from the one wire bus a bit at a time | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
Return |
|
|
I2CSend |
| Transmit a byte using the I2C bus | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
DataOut |
| [[File:]] - | Return |
|
|
UARTSend |
| Send a byte via the UART module | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - UART Bus Count - 1 | |
| - BYTE
|
Data |
| Data Byte to send. Range: 0-255 | |
| - VOID
|
Return |
|
|
OneWireGetDeviceCount |
| Returns the number of devices found by the last ScanBus operation. | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
Return |
|
|
PWMSetPrescaler |
| Sets the prescaler for the PWM output | |
| - BYTE
|
Channel |
| Range: 0 - 11 | |
| - BYTE
|
Prescaler |
| - BYTE
|
Period |
| - VOID
|
Return |
|
|
PWMEnable |
| Enable a PWM output | |
| - BYTE
|
Channel |
| Range: 0-11 | |
| - VOID
|
Return |
|
|
ADCSampleArray10 |
| Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet | |
| - BYTE
|
ADCChannel |
| Range: 0, 3-7 | |
| - BYTE
|
SampleCount |
| Range: 1- 32 | |
| - UINT
|
SampleDelay |
| Delay in us between each sample | |
| - UINT
|
Samples |
| 10-bit samples returned from the function | |
| - VOID
|
Return |
|
|
ADCSampleAverage8 |
| Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples | |
| - BYTE
|
ADCChannel |
| Range: 0, 3-7 | |
| - BYTE
|
SampleCount |
| Range: 1- 100 | |
| - BYTE
|
SampleDelay |
| Delay in us between each sample | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the comms to the Arduino board ready for commands to be sent. | |
| - VOID
|
Return |
|
|
PWMEnable |
| Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD | |
| - BYTE
|
EnableMask |
| Range 0-63 or 0b00000 to 0b111111 | |
| - VOID
|
Return |
|
|
Initialise |
| - VOID
|
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 |
|
|
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. | |
|
|
Scope Traces |
| 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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
API |
|
Connections |
|
|
Simulations |
|
|
Simulate Comms |