Gocator API
|
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... | |
Assigns a buddy sensor.
sensor | GoSensor object. |
buddy | Sensor to be assigned as buddy. |
kStatus GoSensor_Address | ( | GoSensor | sensor, |
GoAddressInfo * | info | ||
) |
Retrieves the sensor's network address settings.
sensor | GoSensor object. |
info | Receives current address configuration. |
GoAlignmentState GoSensor_AlignmentState | ( | GoSensor | sensor | ) |
Gets the alignment state of the sensor.
sensor | GoSensor object. |
kStatus GoSensor_Backup | ( | GoSensor | sensor, |
const kChar * | destPath | ||
) |
Creates a backup of sensor files and downloads the backup to the specified location.
sensor | GoSensor object. |
destPath | Local file system path for the saved backup file. |
Gets the buddy sensor.
sensor | GoSensor object. |
k32u GoSensor_BuddyId | ( | GoSensor | sensor | ) |
Gets the buddy sensor's device ID.
sensor | GoSensor object. |
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.
sensor | GoSensor object. |
Changes the password associated with the specified user account.
sensor | GoSensor object. |
user | User account. |
password | New password. |
kStatus GoSensor_ClearLog | ( | GoSensor | sensor | ) |
kStatus GoSensor_ClearMeasurementStats | ( | GoSensor | sensor | ) |
Resets the measurment statistics reported by the health channel.
sensor | GoSensor object. |
kStatus GoSensor_ClearReplayData | ( | GoSensor | sensor | ) |
kStatus GoSensor_Connect | ( | GoSensor | sensor | ) |
kStatus GoSensor_CopyFile | ( | GoSensor | sensor, |
const kChar * | sourceName, | ||
const kChar * | destName | ||
) |
Copies a file within the connected sensor.
sensor | GoSensor object. |
sourceName | Source name for the file to be copied. |
destName | Destination name for the file (maximum 63 characters). |
kStatus GoSensor_DefaultJob | ( | GoSensor | sensor, |
kChar * | fileName, | ||
kSize | capacity | ||
) |
Gets the name of the default job file to be loaded on boot.
sensor | GoSensor object. |
fileName | Receives name of the default file. |
capacity | Name buffer capacity. |
kStatus GoSensor_DeleteFile | ( | GoSensor | sensor, |
const kChar * | name | ||
) |
Deletes a file within the connected sensor.
sensor | GoSensor object. |
name | Name of the file to be deleted. |
kStatus GoSensor_Disconnect | ( | GoSensor | sensor | ) |
kStatus GoSensor_DownloadFile | ( | GoSensor | sensor, |
const kChar * | sourceName, | ||
const kChar * | destPath | ||
) |
Downloads a file from the connected sensor.
sensor | GoSensor object. |
sourceName | Source name of the file to be downloaded. |
destPath | Destination file system path for the file to be downloaded. |
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.
sensor | GoSensor object. |
index | The analog output index. |
target | The time or position target (us or mm), depending on GoDomain. Ignored if GoAnalog_ScheduleEnabled is false. |
value | The value of the scheduled output (mA). |
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.
sensor | GoSensor object. |
index | The digital output index. |
target | The time or position target (us or mm), depending on GoDomain. Ignored if GoDigital_ScheduleEnabled is false or GoDigital_SignalType is pulsed. |
value | The value of scheduled output (0-Low or 1-High). Ignored if output GoDigital_SignalType is pulsed. |
kStatus GoSensor_EnableData | ( | GoSensor | sensor, |
kBool | enable | ||
) |
Enables or disables the sensor's data channel.
sensor | GoSensor object. |
enable | kTRUE to enable, or kFALSE to disable. |
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.
sensor | GoSensor object. |
type | The type of data to export. |
source | The device data source to export from. |
dstFileName | The destination file name of the exported CSV file. |
kStatus GoSensor_ExportCsv | ( | GoSensor | sensor, |
const kChar * | dstFileName | ||
) |
Exports replay data in CSV format.
sensor | GoSensor object. |
dstFileName | The destination file name of the exported CSV file. |
GoFamily GoSensor_Family | ( | GoSensor | sensor | ) |
Returns an enumerator value representing the current sensor's family.
sensor | GoSensor object. |
kSize GoSensor_FileCount | ( | GoSensor | sensor | ) |
Gets the number of files available from the connected sensor.
sensor | GoSensor object. |
kBool GoSensor_FileExists | ( | GoSensor | sensor, |
const kChar * | name | ||
) |
Checks whether the specified file is present on the sensor.
sensor | GoSensor object. |
name | Name of the file to be checked. |
kStatus GoSensor_FileNameAt | ( | GoSensor | sensor, |
kSize | index, | ||
kChar * | name, | ||
kSize | capacity | ||
) |
Gets the file name at the specified index.
sensor | GoSensor object. |
index | Index of the desired file name. |
name | Receives the name of the file. |
capacity | Capacity of the file name buffer. |
kVersion GoSensor_FirmwareVersion | ( | GoSensor | sensor | ) |
kBool GoSensor_GetAutoStartEnabled | ( | GoSensor | sensor | ) |
Gets the AutoStart enabled state currently used by the sensor.
sensor | GoSensor object. |
kStatus GoSensor_GetEncoder | ( | GoSensor | sensor, |
k64s * | encoder | ||
) |
Gets the current encoder count.
sensor | GoSensor object. |
encoder | Receives the encoder count (ticks). |
GoInputSource GoSensor_GetInputSource | ( | GoSensor | sensor | ) |
Gets the input source currently used by the sensor.
sensor | GoSensor object. |
kBool GoSensor_GetRecordingEnabled | ( | GoSensor | sensor | ) |
Gets the recording state of the sensor.
sensor | GoSensor object. |
kStatus GoSensor_GetTimeStamp | ( | GoSensor | sensor, |
k64u * | time | ||
) |
Gets the current time stamp (common among all synchronized sensors).
sensor | GoSensor object. |
time | Receives the current time stamp(us). |
kBool GoSensor_HasBuddy | ( | GoSensor | sensor | ) |
Reports whether a buddy had been assigned.
sensor | GoSensor object. |
k32u GoSensor_Id | ( | GoSensor | sensor | ) |
Gets the device identifier associated with this sensor.
sensor | GoSensor object. |
kBool GoSensor_IsConnected | ( | GoSensor | sensor | ) |
Reports whether the the sensor is currently connected.
sensor | GoSensor object. |
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.
sensor | GoSensor object. |
fileName | Receives name of the loaded file. |
capacity | Name buffer capacity. |
changed | Receives the status of whether the file has changed. |
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.
sensor | GoSensor object. |
user | User account. |
password | User password. |
kStatus GoSensor_Model | ( | GoSensor | sensor, |
kChar * | model, | ||
kSize | capacity | ||
) |
Gets the model number associated with this sensor.
sensor | GoSensor object. |
model | Receives sensor model. |
capacity | Capacity of model buffer. |
Gets the output module, used for output configuration.
sensor | GoSensor object. |
kSize GoSensor_PlaybackFrameCount | ( | GoSensor | sensor | ) |
Gets the current replay frame count.
sensor | GoSensor object. |
kStatus GoSensor_PlaybackPosition | ( | GoSensor | sensor, |
kSize * | position, | ||
kSize * | count | ||
) |
Gets the current replay frame position.
sensor | GoSensor object. |
position | The current frame position index. |
count | The frame count. |
kStatus GoSensor_PlaybackSeek | ( | GoSensor | sensor, |
k32u | position | ||
) |
Sets the current frame position for a replay.
sensor | GoSensor object. |
position | The frame position to seek. |
kStatus GoSensor_PlaybackStep | ( | GoSensor | sensor, |
GoSeekDirection | direction | ||
) |
Advances one frame from the current replay position.
sensor | GoSensor object. |
direction | Direction with which to step. |
kVersion GoSensor_ProtocolVersion | ( | GoSensor | sensor | ) |
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).
sensor | GoSensor object. |
kStatus GoSensor_RemoveBuddy | ( | GoSensor | sensor | ) |
kStatus GoSensor_Reset | ( | GoSensor | sensor, |
kBool | wait | ||
) |
Reboots the main sensor and any connected buddy sensors.
sensor | GoSensor object. |
wait | kTRUE to wait for reboot and then reconnect. |
kStatus GoSensor_Restore | ( | GoSensor | sensor, |
const kChar * | sourcePath | ||
) |
Restores a backup of sensor files.
sensor | GoSensor object. |
sourcePath | Local file system path of the saved backup file. |
kStatus GoSensor_RestoreDefaults | ( | GoSensor | sensor, |
kBool | restoreAddress | ||
) |
Restores factory default settings.
sensor | GoSensor object. |
restoreAddress | kTRUE to restore the factory default IP address; False otherwise. |
GoRole GoSensor_Role | ( | GoSensor | sensor | ) |
Gets the sensor's current role within the system.
sensor | GoSensor object. |
GoMode GoSensor_ScanMode | ( | GoSensor | sensor | ) |
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.
sensor | GoSensor object. |
info | New address settings. |
wait | Should this function block until the sensor finishes rebooting? |
kStatus GoSensor_SetAutoStartEnabled | ( | GoSensor | sensor, |
kBool | enable | ||
) |
Sets the AutoStart enabled state of the sensor.
sensor | GoSensor object. |
enable | The AutoStart enabled state to use. |
kStatus GoSensor_SetDefaultJob | ( | GoSensor | sensor, |
const kChar * | fileName | ||
) |
Sets a default job file to be loaded on boot.
sensor | GoSensor object. |
fileName | Name of the default file. |
kStatus GoSensor_SetInputSource | ( | GoSensor | sensor, |
GoInputSource | source | ||
) |
Sets the input source of the sensor.
sensor | GoSensor object. |
source | The input source to use. |
kStatus GoSensor_SetRecordingEnabled | ( | GoSensor | sensor, |
kBool | enable | ||
) |
Sets the recording state of the sensor.
sensor | GoSensor object. |
enable | Enables or disables recording. |
kStatus GoSensor_Simulate | ( | GoSensor | sensor, |
kBool * | isBufferValid | ||
) |
Simulates the current frame in the live recording buffer.
sensor | GoSensor object. |
isBufferValid | kTRUE if the source simulation buffer was valid. kFALSE otherwise. |
Gets the sensor's tools module, used for measurement configuration.
sensor | GoSensor object. |
GoTransform GoSensor_Transform | ( | GoSensor | sensor | ) |
Gets the transform module, used for transformation configuration.
sensor | GoSensor object. |
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.
sensor | GoSensor object. |
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.
sensor | GoSensor object. |
sourcePath | Local file system path to the upgrade file. |
onUpdate | Callback function to receive progress updates, or kNULL. |
context | Context handle to be passed to the upgrade callback. |
kStatus GoSensor_UploadFile | ( | GoSensor | sensor, |
const kChar * | sourcePath, | ||
const kChar * | destName | ||
) |
Uploads a file to the connected sensor.
sensor | GoSensor object. |
sourcePath | Source file system path for the file to be uploaded. |
destName | Destination name for the uploaded file (maximum 63 characters). |
Reports the user account associated with the current user.
sensor | GoSensor object. |