Gocator API > Go2 > Classes > Go2System > Functions

Gocator 1x00 API | Contents | Reference |

Functions
Functions Legend
Functions

Function | Description
Go2System_AlignmentTarget | Gets the target type used for alignment calibration.
Go2System_Backup | Creates a backup of sensor files and downloads the backup to the specified location.
Go2System_BarHeight | Gets the height of the bar used for travel calibration.
Go2System_BarWidth | Gets the width of the bar used for travel calibration.
Go2System_BuddyReversed | Gets the configured mounting orientation of the Buddy.
Go2System_BuddySensor | Gets the buddy sensor.
Go2System_CalibratedHeight | Gets the system's active area height in system coordinates (post-calibration).
Go2System_CalibratedZ | Gets the system's active area z-origin in system coordinates (post-calibration).
Go2System_CalibrationSource | Gets the system's current calibration data source/destination.
Go2System_CalibrationState | Gets the current calibration state of the sensor system.
Go2System_ChangePassword | Changes the password associated with the specified user account.
Go2System_Changes | Reports any changes requiring a client refresh.
Go2System_ClearCalibration | Clears the existing calibration setting the Go2CalibrationState to NONE
Go2System_ClearMeasurementStats | Resets the measurement statistic values as returned by the health channel.
Go2System_Connect | Connects to a sensor.
Go2System_ConnectData | Connects to the sensor's data channel, to receive data messages.
Go2System_ConnectHealth | Connects to the sensor's health channel, to receive health messages.
Go2System_ConnectionType | Reports the type of sensor connection (custom, master, etc.).
Go2System_Construct | Constructs a Go2System object.
Go2System_CopyFile | Copies a file within the connected sensor.
Go2System_CustomElement | Gets the XML document representing the custom configuration block within the Setup block for the Gocator Base Library.
Go2System_DefaultFile | Gets the name of the default configuration or template file to be loaded on boot.
Go2System_DefaultMode | Gets the default operation mode of the sensor system.
Go2System_DefaultState | Gets the default state of the sensor system upon boot.
Go2System_DeleteFile | Deletes a file within the connected sensor.
Go2System_Destroy | Destroys a Go2System object.
Go2System_Disconnect | Logs out and disconnects from a sensor.
Go2System_DisconnectData | Disconnects the sensor's data channel.
Go2System_DisconnectHealth | Disconnects the sensor's health channel.
Go2System_Discover | Locates sensors and reports their network address settings.
Go2System_DownloadFile | Downloads a file from the connected sensor.
Go2System_EnableFullFrameRate | Enables or disables operation at full frame rate (ignoring frame rate setting).
Go2System_EnableIntensity | Enables profile intensity collection.
Go2System_EnableOverlap | Enables overlap feature to prevent profile interference.
Go2System_EnableTemperatureSafety | Enables temperature safety feature to protect the sensor from over-temperature conditions.
Go2System_EnableTriggerGate | Enables trigger gate feature to prevent encoder or time triggering when the external input is asserted.
Go2System_EncoderPeriod | Gets the current encoder period for encoder-based triggering.
Go2System_EncoderPeriodMax | Constraint for the maximum valid value of the EncoderPeriod setting.
Go2System_EncoderPeriodMin | Constraint for the minimum valid value of the EncoderPeriod setting.
Go2System_EncoderPeriodMinSource | Gets the source for what is currently constraining the minimum encoder period.
Go2System_EncoderTriggerMode | Gets the encoder trigger mode.
Go2System_FileCount | Gets the number of files available from the connected sensor.
Go2System_FileNameAt | Gets the file name at the specified index.
Go2System_FindSensor | Gets the sensor with the specified device identifier.
Go2System_FrameRate | Reports the maximum frame rate, based on current settings.
Go2System_FrameRateMax | Constraint for the maximum valid value of the Frame Rate setting.
Go2System_FrameRateMaxSource | Gets the source for what is currently constraining the maximum frame rate.
Go2System_FrameRateMin | Constraint for the minimum valid value of the Frame Rate setting.
Go2System_FullFrameRateEnabled | Reports whether or not system is configured to operate at full frame rate.
Go2System_GetAddress | Locates a Gocator sensor by id (serial number) and reports its network address settings.
Go2System_GetEncoder | Gets the current encoder count.
Go2System_GetStates | Gets a set of system states.
Go2System_GetTime | Gets the current system time.
Go2System_IntensityEnabled | Reports whether the profile intensity collection is enabled.
Go2System_IsAuthenticated | Determines if the sensor is in an authenticated state. There can only be a single authenticated connection to the system at a time. This does not return the authentication state of this connection.
Go2System_IsConnected | Reports whether the client is currently connected to a sensor.
Go2System_LoadedFile | Gets the name of the loaded configuration or template file and whether it has been modified since loading
Go2System_LocalProtocol | Gets the most recent version of Gocator protocol that is supported by the client.
Go2System_Login | Logs into the system. Requires that a connection is already established. This is an optional mechanism for ensuring this connection is exclusive of any other connection. There can only be a single connection logged in at a time, so any existing logged in connections will be disconnected.
Go2System_Logout | Logs out of the system. This releases the exclusivity of this connection and allows another connection to log in without affecting this one.
Go2System_MainSensor | Gets the main sensor.
Go2System_Mode | Gets the selected operation mode of the sensor system.
Go2System_Orientation | Gets the sensor orientation type for the system.
Go2System_Output | Gets the output module, used for output configuration.
Go2System_OverlapEnabled | Reports whether the overlap feature is currently enabled.
Go2System_Range | Gets the range module, used for range measurement configuration.
Go2System_ReceiveData | Waits to receive a data message from the sensor's data channel.
Go2System_ReceiveHealth | Waits to receive a health message from the sensor's health channel.
Go2System_Reconnect | Waits to connect with a sensor that might currently be powering up or resetting.
Go2System_Refresh | Refresh the Go2System object to match the state of the sensor system.
Go2System_RemoteProtocol | Gets the most recent version of Gocator protocol that is supported by the sensor system.
Go2System_Reset | Reboots the main sensor and any connected buddy sensors.
Go2System_Restore | Restores a backup of sensor files.
Go2System_RestoreDefaults | Restores factory default settings
Go2System_ScheduleAnalogOutput | Schedules an analog output. Requires that the output be configured to trigger on software control
Go2System_ScheduleDigitalOutput | Schedules a digital output. Requires that the output be configured to trigger on software control
Go2System_ScheduledStart | Schedules the system to start at the specified time or location. Uses the trigger mode of the system to determine which target to use, defaulting to time for randomly occuring trigger types. This command changes the state of the sensor to running immediately, but the system doesn't actually begin until the target is met.
Go2System_SensorAt | Gets the sensor at the specified index.
Go2System_SensorCount | Gets the number of sensors in the system.
Go2System_SetAddress | Locates a Gocator sensor by id (serial number) and configures its network address settings.
Go2System_SetAlignmentTarget | Sets the target type used for alignment calibration.
Go2System_SetBarHeight | Sets the height of the bar used for travel calibration.
Go2System_SetBarWidth | Sets the width of the bar used for travel calibration.
Go2System_SetBuddyReversed | Sets the buddy reversed option which informs the system of the mounting orientation of the Buddy.
Go2System_SetCalibrationSource | Sets the system's current calibration data source/destination.
Go2System_SetConnectionType | Sets the type of sensor connection (custom, master, etc.).
Go2System_SetCustomMode | Sets the selected custom operation mode of the sensor system.
Go2System_SetDefaultFile | Sets a default configuration or template file to be loaded on boot.
Go2System_SetDefaultMode | Sets the default operation mode of the sensor system.
Go2System_SetDefaultState | Sets the default state of the sensor system upon boot.
Go2System_SetEncoderPeriod | Sets the current encoder period for encoder-based triggering.
Go2System_SetEncoderTriggerMode | Sets the encoder trigger mode.
Go2System_SetFrameRate | Sets the current frame rate for time-based triggering. Note, calling this function also implicitly disables the FullFrameRate option.
Go2System_SetMode | Sets the selected operation mode of the sensor system.
Go2System_SetOrientation | Sets the sensor orientation type for the system.
Go2System_SetSystemDomain | Sets the system domain (referred to as 'System units' or 'units' in the GUI). Ignored if Go2System_TriggerSource is time or encoder
Go2System_SetTravelResolution | Sets the travel (encoder) resolution.
Go2System_SetTravelSpeed | Sets the travel speed. Used in time based systems to convert time into units of distance.
Go2System_SetTravelTarget | Sets the target type used for travel calibration.
Go2System_SetTriggerDelay | Sets the trigger delay. Depending on Go2System_SystemDomain, units are uS or mm.
Go2System_SetTriggerSource | Sets the trigger source for profile triggering.
Go2System_Start | Starts the sensor system.
Go2System_Stop | Stops the sensor system.
Go2System_SystemDomain | Gets the system domain (referred to as 'System units' or 'units' in the GUI). Not valid if the Go2System_TriggerSource is time or encoder
Go2System_SystemState | Reports the current state of the sensor system.
Go2System_TemperatureSafetyEnabled | Reports whether the temperature safety feature is currently enabled.
Go2System_TemperatureSafetyValid | Reports whether the temperature safety feature is valid for this sensor.
Go2System_TravelResolution | Reports the current travel (encoder) resolution.
Go2System_TravelSpeed | Reports the configured travel speed. This is not a measurement of the current speed it is a way of converting into units of travel distance (like encoder resolution)
Go2System_TravelTarget | Gets the target type used for travel calibration.
Go2System_Trigger | Sends a software trigger to the connected sensor.
Go2System_TriggerDelay | Gets the trigger delay. Depending on Go2System_SystemDomain, units are uS or mm.
Go2System_TriggerDelayMax | Reports the maximum trigger delay, based on current settings. Depending on Go2System_SystemDomain, units are uS or mm.
Go2System_TriggerDelayMin | Reports the minimum trigger delay, based on current settings. Depending on Go2System_SystemDomain, units are uS or mm.
Go2System_TriggerGateEnabled | Reports whether the trigger gate feature is currently enabled.
Go2System_TriggerSource | Gets the trigger source for profile triggering.
Go2System_Upgrade | Upgrades system firmware.
Go2System_UploadFile | Uploads a file to the connected sensor.
Go2System_User | Reports user account associated with the current user.

Copyright (c) 2013 by LMI Technologies Inc. All rights reserved.
Contents | Reference