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