neoVI API Docs
All DocsProductsLearning CenterSupport
  • The neoVI API - Create your own software applications
  • Basic Operation - neoVI API
    • Using the neoVI API in Visual Studio: 32 bit DLL and 64 bit OS - neoVI API
    • Using the intrepidcs API in Visual Basic - neoVI API
    • Using the neoVI API in Visual C++ - neoVI API
    • Using the neoVI API in C# - neoVI API
    • Using the neoVI API in Borland C++ Builder - neoVI API
    • Using the neoVI API in Delphi - neoVI API
    • Using the API in LabVIEW - neoVI API
    • Using the neoVI API in LabWindows CVI - neoVI API
    • Unity3D Graphic Display API
    • Using the neoVI API in Excel - neoVI API
  • WIN32 API Overview - neoVI API
    • Basic Functions Overview - neoVI API
      • FindDevices Method
      • OpenNeoDevice Method - neoVI API
      • ClosePort Method - neoVI API
      • FreeObject Method - neoVI API
    • Message Functions Overview - neoVI API
      • GetMessages Method - neoVI API
      • TxMessages Method - neoVI API
      • TxMessagesEx Method - neoVI API
      • WaitForRxMessagesWithTimeOut Method - neoVI API
      • GetTimeStampForMsg Method - neoVI API
      • ISO15765 Message Functions Overview - neoVI API
        • ISO15765_EnableNetworks Method - neoVI API
        • ISO15765_TransmitMessage Method - neoVI API
        • ISO15765_ReceiveMessage Method - neoVI API
      • Transmitting Long Messages - neoVI API
    • Device Settings Functions Overview - neoVI API
      • GetConfiguration Method - neoVI API
      • SendConfiguration Method - neoVI API
      • neoVI Fire - neoVI API
        • GetFireSettings Method - neoVI API
        • SetFireSettings Method - neoVI API
      • neoVI FIRE 2 - neoVI API
        • GetFIRE2Settings Method - neoVI API
        • SetFire2Settings Method - neoVI API
      • ValueCAN3 - neoVI API
        • GetVCAN3Settings Method - neoVI API
        • SetVCAN3Settings Method - neoVI API
      • ValueCAN 4-1 and 4-2 - neoVI API
        • GetVCAN412Settings Method - neoVI API
        • SetVCAN412Settings Method - neoVI API
      • ValueCAN 4-4 - neoVI API
        • GetVCAN4Settings Method - neoVI API
        • SetVCAN4Settings Method - neoVI API
      • ValueCAN RF - neoVI API
        • GetVCANRFSettings Method - neoVI API
        • SetVCANRFSettings Method - neoVI API
      • RAD Galaxy - neoVI API
        • GetRADGalaxySettings Method - neoVI API
        • SetRADGalaxySettings Method - neoVI API
      • General Device Settings - neoVI API
        • SetBitRate Method - neoVI API
        • SetFDBitRate Method - neoVI API
        • GetDeviceSettings Method - neoVI API
        • SetDeviceSettings Method - neoVI API
        • GetHWFirmwareInfo Method - neoVI API
        • GetDLLFirmwareInfo Method - neoVI API
        • ForceFirmwareUpdate Method - neoVI API
        • GetDeviceParameters Method - neoVI API
        • SetDeviceParameters Method - neoVI API
        • SetReflashDisplayCallbacks Method - neoVI API
        • ClearReflashDisplayCallbacks Method - neoVI API
        • GetRTC Method - neoVI API
        • SetRTC Method - neoVI API
    • Error Functions Overview - neoVI API
      • GetLastAPIError Method - neoVI API
      • GetErrorMessages Method - neoVI API
      • GetErrorInfo Method - neoVI API
      • Error Messages - neoVI API
    • General Utility Functions Overview - neoVI API
      • ValidateHObject Method - neoVI API
      • GetDLLVersion Method - neoVI API
      • StartSocketServer Method - neoVI API
      • StopSocketServer Method - neoVI API
      • GetPerformanceParameters Method - neoVI API
      • ReadWritePhySettings Method - neoVI API
      • EnableDOIPLine Method - neoVI API
      • GetGPTPStatus Method - neoVI API
    • Deprecated Functions Overview - neoVI API
      • OpenPortEx Method - neoVI API
        • OpenPortEx Hardware Type Information - neoVI API
      • FindAllCOMDevices Method - neoVI API
      • FindAllUSBDevices Method - neoVI API
      • FindNeoDevices Method - neoVI API
      • EnableNetworkCom Method - neoVI API
      • CoreMini Script interface Overview - neoVI API
        • ScriptStart Method - neoVI API
        • ScriptStop Method - neoVI API
        • ScriptLoad Method - neoVI API
        • ScriptClear Method - neoVI API
        • ScriptStartFBlock Method - neoVI API
        • ScriptGetFBlockStatus Method - neoVI API
        • ScriptStopFBlock Method - neoVI API
        • ScriptGetScriptStatus Method - neoVI API
        • ScriptReadAppSignal Method - neoVI API
        • ScriptWriteAppSignal Method - neoVI API
    • Structures, Types, and Defines Overview - neoVI API
      • Setting Structures Overview - neoVI API
        • SFireSettings Structure
        • SFire2Settings Structure
        • SVCAN3Settings Structure
        • SVCANRFSettings Structure
        • SVCAN412Settings Structure
        • SVCAN4Settings Structure
        • SVCAN4IndSettings Structure
        • SRADGalaxySettings Structure
        • SRADStar2Settings Structure
        • SRADPlutoSettings Structure
        • SRADSuperMoonSettings Structure
        • SRADMoon2Settings Structure
        • SDeviceSettings Structure
        • Sub Setting Structures Overview - neoVI API
          • CAN_SETTINGS Structure
          • SWCAN_SETTINGS Structure
          • CANFD_SETTINGS Structure
          • LIN_SETTINGS Structure
          • ISO9141_KEYWORD2000_SETTINGS Structure
          • ISO9141_KEYWORD2000__INIT_STEP Structure
          • ETHERNET_SETTINGS Structure
          • ETHERNET_SETTINGS2 Structure
          • OP_ETH_GENERAL_SETTINGS Structure
          • OP_ETH_SETTINGS Structure
          • SPluto_CustomParams Structure
          • UART_SETTINGS Structure
          • RAD_GPTP_SETTINGS Structure
          • LOGGER_SETTINGS Structure
          • DISK_SETTINGS Structure
          • TIMESYNC_ICSHARDWARE_SETTINGS Structure
          • RAD_REPORTING_SETTINGS Structure
          • STextAPISettings Structure
          • gPTP Structures
            • GPTPStatus Structure
            • timestamp Structure
            • priority_vector Structure
            • port_identity Structure
            • clock_quality Structure
            • system_identity Structure
        • NeoDevice Structure
        • NeoDeviceEx Structure
        • stAPIFirmwareInfo Structure
        • Message Structures - neoVI API
        • Status Bitfields - neoVI API
        • Using an array instead of a message structure - intrepidcs API
        • icsSpyTime Structure
        • stCM_ISO157652_TxMessage Structure
        • stCM_ISO157652_RxMessage Structure
        • Valid parameter names for the SetDeviceParameter and GetDeviceParameter methods
        • neoVI API Data Types
        • PhyRegPktClauseMess_t Structure
        • neoVI Network ID List
  • Development FAQ's
    • How do I detect and handle disconnects?
    • How do I set parameters on a neoVI device?
    • How do I open more than one channel on a single piece of hardware? - neoVI API
    • How do I communicate on LIN - neoVI API
    • How do I send a Extended Frame or a High Voltage Wakeup or ISO9141/KW2K Init? - neoVI API
  • Unix-like Operating Systems - Support
  • J2534 Support - neoVI API
  • Vehicle Spy Text API
    • ECU Object - Vehicle Spy Text API
    • Labview Text API Interface to Vehicle Spy 3
  • Vehicle Spy VSB file Spec
  • Contact Us
    • Contact Information - Intrepid Control Systems, Inc
Powered by GitBook
LogoLogo

Applications

  • Cybersecurity
  • Data Logging
  • Simulate ECU Functions
  • Diagnostics, Testing and Validation

Products

  • Vehicle Network Adapters
  • Data Loggers
  • Software
  • Automotive Ethernet Tools

Support

  • Support Resources
  • Contact Support
  • Class Schedule & Registration
  • Training Video Library

Company

  • About
  • News
  • Events
  • Contact Us

Copyright © 2025 | All Rights Reserved

On this page
Edit on GitHub
Export as PDF

Vehicle Spy Text API

Objective

The Text API purpose is to provide a simple text based command set for Vehicle Spy 3 to allow third party applications to take advantage of the power of Vehicle Spy without rewriting much code.

The Text API command set is text based so it can be easily used over many interfaces such as RS232, USB, Ethernet, or Wireless. It is also independent of the operating system or development environment of the host. The command set is similar to what may be found in a programmable instrument consisting of commands and responses.

You can easily write an object or function wrapper around the Text API. This will allow a more convenient use in professional languages such as C#, Java, Visual Basic, LabVIEW, or C/C++. The Text API could also exist as a simple macro language itself.

Tips for Learning

The best way to learn the Text API is to experiment. The Text API terminal in Vehicle Spy 3 is a great tool for this purpose. Also, because most of the commands are based on the XML tags, you can just open the vs3 file in a text editor to see what properties can be manipulated via this extremely flexible API.

Summary of Rules

  • All commands start with the default root object.

  • Commands are separated by a <CR>,<LF> or <CR><LF> combination.

  • Commands are case insensitive. Arguments can be case sensitive if they are text based such as Description properties.

  • All objects and properties have the same text as their XML element names. Properties can be changed by calling out the property and supplying an argument. Property values can be returned by using a question mark ? to query the property.

The following rules are not yet supported

  • There is special encoding to support non ASCII, extended characters, the % escape character, and the ; comment character. Where % will be followed with the Text number in four digit hex form. For example, %000D would equal CR, %000A would be <LF>. The four digit Text allows Unicode support for text arguments such as descriptions.

  • The comment character is the semicolon. After the semicolon all characters are ignored until the next command.

  • The Text API is available as UNICODE via the Vehicle Spy 3 DLL.

Command and Queries

The basic communication consists of commands and queries. Commands set a property or execute a method. Queries request a property.

Commands and Queries will return one of two of possible responses: ok or er. “ok” means that the command completed successfully. “er” means there was a problem with the command. The ok will have text following the command that indicates what command completed and any return values.

Events can be either asked for with a method or can appear asynchronously in the receive stream. You also must specify, or “register”, which events you wish to receive.

Syntax of Commands, Queries, and Events

Type
Syntax of Command
Syntax of Successful Response

Command

methodname {arguments}

ok methodname

Queries

methodname?

ok methodname {propertyvalue}

Examples:

A successful start command

Host: Start

Vehicle Spy 3:ok start

A unsuccessful root command

Host: Startasdf

Vehicle Spy 3: er command not found:startasdf

A successful query

Host: AutoDetectHardware?

Vehicle Spy 3: ok autodetecthardware 1

example: LoadFile Method

This command starts with root object and ends with a carriage return.

Host: loadfile text.vs3<CR>

Vehicle Spy 3: ok loadfile

neoVI PRO Text API

The neoVI PRO supports two APIs, first is the Text API and the second is the neoVI RAW API. The Text API is the default API on the USB, COM, and Ethernet (via TCP) ports; therefore, all of the Text API commands here work with the Vehicle Spy 3 code running in the neoVI PRO.

Using the Text API

The following table indicates how you can interact with the Text API.

Application
Source
Comment

Vehicle Spy 3

Text API Terminal

Allows you to manually type in Text API commands and see their responses.

Vehicle Spy 3

Function Blocks

Allows you to send and receive Text API commands.

Vehicle Spy 3

Java

The Java Environment interacts with Vehicle Spy via the Text API.

Vehicle Spy 3

Via COM or TCP port

Vehicle Spy 3 can act as a COM or TCP server. Setup via Tools/Options.

neoVI PRO

neoVI PRO setup

The neoVI PRO setup allows you to send commands to neoVI PRO on the control panel.

neoVI PRO

via USB, COM and TCP ports

neoVI PRO

Java or Function Block scripts

DLL

The TextAPI method of the icsneo40.dll

Not yet supported.

Root Objects

Command Name
Description
Example

****

Root Objects for Application Signals

all?

returns all application signals that are not remote signals in a key=value comma separated string. This is used to efficiently read all app signals over a slower network.

all?

allsetup?

returns all application signals that are not remote signals in a key=description comma separated string. This is used to efficiently read all app signals descriptions over a slower network.

apprestore

Restores application signals from disk.

appsave

Saves application signals to disk. Application Signals must be enabled for saving. Signals are saved in a file in the same path as the vs3 file. {vs3 file name}.appini

as

as(index or key)

****

Root Objects for Diagnostic Jobs

dg

Accesses a specific diagnostic jobs by an index or a key.

dg(0).start ;starts a diag job.

****

Root Objects for Files and Paths

copyfile

Copies a file in the data directory to another in the data directory. Source and target are separated by a comma. Make sure the file is accessible and not in use.

copyfile MyTestfile.vs3,CopyOfMyTest.vs3

deletefile

Removes a file in the data directory. Make sure the file is accessible and not in use.

deletefile FileToDelete.vs3

dir

Returns the files in the root of the compact flash card or the Vehicle Spy data directory. A filter spec determines which files to return.

dir? *.*

diskspace

returns the amount of diskspace both available and total in kilobytes.

diskspace?

filedetails

Returns information size, time/date on a file in the data directory/neoVI PRO compact flash card.

filedetails? test.vs3

loadfile

Loads a setup file from the data directory. This command should not be called from the same instance of Vehicle spy.

loadfile test.vs3

renamefile

Renames a file in the data directory. The input and output files names are separated by a comma. Make sure the file is accessible and not in use.

renamefile FileName.vs3,NewNameForFile.vs3

status

Returns the loaded file and whether the file is running.

status?

****

Root Objects for Function Blocks

fb

fb.count? ;asks for the number of function blocks

fb(index or key)

fb(1).start ;starts the first function block. fb(tst2).stop ;stops the function block with key tst2.

****

Root Objects for GPS or Joystick

gps

Accesses the GPS object.

gps.latitude? gps.longitude? gps.altitude? gps.speed? gps.isvalid?

JoystickEnabled

Indicates whether the joystick is enabled or not.

JoystickSelected

Indicates which joystick is used.

****

Root Objects for Graphical Panels or User Interface

gp(index or key)

Graphical Panel objects.

gp(index or key).all?

returns all graphical panel control values in a key=value comma separated string. This is used to efficiently read all graphical panel data over a slower network.

gp(dia1).all?

gp(index or key).allsetup?

returns the graphical panel as an XML string.

gpallsetup?

returns all graphical panels in a key=description comma separated string. This is used to efficiently read all panel descriptions over a slower network.

ui

Controls the user interface of neoVI PRO. Described in a separate topic.

Root Objects for Hardware

ao

ao(0).value 3.42

id

Returns the current neoVI PRO firmware ID.

id? ;get the neoVI PRO ID.

io0isoutput or io1isoutput

Returns/Sets whether MISC1 pin is an output or input.

io0isoutput 1 ;make MISC1 and output

io0value

Returns/Sets the value of the MISC 1 pin on neoVI PRO on the DB15 connector.

io0value?

io1value

Returns/Sets the value of the MISC 2 pin on neoVI PRO on the DB15 connector.

io1value 1

ixcbusenabled

Returns/Sets whether the ixcbus is enabled.

ixcbusnetwork

Returns/Sets the network where the IXCBus protocol is used.

****

Root Objects for J1939

j1939dm1srcall

Returns a comma separated list of SRC addresses that have active DTC's

j1939dm1srcall?

J1939dm1src(address)

j1939dm1src(0)?

****

Root Objects for Messages

mg

mg(index or key)

mg(0).clearstats ;clears the stats of first msg

tx

tx.add ;adds a message at the end of the collection and returns new key

tx(index or key)

Accesses a specific transmit message by an index or a key. See the topic on transmit message objects.

tx(1).Arbid 234 ;sets the arb id in hex

****

Root Objects for Simulation

ecu

SimulationEnabled

Sets/Returns whether simulation is used or you are connecting to hardware.

SimulationPath

Sets/Returns the path of the file used for simulation mode.

****

Root Objects for Vehicle Spy

AutoDetectHardware

Sets whether Vehicle Spy will detect hardware or not.

AutoDetectHardware 1 ;sets hardware to autodetect. AutoDetectHardware? ;asks for the autodetect setting.

isrunning

Returns whether if Vehicle Spy is running or not.

isrunning?

Start

Starts Vehicle Spy.

Stop

Stops Vehicle Spy.

timedate

Returns/Sets the time date of the clock.

timedate?

Analog Output Objects

Command Name
Description
Example

calculatefromsignal

Returns/Sets whether analog outputs are automatically calculated using busdecoder mode or can be set via the Text API. The power default is automatically calculated.

ao(0).calculatefromsignal 0 ;allow manual control

EnableCalibratedValues

Returns/Sets whether analog outputs are scaled according to the calibration scaling. Disable this feature to perform calibration.

ao(0).EnableCalibratedValues 0 ;disable for calibration

messagekey

Returns/Sets the key of the message attached to this analog output.

signalkey

Returns/Sets the key of the signal attached to this analog output. This is used in conjunction with signal key.

value

Returns/Sets the value of the output. This is only valid if calculatefromsignal is false.

ao(0).value 3.21 ;sets output to 3.21V

Collection Objects

Command Name
Description
Example

Additem

Adds an item to the end of the collection.

fb.additem ;adds an item to the end of the collection.

Count

Indicates how many items in the collection. Read only.

tx.count? ;how many tx messages are defined?

DeleteAllObjects

Removes all items from the collection.

as.deleteallobjects ;remove all of the app signals.

KeyExists

Determines if the specified key exists in the collection.

tx.keyexists out0 ;does this key exist in the collection?

ReturnIndexFromKey

Finds the key in the collection and returns the index. If the key is not found it returns -1.

tx.returnindexfromkey out0

Function Block Objects

Command Name
Description
Example

save

Saves the function block data.

start

Starts the function block.

fb(0).start ;starts the first function block.

stop

Stops the function block.

trigger

Triggers the function block.

J1939 Objects

Command Name
Description
Example

dtc(code).spn

Returns the SPN number for requested DTC (specified by code)

j1939dm1src(0).dtc(0).spn?

dtc(code).FMI

Returns the FMI number for requested DTC (specified by code)

j1939dm1src(0).dtc(0).fmi?

dtc(code).oc

Returns the OC number for requested DTC (specified by code)

j1939dm1src(0).dtc(0).co?

Message Objects

Command Name
Description
Example

ByteStringX

Sets the filter bytes for a network in hex.

mg(0).ByteString0 110

CFTimeOutsMs

Specifies the Consecutive Frame timeout in milliseconds.

ClearStats

Clears all statistical information associated with the message. Does not clear signal stats.

mg(0).ClearStats

Compile

Compiles filter bytes and equations and then makes changes activate.

Description {Text Description}

Sets the description for a message.

Set the description for message number 4 as Engine Data: mg(3).description Engine Data<CR>

DisplayColor

Sets/Returns the color the message is displayed with.

mg(0).DisplayColor 0 ;display black

EnableISO15765

This enables long messaging on CAN based off of ISO15765.

EnRxEvent {Return Msg, Return Value, Return Stats}

.sg(in3433).EnRxEvent

ExpectedLength

Sets the expected length of a specific message.

FlowCArbID

Sets/Returns CAN id used for the flow control frame in iso15765 messaging.

FlowCBlockSize

Sets/Returns the block sized used in long can messaging.

FlowCSTmin

Sets/Returns the flow control STMin.

refresh

Updates message table. This is useful when making changes to messages via text API

mg.refresh

sg

sg(index or key)

sg(0).value? ;Asks for the Value of the first signal

Signal Objects

Command Name
Description
Example

****

****

****

value

Sets/Gets the value.

Description {Text Description}

Sets the description for a signal.

Set the description for signal number 4 as throttle position: mg(0).sig(3).description Throttle Position<CR>

DisplayColor

Sets/Returns the color the message is displayed.

mg(0).DisplayColor 0 ;display black

Equation

Gets/Sets the equation.

Format

Get/Sets the equation format.

refresh

Updates signal information. This is useful when making changes to signals via text API.

ASCII Chart

    0   1   2   3   4   5   6   7   8   9   A   B   C   D   E   F
0  NUL SOH STX ETX EOT ENQ ACK BEL BS  HT  LF  VT  FF  CR  SO  SI
1  DLE DC1 DC2 DC3 DC4 NAK SYN ETB CAN EM  SUB ESC FS  GS  RS  US
2   SP  !   "   #   $   %   &   '   (   )   *   +   ,   -   .   /
3   0   1   2   3   4   5   6   7   8   9   :   ;   <   =   >   ?
4   @   A   B   C   D   E   F   G   H   I   J   K   L   M   N   O
5   P   Q   R   S   T   U   V   W   X   Y   Z   [   \   ]   ^   _
6   `   a   b   c   d   e   f   g   h   i   j   k   l   m   n   o
7   p   q   r   s   t   u   v   w   x   y   z   {   |   }   ~ DEL
PreviousJ2534 Support - neoVI APINextECU Object - Vehicle Spy Text API

Last updated 2 years ago

Accesses the collection of Application Signals. See the topic on .

Accesses a specific application signal by an index or a key. Set the topic on objects.

Accesses the collection of Function Blocks. See the topic on .

Accesses a specific function block by an index or a key. Set the topic on objects.

Accesses a specific by an index or a key. See the topic on transmit message objects.

; also returns list of DTCs for specified address

Accesses the collection of Messages. See the topic on .

Accesses a specific by an index or a key. See the topic on message objects.

Accesses the collection of Transmit Messages. See the topic on .

Accesses the ecu subobject. This is discussed in a .

Accesses the collection of Signals. See the topic on .

Accesses a specific by an index or a key. See the topic on message objects.

separate topic
Collection Objects
Signal
Collection Objects
function block
analog outputs
J1939 Object
Collection Objects
message object
Collection Objects
collection objects
Signal object