1. Start the application.

2. Open the driver and find a neoVI or ValueCAN device.

3. Create the neoVI object using the OpenNeoDevice method.

4. Transmit messages using the TxMessages method.

5. Read messages on the network using the GetMessages method.

6. Optionally readout any errors using the GetErrorMessages method.

7. Repeat steps 3 through 5 while your application is monitoring the network.

8. Close the driver when not monitoring by calling the ClosePort method.

9. To start monitoring again go back to step 2.

10. When the application exits the neoVI object must freed (destroyed) by calling the FreeObject method.

Overview

The neoVI API provides a simple way to access the neoVI hardware with WIN32 development tools. This documentation describes how to use the API for custom applications. Each API has an example targeted for both C/C++, C#, and Visual Basic (VB). Operational examples are included for Microsoft Visual C++, National Instruments LabVIEW, National Instruments LabWindows CVI, Borland C++ Builder, Borland Delphi, and Microsoft Visual Basic.

Included with neoVI is the "icsneo40.dll" DLL. This DLL is a high performance multi-threaded DLL, capable of supporting many neoVI devices simultaneously. The DLL is through dynamic linkage.

For applications using neoVI and ValueCAN devices which do not use Windows, a Linux interface is available. Intrepid Control Systems also has a Github page with APIs and projects for a verity of different system configurations. Code here can be built to fit the needed system.

Getting Started

To get started, review the Basic Operation topic and the topics describing how to use the API in Visual Basic .NET, Visual C++, Visual C#, LabWindows CVI, LabVIEW, Borland C++ Builder, Unity Engine, and Borland Delphi.

This method starts the TCP/IP socket server at a specified port.

int _stdcall icsneoStopSockServer(int hObject);

Public Declare Function icsneoStopSockServer Lib “icsneo40.dll” (ByVal hObject As Integer) As Integer

[DllImport(“icsneo40.dll”)] public static extern int icsneoStopSockServer(int hObject);

Parameters

hObject

[in] Handle to the driver object created by OpenNeoDevice

Return Values

If the server has been stopped successfully the return value will be 1. If the function fails the return value will be zero.

Remarks

This method should be called when the server created with StartSocketServer.

Examples

icsneoStopSockServer(hObject);

bStatus = icsneoStopSockServer(m_hObject) '// stop the socket server

iStatus = icsNeoDll.icsneoStopSockServer(m_hObject); // stop the socket server

This method is no longer supported and will always return 0. It remains in the API for backward compatibility.

To use the neoVI API in Visual Basic add the Download the file bas_neoVI.vb module into the VB project (figure 1) by right clicking on the Solution and selecting Add Existing Item from the Add menu. Open the bas_neoVI.vb. Then, call the methods as defined in the WIN32 API Functions and Types Section of this document.

Example

A Visual Basic Dot Net 2010 example (Figure 1) is included to show how the API all works together. The main project files are as follows: 1) the project file: IcsNeoDotNet.sln 2) the form file : Form1.vb, and 3) the neoVI module : bas_neoVI.vb. All project files are included in the following file VBnet2010.zip. This project will open in Visual Studio 2010, 2012, 2013, 2015, and 2017.

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

Do the following steps to use neoVI in Borland C++ Builder:

1) Start your new project and add the to your project.

2) Add a #include "icsneo40DLLAPI.h" to your project

3) Use the Functions "LoadDLLAPI" to load the functions and "UnloadDLLAPI" to unload the functions. Examples are below.

4) Finally, call the methods as defined in the he document.

Example

A Borland C++ Builder example (Figure 1) is included to show how the API all works together. The example files are included in the following file:

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

Overview

The intrepidcs API packages all of the WIN32 methods into LabVIEW LLB. Inside the LLB the sub VIs can be accessed to make it easy for you to use neoVI with National Instruments LabVIEW.

Steps to use neoVI in LabVIEW

Open the “NEO VI Example.llb” found in the file. When you first access the main VI or sub VI’s you may receive a warning regarding a Dependency missing. Make sure that your project is pointing to the icsneo40.dll. This is normally installed to the system32 or SysWOW64 directories.

Example

A LabVIEW example (Figure 1) is included to show how the API all works together. An example project can be found here: .

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

Do the following steps to use Unity3D Graphic Display:

First set the scene for running an .exe file, then an explanation of how the scripts work.

Example

This is the Unity3D Demo in its entirety included to show how the API all works together; The example files are included in the following file:

Open Unity3D. Locate and open the project folder called “Unity Graphic display API”. (Figure 1)

In the project panel open the Unity scene called Unity_API_Demo. Once opened, in the game view is a place holder for the graphical display. This is where all the data will be visually displayed upon execution of the application. (Figure 2)

Next, locate the icsNeoClass.cs and make sure it is in the correct folder, this imports the .DLL into the project panel (cannot be in any other folder, other then the main “project asset folder”).

Locate IcsNeoClassUnity.cs, located in the Scripts folder. This example script handles the functions of the Intrepid Hardware; open, close, transmit, receive, ect… Then attach the IcsNeoClassUnity.cs on the Main Camera. (refer to figure 3)

The demo should be all set up and ready to play out at this point. Press the play button near the top of the Unity3D windows to enter play mode and begin the demo. (Figure 4)

This method releases system resources used by the neoVI device.

Parameters

hObject

**** [in] Specifies the driver object created by .

Return Values

None.

Remarks

This method is used to release any resources that were allocated by . Applications that create neoVI handles should release them using this method, however, the intrepidCS API will release any resources that it created for the client application when the client application ends and the API is unloaded. The LabVIEW neoClosePort.vi will call the FreeObject API.

Examples

This method forces the firmware on neoVI device to be updated.

Parameters

hObject

[in] Specifies the driver object created by .

Return Values

int.

Remarks

This method is used to force the firmware on a neoVI device to be updated to the version stored in the DLL API.

Examples

This method is used to clear callback functions that were set using the SetReflashDisplayCallback method.

Parameters

None

Return Values

None

Remarks

Examples

This method sets the value of the real-time clock on a connected neoVI device.

Parameters

hObject

[in] Specifies the driver object created by .

pTime

[in] The address of a icsSpyTime structure. This structure is defined in the file icsSpyDataCommon.h

Return Values

1 if the function succeeded. 0 if it failed for any reason. must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

Examples

This method returns the error generated by the last API call.

Parameters

hObject

[in] Specifies the driver object created by .

piErrorNumber

[out] The value of the error generated by the previous API call will be returned. The text description of the error can then be obtained by calling .

Return Values

If an error was generated and stored during the last API call then 1 will be returned. 0 will be returned if no error was generated since the port was opened or the last time that was called. The stored error will be cleared after this call. API errors are generated and stored on a ‘per-thread’ basis. The calling thread will only receive errors generated within it’s own context. If a new API error is generated before the previous error has been retrieved, the previous error will be lost. All errors generated can still be retrieved using . However, will return errors generated in all threads, not just the current thread.

Remarks

Examples

This method returns the software version of the DLL.

Parameters

None.

Return Values

This function returns the version number of the API.

Remarks

None.

Examples

This method starts the TCP/IP socket server at a specified port.

Parameters

hObject

[in] Handle which specifies the driver object created by

iPort

[in] specifies the TCP/IP Port where the server will be established.

Return Values

If the server was started successfully the return value will be non-zero.

Remarks

This method creates a TCP/IP server in the DLL. This server can be attached to by any TCP/IP clients using the RAW API or using the DLL by specifying TCP/IP with . Only one server is allowed at a time.

Examples

This function is deprecated. Use the EnableNetworkRXQueue method instead.

This method enables or disables all vehicle network rx data.

Parameters

lEnable

[in] When 1 it will enable network receive. When 0 it will disable network receive.

Return Values

This function returns the 1 when successful. 0 if otherwise.

Remarks

This function will enable and disable network traffic for all client applications connected to the neoVI. The icsneoEnableNetworkRXQueue function can be used to enable and disable the receive message queue for individual applications.

Examples

Overview

For ISO9141 and Keyword 2000 Networks, a long message transmission option is allowed. Long message transmission is necessary when the message length exceeds twelve bytes (including checksum if used).

You can transmit a long message by calling the TxMessages method with modified arguments. First, you will pass an array of icsSpyMessage structures which contain the long message data. This data in the array must be set properly. Finally, you must set the lNumMessages argument to the number of structures.

You must setup the long message data properly. For the first message, both the 3 byte Header and the 8 byte data section are filled in. For consecutive messages only the 8 byte data section is filled in.

VB Example to Send a 16 byte message

'// Declared at form level
Private m_hObject As intptr '// Holds the object for the state of the application


Dim stMsgJ1850(0 To 3) As icsSpyMessageJ1850
Dim lResult As Long

'//Fill in first header
stMsgJ1850(0).Header1 = &H1
stMsgJ1850(0).Header2 = &H2
stMsgJ1850(0).Header3 = &H0
stMsgJ1850(0).NumberBytesHeader = 3

'//Fill in data
stMsgJ1850(0).Data1 = &H4
stMsgJ1850(0).Data2 = &H5
stMsgJ1850(0).Data3 = &H6
stMsgJ1850(0).Data4 = &H7
stMsgJ1850(0).Data5 = &H8
stMsgJ1850(0).Data6 = &H9
stMsgJ1850(0).Data7 = &H10
stMsgJ1850(0).Data8 = &H11
stMsgJ1850(0).NumberBytesData = 8

'//Fill in data
stMsgJ1850(1).NumberBytesHeader = 0
stMsgJ1850(1).Data1 = &H12
stMsgJ1850(1).Data2 = &H13
stMsgJ1850(1).Data3 = &H14
stMsgJ1850(1).Data4 = &H15
stMsgJ1850(1).Data5 = &H16
stMsgJ1850(1).NumberBytesData = 5

'// Transmit the assembled message
lResult = icsneoTxMessages(m_hObject, stMsgJ1850(0), NETID_ISO, 2)

'// Test the returned result
If Not CBool(lResult) Then
    MsgBox("Problem Transmitting Message")
End If

This method returns the firmware version of the open neoVI device.

int _stdcall icsneoGetHWFirmwareInfo(void * hObject, stAPIFirmwareInfo *pInfo);

Public Declare Function icsneoGetHWFirmwareInfo Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pInfo As stAPIFirmwareInfo) As Integer

[DllImport(“icsneo40.dll”)] public static extern int icsneoGetHWFirmwareInfo(intPtr hObject, ref stAPIFirmwareInfo pInfo);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pInfo

[out] Pointer to an stAPIFirmwareInfo structure.

Return Values

Returns 1 if successful, 0 if an error occurred.

Remarks

This method returns the firmware version stored in the open neoVI device.

Examples

stAPIFirmwareInfo FirmwareInfo;
int iResult;

iResult = icsneoGetHWFirmwareInfo(m_hObject, &FirmwareInfo);
if(iResult == 0)
{
    MessageBox::Show("Problem getting the neoVI's firmware information");
    return;
}

stAPIFirmwareInfo FirmwareInfo = new stAPIFirmwareInfo();
int iResult;

iResult = icsNeoDll.icsneoGetHWFirmwareInfo(m_hObject, ref FirmwareInfo);
if(iResult == 0)
{
    MessageBox.Show("Problem getting the neoVI's firmware information");
    return;
}

Dim FirmwareInfo As stAPIFirmwareInfo
Dim iResult As Integer

iResult = icsneoGetHWFirmwareInfo(m_hObject, FirmwareInfo)
If iResult = 0 Then
    MsgBox("Problem getting the neoVI's firmware information")
    Exit Sub
End If

int _stdcall icsneoGetDLLFirmwareInfo(void * hObject, stAPIFirmwareInfo *pInfo);

Public Declare Function icsneoGetDLLFirmwareInfo Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pInfo As stAPIFirmwareInfo) As Integer

[DllImport(“icsneo40.dll”)] public static extern int icsneoGetDLLFirmwareInfo(IntPtr hObject, ref stAPIFirmwareInfo pInfo);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pInfo

[out] Pointer to an stAPIFirmwareInfo structure.

Return Values

Returns 1 if successful, 0 if an error occurred.

Remarks

This method returns the version information for the neoVI firmware stored within the neoVI DLL API. This is the version that will be written to the neoVI device by the ForceFirmwareUpdate method.

Examples

stAPIFirmwareInfo FirmwareInfo;
int iResult;

iResult = icsneoGetDLLFirmwareInfo(m_hObject, &FirmwareInfo);
if(iResult == 0)
{
    MessageBox::Show("Problem getting the version of the firmware stored within the DLL API");
    return;
}

stAPIFirmwareInfo FirmwareInfo = new stAPIFirmwareInfo();
int iResult;

iResult = icsNeoDll.icsneoGetDLLFirmwareInfo(m_hObject, ref FirmwareInfo);
if(iResult == 0)
{
    MessageBox.Show("Problem getting the version of the firmware stored within the DLL API");
    return;
}

Dim FirmwareInfo As stAPIFirmwareInfo
Dim iResult As Integer

iResult = icsneoGetDLLFirmwareInfo(m_hObject, FirmwareInfo)
If iResult = 0 Then
    MsgBox("Problem getting the version of the firmware stored within the DLL API")
    Exit Sub
End If

This method forces the firmware on neoVI device to be updated.

int _stdcall icsneoGetDeviceParameters(void * hObject, char *pParameters, char *pValues, short ValuesLength);

Public Declare Function icsneoGetDeviceParameters Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pParameters As Byte, ByRef pValues As Byte, ByVal ValuesLength As short) As Integer

[DllImport(“icsneo40.dll”)] public static extern int icsneoGetDeviceParameters(IntPtr hObject, ref byte pParameters, ref byte pValues, short ValuesLength);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pParameters

[in] This is an array containing parameter names. Each parameter is separated by a comma. The parameter names are matched without regard to case. All spaces are ignored. The size of this array must be 1024 bytes or less. The format of the array is:

ParameterName,ParameterName, , …

See Valid Parameters for a list of parameter names for each device and supported network.

See examples below on how to build a parameter string.

pValues

[out] This array will contain the values requested in the pParameters array. The values will be separated by comma’s and in the order of the parameter names specified in the pParameters array. If a parameter name is not recognized the word “Error” will be placed in that value’s location. If the pValues array length (specified by the ValuesLength parameter) is not long enough to store all of the values, the retrieval of parameter values will end and only a portion of the values will have be read and stored. The return value of the function, if greater than 0, will indicate the number of values read.

Return Values

-1 if there was an error while reading parameter values from the device. A return value greater than 0 indicates the total number of parameters read. A return value of 0 indicates that ValueLength was greater than 1024. GetLastAPIError must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

It is ineffecient to use this function to read one parameter value at a time. If multiple parameters need to be read, combine them into a long string and call this function once.

Examples

char pGetFireParms[] = "network_enables,can1/Mode,can1/Baudrate";
char Values[500];
int iRetVal;

iRetVal = icsneoGetDeviceParameters(hObject, pGetFireParms, Values, 499);

This method is used to set ‘call back’ functions that will be called by the neoVI API when flashing a neoVI device with the ForceFirmwareUpdate function. This overrides the Windows dialog box that normally displays the progress of a neoVI flash update. The use of call back functions allows the client application to receive the status messages and display them as desired.

int _stdcall icsneoSetReflashDisplayCallbacks(void (*OnPrompt)(unsigned long), void (*OnReflashUpdate)(const wchar_t *, unsigned long));

Parameters

void (*OnPrompt)(unsigned long)

[in] Specifies a function pointer that will be called when a message must be displayed instructing the user to disconnect and then re-connect the neoVI from the USZB port. The function receives an unsigned long that will contain the serial number of the neoVI device being flash updated. Before returning from this function call the user of the client application must be prompted to unplug the neoVI from the USB port and then re-connect it before continuing. This is to put the USB chip in the neoVI into bootloader mode so that flashing can begin. This function will not be called when flashing a ValueCAN3 device.

void (*OnReflashUpdate)(const wchar_t *, unsigned long)

[in] Specifies a function pointer that will be called when a flashing status message is ready to be displayed. The function recieves a pointer to a wide character string that contains the status message to display. It also receives an unsigned long that contains the percentage complete for the current chip being flashed. The percentage value will reset to 0 for each new chip. For example, the neoVI Fire has four chips to flash while the ValueCAN3 has only two.

Return Values

1 if successful, 0 if either function pointer is NULL.

Remarks

After calling this function you must call the ForceFirmwareUpdate function to cause the neoVI device firmware to be updated. Once the callbacks have been set they are valid and active until the the DLL is unloaded or until the ClearReflashDisplayCallbacks function is called.

Examples

This method is used to determine if a driver object is valid.

int _stdcall icsneoValidateHObject(void * hObject);

Public Declare Function icsneoValidateHObject Lib “icsneo40.dll” (ByVal hObject As IntPtr) As Integer

[DllImport(“icsneo40.dll”)] public static extern int icsneoValidateHObject(IntPtr hObject);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

Return Values

1 if the hObject is valid. 0 if the object is invalid.

Remarks

A driver object will be invalid if it was never initialized by OpenNeoDevice. Calling ClosePort will not invalidate a driver object; only FreeObject will do so.

Examples

if(Convert::ToBoolean(icsneoValidateHObject(m_hObject)))
{
    cmdCheckHardwareHandle->Text = "Good";
}
else
{
    cmdCheckHardwareHandle->Text = "Lost";
}

if (Convert.ToBoolean (icsNeoDll.icsneoValidateHObject(m_hObject)))
{
    cmdCheckHardwareHandle.Text = "Good";
}
else
{
    cmdCheckHardwareHandle.Text = "Lost";
}

If (CBool(icsneoValidateHObject(m_hObject))) Then
    cmdCheckHardwareHandle.Text = "Good"
Else
    cmdCheckHardwareHandle.Text = "Lost"
End If

int _stdcall icsneoGetPerformanceParameters(void * hObject, int * iBufferCount, int * iBufferMax, int * iOverFlowCount, int * iReserved1, int * iReserved2,int * iReserved3,int * iReserved4,int * iReserved5)

Public Declare Function icsneoGetPerformanceParameters Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef iBufferCount As Integer, ByRef iBufferMax As Integer, ByRef iOverFlowCount As Integer, ByRef iReserved1 As Integer, ByRef iReserved2 As Integer, ByRef iReserved3 As Integer, ByRef iReserved4 As Integer, ByRef iReserved5 As Integer) As Integer

[DllImport(“icsneo40.dll”)] public static extern int icsneoGetPerformanceParameters(IntPtr hObject,ref int iBufferCount, ref int iBufferMax, ref int iOverFlowCount , ref int iReserved1, ref int iReserved2 , ref int iReserved3, ref int iReserved4 ,ref int iReserved5);

Parameters

hObject

[in] Specifies the driver object created with the OpenPort method.

iBufferCount

[out] Specifies the driver object created with the OpenPort method.

IBufferMax

[out] Specifies the size of the buffer.

iOverFlowCount

[out] Indicates the the number of overflows that have occurred since the last successful OpenPort method was called.

iReserved1

[out] Reserved. Set to 0.

iReserved2

[out] Reserved. Set to 0.

iReserved3

[out] Reserved. Set to 0.

iReserved4

[out] Reserved. Set to 0.

iReserved5

[out] Reserved. Set to 0.

Return Values

This function returns the 1 when successful. 0 if otherwise.

Remarks

XX.

Examples

icsneoGetPerformanceParameters(m_hObject, &iBufferCount, &iBufferMax, &iOverFlowCount, &iReserved1, &iReserved2, &iReserved3, &iReserved4, &iReserved5);

lResult = icsneoGetPerformanceParameters(m_hObject, iBufferCount, iBufferMax, iOverFlowCount, iReserved1, iReserved2, iReserved3, iReserved4, iReserved5)

If CBool(lResult) Then
    txtBufferCount.Text = iBufferCount
    txtBufferMax.Text = iBufferMax
    txtOverflowCount.Text = iOverFlowCount
End If

lResult = icsNeoDll.icsneoGetPerformanceParameters(m_hObject, ref iBufferCount, ref iBufferMax, ref iOverFlowCount, ref iReserved1, ref iReserved2, ref iReserved3, ref iReserved4, ref iReserved5);

if(lResult=1)
{
    txtBufferCount.Text = Convert.ToString(iBufferCount);
    txtBufferMax.Text = Convert.ToString(iBufferMax);
    txtOverflowCount.Text = Convert.ToString(iOverFlowCount);
}

This topic discusses which port type can be used with what type of hardware.

A required parameter for the OpenPortEx command is the Port type. Each type is and the hardware it supports is listed below.

To use neoVI in Visual C++:

1. Start your new project and add the Dynamic link helper files to your project.

2. Add a #include “icsneo40DLLAPI.h” to your project

3. Use the Functions “LoadDLLAPI” to load the functions and “UnloadDLLAPI” to unload the functions. Examples are below.

 HINSTANCE hDLL;

 //-----Load the DLL
 if(!LoadDLLAPI(hDLL))
 {
 //problem, close the application

 printf("Problem loading Library\r\nMake sure icsneo40.dll is installed and accessable\r\nPress any key to Exit");

 }

 //-----Unload the DLL

 UnloadDLLAPI(hDLL);

4. Finally, call the methods as defined in the Basic Operation document.

A Visual C++ example (Figure 1) is included to show how the API all works together. The example files are included in the following file: VCNewneoVI.zip

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

To use the neoVI API in C# add the icsNeoClass.cs Class into the C# project (figure 1). Right click on the solution and select “Add Existing Item” from the “Add” menu. Then, call the methods as defined in the WIN32 API Functions and Types Section of this document.

Example

A C# Dot Net 2010 example (Figure 1) is included to show how the API all works together. The main project files are as follows: 1) the project file: IcsApiDotNetCSharp.sln 2) the form file : Form1.cs, and 3) the neoVI module : icsNeoClass.cs. All project files are included in the following file CSnet2010.zip. This project will open in Visual Studio 2010, 2012, 2013, 2015 and 2017.

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

Do the following steps to use neoVI in Borland Delphi:

1. Copy the import library icsn40.pas, and data structure file icsSpyData.pas to your project directory.

2. Link to icsn40.pas import library via the “Add to Project…” option (Figure 1). This dialog is accessible via the “Project” pull down menu in Delphi. When the file dialog appears, select the icsn40.pas.

3. Your project manager will now show the import library icsn40.pas (Figure 2).

4. Include icsn40 and icsSpyData in your interface Uses (Figure 3).

5. Finally, call the methods as defined in the Basic Operation document.

Example

A Borland Delphi example (Figure 1) is included to show how the API all works together. The example files are included in the following file: icsnDelphiSample.zip (14kB)

The example shows how to open and close communication to the driver, send messages, and read messages on the networks.

Do the following steps to use neoVI in LabWindows CVI:

1. Copy the import library icsnLW40.lib , header file icsnLW40.h , and data structure file icsspyData.h to your project directory.

2. Link to icsnLW40.lib import library by selecting Add Files To Project from the Edit pull down menu. In the “Add Files To Project” dialog select the icsnLW40.lib file (figure 1). You can also the headers from step 1 if you wish. Your project should now list the files you added (figure 2).

3. Include the header icsnLW40.h in your C module (Figure 3).

4. Finally, call the methods as defined in the Basic Operation document.

Example

A National Instruments LabWindows example (Figure 1) is included to show how the API all works together. The example files are included in the following file: LWneoVI.zip (10kB)

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

To use the intrepidcs API in Excel or other VBA supported application add the bas_neoVI.vb module into your project (figure 1) by right clicking on the Project in the VBA Editor and selecting Insert and then Module. Open the bas_neoVI.vb. Then, call the methods as defined in the Basic Operation document. The function calls for use in VBA are the same as the calls in Visual Basic 6.

Example

A VBA Excel example (Figure 1) is included to show how the API all works together. This project only has 1 file, NeoVIExample.XlS. Make sure macros are enabled to run this example. All the needed project files are included in the following file: ExcelVBA.zip

The example shows how to open and close communication to the driver, send messages and read messages on the networks.

These functions are designed to work for both 2G and 3G devices

This method enables the use of ISO15765-2 on a CAN network. icsneoISO15765_EnableNetwroks must be called before using icsneoISO15765_TransmitMessage or icsneoISO15765_ReceiveMessage.

Parameters

hObject

[in] Handle which specifies the driver object created with the OpenPort method.

lNetwork

[in] Specifies which CAN network the status is requested for. Can be one of the following values:

Return Values

None.

Remarks

None.

Examples

This method reads the configuration settings from a ValueCAN3 device.

Parameters

hObject

[in] Specifies the driver object created by .

pSettings

[out] Pointer to a structure.

iNumBytes

[in] This value is always the size, in bytes, of the structure.

Return Values

Returns 1 if successful, 0 if an error occurred. must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

After getting the current settings, you may change the parameters defined in the structure and write the settings back to the ValueCAN3 using .

Examples

This method sets bit rates for networks on neoVI devices

Parameters

hObject

[in] Specifies the driver object created by .

iBitRate

[in] Specifies bit rate setting. Valid values depend on the network specified.

For the networks HSCAN, MSCAN, HSCAN2, HSCAN3, HSCAN4, HSCAN5, HSCAN6, and HSCAN7 valid bit rates are 1000000, 2000000, 4000000, 5000000, 8000000,and 10000000

iNetworkID

[in] Specifies the network. The valid values are:

NETID_HSCAN, NETID_MSCAN, NETID_HSCAN2, NETID_HSCAN3, NETID_HSCAN4, NETID_HSCAN5, NETID_HSCAN6, and NETID_HSCAN7

These values are defined in the icsnVC40.h file

Return Values

1 if the function succeeded. 0 if it failed for any reason. must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_INVALID_NETID = 8

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

NEOVI_ERROR_DLL_RED_INVALID_BAUD_SPECIFIED = 122

NEOVI_ERROR_DLL_SEND_DEVICE_CONFIG_ERROR = 229

NEOVI_ERROR_DLL_GET_DEVICE_CONFIG_ERROR = 230

NEOVI_ERROR_DLL_UNKNOWN_NEOVI_TYPE = 231

Remarks

The specified network must exist on the connected neoVI device.

Examples

This method changes neoVI device parameters.

Parameters

hObject

[in] Specifies the driver object created by .

pParmValue

[in] This is an array containing parameter names and values. Each parameter and value is separated by a equal sign, and each parameter/value pairing is separated by a comma. The parameter names are matched without regard to case. All spaces are ignored. The size of this array must be 1024 bytes or less. The format of the array is:

ParameterName=Value,ParameterName=Value, …

See for a list of parameter names for each device and supported network.

See examples below on how to build a parameter/value string.

pErrorIndex

[out] If there are any errors detected within the pParmValue parameter, this value will indicate index of the parameter where the first error was found. The index is zero-based.

bSaveToEEPROM

[in] This value determines if the parameter changes are permanent or will be lost when the device is power-cycled. Set the value to 1 to write the changes to EEPROM, 0 to keep the changes restricted to RAM.

Return Values

1 if the changes are successful. -1 if there was an error while writing the changes to the device. 0 if there is an error detected within the pParmValue array. If the return value is 0, indicating an error, check the pErrorIndex to get the index of the first error detected within the pParmValue array. must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

It is ineffecient to use this function to write one parameter change at a time. If multiple parameters need to be changed, combine them into a long string and call this function once.

Examples

This method reads the neoVI DLL error message queue.

Parameters

hObject

[in] Specifies the driver object created with .

pErrorMsgs

[out] This is the address of the first element of an array of long variables of at least 600 elements. This array will be loaded with the current error queue. The error queue will contain errors generated by all threads, not just the current thread. A separate topic describes the possible values for . You can get a text description of this error using .

pNumberOfErrors

[out] Specifies the number of errors copied into the pErrorMsgs buffer. The maximum value will be 600.

Return Values

Returns 1 if successful, 0 on failure.

Remarks

The error queue will be reset after this method is called.

Examples

The CoreMini Script Interface is a way to use functionality from Vehicle Spy in your own application. When a CoreMini file is created in Vehicle Spy 3 it creates header files for the functions in the file and giving access to basic parameters in the script.

This section includes commands to load and interact with CoreMini scripts for Intrepid Control Systems 3G hardware. CoreMini scripts are created using Vehicle Spy 3. For information on creating CoreMini scripts see the help documents for Vehicle Spy 3. The table below lists the different script interface commands and gives a short description of the command.

This method returns the value of the real-time clock on a connected neoVI device.

Parameters

hObject

[in] Specifies the driver object created by .

pTime

[in] The address of a icsSpyTime structure. This structure is defined in the file icsSpyDataCommon.h

Return Values

1 if the function succeeded. 0 if it failed for any reason. must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

Examples

This method sets bit rates for networks on neoVI devices

Parameters

hObject __ [in] Specifies the driver object created by OpenNeoDevice. gptpStatus [out] The address of a GPTPStatus structure.

Return Values

1 if the function succeeded. 0 if it failed for any reason. GetLastAPIError must be called to obtain the specific error. Failure could include the device not supporting gPTP, or the device supports gPTP but not support icsneoGetGPTPStatus API. Remarks

Rad Galaxy, Rad SuperMoon, Rad Star2, and Rad GigaStar supports icsneoGetGPTPStatus API nEAT, Rad Pluto, Rad Jupiter support gPTP but, does not support this API

Examples

This method enables or disables the Ethernet activation line on supported hardware devices.

Parameters

hObject

[in] Specifies the driver object created by

bActivate

[in] Specifies the state of the Activation line. True enables the activation and False disabled it.

Return Values

1 if the function succeeded. 0 if it failed for any reason. r must be called to obtain the specific error.

Remarks

The specified hardware must support a DoIP activation line

Examples

Visual Studio 2005 and newer contain different options to compile an application. By default, new programs or programs upgraded from earlier versions of Visual Studio will be configured as "ANY CPU". This option will run as a 32 bit program (x86) on a 32 bit version of Windows and as a 64 bit program (x64) in a 64 bit version of Windows. Projects can also be directly specified as 32 bit (x86) or 64 bit (x64). Starting with icsneo40.dll version 3.7.1.73 and newer, a 64 bit dll was introduced. Using software installs from Intrepid Control Systems, the two dlls are installed to their proper locations on the system. The compiler settings will dictate which of the two dlls is used. Windows will map to the proper one.

The folder location for the icsneo40.dll depends on the Windows install. On a 32 bit (x86) PC, just the 32 bit version is installed to the System32 folder. On a 64 bit system (x64) the 32 bit version is stored in the SysWoW64 folder and the 64 bit version is in the System32 folder. Again the operating system will take care of this based on your settings in the compiler. In either case, the application would need to reference System32, or not specify the location at all. Windows will search the application folder followed by the proper system folder locations to access the correct dll based on your compile options

The configuration manager is used to set which compile type needed. The following are steps for changing the compile options Visual Studio 2010. For help with your version and level of Visual Studio, consult Visual Studio help or . It is possible to change the compile options. The first step is to open the "Configuration Manager". This can be found by right clicking on your Solution and choosing "Configuration Manager" (figure 1).

Once in Configuration Manager, the Active solution platform can be selected. If you do not have the required option, select "<New...>" (figure 2).

After a new Platform has be created, it can be selected from the Standard tool bar (figure 4)

This method closes the communication link with the neoVI hardware.

int _stdcall icsneoClosePort(void * hObject, int * pNumberOfErrors);

Public Declare Function icsneoClosePort Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pNumberOfErrors As Int32) As Int32

[DllImport(“icsneo40.dll”)] public static extern Int32 icsneoClosePort(IntPtr hObject, ref Int32 pNumberOfErrors);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pNumberOfErrors

[out] Specifies the number of errors in the neoVI DLL error queue. You can read out the errors by calling the GetErrorMessages method.

Return Values

If the port has been closed successfully the return value will be 1. Otherwise, it will return zero. It will also return zero if the port is already closed.

Remarks

Must be called once for each successful call to OpenNeoDevice or memory and resource leaks will occur.

Examples

int lNumberOfErrors;    // used to get the number of errors
int iResult;

// Close Communication
iResult = icsneoClosePort(hObject, &iNumberOfErrors);
// Test the Result
if (iResult== 0)
    MessageBox(hWnd,TEXT("Problem Closing Port"),TEXT("neoVI Example"),0);
else
    MessageBox(hWnd,TEXT("Port Closed Successfully"),TEXT("neoVI Example"),0);

//Declared at form level and previously open with a call to OpenNeoDevice
IntPtr m_hObject; //handle for device,

int iResult;
int iNumberOfErrors = 0;

//close the port
iResult = icsNeoDll.icsneoClosePort(m_hObject, ref iNumberOfErrors);
if (iResult == 1)
{
    MessageBox.Show("Port Closed OK!");
}
else
{
    MessageBox.Show("Problem ClosingPort");
}
m_bPortOpen = false;

Private m_hObject As IntPtr '// Declared at form level and previously open with a call to OpenNeoDevice

Dim iResult As Integer
Dim iNumberOfErrors As Integer

'//close the port
iResult = icsneoClosePort(m_hObject, iNumberOfErrors)
If CBool(iResult) Then
    MsgBox("Port Closed OK!")
Else
    MsgBox("Problem Closing Port")
End If

int _stdcall icsneoGetMessages(void * hObject, icsSpyMessage *pMsg, int *pNumberOfMessages, int *pNumberOfErrors);

Public Declare Function icsneoGetMessages Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pMsg As icsSpyMessage, ByRef pNumberOfMessages As Int32, ByRef pNumberOfErrors As Int32) As Int32

[DllImport(“icsneo40.dll”)] public static extern Int32 icsneoGetMessages(IntPtr hObject, ref icsSpyMessage pMsg, ref Int32 pNumberOfMessages, ref Int32 pNumberOfErrors);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pMsg

[out] This is the address of the first element of an array of icsSpyMessage structures. This array will be loaded with messages received by the hardware. This array must be sized to fit 20,000 icsSpyMessage structures.

pNumberOfMessages

[out] Specifies the number of messages the driver has loaded in the pMsg array. This number can be up to 20,000 messages.

pNumberOfErrors

[out] Specifies the number of errors in the neoVI DLL error queue. Errors are obtained using GetErrorMessages.

Return Values

Returns 1 if successful, 0 if an error occurred. GetLastAPIError must be called to obtain the specific error. This function will return 1 even if no messages were received, provided there are no errors. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

The driver object will hold 20,000 received messages before it will generate an rx buffer overflow error (indicated by a NEOVI_ERROR_DLL_RX_MSG_BUFFER_OVERFLOW error message in the error queue). It is the job of the application software to read this buffer at regular intervals. The rate that the application needs to read these messages is dependant on the rate messages are received on the bus. For example, a high bandwidth CAN bus can generate 5000 messages per second. In this case you must read out the messages at least every four seconds or overflow errors will result.

Examples

void * hObject = 0;                 // holds a handle to the neoVI object
icsSpyMessage stMessages[20000]; // holds the received messages
int iResult;
int iNumberOfErrors;
int iNumberOfMessages;

// read out the messages
iResult = icsneoGetMessages(hObject,stMessages,&iNumberOfMessages,&iNumberOfErrors);
if (iResult == 0)
    MessageBox(hWnd,TEXT("Problem Reading Messages"),TEXT("neoVI Example"),0);
else
    MessageBox(hWnd, TEXT("Messages Read Successfully"),TEXT("neoVI Example"),0);

Dim lResult As Long ''Storage for Result of Call
Dim iNumberOfErrors As Long ''Storage for number of errors
Dim lNumberOfMessages As Long ''Storage for number of messages
Dim stMessages(20000) As icsSpyMessage '// Array of message structures to hold the received data

lResult = icsneoGetMessages(m_hObject, stMessages(0), lNumberOfMessages, iNumberOfErrors) ''Call get message function
If Not CBool(lResult) Then ''See if Call was successful
    MsgBox("Problem Getting Messages")
    Exit Sub
End If

long lResult; //Storage the Result for the function call
int lNumberOfErrors = 0; //Storage for the number of Errors
int lNumberOfMessages = 0; //Storage for the number of messages

//Call Get messages
lResult = icsNeoDll.icsneoGetMessages(m_hObject, ref stMessages[0],ref lNumberOfMessages,ref lNumberOfErrors);
if(lResult == 0) //Check the Results to see if there is a problem
{
    MessageBox.Show ("Problem Getting Messages");
    return;
}

This method reads the configuration from the hardware device. Note: This function is only to be used for neoVI Blue and ValueCAN. For neoVI Fire and neoVI Red use the GetFireSettings method. For ValueCAN3 use the GetVCAN3Settings method.

int _stdcall icsneoGetConfiguration(int hObject, unsigned char *pData, int *plNumBytes);

Public Declare Function icsneoGetConfiguration Lib "icsneo40.dll" (ByVal hObject As Int32, ByRef pData As Byte, ByRef lNumBytes As Int32) As Int32

[DllImport("icsneo40.dll")]
public static extern Int32 icsneoGetConfiguration(Int32 hObject, ref byte pData, ref Int32 lNumBytes);

Parameters

hObject

[in] Specifies the driver object created with the OpenNeoDevice method.

pData

[out] Pointer to an array of 1024 bytes. Each index of the array corresponds to a configuration value. For a list of configuration values to change, please see the Configuration Array topic.

plNumBytes

[out] This will return the number of bytes written to the array. For the current version of the API this will be 1024 bytes.

Return Values

Returns 1 if successful, 0 if an error occurred. GetLastAPIError must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

None.

Examples

unsigned char bConfigBytes[1024];

int iNumConfigBytes = 1024;

lResult  =  icsneoGetConfiguration(hObject, bConfigBytes, &iNumConfigBytes);
if (lResult == 0)
    MessageBox(hWnd,TEXT("Problem Reading Configuration"),TEXT("neoVI Example"),0);
else
{
    wsprintf(szOut,TEXT("HSCAN CNF1 = %x"),bConfigBytes[NEO_CFG_MPIC_HS_CAN_CNF1]);
    MessageBox(hWnd,szOut,TEXT("neoVI Example"),0);
} 

byte[] bConfigBytes = new byte[1024]; //Storage for Data Bytes from Device
int iNumBytes = 1204; //Storage for Number of Bytes
int lResult; //Storage for Result of Called Function
int Counter;

//Clear listbox
lstConfigInformation.Items.Clear();

//Call Get Configuration
lResult = icsNeoDll.icsneoGetConfiguration(m_hObject, ref bConfigBytes[0],ref iNumBytes);

//Fill ListBox with Data From function Call
for(Counter=0;Counter<1024;Counter++)
{
    lstConfigInformation.Items.Add("Byte Number-" + Counter + " Byte Data-" + bConfigBytes[Counter]);
}

byte[] bConfigBytes = new byte[1024]; //Storage for Data Bytes from Device
int iNumBytes = 1204; //Storage for Number of Bytes
int lResult; //Storage for Result of Called Function
int Counter;

//Clear listbox
lstConfigInformation.Items.Clear();

//Call Get Configuration
lResult = icsNeoDll.icsneoGetConfiguration(m_hObject, ref bConfigBytes[0],ref iNumBytes);

//Fill ListBox with Data From function Call
for(Counter=0;Counter<1024;Counter++)
{
    lstConfigInformation.Items.Add("Byte Number-" + Counter + " Byte Data-" + bConfigBytes[Counter]);
} 

This method reads the configuration settings from a neoVI Fire device.

int _stdcall icsneoGetFireSettings(void * hObject, SFireSettings *pSettings, int iNumBytes);

Public Declare Function icsneoGetFireSettings Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pSettings As SFireSettings , ByVal iNumBytes As Int32) As Int32

[DllImport(“icsneo40.dll”)] public static extern Int32 icsneoSetFireSettings(IntPtr hObject, ref SFireSettings pSettings, Int32 iNumBytes, Int32 bSaveToEEPROM);