FlexSEA Wiki

A WEARABLE ROBOTICS TOOLKIT

User Tools

Site Tools


fx_plan_stack_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
fx_plan_stack_api [2020/02/13 20:20]
rqurashi
fx_plan_stack_api [2020/02/13 20:34] (current)
rqurashi
Line 121: Line 121:
 /// communicate with. /// communicate with.
 /// ///
-/// @param idArray On return each element of the array will contain ​either ​+/// @param idArray ​is an array to hold the returned device IDs. The return value 
-/// valid device ID or -1 (no device). This array should have at least as many +/// of this function is the number of connected FlexSEA devices (numDevices). 
-/// elements as FlexSEA devices used.+/// On return each element of the array up till numDevices ​will contain a valid 
 +/// device ID.
 /// ///
-/// @param size is the size of the idarray.+/// @param size is the size of the idarray. Should be large enough to contain 
 +/// device IDs for all devices you plan to use at once, or FX_MAX_DEVICES.
 /// ///
 /// @returns number of connected FlexSEA devices /// @returns number of connected FlexSEA devices
Line 135: Line 137:
 ===fxStartStreaming=== ===fxStartStreaming===
 <​code>​ <​code>​
-/// \brief Start streaming data from a FlexSEA device.+/// \brief Start streaming data from a FlexSEA device ​and optionally log the 
 +/// streamed data. The data logger can impact performance if you are sending 
 +/// many commands in quick succession.
 /// ///
 /// @param deviceId is the device ID /// @param deviceId is the device ID
 /// ///
 /// @param shouldLog If set true, the program logs all received data to a file. /// @param shouldLog If set true, the program logs all received data to a file.
 +/// Enabling the data logging can impact performance if you are sending many
 +/// commands in quick succession.
 +///
 /// The name of the file is formed as follows: /// The name of the file is formed as follows:
 /// ///
Line 153: Line 160:
 /// ///
 /// @returns Error codes defined at top of the header /// @returns Error codes defined at top of the header
 +///
 +/// @note The data logger can impact performance if you are sending many
 +/// commands in quick succession.
 FxError fxStartStreaming(const unsigned int deviceId, FxError fxStartStreaming(const unsigned int deviceId,
                         const unsigned int frequency,                         const unsigned int frequency,
fx_plan_stack_api.txt · Last modified: 2020/02/13 20:34 by rqurashi