Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoSensor Class Reference

Description

Represents a Gocator sensor.

Inherits kObject.

Public Member Functions

kStatus GoSensor_AddBuddy (GoSensor sensor, GoSensor buddy)
 Assigns a buddy sensor. More...
 
kStatus GoSensor_Address (GoSensor sensor, GoAddressInfo *info)
 Retrieves the sensor's network address settings. More...
 
GoAlignmentState GoSensor_AlignmentState (GoSensor sensor)
 Gets the alignment state of the sensor. More...
 
kStatus GoSensor_Backup (GoSensor sensor, const kChar *destPath)
 Creates a backup of sensor files and downloads the backup to the specified location. More...
 
GoSensor GoSensor_Buddy (GoSensor sensor)
 Gets the buddy sensor. More...
 
k32u GoSensor_BuddyId (GoSensor sensor)
 Gets the buddy sensor's device ID. More...
 
kStatus GoSensor_Cancel (GoSensor sensor)
 Aborts ongoing sensor communication. More...
 
kStatus GoSensor_ChangePassword (GoSensor sensor, GoUser user, const kChar *password)
 Changes the password associated with the specified user account. More...
 
kStatus GoSensor_ClearLog (GoSensor sensor)
 Clears the log file (_live.log). More...
 
kStatus GoSensor_ClearMeasurementStats (GoSensor sensor)
 Resets the measurment statistics reported by the health channel. More...
 
kStatus GoSensor_ClearReplayData (GoSensor sensor)
 Clears the replay buffer. More...
 
kStatus GoSensor_Connect (GoSensor sensor)
 Creates a connection to the sensor. More...
 
kStatus GoSensor_CopyFile (GoSensor sensor, const kChar *sourceName, const kChar *destName)
 Copies a file within the connected sensor. More...
 
kStatus GoSensor_DefaultJob (GoSensor sensor, kChar *fileName, kSize capacity)
 Gets the name of the default job file to be loaded on boot. More...
 
kStatus GoSensor_DeleteFile (GoSensor sensor, const kChar *name)
 Deletes a file within the connected sensor. More...
 
kStatus GoSensor_Disconnect (GoSensor sensor)
 Disconnects from the sensor. More...
 
kStatus GoSensor_DownloadFile (GoSensor sensor, const kChar *sourceName, const kChar *destPath)
 Downloads a file from the connected sensor. More...
 
kStatus GoSensor_EmitAnalog (GoSensor sensor, k16u index, k64s target, k32s value)
 Schedules an analog output. More...
 
kStatus GoSensor_EmitDigital (GoSensor sensor, k16u index, k64s target, k8u value)
 Schedules a digital output. More...
 
kStatus GoSensor_EnableData (GoSensor sensor, kBool enable)
 Enables or disables the sensor's data channel. More...
 
kStatus GoSensor_ExportBitmap (GoSensor sensor, GoReplayExportSourceType type, GoDataSource source, const kChar *dstFileName)
 Exports the current frame of a replay in the form of a bitmap. More...
 
kStatus GoSensor_ExportCsv (GoSensor sensor, const kChar *dstFileName)
 Exports replay data in CSV format. More...
 
GoFamily GoSensor_Family (GoSensor sensor)
 Returns an enumerator value representing the current sensor's family. More...
 
kSize GoSensor_FileCount (GoSensor sensor)
 Gets the number of files available from the connected sensor. More...
 
kBool GoSensor_FileExists (GoSensor sensor, const kChar *name)
 Checks whether the specified file is present on the sensor. More...
 
kStatus GoSensor_FileNameAt (GoSensor sensor, kSize index, kChar *name, kSize capacity)
 Gets the file name at the specified index. More...
 
kVersion GoSensor_FirmwareVersion (GoSensor sensor)
 Gets the sensor's firmware version. More...
 
kBool GoSensor_GetAutoStartEnabled (GoSensor sensor)
 Gets the AutoStart enabled state currently used by the sensor. More...
 
kStatus GoSensor_GetEncoder (GoSensor sensor, k64s *encoder)
 Gets the current encoder count. More...
 
GoInputSource GoSensor_GetInputSource (GoSensor sensor)
 Gets the input source currently used by the sensor. More...
 
kBool GoSensor_GetRecordingEnabled (GoSensor sensor)
 Gets the recording state of the sensor. More...
 
kStatus GoSensor_GetTimeStamp (GoSensor sensor, k64u *time)
 Gets the current time stamp (common among all synchronized sensors). More...
 
kBool GoSensor_HasBuddy (GoSensor sensor)
 Reports whether a buddy had been assigned. More...
 
k32u GoSensor_Id (GoSensor sensor)
 Gets the device identifier associated with this sensor. More...
 
kBool GoSensor_IsConnected (GoSensor sensor)
 Reports whether the the sensor is currently connected. More...
 
kStatus GoSensor_LoadedJob (GoSensor sensor, kChar *fileName, kSize capacity, kBool *changed)
 Gets the name of the loaded job file and whether it has been modified since loading. More...
 
kStatus GoSensor_LogIn (GoSensor sensor, GoUser user, const kChar *password)
 Logs into the sensor using the specified user name and password. More...
 
kStatus GoSensor_Model (GoSensor sensor, kChar *model, kSize capacity)
 Gets the model number associated with this sensor. More...
 
GoOutput GoSensor_Output (GoSensor sensor)
 Gets the output module, used for output configuration. More...
 
kSize GoSensor_PlaybackFrameCount (GoSensor sensor)
 Gets the current replay frame count. More...
 
kStatus GoSensor_PlaybackPosition (GoSensor sensor, kSize *position, kSize *count)
 Gets the current replay frame position. More...
 
kStatus GoSensor_PlaybackSeek (GoSensor sensor, k32u position)
 Sets the current frame position for a replay. More...
 
kStatus GoSensor_PlaybackStep (GoSensor sensor, GoSeekDirection direction)
 Advances one frame from the current replay position. More...
 
kVersion GoSensor_ProtocolVersion (GoSensor sensor)
 Gets the sensor's protocol version. More...
 
kStatus GoSensor_Refresh (GoSensor sensor)
 Refreshes sensor state. More...
 
kStatus GoSensor_RemoveBuddy (GoSensor sensor)
 Removes the current buddy sensor. More...
 
kStatus GoSensor_Reset (GoSensor sensor, kBool wait)
 Reboots the main sensor and any connected buddy sensors. More...
 
kStatus GoSensor_Restore (GoSensor sensor, const kChar *sourcePath)
 Restores a backup of sensor files. More...
 
kStatus GoSensor_RestoreDefaults (GoSensor sensor, kBool restoreAddress)
 Restores factory default settings. More...
 
GoRole GoSensor_Role (GoSensor sensor)
 Gets the sensor's current role within the system. More...
 
GoMode GoSensor_ScanMode (GoSensor sensor)
 Gets the sensor's scan mode. More...
 
kStatus GoSensor_SetAddress (GoSensor sensor, const GoAddressInfo *info, kBool wait)
 Configures a sensor's network address settings. More...
 
kStatus GoSensor_SetAutoStartEnabled (GoSensor sensor, kBool enable)
 Sets the AutoStart enabled state of the sensor. More...
 
kStatus GoSensor_SetDefaultJob (GoSensor sensor, const kChar *fileName)
 Sets a default job file to be loaded on boot. More...
 
kStatus GoSensor_SetInputSource (GoSensor sensor, GoInputSource source)
 Sets the input source of the sensor. More...
 
kStatus GoSensor_SetRecordingEnabled (GoSensor sensor, kBool enable)
 Sets the recording state of the sensor. More...
 
GoSetup GoSensor_Setup (GoSensor sensor)
 Gets the GoSetup instance associated with the sensor. More...
 
kStatus GoSensor_Simulate (GoSensor sensor, kBool *isBufferValid)
 Simulates the current frame in the live recording buffer. More...
 
GoState GoSensor_State (GoSensor sensor)
 Reports the current state of the sensor. More...
 
kStatus GoSensor_States (GoSensor sensor, GoStates *states)
 Reports the current states of the sensor. More...
 
GoTools GoSensor_Tools (GoSensor sensor)
 Gets the sensor's tools module, used for measurement configuration. More...
 
GoTransform GoSensor_Transform (GoSensor sensor)
 Gets the transform module, used for transformation configuration. More...
 
kStatus GoSensor_Trigger (GoSensor sensor)
 Sends a software trigger to the sensor. More...
 
kStatus GoSensor_Upgrade (GoSensor sensor, const kChar *sourcePath, GoUpgradeFx onUpdate, kPointer context)
 Upgrades sensor firmware. More...
 
kStatus GoSensor_UploadFile (GoSensor sensor, const kChar *sourcePath, const kChar *destName)
 Uploads a file to the connected sensor. More...
 
GoUser GoSensor_User (GoSensor sensor)
 Reports the user account associated with the current user. More...
 

Member Function Documentation

kStatus GoSensor_AddBuddy ( GoSensor  sensor,
GoSensor  buddy 
)

Assigns a buddy sensor.

Parameters
sensorGoSensor object.
buddySensor to be assigned as buddy.
Returns
Operation status.
kStatus GoSensor_Address ( GoSensor  sensor,
GoAddressInfo info 
)

Retrieves the sensor's network address settings.

Parameters
sensorGoSensor object.
infoReceives current address configuration.
Returns
Operation status.
GoAlignmentState GoSensor_AlignmentState ( GoSensor  sensor)

Gets the alignment state of the sensor.

Parameters
sensorGoSensor object.
Returns
A GoAlignmentState.
kStatus GoSensor_Backup ( GoSensor  sensor,
const kChar *  destPath 
)

Creates a backup of sensor files and downloads the backup to the specified location.

Parameters
sensorGoSensor object.
destPathLocal file system path for the saved backup file.
Returns
Operation status.
GoSensor GoSensor_Buddy ( GoSensor  sensor)

Gets the buddy sensor.

Parameters
sensorGoSensor object.
Returns
Buddy sensor (or kNULL if not assigned or not online).
k32u GoSensor_BuddyId ( GoSensor  sensor)

Gets the buddy sensor's device ID.

Parameters
sensorGoSensor object.
Returns
Buddy device ID (or k32U_NULL if not assigned).
kStatus GoSensor_Cancel ( GoSensor  sensor)

Aborts ongoing sensor communication.

This method asynchronously aborts ongoing communication; the next time that any I/O operation blocks for an extended period of time, it will be terminated. This method is thread-safe.

In order to resume communication, call GoSensor_Refresh or GoSensor_Connect.

Parameters
sensorGoSensor object.
Returns
Operation status.
kStatus GoSensor_ChangePassword ( GoSensor  sensor,
GoUser  user,
const kChar *  password 
)

Changes the password associated with the specified user account.

Parameters
sensorGoSensor object.
userUser account.
passwordNew password.
Returns
Operation status.
kStatus GoSensor_ClearLog ( GoSensor  sensor)

Clears the log file (_live.log).

Parameters
sensorGoSensor object.
Returns
Operation status.
kStatus GoSensor_ClearMeasurementStats ( GoSensor  sensor)

Resets the measurment statistics reported by the health channel.

Parameters
sensorGoSensor object.
Returns
A GoAlignmentState.
kStatus GoSensor_ClearReplayData ( GoSensor  sensor)

Clears the replay buffer.

Parameters
sensorGoSensor object.
Returns
Operation status.
kStatus GoSensor_Connect ( GoSensor  sensor)

Creates a connection to the sensor.

Parameters
sensorGoSensor object.
Returns
Operation status.
kStatus GoSensor_CopyFile ( GoSensor  sensor,
const kChar *  sourceName,
const kChar *  destName 
)

Copies a file within the connected sensor.

Parameters
sensorGoSensor object.
sourceNameSource name for the file to be copied.
destNameDestination name for the file (maximum 63 characters).
Returns
Operation status.
kStatus GoSensor_DefaultJob ( GoSensor  sensor,
kChar *  fileName,
kSize  capacity 
)

Gets the name of the default job file to be loaded on boot.

Parameters
sensorGoSensor object.
fileNameReceives name of the default file.
capacityName buffer capacity.
Returns
Operation status.
kStatus GoSensor_DeleteFile ( GoSensor  sensor,
const kChar *  name 
)

Deletes a file within the connected sensor.

Parameters
sensorGoSensor object.
nameName of the file to be deleted.
Returns
Operation status.
kStatus GoSensor_Disconnect ( GoSensor  sensor)

Disconnects from the sensor.

Parameters
sensorGoSensor object.
Returns
Operation status.
kStatus GoSensor_DownloadFile ( GoSensor  sensor,
const kChar *  sourceName,
const kChar *  destPath 
)

Downloads a file from the connected sensor.

Parameters
sensorGoSensor object.
sourceNameSource name of the file to be downloaded.
destPathDestination file system path for the file to be downloaded.
Returns
Operation status.
kStatus GoSensor_EmitAnalog ( GoSensor  sensor,
k16u  index,
k64s  target,
k32s  value 
)

Schedules an analog output.

This method requires that the output be configured to trigger on software control.

Parameters
sensorGoSensor object.
indexThe analog output index.
targetThe time or position target (us or mm), depending on GoDomain. Ignored if GoAnalog_ScheduleEnabled is false.
valueThe value of the scheduled output (mA).
Returns
Operation status.
kStatus GoSensor_EmitDigital ( GoSensor  sensor,
k16u  index,
k64s  target,
k8u  value 
)

Schedules a digital output.

This method requires that the output is configured to trigger on software control.

Parameters
sensorGoSensor object.
indexThe digital output index.
targetThe time or position target (us or mm), depending on GoDomain. Ignored if GoDigital_ScheduleEnabled is false or GoDigital_SignalType is pulsed.
valueThe value of scheduled output (0-Low or 1-High). Ignored if output GoDigital_SignalType is pulsed.
Returns
Operation status.
kStatus GoSensor_EnableData ( GoSensor  sensor,
kBool  enable 
)

Enables or disables the sensor's data channel.

Parameters
sensorGoSensor object.
enablekTRUE to enable, or kFALSE to disable.
Returns
Operation status.
kStatus GoSensor_ExportBitmap ( GoSensor  sensor,
GoReplayExportSourceType  type,
GoDataSource  source,
const kChar *  dstFileName 
)

Exports the current frame of a replay in the form of a bitmap.

Parameters
sensorGoSensor object.
typeThe type of data to export.
sourceThe device data source to export from.
dstFileNameThe destination file name of the exported CSV file.
Returns
Operation status.
kStatus GoSensor_ExportCsv ( GoSensor  sensor,
const kChar *  dstFileName 
)

Exports replay data in CSV format.

Parameters
sensorGoSensor object.
dstFileNameThe destination file name of the exported CSV file.
Returns
Operation status.
GoFamily GoSensor_Family ( GoSensor  sensor)

Returns an enumerator value representing the current sensor's family.

Parameters
sensorGoSensor object.
Returns
A GoFamily value.
kSize GoSensor_FileCount ( GoSensor  sensor)

Gets the number of files available from the connected sensor.

Parameters
sensorGoSensor object.
Returns
File count.
kBool GoSensor_FileExists ( GoSensor  sensor,
const kChar *  name 
)

Checks whether the specified file is present on the sensor.

Parameters
sensorGoSensor object.
nameName of the file to be checked.
Returns
Operation status.
kStatus GoSensor_FileNameAt ( GoSensor  sensor,
kSize  index,
kChar *  name,
kSize  capacity 
)

Gets the file name at the specified index.

Parameters
sensorGoSensor object.
indexIndex of the desired file name.
nameReceives the name of the file.
capacityCapacity of the file name buffer.
Returns
Operation status.
kVersion GoSensor_FirmwareVersion ( GoSensor  sensor)

Gets the sensor's firmware version.

Parameters
sensorGoSensor object.
Returns
Firmware version.
kBool GoSensor_GetAutoStartEnabled ( GoSensor  sensor)

Gets the AutoStart enabled state currently used by the sensor.

Parameters
sensorGoSensor object.
Returns
A GoAutoStart.
kStatus GoSensor_GetEncoder ( GoSensor  sensor,
k64s *  encoder 
)

Gets the current encoder count.

Parameters
sensorGoSensor object.
encoderReceives the encoder count (ticks).
Returns
Operation status.
GoInputSource GoSensor_GetInputSource ( GoSensor  sensor)

Gets the input source currently used by the sensor.

Parameters
sensorGoSensor object.
Returns
A GoInputSource.
kBool GoSensor_GetRecordingEnabled ( GoSensor  sensor)

Gets the recording state of the sensor.

Parameters
sensorGoSensor object.
Returns
kTRUE if recording is enabled. kFALSE otherwise.
kStatus GoSensor_GetTimeStamp ( GoSensor  sensor,
k64u *  time 
)

Gets the current time stamp (common among all synchronized sensors).

Parameters
sensorGoSensor object.
timeReceives the current time stamp(us).
Returns
Operation status.
kBool GoSensor_HasBuddy ( GoSensor  sensor)

Reports whether a buddy had been assigned.

Parameters
sensorGoSensor object.
Returns
kTRUE if sensor has a buddy; kFALSE otherwise.
k32u GoSensor_Id ( GoSensor  sensor)

Gets the device identifier associated with this sensor.

Parameters
sensorGoSensor object.
Returns
The sensor's device ID.
kBool GoSensor_IsConnected ( GoSensor  sensor)

Reports whether the the sensor is currently connected.

Parameters
sensorGoSensor object.
Returns
kTRUE if the sensor is connected; kFALSE otherwise.
kStatus GoSensor_LoadedJob ( GoSensor  sensor,
kChar *  fileName,
kSize  capacity,
kBool *  changed 
)

Gets the name of the loaded job file and whether it has been modified since loading.

Parameters
sensorGoSensor object.
fileNameReceives name of the loaded file.
capacityName buffer capacity.
changedReceives the status of whether the file has changed.
Returns
Operation status.
kStatus GoSensor_LogIn ( GoSensor  sensor,
GoUser  user,
const kChar *  password 
)

Logs into the sensor using the specified user name and password.

Logging in is not required in order to programmatically control a sensor. The Gocator log-in feature is intended only to support administrative user interfaces, by allowing the username and password to be stored onboard the sensor.

Parameters
sensorGoSensor object.
userUser account.
passwordUser password.
Returns
Operation status.
kStatus GoSensor_Model ( GoSensor  sensor,
kChar *  model,
kSize  capacity 
)

Gets the model number associated with this sensor.

Parameters
sensorGoSensor object.
modelReceives sensor model.
capacityCapacity of model buffer.
Returns
Model number.
GoOutput GoSensor_Output ( GoSensor  sensor)

Gets the output module, used for output configuration.

Parameters
sensorGoSensor object.
Returns
Output configuration module.
kSize GoSensor_PlaybackFrameCount ( GoSensor  sensor)

Gets the current replay frame count.

Parameters
sensorGoSensor object.
Returns
The current frame count.
kStatus GoSensor_PlaybackPosition ( GoSensor  sensor,
kSize *  position,
kSize *  count 
)

Gets the current replay frame position.

Parameters
sensorGoSensor object.
positionThe current frame position index.
countThe frame count.
Returns
Operation status.
kStatus GoSensor_PlaybackSeek ( GoSensor  sensor,
k32u  position 
)

Sets the current frame position for a replay.

Parameters
sensorGoSensor object.
positionThe frame position to seek.
Returns
Operation status.
kStatus GoSensor_PlaybackStep ( GoSensor  sensor,
GoSeekDirection  direction 
)

Advances one frame from the current replay position.

Parameters
sensorGoSensor object.
directionDirection with which to step.
Returns
Operation status.
kVersion GoSensor_ProtocolVersion ( GoSensor  sensor)

Gets the sensor's protocol version.

Parameters
sensorGoSensor object.
Returns
Protocol version.
kStatus GoSensor_Refresh ( GoSensor  sensor)

Refreshes sensor state.

Unresponsive sensors will be disconnected, and cancelled sensors will be reconnected. Sensors in any other state will discard all locally-cached information.

This function should be used to update sensors in the GO_SENSOR_INCONSISTENT state. This state can arise due to buddy changes performed by remote sensors (e.g. a main sensor boots and claims ownership of a buddy sensor, but the buddy sensor has already been detected and loaded as a main sensor by the client).

Parameters
sensorGoSensor object.
Returns
kTRUE if the sensor is connected; kFALSE otherwise.
kStatus GoSensor_RemoveBuddy ( GoSensor  sensor)

Removes the current buddy sensor.

Parameters
sensorGoSensor object.
Returns
Operation status.
kStatus GoSensor_Reset ( GoSensor  sensor,
kBool  wait 
)

Reboots the main sensor and any connected buddy sensors.

Parameters
sensorGoSensor object.
waitkTRUE to wait for reboot and then reconnect.
Returns
Operation status.
kStatus GoSensor_Restore ( GoSensor  sensor,
const kChar *  sourcePath 
)

Restores a backup of sensor files.

Parameters
sensorGoSensor object.
sourcePathLocal file system path of the saved backup file.
Returns
Operation status.
kStatus GoSensor_RestoreDefaults ( GoSensor  sensor,
kBool  restoreAddress 
)

Restores factory default settings.

Parameters
sensorGoSensor object.
restoreAddresskTRUE to restore the factory default IP address; False otherwise.
Returns
Operation status.
GoRole GoSensor_Role ( GoSensor  sensor)

Gets the sensor's current role within the system.

Parameters
sensorGoSensor object.
Returns
Sensor role.
GoMode GoSensor_ScanMode ( GoSensor  sensor)

Gets the sensor's scan mode.

Parameters
sensorGoSensor object.
Returns
Scan mode.
kStatus GoSensor_SetAddress ( GoSensor  sensor,
const GoAddressInfo info,
kBool  wait 
)

Configures a sensor's network address settings.

This function uses UDP broadcasts for sensor configuration; the sensor does not need to be connected, and can be on a different subnet than the client.

The sensor will automatically reboot if the address is successfully changed.

Parameters
sensorGoSensor object.
infoNew address settings.
waitShould this function block until the sensor finishes rebooting?
Returns
Operation status.
kStatus GoSensor_SetAutoStartEnabled ( GoSensor  sensor,
kBool  enable 
)

Sets the AutoStart enabled state of the sensor.

Parameters
sensorGoSensor object.
enableThe AutoStart enabled state to use.
Returns
Operation status.
kStatus GoSensor_SetDefaultJob ( GoSensor  sensor,
const kChar *  fileName 
)

Sets a default job file to be loaded on boot.

Parameters
sensorGoSensor object.
fileNameName of the default file.
Returns
Operation status.
kStatus GoSensor_SetInputSource ( GoSensor  sensor,
GoInputSource  source 
)

Sets the input source of the sensor.

Parameters
sensorGoSensor object.
sourceThe input source to use.
Returns
Operation status.
kStatus GoSensor_SetRecordingEnabled ( GoSensor  sensor,
kBool  enable 
)

Sets the recording state of the sensor.

Parameters
sensorGoSensor object.
enableEnables or disables recording.
Returns
Operation status.
GoSetup GoSensor_Setup ( GoSensor  sensor)

Gets the GoSetup instance associated with the sensor.

Parameters
sensorGoSensor object.
Returns
A GoSetup object module
kStatus GoSensor_Simulate ( GoSensor  sensor,
kBool *  isBufferValid 
)

Simulates the current frame in the live recording buffer.

Parameters
sensorGoSensor object.
isBufferValidkTRUE if the source simulation buffer was valid. kFALSE otherwise.
Returns
Operation status.
GoState GoSensor_State ( GoSensor  sensor)

Reports the current state of the sensor.

Parameters
sensorGoSensor object.
Returns
Sensor state.
kStatus GoSensor_States ( GoSensor  sensor,
GoStates states 
)

Reports the current states of the sensor.

Parameters
sensorGoSensor object.
Returns
Sensor states.
GoTools GoSensor_Tools ( GoSensor  sensor)

Gets the sensor's tools module, used for measurement configuration.

Parameters
sensorGoSensor object.
Returns
Measurement configuration module.
GoTransform GoSensor_Transform ( GoSensor  sensor)

Gets the transform module, used for transformation configuration.

Parameters
sensorGoSensor object.
Returns
Transformation configuration module.
kStatus GoSensor_Trigger ( GoSensor  sensor)

Sends a software trigger to the sensor.

This method is used in conjunction with sensors that are configured to accept software triggers.

Parameters
sensorGoSensor object.
Returns
Operation status.
See also
GoSetup_TriggerSource, GoSetup_SetTriggerSource
kStatus GoSensor_Upgrade ( GoSensor  sensor,
const kChar *  sourcePath,
GoUpgradeFx  onUpdate,
kPointer  context 
)

Upgrades sensor firmware.

This function will block until the upgrade is completed. A reboot is required in order for the upgrade to take effet, but the reboot is not automatic. Call GoSensor_Reset to reboot.

Parameters
sensorGoSensor object.
sourcePathLocal file system path to the upgrade file.
onUpdateCallback function to receive progress updates, or kNULL.
contextContext handle to be passed to the upgrade callback.
Returns
Operation status.
kStatus GoSensor_UploadFile ( GoSensor  sensor,
const kChar *  sourcePath,
const kChar *  destName 
)

Uploads a file to the connected sensor.

Parameters
sensorGoSensor object.
sourcePathSource file system path for the file to be uploaded.
destNameDestination name for the uploaded file (maximum 63 characters).
Returns
Operation status.
GoUser GoSensor_User ( GoSensor  sensor)

Reports the user account associated with the current user.

Parameters
sensorGoSensor object.
Returns
User account id.

The documentation for this class was generated from the following file: