Gocator API
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-2026 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>
22 #include <GoSdk/Outputs/GoOutput.h>
23 #include <GoSdk/Tools/GoTools.h>
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 GoSensor
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  * WARNING! This operation writes to flash storage.
53  * Review the user manual for implications.
54  *
55  * This function uses UDP broadcasts for sensor configuration; the sensor does not need to
56  * be connected, and can be on a different subnet than the client.
57  *
58  * The sensor will automatically reboot if the address is successfully changed.
59  *
60  * @public @memberof GoSensor
61  * @version Introduced in firmware 4.0.10.27
62  * @param sensor GoSensor object.
63  * @param info New address settings.
64  * @param wait Should this function block until the sensor finishes rebooting?
65  * @return Operation status.
66  * @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.
67  */
68 GoFx(kStatus) GoSensor_SetAddress(GoSensor sensor, const GoAddressInfo* info, kBool wait);
69 
70 /**
71  * Retrieves the sensor's network address settings.
72  *
73  * @public @memberof GoSensor
74  * @version Introduced in firmware 4.0.10.27
75  * @param sensor GoSensor object.
76  * @param info Receives current address configuration.
77  * @return Operation status.
78  */
79 GoFx(kStatus) GoSensor_Address(GoSensor sensor, GoAddressInfo* info);
80 
81 /**
82  * Creates a connection to the sensor.
83  *
84  * @public @memberof GoSensor
85  * @version Introduced in firmware 4.0.10.27
86  * @param sensor GoSensor object.
87  * @return Operation status.
88  */
89 GoFx(kStatus) GoSensor_Connect(GoSensor sensor);
90 
91 /**
92  * Disconnects from the sensor. Do not call this function when state is locked
93  * with GoSensor_LockState().
94  *
95  * @public @memberof GoSensor
96  * @version Introduced in firmware 4.0.10.27
97  * @param sensor GoSensor object.
98  * @return Operation status.
99  */
100 GoFx(kStatus) GoSensor_Disconnect(GoSensor sensor);
101 
102 /**
103  * Reports whether the sensor is currently connected. If sensors are temporarily unreachable, they do not leave
104  * isConnected state. You can use GoSensor_IsResponsive for this case. You can optionally call GoSensor_Disconnect if
105  * unresponsive for too long, or GoSensor_Refresh to trigger discovery cycles that can update the connection status.
106  *
107  * See \ref detDisconnect for more details.
108  *
109  * @public @memberof GoSensor
110  * @version Introduced in firmware 4.0.10.27
111  * @param sensor GoSensor object.
112  * @return kTRUE if the sensor is connected, kFALSE otherwise.
113  */
114 GoFx(kBool) GoSensor_IsConnected(GoSensor sensor);
115 
116 /**
117  * Reports whether the sensor is currently responsive.
118  *
119  * See \ref detDisconnect for more details.
120  *
121  * @public @memberof GoSensor
122  * @version Introduced in firmware 5.0.2.0
123  * @param sensor GoSensor object.
124  * @return kTRUE if the sensor is responsive kFALSE otherwise.
125  */
126 GoFx(kBool) GoSensor_IsResponsive(GoSensor sensor);
127 
128 /**
129  * Reports whether the connected sensor's protocol version is compatible with the SDK's protocol version.
130  *
131  * @public @memberof GoSensor
132  * @version Introduced in firmware 4.4.4.14
133  * @param sensor GoSensor object.
134  * @return kTRUE if the sensor is compatible, kFALSE otherwise.
135  */
136 GoFx(kBool) GoSensor_IsCompatible(GoSensor sensor);
137 
138 /**
139  * Refreshes sensor state.
140  *
141  * Unresponsive sensors will be disconnected, and canceled sensors will be reconnected.
142  * Sensors in any other state will discard all locally-cached information.
143  *
144  * This function should be used to update sensors in the GO_SENSOR_INCONSISTENT state. This
145  * state can arise due to buddy changes performed by remote sensors (e.g. a main sensor boots
146  * and claims ownership of a buddy sensor, but the buddy sensor has already been detected and
147  * loaded as a main sensor by the client).
148  *
149  * See \ref detDisconnect for more details.
150  *
151  * @public @memberof GoSensor
152  * @version Introduced in firmware 4.0.10.27
153  * @param sensor GoSensor object.
154  * @return kTRUE if the sensor is connected; kFALSE otherwise.
155  */
156 GoFx(kStatus) GoSensor_Refresh(GoSensor sensor);
157 
158 /**
159  * Assigns a buddy sensor.
160  *
161  * This function is asynchronous, use GoSensor_AddBuddyBlocking() for synchronous version.
162  *
163  * NOTE: The provided buddy sensor handle must already be connected.
164  *
165  * @public @memberof GoSensor
166  * @version Introduced in firmware 4.0.10.27
167  * @param sensor GoSensor object.
168  * @param buddy Sensor to be assigned as buddy.
169  * @return Operation status.
170  * @see GoSensor_Connect, GoSensor_HasBuddy, GoSensor_BuddyId, GoSensor_RemoveBuddy
171  */
172 GoFx(kStatus) GoSensor_AddBuddy(GoSensor sensor, GoSensor buddy);
173 
174 /**
175 * Synchronously assigns a buddy sensor.
176 *
177 * NOTE: The provided buddy sensor handle must already be connected.
178 *
179 * @public @memberof GoSensor
180 * @version Introduced in firmware 4.8.1.65
181 * @param sensor GoSensor object.
182 * @param buddy Sensor to be assigned as buddy.
183 * @return Operation status.
184 * @see GoSensor_Connect, GoSensor_HasBuddy, GoSensor_BuddyId, GoSensor_RemoveBuddy
185 */
187 
188 /**
189  * Removes the current buddy sensor.
190  *
191  * @public @memberof GoSensor
192  * @version Introduced in firmware 4.0.10.27
193  * @param sensor GoSensor object.
194  * @return Operation status.
195  */
197 
198 /**
199  * Reports whether a buddy had been assigned.
200  *
201  * @public @memberof GoSensor
202  * @version Introduced in firmware 4.0.10.27
203  * @param sensor GoSensor object.
204  * @return kTRUE if sensor has a buddy; kFALSE otherwise.
205  */
206 GoFx(kBool) GoSensor_HasBuddy(GoSensor sensor);
207 
208 /**
209  * Gets the buddy sensor's device ID.
210  *
211  * @public @memberof GoSensor
212  * @version Introduced in firmware 4.0.10.27
213  * @param sensor GoSensor object.
214  * @return Buddy device ID (or k32U_NULL if not assigned).
215  */
216 GoFx(k32u) GoSensor_BuddyId(GoSensor sensor);
217 
218 /**
219  * Gets the sensor's scan mode.
220  *
221  * @public @memberof GoSensor
222  * @version Introduced in firmware 4.0.10.27
223  * @param sensor GoSensor object.
224  * @return Scan mode.
225  */
226 GoFx(GoMode) GoSensor_ScanMode(GoSensor sensor);
227 
228 /**
229  * Enables or disables the sensor's data channel. After using GoSensor_EnableData function, SDK application is responsible
230  * for disposing of the GoDataSet objects that hold the data received from the sensor on the data connection.
231  *
232  * @public @memberof GoSensor
233  * @version Introduced in firmware 4.0.10.27
234  * @param sensor GoSensor object.
235  * @param enable kTRUE to enable, or kFALSE to disable.
236  * @return Operation status.
237  */
238 GoFx(kStatus) GoSensor_EnableData(GoSensor sensor, kBool enable);
239 
240 /**
241  * Starts the sensor.
242  *
243  * @public @memberof GoSensor
244  * @version Introduced in firmware 4.0.10.27
245  * @param sensor GoSensor object.
246  * @return Operation status.
247  */
248 GoFx(kStatus) GoSensor_Start(GoSensor sensor);
249 
250 /**
251  * Checks if the sensor is ready to start, if all assigned buddies are connected.
252  *
253  * See \ref detDisconnect for more details.
254  *
255  * @public @memberof GoSensor
256  * @version Introduced in firmware 5.2.18.3
257  * @param sensor GoSensor object.
258  * @return Operation status.
259  */
260 GoFx(kBool) GoSensor_CanStart(GoSensor sensor);
261 
262 /**
263  * Starts the sensor at a scheduled value.
264  *
265  * @public @memberof GoSensor
266  * @version Introduced in firmware 4.1.3.106
267  * @param sensor GoSensor object.
268  * @param value Scheduled start value. uS when time triggered and ticks when encoder triggered.
269  * @return Operation status.
270  * @see GoSetup_SetTriggerSource, GoSetup_TriggerSource, GoSystem_Timestamp, GoSystem_Encoder
271  */
272 GoFx(kStatus) GoSensor_ScheduledStart(GoSensor sensor, k64s value);
273 
274 /**
275  * Stops the sensor.
276  *
277  * @public @memberof GoSensor
278  * @version Introduced in firmware 4.0.10.27
279  * @param sensor GoSensor object.
280  * @return Operation status.
281  */
282 GoFx(kStatus) GoSensor_Stop(GoSensor sensor);
283 
284 /**
285  * Performs a sensor snapshot.
286  *
287  * A snapshot starts the sensor, takes a scan, and immediately stops the sensor.
288  * Because the sensor is stopped after every snapshot, some asynchronous activities such
289  * as digital output may not have enough time to occur. Algorithms that maintain memory
290  * between scans would also be reset for every snapshot. The only guarantee that
291  * can be made is that the data is delivered over the SDK.
292  *
293  * Because of these limitations, GoSensor_Trigger should usually be used instead.
294  *
295  * @public @memberof GoSensor
296  * @version Introduced in firmware 5.2.1.x
297  * @param sensor GoSensor object.
298  * @return Operation status.
299  */
300 GoFx(kStatus) GoSensor_Snapshot(GoSensor sensor);
301 
302 /**
303  * Perform alignment using the configured alignment type and target.
304  *
305  * NOTE: This operation will result in a sensor start for the duration of the
306  * alignment. It can be canceled via GoSensor_Stop. This function's operation
307  * status does not correspond to the actual alignment result. In order to
308  * retrieve the alignment result, you must enable the data channel before calling
309  * this function, receive an alignment data message and then check its status.
310  *
311  * WARNING! This operation may (depending on alignment reference) write to flash storage.
312  * Review the user manual for implications.
313  *
314  * @public @memberof GoSensor
315  * @version Introduced in firmware 4.0.10.27
316  * @param sensor GoSensor object.
317  * @return Operation status.
318  * @see GoSensor_EnableData, GoSystem_ReceiveData, GoSetup_AlignmentType, GoSetup_AlignmentMovingTarget, GoSetup_AlignmentStationaryTarget, GoAlignMsg_Status, GoSensor_Stop
319  * @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.
320  */
321 GoFx(kStatus) GoSensor_Align(GoSensor sensor);
322 
323 
324 /**
325  * Clears the current sensor alignment.
326  *
327  * WARNING! This operation writes to flash storage.
328  * Review the user manual for implications.
329  *
330  * @public @memberof GoSensor
331  * @version Introduced in firmware 4.1.3.106
332  * @param sensor GoSensor object.
333  * @return Operation status.
334  * @see GoSensor_Align
335  * @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.
336  */
338 
339 
340 /**
341  * Perform an exposure auto set.
342  *
343  * NOTE: This operation will result in a sensor start for the duration of the
344  * exposure AutoSet. A successful operation status does NOT modify the configuration.
345  * You must retrieve the resulting exposure value and set it for the appropriate
346  * exposure setting. This involves enabling the data connection prior to running
347  * exposure auto set and then receiving an exposure auto set message, which
348  * you can then use to query the status and access the resulting value.
349  *
350  * @public @memberof GoSensor
351  * @version Introduced in firmware 4.0.10.27
352  * @param sensor GoSensor object.
353  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
354  * @return Operation status.
355  * @see GoRole, GoSensor_EnableData, GoSystem_ReceiveData, GoExposureCalMsg_Status, GoExposureCalMsg_Exposure
356  */
357 GoFx(kStatus) GoSensor_ExposureAutoSet(GoSensor sensor, GoRole role);
358 
359 /**
360  * Gets the alignment state of the sensor.
361  *
362  * @public @memberof GoSensor
363  * @version Introduced in firmware 4.0.10.27
364  * @param sensor GoSensor object.
365  * @return A GoAlignmentState.
366  */
368 
369 
370 /**
371  * Sets the alignment reference of the sensor.
372  *
373  * @public @memberof GoSensor
374  * @version Introduced in firmware 4.0.10.27
375  * @param sensor GoSensor object.
376  * @param reference The alignment reference value to set.
377  * @return Operation status.
378  */
380 
381 /**
382  * Gets the alignment reference of the sensor.
383  *
384  * @public @memberof GoSensor
385  * @version Introduced in firmware 4.0.10.27
386  * @param sensor GoSensor object.
387  * @param reference A pointer that will hold the current alignment reference value.
388  * @return Operation status.
389  */
391 
392 /**
393  * Reboots the main sensor and any connected buddy sensors.
394  *
395  * @public @memberof GoSensor
396  * @version Introduced in firmware 4.0.10.27
397  * @param sensor GoSensor object.
398  * @param wait kTRUE to wait for reboot and then reconnect.
399  * @return Operation status.
400  */
401 GoFx(kStatus) GoSensor_Reset(GoSensor sensor, kBool wait);
402 
403 /**
404  * Resets the encoder value. NOTE: This is only possible with a direct encoder
405  * connection to a sensor. Resetting the encoder value when connected to a Master
406  * device will not work.
407  *
408  * @public @memberof GoSensor
409  * @version Introduced in firmware 4.5.3.57
410  * @param sensor GoSensor object.
411  * @return Operation status.
412  */
414 
415 /**
416  * Aborts ongoing sensor communication.
417  *
418  * This method asynchronously aborts ongoing communication; the next time that any
419  * I/O operation blocks for an extended period of time, it will be terminated. This method
420  * is thread-safe.
421  *
422  * In order to resume communication, call GoSensor_Refresh or GoSensor_Connect.
423  *
424  * @public @memberof GoSensor
425  * @version Introduced in firmware 4.0.10.27
426  * @param sensor GoSensor object.
427  * @return Operation status.
428  */
429 GoFx(kStatus) GoSensor_Cancel(GoSensor sensor);
430 
431 /**
432  * Gets the current time stamp (common among all synchronized sensors).
433  *
434  * @public @memberof GoSensor
435  * @version Introduced in firmware 4.0.10.27
436  * @param sensor GoSensor object.
437  * @param time Receives the current time stamp(us).
438  * @return Operation status.
439  */
440 GoFx(kStatus) GoSensor_Timestamp(GoSensor sensor, k64u* time);
441 
442 /**
443  * Gets the current encoder count from the sensor. This is useful when an encoder value is needed
444  * while the sensor is not started and thus not producing data with encoder values in the stamp.
445  *
446  * Note that this function sends a command to the sensor, where the current encoder value is read
447  * and then sent back in a reply message. So this is not the most accurate method of reading the
448  * encoder value. To read the encoder value of a specific frame of data, use the encoder value
449  * from the GoStamp received as GO_DATA_MESSAGE_TYPE_STAMP.
450  *
451  * @public @memberof GoSensor
452  * @version Introduced in firmware 4.0.10.27
453  * @param sensor GoSensor object.
454  * @param encoder Receives the encoder count (ticks).
455  * @return Operation status.
456  */
457 GoFx(kStatus) GoSensor_Encoder(GoSensor sensor, k64s* encoder);
458 
459 /**
460  * Sends a software trigger to the sensor.
461  *
462  * This method is used in conjunction with sensors that are configured to accept
463  * software triggers. The sensor must be running (e.g. by calling GoSensor_Start)
464  * for triggers to be accepted.
465  *
466  * When the trigger mode is set to Software, this command will trigger individual
467  * frames in Profile or Surface mode. For G2 sensors with other trigger modes,
468  * this command can also be used to trigger Fixed Length surface generation when
469  * the Fixed Length Start Trigger option is set to "Software".
470  *
471  * @public @memberof GoSensor
472  * @version Introduced in firmware 4.0.10.27
473  * @param sensor GoSensor object.
474  * @return Operation status.
475  * @see GoSetup_TriggerSource, GoSetup_SetTriggerSource
476  */
477 GoFx(kStatus) GoSensor_Trigger(GoSensor sensor);
478 
479 /**
480  * Schedules a digital output.
481  *
482  * This method requires that the output is configured to trigger on software control.
483  *
484  * @public @memberof GoSensor
485  * @version Introduced in firmware 4.0.10.27
486  * @param sensor GoSensor object.
487  * @param index The digital output index.
488  * @param target The time or position target (us or mm), depending on GoDomain. Ignored if
489  * GoDigital_ScheduleEnabled is false or GoDigital_SignalType is pulsed.
490  * @param value The value of scheduled output (0-Low or 1-High). Ignored if output
491  * GoDigital_SignalType is pulsed.
492  * @return Operation status.
493  */
494 GoFx(kStatus) GoSensor_EmitDigital(GoSensor sensor, k16u index, k64s target, k8u value);
495 
496 /**
497  * Schedules an analog output.
498  *
499  * This method requires that the output be configured to trigger on software control.
500  * NOTE: It is not possible to schedule a continuous output. The operation will
501  * fail accordingly if attempted.
502  *
503  * @public @memberof GoSensor
504  * @version Introduced in firmware 4.0.10.27
505  * @param sensor GoSensor object.
506  * @param index The analog output index.
507  * @param target The time or position target (us or mm), depending on GoDomain. Ignored if
508  * GoAnalog_ScheduleEnabled is false.
509  * @param value The value of the scheduled output (uA).
510  * @return Operation status.
511  */
512 GoFx(kStatus) GoSensor_EmitAnalog(GoSensor sensor, k16u index, k64s target, k32s value);
513 
514 /**
515  * Gets the number of files available from the connected sensor. This includes files that may not be visible through the web interface.
516  *
517  * @public @memberof GoSensor
518  * @version Introduced in firmware 4.0.10.27
519  * @param sensor GoSensor object.
520  * @return File count.
521  */
522 GoFx(kSize) GoSensor_FileCount(GoSensor sensor);
523 
524 /**
525  * Gets the file name at the specified index.
526  *
527  * @public @memberof GoSensor
528  * @version Introduced in firmware 4.0.10.27
529  * @param sensor GoSensor object.
530  * @param index Index of the desired file name.
531  * @param name Receives the name of the file.
532  * @param capacity Capacity of the file name buffer.
533  * @return Operation status.
534  */
535 GoFx(kStatus) GoSensor_FileNameAt(GoSensor sensor, kSize index, kChar* name, kSize capacity);
536 
537 /**
538  * Uploads a file to the connected sensor. The following is a list of
539  * macros representing common files used in this operation:
540  *
541  * @li GO_SENSOR_LIVE_JOB - Represents "_live.job".
542  * @li GO_SENSOR_LIVE_REPLAY - Represents the recording file, "_live.rec".
543  *
544  * WARNING! This operation writes to flash storage.
545  * Review the user manual for implications.
546  *
547  * @public @memberof GoSensor
548  * @version Introduced in firmware 4.0.10.27
549  * @param sensor GoSensor object.
550  * @param sourcePath Source file system path for the file to be uploaded.
551  * @param destName Destination name for the uploaded file (maximum 63 characters).
552  * @return Operation status.
553  * @remark Calling this function will result in writing operations to flash storage if the destination is not a live file. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.
554  */
555 GoFx(kStatus) GoSensor_UploadFile(GoSensor sensor, const kChar* sourcePath, const kChar* destName);
556 
557 /**
558  * Downloads a file from the connected sensor. The following is a list of
559  * macros representing common files used in this operation:
560  *
561  * @li GO_SENSOR_LIVE_JOB - Represents "_live.job".
562  * @li GO_SENSOR_LIVE_REPLAY - Represents the recording file, "_live.rec".
563  *
564  * File names of saved jobs may also be specified.
565  *
566  * @public @memberof GoSensor
567  * @version Introduced in firmware 4.0.10.27
568  * @param sensor GoSensor object.
569  * @param sourceName Source name of the file to be downloaded.
570  * @param destPath Destination file system path for the file to be downloaded.
571  * @return Operation status.
572  */
573 GoFx(kStatus) GoSensor_DownloadFile(GoSensor sensor, const kChar* sourceName, const kChar* destPath);
574 
575 /**
576  * Copies a file within the connected sensor.
577  *
578  * If the destination file name is GO_SENSOR_LIVE_JOB_NAME, then the configuration job
579  * file used by the sensor is changed (ie. a job/load switch operation takes place).
580  * To do a job load/switch, the sensor is first stopped before the job load/switch.
581  * After the job load/switch, the sensor remains stopped, to match the behaviour
582  * of loading/switching a job file from the GUI.
583  *
584  * WARNING! This operation writes to flash storage.
585  * Review the user manual for implications.
586  *
587  * NOTE: if doing a job load/switch, this API leaves the sensor stopped. User must
588  * explicitly start the sensor again.
589  *
590  * @public @memberof GoSensor
591  * @version Introduced in firmware 4.0.10.27
592  * @param sensor GoSensor object.
593  * @param sourceName Source name for the file to be copied.
594  * @param destName Destination name for the file (maximum 63 characters).
595  * @return Operation status.
596  * @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.
597  * @see GoSensor_UploadFile()
598  */
599 GoFx(kStatus) GoSensor_CopyFile(GoSensor sensor, const kChar* sourceName, const kChar* destName);
600 
601 /**
602  * Deletes a file within the connected sensor.
603  *
604  * @public @memberof GoSensor
605  * @version Introduced in firmware 4.0.10.27
606  * @param sensor GoSensor object.
607  * @param name Name of the file to be deleted.
608  * @return Operation status.
609  * @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.
610  */
611 GoFx(kStatus) GoSensor_DeleteFile(GoSensor sensor, const kChar* name);
612 
613 /**
614  * Checks whether the specified file is present on the sensor.
615  *
616  * WARNING! This operation writes to flash storage.
617  * Review the user manual for implications.
618  *
619  * @public @memberof GoSensor
620  * @version Introduced in firmware 4.0.10.27
621  * @param sensor GoSensor object.
622  * @param name Name of the file to be checked.
623  * @return Operation status.
624  */
625 GoFx(kBool) GoSensor_FileExists(GoSensor sensor, const kChar* name);
626 
627 /**
628  * Gets the available storage space remaining for user files.
629  *
630  * @public @memberof GoSensor
631  * @version
632  * @param sensor GoSensor object.
633  * @return Storage space available.
634  */
636 
637 /**
638  * Gets the storage space used for user files.
639  *
640  * @public @memberof GoSensor
641  * @version
642  * @param sensor GoSensor object.
643  * @return Storage space used.
644  */
646 
647 /**
648  * Sets a default job file to be loaded on boot.
649  *
650  * WARNING! This operation writes to flash storage.
651  * Review the user manual for implications.
652  *
653  * @public @memberof GoSensor
654  * @version Introduced in firmware 4.0.10.27
655  * @param sensor GoSensor object.
656  * @param fileName Name of the default file.
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_SetDefaultJob(GoSensor sensor, const kChar* fileName);
661 
662 /**
663  * Gets the name of the default job file to be loaded on boot.
664  *
665  * @public @memberof GoSensor
666  * @version Introduced in firmware 4.0.10.27
667  * @param sensor GoSensor object.
668  * @param fileName Receives name of the default file.
669  * @param capacity Name buffer capacity.
670  * @return Operation status.
671  */
672 GoFx(kStatus) GoSensor_DefaultJob(GoSensor sensor, kChar* fileName, kSize capacity);
673 
674 /**
675  * Gets the name of the loaded job file and whether it has been modified since loading.
676  *
677  * @public @memberof GoSensor
678  * @version Introduced in firmware 4.0.10.27
679  * @param sensor GoSensor object.
680  * @param fileName Receives name of the loaded file.
681  * @param capacity Name buffer capacity.
682  * @param changed Receives the status of whether the file has changed.
683  * @return Operation status.
684  */
685 GoFx(kStatus) GoSensor_LoadedJob(GoSensor sensor, kChar* fileName, kSize capacity, kBool* changed);
686 
687 /**
688  * Logs into the sensor using the specified user name and password.
689  *
690  * Logging in is not required in order to programmatically control a sensor. The Gocator log-in feature is
691  * intended only to support administrative user interfaces, by allowing the username and password to be
692  * stored in the sensor.
693  *
694  * @public @memberof GoSensor
695  * @version Introduced in firmware 4.0.10.27
696  * @param sensor GoSensor object.
697  * @param user User account.
698  * @param password User password.
699  * @return Operation status.
700  */
701 GoFx(kStatus) GoSensor_LogIn(GoSensor sensor, GoUser user, const kChar* password);
702 
703 /**
704  * Changes the password associated with the specified user account.
705  *
706  * The administrator and technician passwords limit access to the sensor's
707  * web-based user interface only. They do not add authentication to the
708  * control protocol used by this SDK and do not enable any form of encryption
709  * on data sent to or received from the sensor. An application that can reach
710  * the sensor on the network can issue control commands regardless of which
711  * password (if any) has been set.
712  *
713  * WARNING! This operation writes to flash storage.
714  * Review the user manual for implications.
715  *
716  * @public @memberof GoSensor
717  * @version Introduced in firmware 4.0.10.27
718  * @param sensor GoSensor object.
719  * @param user User account.
720  * @param password New password.
721  * @return Operation status.
722  * @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.
723  */
724 GoFx(kStatus) GoSensor_ChangePassword(GoSensor sensor, GoUser user, const kChar* password);
725 
726 /**
727  * Upgrades sensor firmware.
728  *
729  * This function will block until the upgrade is completed.
730  *
731  * WARNING! This operation writes to flash storage.
732  * Review the user manual for implications.
733  *
734  * This function results in flash storage modifications. If modifications are interrupted due to
735  * power loss, the sensor may reboot into Rescue mode.
736  *
737  * The sensor does not need to be connected to perform an upgrade.
738  *
739  * @public @memberof GoSensor
740  * @version Introduced in firmware 4.0.10.27 and updated in 4.3.3.124
741  * @param sensor GoSensor object.
742  * @param sourcePath Local file system path to the upgrade file.
743  * @param onUpdate Callback function to receive progress updates, or kNULL.
744  * @param context Context handle to be passed to the upgrade callback.
745  * @return Operation status.
746  */
747 GoFx(kStatus) GoSensor_Upgrade(GoSensor sensor, const kChar* sourcePath, GoUpgradeFx onUpdate, kPointer context);
748 
749 /**
750  * Creates a backup of sensor files and downloads the backup to the specified location.
751  *
752  * @public @memberof GoSensor
753  * @version Introduced in firmware 4.0.10.27
754  * @param sensor GoSensor object.
755  * @param destPath Local file system path for the saved backup file.
756  * @return Operation status.
757  */
758 GoFx(kStatus) GoSensor_Backup(GoSensor sensor, const kChar* destPath);
759 
760 /**
761  * Restores a backup of sensor files.
762  *
763  * WARNING! This operation writes to flash storage.
764  * Review the user manual for implications.
765  *
766  * @public @memberof GoSensor
767  * @version Introduced in firmware 4.0.10.27
768  * @param sensor GoSensor object.
769  * @param sourcePath Local file system path of the saved backup file.
770  * @return Operation status.
771  * @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.
772  */
773 GoFx(kStatus) GoSensor_Restore(GoSensor sensor, const kChar* sourcePath);
774 
775 /**
776  * Restores factory default settings.
777  *
778  * WARNING! This operation writes to flash storage.
779  * Review the user manual for implications.
780  *
781  * @public @memberof GoSensor
782  * @version Introduced in firmware 4.0.10.27
783  * @param sensor GoSensor object.
784  * @param restoreAddress kTRUE to restore the factory default IP address; False otherwise.
785  * @return Operation status.
786  * @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.
787  */
788 GoFx(kStatus) GoSensor_RestoreDefaults(GoSensor sensor, kBool restoreAddress);
789 
790 /**
791  * Gets the GoSetup instance associated with the sensor.
792  *
793  * @public @memberof GoSensor
794  * @version Introduced in firmware 4.0.10.27
795  * @param sensor GoSensor object.
796  * @return A GoSetup object module
797  */
798 GoFx(GoSetup) GoSensor_Setup(GoSensor sensor);
799 
800 /**
801  * Gets the sensor's tools module, used for measurement configuration.
802  *
803  * @public @memberof GoSensor
804  * @version Introduced in firmware 4.0.10.27
805  * @param sensor GoSensor object.
806  * @return Measurement configuration module.
807  */
808 GoFx(GoTools) GoSensor_Tools(GoSensor sensor);
809 
810 /**
811  * Gets the output module, used for output configuration.
812  *
813  * @public @memberof GoSensor
814  * @version Introduced in firmware 4.0.10.27
815  * @param sensor GoSensor object.
816  * @return Output configuration module.
817  */
818 GoFx(GoOutput) GoSensor_Output(GoSensor sensor);
819 
820 /**
821  * Gets the transform module, used for transformation configuration.
822  *
823  * @public @memberof GoSensor
824  * @version Introduced in firmware 4.0.10.27
825  * @param sensor GoSensor object.
826  * @return Transformation configuration module.
827  */
829 
830 /**
831  * Gets the replay module, used for replay configuration.
832  *
833  * @public @memberof GoSensor
834  * @version Introduced in firmware 4.5.3.57
835  * @param sensor GoSensor object.
836  * @return Replay configuration module.
837  */
838 GoFx(GoReplay) GoSensor_Replay(GoSensor sensor);
839 
840 /**
841  * Gets the device identifier associated with this sensor.
842  *
843  * @public @memberof GoSensor
844  * @version Introduced in firmware 4.0.10.27
845  * @param sensor GoSensor object.
846  * @return The sensor's device ID.
847  */
848 GoFx(k32u) GoSensor_Id(GoSensor sensor);
849 
850 /**
851  * Gets the part number associated with this sensor.
852  *
853  * @public @memberof GoSensor
854  * @version Introduced in firmware 5.3.17.23
855  * @param sensor GoSensor object.
856  * @param partNumber A character array pointer.
857  * @param capacity The character array capacity.
858  * @return Operation status.
859  */
860 GoFx(kStatus) GoSensor_PartNumber(GoSensor sensor, kChar* partNumber, kSize capacity);
861 
862 /**
863  * Gets the model display name associated with this sensor.
864  *
865  * @public @memberof GoSensor
866  * @version Introduced in firmware 5.3.17.23
867  * @param sensor GoSensor object.
868  * @param modelDisplayName A character array pointer.
869  * @param capacity The character array capacity.
870  * @return Operation status.
871  */
872 GoFx(kStatus) GoSensor_ModelDisplayName(GoSensor sensor, kChar* modelDisplayName, kSize capacity);
873 
874 /**
875  * Reports the current system state of the sensor from cache.
876  * Sends a command to the sensor if cache info is invalid.
877  * Cache info is invalidated during initialization, restore, buddying changes, etc.
878  * Thread safety is not guaranteed.
879  * Calling this from separate threads can cause concurrency issues.
880  *
881  * See \ref detDisconnect for more details.
882  *
883  * @public @memberof GoSensor
884  * @version Introduced in firmware 4.0.10.27
885  * @param sensor GoSensor object.
886  * @return Sensor state.
887  */
888 GoFx(GoState) GoSensor_State(GoSensor sensor);
889 
890 /**
891  * Reports various current states of the sensor associated with the control connection.
892  * Sends a command to the sensor.
893  * Thread safety is not guaranteed.
894  * Calling this from separate threads can cause concurrency issues.
895  *
896  * See \ref detDisconnect for more details.
897  *
898  * @public @memberof GoSensor
899  * @version Introduced in firmware 4.0.10.27
900  * @param sensor GoSensor object.
901  * @param states Reference to updated states.
902  * @return Operation status.
903  */
904 GoFx(kStatus) GoSensor_States(GoSensor sensor, GoStates* states);
905 
906 /**
907  * Gets the sensor's current role within the system.
908  *
909  * @public @memberof GoSensor
910  * @version Introduced in firmware 4.0.10.27
911  * @param sensor GoSensor object.
912  * @return Sensor role.
913  */
914 GoFx(GoRole) GoSensor_Role(GoSensor sensor);
915 
916 /**
917  * Reports the user account associated with the current user.
918  *
919  * @public @memberof GoSensor
920  * @version Introduced in firmware 4.0.10.27
921  * @param sensor GoSensor object.
922  * @return User account id.
923  */
924 GoFx(GoUser) GoSensor_User(GoSensor sensor);
925 
926 /**
927  * Gets the sensor's protocol version.
928  *
929  * @public @memberof GoSensor
930  * @version Introduced in firmware 4.0.10.27
931  * @param sensor GoSensor object.
932  * @return Protocol version.
933  */
935 
936 /**
937  * Gets the sensor's firmware version.
938  *
939  * @public @memberof GoSensor
940  * @version Introduced in firmware 4.0.10.27
941  * @param sensor GoSensor object.
942  * @return Firmware version.
943  */
945 
946 /**
947  * Sets the recording state of the sensor.
948  *
949  * @public @memberof GoSensor
950  * @version Introduced in firmware 4.0.10.27
951  * @param sensor GoSensor object.
952  * @param enable Enables or disables recording.
953  * @return Operation status.
954  */
955 GoFx(kStatus) GoSensor_EnableRecording(GoSensor sensor, kBool enable);
956 
957 /**
958  * Gets the recording state of the sensor.
959  *
960  * @public @memberof GoSensor
961  * @version Introduced in firmware 4.0.10.27
962  * @param sensor GoSensor object.
963  * @return kTRUE if recording is enabled. kFALSE otherwise.
964  */
966 
967 /**
968  * Sets the input source of the sensor.
969  *
970  * @public @memberof GoSensor
971  * @version Introduced in firmware 4.0.10.27
972  * @param sensor GoSensor object.
973  * @param source The input source to use.
974  * @return Operation status.
975  */
977 
978 /**
979  * Gets the input source currently used by the sensor.
980  *
981  * @public @memberof GoSensor
982  * @version Introduced in firmware 4.0.10.27
983  * @param sensor GoSensor object.
984  * @return A GoInputSource.
985  */
987 
988 /**
989  * Simulates the current frame in the live recording buffer.
990  *
991  * @public @memberof GoSensor
992  * @version Introduced in firmware 4.0.10.27
993  * @param sensor GoSensor object.
994  * @param isBufferValid kTRUE if the source simulation buffer was valid. kFALSE otherwise.
995  * @return Operation status.
996  */
997 GoFx(kStatus) GoSensor_Simulate(GoSensor sensor, kBool* isBufferValid);
998 
999 
1000 /**
1001  * Advances one frame from the current replay position.
1002  *
1003  * @public @memberof GoSensor
1004  * @version Introduced in firmware 4.0.10.27
1005  * @param sensor GoSensor object.
1006  * @param direction Direction with which to step.
1007  * @return Operation status.
1008  */
1009 GoFx(kStatus) GoSensor_PlaybackStep(GoSensor sensor, GoSeekDirection direction);
1010 
1011 /**
1012  * Sets the current frame position for a replay.
1013  *
1014  * @public @memberof GoSensor
1015  * @version Introduced in firmware 4.0.10.27
1016  * @param sensor GoSensor object.
1017  * @param position The frame position to seek.
1018  * @return Operation status.
1019  */
1020 GoFx(kStatus) GoSensor_PlaybackSeek(GoSensor sensor, kSize position);
1021 
1022 /**
1023  * Gets the current replay frame position.
1024  *
1025  * @public @memberof GoSensor
1026  * @version Introduced in firmware 4.0.10.27
1027  * @param sensor GoSensor object.
1028  * @param position The current frame position index.
1029  * @param count The frame count.
1030  * @return Operation status.
1031  */
1032 GoFx(kStatus) GoSensor_PlaybackPosition(GoSensor sensor, kSize* position, kSize* count);
1033 
1034 /**
1035  * Clears the replay buffer.
1036  *
1037  * @public @memberof GoSensor
1038  * @version Introduced in firmware 4.0.10.27
1039  * @param sensor GoSensor object.
1040  * @return Operation status.
1041  */
1043 
1044 /**
1045  * Resets the measurement statistics reported by the health channel
1046  *
1047  * @public @memberof GoSensor
1048  * @version Introduced in firmware 4.0.10.27
1049  * @param sensor GoSensor object.
1050  * @return Operation status.
1051  */
1053 
1054 /**
1055  * Exports the current frame of a replay in the form of a bitmap.
1056  *
1057  * @public @memberof GoSensor
1058  * @version Introduced in firmware 4.0.10.27
1059  * @param sensor GoSensor object.
1060  * @param type The type of data to export.
1061  * @param source The device data source to export from.
1062  * @param dstFileName The destination file name of the exported bitmap file.
1063  * @return Operation status.
1064  */
1067  GoDataSource source,
1068  const kChar* dstFileName);
1069 
1070 /**
1071  * Exports replay data in CSV format.
1072  *
1073  * @public @memberof GoSensor
1074  * @version Introduced in firmware 4.0.10.27
1075  * @param sensor GoSensor object.
1076  * @param dstFileName The destination file name of the exported CSV file.
1077  * @return Operation status.
1078  */
1079 GoFx(kStatus) GoSensor_ExportCsv(GoSensor sensor, const kChar* dstFileName);
1080 
1081 /**
1082  * Returns an enumerator value representing the current sensor's family.
1083  *
1084  * @public @memberof GoSensor
1085  * @version Introduced in firmware 4.0.10.27
1086  * @param sensor GoSensor object.
1087  * @return A GoFamily value.
1088  */
1089 GoFx(GoFamily) GoSensor_Family(GoSensor sensor);
1090 
1091 /**
1092  * Clears the log file (_live.log).
1093  *
1094  * @public @memberof GoSensor
1095  * @version Introduced in firmware 4.0.10.27
1096  * @param sensor GoSensor object.
1097  * @return Operation status.
1098  */
1099 GoFx(kStatus) GoSensor_ClearLog(GoSensor sensor);
1100 
1101 /**
1102  * Sets the AutoStart enabled state of the sensor.
1103  *
1104  * @public @memberof GoSensor
1105  * @version Introduced in firmware 4.0.10.27
1106  * @param sensor GoSensor object.
1107  * @param enable The AutoStart enabled state to use.
1108  * @return Operation status.
1109  */
1110 GoFx(kStatus) GoSensor_EnableAutoStart(GoSensor sensor, kBool enable);
1111 
1112 /**
1113  * Gets the AutoStart enabled state currently used by the sensor.
1114  *
1115  * @public @memberof GoSensor
1116  * @version Introduced in firmware 4.0.10.27
1117  * @param sensor GoSensor object.
1118  * @return kTRUE if auto start is enabled and kFALSE otherwise.
1119  */
1121 
1122 /**
1123 * Set sensor voltage settings (only on G3210)
1124 *
1125 * @public @memberof GoSensor
1126 * @version Introduced in firmware 4.7.5.25
1127 * @param sensor GoSensor object.
1128 * @param voltage Either 48V or 24V operation
1129 * @param cableLength When in 24V operation mode the cable length (meter) must also be supplied
1130 * @return Operation status.
1131 */
1132 GoFx(kStatus) GoSensor_SetVoltage(GoSensor sensor, GoVoltageSetting voltage, k64f cableLength);
1133 
1134 /**
1135 * Get the sensor voltage settings (only on G3210)
1136 *
1137 * @public @memberof GoSensor
1138 * @version Introduced in firmware 4.7.5.25
1139 * @param sensor GoSensor object.
1140 * @param voltage Destination to store voltage (can be kNULL)
1141 * @param cableLength Destination to store cable length (meter) (can be kNULL)
1142 * @return Operation status.
1143 */
1144 GoFx(kStatus) GoSensor_GetVoltage(GoSensor sensor, GoVoltageSetting *voltage, k64f *cableLength);
1145 
1146 /**
1147 * Sets the quick edit state of the sensor.
1148 *
1149 * @public @memberof GoSensor
1150 * @version Introduced in firmware 4.7.11.5
1151 * @param sensor GoSensor object.
1152 * @param enable The Quick Edit enabled state to use.
1153 * @return Operation status.
1154 */
1155 GoFx(kStatus) GoSensor_EnableQuickEdit(GoSensor sensor, kBool enable);
1156 
1157 /**
1158 * Gets the quick edit state of the sensor
1159 *
1160 * @public @memberof GoSensor
1161 * @version Introduced in firmware 4.7.11.5
1162 * @param sensor GoSensor object.
1163 * @return kTRUE if Quick Edit is enabled, kFALSE otherwise.
1164 */
1166 
1167 /**
1168  * Gets the count of remote sensor information held by the sensor.
1169  *
1170  * @public @memberof GoSensor
1171  * @version Introduced in firmware 4.0.10.27
1172  * @param sensor GoSensor object.
1173  * @return The remote sensor information count.
1174  */
1176 
1177 /**
1178  * Gets the remote sensor information at the given index.
1179  *
1180  * @public @memberof GoSensor
1181  * @version Introduced in firmware 4.0.10.27
1182  * @param sensor GoSensor object.
1183  * @param index The index of the remote sensor information to retrieve.
1184  * @return A handle to the selected remote sensor information or kNULL if an invalid index is provided.
1185  */
1186 GoFx(GoSensorInfo) GoSensor_RemoteInfoAt(GoSensor sensor, kSize index);
1187 
1188 /**
1189  * Return the number of files contained in the specified path with an optional extension filter applied.
1190  *
1191  * @public @memberof GoSensor
1192  * @version Introduced in firmware 4.1.3.106
1193  * @param sensor GoSensor object.
1194  * @param extensionFilter An optional extension filter to apply. Send "" to not apply a filter.
1195  * @param path The file system path to retrieve the file count for.
1196  * @param isRecursive kTRUE to include files in sub-folders of the path and kFALSE to only count files in the immediate path.
1197  * @return The number of files contained in the specified path with an optional extension filter applied.
1198  */
1199 GoFx(kSize) GoSensor_DirectoryFileCount(GoSensor sensor, const kChar* extensionFilter, const kChar* path, kBool isRecursive);
1200 
1201 /**
1202  * Retrieves the file name at the specified index for a given path and optional extension filter.
1203  *
1204  * @public @memberof GoSensor
1205  * @version Introduced in firmware 4.1.3.106
1206  * @param sensor GoSensor object.
1207  * @param extensionFilter An optional extension filter to apply. Send "" to not apply a filter.
1208  * @param path The file system path to retrieve the file count for.
1209  * @param isRecursive kTRUE to include files in sub-folders of the path and kFALSE to only count files in the immediate path.
1210  * @param index The index of the file name to retrieve.
1211  * @param fileName The pointer to a character array of which to store the retrieve file name.
1212  * @param capacity The maximum capacity of the character array.
1213  * @return Operation status.
1214  */
1215 GoFx(kStatus) GoSensor_DirectoryFileNameAt(GoSensor sensor, const kChar* extensionFilter, const kChar* path, kBool isRecursive, kSize index, kChar* fileName, kSize capacity);
1216 
1217 /**
1218  * Defines the signature for a custom data message handler.
1219  *
1220  * @public @memberof GoSensor
1221  * @version Introduced in firmware 4.1.3.106
1222  * @param context A pointer to an application context to use with the provided data set.
1223  * @param sensor GoSensor object.
1224  * @param dataSet The data set.
1225  * @return Operation status.
1226  * @see GoSensor_SetDataHandler
1227  */
1228 typedef kStatus (kCall* GoSensorDataSetFx)(kPointer context, GoSensor sensor, GoDataSet dataSet);
1229 
1230 /**
1231  * Sets the data callback function to be used upon receipt of data.
1232  *
1233  * @public @memberof GoSensor
1234  * @version Introduced in firmware 4.1.3.106
1235  * @param sensor GoSensor object.
1236  * @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.
1237  * @param context The context to use with the function pointer.
1238  * @return Operation status.
1239  * @see GoSensorDataSetFx
1240  */
1241 GoFx(kStatus) GoSensor_SetDataHandler(GoSensor sensor, GoSensorDataSetFx function, kPointer context);
1242 
1243 
1244 /**
1245  * Creates a part matching model based on the current part data.
1246  *
1247  * @public @memberof GoSensor
1248  * @version Introduced in firmware 4.2.4.7
1249  * @param sensor GoSensor object.
1250  * @param name The intended name of the part match model.
1251  * @return Operation status.
1252  */
1253 GoFx(kStatus) GoSensor_PartMatchCreateModel(GoSensor sensor, const kChar* name);
1254 
1255 /**
1256  * Detect the edges of the specified part model.
1257  *
1258  * @public @memberof GoSensor
1259  * @version Introduced in firmware 4.2.4.7
1260  * @param sensor GoSensor object.
1261  * @param name The name of the part match model to detect edges on.
1262  * @param sensitivity The sensitivity to use for model edge detection.
1263  * @return Operation status.
1264  */
1265 GoFx(kStatus) GoSensor_PartMatchDetectModelEdges(GoSensor sensor, const kChar* name, k16u sensitivity);
1266 
1267 /**
1268  * Returns a handle to a part model based on a given name.
1269  *
1270  * @public @memberof GoSensor
1271  * @version Introduced in firmware 4.2.4.7
1272  * @param sensor GoSensor object.
1273  * @param name The name of the part match model to retrieve.
1274  * @return A GoPartModel handle.
1275  */
1276 GoFx(GoPartModel) GoSensor_PartMatchModel(GoSensor sensor, const kChar* name);
1277 
1278 /**
1279  * Returns the number of part match models present in the currently loaded job.
1280  *
1281  * @public @memberof GoSensor
1282  * @version Introduced in firmware 4.2.4.7
1283  * @param sensor GoSensor object.
1284  * @return The count of part match models in the currently loaded job.
1285  */
1287 
1288 /**
1289  * Returns a handle to a part model based on a given index.
1290  *
1291  * @public @memberof GoSensor
1292  * @version Introduced in firmware 4.2.4.7
1293  * @param sensor GoSensor object.
1294  * @param index The index of the part model to retrieve.
1295  * @return A GoPartModel handle.
1296  */
1298 
1299 /**
1300  * Sets the runtime variables from the provided starting index to the specified length
1301  * with the values contained in the provided array.
1302  *
1303  * @public @memberof GoSensor
1304  * @version Introduced in firmware 4.5.3.57
1305  * @param sensor GoSensor object.
1306  * @param startIndex The starting index of the runtime variable values to set.
1307  * @param length The number of runtime variables to set/the length of the array parameter.
1308  * @param values A reference to an array which contains the intended runtime variable values.
1309  * @return Operation status.
1310  */
1311 GoFx(kStatus) GoSensor_SetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s* values);
1312 
1313 /**
1314  * Returns the number of runtime variables available on the device.
1315  *
1316  * @public @memberof GoSensor
1317  * @version Introduced in firmware 4.5.3.57
1318  * @param sensor GoSensor object.
1319  * @return The runtime variable count of the device.
1320  */
1322 
1323 /**
1324  * Gets the values associated with a given runtime variable starting index and length.
1325  *
1326  * @public @memberof GoSensor
1327  * @version Introduced in firmware 4.5.3.57
1328  * @param sensor GoSensor object.
1329  * @param startIndex The starting index of the runtime variable values to retrieve.
1330  * @param length The number of runtime variables to retrieve.
1331  * @param values A reference to an array which will hold the retrieved runtime variable values.
1332  * @return Operation status.
1333  */
1334 GoFx(kStatus) GoSensor_GetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s* values);
1335 
1336 /**
1337  * Gets the value associated with a given runtime variable index.
1338  *
1339  * @public @memberof GoSensor
1340  * @version Introduced in firmware 4.5.3.57
1341  * @param sensor GoSensor object.
1342  * @param index The index of the runtime variable value to retrieve.
1343  * @param value A reference to be updated with the runtime variable value.
1344  * @return Operation status.
1345  */
1346 GoFx(kStatus) GoSensor_GetRuntimeVariableAt(GoSensor sensor, kSize index, k32s* value);
1347 
1348 /**
1349  * Starts recording to a stream.
1350  *
1351  * NOTE: Before calling this function, the sensor should already be running and
1352  * recording. GoSensor_StopRecordingStream() should be called before executing
1353  * any other sensor commands, with the exception of GoSensor_IsRecordingStreaming().
1354  *
1355  * @public @memberof GoSensor
1356  * @version Introduced in firmware 4.6.4.66
1357  * @param sensor GoSensor object.
1358  * @param destFile A local file path to store the .rec data.
1359  * @return Operation status.
1360  */
1361 GoFx(kStatus) GoSensor_StartRecordingStream(GoSensor sensor, kChar* destFile);
1362 
1363 /**
1364  * Stops recording to a stream.
1365  *
1366  * @public @memberof GoSensor
1367  * @version Introduced in firmware 4.6.4.66
1368  * @param sensor GoSensor object.
1369  * @return Operation status.
1370  */
1372 
1373 /**
1374  * Reports whether or not recording is streaming.
1375  *
1376  * @public @memberof GoSensor
1377  * @version Introduced in firmware 4.6.4.66
1378  * @param sensor GoSensor object.
1379  * @return kTRUE if recording is streaming, kFALSE otherwise.
1380  */
1382 
1383 /**
1384 * Gets the buddy at a given index.
1385 *
1386 * @public @memberof GoSensor
1387 * @version Introduced in firmware 4.6.4.66
1388 * @param sensor GoSensor object.
1389 * @param index index of buddy to retrieve.
1390 * @return Device state.
1391 */
1392 GoFx(GoSensorInfo) GoSensor_BuddiesAt(GoSensor sensor, k32u index);
1393 
1394 /**
1395 * Gets the number of buddies in the sytem.
1396 *
1397 * @public @memberof GoSensor
1398 * @version Introduced in firmware 4.6.4.66
1399 * @param sensor GoSensor object.
1400 * @return Device state.
1401 */
1402 GoFx(kSize) GoSensor_BuddiesCount(GoSensor sensor);
1403 
1404 /**
1405 * returns true if the system has any buddies.
1406 *
1407 * @public @memberof GoSensor
1408 * @version Introduced in firmware 4.6.4.66
1409 * @param sensor GoSensor object.
1410 * @return Device state.
1411 */
1412 GoFx(kBool) GoSensor_HasBuddies(GoSensor sensor);
1413 
1414 /**
1415 * returns the GeoCal object for querying or Null if it does not exist.
1416 *
1417 * @public @memberof GoSensor
1418 * @version Introduced in firmware 4.7.0.130
1419 * @param sensor GoSensor object.
1420 * @param geoCal Output: A reference to be updated with the GoGeoCal object
1421 * @return Status of operation
1422 */
1423 GoFx(kStatus) GoSensor_GeoCal(GoSensor sensor, GoGeoCal *geoCal);
1424 
1425 /**
1426  ** Sets the Data Port.
1427  *
1428  * @public @memberof GoSensor
1429  * @version Introduced in firmware 4.8.2.76
1430  * @param sensor GoSensor object.
1431  * @param port Port number to be used
1432  * @return Status of operation
1433  */
1434 GoFx(kStatus) GoSensor_SetDataPort(GoSensor sensor, k32u port);
1435 
1436 /**
1437  * returns the Data Port.
1438  *
1439  * @public @memberof GoSensor
1440  * @version Introduced in firmware 4.8.2.76
1441  * @param sensor GoSensor object.
1442  * @return Port Number
1443  */
1444 GoFx(k32u) GoSensor_DataPort(GoSensor sensor);
1445 
1446 /**
1447  * Sets the Health Port.
1448  *
1449  * @public @memberof GoSensor
1450  * @version Introduced in firmware 4.8.2.76
1451  * @param sensor GoSensor object.
1452  * @param port Port number to be used
1453  * @return Status of operation
1454  */
1455 GoFx(kStatus) GoSensor_SetHealthPort(GoSensor sensor, k32u port);
1456 
1457 /**
1458  * returns the Health Port.
1459  *
1460  * @public @memberof GoSensor
1461  * @version Introduced in firmware 4.8.2.76
1462  * @param sensor GoSensor object.
1463  * @return Port Number
1464  */
1465 GoFx(k32u) GoSensor_HealthPort(GoSensor sensor);
1466 
1467 /**
1468  ** Sets the Control Port.
1469  *
1470  * @public @memberof GoSensor
1471  * @version Introduced in firmware 4.8.2.76
1472  * @param sensor GoSensor object.
1473  * @param port Port number to be used
1474  * @return Status of operation
1475  */
1476 GoFx(kStatus) GoSensor_SetControlPort(GoSensor sensor, k32u port);
1477 
1478 /**
1479  * returns the Control Port.
1480  *
1481  * @public @memberof GoSensor
1482  * @version Introduced in firmware 4.8.2.76
1483  * @param sensor GoSensor object.
1484  * @return Port Number
1485  */
1486 GoFx(k32u) GoSensor_ControlPort(GoSensor sensor);
1487 
1488 /**
1489  * Sets the Upgrade Port.
1490  *
1491  * @public @memberof GoSensor
1492  * @version Introduced in firmware 4.8.2.76
1493  * @param sensor GoSensor object.
1494  * @param port Port number to be used
1495  * @return Status of operation
1496  */
1497 GoFx(kStatus) GoSensor_SetUpgradePort(GoSensor sensor, k32u port);
1498 
1499 /**
1500  * returns the Upgrade Port.
1501  *
1502  * @public @memberof GoSensor
1503  * @version Introduced in firmware 4.8.2.76
1504  * @param sensor GoSensor object.
1505  * @return Port Number
1506  */
1507 GoFx(k32u) GoSensor_UpgradePort(GoSensor sensor);
1508 
1509 /**
1510 * Waits for all buddies to be connected within a specific timeout.
1511 *
1512 * See \ref detDisconnect for more details.
1513 *
1514 * @public @memberof GoSensor
1515 * @version Introduced in firmware 5.2.18.3
1516 * @param sensor GoSensor object.
1517 * @param timeout a timeout in milliseconds to wait for all required buddies to get connected
1518 * @return Operational status: kOK if all required buddies are connected within specified timeout; otherwise kERROR_TIMEOUT
1519 */
1520 GoFx(kStatus) GoSensor_WaitForBuddies(GoSensor sensor, k64u timeout);
1521 
1522 /**
1523 * Connects and logs into the sensor using the specified user name and password.
1524 * Once security protection is enabled logging in is required in order to programmatically control a sensor.
1525 * This must be used to connect to the sensor instead of anonymous connect method that fails in case security is enabled.
1526 *
1527 * @public @memberof GoSensor
1528 * @version Introduced in firmware 5.2.18.3
1529 * @param sensor GoSensor object.
1530 * @param user User account
1531 * @param password User password
1532 * @return Operational status: kOK if funcions could complete with given login information;
1533 * otherwise GS_ERROR_AUTHENTICATION indicating unauthorized access
1534 */
1535 GoFx(kStatus) GoSensor_ConnectAndLogin(GoSensor sensor, GoUser user, const kChar* password);
1536 
1537 /**
1538 * Sets sensor's security level. This will enabled/disable security protection.
1539 * Only authorized users can change security level that can deny access to specific objects/files to anonymous users
1540 *
1541 * @public @memberof GoSensor
1542 * @version Introduced in firmware 5.2.18.3
1543 * @param sensor GoSensor object.
1544 * @param security new security level
1545 * @return Operational status: kOK if funcions could complete with given login information;
1546 * otherwise GS_ERROR_AUTHENTICATION indicating unauthorized access
1547 */
1549 
1550 /**
1551  * Sets a sensor flag value.
1552  *
1553  * Sensor flags are an advanced feature that gives the user control over some internal
1554  * system parameters and experimental features. These flags are provided only for the
1555  * purposes of experimentation and demonstration, and may be changed or removed from
1556  * one firwmare version to another.
1557  *
1558  * @public @memberof GoSensor
1559  * @version Introduced in firmware 5.2.18.3
1560  * @param sensor GoControl object.
1561  * @param name Name of the flag.
1562  * @param value Value of the flag (in text).
1563  * @return Operation status.
1564  */
1565 GoFx(kStatus) GoSensor_SetFlag(GoSensor sensor, const kChar* name, const kChar* value);
1566 
1567 /**
1568  * Gets a sensor flag value. See GoSensor_SetFlag for more details.
1569  *
1570  * @public @memberof GoSensor
1571  * @version Introduced in firmware 5.2.18.3
1572  * @param sensor GoControl object.
1573  * @param name Name of the flag.
1574  * @param value String object to receive the value (in text).
1575  * @return Operation status.
1576  */
1577 GoFx(kStatus) GoSensor_GetFlag(GoSensor sensor, const kChar* name, kString value);
1578 
1579 /**
1580 * Returns the acceleration state of a sensor. The state can be used by
1581 * acceleration applications to determine if the
1582 * sensor is available for acceleration or is already accelerated by a host.
1583 *
1584 * @public @memberof GoSensor
1585 * @version Introduced in firmware 5.2.18.3
1586 * @param sensor GoSensor object.
1587 * @return Acceleration state.
1588 */
1590 
1591 /**
1592 * Returns the port numbers used by an accelerated sensor, including web port.
1593 * Can be used by acceleration applications to get the ports used by an
1594 * accelerated sensor.
1595 *
1596 * @public @memberof GoSensor
1597 * @version Introduced in firmware 5.2.18.3
1598 * @param sensor GoSensor object.
1599 * @return Port numbers used by sensor.
1600 */
1602 
1603 /**
1604 * Returns the operational mode of the sensor. This can be used by an
1605 * acceleration application to determine if the sensor is a virtual sensor,
1606 * standalone sensor or an accelerated sensor mode.
1607 *
1608 * @public @memberof GoSensor
1609 * @version Introduced in firmware 5.2.18.3
1610 * @param sensor GoSensor object.
1611 * @return Sensor operational mode.
1612 */
1614 
1615 /**
1616 * Returns the physical sensor IP address when sensor is accelerated.
1617 *
1618 * @public @memberof GoSensor
1619 * @version Introduced in firmware 5.2.18.3
1620 * @param sensor GoSensor object.
1621 * @param ipAddress Destination to store the IP Address.
1622 * @return Operational status.
1623 */
1624 GoFx(kStatus) GoSensor_AccelSensorIpAddress(GoSensor sensor, kIpAddress* ipAddress);
1625 
1626 
1627 /**
1628  * Set the current laser state.
1629  * Calling this function will turn the laser on or off.
1630  *
1631  * @public @memberof GoSensor
1632  * @version Introduced in firmware 6.2.26.2
1633  * @param sensor GoSensor object.
1634  * @param enable State of laser to set if enable > 0, reset if enable = 0
1635  * @return Operation status.
1636  */
1637 GoFx(kStatus) GoSensor_SetLaserState(GoSensor sensor, k8u enable);
1638 
1639 /**
1640  * Turns off the sensor. Sensor will not restart until it is powercycled.
1641  *
1642  * @public @memberof GoSensor
1643  * @version Introduced in firmware 6.4.39.2
1644  * @param sensor GoSensor object.
1645  * @return Operation status.
1646  */
1647 GoFx(kStatus) GoSensor_Shutdown(GoSensor sensor);
1648 
1649 /**
1650  * When enabled, the laser line is locked out, preventing scanning.
1651  * This is currently only supported on battery-powered sensors.
1652  *
1653  * @public @memberof GoSensor
1654  * @version Introduced in firmware 6.4.39.2
1655  * @param sensor GoSensor object.
1656  * @param shouldLock Locks out the laser if not 0. Unlocks it if 0.
1657  * @return Operation status.
1658  */
1659 GoFx(kStatus) GoSensor_LockOutLaser(GoSensor sensor, kBool shouldLock);
1660 
1661 /**
1662  * Defines the signature for a sensor heartbeat disconnect callback function.
1663  *
1664  * This callback is invoked when the sensor is detected as disconnected
1665  * via the fast heartbeat mechanism (no heartbeat received within timeout).
1666  *
1667  * @param receiver User-provided context pointer.
1668  * @param sensor GoSensor object that detected the disconnection.
1669  */
1670 typedef void (kCall* GoSensorHeartbeatDisconnectFx)(kPointer receiver, GoSensor sensor);
1671 
1672 /**
1673  * Defines the signature for a sensor heartbeat reconnect callback function.
1674  *
1675  * This callback is invoked when a previously disconnected sensor
1676  * starts sending heartbeats again.
1677  *
1678  * @param receiver User-provided context pointer.
1679  * @param sensor GoSensor object that detected the reconnection.
1680  */
1681 typedef void (kCall* GoSensorHeartbeatReconnectFx)(kPointer receiver, GoSensor sensor);
1682 
1683 /**
1684  * Enables fast heartbeat-based disconnection detection for this sensor.
1685  *
1686  * When enabled, the SDK monitors UDP heartbeat packets from the sensor
1687  * (or accelerator) and can detect disconnection within approximately 100ms,
1688  * significantly faster than the standard health-based detection (~6 seconds).
1689  *
1690  * This function should be called after GoSensor_Connect succeeds.
1691  *
1692  * Heartbeat monitoring is stopped automatically in two cases:
1693  * 1. GoSensor_Disconnect is called (explicit user teardown).
1694  * 2. The discovery layer observes the sensor in an accelerated state
1695  * while heartbeat is enabled via the direct path. The previous
1696  * registration is no longer addressed correctly through the new
1697  * topology, so the SDK disables monitoring; re-enable it after re-
1698  * confirming connectivity through the accelerator path. The auto-
1699  * disable is retried on each discovery cycle until it succeeds (so a
1700  * transient kERROR_BUSY collision with a concurrent user-thread call
1701  * does not leave the stale path in place).
1702  *
1703  * Concurrency:
1704  * At most one enable/disable transition is allowed in flight on a given
1705  * sensor at any time. If a second caller (including a heartbeat callback
1706  * re-entering through GoSensor_Disconnect, or the discovery-thread auto-
1707  * disable) arrives while a transition is mid-flight, the second caller
1708  * receives kERROR_BUSY and must retry after a brief delay. This prevents
1709  * Start/Stop interleaving on the same internal heartbeat object, which
1710  * could otherwise deadlock the in-flight Stop's join.
1711  *
1712  * @public @memberof GoSensor
1713  * @version Introduced in firmware 6.6.4.3
1714  * @param sensor GoSensor object.
1715  * @param enable kTRUE to enable heartbeat monitoring, kFALSE to disable.
1716  * @return Operation status. kERROR_BUSY if another transition
1717  * is currently in flight on this sensor; retry after a
1718  * brief delay.
1719  */
1720 GoFx(kStatus) GoSensor_EnableHeartbeat(GoSensor sensor, kBool enable);
1721 
1722 /**
1723  * Reports whether heartbeat monitoring is enabled for this sensor.
1724  *
1725  * @public @memberof GoSensor
1726  * @version Introduced in firmware 6.6.4.3
1727  * @param sensor GoSensor object.
1728  * @return kTRUE if heartbeat monitoring is enabled, kFALSE otherwise.
1729  */
1731 
1732 /**
1733  * Sets the heartbeat timeout duration.
1734  *
1735  * If no heartbeat is received within this timeout, the sensor is
1736  * considered disconnected and the disconnect callback will be invoked.
1737  * Default is 100ms (100000 microseconds).
1738  *
1739  * This function must be called before enabling heartbeat monitoring.
1740  *
1741  * @public @memberof GoSensor
1742  * @version Introduced in firmware 6.6.4.3
1743  * @param sensor GoSensor object.
1744  * @param timeoutUs Timeout in microseconds.
1745  * @return Operation status.
1746  */
1747 GoFx(kStatus) GoSensor_SetHeartbeatTimeout(GoSensor sensor, k64u timeoutUs);
1748 
1749 /**
1750  * Gets the current heartbeat timeout duration.
1751  *
1752  * @public @memberof GoSensor
1753  * @version Introduced in firmware 6.6.4.3
1754  * @param sensor GoSensor object.
1755  * @return Timeout in microseconds.
1756  */
1758 
1759 /**
1760  * Sets the handler for fast heartbeat-based disconnect detection.
1761  *
1762  * This callback is invoked when the sensor is detected as disconnected
1763  * via the heartbeat mechanism (~100ms detection time).
1764  * The callback is invoked from a background thread.
1765  *
1766  * Note: This is separate from the standard connection state change callback
1767  * (GoSystem_SetDataHandler), which detects disconnection via health messages
1768  * (~6 seconds detection time).
1769  *
1770  * Callback re-entry rules:
1771  * - The callback must not synchronously call GoSystem_* APIs that take the
1772  * GoSystem state lock (e.g. GoSystem_FindSensor, GoSystem_RefreshSensors,
1773  * GoSystem_SensorCount). The discovery thread holds that lock while it
1774  * may be tearing down this same heartbeat in response to a topology
1775  * transition; a synchronous call from the callback can deadlock against
1776  * the in-progress teardown.
1777  * - Calling GoSensor_Disconnect from inside this callback is supported
1778  * (the heartbeat layer's self-call detector handles the re-entry).
1779  * - The recommended pattern is to set a flag here and act on it from your
1780  * application's main thread.
1781  *
1782  * @public @memberof GoSensor
1783  * @version Introduced in firmware 6.6.4.3
1784  * @param sensor GoSensor object.
1785  * @param function Disconnect callback function (or kNULL to unregister).
1786  * @param receiver Receiver argument for callback.
1787  * @return Operation status.
1788  */
1790 
1791 /**
1792  * Sets the handler for heartbeat-based reconnect detection.
1793  *
1794  * This callback is invoked when a previously disconnected sensor
1795  * starts sending heartbeats again.
1796  * The callback is invoked from a background thread.
1797  *
1798  * Callback re-entry rules: see GoSensor_SetHeartbeatDisconnectHandler.
1799  * The same constraints apply here - do not synchronously call GoSystem_*
1800  * APIs from this callback; set a flag and act from your main thread instead.
1801  *
1802  * @public @memberof GoSensor
1803  * @version Introduced in firmware 6.6.4.3
1804  * @param sensor GoSensor object.
1805  * @param function Reconnect callback function (or kNULL to unregister).
1806  * @param receiver Receiver argument for callback.
1807  * @return Operation status.
1808  */
1810 
1811 /**
1812  * Reports whether the sensor is connected according to the heartbeat monitor.
1813  *
1814  * This provides faster detection than the standard GoSensor_IsConnected,
1815  * which relies on health messages.
1816  *
1817  * @public @memberof GoSensor
1818  * @version Introduced in firmware 6.6.4.3
1819  * @param sensor GoSensor object.
1820  * @return kTRUE if heartbeats are being received, kFALSE otherwise.
1821  */
1823 
1824 #include <GoSdk/GoSensor.x.h>
1825 
1826 #endif
GoDiscoveryOpMode GoSensor_AccelOpMode(GoSensor sensor)
Returns the operational mode of the sensor.
kVersion GoSensor_FirmwareVersion(GoSensor sensor)
Gets the sensor's firmware version.
kBool GoSensor_FileExists(GoSensor sensor, const kChar *name)
Checks whether the specified file is present on the sensor.
kStatus GoSensor_RestoreDefaults(GoSensor sensor, kBool restoreAddress)
Restores factory default settings.
GoReplay GoSensor_Replay(GoSensor sensor)
Gets the replay module, used for replay configuration.
kStatus GoSensor_PlaybackPosition(GoSensor sensor, kSize *position, kSize *count)
Gets the current replay frame position.
Sensor state, login, alignment information, recording state, playback source, uptime, playback information, and auto-start setting state.
Definition: GoSdkDef.h:836
kStatus GoSensor_StopRecordingStream(GoSensor sensor)
Stops recording to a stream.
Ports used from a source device.
Definition: GoSdkDef.h:877
Represents a data input source.
Represents read-only sensor information.
Represents a part model configuration.
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.
kStatus GoSensor_SetAlignmentReference(GoSensor sensor, GoAlignmentRef reference)
Sets the alignment reference of the sensor.
kStatus GoSensor_ResetEncoder(GoSensor sensor)
Resets the encoder value.
kStatus GoSensor_SetUpgradePort(GoSensor sensor, k32u port)
Sets the Upgrade Port.
Represents a playback seek direction.
Represents the replay export source type.
k64u GoSensor_UserStorageUsed(GoSensor sensor)
Gets the storage space used for user files.
kStatus(kCall * GoSensorDataSetFx)(kPointer context, GoSensor sensor, GoDataSet dataSet)
Defines the signature for a custom data message handler.
Definition: GoSensor.h:1228
kStatus GoSensor_EnableAutoStart(GoSensor sensor, kBool enable)
Sets the AutoStart enabled state of the sensor.
kStatus GoSensor_ClearReplayData(GoSensor sensor)
Clears the replay buffer.
kStatus GoSensor_WaitForBuddies(GoSensor sensor, k64u timeout)
Waits for all buddies to be connected within a specific timeout.
kBool GoSensor_HeartbeatEnabled(GoSensor sensor)
Reports whether heartbeat monitoring is enabled for this sensor.
kStatus GoSensor_SetControlPort(GoSensor sensor, k32u port)
Sets the Control Port.
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...
kStatus GoSensor_Simulate(GoSensor sensor, kBool *isBufferValid)
Simulates the current frame in the live recording buffer.
kStatus GoSensor_ClearLog(GoSensor sensor)
Clears the log file (_live.log).
Declares the GoGeoCal class.
kStatus GoSensor_Backup(GoSensor sensor, const kChar *destPath)
Creates a backup of sensor files and downloads the backup to the specified location.
kSize GoSensor_FileCount(GoSensor sensor)
Gets the number of files available from the connected sensor.
kStatus GoSensor_Trigger(GoSensor sensor)
Sends a software trigger to the sensor.
kSize GoSensor_BuddiesCount(GoSensor sensor)
Gets the number of buddies in the sytem.
kStatus GoSensor_SetLaserState(GoSensor sensor, k8u enable)
Set the current laser state.
Represents the supported Gocator hardware families.
kStatus GoSensor_SetVoltage(GoSensor sensor, GoVoltageSetting voltage, k64f cableLength)
Set sensor voltage settings (only on G3210)
Represents a user role. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx)
kStatus GoSensor_ConnectAndLogin(GoSensor sensor, GoUser user, const kChar *password)
Connects and logs into the sensor using the specified user name and password.
kStatus GoSensor_GetFlag(GoSensor sensor, const kChar *name, kString value)
Gets a sensor flag value.
GoAlignmentState GoSensor_AlignmentState(GoSensor sensor)
Gets the alignment state of the sensor.
Declares the GoOutput class.
kStatus GoSensor_Refresh(GoSensor sensor)
Refreshes sensor state.
kStatus GoSensor_PartMatchCreateModel(GoSensor sensor, const kChar *name)
Creates a part matching model based on the current part data.
kStatus GoSensor_ClearAlignment(GoSensor sensor)
Clears the current sensor alignment.
kStatus GoSensor_Restore(GoSensor sensor, const kChar *sourcePath)
Restores a backup of sensor files.
Represents a data source.
kBool GoSensor_HeartbeatConnected(GoSensor sensor)
Reports whether the sensor is connected according to the heartbeat monitor.
kStatus GoSensor_PlaybackSeek(GoSensor sensor, kSize position)
Sets the current frame position for a replay.
Represents a replay configuration.
GoPartModel GoSensor_PartMatchModelAt(GoSensor sensor, kSize index)
Returns a handle to a part model based on a given index.
kStatus GoSensor_SetFlag(GoSensor sensor, const kChar *name, const kChar *value)
Sets a sensor flag value.
kStatus GoSensor_Snapshot(GoSensor sensor)
Performs a sensor snapshot.
Represents either 48V or 24V (with cable length) operation. Only relevant on G3210.
Declares the GoDataSet class.
kStatus GoSensor_PlaybackStep(GoSensor sensor, GoSeekDirection direction)
Advances one frame from the current replay position.
kStatus GoSensor_SetHeartbeatReconnectHandler(GoSensor sensor, GoSensorHeartbeatReconnectFx function, kPointer receiver)
Sets the handler for heartbeat-based reconnect detection.
GoSensorAccelState GoSensor_AccelState(GoSensor sensor)
Returns the acceleration state of a sensor.
Declares the GoDiscoveryExtInfo class and related types.
k32u GoSensor_ControlPort(GoSensor sensor)
returns the Control Port.
kStatus GoSensor_EnableHeartbeat(GoSensor sensor, kBool enable)
Enables fast heartbeat-based disconnection detection for this sensor.
Declares the GoSensorInfo class.
kStatus GoSensor_UploadFile(GoSensor sensor, const kChar *sourcePath, const kChar *destName)
Uploads a file to the connected sensor.
Represents an alignment state.
kStatus GoSensor_Address(GoSensor sensor, GoAddressInfo *info)
Retrieves the sensor's network address settings.
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.
kStatus GoSensor_FileNameAt(GoSensor sensor, kSize index, kChar *name, kSize capacity)
Gets the file name at the specified index.
kStatus GoSensor_DownloadFile(GoSensor sensor, const kChar *sourceName, const kChar *destPath)
Downloads a file from the connected sensor.
void(kCall * GoSensorHeartbeatDisconnectFx)(kPointer receiver, GoSensor sensor)
Defines the signature for a sensor heartbeat disconnect callback function.
Definition: GoSensor.h:1670
Represents operational mode of the main controller responding to the discovery protocol.
Represents output configuration.
kStatus GoSensor_DefaultJob(GoSensor sensor, kChar *fileName, kSize capacity)
Gets the name of the default job file to be loaded on boot.
kStatus GoSensor_SetDataHandler(GoSensor sensor, GoSensorDataSetFx function, kPointer context)
Sets the data callback function to be used upon receipt of data.
kStatus GoSensor_AddBuddyBlocking(GoSensor sensor, GoSensor buddy)
Synchronously assigns a buddy sensor.
Essential SDK declarations.
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...
kBool GoSensor_IsCompatible(GoSensor sensor)
Reports whether the connected sensor's protocol version is compatible with the SDK's protocol version...
GoFamily GoSensor_Family(GoSensor sensor)
Returns an enumerator value representing the current sensor's family.
kStatus GoSensor_GetVoltage(GoSensor sensor, GoVoltageSetting *voltage, k64f *cableLength)
Get the sensor voltage settings (only on G3210)
k32u GoSensor_BuddyId(GoSensor sensor)
Gets the buddy sensor's device ID.
kStatus GoSensor_EnableRecording(GoSensor sensor, kBool enable)
Sets the recording state of the sensor.
GoInputSource GoSensor_InputSource(GoSensor sensor)
Gets the input source currently used by the sensor.
GoPartModel GoSensor_PartMatchModel(GoSensor sensor, const kChar *name)
Returns a handle to a part model based on a given name.
kStatus GoSensor_LogIn(GoSensor sensor, GoUser user, const kChar *password)
Logs into the sensor using the specified user name and password.
GoState GoSensor_State(GoSensor sensor)
Reports the current system state of the sensor from cache.
Declares the GoTransform class.
kStatus GoSensor_PartMatchDetectModelEdges(GoSensor sensor, const kChar *name, k16u sensitivity)
Detect the edges of the specified part model.
kBool GoSensor_IsRecordingStreaming(GoSensor sensor)
Reports whether or not recording is streaming.
kStatus GoSensor_ExportCsv(GoSensor sensor, const kChar *dstFileName)
Exports replay data in CSV format.
kStatus GoSensor_GetRuntimeVariableAt(GoSensor sensor, kSize index, k32s *value)
Gets the value associated with a given runtime variable index.
k32u GoSensor_UpgradePort(GoSensor sensor)
returns the Upgrade Port.
kStatus GoSensor_DeleteFile(GoSensor sensor, const kChar *name)
Deletes a file within the connected sensor.
k64u GoSensor_HeartbeatTimeout(GoSensor sensor)
Gets the current heartbeat timeout duration.
Represents a collection of data channel or health channel messages.
k32u GoSensor_DataPort(GoSensor sensor)
returns the Data Port.
kStatus GoSensor_Disconnect(GoSensor sensor)
Disconnects from the sensor.
GoTransform GoSensor_Transform(GoSensor sensor)
Gets the transform module, used for transformation configuration.
Represents a collection of tools.
kStatus GoSensor_ExposureAutoSet(GoSensor sensor, GoRole role)
Perform an exposure auto set.
GoSetup GoSensor_Setup(GoSensor sensor)
Gets the GoSetup instance associated with the sensor.
Declares the GoPartModel and GoPartModelEdge class.
GoTools GoSensor_Tools(GoSensor sensor)
Gets the sensor's tools module, used for measurement configuration.
k32u GoSensor_HealthPort(GoSensor sensor)
returns the Health Port.
kStatus GoSensor_Cancel(GoSensor sensor)
Aborts ongoing sensor communication.
kStatus GoSensor_RemoveBuddy(GoSensor sensor)
Removes the current buddy sensor.
GoMode GoSensor_ScanMode(GoSensor sensor)
Gets the sensor's scan mode.
Represents a user id.
kStatus GoSensor_EmitAnalog(GoSensor sensor, k16u index, k64s target, k32s value)
Schedules an analog output.
kStatus GoSensor_AlignmentReference(GoSensor sensor, GoAlignmentRef *reference)
Gets the alignment reference of the sensor.
kStatus GoSensor_ClearMeasurementStats(GoSensor sensor)
Resets the measurement statistics reported by the health channel.
kStatus GoSensor_EnableQuickEdit(GoSensor sensor, kBool enable)
Sets the quick edit state of the sensor.
Represents an alignment reference.
kStatus GoSensor_Start(GoSensor sensor)
Starts the sensor.
kStatus GoSensor_Shutdown(GoSensor sensor)
Turns off the sensor.
kStatus GoSensor_Align(GoSensor sensor)
Perform alignment using the configured alignment type and target.
GoUser GoSensor_User(GoSensor sensor)
Reports the user account associated with the current user.
kStatus GoSensor_Encoder(GoSensor sensor, k64s *encoder)
Gets the current encoder count from the sensor.
k32u GoSensor_Id(GoSensor sensor)
Gets the device identifier associated with this sensor.
kStatus GoSensor_PartNumber(GoSensor sensor, kChar *partNumber, kSize capacity)
Gets the part number associated with this sensor.
kStatus GoSensor_SetHealthPort(GoSensor sensor, k32u port)
Sets the Health Port.
kBool GoSensor_QuickEditEnabled(GoSensor sensor)
Gets the quick edit state of the sensor.
k64u GoSensor_UserStorageFree(GoSensor sensor)
Gets the available storage space remaining for user files.
kStatus GoSensor_Connect(GoSensor sensor)
Creates a connection to the sensor.
kStatus GoSensor_Flush(GoSensor sensor)
Initiates a sensor configuration, model file, and transformation synchronization if modifications are...
GoOutput GoSensor_Output(GoSensor sensor)
Gets the output module, used for output configuration.
Declares the GoTool classes.
kStatus GoSensor_ModelDisplayName(GoSensor sensor, kChar *modelDisplayName, kSize capacity)
Gets the model display name associated with this sensor.
kStatus GoSensor_CopyFile(GoSensor sensor, const kChar *sourceName, const kChar *destName)
Copies a file within the connected sensor.
kStatus GoSensor_SetSecurityLevel(GoSensor sensor, GoSecurityLevel security)
Sets sensor's security level.
kBool GoSensor_HasBuddy(GoSensor sensor)
Reports whether a buddy had been assigned.
kStatus GoSensor_AccelSensorIpAddress(GoSensor sensor, kIpAddress *ipAddress)
Returns the physical sensor IP address when sensor is accelerated.
Declares the GoSetup class.
kBool GoSensor_AutoStartEnabled(GoSensor sensor)
Gets the AutoStart enabled state currently used by the sensor.
Represents a scan mode.
kStatus GoSensor_Stop(GoSensor sensor)
Stops the sensor.
kStatus GoSensor_SetDefaultJob(GoSensor sensor, const kChar *fileName)
Sets a default job file to be loaded on boot.
kBool GoSensor_HasBuddies(GoSensor sensor)
returns true if the system has any buddies.
kStatus GoSensor_GeoCal(GoSensor sensor, GoGeoCal *geoCal)
returns the GeoCal object for querying or Null if it does not exist.
kSize GoSensor_RemoteInfoCount(GoSensor sensor)
Gets the count of remote sensor information held by the sensor.
Represents a sensor transformation.
kStatus GoSensor_EnableData(GoSensor sensor, kBool enable)
Enables or disables the sensor's data channel.
kStatus GoSensor_SetHeartbeatTimeout(GoSensor sensor, k64u timeoutUs)
Sets the heartbeat timeout duration.
kStatus GoSensor_Upgrade(GoSensor sensor, const kChar *sourcePath, GoUpgradeFx onUpdate, kPointer context)
Upgrades sensor firmware.
kBool GoSensor_IsResponsive(GoSensor sensor)
Reports whether the sensor is currently responsive.
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...
kStatus GoSensor_SetAddress(GoSensor sensor, const GoAddressInfo *info, kBool wait)
Configures a sensor's network address settings.
kStatus GoSensor_StartRecordingStream(GoSensor sensor, kChar *destFile)
Starts recording to a stream.
kStatus GoSensor_GetRuntimeVariables(GoSensor sensor, kSize startIndex, kSize length, k32s *values)
Gets the values associated with a given runtime variable starting index and length.
GoSensorInfo GoSensor_BuddiesAt(GoSensor sensor, k32u index)
Gets the buddy at a given index.
kVersion GoSensor_ProtocolVersion(GoSensor sensor)
Gets the sensor's protocol version.
kStatus GoSensor_Timestamp(GoSensor sensor, k64u *time)
Gets the current time stamp (common among all synchronized sensors).
kStatus GoSensor_States(GoSensor sensor, GoStates *states)
Reports various current states of the sensor associated with the control connection.
kBool GoSensor_RecordingEnabled(GoSensor sensor)
Gets the recording state of the sensor.
kSize GoSensor_GetRuntimeVariableCount(GoSensor sensor)
Returns the number of runtime variables available on the device.
GoSensorInfo GoSensor_RemoteInfoAt(GoSensor sensor, kSize index)
Gets the remote sensor information at the given index.
void(kCall * GoSensorHeartbeatReconnectFx)(kPointer receiver, GoSensor sensor)
Defines the signature for a sensor heartbeat reconnect callback function.
Definition: GoSensor.h:1681
kStatus GoSensor_AddBuddy(GoSensor sensor, GoSensor buddy)
Assigns a buddy sensor.
Contains the GeoCal data for a sensor. Do not read the GeoCal file directly, use this class to parse ...
kStatus GoSensor_SetHeartbeatDisconnectHandler(GoSensor sensor, GoSensorHeartbeatDisconnectFx function, kPointer receiver)
Sets the handler for fast heartbeat-based disconnect detection.
kStatus GoSensor_EmitDigital(GoSensor sensor, k16u index, k64s target, k8u value)
Schedules a digital output.
GoPortInfo GoSensor_AccelPortInfo(GoSensor sensor)
Returns the port numbers used by an accelerated sensor, including web port.
Declares the GoReplay class.
kStatus GoSensor_SetInputSource(GoSensor sensor, GoInputSource source)
Sets the input source of the sensor.
Represents a device configuration.
kStatus GoSensor_LockOutLaser(GoSensor sensor, kBool shouldLock)
When enabled, the laser line is locked out, preventing scanning.
Represents a Gocator sensor.
kBool GoSensor_CanStart(GoSensor sensor)
Checks if the sensor is ready to start, if all assigned buddies are connected.
kStatus GoSensor_Reset(GoSensor sensor, kBool wait)
Reboots the main sensor and any connected buddy sensors.
kStatus GoSensor_ScheduledStart(GoSensor sensor, k64s value)
Starts the sensor at a scheduled value.
kStatus GoSensor_ChangePassword(GoSensor sensor, GoUser user, const kChar *password)
Changes the password associated with the specified user account.
kStatus GoSensor_SetDataPort(GoSensor sensor, k32u port)
Sets the Data Port.
GoRole GoSensor_Role(GoSensor sensor)
Gets the sensor's current role within the system.
Lists all sensor acceleration states that a sensor can be in. When a sensor is being accelerated...
Sensor network address settings.
Definition: GoSdkDef.h:863
Represents the current state of a sensor object.
kSize GoSensor_PartMatchModelCount(GoSensor sensor)
Returns the number of part match models present in the currently loaded job.
kBool GoSensor_IsConnected(GoSensor sensor)
Reports whether the sensor is currently connected.