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