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