Description

Represents a Gocator sensor.

Inherits kObject.

Public Member Functions
kStatus	GoSensor_AddBuddy (GoSensor sensor, GoSensor buddy)
	Assigns a buddy sensor. More...

kStatus	GoSensor_Address (GoSensor sensor, GoAddressInfo *info)
	Retrieves the sensor's network address settings. More...

kStatus	GoSensor_Align (GoSensor sensor)
	Perform alignment using the configured alignment type and target. More...

kStatus	GoSensor_AlignmentReference (GoSensor sensor, GoAlignmentRef *reference)
	Gets the alignment reference of the sensor. More...

GoAlignmentState	GoSensor_AlignmentState (GoSensor sensor)
	Gets the alignment state of the sensor. More...

kBool	GoSensor_AutoStartEnabled (GoSensor sensor)
	Gets the AutoStart enabled state currently used by the sensor. More...

kStatus	GoSensor_Backup (GoSensor sensor, const kChar *destPath)
	Creates a backup of sensor files and downloads the backup to the specified location. More...

GoSensor	GoSensor_Buddy (GoSensor sensor)
	Gets the buddy sensor. More...

k32u	GoSensor_BuddyId (GoSensor sensor)
	Gets the buddy sensor's device ID. More...

kStatus	GoSensor_Cancel (GoSensor sensor)
	Aborts ongoing sensor communication. More...

kStatus	GoSensor_ChangePassword (GoSensor sensor, GoUser user, const kChar *password)
	Changes the password associated with the specified user account. More...

kStatus	GoSensor_ClearLog (GoSensor sensor)
	Clears the log file (_live.log). More...

kStatus	GoSensor_ClearMeasurementStats (GoSensor sensor)
	Resets the measurement statistics reported by the health channel. More...

kStatus	GoSensor_ClearReplayData (GoSensor sensor)
	Clears the replay buffer. More...

kStatus	GoSensor_Connect (GoSensor sensor)
	Creates a connection to the sensor. More...

kStatus	GoSensor_CopyFile (GoSensor sensor, const kChar sourceName, const kChar destName)
	Copies a file within the connected sensor. More...

kStatus	GoSensor_DefaultJob (GoSensor sensor, kChar *fileName, kSize capacity)
	Gets the name of the default job file to be loaded on boot. More...

kStatus	GoSensor_DeleteFile (GoSensor sensor, const kChar *name)
	Deletes a file within the connected sensor. More...

kStatus	GoSensor_Disconnect (GoSensor sensor)
	Disconnects from the sensor. More...

kStatus	GoSensor_DownloadFile (GoSensor sensor, const kChar sourceName, const kChar destPath)
	Downloads a file from the connected sensor. More...

kStatus	GoSensor_EmitAnalog (GoSensor sensor, k16u index, k64s target, k32s value)
	Schedules an analog output. More...

kStatus	GoSensor_EmitDigital (GoSensor sensor, k16u index, k64s target, k8u value)
	Schedules a digital output. More...

kStatus	GoSensor_EnableAutoStart (GoSensor sensor, kBool enable)
	Sets the AutoStart enabled state of the sensor. More...

kStatus	GoSensor_EnableData (GoSensor sensor, kBool enable)
	Enables or disables the sensor's data channel. More...

kStatus	GoSensor_EnableRecording (GoSensor sensor, kBool enable)
	Sets the recording state of the sensor. More...

kStatus	GoSensor_Encoder (GoSensor sensor, k64s *encoder)
	Gets the current encoder count. More...

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. More...

kStatus	GoSensor_ExportCsv (GoSensor sensor, const kChar *dstFileName)
	Exports replay data in CSV format. More...

kStatus	GoSensor_ExposureAutoSet (GoSensor sensor, GoRole role)
	Perform an exposure auto set. More...

GoFamily	GoSensor_Family (GoSensor sensor)
	Returns an enumerator value representing the current sensor's family. More...

kSize	GoSensor_FileCount (GoSensor sensor)
	Gets the number of files available from the connected sensor. More...

kBool	GoSensor_FileExists (GoSensor sensor, const kChar *name)
	Checks whether the specified file is present on the sensor. More...

kStatus	GoSensor_FileNameAt (GoSensor sensor, kSize index, kChar *name, kSize capacity)
	Gets the file name at the specified index. More...

kVersion	GoSensor_FirmwareVersion (GoSensor sensor)
	Gets the sensor's firmware version. More...

kBool	GoSensor_HasBuddy (GoSensor sensor)
	Reports whether a buddy had been assigned. More...

k32u	GoSensor_Id (GoSensor sensor)
	Gets the device identifier associated with this sensor. More...

GoInputSource	GoSensor_InputSource (GoSensor sensor)
	Gets the input source currently used by the sensor. More...

kBool	GoSensor_IsConnected (GoSensor sensor)
	Reports whether the the sensor is currently connected. More...

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. More...

kStatus	GoSensor_LogIn (GoSensor sensor, GoUser user, const kChar *password)
	Logs into the sensor using the specified user name and password. More...

kStatus	GoSensor_Model (GoSensor sensor, kChar *model, kSize capacity)
	Gets the model number associated with this sensor. More...

GoOutput	GoSensor_Output (GoSensor sensor)
	Gets the output module, used for output configuration. More...

kSize	GoSensor_PlaybackFrameCount (GoSensor sensor)
	Gets the current replay frame count. More...

kStatus	GoSensor_PlaybackPosition (GoSensor sensor, kSize position, kSize count)
	Gets the current replay frame position. More...

kStatus	GoSensor_PlaybackSeek (GoSensor sensor, kSize position)
	Sets the current frame position for a replay. More...

kStatus	GoSensor_PlaybackStep (GoSensor sensor, GoSeekDirection direction)
	Advances one frame from the current replay position. More...

kVersion	GoSensor_ProtocolVersion (GoSensor sensor)
	Gets the sensor's protocol version. More...

kBool	GoSensor_RecordingEnabled (GoSensor sensor)
	Gets the recording state of the sensor. More...

kStatus	GoSensor_Refresh (GoSensor sensor)
	Refreshes sensor state. More...

GoSensorInfo	GoSensor_RemoteInfoAt (GoSensor sensor, kSize index)
	Gets the remote sensor information at the given index. More...

kSize	GoSensor_RemoteInfoCount (GoSensor sensor)
	Gets the count of remote sensor information held by the sensor. More...

kStatus	GoSensor_RemoveBuddy (GoSensor sensor)
	Removes the current buddy sensor. More...

kStatus	GoSensor_Reset (GoSensor sensor, kBool wait)
	Reboots the main sensor and any connected buddy sensors. More...

kStatus	GoSensor_Restore (GoSensor sensor, const kChar *sourcePath)
	Restores a backup of sensor files. More...

kStatus	GoSensor_RestoreDefaults (GoSensor sensor, kBool restoreAddress)
	Restores factory default settings. More...

GoRole	GoSensor_Role (GoSensor sensor)
	Gets the sensor's current role within the system. More...

GoMode	GoSensor_ScanMode (GoSensor sensor)
	Gets the sensor's scan mode. More...

kStatus	GoSensor_SetAddress (GoSensor sensor, const GoAddressInfo *info, kBool wait)
	Configures a sensor's network address settings. More...

kStatus	GoSensor_SetAlignmentReference (GoSensor sensor, GoAlignmentRef reference)
	Sets the alignment reference of the sensor. More...

kStatus	GoSensor_SetDefaultJob (GoSensor sensor, const kChar *fileName)
	Sets a default job file to be loaded on boot. More...

kStatus	GoSensor_SetInputSource (GoSensor sensor, GoInputSource source)
	Sets the input source of the sensor. More...

GoSetup	GoSensor_Setup (GoSensor sensor)
	Gets the GoSetup instance associated with the sensor. More...

kStatus	GoSensor_Simulate (GoSensor sensor, kBool *isBufferValid)
	Simulates the current frame in the live recording buffer. More...

kStatus	GoSensor_Start (GoSensor sensor)
	Starts the sensor. More...

GoState	GoSensor_State (GoSensor sensor)
	Reports the current state of the sensor. More...

kStatus	GoSensor_States (GoSensor sensor, GoStates *states)
	Reports the current states of the sensor. More...

kStatus	GoSensor_Stop (GoSensor sensor)
	Stops the sensor. More...

kStatus	GoSensor_Timestamp (GoSensor sensor, k64u *time)
	Gets the current time stamp (common among all synchronized sensors). More...

GoTools	GoSensor_Tools (GoSensor sensor)
	Gets the sensor's tools module, used for measurement configuration. More...

GoTransform	GoSensor_Transform (GoSensor sensor)
	Gets the transform module, used for transformation configuration. More...

kStatus	GoSensor_Trigger (GoSensor sensor)
	Sends a software trigger to the sensor. More...

kStatus	GoSensor_Upgrade (GoSensor sensor, const kChar *sourcePath, GoUpgradeFx onUpdate, kPointer context)
	Upgrades sensor firmware. More...

kStatus	GoSensor_UploadFile (GoSensor sensor, const kChar sourcePath, const kChar destName)
	Uploads a file to the connected sensor. More...

GoUser	GoSensor_User (GoSensor sensor)
	Reports the user account associated with the current user. More...

Member Function Documentation

kStatus GoSensor_AddBuddy	(	GoSensor	sensor,
		GoSensor	buddy
	)

Assigns a buddy sensor.

NOTE: The provided buddy sensor handle must already be connected.

Parameters

sensor	GoSensor object.
buddy	Sensor to be assigned as buddy.

Returns: Operation status.

See also: GoSensor_Connect

kStatus GoSensor_Address	(	GoSensor	sensor,
		GoAddressInfo *	info
	)

Retrieves the sensor's network address settings.

Parameters

sensor	GoSensor object.
info	Receives current address configuration.

Returns: Operation status.

kStatus GoSensor_Align ( GoSensor sensor )

Perform alignment using the configured alignment type and target.

NOTE: This operation will result in a sensor start for the duration of the alignment. It can be canceled via GoSensor_Stop. This function's operation status does not correspond to the actual alignment result. In order to retrieve the alignment result, you must enable the data channel before calling this function, receive an alignment data message and then check its status.

Parameters

sensor GoSensor object.

Returns: Operation status.

See also: GoSensor_EnableData, GoSystem_ReceiveData, GoSetup_AlignmentType, GoSetup_AlignmentMovingTarget, GoSetup_AlignmentStationaryTarget, GoAlignMsg_Status, GoSensor_Stop

kStatus GoSensor_AlignmentReference	(	GoSensor	sensor,
		GoAlignmentRef *	reference
	)

Gets the alignment reference of the sensor.

Parameters

sensor	GoSensor object.
reference	A pointer that will hold the current alignment reference value.

Returns: Operation status.

GoAlignmentState GoSensor_AlignmentState ( GoSensor sensor )

Gets the alignment state of the sensor.

Parameters

sensor GoSensor object.

Returns: A GoAlignmentState.

kBool GoSensor_AutoStartEnabled ( GoSensor sensor )

Gets the AutoStart enabled state currently used by the sensor.

Parameters

sensor GoSensor object.

Returns: kTRUE if auto start is enabled and kFALSE otherwise.

kStatus GoSensor_Backup	(	GoSensor	sensor,
		const kChar *	destPath
	)

Creates a backup of sensor files and downloads the backup to the specified location.

Parameters

sensor	GoSensor object.
destPath	Local file system path for the saved backup file.

Returns: Operation status.

GoSensor GoSensor_Buddy ( GoSensor sensor )

Gets the buddy sensor.

Parameters

sensor GoSensor object.

Returns: Buddy sensor (or kNULL if not assigned or not online).

k32u GoSensor_BuddyId ( GoSensor sensor )

Gets the buddy sensor's device ID.

Parameters

sensor GoSensor object.

Returns: Buddy device ID (or k32U_NULL if not assigned).

kStatus GoSensor_Cancel ( GoSensor sensor )

Aborts ongoing sensor communication.

This method asynchronously aborts ongoing communication; the next time that any I/O operation blocks for an extended period of time, it will be terminated. This method is thread-safe.

In order to resume communication, call GoSensor_Refresh or GoSensor_Connect.

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_ChangePassword	(	GoSensor	sensor,
		GoUser	user,
		const kChar *	password
	)

Changes the password associated with the specified user account.

Parameters

sensor	GoSensor object.
user	User account.
password	New password.

Returns: Operation status.

kStatus GoSensor_ClearLog ( GoSensor sensor )

Clears the log file (_live.log).

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_ClearMeasurementStats ( GoSensor sensor )

Resets the measurement statistics reported by the health channel.

Parameters

sensor GoSensor object.

Returns: A GoAlignmentState.

kStatus GoSensor_ClearReplayData ( GoSensor sensor )

Clears the replay buffer.

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_Connect ( GoSensor sensor )

Creates a connection to the sensor.

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_CopyFile	(	GoSensor	sensor,
		const kChar *	sourceName,
		const kChar *	destName
	)

Copies a file within the connected sensor.

Parameters

sensor	GoSensor object.
sourceName	Source name for the file to be copied.
destName	Destination name for the file (maximum 63 characters).

Returns: Operation status.

kStatus GoSensor_DefaultJob	(	GoSensor	sensor,
		kChar *	fileName,
		kSize	capacity
	)

Gets the name of the default job file to be loaded on boot.

Parameters

sensor	GoSensor object.
fileName	Receives name of the default file.
capacity	Name buffer capacity.

Returns: Operation status.

kStatus GoSensor_DeleteFile	(	GoSensor	sensor,
		const kChar *	name
	)

Deletes a file within the connected sensor.

Parameters

sensor	GoSensor object.
name	Name of the file to be deleted.

Returns: Operation status.

kStatus GoSensor_Disconnect ( GoSensor sensor )

Disconnects from the sensor.

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_DownloadFile	(	GoSensor	sensor,
		const kChar *	sourceName,
		const kChar *	destPath
	)

Downloads a file from the connected sensor.

Parameters

sensor	GoSensor object.
sourceName	Source name of the file to be downloaded.
destPath	Destination file system path for the file to be downloaded.

Returns: Operation status.

kStatus GoSensor_EmitAnalog	(	GoSensor	sensor,
		k16u	index,
		k64s	target,
		k32s	value
	)

Schedules an analog output.

This method requires that the output be configured to trigger on software control.

Parameters

sensor	GoSensor object.
index	The analog output index.
target	The time or position target (us or mm), depending on GoDomain. Ignored if GoAnalog_ScheduleEnabled is false.
value	The value of the scheduled output (mA).

Returns: Operation status.

kStatus GoSensor_EmitDigital	(	GoSensor	sensor,
		k16u	index,
		k64s	target,
		k8u	value
	)

Schedules a digital output.

This method requires that the output is configured to trigger on software control.

Parameters

sensor	GoSensor object.
index	The digital output index.
target	The time or position target (us or mm), depending on GoDomain. Ignored if GoDigital_ScheduleEnabled is false or GoDigital_SignalType is pulsed.
value	The value of scheduled output (0-Low or 1-High). Ignored if output GoDigital_SignalType is pulsed.

Returns: Operation status.

kStatus GoSensor_EnableAutoStart	(	GoSensor	sensor,
		kBool	enable
	)

Sets the AutoStart enabled state of the sensor.

Parameters

sensor	GoSensor object.
enable	The AutoStart enabled state to use.

Returns: Operation status.

kStatus GoSensor_EnableData	(	GoSensor	sensor,
		kBool	enable
	)

Enables or disables the sensor's data channel.

Parameters

sensor	GoSensor object.
enable	kTRUE to enable, or kFALSE to disable.

Returns: Operation status.

kStatus GoSensor_EnableRecording	(	GoSensor	sensor,
		kBool	enable
	)

Sets the recording state of the sensor.

Parameters

sensor	GoSensor object.
enable	Enables or disables recording.

Returns: Operation status.

kStatus GoSensor_Encoder	(	GoSensor	sensor,
		k64s *	encoder
	)

Gets the current encoder count.

Parameters

sensor	GoSensor object.
encoder	Receives the encoder count (ticks).

Returns: Operation status.

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.

Parameters

sensor	GoSensor object.
type	The type of data to export.
source	The device data source to export from.
dstFileName	The destination file name of the exported bitmap file.

Returns: Operation status.

kStatus GoSensor_ExportCsv	(	GoSensor	sensor,
		const kChar *	dstFileName
	)

Exports replay data in CSV format.

Parameters

sensor	GoSensor object.
dstFileName	The destination file name of the exported CSV file.

Returns: Operation status.

kStatus GoSensor_ExposureAutoSet	(	GoSensor	sensor,
		GoRole	role
	)

Perform an exposure auto set.

NOTE: This operation will result in a sensor start for the duration of the exposure AutoSet. A successful operation status does NOT modify the configuration. You must retrieve the resulting exposure value and set it for the appropriate exposure setting. This involves enabling the data connection prior to running exposure auto set and then receiving an exposure auto set message, which you can then use to query the status and access the resulting value.

Parameters

sensor	GoSensor object.
role	The role of the device to auto set.

Returns: Operation status.

See also: GoRole, GoSensor_EnableData, GoSystem_ReceiveData, GoExposureCalMsg_Status, GoExposureCalMsg_Exposure

GoFamily GoSensor_Family ( GoSensor sensor )

Returns an enumerator value representing the current sensor's family.

Parameters

sensor GoSensor object.

Returns: A GoFamily value.

kSize GoSensor_FileCount ( GoSensor sensor )

Gets the number of files available from the connected sensor.

Parameters

sensor GoSensor object.

Returns: File count.

kBool GoSensor_FileExists	(	GoSensor	sensor,
		const kChar *	name
	)

Checks whether the specified file is present on the sensor.

Parameters

sensor	GoSensor object.
name	Name of the file to be checked.

Returns: Operation status.

kStatus GoSensor_FileNameAt	(	GoSensor	sensor,
		kSize	index,
		kChar *	name,
		kSize	capacity
	)

Gets the file name at the specified index.

Parameters

sensor	GoSensor object.
index	Index of the desired file name.
name	Receives the name of the file.
capacity	Capacity of the file name buffer.

Returns: Operation status.

kVersion GoSensor_FirmwareVersion ( GoSensor sensor )

Gets the sensor's firmware version.

Parameters

sensor GoSensor object.

Returns: Firmware version.

kBool GoSensor_HasBuddy ( GoSensor sensor )

Reports whether a buddy had been assigned.

Parameters

sensor GoSensor object.

Returns: kTRUE if sensor has a buddy; kFALSE otherwise.

k32u GoSensor_Id ( GoSensor sensor )

Gets the device identifier associated with this sensor.

Parameters

sensor GoSensor object.

Returns: The sensor's device ID.

GoInputSource GoSensor_InputSource ( GoSensor sensor )

Gets the input source currently used by the sensor.

Parameters

sensor GoSensor object.

Returns: A GoInputSource.

kBool GoSensor_IsConnected ( GoSensor sensor )

Reports whether the the sensor is currently connected.

Parameters

sensor GoSensor object.

Returns: kTRUE if the sensor is connected; kFALSE otherwise.

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.

Parameters

sensor	GoSensor object.
fileName	Receives name of the loaded file.
capacity	Name buffer capacity.
changed	Receives the status of whether the file has changed.

Returns: Operation status.

kStatus GoSensor_LogIn	(	GoSensor	sensor,
		GoUser	user,
		const kChar *	password
	)

Logs into the sensor using the specified user name and password.

Logging in is not required in order to programmatically control a sensor. The Gocator log-in feature is intended only to support administrative user interfaces, by allowing the username and password to be stored in the sensor.

Parameters

sensor	GoSensor object.
user	User account.
password	User password.

Returns: Operation status.

kStatus GoSensor_Model	(	GoSensor	sensor,
		kChar *	model,
		kSize	capacity
	)

Gets the model number associated with this sensor.

Parameters

sensor	GoSensor object.
model	Receives sensor model.
capacity	Capacity of model buffer.

Returns: Model number.

GoOutput GoSensor_Output ( GoSensor sensor )

Gets the output module, used for output configuration.

Parameters

sensor GoSensor object.

Returns: Output configuration module.

kSize GoSensor_PlaybackFrameCount ( GoSensor sensor )

Gets the current replay frame count.

Parameters

sensor GoSensor object.

Returns: The current frame count.

kStatus GoSensor_PlaybackPosition	(	GoSensor	sensor,
		kSize *	position,
		kSize *	count
	)

Gets the current replay frame position.

Parameters

sensor	GoSensor object.
position	The current frame position index.
count	The frame count.

Returns: Operation status.

kStatus GoSensor_PlaybackSeek	(	GoSensor	sensor,
		kSize	position
	)

Sets the current frame position for a replay.

Parameters

sensor	GoSensor object.
position	The frame position to seek.

Returns: Operation status.

kStatus GoSensor_PlaybackStep	(	GoSensor	sensor,
		GoSeekDirection	direction
	)

Advances one frame from the current replay position.

Parameters

sensor	GoSensor object.
direction	Direction with which to step.

Returns: Operation status.

kVersion GoSensor_ProtocolVersion ( GoSensor sensor )

Gets the sensor's protocol version.

Parameters

sensor GoSensor object.

Returns: Protocol version.

kBool GoSensor_RecordingEnabled ( GoSensor sensor )

Gets the recording state of the sensor.

Parameters

sensor GoSensor object.

Returns: kTRUE if recording is enabled. kFALSE otherwise.

kStatus GoSensor_Refresh ( GoSensor sensor )

Refreshes sensor state.

Unresponsive sensors will be disconnected, and canceled sensors will be reconnected. Sensors in any other state will discard all locally-cached information.

This function should be used to update sensors in the GO_SENSOR_INCONSISTENT state. This state can arise due to buddy changes performed by remote sensors (e.g. a main sensor boots and claims ownership of a buddy sensor, but the buddy sensor has already been detected and loaded as a main sensor by the client).

Parameters

sensor GoSensor object.

Returns: kTRUE if the sensor is connected; kFALSE otherwise.

GoSensorInfo GoSensor_RemoteInfoAt	(	GoSensor	sensor,
		kSize	index
	)

Gets the remote sensor information at the given index.

Parameters

sensor	GoSensor object.
index	The index of the remote sensor information to retrieve.

Returns: A handle to the selected remote sensor information or kNULL if an invalid index is provided.

kSize GoSensor_RemoteInfoCount ( GoSensor sensor )

Gets the count of remote sensor information held by the sensor.

Parameters

sensor GoSensor object.

Returns: The remote sensor information count.

kStatus GoSensor_RemoveBuddy ( GoSensor sensor )

Removes the current buddy sensor.

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_Reset	(	GoSensor	sensor,
		kBool	wait
	)

Reboots the main sensor and any connected buddy sensors.

Parameters

sensor	GoSensor object.
wait	kTRUE to wait for reboot and then reconnect.

Returns: Operation status.

kStatus GoSensor_Restore	(	GoSensor	sensor,
		const kChar *	sourcePath
	)

Restores a backup of sensor files.

Parameters

sensor	GoSensor object.
sourcePath	Local file system path of the saved backup file.

Returns: Operation status.

kStatus GoSensor_RestoreDefaults	(	GoSensor	sensor,
		kBool	restoreAddress
	)

Restores factory default settings.

Parameters

sensor	GoSensor object.
restoreAddress	kTRUE to restore the factory default IP address; False otherwise.

Returns: Operation status.

GoRole GoSensor_Role ( GoSensor sensor )

Gets the sensor's current role within the system.

Parameters

sensor GoSensor object.

Returns: Sensor role.

GoMode GoSensor_ScanMode ( GoSensor sensor )

Gets the sensor's scan mode.

Parameters

sensor GoSensor object.

Returns: Scan mode.

kStatus GoSensor_SetAddress	(	GoSensor	sensor,
		const GoAddressInfo *	info,
		kBool	wait
	)

Configures a sensor's network address settings.

This function uses UDP broadcasts for sensor configuration; the sensor does not need to be connected, and can be on a different subnet than the client.

The sensor will automatically reboot if the address is successfully changed.

Parameters

sensor	GoSensor object.
info	New address settings.
wait	Should this function block until the sensor finishes rebooting?

Returns: Operation status.

kStatus GoSensor_SetAlignmentReference	(	GoSensor	sensor,
		GoAlignmentRef	reference
	)

Sets the alignment reference of the sensor.

Parameters

sensor	GoSensor object.
reference	The alignment reference value to set.

Returns: Operation status.

kStatus GoSensor_SetDefaultJob	(	GoSensor	sensor,
		const kChar *	fileName
	)

Sets a default job file to be loaded on boot.

Parameters

sensor	GoSensor object.
fileName	Name of the default file.

Returns: Operation status.

kStatus GoSensor_SetInputSource	(	GoSensor	sensor,
		GoInputSource	source
	)

Sets the input source of the sensor.

Parameters

sensor	GoSensor object.
source	The input source to use.

Returns: Operation status.

GoSetup GoSensor_Setup ( GoSensor sensor )

Gets the GoSetup instance associated with the sensor.

Parameters

sensor GoSensor object.

Returns: A GoSetup object module

kStatus GoSensor_Simulate	(	GoSensor	sensor,
		kBool *	isBufferValid
	)

Simulates the current frame in the live recording buffer.

Parameters

sensor	GoSensor object.
isBufferValid	kTRUE if the source simulation buffer was valid. kFALSE otherwise.

Returns: Operation status.

kStatus GoSensor_Start ( GoSensor sensor )

Starts the sensor.

Parameters

sensor GoSensor object.

Returns: Operation status.

GoState GoSensor_State ( GoSensor sensor )

Reports the current state of the sensor.

Parameters

sensor GoSensor object.

Returns: Sensor state.

kStatus GoSensor_States	(	GoSensor	sensor,
		GoStates *	states
	)

Reports the current states of the sensor.

Parameters

sensor	GoSensor object.
states	Reference to updated states.

Returns: Operation status.

kStatus GoSensor_Stop ( GoSensor sensor )

Stops the sensor.

Parameters

sensor GoSensor object.

Returns: Operation status.

kStatus GoSensor_Timestamp	(	GoSensor	sensor,
		k64u *	time
	)

Gets the current time stamp (common among all synchronized sensors).

Parameters

sensor	GoSensor object.
time	Receives the current time stamp(us).

Returns: Operation status.

GoTools GoSensor_Tools ( GoSensor sensor )

Gets the sensor's tools module, used for measurement configuration.

Parameters

sensor GoSensor object.

Returns: Measurement configuration module.

GoTransform GoSensor_Transform ( GoSensor sensor )

Gets the transform module, used for transformation configuration.

Parameters

sensor GoSensor object.

Returns: Transformation configuration module.

kStatus GoSensor_Trigger ( GoSensor sensor )

Sends a software trigger to the sensor.

This method is used in conjunction with sensors that are configured to accept software triggers.

Parameters

sensor GoSensor object.

Returns: Operation status.

See also: GoSetup_TriggerSource, GoSetup_SetTriggerSource

kStatus GoSensor_Upgrade	(	GoSensor	sensor,
		const kChar *	sourcePath,
		GoUpgradeFx	onUpdate,
		kPointer	context
	)

Upgrades sensor firmware.

This function will block until the upgrade is completed. A reboot is required in order for the upgrade to take effect, but the reboot is not automatic. Call GoSensor_Reset to reboot.

Parameters

sensor	GoSensor object.
sourcePath	Local file system path to the upgrade file.
onUpdate	Callback function to receive progress updates, or kNULL.
context	Context handle to be passed to the upgrade callback.

Returns: Operation status.

kStatus GoSensor_UploadFile	(	GoSensor	sensor,
		const kChar *	sourcePath,
		const kChar *	destName
	)

Uploads a file to the connected sensor.

Parameters

sensor	GoSensor object.
sourcePath	Source file system path for the file to be uploaded.
destName	Destination name for the uploaded file (maximum 63 characters).

Returns: Operation status.

GoUser GoSensor_User ( GoSensor sensor )

Reports the user account associated with the current user.

Parameters

sensor GoSensor object.

Returns: User account id.

The documentation for this class was generated from the following file:

GoSensor.h

Description

Public Member Functions

Member Function Documentation