View source for Component: Accel Mag 6 Axis (LSM303DLHC) (Sensors)

From Flowcode Help

← Component: Accel Mag 6 Axis (LSM303DLHC) (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 | 2.0 (Release) |- | width="20%" style="color: gray;" | Category | Sensors |} ==[[File:Component Icon d61dd6a6_231e_4244_9e8d_4f15e7ea10d5.png|Image]] Accel Mag 6_Axis (LSM303DLHC) component== LSM303DLHC Combined 6-Axis Accelerometer and Magnetometer sensors Useful for working out data such as Pitch and Yaw. ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Downloadable macro reference== ===<span style="font-weight: normal;"><u><tt>SimReset1G</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>UpdateCompassData</tt></u></span>=== Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>SimSetAccelerometer</tt></u></span>=== Allows the XYZ slider values to be set via the simulation '''Parameters''' :[[Variable Types|INT]] ''X'' :[[Variable Types|INT]] ''Y'' :[[Variable Types|INT]] ''Z'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>CollectXYZData</tt></u></span>=== Collect the data from the local accelerometer buffers. The Axis parameter specifies the Axis to be read. 0 / 'x' / 'X' - X axis 1 / 'y' / 'Y' - Y axis 2 / 'z' / 'Z' - Z axis '''Parameters''' :[[Variable Types|BYTE]] ''Axis'' '''Return value''' :[[Variable Types|INT]] ===<span style="font-weight: normal;"><u><tt>UpdateAccelerometerData</tt></u></span>=== Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>SimSetCompass</tt></u></span>=== Allows the XYZ slider values to be set via the simulation '''Parameters''' :[[Variable Types|INT]] ''X'' :[[Variable Types|INT]] ''Y'' :[[Variable Types|INT]] ''Z'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>=== Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail. '''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>Power Mode</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''power_mode''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Accel Data Rate</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''accel_data_rate''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Accel Scale</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''accel_scale''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Compass Data Rate</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''compass_data_rate''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Compass Scale</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''compass_scale''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Comms Mode</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''CommsMode''. Specifies the communications mode. Interrupt - Wait for the interrupt pin to go high before allowing new data to be sampled. Polling - New data is sampled without needing to check the interrupt pin. <span style="font-weight: normal;"><u>Bit Depth</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''bit_depth''. ''<span style="color:red;">No additional information</span>'' <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_i2c::CHANNEL''. Channel selection <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_i2c::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_i2c::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_i2c::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>SDA</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c::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_i2c::SCL''. Pin used for SCL (clock signal) <span style="font-weight: normal;"><u>Interrupt Pin</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''int_pin''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Sim Type</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimType''. Controls how the simulation data is generated, via the component GUI or via a I2C injector. <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_i2c::ScopeTraces''. Selects if the scope traces are automatically generated or not <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_i2c::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_i2c::Injector''. ''<span style="color:red;">No additional information</span>''

Return to Component: Accel Mag 6 Axis (LSM303DLHC) (Sensors).