WIN32 API Overview - intrepidcs API

 Basic Operations

Name Description
FindNeoDevices Used to locate connected neoVI devices.
OpenNeoDevice Used to open a communication link with a specific neoVI device.
ClosePort Closes the communication link with the neoVI device.
FreeObject Releases system resources used by the neoVI device.


Message Functions

Name Description
GetMessages Reads messages from the neoVI device.
TxMessages Transmits messages to vehicle networks using a neoVI device.
WaitForRxMessagesWithTimeOut Waits a specified amount of time in milliseconds for a received message
GetTimeStampForMsg Calculates and returns the timestamp for a message
EnableNetworkRXQueue Enables and disables the receive queue for network messages
GetISO15765Status Gets and clears the current status of the CAN ISO15765-2 network layer receive.
SetISO15765RxParameters Sets parameters for CAN ISO15765-2 network layer message reception


Device Settings Functions

Name Description
GetConfiguration Reads the configuration bytes for a neoVI Blue or ValueCAN device
SendConfiguration Sends configuration bytes to a neoVI Blue or ValueCAN device
GetFireSettings Gets device and network parameters for a neoVI Fire device
SetFireSettings Sets device and network parameters for a neoVI Fire device
GetVCAN3Settings Gets device and network parameters for a ValueCAN3 device
SetVCAN3Settings Sets device and network parameters for a ValueCAN3 device
SetBitRate Set the baud or bit rate for a specific neoVI network
GetHWFirmwareInfo Gets the firmware version of a neoVI device
GetDLLFirmwareInfo Gets the firmware version stored in the DLL API
ForceFirmwareUpdate Forces the firmware to updated on a neoVI device
GetDeviceParameters Gets individual parameters for a neoVI device
SetDeviceParameters Sets individual parameters for a neoVI device
SetReflashDisplayCallbacks Sets callback function pointers for flashing a neoVI
ClearReflashDisplayCallbacks Clears callback function pointers for flashing a neoVI
GetRTC Gets the current real-time clock value from a connect neoVI device
SetRTC Sets the current real-time clock value in a connected neoVI device


Error Functions

Name Description
GetLastAPIError Returns the error generated by the last intrepidcs API call
GetErrorMessages Returns the intrepidcs API error message queue
GetErrorInfo Returns a text description of an intrepidcs API error


General Utility Functions

Name Description
ValidateHObject Used to determine if an hObject reference is valid
GetDLLVersion Returns DLL version information
StartSockServer Starts the TCP/IP socket server at a specified port.
StopSockServer Stops the TCP/IP socket server


CoreMini Functions

Function Description
ScriptStart Starts execution of a script that has been downloaded to a neoVI device
ScriptStop Stops execution of a script running on a neoVI device
ScriptLoad Downloads a script to a connected neoVI device into a specified location
ScriptClear Clears a script from a specific location on a neoVI device
ScriptStartFBlock Starts a function block within a script on a neoVI device
ScriptGetFBlockStatus Returns the run status of a function block within a script on a neoVI device
ScriptStopFBlock Stops the execution of a function block within a script on a neoVI device
ScriptGetScriptStatus Stops the execution of a function block within a script on a neoVI device
ScriptReadAppSignal Read an application signal from a script running on a neoVI device
ScriptWriteAppSignal Set the value of an application signal in a script running on a neoVI device
ScriptReadRxMessage Reads parameters for a receive message defined in a script on a neoVI device
ScriptReadTxMessage Reads parameters for a transmit message defined within a script on a neoVI device
ScriptWriteRxMessage Alter a receive message defined within script on a neoVI device
ScriptWriteTxMessage Alter a transmit message defined within a script on a neoVI device
ScriptReadISO15765TxMessage Read parameters of an ISO15765-2 long transmit message in a script on a neoVI device
ScriptWriteISO15765TxMessage Change the parameters for an ISO15765-2 long transmit message defined in a script on a neoVI device

Deprecated Functions

Name Description
OpenPortEx Use OpenNeoDevice instead 
OpenPort Use OpenNeoDevice instead
EnableNetworkCom It is no longer necessary to call this before and after calling SendConfiguration
FindAllUSBDevices No longer supported. It is present in the API but will always return 0

 

intrepidcs API Documentation - (C) Copyright 2000-2010 Intrepid Control Systems, Inc.  (www.intrepidcs.com)

Last Updated : Wednesday, August 05, 2009