Gocator API

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