Gocator API
|
Represents a set of sensor command connections (control, upgrade).
Inherits kObject.
Public Member Functions | |
kStatus | GoControl_Backup (GoControl control, kByte **fileData, k32u *size, kAlloc allocator) |
Creates and downloads a backup of sensor files. More... | |
kStatus | GoControl_BeginAlignment (GoControl control) |
Sends a alignment command to a sensor, but doesn't wait for the response. More... | |
kStatus | GoControl_BeginExposureAutoSet (GoControl control, GoRole role) |
Sends an exposure auto set command to a sensor, but doesn't wait for the response. More... | |
kStatus | GoControl_BeginStart (GoControl control) |
Sends a start command to a sensor with the currently selected input source, but doesn't wait for the response. More... | |
kStatus | GoControl_BeginStop (GoControl control) |
Sends a stop command to a sensor, but doesn't wait for the response. More... | |
kStatus | GoControl_BeginUpgrade (GoControl control, void *data, kSize size) |
Begins a sensor firmware upgrade. More... | |
kStatus | GoControl_ChangeBuddy (GoControl control, kBool add, k32u buddyId) |
Assigns or removes a buddy sensor. More... | |
kStatus | GoControl_ChangePassword (GoControl control, GoUser user, const kChar *password) |
Changes the password associated with the specified user account. More... | |
kStatus | GoControl_ClearLog (GoControl control) |
Clears the sensor log file. More... | |
kStatus | GoControl_ClearMeasurementStats (GoControl control) |
Clear the sensor's measurement statistics. More... | |
kStatus | GoControl_ClearReplayData (GoControl control) |
Clear the sensor's replay data. More... | |
kStatus | GoControl_Close (GoControl control) |
Closes all open command connections. More... | |
kStatus | GoControl_Construct (GoControl *control, kAlloc allocator) |
Constructs a GoControl object. More... | |
kStatus | GoControl_CopyFile (GoControl control, const kChar *source, const kChar *destination) |
Copies a file within the connected sensor. More... | |
kStatus | GoControl_DeleteFile (GoControl control, const kChar *fileName) |
Deletes a file within the connected sensor. More... | |
kStatus | GoControl_EndAlignment (GoControl control) |
Waits for a alignment response from a sensor. More... | |
kStatus | GoControl_EndExposureAutoSet (GoControl control) |
Waits for a exposure auto set response from a sensor. More... | |
kStatus | GoControl_EndStart (GoControl control) |
Waits for a start response from a sensor. More... | |
kStatus | GoControl_EndStop (GoControl control) |
Waits for a stop response from a sensor. More... | |
kStatus | GoControl_ExportBitmap (GoControl control, GoReplayExportSourceType type, GoDataSource source, const kChar *dstFileName) |
Export an intensity bitmap file to local storage. More... | |
kStatus | GoControl_ExportCsv (GoControl control, const kChar *dstFileName) |
Export a CSV file to local storage. More... | |
kStatus | GoControl_GetAlignmentReference (GoControl control, GoAlignmentRef *reference) |
Gets the alignment reference for a sensor. More... | |
kStatus | GoControl_GetAutoStartEnabled (GoControl control, kBool *enabled) |
Returns the state of sensor AutoStart. More... | |
kStatus | GoControl_GetDefaultJob (GoControl control, kChar *fileName, kSize capacity) |
Gets the name of the default configuration or template file to be loaded on boot. More... | |
kStatus | GoControl_GetEncoder (GoControl control, k64s *encoder) |
Gets the current system encoder value. More... | |
kStatus | GoControl_GetInputSource (GoControl control, GoInputSource *source) |
Gets the sensor's data input source. More... | |
kStatus | GoControl_GetLoadedJob (GoControl control, kChar *fileName, kSize capacity, kBool *isModified) |
Gets the name of the loaded job file and whether it has been modified since loading. More... | |
kStatus | GoControl_GetRecordingEnabled (GoControl control, kBool *enabled) |
Get's the sensor's recording state. More... | |
kStatus | GoControl_GetScanMode (GoControl control, GoMode *mode) |
Gets the sensor's scan mode. More... | |
kStatus | GoControl_GetSensorInfo (GoControl control, GoSensorInfo info) |
Gets current sensor state information. More... | |
kStatus | GoControl_GetStates (GoControl control, GoStates *states) |
Retrieves a set of various sensor states. More... | |
kStatus | GoControl_GetTimeStamp (GoControl control, k64u *time) |
Gets the current time stamp value(common among all synchronized sensors). More... | |
kStatus | GoControl_GetUpgradeStatus (GoControl control, kBool *complete, kBool *succeeded, k32s *progress) |
Polls for upgrade status. More... | |
kBool | GoControl_IsCompatible (GoControl control) |
Reports whether the GoControl object is compatible with the sensor firmware. More... | |
kBool | GoControl_IsConnected (GoControl control) |
Reports whether the control object has been opened. More... | |
kStatus | GoControl_Login (GoControl control, GoUser user, const kChar *password) |
Logs into the sensor using the specified user name and password. More... | |
kStatus | GoControl_Open (GoControl control, kIpAddress address) |
Opens connections to the specified sensor IP address. More... | |
kStatus | GoControl_PlaybackPosition (GoControl control, k32u *position, k32u *count) |
Get the current frame position in a replay. More... | |
kStatus | GoControl_PlaybackSeek (GoControl control, k32u position) |
Seek to the specified frame position for a replay. More... | |
kStatus | GoControl_PlaybackStep (GoControl control, GoSeekDirection direction) |
Advance one frame in a replay. More... | |
kVersion | GoControl_ProtocolVersion (GoControl control) |
Gets the connected sensor's protocol version. More... | |
kStatus | GoControl_ReadFile (GoControl control, const kChar *fileName, kByte **data, kSize *size, kAlloc allocator) |
Reads a file from the connected sensor. More... | |
kStatus | GoControl_ReadFileList (GoControl control, kArrayList files, const kChar *extensionFilter) |
Reads the list of available sensor files. More... | |
kStatus | GoControl_Reset (GoControl control) |
Reboots the main sensor and any connected buddy sensors. More... | |
kStatus | GoControl_Restore (GoControl control, const kByte *fileData, k32u size) |
Restores a backup of sensor files. More... | |
kStatus | GoControl_RestoreFactory (GoControl control, kBool restoreAddress) |
Restores factory default settings. More... | |
kStatus | GoControl_ScheduleAnalog (GoControl control, k16u index, k64s target, k32s value) |
Schedules an analog output. More... | |
kStatus | GoControl_ScheduleDigital (GoControl control, k16u index, k64s target, k8u value) |
Schedules a digital output. More... | |
kStatus | GoControl_SetAlignmentReference (GoControl control, GoAlignmentRef reference) |
Sets the alignment reference for a sensor. More... | |
kStatus | GoControl_SetAutoStartEnabled (GoControl control, kBool enable) |
Enable or disable sensor AutoStart. More... | |
kStatus | GoControl_SetCancelHandler (GoControl control, kCallbackFx function, kPointer receiver) |
Sets an I/O cancellation query handler for this control object. More... | |
kStatus | GoControl_SetDefaultJob (GoControl control, const kChar *fileName) |
Sets a default job file to be loaded on boot. More... | |
kStatus | GoControl_SetInputSource (GoControl control, GoInputSource source) |
Sets the sensor's data input source. More... | |
kStatus | GoControl_SetRecordingEnabled (GoControl control, kBool enable) |
Enables recording on the sensor. More... | |
kStatus | GoControl_Simulate (GoControl control, kBool *isBufferValid) |
Simulate the current frame stored on the sensor's live replay buffer. More... | |
kStatus | GoControl_Trigger (GoControl control) |
Sends a software trigger to the sensor. More... | |
kStatus | GoControl_WriteFile (GoControl control, const kChar *fileName, const kByte *data, k32u size) |
Writes a file to the connected sensor. More... | |
kStatus GoControl_Backup | ( | GoControl | control, |
kByte ** | fileData, | ||
k32u * | size, | ||
kAlloc | allocator | ||
) |
Creates and downloads a backup of sensor files.
control | GoControl object. |
fileData | Receives a pointer to a buffer containing the backup data. |
size | Receives the size of the allocated buffer. |
allocator | Memory allocator, used to allocate the backup buffer (or kNULL for default). |
kStatus GoControl_BeginAlignment | ( | GoControl | control | ) |
Sends a alignment command to a sensor, but doesn't wait for the response.
Use the EndAlignment function to wait for the sensor's reply.
control | GoControl object. |
kStatus GoControl_BeginExposureAutoSet | ( | GoControl | control, |
GoRole | role | ||
) |
Sends an exposure auto set command to a sensor, but doesn't wait for the response.
Use the EndExposureAutoSet function to wait for the sensor's reply.
control | GoControl object. |
role | The sensor's role. |
kStatus GoControl_BeginStart | ( | GoControl | control | ) |
Sends a start command to a sensor with the currently selected input source, but doesn't wait for the response.
Use the EndStart function to wait for the sensor's reply.
control | GoControl object. |
target | Start time or encoder value. |
kStatus GoControl_BeginStop | ( | GoControl | control | ) |
Sends a stop command to a sensor, but doesn't wait for the response.
Use the EndStop function to wait for the sensor's reply.
control | GoControl object. |
kStatus GoControl_BeginUpgrade | ( | GoControl | control, |
void * | data, | ||
kSize | size | ||
) |
Begins a sensor firmware upgrade.
Use the GetUpgradeStatus function to poll for upgrade completion.
control | GoControl object. |
data | Pointer to buffer containing upgrade file. |
size | Size of upgrade file. |
kStatus GoControl_ChangeBuddy | ( | GoControl | control, |
kBool | add, | ||
k32u | buddyId | ||
) |
Assigns or removes a buddy sensor.
control | GoControl object. |
add | kTRUE to add; kFALSE to remove. |
buddyId | Buddy device id. |
Changes the password associated with the specified user account.
control | GoControl object. |
user | User account. |
password | New password. |
kStatus GoControl_ClearLog | ( | GoControl | control | ) |
kStatus GoControl_ClearMeasurementStats | ( | GoControl | control | ) |
Clear the sensor's measurement statistics.
control | GoControl object. |
kStatus GoControl_ClearReplayData | ( | GoControl | control | ) |
kStatus GoControl_Close | ( | GoControl | control | ) |
kStatus GoControl_Construct | ( | GoControl * | control, |
kAlloc | allocator | ||
) |
Constructs a GoControl object.
control | Receives constructed control object. |
allocator | Memory allocator (or kNULL for default). |
kStatus GoControl_CopyFile | ( | GoControl | control, |
const kChar * | source, | ||
const kChar * | destination | ||
) |
Copies a file within the connected sensor.
control | GoControl object. |
source | Source name for the file to be copied. |
destination | Destination name for the file (maximum 63 characters). |
kStatus GoControl_DeleteFile | ( | GoControl | control, |
const kChar * | fileName | ||
) |
Deletes a file within the connected sensor.
control | GoControl object. |
fileName | Name of the file to be deleted. |
kStatus GoControl_EndAlignment | ( | GoControl | control | ) |
Waits for a alignment response from a sensor.
Call this function sometime after calling BeginAlignment.
control | GoControl object. |
kStatus GoControl_EndExposureAutoSet | ( | GoControl | control | ) |
Waits for a exposure auto set response from a sensor.
Call this function sometime after calling BeginExposureAutoSet.
control | GoControl object. |
kStatus GoControl_EndStart | ( | GoControl | control | ) |
Waits for a start response from a sensor.
Call this function sometime after calling BeginStart.
control | GoControl object. |
kStatus GoControl_EndStop | ( | GoControl | control | ) |
Waits for a stop response from a sensor.
Call this function sometime after calling BeginStop.
control | GoControl object. |
kStatus GoControl_ExportBitmap | ( | GoControl | control, |
GoReplayExportSourceType | type, | ||
GoDataSource | source, | ||
const kChar * | dstFileName | ||
) |
Export an intensity bitmap file to local storage.
control | GoControl object. |
type | The type of data to export. |
source | The data source to obtain data from. |
dstFileName | The destination file name. |
kStatus GoControl_ExportCsv | ( | GoControl | control, |
const kChar * | dstFileName | ||
) |
Export a CSV file to local storage.
control | GoControl object. |
dstFileName | The destination file name. |
kStatus GoControl_GetAlignmentReference | ( | GoControl | control, |
GoAlignmentRef * | reference | ||
) |
Gets the alignment reference for a sensor.
control | GoControl object. |
reference | Alignment reference. |
kStatus GoControl_GetAutoStartEnabled | ( | GoControl | control, |
kBool * | enabled | ||
) |
Returns the state of sensor AutoStart.
enabled | A pointer to store the boolean state of sensor AutoStart. kTRUE if enabled and kFALSE if disabled. |
kStatus GoControl_GetDefaultJob | ( | GoControl | control, |
kChar * | fileName, | ||
kSize | capacity | ||
) |
Gets the name of the default configuration or template file to be loaded on boot.
control | GoControl object. |
extension | Type of file ("cfg", "rec", or "prof"). |
fileName | Receives name of the default file. |
capacity | Name buffer capacity. |
kStatus GoControl_GetEncoder | ( | GoControl | control, |
k64s * | encoder | ||
) |
Gets the current system encoder value.
control | GoControl object. |
encoder | Receives encoder value. |
kStatus GoControl_GetInputSource | ( | GoControl | control, |
GoInputSource * | source | ||
) |
Gets the sensor's data input source.
control | GoControl object. |
inputSource | Receives the data source used by the sensor. |
kStatus GoControl_GetLoadedJob | ( | GoControl | control, |
kChar * | fileName, | ||
kSize | capacity, | ||
kBool * | isModified | ||
) |
Gets the name of the loaded job file and whether it has been modified since loading.
control | GoControl object. |
extension | File extension; identifies type of file (e.g. "cfg"). |
fileName | Receives name of the loaded file. |
capacity | Name buffer capacity. |
isModified | Receives the status of whether the file has changed. |
kStatus GoControl_GetRecordingEnabled | ( | GoControl | control, |
kBool * | enabled | ||
) |
Get's the sensor's recording state.
control | GoControl object. |
enabled | Receives the recording state. |
kStatus GoControl_GetScanMode | ( | GoControl | control, |
GoMode * | mode | ||
) |
Gets the sensor's scan mode.
control | GoControl object. |
mode | Receives the scan mode. |
kStatus GoControl_GetSensorInfo | ( | GoControl | control, |
GoSensorInfo | info | ||
) |
Gets current sensor state information.
control | GoControl object. |
info | Receives sensor information. |
Retrieves a set of various sensor states.
control | GoControl object. |
states | A struct of current sensor states. |
kStatus GoControl_GetTimeStamp | ( | GoControl | control, |
k64u * | time | ||
) |
Gets the current time stamp value(common among all synchronized sensors).
control | GoControl object. |
time | Receives the time stamp value. |
kStatus GoControl_GetUpgradeStatus | ( | GoControl | control, |
kBool * | complete, | ||
kBool * | succeeded, | ||
k32s * | progress | ||
) |
Polls for upgrade status.
control | GoControl object. |
complete | Receives boolean indicating upgrade completion. |
succeeded | If complete, receives boolean indicating whether upgrade was successful. |
progress | If not complete, receives integer percentage indicating progress. |
kBool GoControl_IsCompatible | ( | GoControl | control | ) |
Reports whether the GoControl object is compatible with the sensor firmware.
Compatibility is determined by comparing the major protocol version reported by the sensor with the major protocol version supported by this library. If the major versions match, then compatibility is established.
control | GoControl object. |
kBool GoControl_IsConnected | ( | GoControl | control | ) |
Reports whether the control object has been opened.
control | GoControl object. |
Logs into the sensor using the specified user name and password.
control | GoControl object. |
user | User account. |
password | User password. |
kStatus GoControl_Open | ( | GoControl | control, |
kIpAddress | address | ||
) |
Opens connections to the specified sensor IP address.
The Open function immediately opens a control connection. Later, while in the open state, if an upgrade command is given, an upgrade connection will be established automatically at that time.
control | GoControl object. |
address | Sensor IP address. |
kStatus GoControl_PlaybackPosition | ( | GoControl | control, |
k32u * | position, | ||
k32u * | count | ||
) |
Get the current frame position in a replay.
control | GoControl object. |
position | Replay frame position. |
count | Replay frame count. |
kStatus GoControl_PlaybackSeek | ( | GoControl | control, |
k32u | position | ||
) |
Seek to the specified frame position for a replay.
control | GoControl object. |
position | Replay frame position. |
kStatus GoControl_PlaybackStep | ( | GoControl | control, |
GoSeekDirection | direction | ||
) |
Advance one frame in a replay.
control | GoControl object. |
direction | The direction to seek. |
kVersion GoControl_ProtocolVersion | ( | GoControl | control | ) |
Gets the connected sensor's protocol version.
control | GoControl object. |
kStatus GoControl_ReadFile | ( | GoControl | control, |
const kChar * | fileName, | ||
kByte ** | data, | ||
kSize * | size, | ||
kAlloc | allocator | ||
) |
Reads a file from the connected sensor.
control | GoControl object. |
fileName | Name of remote file to be read. |
data | Receives a pointer to a buffer containing the file data. |
size | Receives the size of the allocated buffer. |
allocator | Memory allocator, used to allocate the file buffer (or kNULL for default). |
kStatus GoControl_ReadFileList | ( | GoControl | control, |
kArrayList | files, | ||
const kChar * | extensionFilter | ||
) |
Reads the list of available sensor files.
control | GoControl object. |
files | List to be populated with file names (kArrayList<kText64>). |
extensionFilter | Can be used to filter the file list: "cfg", "rec", "prof", "xml", or null for all. |
kStatus GoControl_Reset | ( | GoControl | control | ) |
Reboots the main sensor and any connected buddy sensors.
control | GoControl object. |
kStatus GoControl_Restore | ( | GoControl | control, |
const kByte * | fileData, | ||
k32u | size | ||
) |
Restores a backup of sensor files.
control | GoControl object. |
fileData | Pointer to a buffer containing the backup data to be restored. |
size | Size of the backup buffer. |
kStatus GoControl_RestoreFactory | ( | GoControl | control, |
kBool | restoreAddress | ||
) |
Restores factory default settings.
control | GoControl object. |
restoreAddress | kTRUE to restore the factory default IP address; False otherwise. |
kStatus GoControl_ScheduleAnalog | ( | GoControl | control, |
k16u | index, | ||
k64s | target, | ||
k32s | value | ||
) |
Schedules an analog output.
control | GoControl object. |
index | The analog output index. |
target | The time or position target (us or mm), depending on the configured domain. Ignored if scheduling disabled. |
value | The value of the scheduled output (mA). |
kStatus GoControl_ScheduleDigital | ( | GoControl | control, |
k16u | index, | ||
k64s | target, | ||
k8u | value | ||
) |
Schedules a digital output.
control | GoControl object. |
index | The digital output index. |
target | The time or position target (us or mm), depending on the configured domain. Ignored if scheduling disabled or pulsed mode enabled. |
value | The value of scheduled output (0-Low or 1-High). Ignored if pulsed mode enabled. |
kStatus GoControl_SetAlignmentReference | ( | GoControl | control, |
GoAlignmentRef | reference | ||
) |
Sets the alignment reference for a sensor.
control | GoControl object. |
reference | Alignment reference. |
kStatus GoControl_SetAutoStartEnabled | ( | GoControl | control, |
kBool | enable | ||
) |
Enable or disable sensor AutoStart.
enable | kTRUE to enable AutoStart, kFALSE to disable it. |
kStatus GoControl_SetCancelHandler | ( | GoControl | control, |
kCallbackFx | function, | ||
kPointer | receiver | ||
) |
Sets an I/O cancellation query handler for this control object.
The I/O cancellation query handler will be polled periodically when I/O is blocked for a non-negligible amount of time. If the cancellation handler returns kERROR_ABORT, ongoing communication will be terminated.
control | Control object. |
function | I/O cancellation callback function (or kNULL to unregister). |
receiver | Receiver argument for callback. |
kStatus GoControl_SetDefaultJob | ( | GoControl | control, |
const kChar * | fileName | ||
) |
Sets a default job file to be loaded on boot.
control | GoControl object. |
fileName | Name of the default file. |
kStatus GoControl_SetInputSource | ( | GoControl | control, |
GoInputSource | source | ||
) |
Sets the sensor's data input source.
control | GoControl object. |
inputSource | The input source to set. |
kStatus GoControl_SetRecordingEnabled | ( | GoControl | control, |
kBool | enable | ||
) |
Enables recording on the sensor.
control | GoControl object. |
enable | Enable or disable recording. |
kStatus GoControl_Simulate | ( | GoControl | control, |
kBool * | isBufferValid | ||
) |
Simulate the current frame stored on the sensor's live replay buffer.
control | GoControl object. |
isBufferValid | Represents whether the specified data input source contained valid data to simulate against. |
kStatus GoControl_Trigger | ( | GoControl | control | ) |
Sends a software trigger to the sensor.
control | GoControl object. |
kStatus GoControl_WriteFile | ( | GoControl | control, |
const kChar * | fileName, | ||
const kByte * | data, | ||
k32u | size | ||
) |
Writes a file to the connected sensor.
control | GoControl object. |
fileName | Name of remote file to be written. |
data | Pointer to buffer containing the file data. |
size | Size of the file. |