Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSensor.h
Go to the documentation of this file.
1 /**
2 * @file GoSensor.h
3 * @brief Declares the GoSensor class.
4 *
5 * @internal
6 * Copyright (C) 2016 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SENSOR_H
11 #define GO_SENSOR_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoSetup.h>
15 #include <GoSdk/GoPartModel.h>
16 #include <GoSdk/GoReplay.h>
17 #include <GoSdk/GoTransform.h>
18 #include <GoSdk/GoSensorInfo.h>
19 #include <GoSdk/Messages/GoDataSet.h>
20 #include <GoSdk/Outputs/GoOutput.h>
21 #include <GoSdk/Tools/GoTools.h>
22
23 kBeginHeader()
24
25 #define GO_SENSOR_LIVE_JOB_NAME "_live.job" //<<< Represents the active live job on the sensor
26 #define GO_SENSOR_LIVE_LOG_NAME "_live.log" //<<< Represents the log file on the sensor
27 #define GO_SENSOR_LIVE_REPLAY "_live.rec" //<<< Represents the current recording on the sensor
28
29 /**
30 * @class GoSensor
31 * @extends kObject
32 * @ingroup GoSdk
33 * @brief Represents a Gocator sensor.
34 */
35 typedef kObject GoSensor;
36
37 /**
38 * Initiates a sensor configuration, model file, and transformation synchronization
39 * if modifications are present.
40 *
41 * @public @memberof GoSetup
42 * @version Introduced in firmware 4.0.10.27
43 * @param sensor GoSensor object.
44 * @return Operation status.
45 */
46 GoFx(kStatus) GoSensor_Flush(GoSensor sensor);
47
48 /**
49 * Configures a sensor's network address settings.
50 *
51 * This function uses UDP broadcasts for sensor configuration; the sensor does not need to
52 * be connected, and can be on a different subnet than the client.
53 *
54 * The sensor will automatically reboot if the address is successfully changed.
55 *
56 * @public @memberof GoSensor
57 * @version Introduced in firmware 4.0.10.27
58 * @param sensor GoSensor object.
59 * @param info New address settings.
60 * @param wait Should this function block until the sensor finishes rebooting?
61 * @return Operation status.
62 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
63 */
64 GoFx(kStatus) GoSensor_SetAddress(GoSensor sensor, const GoAddressInfo* info, kBool wait);
65
66 /**
67 * Retrieves the sensor's network address settings.
68 *
69 * @public @memberof GoSensor
70 * @version Introduced in firmware 4.0.10.27
71 * @param sensor GoSensor object.
72 * @param info Receives current address configuration.
73 * @return Operation status.
74 */
75 GoFx(kStatus) GoSensor_Address(GoSensor sensor, GoAddressInfo* info);
76
77 /**
78 * Creates a connection to the sensor.
79 *
80 * @public @memberof GoSensor
81 * @version Introduced in firmware 4.0.10.27
82 * @param sensor GoSensor object.
83 * @return Operation status.
84 */
85 GoFx(kStatus) GoSensor_Connect(GoSensor sensor);
86
87 /**
88 * Disconnects from the sensor.
89 *
90 * @public @memberof GoSensor
91 * @version Introduced in firmware 4.0.10.27
92 * @param sensor GoSensor object.
93 * @return Operation status.
94 */
95 GoFx(kStatus) GoSensor_Disconnect(GoSensor sensor);
96
97 /**
98 * Reports whether the sensor is currently connected.
99 *
100 * @public @memberof GoSensor
101 * @version Introduced in firmware 4.0.10.27
102 * @param sensor GoSensor object.
103 * @return kTRUE if the sensor is connected; kFALSE otherwise.
104 */
105 GoFx(kBool) GoSensor_IsConnected(GoSensor sensor);
106
107 /**
108 * Reports whether the connected sensor's protocol version is compatible with the SDK's protocol version.
109 *
110 * @public @memberof GoSensor
111 * @version Introduced in firmware 4.4.4.14
112 * @param sensor GoSensor object.
113 * @return kTRUE if the sensor is compatible; kFALSE otherwise.
114 */
115 GoFx(kBool) GoSensor_IsCompatible(GoSensor sensor);
116
117 /**
118 * Refreshes sensor state.
119 *
120 * Unresponsive sensors will be disconnected, and canceled sensors will be reconnected.
121 * Sensors in any other state will discard all locally-cached information.
122 *
123 * This function should be used to update sensors in the GO_SENSOR_INCONSISTENT state. This
124 * state can arise due to buddy changes performed by remote sensors (e.g. a main sensor boots
125 * and claims ownership of a buddy sensor, but the buddy sensor has already been detected and
126 * loaded as a main sensor by the client).
127 *
128 * @public @memberof GoSensor
129 * @version Introduced in firmware 4.0.10.27
130 * @param sensor GoSensor object.
131 * @return kTRUE if the sensor is connected; kFALSE otherwise.
132 */
133 GoFx(kStatus) GoSensor_Refresh(GoSensor sensor);
134
135 /**
136 * Assigns a buddy sensor.
137 *
138 * NOTE: The provided buddy sensor handle must already be connected.
139 *
140 * @public @memberof GoSensor
141 * @version Introduced in firmware 4.0.10.27
142 * @param sensor GoSensor object.
143 * @param buddy Sensor to be assigned as buddy.
144 * @return Operation status.
145 * @see GoSensor_Connect, GoSensor_HasBuddy, GoSensor_BuddyId, GoSensor_RemoveBuddy
146 */
147 GoFx(kStatus) GoSensor_AddBuddy(GoSensor sensor, GoSensor buddy);
148
149 /**
150 * Removes the current buddy sensor.
151 *
152 * @public @memberof GoSensor
153 * @version Introduced in firmware 4.0.10.27
154 * @param sensor GoSensor object.
155 * @return Operation status.
156 */
157 GoFx(kStatus) GoSensor_RemoveBuddy(GoSensor sensor);
158
159 /**
160 * Reports whether a buddy had been assigned.
161 *
162 * @public @memberof GoSensor
163 * @version Introduced in firmware 4.0.10.27
164 * @param sensor GoSensor object.
165 * @return kTRUE if sensor has a buddy; kFALSE otherwise.
166 */
167 GoFx(kBool) GoSensor_HasBuddy(GoSensor sensor);
168
169 /**
170 * Gets the buddy sensor's device ID.
171 *
172 * @public @memberof GoSensor
173 * @version Introduced in firmware 4.0.10.27
174 * @param sensor GoSensor object.
175 * @return Buddy device ID (or k32U_NULL if not assigned).
176 */
177 GoFx(k32u) GoSensor_BuddyId(GoSensor sensor);
178
179 /**
180 * Gets the sensor's scan mode.
181 *
182 * @public @memberof GoSensor
183 * @version Introduced in firmware 4.0.10.27
184 * @param sensor GoSensor object.
185 * @return Scan mode.
186 */
187 GoFx(GoMode) GoSensor_ScanMode(GoSensor sensor);
188
189 /**
190 * Enables or disables the sensor's data channel.
191 *
192 * @public @memberof GoSensor
193 * @version Introduced in firmware 4.0.10.27
194 * @param sensor GoSensor object.
195 * @param enable kTRUE to enable, or kFALSE to disable.
196 * @return Operation status.
197 */
198 GoFx(kStatus) GoSensor_EnableData(GoSensor sensor, kBool enable);
199
200 /**
201 * Starts the sensor.
202 *
203 * @public @memberof GoSensor
204 * @version Introduced in firmware 4.0.10.27
205 * @param sensor GoSensor object.
206 * @return Operation status.
207 */
208 GoFx(kStatus) GoSensor_Start(GoSensor sensor);
209
210 /**
211 * Starts the sensor at a scheduled value.
212 *
213 * @public @memberof GoSensor
214 * @version Introduced in firmware 4.1.3.106
215 * @param sensor GoSensor object.
216 * @param value Scheduled start value. uS when time triggered and ticks when encoder triggered.
217 * @return Operation status.
218 * @see GoSetup_SetTriggerSource, GoSetup_TriggerSource, GoSystem_Timestamp, GoSystem_Encoder
219 */
220 GoFx(kStatus) GoSensor_ScheduledStart(GoSensor sensor, k64s value);
221
222 /**
223 * Stops the sensor.
224 *
225 * @public @memberof GoSensor
226 * @version Introduced in firmware 4.0.10.27
227 * @param sensor GoSensor object.
228 * @return Operation status.
229 */
230 GoFx(kStatus) GoSensor_Stop(GoSensor sensor);
231
232 /**
233 * Perform alignment using the configured alignment type and target.
234 *
235 * NOTE: This operation will result in a sensor start for the duration of the
236 * alignment. It can be canceled via GoSensor_Stop. This function's operation
237 * status does not correspond to the actual alignment result. In order to
238 * retrieve the alignment result, you must enable the data channel before calling
239 * this function, receive an alignment data message and then check its status.
240 *
241 * @public @memberof GoSensor
242 * @version Introduced in firmware 4.0.10.27
243 * @param sensor GoSensor object.
244 * @return Operation status.
245 * @see GoSensor_EnableData, GoSystem_ReceiveData, GoSetup_AlignmentType, GoSetup_AlignmentMovingTarget, GoSetup_AlignmentStationaryTarget, GoAlignMsg_Status, GoSensor_Stop
246 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
247 */
248 GoFx(kStatus) GoSensor_Align(GoSensor sensor);
249
250
251 /**
252 * Clears the current sensor alignment.
253 *
254 * @public @memberof GoSensor
255 * @version Introduced in firmware 4.1.3.106
256 * @param sensor GoSensor object.
257 * @return Operation status.
258 * @see GoSensor_Align
259 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
260 */
261 GoFx(kStatus) GoSensor_ClearAlignment(GoSensor sensor);
262
263
264 /**
265 * Perform an exposure auto set.
266 *
267 * NOTE: This operation will result in a sensor start for the duration of the
268 * exposure AutoSet. A successful operation status does NOT modify the configuration.
269 * You must retrieve the resulting exposure value and set it for the appropriate
270 * exposure setting. This involves enabling the data connection prior to running
271 * exposure auto set and then receiving an exposure auto set message, which
272 * you can then use to query the status and access the resulting value.
273 *
274 * @public @memberof GoSensor
275 * @version Introduced in firmware 4.0.10.27
276 * @param sensor GoSensor object.
277 * @param role The role of the device to auto set.
278 * @return Operation status.
279 * @see GoRole, GoSensor_EnableData, GoSystem_ReceiveData, GoExposureCalMsg_Status, GoExposureCalMsg_Exposure
280 */
281 GoFx(kStatus) GoSensor_ExposureAutoSet(GoSensor sensor, GoRole role);
282
283 /**
284 * Gets the alignment state of the sensor.
285 *
286 * @public @memberof GoSensor
287 * @version Introduced in firmware 4.0.10.27
288 * @param sensor GoSensor object.
289 * @return A GoAlignmentState.
290 */
291 GoFx(GoAlignmentState) GoSensor_AlignmentState(GoSensor sensor);
292
293
294 /**
295 * Sets the alignment reference of the sensor.
296 *
297 * @public @memberof GoSensor
298 * @version Introduced in firmware 4.0.10.27
299 * @param sensor GoSensor object.
300 * @param reference The alignment reference value to set.
301 * @return Operation status.
302 */
303 GoFx(kStatus) GoSensor_SetAlignmentReference(GoSensor sensor, GoAlignmentRef reference);
304
305 /**
306 * Gets the alignment reference of the sensor.
307 *
308 * @public @memberof GoSensor
309 * @version Introduced in firmware 4.0.10.27
310 * @param sensor GoSensor object.
311 * @param reference A pointer that will hold the current alignment reference value.
312 * @return Operation status.
313 */
314 GoFx(kStatus) GoSensor_AlignmentReference(GoSensor sensor, GoAlignmentRef* reference);
315
316 /**
317 * Reboots the main sensor and any connected buddy sensors.
318 *
319 * @public @memberof GoSensor
320 * @version Introduced in firmware 4.0.10.27
321 * @param sensor GoSensor object.
322 * @param wait kTRUE to wait for reboot and then reconnect.
323 * @return Operation status.
324 */
325 GoFx(kStatus) GoSensor_Reset(GoSensor sensor, kBool wait);
326
327 /**
328 * Resets the encoder value. NOTE: This is only possible with a direct encoder
329 * connection to a sensor. Resetting the encoder value when connected to a Master
330 * device will not work.
331 *
332 * @public @memberof GoSensor
333 * @version Introduced in firmware 4.5.3.57
334 * @param sensor GoSensor object.
335 * @return Operation status.
336 */
337 GoFx(kStatus) GoSensor_ResetEncoder(GoSensor sensor);
338
339 /**
340 * Aborts ongoing sensor communication.
341 *
342 * This method asynchronously aborts ongoing communication; the next time that any
343 * I/O operation blocks for an extended period of time, it will be terminated. This method
344 * is thread-safe.
345 *
346 * In order to resume communication, call GoSensor_Refresh or GoSensor_Connect.
347 *
348 * @public @memberof GoSensor
349 * @version Introduced in firmware 4.0.10.27
350 * @param sensor GoSensor object.
351 * @return Operation status.
352 */
353 GoFx(kStatus) GoSensor_Cancel(GoSensor sensor);
354
355 /**
356 * Gets the current time stamp (common among all synchronized sensors).
357 *
358 * @public @memberof GoSensor
359 * @version Introduced in firmware 4.0.10.27
360 * @param sensor GoSensor object.
361 * @param time Receives the current time stamp(us).
362 * @return Operation status.
363 */
364 GoFx(kStatus) GoSensor_Timestamp(GoSensor sensor, k64u* time);
365
366 /**
367 * Gets the current encoder count.
368 *
369 * @public @memberof GoSensor
370 * @version Introduced in firmware 4.0.10.27
371 * @param sensor GoSensor object.
372 * @param encoder Receives the encoder count (ticks).
373 * @return Operation status.
374 */
375 GoFx(kStatus) GoSensor_Encoder(GoSensor sensor, k64s* encoder);
376
377 /**
378 * Sends a software trigger to the sensor.
379 *
380 * This method is used in conjunction with sensors that are configured to accept
381 * software triggers.
382 *
383 * @public @memberof GoSensor
384 * @version Introduced in firmware 4.0.10.27
385 * @param sensor GoSensor object.
386 * @return Operation status.
387 * @see GoSetup_TriggerSource, GoSetup_SetTriggerSource
388 */
389 GoFx(kStatus) GoSensor_Trigger(GoSensor sensor);
390
391 /**
392 * Schedules a digital output.
393 *
394 * This method requires that the output is configured to trigger on software control.
395 *
396 * @public @memberof GoSensor
397 * @version Introduced in firmware 4.0.10.27
398 * @param sensor GoSensor object.
399 * @param index The digital output index.
400 * @param target The time or position target (us or mm), depending on GoDomain. Ignored if
401 * GoDigital_ScheduleEnabled is false or GoDigital_SignalType is pulsed.
402 * @param value The value of scheduled output (0-Low or 1-High). Ignored if output
403 * GoDigital_SignalType is pulsed.
404 * @return Operation status.
405 */
406 GoFx(kStatus) GoSensor_EmitDigital(GoSensor sensor, k16u index, k64s target, k8u value);
407
408 /**
409 * Schedules an analog output.
410 *
411 * This method requires that the output be configured to trigger on software control.
412 * NOTE: It is not possible to schedule a continuous output. The operation will
413 * fail accordingly if attempted.
414 *
415 * @public @memberof GoSensor
416 * @version Introduced in firmware 4.0.10.27
417 * @param sensor GoSensor object.
418 * @param index The analog output index.
419 * @param target The time or position target (us or mm), depending on GoDomain. Ignored if
420 * GoAnalog_ScheduleEnabled is false.
421 * @param value The value of the scheduled output (mA).
422 * @return Operation status.
423 */
424 GoFx(kStatus) GoSensor_EmitAnalog(GoSensor sensor, k16u index, k64s target, k32s value);
425
426 /**
427 * Gets the number of files available from the connected sensor.
428 *
429 * @public @memberof GoSensor
430 * @version Introduced in firmware 4.0.10.27
431 * @param sensor GoSensor object.
432 * @return File count.
433 */
434 GoFx(kSize) GoSensor_FileCount(GoSensor sensor);
435
436 /**
437 * Gets the file name at the specified index.
438 *
439 * @public @memberof GoSensor
440 * @version Introduced in firmware 4.0.10.27
441 * @param sensor GoSensor object.
442 * @param index Index of the desired file name.
443 * @param name Receives the name of the file.
444 * @param capacity Capacity of the file name buffer.
445 * @return Operation status.
446 */
447 GoFx(kStatus) GoSensor_FileNameAt(GoSensor sensor, kSize index, kChar* name, kSize capacity);
448
449 /**
450 * Uploads a file to the connected sensor. The following is a list of
451 * macros representing common files used in this operation:
452 *
453 * @li GO_SENSOR_LIVE_JOB - Represents "_live.job".
454 * @li GO_SENSOR_LIVE_REPLAY - Represents the recording file, "_live.rec".
455 *
456 * @public @memberof GoSensor
457 * @version Introduced in firmware 4.0.10.27
458 * @param sensor GoSensor object.
459 * @param sourcePath Source file system path for the file to be uploaded.
460 * @param destName Destination name for the uploaded file (maximum 63 characters).
461 * @return Operation status.
462 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
463 */
464 GoFx(kStatus) GoSensor_UploadFile(GoSensor sensor, const kChar* sourcePath, const kChar* destName);
465
466 /**
467 * Downloads a file from the connected sensor. The following is a list of
468 * macros representing common files used in this operation:
469 *
470 * @li GO_SENSOR_LIVE_JOB - Represents "_live.job".
471 * @li GO_SENSOR_LIVE_REPLAY - Represents the recording file, "_live.rec".
472 *
473 * File names of saved jobs may also be specified.
474 *
475 * @public @memberof GoSensor
476 * @version Introduced in firmware 4.0.10.27
477 * @param sensor GoSensor object.
478 * @param sourceName Source name of the file to be downloaded.
479 * @param destPath Destination file system path for the file to be downloaded.
480 * @return Operation status.
481 */
482 GoFx(kStatus) GoSensor_DownloadFile(GoSensor sensor, const kChar* sourceName, const kChar* destPath);
483
484 /**
485 * Copies a file within the connected sensor.
486 *
487 * @public @memberof GoSensor
488 * @version Introduced in firmware 4.0.10.27
489 * @param sensor GoSensor object.
490 * @param sourceName Source name for the file to be copied.
491 * @param destName Destination name for the file (maximum 63 characters).
492 * @return Operation status.
493 * @remark Calling this function can result in writing operations to flash storage if the destination is not a live file(e.g. "_live.job"). Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
494 */
495 GoFx(kStatus) GoSensor_CopyFile(GoSensor sensor, const kChar* sourceName, const kChar* destName);
496
497 /**
498 * Deletes a file within the connected sensor.
499 *
500 * @public @memberof GoSensor
501 * @version Introduced in firmware 4.0.10.27
502 * @param sensor GoSensor object.
503 * @param name Name of the file to be deleted.
504 * @return Operation status.
505 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
506 */
507 GoFx(kStatus) GoSensor_DeleteFile(GoSensor sensor, const kChar* name);
508
509 /**
510 * Checks whether the specified file is present on the sensor.
511 *
512 * @public @memberof GoSensor
513 * @version Introduced in firmware 4.0.10.27
514 * @param sensor GoSensor object.
515 * @param name Name of the file to be checked.
516 * @return Operation status.
517 */
518 GoFx(kBool) GoSensor_FileExists(GoSensor sensor, const kChar* name);
519
520 /**
521 * Gets the available storage space remaining for user files.
522 *
523 * @public @memberof GoSensor
524 * @version
525 * @param sensor GoSensor object.
526 * @return Storage space available.
527 */
528 GoFx(k64u) GoSensor_UserStorageFree(GoSensor sensor);
529
530 /**
531 * Gets the storage space used for user files.
532 *
533 * @public @memberof GoSensor
534 * @version
535 * @param sensor GoSensor object.
536 * @return Storage space used.
537 */
538 GoFx(k64u) GoSensor_UserStorageUsed(GoSensor sensor);
539
540 /**
541 * Sets a default job file to be loaded on boot.
542 *
543 * @public @memberof GoSensor
544 * @version Introduced in firmware 4.0.10.27
545 * @param sensor GoSensor object.
546 * @param fileName Name of the default file.
547 * @return Operation status.
548 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
549 */
550 GoFx(kStatus) GoSensor_SetDefaultJob(GoSensor sensor, const kChar* fileName);
551
552 /**
553 * Gets the name of the default job file to be loaded on boot.
554 *
555 * @public @memberof GoSensor
556 * @version Introduced in firmware 4.0.10.27
557 * @param sensor GoSensor object.
558 * @param fileName Receives name of the default file.
559 * @param capacity Name buffer capacity.
560 * @return Operation status.
561 */
562 GoFx(kStatus) GoSensor_DefaultJob(GoSensor sensor, kChar* fileName, kSize capacity);
563
564 /**
565 * Gets the name of the loaded job file and whether it has been modified since loading.
566 *
567 * @public @memberof GoSensor
568 * @version Introduced in firmware 4.0.10.27
569 * @param sensor GoSensor object.
570 * @param fileName Receives name of the loaded file.
571 * @param capacity Name buffer capacity.
572 * @param changed Receives the status of whether the file has changed.
573 * @return Operation status.
574 */
575 GoFx(kStatus) GoSensor_LoadedJob(GoSensor sensor, kChar* fileName, kSize capacity, kBool* changed);
576
577 /**
578 * Logs into the sensor using the specified user name and password.
579 *
580 * Logging in is not required in order to programmatically control a sensor. The Gocator log-in feature is
581 * intended only to support administrative user interfaces, by allowing the username and password to be
582 * stored in the sensor.
583 *
584 * @public @memberof GoSensor
585 * @version Introduced in firmware 4.0.10.27
586 * @param sensor GoSensor object.
587 * @param user User account.
588 * @param password User password.
589 * @return Operation status.
590 */
591 GoFx(kStatus) GoSensor_LogIn(GoSensor sensor, GoUser user, const kChar* password);
592
593 /**
594 * Changes the password associated with the specified user account.
595 *
596 * @public @memberof GoSensor
597 * @version Introduced in firmware 4.0.10.27
598 * @param sensor GoSensor object.
599 * @param user User account.
600 * @param password New password.
601 * @return Operation status.
602 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
603 */
604 GoFx(kStatus) GoSensor_ChangePassword(GoSensor sensor, GoUser user, const kChar* password);
605
606 /**
607 * Upgrades sensor firmware.
608 *
609 * This function will block until the upgrade is completed.
610 *
611 * This function results in flash storage modifications. If modifications are interrupted due to
612 * power loss, the sensor may reboot into Rescue mode.
613 *
614 * The sensor does not need to be connected to perform an upgrade.
615 *
616 * @public @memberof GoSensor
617 * @version Introduced in firmware 4.0.10.27 and updated in 4.3.3.124
618 * @param sensor GoSensor object.
619 * @param sourcePath Local file system path to the upgrade file.
620 * @param onUpdate Callback function to receive progress updates, or kNULL.
621 * @param context Context handle to be passed to the upgrade callback.
622 * @return Operation status.
623 */
624 GoFx(kStatus) GoSensor_Upgrade(GoSensor sensor, const kChar* sourcePath, GoUpgradeFx onUpdate, kPointer context);
625
626 /**
627 * Creates a backup of sensor files and downloads the backup to the specified location.
628 *
629 * @public @memberof GoSensor
630 * @version Introduced in firmware 4.0.10.27
631 * @param sensor GoSensor object.
632 * @param destPath Local file system path for the saved backup file.
633 * @return Operation status.
634 */
635 GoFx(kStatus) GoSensor_Backup(GoSensor sensor, const kChar* destPath);
636
637 /**
638 * Restores a backup of sensor files.
639 *
640 * @public @memberof GoSensor
641 * @version Introduced in firmware 4.0.10.27
642 * @param sensor GoSensor object.
643 * @param sourcePath Local file system path of the saved backup file.
644 * @return Operation status.
645 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
646 */
647 GoFx(kStatus) GoSensor_Restore(GoSensor sensor, const kChar* sourcePath);
648
649 /**
650 * Restores factory default settings.
651 *
652 * @public @memberof GoSensor
653 * @version Introduced in firmware 4.0.10.27
654 * @param sensor GoSensor object.
655 * @param restoreAddress kTRUE to restore the factory default IP address; False otherwise.
656 * @return Operation status.
657 * @remark Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
658 */
659 GoFx(kStatus) GoSensor_RestoreDefaults(GoSensor sensor, kBool restoreAddress);
660
661 /**
662 * Gets the GoSetup instance associated with the sensor.
663 *
664 * @public @memberof GoSensor
665 * @version Introduced in firmware 4.0.10.27
666 * @param sensor GoSensor object.
667 * @return A GoSetup object module
668 */
669 GoFx(GoSetup) GoSensor_Setup(GoSensor sensor);
670
671 /**
672 * Gets the sensor's tools module, used for measurement configuration.
673 *
674 * @public @memberof GoSensor
675 * @version Introduced in firmware 4.0.10.27
676 * @param sensor GoSensor object.
677 * @return Measurement configuration module.
678 */
679 GoFx(GoTools) GoSensor_Tools(GoSensor sensor);
680
681 /**
682 * Gets the output module, used for output configuration.
683 *
684 * @public @memberof GoSensor
685 * @version Introduced in firmware 4.0.10.27
686 * @param sensor GoSensor object.
687 * @return Output configuration module.
688 */
689 GoFx(GoOutput) GoSensor_Output(GoSensor sensor);
690
691 /**
692 * Gets the transform module, used for transformation configuration.
693 *
694 * @public @memberof GoSensor
695 * @version Introduced in firmware 4.0.10.27
696 * @param sensor GoSensor object.
697 * @return Transformation configuration module.
698 */
699 GoFx(GoTransform) GoSensor_Transform(GoSensor sensor);
700
701 /**
702 * Gets the replay module, used for replay configuration.
703 *
704 * @public @memberof GoSensor
705 * @version Introduced in firmware 4.5.3.57
706 * @param sensor GoSensor object.
707 * @return Replay configuration module.
708 */
709 GoFx(GoReplay) GoSensor_Replay(GoSensor sensor);
710
711 /**
712 * Gets the device identifier associated with this sensor.
713 *
714 * @public @memberof GoSensor
715 * @version Introduced in firmware 4.0.10.27
716 * @param sensor GoSensor object.
717 * @return The sensor's device ID.
718 */
719 GoFx(k32u) GoSensor_Id(GoSensor sensor);
720
721 /**
722 * Gets the model number associated with this sensor.
723 *
724 * @public @memberof GoSensor
725 * @version Introduced in firmware 4.0.10.27
726 * @param sensor GoSensor object.
727 * @param model Receives sensor model.
728 * @param capacity Capacity of model buffer.
729 * @return Operation status.
730 */
731 GoFx(kStatus) GoSensor_Model(GoSensor sensor, kChar* model, kSize capacity);
732
733 /**
734 * Reports the current state of the sensor.
735 *
736 * @public @memberof GoSensor
737 * @version Introduced in firmware 4.0.10.27
738 * @param sensor GoSensor object.
739 * @return Sensor state.
740 */
741 GoFx(GoState) GoSensor_State(GoSensor sensor);
742
743 /**
744 * Reports the current states of the sensor.
745 *
746 * @public @memberof GoSensor
747 * @version Introduced in firmware 4.0.10.27
748 * @param sensor GoSensor object.
749 * @param states Reference to updated states.
750 * @return Operation status.
751 */
752 GoFx(kStatus) GoSensor_States(GoSensor sensor, GoStates* states);
753
754 /**
755 * Gets the sensor's current role within the system.
756 *
757 * @public @memberof GoSensor
758 * @version Introduced in firmware 4.0.10.27
759 * @param sensor GoSensor object.
760 * @return Sensor role.
761 */
762 GoFx(GoRole) GoSensor_Role(GoSensor sensor);
763
764 /**
765 * Reports the user account associated with the current user.
766 *
767 * @public @memberof GoSensor
768 * @version Introduced in firmware 4.0.10.27
769 * @param sensor GoSensor object.
770 * @return User account id.
771 */
772 GoFx(GoUser) GoSensor_User(GoSensor sensor);
773
774 /**
775 * Gets the sensor's protocol version.
776 *
777 * @public @memberof GoSensor
778 * @version Introduced in firmware 4.0.10.27
779 * @param sensor GoSensor object.
780 * @return Protocol version.
781 */
782 GoFx(kVersion) GoSensor_ProtocolVersion(GoSensor sensor);
783
784 /**
785 * Gets the sensor's firmware version.
786 *
787 * @public @memberof GoSensor
788 * @version Introduced in firmware 4.0.10.27
789 * @param sensor GoSensor object.
790 * @return Firmware version.
791 */
792 GoFx(kVersion) GoSensor_FirmwareVersion(GoSensor sensor);
793
794 /**
795 * Sets the recording state of the sensor.
796 *
797 * @public @memberof GoSensor
798 * @version Introduced in firmware 4.0.10.27
799 * @param sensor GoSensor object.
800 * @param enable Enables or disables recording.
801 * @return Operation status.
802 */
803 GoFx(kStatus) GoSensor_EnableRecording(GoSensor sensor, kBool enable);
804
805 /**
806 * Gets the recording state of the sensor.
807 *
808 * @public @memberof GoSensor
809 * @version Introduced in firmware 4.0.10.27
810 * @param sensor GoSensor object.
811 * @return kTRUE if recording is enabled. kFALSE otherwise.
812 */
813 GoFx(kBool) GoSensor_RecordingEnabled(GoSensor sensor);
814
815 /**
816 * Sets the input source of the sensor.
817 *
818 * @public @memberof GoSensor
819 * @version Introduced in firmware 4.0.10.27
820 * @param sensor GoSensor object.
821 * @param source The input source to use.
822 * @return Operation status.
823 */
824 GoFx(kStatus) GoSensor_SetInputSource(GoSensor sensor, GoInputSource source);
825
826 /**
827 * Gets the input source currently used by the sensor.
828 *
829 * @public @memberof GoSensor
830 * @version Introduced in firmware 4.0.10.27
831 * @param sensor GoSensor object.
832 * @return A GoInputSource.
833 */
834 GoFx(GoInputSource) GoSensor_InputSource(GoSensor sensor);
835
836 /**
837 * Simulates the current frame in the live recording buffer.
838 *
839 * @public @memberof GoSensor
840 * @version Introduced in firmware 4.0.10.27
841 * @param sensor GoSensor object.
842 * @param isBufferValid kTRUE if the source simulation buffer was valid. kFALSE otherwise.
843 * @return Operation status.
844 */
845 GoFx(kStatus) GoSensor_Simulate(GoSensor sensor, kBool* isBufferValid);
846
847
848 /**
849 * Advances one frame from the current replay position.
850 *
851 * @public @memberof GoSensor
852 * @version Introduced in firmware 4.0.10.27
853 * @param sensor GoSensor object.
854 * @param direction Direction with which to step.
855 * @return Operation status.
856 */
857 GoFx(kStatus) GoSensor_PlaybackStep(GoSensor sensor, GoSeekDirection direction);
858
859 /**
860 * Sets the current frame position for a replay.
861 *
862 * @public @memberof GoSensor
863 * @version Introduced in firmware 4.0.10.27
864 * @param sensor GoSensor object.
865 * @param position The frame position to seek.
866 * @return Operation status.
867 */
868 GoFx(kStatus) GoSensor_PlaybackSeek(GoSensor sensor, kSize position);
869
870 /**
871 * Gets the current replay frame position.
872 *
873 * @public @memberof GoSensor
874 * @version Introduced in firmware 4.0.10.27
875 * @param sensor GoSensor object.
876 * @param position The current frame position index.
877 * @param count The frame count.
878 * @return Operation status.
879 */
880 GoFx(kStatus) GoSensor_PlaybackPosition(GoSensor sensor, kSize* position, kSize* count);
881
882 /**
883 * Clears the replay buffer.
884 *
885 * @public @memberof GoSensor
886 * @version Introduced in firmware 4.0.10.27
887 * @param sensor GoSensor object.
888 * @return Operation status.
889 */
890 GoFx(kStatus) GoSensor_ClearReplayData(GoSensor sensor);
891
892 /**
893 * Resets the measurement statistics reported by the health channel
894 *
895 * @public @memberof GoSensor
896 * @version Introduced in firmware 4.0.10.27
897 * @param sensor GoSensor object.
898 * @return A GoAlignmentState.
899 */
900 GoFx(kStatus) GoSensor_ClearMeasurementStats(GoSensor sensor);
901
902 /**
903 * Exports the current frame of a replay in the form of a bitmap.
904 *
905 * @public @memberof GoSensor
906 * @version Introduced in firmware 4.0.10.27
907 * @param sensor GoSensor object.
908 * @param type The type of data to export.
909 * @param source The device data source to export from.
910 * @param dstFileName The destination file name of the exported bitmap file.
911 * @return Operation status.
912 */
913 GoFx(kStatus) GoSensor_ExportBitmap(GoSensor sensor,
914 GoReplayExportSourceType type,
915 GoDataSource source,
916 const kChar* dstFileName);
917
918 /**
919 * Exports replay data in CSV format.
920 *
921 * @public @memberof GoSensor
922 * @version Introduced in firmware 4.0.10.27
923 * @param sensor GoSensor object.
924 * @param dstFileName The destination file name of the exported CSV file.
925 * @return Operation status.
926 */
927 GoFx(kStatus) GoSensor_ExportCsv(GoSensor sensor, const kChar* dstFileName);
928
929 /**
930 * Returns an enumerator value representing the current sensor's family.
931 *
932 * @public @memberof GoSensor
933 * @version Introduced in firmware 4.0.10.27
934 * @param sensor GoSensor object.
935 * @return A GoFamily value.
936 */
937 GoFx(GoFamily) GoSensor_Family(GoSensor sensor);
938
939 /**
940 * Clears the log file (_live.log).
941 *
942 * @public @memberof GoSensor
943 * @version Introduced in firmware 4.0.10.27
944 * @param sensor GoSensor object.
945 * @return Operation status.
946 */
947 GoFx(kStatus) GoSensor_ClearLog(GoSensor sensor);
948
949 /**
950 * Sets the AutoStart enabled state of the sensor.
951 *
952 * @public @memberof GoSensor
953 * @version Introduced in firmware 4.0.10.27
954 * @param sensor GoSensor object.
955 * @param enable The AutoStart enabled state to use.
956 * @return Operation status.
957 */
958 GoFx(kStatus) GoSensor_EnableAutoStart(GoSensor sensor, kBool enable);
959
960 /**
961 * Gets the AutoStart enabled state currently used by the sensor.
962 *
963 * @public @memberof GoSensor
964 * @version Introduced in firmware 4.0.10.27
965 * @param sensor GoSensor object.
966 * @return kTRUE if auto start is enabled and kFALSE otherwise.
967 */
968 GoFx(kBool) GoSensor_AutoStartEnabled(GoSensor sensor);
969
970 /**
971 * Gets the count of remote sensor information held by the sensor.
972 *
973 * @public @memberof GoSensor
974 * @version Introduced in firmware 4.0.10.27
975 * @param sensor GoSensor object.
976 * @return The remote sensor information count.
977 */
978 GoFx(kSize) GoSensor_RemoteInfoCount(GoSensor sensor);
979
980 /**
981 * Gets the remote sensor information at the given index.
982 *
983 * @public @memberof GoSensor
984 * @version Introduced in firmware 4.0.10.27
985 * @param sensor GoSensor object.
986 * @param index The index of the remote sensor information to retrieve.
987 * @return A handle to the selected remote sensor information or kNULL if an invalid index is provided.
988 */
989 GoFx(GoSensorInfo) GoSensor_RemoteInfoAt(GoSensor sensor, kSize index);
990
991 /**
992 * Return the number of files contained in the specified path with an optional extension filter applied.
993 *
994 * @public @memberof GoSensor
995 * @version Introduced in firmware 4.1.3.106
996 * @param sensor GoSensor object.
997 * @param extensionFilter An optional extension filter to apply. Send "" to not apply a filter.
998 * @param path The file system path to retrieve the file count for.
999 * @param isRecursive kTRUE to include files in sub-folders of the path and kFALSE to only count files in the immediate path.
1000 * @return The number of files contained in the specified path with an optional extension filter applied.
1001 */
1002 GoFx(kSize) GoSensor_DirectoryFileCount(GoSensor sensor, const kChar* extensionFilter, const kChar* path, kBool isRecursive);
1003
1004 /**
1005 * Retrieves the file name at the specified index for a given path and optional extension filter.
1006 *
1007 * @public @memberof GoSensor
1008 * @version Introduced in firmware 4.1.3.106
1009 * @param sensor GoSensor object.
1010 * @param extensionFilter An optional extension filter to apply. Send "" to not apply a filter.
1011 * @param path The file system path to retrieve the file count for.
1012 * @param isRecursive kTRUE to include files in sub-folders of the path and kFALSE to only count files in the immediate path.
1013 * @param index The index of the file name to retrieve.
1014 * @param fileName The pointer to a character array of which to store the retrieve file name.
1015 * @param capacity The maximum capacity of the character array.
1016 * @return Operation status.
1017 */
1018 GoFx(kStatus) GoSensor_DirectoryFileNameAt(GoSensor sensor, const kChar* extensionFilter, const kChar* path, kBool isRecursive, kSize index, kChar* fileName, kSize capacity);
1019
1020 /**
1021 * Defines the signature for a custom data message handler.
1022 *
1023 * @public @memberof GoSensor
1024 * @version Introduced in firmware 4.1.3.106
1025 * @param context A pointer to an application context to use with the provided data set.
1026 * @param sensor GoSensor object.
1027 * @param dataSet The data set.
1028 * @return Operation status.
1029 * @see GoSensor_SetDataHandler
1030 */
1031 typedef kStatus (kCall* GoSensorDataSetFx)(kPointer context, GoSensor sensor, GoDataSet dataSet);
1032
1033 /**
1034 * Sets the data callback function to be used upon receipt of data.
1035 *
1036 * @public @memberof GoSensor
1037 * @version Introduced in firmware 4.1.3.106
1038 * @param sensor GoSensor object.
1039 * @param function The function pointer to use when data has been received from the sensor. Send kNULL to revert back to the GoSystem data set storage behavior.
1040 * @param context The context to use with the function pointer.
1041 * @return Operation status.
1042 * @see GoSensorDataSetFx
1043 */
1044 GoFx(kStatus) GoSensor_SetDataHandler(GoSensor sensor, GoSensorDataSetFx function, kPointer context);
1045
1046
1047 /**
1048 * Creates a part matching model based on the current part data.
1049 *
1050 * @public @memberof GoSensor
1051 * @version Introduced in firmware 4.2.4.7
1052 * @param sensor GoSensor object.
1053 * @param name The intended name of the part match model.
1054 * @return Operation status.
1055 */
1056 GoFx(kStatus) GoSensor_PartMatchCreateModel(GoSensor sensor, const kChar* name);
1057
1058 /**
1059 * Detect the edges of the specified part model.
1060 *
1061 * @public @memberof GoSensor
1062 * @version Introduced in firmware 4.2.4.7
1063 * @param sensor GoSensor object.
1064 * @param name The name of the part match model to detect edges on.
1065 * @param sensitivity The sensitivity to use for model edge detection.
1066 * @return Operation status.
1067 */
1068 GoFx(kStatus) GoSensor_PartMatchDetectModelEdges(GoSensor sensor, const kChar* name, k16u sensitivity);
1069
1070 /**
1071 * Returns a handle to a part model based on a given name.
1072 *
1073 * @public @memberof GoSensor
1074 * @version Introduced in firmware 4.2.4.7
1075 * @param sensor GoSensor object.
1076 * @param name The name of the part match model to retrieve.
1077 * @return A GoPartModel handle.
1078 */
1079 GoFx(GoPartModel) GoSensor_PartMatchModel(GoSensor sensor, const kChar* name);
1080
1081 /**
1082 * Returns the number of part match models present in the currently loaded job.
1083 *
1084 * @public @memberof GoSensor
1085 * @version Introduced in firmware 4.2.4.7
1086 * @param sensor GoSensor object.
1087 * @return The count of part match models in the currently loaded job.
1088 */
1089 GoFx(kSize) GoSensor_PartMatchModelCount(GoSensor sensor);
1090
1091 /**
1092 * Returns a handle to a part model based on a given index.
1093 *
1094 * @public @memberof GoSensor
1095 * @version Introduced in firmware 4.2.4.7
1096 * @param sensor GoSensor object.
1097 * @param index The index of the part model to retrieve.
1098 * @return A GoPartModel handle.
1099 */
1100 GoFx(GoPartModel) GoSensor_PartMatchModelAt(GoSensor sensor, kSize index);
1101
1102 /**
1103 * Sets the runtime variables from the provided starting index to the specified length
1104 * with the values contained in the provided array.
1105 *
1106 * @public @memberof GoSensor
1107 * @version Introduced in firmware 4.5.3.57
1108 * @param sensor GoSensor object.
1109 * @param startIndex The starting index of the runtime variable values to set.
1110 * @param length The number of runtime variables to set/the length of the array parameter.
1111 * @param values A reference to an array which contains the intended runtime variable values.
1112 * @return Operation status.
1113 */
1114 GoFx(kStatus) GoSensor_SetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s* values);
1115
1116 /**
1117 * Returns the number of runtime variables available on the device.
1118 *
1119 * @public @memberof GoSensor
1120 * @version Introduced in firmware 4.5.3.57
1121 * @param sensor GoSensor object.
1122 * @return The runtime variable count of the device.
1123 */
1124 GoFx(kSize) GoSensor_GetRuntimeVariableCount(GoSensor sensor);
1125
1126 /**
1127 * Gets the values associated with a given runtime variable starting index and length.
1128 *
1129 * @public @memberof GoSensor
1130 * @version Introduced in firmware 4.5.3.57
1131 * @param sensor GoSensor object.
1132 * @param startIndex The starting index of the runtime variable values to retrieve.
1133 * @param length The number of runtime variables to retrieve.
1134 * @param values A reference to an array which will hold the retrieved runtime variable values.
1135 * @return Operation status.
1136 */
1137 GoFx(kStatus) GoSensor_GetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s* values);
1138
1139 /**
1140 * Gets the value associated with a given runtime variable index.
1141 *
1142 * @public @memberof GoSensor
1143 * @version Introduced in firmware 4.5.3.57
1144 * @param sensor GoSensor object.
1145 * @param index The index of the runtime variable value to retrieve.
1146 * @param value A reference to be updated with the runtime variable value.
1147 * @return Operation status.
1148 */
1149 GoFx(kStatus) GoSensor_GetRuntimeVariableAt(GoSensor sensor, kSize index, k32s* value);
1150
1151 kEndHeader()
1152 #include <GoSdk/GoSensor.x.h>
1153
1154 #endif
GoSensor::GoSensor_FirmwareVersion
kVersion GoSensor_FirmwareVersion(GoSensor sensor)
Gets the sensor's firmware version.
GoSensor::GoSensor_FileExists
kBool GoSensor_FileExists(GoSensor sensor, const kChar *name)
Checks whether the specified file is present on the sensor.
GoSensor::GoSensor_RestoreDefaults
kStatus GoSensor_RestoreDefaults(GoSensor sensor, kBool restoreAddress)
Restores factory default settings.
GoSensor::GoSensor_Replay
GoReplay GoSensor_Replay(GoSensor sensor)
Gets the replay module, used for replay configuration.
GoSensor::GoSensor_PlaybackPosition
kStatus GoSensor_PlaybackPosition(GoSensor sensor, kSize *position, kSize *count)
Gets the current replay frame position.
GoStates
Sensor state, login, alignment information, recording state, playback source, uptime, playback information, and auto-start setting state.
Definition: GoSdkDef.h:574
k32u
GoInputSource
Represents a data input source.
GoSensorInfo
Represents read-only sensor information.
GoSensor::GoSensor_ExportBitmap
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.
GoSensor::GoSensor_SetAlignmentReference
kStatus GoSensor_SetAlignmentReference(GoSensor sensor, GoAlignmentRef reference)
Sets the alignment reference of the sensor.
GoSensor::GoSensor_ResetEncoder
kStatus GoSensor_ResetEncoder(GoSensor sensor)
Resets the encoder value.
GoSeekDirection
Represents a playback seek direction.
GoReplayExportSourceType
Represents the replay export source type.
GoSensor::GoSensor_UserStorageUsed
k64u GoSensor_UserStorageUsed(GoSensor sensor)
Gets the storage space used for user files.
GoSensor::GoSensorDataSetFx
kStatus(kCall * GoSensorDataSetFx)(kPointer context, GoSensor sensor, GoDataSet dataSet)
Defines the signature for a custom data message handler.
Definition: GoSensor.h:1031
GoSensor::GoSensor_EnableAutoStart
kStatus GoSensor_EnableAutoStart(GoSensor sensor, kBool enable)
Sets the AutoStart enabled state of the sensor.
GoSensor::GoSensor_ClearReplayData
kStatus GoSensor_ClearReplayData(GoSensor sensor)
Clears the replay buffer.
k64u
GoSensor::GoSensor_SetRuntimeVariables
kStatus GoSensor_SetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s *values)
Sets the runtime variables from the provided starting index to the specified length with the values c...
GoSensor::GoSensor_Simulate
kStatus GoSensor_Simulate(GoSensor sensor, kBool *isBufferValid)
Simulates the current frame in the live recording buffer.
GoSensor::GoSensor_ClearLog
kStatus GoSensor_ClearLog(GoSensor sensor)
Clears the log file (_live.log).
kPointer
GoSensor::GoSensor_Backup
kStatus GoSensor_Backup(GoSensor sensor, const kChar *destPath)
Creates a backup of sensor files and downloads the backup to the specified location.
GoSensor::GoSensor_FileCount
kSize GoSensor_FileCount(GoSensor sensor)
Gets the number of files available from the connected sensor.
GoSensor::GoSensor_Trigger
kStatus GoSensor_Trigger(GoSensor sensor)
Sends a software trigger to the sensor.
GoFamily
Represents the supported Gocator hardware families.
k16u
GoRole
Represents a user role.
kSize
GoSensor::GoSensor_AlignmentState
GoAlignmentState GoSensor_AlignmentState(GoSensor sensor)
Gets the alignment state of the sensor.
GoOutput.h
Declares the GoOutput class.
GoSensor::GoSensor_Refresh
kStatus GoSensor_Refresh(GoSensor sensor)
Refreshes sensor state.
GoSensor::GoSensor_PartMatchCreateModel
kStatus GoSensor_PartMatchCreateModel(GoSensor sensor, const kChar *name)
Creates a part matching model based on the current part data.
GoSensor::GoSensor_ClearAlignment
kStatus GoSensor_ClearAlignment(GoSensor sensor)
Clears the current sensor alignment.
GoSensor::GoSensor_Restore
kStatus GoSensor_Restore(GoSensor sensor, const kChar *sourcePath)
Restores a backup of sensor files.
GoDataSource
Represents a data source.
k8u
GoSensor::GoSensor_PlaybackSeek
kStatus GoSensor_PlaybackSeek(GoSensor sensor, kSize position)
Sets the current frame position for a replay.
GoReplay
Represents a replay configuration.
GoSensor::GoSensor_PartMatchModelAt
GoPartModel GoSensor_PartMatchModelAt(GoSensor sensor, kSize index)
Returns a handle to a part model based on a given index.
GoDataSet.h
Declares the GoDataSet class.
kChar
GoSensor::GoSensor_PlaybackStep
kStatus GoSensor_PlaybackStep(GoSensor sensor, GoSeekDirection direction)
Advances one frame from the current replay position.
GoSensorInfo.h
Declares the GoSensorInfo class.
GoSensor::GoSensor_UploadFile
kStatus GoSensor_UploadFile(GoSensor sensor, const kChar *sourcePath, const kChar *destName)
Uploads a file to the connected sensor.
GoAlignmentState
Represents an alignment state.
GoSensor::GoSensor_Address
kStatus GoSensor_Address(GoSensor sensor, GoAddressInfo *info)
Retrieves the sensor's network address settings.
GoSensor::GoSensor_LoadedJob
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.
GoSensor::GoSensor_FileNameAt
kStatus GoSensor_FileNameAt(GoSensor sensor, kSize index, kChar *name, kSize capacity)
Gets the file name at the specified index.
GoSensor::GoSensor_DownloadFile
kStatus GoSensor_DownloadFile(GoSensor sensor, const kChar *sourceName, const kChar *destPath)
Downloads a file from the connected sensor.
GoOutput
Represents output configuration.
GoSensor::GoSensor_DefaultJob
kStatus GoSensor_DefaultJob(GoSensor sensor, kChar *fileName, kSize capacity)
Gets the name of the default job file to be loaded on boot.
GoSensor::GoSensor_SetDataHandler
kStatus GoSensor_SetDataHandler(GoSensor sensor, GoSensorDataSetFx function, kPointer context)
Sets the data callback function to be used upon receipt of data.
GoSdkDef.h
Essential SDK declarations.
GoSensor::GoSensor_DirectoryFileNameAt
kStatus GoSensor_DirectoryFileNameAt(GoSensor sensor, const kChar *extensionFilter, const kChar *path, kBool isRecursive, kSize index, kChar *fileName, kSize capacity)
Retrieves the file name at the specified index for a given path and optional extension filter...
GoSensor::GoSensor_IsCompatible
kBool GoSensor_IsCompatible(GoSensor sensor)
Reports whether the connected sensor's protocol version is compatible with the SDK's protocol version...
GoSensor::GoSensor_Family
GoFamily GoSensor_Family(GoSensor sensor)
Returns an enumerator value representing the current sensor's family.
GoSensor::GoSensor_BuddyId
k32u GoSensor_BuddyId(GoSensor sensor)
Gets the buddy sensor's device ID.
GoSensor::GoSensor_EnableRecording
kStatus GoSensor_EnableRecording(GoSensor sensor, kBool enable)
Sets the recording state of the sensor.
GoSensor::GoSensor_InputSource
GoInputSource GoSensor_InputSource(GoSensor sensor)
Gets the input source currently used by the sensor.
GoSensor::GoSensor_PartMatchModel
GoPartModel GoSensor_PartMatchModel(GoSensor sensor, const kChar *name)
Returns a handle to a part model based on a given name.
GoSensor::GoSensor_LogIn
kStatus GoSensor_LogIn(GoSensor sensor, GoUser user, const kChar *password)
Logs into the sensor using the specified user name and password.
GoSensor::GoSensor_State
GoState GoSensor_State(GoSensor sensor)
Reports the current state of the sensor.
GoTransform.h
Declares the GoTransform class.
GoSensor::GoSensor_PartMatchDetectModelEdges
kStatus GoSensor_PartMatchDetectModelEdges(GoSensor sensor, const kChar *name, k16u sensitivity)
Detect the edges of the specified part model.
GoSensor::GoSensor_ExportCsv
kStatus GoSensor_ExportCsv(GoSensor sensor, const kChar *dstFileName)
Exports replay data in CSV format.
GoSensor::GoSensor_GetRuntimeVariableAt
kStatus GoSensor_GetRuntimeVariableAt(GoSensor sensor, kSize index, k32s *value)
Gets the value associated with a given runtime variable index.
GoSetup::GoSensor_Flush
kStatus GoSensor_Flush(GoSensor sensor)
Initiates a sensor configuration, model file, and transformation synchronization if modifications are...
GoSensor::GoSensor_DeleteFile
kStatus GoSensor_DeleteFile(GoSensor sensor, const kChar *name)
Deletes a file within the connected sensor.
GoDataSet
Represents a collection of data channel or health channel messages.
GoSensor::GoSensor_Disconnect
kStatus GoSensor_Disconnect(GoSensor sensor)
Disconnects from the sensor.
GoSensor::GoSensor_Transform
GoTransform GoSensor_Transform(GoSensor sensor)
Gets the transform module, used for transformation configuration.
GoTools
Represents a collection of tools.
GoSensor::GoSensor_ExposureAutoSet
kStatus GoSensor_ExposureAutoSet(GoSensor sensor, GoRole role)
Perform an exposure auto set.
GoSensor::GoSensor_Setup
GoSetup GoSensor_Setup(GoSensor sensor)
Gets the GoSetup instance associated with the sensor.
GoSensor::GoSensor_Tools
GoTools GoSensor_Tools(GoSensor sensor)
Gets the sensor's tools module, used for measurement configuration.
GoSensor::GoSensor_Cancel
kStatus GoSensor_Cancel(GoSensor sensor)
Aborts ongoing sensor communication.
k32s
GoSensor::GoSensor_RemoveBuddy
kStatus GoSensor_RemoveBuddy(GoSensor sensor)
Removes the current buddy sensor.
GoSensor::GoSensor_ScanMode
GoMode GoSensor_ScanMode(GoSensor sensor)
Gets the sensor's scan mode.
GoUser
Represents a user id.
GoSensor::GoSensor_EmitAnalog
kStatus GoSensor_EmitAnalog(GoSensor sensor, k16u index, k64s target, k32s value)
Schedules an analog output.
GoSensor::GoSensor_AlignmentReference
kStatus GoSensor_AlignmentReference(GoSensor sensor, GoAlignmentRef *reference)
Gets the alignment reference of the sensor.
GoSensor::GoSensor_Model
kStatus GoSensor_Model(GoSensor sensor, kChar *model, kSize capacity)
Gets the model number associated with this sensor.
GoSensor::GoSensor_ClearMeasurementStats
kStatus GoSensor_ClearMeasurementStats(GoSensor sensor)
Resets the measurement statistics reported by the health channel.
GoAlignmentRef
Represents an alignment reference.
GoSensor::GoSensor_Start
kStatus GoSensor_Start(GoSensor sensor)
Starts the sensor.
k64s
GoSensor::GoSensor_Align
kStatus GoSensor_Align(GoSensor sensor)
Perform alignment using the configured alignment type and target.
GoSensor::GoSensor_User
GoUser GoSensor_User(GoSensor sensor)
Reports the user account associated with the current user.
GoSensor::GoSensor_Encoder
kStatus GoSensor_Encoder(GoSensor sensor, k64s *encoder)
Gets the current encoder count.
GoSensor::GoSensor_Id
k32u GoSensor_Id(GoSensor sensor)
Gets the device identifier associated with this sensor.
GoSensor::GoSensor_UserStorageFree
k64u GoSensor_UserStorageFree(GoSensor sensor)
Gets the available storage space remaining for user files.
GoSensor::GoSensor_Connect
kStatus GoSensor_Connect(GoSensor sensor)
Creates a connection to the sensor.
GoSensor::GoSensor_Output
GoOutput GoSensor_Output(GoSensor sensor)
Gets the output module, used for output configuration.
GoTools.h
Declares the GoTool classes.
GoSensor::GoSensor_CopyFile
kStatus GoSensor_CopyFile(GoSensor sensor, const kChar *sourceName, const kChar *destName)
Copies a file within the connected sensor.
GoSensor::GoSensor_HasBuddy
kBool GoSensor_HasBuddy(GoSensor sensor)
Reports whether a buddy had been assigned.
GoSetup.h
Declares the GoSetup class.
GoSensor::GoSensor_AutoStartEnabled
kBool GoSensor_AutoStartEnabled(GoSensor sensor)
Gets the AutoStart enabled state currently used by the sensor.
kObject
GoMode
Represents a scan mode.
kVersion
GoSensor::GoSensor_Stop
kStatus GoSensor_Stop(GoSensor sensor)
Stops the sensor.
kStatus
GoSensor::GoSensor_SetDefaultJob
kStatus GoSensor_SetDefaultJob(GoSensor sensor, const kChar *fileName)
Sets a default job file to be loaded on boot.
GoSensor::GoSensor_RemoteInfoCount
kSize GoSensor_RemoteInfoCount(GoSensor sensor)
Gets the count of remote sensor information held by the sensor.
GoTransform
Represents a sensor transformation.
GoSensor::GoSensor_EnableData
kStatus GoSensor_EnableData(GoSensor sensor, kBool enable)
Enables or disables the sensor's data channel.
GoSensor::GoSensor_Upgrade
kStatus GoSensor_Upgrade(GoSensor sensor, const kChar *sourcePath, GoUpgradeFx onUpdate, kPointer context)
Upgrades sensor firmware.
GoSensor::GoSensor_DirectoryFileCount
kSize GoSensor_DirectoryFileCount(GoSensor sensor, const kChar *extensionFilter, const kChar *path, kBool isRecursive)
Return the number of files contained in the specified path with an optional extension filter applied...
GoSensor::GoSensor_SetAddress
kStatus GoSensor_SetAddress(GoSensor sensor, const GoAddressInfo *info, kBool wait)
Configures a sensor's network address settings.
GoSensor::GoSensor_GetRuntimeVariables
kStatus GoSensor_GetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s *values)
Gets the values associated with a given runtime variable starting index and length.
GoSensor::GoSensor_ProtocolVersion
kVersion GoSensor_ProtocolVersion(GoSensor sensor)
Gets the sensor's protocol version.
GoSensor::GoSensor_Timestamp
kStatus GoSensor_Timestamp(GoSensor sensor, k64u *time)
Gets the current time stamp (common among all synchronized sensors).
GoSensor::GoSensor_States
kStatus GoSensor_States(GoSensor sensor, GoStates *states)
Reports the current states of the sensor.
GoSensor::GoSensor_RecordingEnabled
kBool GoSensor_RecordingEnabled(GoSensor sensor)
Gets the recording state of the sensor.
GoSensor::GoSensor_GetRuntimeVariableCount
kSize GoSensor_GetRuntimeVariableCount(GoSensor sensor)
Returns the number of runtime variables available on the device.
GoSensor::GoSensor_RemoteInfoAt
GoSensorInfo GoSensor_RemoteInfoAt(GoSensor sensor, kSize index)
Gets the remote sensor information at the given index.
GoSensor::GoSensor_AddBuddy
kStatus GoSensor_AddBuddy(GoSensor sensor, GoSensor buddy)
Assigns a buddy sensor.
kBool
GoSensor::GoSensor_EmitDigital
kStatus GoSensor_EmitDigital(GoSensor sensor, k16u index, k64s target, k8u value)
Schedules a digital output.
GoReplay.h
Declares the GoReplay class.
GoSensor::GoSensor_SetInputSource
kStatus GoSensor_SetInputSource(GoSensor sensor, GoInputSource source)
Sets the input source of the sensor.
GoSetup
Represents a device configuration.
GoSensor
Represents a Gocator sensor.
GoSensor::GoSensor_Reset
kStatus GoSensor_Reset(GoSensor sensor, kBool wait)
Reboots the main sensor and any connected buddy sensors.
GoSensor::GoSensor_ScheduledStart
kStatus GoSensor_ScheduledStart(GoSensor sensor, k64s value)
Starts the sensor at a scheduled value.
GoSensor::GoSensor_ChangePassword
kStatus GoSensor_ChangePassword(GoSensor sensor, GoUser user, const kChar *password)
Changes the password associated with the specified user account.
GoSensor::GoSensor_Role
GoRole GoSensor_Role(GoSensor sensor)
Gets the sensor's current role within the system.
GoAddressInfo
Sensor network address settings.
Definition: GoSdkDef.h:596
GoState
Represents the current state of a sensor object.
GoSensor::GoSensor_PartMatchModelCount
kSize GoSensor_PartMatchModelCount(GoSensor sensor)
Returns the number of part match models present in the currently loaded job.
GoSensor::GoSensor_IsConnected
kBool GoSensor_IsConnected(GoSensor sensor)
Reports whether the sensor is currently connected.