Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
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.
Displays the Value of CNF1 of ValueCAN/neoVI HSCAN
This method reads the configuration settings from a neoVI Fire device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to an SFireSettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SFireSettings structure.
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
After getting the current settings, you may change the parameters defined in the SFireSettings structure and write the settings back to the neoVI Fire using SetFireSettings.
This method writes configuration settings to a neoVI Fire device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to an SFireSettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SFireSettings structure.
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the neoVI is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the neoVI.
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
Before using this function, the SFireSettings structure must be initialized with the current neoVI settings using GetFireSettings.
This method sends configuration information to the hardware.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pData
[in] This is an array configuration bytes. The format of this array is defined in the Configuration Array help topic. This data should be filled in with a call to GetConfiguration before calling SendConfiguration. The size of this array must always be 1024 bytes.
lNumBytes
[in] This must always be set to 1024.
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
This method will only update the configuration defined in the Configuration Array topic. It will also apply checking to the data so that a neoVI is not programmed to an illegal state. For example, setting the CAN controller to an illegal operating mode.
Parameters
hObject
pSettings
iNumBytes
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the neoVI FIRE 2 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the neoVI FIRE 2.
Return Values
NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75
Remarks
Name | Description |
---|---|
Name | Description |
---|---|
[in] Specifies the driver object created by .
[out] Pointer to a structure.
[in] This value is always the size, in bytes, of the structure.
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:
After getting the current settings, you may change the parameters defined in the structure and write the settings back to the neoVI FIRE 2 using .
[in] Specifies the driver object created by .
[in] The address of an allocated structure.
[in] This value is always the size, in bytes, of the structure.
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:
Before using this function, the structure must be initialized with the current neoVI settings using .
Gets device and network parameters for a neoVI Fire device
Sets device and network parameters for a neoVI Fire device
Gets device and network parameters for a neoVI FIRE 2 device
Sets device and network parameters for a neoVI FIRE 2 device
This method reads the configuration settings from a ValueCAN3 device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to a SVCAN3Settings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SVCAN3Settings structure.
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
After getting the current settings, you may change the parameters defined in the SVCAN3Settings structure and write the settings back to the ValueCAN3 using SetVCAN3Settings.
This method reads the configuration settings from a ValueCAN4-1 and ValueCAN4-2 device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to a SVCAN412Settings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SVCAN412Settings structure.
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
After getting the current settings, you may change the parameters defined in the SVCAN412Settings structure and write the settings back to the ValueCAN 4-1 and ValueCAN 4-2 using SetVCAN412Settings.
This method writes configuration settings to a ValueCAN4-1 and ValueCAN4-2 device.
Parameters
hObject
pSettings
iNumBytes
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the ValueCAN3 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the ValueCAN4-1 and ValueCAN4-2.
Return Values
NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75
Remarks
Name | Description |
---|
[in] Specifies the driver object created by .
[in] The address of an allocated structure.
[in] This value is always the size, in bytes, of the structure.
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:
Before using this function, the structure must be initialized with the current neoVI settings using .
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.
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
After getting the current settings, you may change the parameters defined in the structure and write the settings back to the ValueCAN 4-4 using .
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[in] The address of an allocated SVCANRFSettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SVCANRFSettings structure.
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the ValueCAN RF is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the ValueCAN RF.
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
Before using this function, the SVCANRFSettings structure must be initialized with the current neoVI settings using GetVCANRFSettings.
This method reads the configuration settings from a ValueCAN RF device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to a SVCANRFSettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SVCANRFSettings structure.
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
After getting the current settings, you may change the parameters defined in the SVCANRFSettings structure and write the settings back to the ValueCAN RF using SetVCANRFSettings.
Gets device and network parameters for a ValueCAN 4-4 device |
Sets device and network parameters for a ValueCAN 4-4 device |
Name | Description |
---|---|
Name | Description |
---|
Gets device and network parameters for a ValueCAN RF device
Sets device and network parameters for a ValueCAN RF device
This method reads the configuration settings from a RAD Galaxy device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[in] The address of an allocated SRADGalaxySettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SRADGalaxySettings structure.
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the ValueCAN3 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the ValueCAN3.
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
Before using this function, the SRADGalaxySettings structure must be initialized with the current neoVI settings using GetRADGalaxySettings.
This method reads the configuration settings from a RAD Galaxy device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to a SRADGalaxySettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SRADGalaxySettings structure.
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
After getting the current settings, you may change the parameters defined in the SRADGalaxySettings structure and write the settings back to the RAD Galaxy using SetRADGalaxySettings.
This method sets bit rates for networks on neoVI devices
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
iBitRate
[in] Specifies bit rate setting. Valid values depend on the network specified.
For the networks NETID_HSCAN, NETID_MSCAN, NETID_SWCAN, NETID_FIRE_HSCAN2, NETID_HSCAN3, NETID_LSFTCAN, valid bit rates are 2000, 33333, 50000, 62500, 83333, 100000, 125000, 250000, 500000, 800000, 1000000
For the networks NETID_LIN, NETID_ISO2, NETID_FIRE_LIN2, NETID_FIRE_LIN3, NETID_FIRE_LIN4, valid bit rates are
For the network NETID_FIRE_CGI valid bit rates are 625000 and 115200
iNetworkID
[in] Specifies the network. The valid values are:
NETID_HSCAN, NETID_MSCAN, NETID_SWCAN, NETID_FIRE_HSCAN2, NETID_HSCAN3, NETID_LSFTCAN, NETID_LIN, NETID_ISO2, NETID_FIRE_LIN2, NETID_FIRE_LIN3, NETID_FIRE_LIN4, NETID_FIRE_CGI
These values are defined in the icsnVC40.h file
Return Values
1 if the function succeeded. 0 if it failed for any reason. GetLastAPIError 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.
Gets device and network parameters for a RAD Galaxy device |
Sets device and network parameters for a RAD Galaxy device |
These functions are designed to work for both 2G and 3G devices
Name | Description |
---|---|
Set the baud or bit rate for a specific neoVI network
Gets the firmware version of a neoVI device
Gets the firmware version stored in the DLL API
Forces the firmware to updated on a neoVI device
Gets individual parameters for a neoVI device
Sets individual parameters for a neoVI device
Sets callback function pointers for use when flashing a neoVI
Clears callback function pointers for flashing a neoVI
This method sets bit rates for networks on neoVI devices
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
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. GetLastAPIError 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.
This method reads the configuration settings from various devices.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[out] Pointer to a SDeviceSettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SDeviceSettings structure.
VnetChan
[in] This value is indicates which Vnet to set the settings to. This parameter is intended for neoVI ION and neoVI Plasma which have more than one Vnet Slot. For all other devices set this to 0.
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
After getting the current settings, you may change the parameters defined in the SDeviceSettings structure and write the settings back to the neoVI FIRE 2 using SetDeviceSettings.
This method writes configuration settings to various devices.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
pSettings
[in] The address of an allocated SDeviceSettings structure.
iNumBytes
[in] This value is always the size, in bytes, of the SDeviceSettings structure.
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the neoVI FIRE 2 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the neoVI FIRE 2.
VnetChan
[in] This value is indicates which Vnet to set the settings to. This parameter is intended for neoVI ION and neoVI Plasma which have more than one Vnet Slot. For all other devices set this to 0.
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
Before using this function, the SDeviceSettings structure must be initialized with the current neoVI settings using GetDeviceSettings.
[in] Specifies the driver object created by .
[out] Pointer to an structure.
[in] Specifies the driver object created by .
This method forces the firmware on neoVI device to be updated.
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.
This method changes neoVI device parameters.
Parameters
hObject
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 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
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.
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
[in] Specifies the driver object created by .
See for a list of parameter names for each device and supported network.
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:
This method is used to set ‘call back’ functions that will be called by the neoVI API when flashing a neoVI device with the 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.
After calling this function you must call the 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 function is called.
This method returns the value of the real-time clock on a connected neoVI device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
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. 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
This method sets the value of the real-time clock on a connected neoVI device.
Parameters
hObject
[in] Specifies the driver object created by OpenNeoDevice.
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. 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
Name | Description |
---|
Gets device and network parameters for a neoVI Fire device |
Sets device and network parameters for a neoVI Fire device |
Gets device and network parameters for a ValueCAN3 device |
Sets device and network parameters for a ValueCAN3 device |
Set the baud or bit rate for a specific neoVI network |
Gets the firmware version of a neoVI device |
Gets the firmware version stored in the DLL API |
Forces the firmware to updated on a neoVI device |
Gets individual parameters for a neoVI device |
Sets individual parameters for a neoVI device |
Sets callback function pointers for use when flashing a neoVI |
Clears callback function pointers for flashing a neoVI |
Gets the current real-time clock value from a connect neoVI device |
Sets the current real-time clock value in a connected neoVI device |
This method reads the configuration settings from a ValueCAN3 device.
Parameters
hObject
pSettings
iNumBytes
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the ValueCAN3 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the ValueCAN3.
Return Values
NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75
Remarks
This method writes configuration settings to a ValueCAN4-4 device.
Parameters
hObject
pSettings
iNumBytes
bSaveToEEPROM
[in] If set to 0, the settings changes will revert to the values stored in EEPROM when the ValueCAN3 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the ValueCAN4-4.
Return Values
NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75
Remarks
Name | Description |
---|
[in] Specifies the driver object created by .
[in] The address of an allocated structure.
[in] This value is always the size, in bytes, of the structure.
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:
Before using this function, the structure must be initialized with the current neoVI settings using .
[in] Specifies the driver object created by .
[in] The address of an allocated structure.
[in] This value is always the size, in bytes, of the structure.
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:
Before using this function, the structure must be initialized with the current neoVI settings using .
Gets device and network parameters for a ValueCAN3 device |
Sets device and network parameters for a ValueCAN3 device |
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.
Name | Description |
---|---|
Gets device and network parameters for a ValueCAN 4-1 and 4-2 device
Sets device and network parameters for a ValueCAN 4-1 and 4-2 device