Component: Gyroscope 3 Axis I2C (L3GD20) (Sensors)

From Flowcode Help
Jump to navigationJump to search


Author Matrix TSL
Version 1.0 (Release)
Category Sensors


Image Gyroscope 3_Axis I2C (L3GD20) component

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

Examples

No additional examples


Downloadable macro reference

GetZ

Returns the previously sampled Z axis data

Parameters

This macro has no parameters


Return value

INT


GetY

Returns the previously sampled Y axis data

Parameters

This macro has no parameters


Return value

INT


GetX

Returns the previously sampled X axis data

Parameters

This macro has no parameters


Return value

INT


SampleDevice

Reads the Axis data from the device. Returns 0 if successful

Parameters

This macro has no parameters


Return value

BYTE


ReadRegister

Read the data byte at the given address of the device

Parameters

BYTE address
address of the register to be read


Return value

BYTE


WriteRegister

Writes the data byte to the given address of the device.

Returns 0 if successful

Parameters

BYTE address
address of register to be written with data byte
BYTE data
data byte to be written to device register


Return value

BYTE


Initialise

Initialise the component.

Returns 0 if successful

Parameters

This macro has no parameters


Return value

BYTE


Simulation macro reference

This component does not contain any simulation macros


Property reference

Output Data Rate

This property is of type Fixed list of ints and can be referenced with the variable name ODR.

No additional information


Full Scale Selection

This property is of type Fixed list of ints and can be referenced with the variable name FSS.

Specifies the maximum angular speed which the sensor can measure in degrees per second

X Axis

This property is of type Fixed list of ints and can be referenced with the variable name XEN.

No additional information


Y Axis

This property is of type Fixed list of ints and can be referenced with the variable name YEN.

No additional information


Z Axis

This property is of type Fixed list of ints and can be referenced with the variable name ZEN.

No additional information


Label

This property is of type Line of text and can be referenced with the variable name label_text.

No additional information


Address Pin

This property is of type Unsigned integer and can be referenced with the variable name AdrPin.

The state of the SDO address pin.

0 = Connected to GND

1 = Connected to VCC

Channel

This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::CHANNEL.

Channel selection

SDA

This property is of type Single digital pin and can be referenced with the variable name cal_i2c1::SDA.

Pin used for SDA (data signal)

SCL

This property is of type Single digital pin and can be referenced with the variable name cal_i2c1::SCL.

Pin used for SCL (clock signal)

Baud Select

This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::BAUD_LIST.

Baud rate option selector

Baud Rate

This property is of type Signed integer and can be referenced with the variable name cal_i2c1::BAUD.

Baud rate to be used

Stop Delay

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.

Simulation Type

This property is of type Fixed list of ints and can be referenced with the variable name SimType.

No additional information


Scope Traces

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.

Console Data

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

Injector

This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::Injector.

No additional information