10 #ifndef GO_API_CONTROL_H
11 #define GO_API_CONTROL_H
15 #include <kApi/Io/kSerializer.h>
16 #include <kApi/Io/kFile.h>
64 GoFx(kStatus)
GoControl_Open(GoControl control, kIpAddress address);
296 GoFx(kStatus)
GoControl_ReadFile(GoControl control, const kChar* fileName, kByte** data, kSize* size, kAlloc allocator);
317 GoFx(kStatus)
GoControl_WriteFile(GoControl control, const kChar* fileName, const kByte* data, k32u size);
328 GoFx(kStatus)
GoControl_CopyFile(GoControl control, const kChar* source, const kChar* destination);
373 GoFx(kStatus)
GoControl_GetLoadedJob(GoControl control, kChar* fileName, kSize capacity, kBool* isModified);
458 GoFx(kStatus)
GoControl_Backup(GoControl control, kByte** fileData, k32u* size, kAlloc allocator);
469 GoFx(kStatus)
GoControl_Restore(GoControl control, const kByte* fileData, k32u size);
617 GoReplayExportSourceType type,
619 const kChar* dstFileName);
651 #include <GoSdk/GoControl.x.h>
Sensor state, login, alignment reference, alignment state, recording state, and playback source...
Definition: GoSdkDef.h:362
kStatus GoControl_BeginUpgrade(GoControl control, void *data, kSize size)
Begins a sensor firmware upgrade.
kStatus GoControl_BeginAlignment(GoControl control)
Sends a alignment command to a sensor, but doesn't wait for the response.
kStatus GoControl_SetRecordingEnabled(GoControl control, kBool enable)
Enables recording on the sensor.
Represents a ...
Definition: GoSensorInfo.h:14
kStatus GoControl_ChangeBuddy(GoControl control, kBool add, k32u buddyId)
Assigns or removes a buddy sensor.
Represents a set of sensor command connections (control, upgrade).
Definition: GoControl.h:17
kStatus GoControl_EndExposureAutoSet(GoControl control)
Waits for a exposure auto set response from a sensor.
kStatus GoControl_ExportCsv(GoControl control, const kChar *dstFileName)
Export a CSV file to local storage.
kStatus GoControl_Trigger(GoControl control)
Sends a software trigger to the sensor.
kStatus GoControl_GetAutoStartEnabled(GoControl control, kBool *enabled)
Returns the state of sensor AutoStart.
kStatus GoControl_GetInputSource(GoControl control, GoInputSource *source)
Gets the sensor's data input source.
kStatus GoControl_SetInputSource(GoControl control, GoInputSource source)
Sets the sensor's data input source.
kStatus GoControl_Login(GoControl control, GoUser user, const kChar *password)
Logs into the sensor using the specified user name and password.
kStatus GoControl_Backup(GoControl control, kByte **fileData, k32u *size, kAlloc allocator)
Creates and downloads a backup of sensor files.
kStatus GoControl_Reset(GoControl control)
Reboots the main sensor and any connected buddy sensors.
kStatus GoControl_BeginStop(GoControl control)
Sends a stop command to a sensor, but doesn't wait for the response.
kStatus GoControl_SetDefaultJob(GoControl control, const kChar *fileName)
Sets a default job file to be loaded on boot.
kStatus GoControl_ExportBitmap(GoControl control, GoReplayExportSourceType type, GoDataSource source, const kChar *dstFileName)
Export an intensity bitmap file to local storage.
kStatus GoControl_ScheduleAnalog(GoControl control, k16u index, k64s target, k32s value)
Schedules an analog output.
Represents a data source.
kStatus GoControl_ScheduleDigital(GoControl control, k16u index, k64s target, k8u value)
Schedules a digital output.
kStatus GoControl_GetSensorInfo(GoControl control, GoSensorInfo info)
Gets current sensor state information.
kStatus GoControl_SetCancelHandler(GoControl control, kCallbackFx function, kPointer receiver)
Sets an I/O cancellation query handler for this control object.
kStatus GoControl_Construct(GoControl *control, kAlloc allocator)
Constructs a GoControl object.
kStatus GoControl_ClearLog(GoControl control)
Clears the sensor log file.
Declares the GoSensorInfo class.
kStatus GoControl_ChangePassword(GoControl control, GoUser user, const kChar *password)
Changes the password associated with the specified user account.
kStatus GoControl_PlaybackPosition(GoControl control, k32u *position, k32u *count)
Get the current frame position in a replay.
kStatus GoControl_PlaybackSeek(GoControl control, k32u position)
Seek to the specified frame position for a replay.
kStatus GoControl_DeleteFile(GoControl control, const kChar *fileName)
Deletes a file within the connected sensor.
kStatus GoControl_EndStop(GoControl control)
Waits for a stop response from a sensor.
kStatus GoControl_GetDefaultJob(GoControl control, kChar *fileName, kSize capacity)
Gets the name of the default configuration or template file to be loaded on boot. ...
Essential API declarations.
kStatus GoControl_ReadFile(GoControl control, const kChar *fileName, kByte **data, kSize *size, kAlloc allocator)
Reads a file from the connected sensor.
kStatus GoControl_GetAlignmentReference(GoControl control, GoAlignmentRef *reference)
Gets the alignment reference for a sensor.
kStatus GoControl_ClearMeasurementStats(GoControl control)
Clear the sensor's measurement statistics.
kStatus GoControl_SetAutoStartEnabled(GoControl control, kBool enable)
Enable or disable sensor AutoStart.
kStatus GoControl_Open(GoControl control, kIpAddress address)
Opens connections to the specified sensor IP address.
kVersion GoControl_ProtocolVersion(GoControl control)
Gets the connected sensor's protocol version.
Represents a user id.
Definition: GoSdkDef.h:15
kStatus GoControl_PlaybackStep(GoControl control, GoSeekDirection direction)
Advance one frame in a replay.
kStatus GoControl_RestoreFactory(GoControl control, kBool restoreAddress)
Restores factory default settings.
kStatus GoControl_CopyFile(GoControl control, const kChar *source, const kChar *destination)
Copies a file within the connected sensor.
kStatus GoControl_GetStates(GoControl control, GoStates *states)
Retrieves a set of various sensor states.
kStatus GoControl_EndStart(GoControl control)
Waits for a start response from a sensor.
kStatus GoControl_Restore(GoControl control, const kByte *fileData, k32u size)
Restores a backup of sensor files.
kStatus GoControl_EndAlignment(GoControl control)
Waits for a alignment response from a sensor.
kStatus GoControl_GetTimeStamp(GoControl control, k64u *time)
Gets the current time stamp value(common among all synchronized sensors).
kStatus GoControl_ReadFileList(GoControl control, kArrayList files, const kChar *extensionFilter)
Reads the list of available sensor files.
kStatus GoControl_SetAlignmentReference(GoControl control, GoAlignmentRef reference)
Sets the alignment reference for a sensor.
kStatus GoControl_ClearReplayData(GoControl control)
Clear the sensor's replay data.
kStatus GoControl_BeginStart(GoControl control)
Sends a start command to a sensor with the currently selected input source, but doesn't wait for the ...
kStatus GoControl_Simulate(GoControl control, kBool *isBufferValid)
Simulate the current frame stored on the sensor's live replay buffer.
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.
kStatus GoControl_BeginExposureAutoSet(GoControl control, GoRole role)
Sends an exposure auto set command to a sensor, but doesn't wait for the response.
kBool GoControl_IsConnected(GoControl control)
Reports whether the control object has been opened.
kStatus GoControl_GetUpgradeStatus(GoControl control, kBool *complete, kBool *succeeded, k32s *progress)
Polls for upgrade status.
kStatus GoControl_GetRecordingEnabled(GoControl control, kBool *enabled)
Get's the sensor's recording state.
kStatus GoControl_GetEncoder(GoControl control, k64s *encoder)
Gets the current system encoder value.
kStatus GoControl_GetScanMode(GoControl control, GoMode *mode)
Gets the sensor's scan mode.
kBool GoControl_IsCompatible(GoControl control)
Reports whether the GoControl object is compatible with the sensor firmware.
kStatus GoControl_Close(GoControl control)
Closes all open command connections.
kStatus GoControl_WriteFile(GoControl control, const kChar *fileName, const kByte *data, k32u size)
Writes a file to the connected sensor.