View source for Component: Gyroscope 3 Axis I2C (L3GD20) (Sensors)

From Flowcode Help

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

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

---

You can view and copy the source of this page.

{| width="50%" |- | width="20%" style="color: gray;" | Author | Matrix TSL |- | width="20%" style="color: gray;" | Version | 1.0 (Release) |- | width="20%" style="color: gray;" | Category | Sensors |} ==[[File:Component Icon 8e4553f8_fce7_4fed_80c1_33de9590a678.png|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== ''<span style="color:red;">No additional examples</span>'' ==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'' '''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'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>ReadRegister</tt></u></span>=== Read the data byte at the given address of the device '''Parameters''' :[[Variable Types|BYTE]] ''address'' ::address of the register to be read '''Return value''' :[[Variable Types|BYTE]] ===<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 '''Parameters''' :[[Variable Types|BYTE]] ''address'' ::address of register to be written with data byte :[[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]] ==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''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Full Scale Selection</u></span> 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 <span style="font-weight: normal;"><u>X Axis</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''XEN''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Y Axis</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''YEN''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Z Axis</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ZEN''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Label</u></span> 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>'' <span style="font-weight: normal;"><u>Address Pin</u></span> 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 <span style="font-weight: normal;"><u>Channel</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::CHANNEL''. Channel selection <span style="font-weight: normal;"><u>SDA</u></span> 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) <span style="font-weight: normal;"><u>SCL</u></span> 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) <span style="font-weight: normal;"><u>Baud Select</u></span> 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 <span style="font-weight: normal;"><u>Baud Rate</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_i2c1::BAUD''. 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>''

Return to Component: Gyroscope 3 Axis I2C (L3GD20) (Sensors).