Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoControl.h
Go to the documentation of this file.
1 /**
2  * @file GoControl.h
3  * @brief Declares the GoControl class.
4  *
5  * @internal
6  * Copyright (C) 2011-2012 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_API_CONTROL_H
11 #define GO_API_CONTROL_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoSensorInfo.h>
15 #include <kApi/Io/kSerializer.h>
16 #include <kApi/Io/kFile.h>
17 kBeginHeader()
18 
19 /**
20  * @class GoControl
21  * @extends kObject
22  * @ingroup GoSdk-Internal
23  * @brief Represents a set of sensor command connections (control, upgrade).
24  */
25 typedef kObject GoControl;
26 
27 /**
28  * Constructs a GoControl object.
29  *
30  * @public @memberof GoControl
31  * @param control Receives constructed control object.
32  * @param allocator Memory allocator (or kNULL for default).
33  * @return Operation status.
34  */
35 GoFx(kStatus) GoControl_Construct(GoControl* control, kAlloc allocator);
36 
37 /**
38  * Sets an I/O cancellation query handler for this control object.
39  *
40  * The I/O cancellation query handler will be polled periodically when I/O is blocked
41  * for a non-negligible amount of time. If the cancellation handler returns kERROR_ABORT,
42  * ongoing communication will be terminated.
43  *
44  * @public @memberof GoControl
45  * @param control Control object.
46  * @param function I/O cancellation callback function (or kNULL to unregister).
47  * @param receiver Receiver argument for callback.
48  * @return Operation status.
49  */
50 GoFx(kStatus) GoControl_SetCancelHandler(GoControl control, kCallbackFx function, kPointer receiver);
51 
52 /**
53  * Opens connections to the specified sensor IP address.
54  *
55  * The Open function immediately opens a control connection. Later, while in the
56  * open state, if an upgrade command is given, an upgrade connection will be established
57  * automatically at that time.
58  *
59  * @public @memberof GoControl
60  * @param control GoControl object.
61  * @param address Sensor IP address.
62  * @return Operation status.
63  */
64 GoFx(kStatus) GoControl_Open(GoControl control, kIpAddress address);
65 
66 /**
67  * Closes all open command connections.
68  *
69  * @public @memberof GoControl
70  * @param control GoControl object.
71  * @return Operation status.
72  */
73 GoFx(kStatus) GoControl_Close(GoControl control);
74 
75 /**
76  * Reports whether the control object has been opened.
77  *
78  * @public @memberof GoControl
79  * @param control GoControl object.
80  * @return kTRUE if connected; kFALSE otherwise.
81  */
82 GoFx(kBool) GoControl_IsConnected(GoControl control);
83 
84 /**
85  * Gets the connected sensor's protocol version.
86  *
87  * @public @memberof GoControl
88  * @param control GoControl object.
89  * @return Protocol version.
90  */
91 GoFx(kVersion) GoControl_ProtocolVersion(GoControl control);
92 
93 /**
94  * Reports whether the GoControl object is compatible with the sensor firmware.
95  *
96  * Compatibility is determined by comparing the major protocol version reported
97  * by the sensor with the major protocol version supported by this library. If
98  * the major versions match, then compatibility is established.
99  *
100  * @public @memberof GoControl
101  * @param control GoControl object.
102  * @return kTRUE if compatible; kFALSE otherwise.
103  */
104 GoFx(kBool) GoControl_IsCompatible(GoControl control);
105 
106 /**
107  * Logs into the sensor using the specified user name and password.
108  *
109  * @public @memberof GoControl
110  * @param control GoControl object.
111  * @param user User account.
112  * @param password User password.
113  * @return Operation status.
114  */
115 GoFx(kStatus) GoControl_Login(GoControl control, GoUser user, const kChar* password);
116 
117 /**
118  * Changes the password associated with the specified user account.
119  *
120  * @public @memberof GoControl
121  * @param control GoControl object.
122  * @param user User account.
123  * @param password New password.
124  * @return Operation status.
125  */
126 GoFx(kStatus) GoControl_ChangePassword(GoControl control, GoUser user, const kChar* password);
127 
128 /**
129  * Gets current sensor state information.
130  *
131  * @public @memberof GoControl
132  * @param control GoControl object.
133  * @param info Receives sensor information.
134  * @return Operation status.
135  */
136 GoFx(kStatus) GoControl_GetSensorInfo(GoControl control, GoSensorInfo info);
137 
138 /**
139  * Gets the sensor's scan mode.
140  *
141  * @public @memberof GoControl
142  * @param control GoControl object.
143  * @param mode Receives the scan mode.
144  * @return Operation status.
145  */
146 GoFx(kStatus) GoControl_GetScanMode(GoControl control, GoMode* mode);
147 
148 /**
149  * Assigns or removes a buddy sensor.
150  *
151  * @public @memberof GoControl
152  * @param control GoControl object.
153  * @param add kTRUE to add; kFALSE to remove.
154  * @param buddyId Buddy device id.
155  * @return Operation status.
156  */
157 GoFx(kStatus) GoControl_ChangeBuddy(GoControl control, kBool add, k32u buddyId);
158 
159 /**
160  * Sends a start command to a sensor with the currently selected input source, but doesn't wait for the response.
161  *
162  * Use the EndStart function to wait for the sensor's reply.
163  *
164  * @public @memberof GoControl
165  * @param control GoControl object.
166  * @param target Start time or encoder value.
167  * @return Operation status.
168  * @see GoControl_SetInputSource, GoControl_GetInputSource
169  */
170 GoFx(kStatus) GoControl_BeginStart(GoControl control);
171 
172 /**
173  * Waits for a start response from a sensor.
174  *
175  * Call this function sometime after calling BeginStart.
176  *
177  * @public @memberof GoControl
178  * @param control GoControl object.
179  * @return Operation status.
180  */
181 GoFx(kStatus) GoControl_EndStart(GoControl control);
182 
183 /**
184  * Sends a stop command to a sensor, but doesn't wait for the response.
185  *
186  * Use the EndStop function to wait for the sensor's reply.
187  *
188  * @public @memberof GoControl
189  * @param control GoControl object.
190  * @return Operation status.
191  */
192 GoFx(kStatus) GoControl_BeginStop(GoControl control);
193 
194 /**
195  * Waits for a stop response from a sensor.
196  *
197  * Call this function sometime after calling BeginStop.
198  *
199  * @public @memberof GoControl
200  * @param control GoControl object.
201  * @return Operation status.
202  */
203 GoFx(kStatus) GoControl_EndStop(GoControl control);
204 
205 
206 /**
207  * Sends a alignment command to a sensor, but doesn't wait for the response.
208  *
209  * Use the EndAlignment function to wait for the sensor's reply.
210  *
211  * @public @memberof GoControl
212  * @param control GoControl object.
213  * @return Operation status.
214  */
215 GoFx(kStatus) GoControl_BeginAlignment(GoControl control);
216 
217 /**
218  * Waits for a alignment response from a sensor.
219  *
220  * Call this function sometime after calling BeginAlignment.
221  *
222  * @public @memberof GoControl
223  * @param control GoControl object.
224  * @return Operation status.
225  */
226 GoFx(kStatus) GoControl_EndAlignment(GoControl control);
227 
228 /**
229  * Sets the alignment reference for a sensor.
230  *
231  * @public @memberof GoControl
232  * @param control GoControl object.
233  * @param reference Alignment reference.
234  * @return Operation status.
235  */
236 GoFx(kStatus) GoControl_SetAlignmentReference(GoControl control, GoAlignmentRef reference);
237 
238 /**
239  * Gets the alignment reference for a sensor.
240  *
241  * @public @memberof GoControl
242  * @param control GoControl object.
243  * @param reference Alignment reference.
244  * @return Operation status.
245  */
246 GoFx(kStatus) GoControl_GetAlignmentReference(GoControl control, GoAlignmentRef* reference);
247 
248 
249 
250 /**
251  * Sends an exposure auto set command to a sensor, but doesn't wait for the response.
252  *
253  * Use the EndExposureAutoSet function to wait for the sensor's reply.
254  *
255  * @public @memberof GoControl
256  * @param control GoControl object.
257  * @param role The sensor's role.
258  * @return Operation status.
259  */
260 GoFx(kStatus) GoControl_BeginExposureAutoSet(GoControl control, GoRole role);
261 
262 /**
263  * Waits for a exposure auto set response from a sensor.
264  *
265  * Call this function sometime after calling BeginExposureAutoSet.
266  *
267  * @public @memberof GoControl
268  * @param control GoControl object.
269  * @return Operation status.
270  */
271 GoFx(kStatus) GoControl_EndExposureAutoSet(GoControl control);
272 
273 
274 /**
275  * Reads the list of available sensor files.
276  *
277  * @public @memberof GoControl
278  * @param control GoControl object.
279  * @param files List to be populated with file names (kArrayList<kText64>).
280  * @param extensionFilter Can be used to filter the file list: "cfg", "rec", "prof", "xml", or null for all.
281  * @return Operation status.
282  */
283 GoFx(kStatus) GoControl_ReadFileList(GoControl control, kArrayList files, const kChar* extensionFilter);
284 
285 /**
286  * Reads a file from the connected sensor.
287  *
288  * @public @memberof GoControl
289  * @param control GoControl object.
290  * @param fileName Name of remote file to be read.
291  * @param data Receives a pointer to a buffer containing the file data.
292  * @param size Receives the size of the allocated buffer.
293  * @param allocator Memory allocator, used to allocate the file buffer (or kNULL for default).
294  * @return Operation status.
295  */
296 GoFx(kStatus) GoControl_ReadFile(GoControl control, const kChar* fileName, kByte** data, kSize* size, kAlloc allocator);
297 
298 /**
299  * Clears the sensor log file.
300  *
301  * @public @memberof GoControl
302  * @param control GoControl object.
303  * @return Operation status.
304  */
305 GoFx(kStatus) GoControl_ClearLog(GoControl control);
306 
307 /**
308  * Writes a file to the connected sensor.
309  *
310  * @public @memberof GoControl
311  * @param control GoControl object.
312  * @param fileName Name of remote file to be written.
313  * @param data Pointer to buffer containing the file data.
314  * @param size Size of the file.
315  * @return Operation status.
316  */
317 GoFx(kStatus) GoControl_WriteFile(GoControl control, const kChar* fileName, const kByte* data, k32u size);
318 
319 /**
320  * Copies a file within the connected sensor.
321  *
322  * @public @memberof GoControl
323  * @param control GoControl object.
324  * @param source Source name for the file to be copied.
325  * @param destination Destination name for the file (maximum 63 characters).
326  * @return Operation status.
327  */
328 GoFx(kStatus) GoControl_CopyFile(GoControl control, const kChar* source, const kChar* destination);
329 
330 /**
331  * Deletes a file within the connected sensor.
332  *
333  * @public @memberof GoControl
334  * @param control GoControl object.
335  * @param fileName Name of the file to be deleted.
336  * @return Operation status.
337  */
338 GoFx(kStatus) GoControl_DeleteFile(GoControl control, const kChar* fileName);
339 
340 /**
341  * Gets the name of the default configuration or template file to be loaded on boot.
342  *
343  * @public @memberof GoControl
344  * @param control GoControl object.
345  * @param extension Type of file ("cfg", "rec", or "prof").
346  * @param fileName Receives name of the default file.
347  * @param capacity Name buffer capacity.
348  * @return Operation status.
349  */
350 GoFx(kStatus) GoControl_GetDefaultJob(GoControl control, kChar* fileName, kSize capacity);
351 
352 /**
353  * Sets a default job file to be loaded on boot.
354  *
355  * @public @memberof GoControl
356  * @param control GoControl object.
357  * @param fileName Name of the default file.
358  * @return Operation status.
359  */
360 GoFx(kStatus) GoControl_SetDefaultJob(GoControl control, const kChar* fileName);
361 
362 /**
363  * Gets the name of the loaded job file and whether it has been modified since loading.
364  *
365  * @public @memberof GoControl
366  * @param control GoControl object.
367  * @param extension File extension; identifies type of file (e.g. "cfg").
368  * @param fileName Receives name of the loaded file.
369  * @param capacity Name buffer capacity.
370  * @param isModified Receives the status of whether the file has changed.
371  * @return Operation status.
372  */
373 GoFx(kStatus) GoControl_GetLoadedJob(GoControl control, kChar* fileName, kSize capacity, kBool* isModified);
374 
375 /**
376  * Restores factory default settings.
377  *
378  * @public @memberof GoControl
379  * @param control GoControl object.
380  * @param restoreAddress kTRUE to restore the factory default IP address; False otherwise.
381  * @return Operation status.
382  */
383 GoFx(kStatus) GoControl_RestoreFactory(GoControl control, kBool restoreAddress);
384 
385 /**
386  * Reboots the main sensor and any connected buddy sensors.
387  *
388  * @public @memberof GoControl
389  * @param control GoControl object.
390  * @return Operation status.
391  */
392 GoFx(kStatus) GoControl_Reset(GoControl control);
393 
394 /**
395  * Begins a sensor firmware upgrade.
396  *
397  * Use the GetUpgradeStatus function to poll for upgrade completion.
398  *
399  * @public @memberof GoControl
400  * @param control GoControl object.
401  * @param data Pointer to buffer containing upgrade file.
402  * @param size Size of upgrade file.
403  * @return Operation status.
404  */
405 GoFx(kStatus) GoControl_BeginUpgrade(GoControl control, void* data, kSize size);
406 
407 /**
408  * Polls for upgrade status.
409  *
410  * @public @memberof GoControl
411  * @param control GoControl object.
412  * @param complete Receives boolean indicating upgrade completion.
413  * @param succeeded If complete, receives boolean indicating whether upgrade was successful.
414  * @param progress If not complete, receives integer percentage indicating progress.
415  * @return Operation status.
416  */
417 GoFx(kStatus) GoControl_GetUpgradeStatus(GoControl control, kBool* complete, kBool* succeeded, k32s* progress);
418 
419 /**
420  * Gets the current time stamp value(common among all synchronized sensors).
421  *
422  * @public @memberof GoControl
423  * @param control GoControl object.
424  * @param time Receives the time stamp value.
425  * @return Operation status.
426  */
427 GoFx(kStatus) GoControl_GetTimeStamp(GoControl control, k64u* time);
428 
429 /**
430  * Gets the current system encoder value.
431  *
432  * @public @memberof GoControl
433  * @param control GoControl object.
434  * @param encoder Receives encoder value.
435  * @return Operation status.
436  */
437 GoFx(kStatus) GoControl_GetEncoder(GoControl control, k64s* encoder);
438 
439 /**
440  * Sends a software trigger to the sensor.
441  *
442  * @public @memberof GoControl
443  * @param control GoControl object.
444  * @return Operation status.
445  */
446 GoFx(kStatus) GoControl_Trigger(GoControl control);
447 
448 /**
449  * Creates and downloads a backup of sensor files.
450  *
451  * @public @memberof GoControl
452  * @param control GoControl object.
453  * @param fileData Receives a pointer to a buffer containing the backup data.
454  * @param size Receives the size of the allocated buffer.
455  * @param allocator Memory allocator, used to allocate the backup buffer (or kNULL for default).
456  * @return Operation status.
457  */
458 GoFx(kStatus) GoControl_Backup(GoControl control, kByte** fileData, k32u* size, kAlloc allocator);
459 
460 /**
461  * Restores a backup of sensor files.
462  *
463  * @public @memberof GoControl
464  * @param control GoControl object.
465  * @param fileData Pointer to a buffer containing the backup data to be restored.
466  * @param size Size of the backup buffer.
467  * @return Operation status.
468  */
469 GoFx(kStatus) GoControl_Restore(GoControl control, const kByte* fileData, k32u size);
470 
471 /**
472  * Schedules a digital output.
473  *
474  * @public @memberof GoControl
475  * @param control GoControl object.
476  * @param index The digital output index.
477  * @param target The time or position target (us or mm), depending on the configured domain. Ignored if
478  * scheduling disabled or pulsed mode enabled.
479  * @param value The value of scheduled output (0-Low or 1-High). Ignored if pulsed mode enabled.
480  * @return Operation status.
481  */
482 GoFx(kStatus) GoControl_ScheduleDigital(GoControl control, k16u index, k64s target, k8u value);
483 
484 /**
485  * Schedules an analog output.
486  *
487  * @public @memberof GoControl
488  * @param control GoControl object.
489  * @param index The analog output index.
490  * @param target The time or position target (us or mm), depending on the configured domain. Ignored if
491  * scheduling disabled.
492  * @param value The value of the scheduled output (mA).
493  * @return Operation status.
494  */
495 GoFx(kStatus) GoControl_ScheduleAnalog(GoControl control, k16u index, k64s target, k32s value);
496 
497 /**
498  * Retrieves a set of various sensor states.
499  *
500  * @public @memberof GoControl
501  * @param control GoControl object.
502  * @param states A struct of current sensor states.
503  * @return Operation status.
504  */
505 GoFx(kStatus) GoControl_GetStates(GoControl control, GoStates* states);
506 
507 /**
508  * Enables recording on the sensor.
509  *
510  * @public @memberof GoControl
511  * @param control GoControl object.
512  * @param enable Enable or disable recording.
513  * @return Operation status.
514  */
515 GoFx(kStatus) GoControl_SetRecordingEnabled(GoControl control, kBool enable);
516 
517 /**
518  * Get's the sensor's recording state.
519  *
520  * @public @memberof GoControl
521  * @param control GoControl object.
522  * @param enabled Receives the recording state.
523  * @return Operation status.
524  */
525 GoFx(kStatus) GoControl_GetRecordingEnabled(GoControl control, kBool* enabled);
526 
527 /**
528  * Sets the sensor's data input source.
529  *
530  * @public @memberof GoControl
531  * @param control GoControl object.
532  * @param inputSource The input source to set.
533  * @return Operation status.
534  */
535 GoFx(kStatus) GoControl_SetInputSource(GoControl control, GoInputSource source);
536 
537 /**
538  * Gets the sensor's data input source.
539  *
540  * @public @memberof GoControl
541  * @param control GoControl object.
542  * @param inputSource Receives the data source used by the sensor.
543  * @return Operation status.
544  */
545 GoFx(kStatus) GoControl_GetInputSource(GoControl control, GoInputSource* source);
546 
547 /**
548  * Clear the sensor's replay data.
549  *
550  * @public @memberof GoControl
551  * @param control GoControl object.
552  * @return Operation status.
553  */
554 GoFx(kStatus) GoControl_ClearReplayData(GoControl control);
555 
556 /**
557  * Simulate the current frame stored on the sensor's live replay buffer.
558  *
559  * @public @memberof GoControl
560  * @param control GoControl object.
561  * @param isBufferValid Represents whether the specified data input source contained valid data to simulate against.
562  * @return Operation status.
563  */
564 GoFx(kStatus) GoControl_Simulate(GoControl control, kBool* isBufferValid);
565 
566 /**
567  * Clear the sensor's measurement statistics.
568  *
569  * @public @memberof GoControl
570  * @param control GoControl object.
571  * @return Operation status.
572  */
573 GoFx(kStatus) GoControl_ClearMeasurementStats(GoControl control);
574 
575 /**
576  * Seek to the specified frame position for a replay.
577  *
578  * @public @memberof GoControl
579  * @param control GoControl object.
580  * @param position Replay frame position.
581  * @return Operation status.
582  */
583 GoFx(kStatus) GoControl_PlaybackSeek(GoControl control, k32u position);
584 
585 /**
586  * Advance one frame in a replay.
587  *
588  * @public @memberof GoControl
589  * @param control GoControl object.
590  * @param direction The direction to seek.
591  * @return Operation status.
592  */
593 GoFx(kStatus) GoControl_PlaybackStep(GoControl control, GoSeekDirection direction);
594 
595 /**
596  * Get the current frame position in a replay.
597  *
598  * @public @memberof GoControl
599  * @param control GoControl object.
600  * @param position Replay frame position.
601  * @param count Replay frame count.
602  * @return Operation status.
603  */
604 GoFx(kStatus) GoControl_PlaybackPosition(GoControl control, k32u* position, k32u* count);
605 
606 /**
607  * Export an intensity bitmap file to local storage.
608  *
609  * @public @memberof GoControl
610  * @param control GoControl object.
611  * @param type The type of data to export.
612  * @param source The data source to obtain data from.
613  * @param dstFileName The destination file name.
614  * @return Operation status.
615  */
616 GoFx(kStatus) GoControl_ExportBitmap(GoControl control,
617  GoReplayExportSourceType type,
618  GoDataSource source,
619  const kChar* dstFileName);
620 
621 /**
622  * Export a CSV file to local storage.
623  *
624  * @public @memberof GoControl
625  * @param control GoControl object.
626  * @param dstFileName The destination file name.
627  * @return Operation status.
628  */
629 GoFx(kStatus) GoControl_ExportCsv(GoControl control, const kChar* dstFileName);
630 
631 /**
632  * Enable or disable sensor AutoStart.
633  *
634  * @public @memberof GoControl
635  * @param enable kTRUE to enable AutoStart, kFALSE to disable it.
636  * @return Operation status.
637  */
638 GoFx(kStatus) GoControl_SetAutoStartEnabled(GoControl control, kBool enable);
639 
640 /**
641  * Returns the state of sensor AutoStart.
642  *
643  * @public @memberof GoControl
644  * @param enabled A pointer to store the boolean state of sensor AutoStart. kTRUE if enabled and kFALSE if disabled.
645  * @return Operation status.
646  */
647 GoFx(kStatus) GoControl_GetAutoStartEnabled(GoControl control, kBool* enabled);
648 
649 
650 kEndHeader()
651 #include <GoSdk/GoControl.x.h>
652 
653 #endif
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.