RP 1210D - Windows (TM) Communication API

• RP 1210D - Windows(TM) Communication API
  • VMRS
  • Preface
  • Purpose And Scope
    • Notes
    • Technical Disclaimer
  • RP 1210 Revision Background
    • Notes
    • Backward Compatibility
    • Operating System (Os) Support Information
    • Document Conventions
  • RP 1210 Compliance Defined
    • Notes
    • RP 1210D-Compliant VDA
    • RP 1210D-Compliant Application
    • RP1210D-Compliant Applications And Supported VDAS
    • RP1210 And 64-Bit Applications
  • High-Level RP 1210 Interface Concept And Design
    • Notes
    • Design
  • Functional Specification
    • Required High-Level Functionality
    • API File Naming Conventions
  • RP 1210 Overview For The Application Developer
    • Notes
    • API Interface At A Glance
    • Step 1 - Parsing Of The RP1210 INI Files
    • Step 2 - Which Adapter To Use?
      • Notes
      • Post RP 1210D
    • Step 3 - Opening DLL And Getting Function Pointers
    • Step 4 - Connecting To The DATABUS
    • Step 5 - Allow Reception Of Messages
    • Step 6 - Read A Message
    • Step 7 - Send A Message
    • Step 8 - Closing The Interface And Freeing Resources
  • RP 1210 Variables And Initial States
    • Notes
    • Echo Mode
    • J1708MODE And RP 1210B Enhancements
    • ISO9141/ISO14230 Mode
    • FILTERSTATES
    • Blocking Mode
    • Blocking Timeout
  • RP 1210 Required Functions
  • VDA And Application Developer Notes
    • Unexpected Vehicle Interface Adapter Disconnect
    • Error Code 142 And Backward Compatibility
    • Notes On Higher Layer Can Protocol Coexistence
      • Notes
      • RP1210B And ISO15765 Compatibility Issue
    • Notes On Wireless VDAS And Time/Code-Sensitive Applications
    • The "Name" Parameter In The "VENDORINFORMATION" INI Section
    • Single Wire, Fault Tolerant, PTCAN, And IESCAN Can Protocols
    • The Can Identifier On Can-Based Protocols
    • Notes On J1939 Address Claim (Single Application)
      • Notes
      • Possible Transport Protocol Layer Conflict And Resolution
    • Notes On J1939 At 500K (J1939-14) And Auto Baud Rate Detection
    • VDA Behavior For RP1210_CLIENTCONNECT () And Auto Baud
    • Can Auto Baud And Non-Auto-Baud Applications
    • Example INI Files With Various Protocol Speeds And Auto Baud
    • Applications Doing Auto-VDA-Detection (Not Recommended)
    • Blocking/Non-Blocking Considerations For App Developers
    • Queue Full Characteristics For VDA Developers
      • Notes
      • Err_TX_Queue_Full
      • Err_RX_Queue_Full
    • Filter State Ambiguities
    • Filter Clarifications - More Than 1 Per SENDCOMMAND () Call
      • Notes
      • J1708/J1587 Parameter Id (PID) Filtering
      • Inclusive And Exclusive Filtering
    • INI File Versus Registry And XML
    • NISAPPPACKETIZINGINCOMINGMSGS And J1939 Transport Protocol
    • J1939 Bam, No Longer Need To Claim An Address
    • Windows User Access Control (UAC) And RP 1210-Compliancy
      • Notes
      • Compliancy For VDA Vendors
      • Compliancy For Application Developers
  • Compliance For API/VDA Vendors
    • Notes
    • All RP 1210 Functions To Be Supported
    • RP1210_CLIENTCONNECT () Functions To Be Supported
    • RP1210_SENDCOMMAND Functions To Be Supported
  • RP1210_CLIENTCONNECT ()
  • RP1210 CLIENTCONNECT () Prototype
    • Notes
    • RP1210_CLIENTCONNECT () Parameters
    • RP1210_CLIENTCONNECT () Return Value
    • RP1210_CLIENTCONNECT () Notes
      • Notes
      • Multiple Can Protocols On One Can Channel; Multiple Baud Rates (J1939/J1708)
    • RP1210_CLIENTCONNECT () Protocol Connection String
      • Notes
      • Example
      • Device-Centric Versus Protocol-Centric
      • RP 1210B (And Later) -Compliance: INI File Shall Be Device-Centric With No Invented Protocols
    • The Null Protocol
    • Using "Protocol" To Signify A Transport Protocol For Can-Based Protocols
    • Using TCP/IP And DNS As A Transport Layer For A Protocol
    • Using A Modem As A Transport Layer For A Protocol
    • Setting Can Baud Rate On RP1210_CLIENTCONNECT ()
      • Notes
      • Setting Can Baud Rate - Format 1
      • Setting Can Baud Rate - Format 2
      • Setting Can Baud Rate - Format 3
      • Setting Can Baud Rate - Format 4 - Default
      • Setting Can Baud Rate - Format 5
    • Setting Can/J1939/ISO15765 Channel On RP1210_CLIENTCONNECT ()
    • Setting J1708 Baud Rate On RP1210_CLIENTCONNECT ()
      • Notes
      • Setting J1708 Baud Rate - Format 1
      • Setting J1708 Baud Rate - Format 2 - Default
    • Setting J1939 Baud Rate On RP1210_CLIENTCONNECT ()
      • Notes
      • Setting J1939 Baud Rate - Format 1
      • Setting J1939 Baud Rate - Format 2 - Default
      • Setting J1939 Baud Rate - Format 3
      • Setting J1939 Baud Rate - Format 4
      • Setting J1939 Baud Rate - Format 5
    • Setting ISO15765-2 Baud Rate On RP1210_CLIENTCONNECT ()
      • Notes
      • Setting ISO15765 Baud Rate - Format 1
      • Setting ISO15765 Baud Rate - Format 2 - Default
    • Multiple RP1210_CLIENTCONNECT () Strings
  • RP1210_CLIENTDISCONNECT ()
    • Notes
    • RP1210_CLIENTDISCONNECT () Prototype
    • RP1210_CLIENTDISCONNECT () Parameters
    • RP1210_CLIENTDISCONNECT () Return Value
    • RP1210_CLIENTDISCONNECT () Notes
  • RP1210_SENDMESSAGE ()
    • Notes
    • Note To Application Vendors
    • RP1210_SENDMESSAGE () Prototype
    • RP1210 SENDMESSAGE () Parameters
    • RP1210_SENDMESSAGE () Return Value
    • Formatting A J1708/Plc Message For RP1210_SENDMESSAGE ()
    • Formatting A J1939 Message For RP1210_SENDMESSAGE ()
    • Formatting A Can Message For RP1210_SENDMESSAGE ()
    • Formatting A J1850 Message For RP1210_SENDMESSAGE ()
    • Formatting An ISO15765 Message For RP1210_SENDMESSAGE ()
    • Formatting AISO9141/ISO14230 Message For RP1210_SENDMESSAGE ()
  • RP1210_READMESSAGE()
    • Notes
    • RP1210_READMESSAGE () Prototype
    • RP1210_ READMESSAGE () Parameters
    • RP1210_ Re A Dm Ess A GE () Return Value
    • The J1708/Plc Message From RP1210_READMESSAGE ()
    • The J1939 Message From RP1210_READMESSAGE ()
    • The Can Message From RP1210_READMESSAGE ()
    • The J1850 Message From RP1210_READMESSAGE ()
    • The ISO15765 Message From RP1210_READMESSAGE ()
    • The ISO9141/ISO14230 Message From RP1210_READMESSAGE ()
  • RP1210_READVERSION ()
    • Notes
    • RP1210_READVERSION () Prototype
    • RP1210_READVERSION () Parameters
    • RP1210_READVERSION () Return Value
  • RP1210_READDETAILED () Version
    • Notes
    • RP1210 READDETAILED () Version Prototype
    • RP1210_READDETAILED () Version Parameters
    • RP1210_READDETAILED () Version Return Value
  • RP1210_GETERRORMSG ()
    • Notes
    • RP1210_GETERRORMSG () Prototype
    • RP1210_GETERRORMSG () Parameters
    • RP1210_GETERRORMSG () Return Value
  • RP1210_GETLASTERRORMSG ()
    • Notes
    • RP1210_GETLASTERRORMSG () Prototype
    • RP1210_GETLASTERRORMSG () Parameters
    • RP1210_GETLASTERRORMSG () Return Value
  • RP1210_GETHARDWARESTATUS ()
    • Notes
    • Fall 2010 Task Force Discussions-Background Notes
    • Changes Made To RP 1210C
      • NBLOCKONREQUEST Ignored
      • NLNFOSIZE Changed To 64 Bytes
      • VDAS Return Success And Only Populate Number Of Bytes The Application Requested
      • Application Developer Notes
      • VDA Vendor And Application Developer Notes On The FPCHCLIENTLNFO Buffer
    • RP1210_GETHARDWARESTATUS () Prototype
    • RP1210_GETHARDWARESTATUS () Parameters
    • RP1210_GETHARDWARESTATUS () Return Value
    • Information Returned In FPCHCLIENTLNFO
      • Notes
      • Hardware Status (Bytes 0-1)
      • J1939 (Bytes 2-3)
      • J1708 (Bytes 4-5)
      • Can (Bytes 6-7)
      • J1850 (Bytes 8-9)
      • Vendor 1, 2, 3 (Bytes 10/11,12/13,14/15)
      • ISO15765 (Bytes 16-17)
      • ISO9141 (Bytes 18-19)
      • ISO14230 (Bytes 20-21)
  • RP1210_GETHARD WA RESTATUSEX ()
    • Notes
    • Application Developer Notes
    • VDA Vendor Notes
    • RP1210 GETHARDWARESTATUSEX () Prototype
    • RP1210_GETHARDWARESTATUSEX () Parameters
    • RP1210_GETHARDWARESTATUSEX () Return Value
    • Buffer Information
    • Information Returned In FPCHCLIENTLNFO
      • Hardware Information (Bytes 00-07)
      • J1708 (Bytes 08-15)
      • J1850VPW (Bytes 24-31) - Same As J1708
      • J1850PWM (Bytes 32-39) - Same As J1708
      • ISO9141 (Bytes 40-47) - Same As J1708
      • ISO14230 (Bytes 48-55) - Same As J1708
      • Can Channel 1 (Bytes 64-71)
      • Can Channel 2 (Bytes 72-79) - Same As Can Channel 1
      • Can Channel 3 (Bytes 80-87) - Same As Can Channel 1
      • Can Channel 4 (Bytes 88-95) - Same As Can Channel 1
      • Reserved (Bytes 96-255)
  • RP1210_SENDCOMMAND ()
    • Notes
    • RP1210_SENDCOMMAND () Prototype
    • RP1210_SENDCOMMAND () Parameters
    • RP1210_SENDCOMMAND () Return Value
    • Values For The NCOMMANDNUMBER Parameter
    • RP1210_ Reset_Device
      • Notes
      • RP1210_ Reset_Device Return Value
    • RP1210_Set_All_Filters_States_To_Pass
      • Notes
      • RP1210_Set_AII_Filter_States_To_Pass Return Value
    • RP1210_Set_Message_Filtering_For_J1939
      • Notes
      • J1939 Filter Parameter Frame
      • RP1210_Set_Message_Filtering_For_J1939 Return Value
    • RP1210_Set_Message_Filtering_For_Can
      • Notes
      • Can Filter Parameter Frame
      • Standard Can (11-Bit Identifier) Example
      • RP1210_Set_Message_Filtering_For_Can Return Value
    • RP1210_Set_Message_Filtering_For_J1708
      • Notes
      • RP1210_Set_Message_Filtering_For_J1708 Return Value
    • RP1210_Set_Message_Filtering_For_J1850
      • Notes
      • RP1210_Set_Message_Filtering_For_ J1850 Return Value
    • RP1210_Set_Message_Filtering_For_ISO15765
      • Notes
      • ISO15765 Filter Parameter Frame
      • RP1210_Set_Message_Filtering_For_ISO15765 Return Value
    • RP1210_Generic_Driver_Command
      • Notes
      • RP1210_Generic_Driver_Command Return Value
    • RP1210_Set_J1708_Mode
      • Notes
      • RP1210_Set_J1708_Mode Return Value
    • RP1210_Set_ISO9141ISO14230_Mode
      • Notes
      • RP1210_Set_ISO9141ISO14230_Mode Return Value
    • RP1210_Echo_ Transmitted_Messages
      • Notes
      • RP1210_Echo_Transmitted_Messages Return Value
    • RP1210_Set_All_Filters_States_To_Discard
      • Notes
      • RP1210_Set_AII_Filter_States_To_Discard Return Value
    • RP1210_Set_Message_Receive
      • Notes
      • RP1210_Set_MESSAAE_Receive Return Value
    • RP1210_Protect_J1939_Address
      • Notes
      • Behavior When Connecting To A Network Without Other Controllers Transmitting
      • J1939 Address Claim Frame
      • RP1210_ Protect_J1939_Address Return Value
    • RP1210_Release_J1939_Address
      • Notes
      • J1939 Address Release Frame
      • RP1210_ Release_J1939_Address Return Value
    • RP1210_Set_Broadcast_For Protocol
      • Notes
      • Broadcast List Entry (FPCHCLIENTCOMMAND)
      • Message Time Tuple Record
      • List Behaviors
      • Return Value. All Function Calls
    • RP1210_Set_BLOCKTIMEOUT
      • Notes
      • RP1210_Set_BLOCKTIMEOUT Return Value
    • RP1210_Set_J1708_Baud
      • Notes
      • RP1210_Set_J1708_Baud Return Value
    • RP1210_Set_J1850_Baud
      • Notes
      • RP1210_Set_J1850_Baud Return Value
    • RP1210_Set_J1939_Baud
      • Notes
      • RP1210_Set_J1939_Baud Return Value
    • RP1210_Set_Can_Baud
      • Notes
      • RP1210_Set_Can_Baud Return Value
    • RP1210_Set_ISO15765_Baud
      • Notes
      • RP1210_Set_ISO15765_Baud Return Value
    • RP1210_Set_ Protocol Filter_Type
      • Notes
      • RP1210_Set_J1708/J1939/J1850/ISO15765/Can_Filter_Type Return Value
      • Example (RP1210A = Inclusive)
      • Example (RP1210B/C = Exclusive)
    • RP1210_Set_J1939_INTERPACKET_Time
      • Notes
      • RP1210_Set_J1939_LNTERPACKET_Time Return Value
    • RP1210_Set_MAXERRORMSGSIZE
      • Notes
      • RP1210 Set MAXERRORMSGSIZE Return Value
    • RP1210_Disallow_Further_Connections
      • Notes
      • RP1210_Disallow_Further_Connections Return Value
    • RP1210_Set_ISO15765_Flow_Control
      • Notes
      • ISO15765 Flow Control Parameter Frame
      • RP1210_Set_ISO15765_Flow_Control Return Value
    • RP1210_Clear_ISO15765_Flow_Control
      • Notes
      • RP1210_Clear_ISO15765_Flow_Control Return Value
    • RP1210_Flush_TX_RX_Buffers
      • Notes
      • RP1210_Flush_TX_RX_Buffers Return Value
    • RP1210_Get_Protocol_Connection_Speed
      • Notes
      • RP1210_Get_Protocol_Connection_Speed Return Value
    • RP1210_Get_Wireless_State
      • Notes
      • RP1210_Get_Wireless_State Return Value
  • RP1210_Ioctl ()
    • Notes
    • RP1210_Ioctl () Prototype
    • RP1210_Ioctl () Parameters
    • RP1210_Ioctl () Return Values
    • Ioctl Id Values
    • LOCTL Section
      • Notes
      • Get_CONFIG
      • Set_CONFIG
      • Five_Baud_INIT
      • Read_Pin_ Voltage (0X03)
      • FASTJNIT
        • Notes
        • ISO9141 Connection - Default Configuration
        • ISO14230 Connection - User Specified Configuration
    • ISO9141_K_Line_Only
  • INI File Format
    • Case Sensitivity
    • INI File Text Encoding
    • INI File Maximum Entry Length (512 Characters)
    • The File Format And Parsing Of The RP 1210 INI Files
      • Notes
      • Application Developer Note - Missing DLL
    • Mangled RP121032.INI - Detecting And Correcting
    • VDAAPI Installation Program Instructions And Notes
      • Notes
      • Step 1 - Check For RP121032.INI File, Create If Non-Existent
      • Step 2 - Append Your Entry To APIIMPLEMENTATIONS
      • Step 3 - Clean Up The INI File
      • Using And/Or Creating The Vendor INI File
    • The [VENDORINFORMATION] Section Of The Vendor INI File
    • The [DEVICEINFORMATIONDX] Section Of The INI File
    • The [PROTOCOLINFORMATIONPX] Section Of The INI File
    • Example VDA Vendor INI File
    • API Vendor Header File
  • RP 1210 C# Addendum
  • Debug File Format
  • Multi-Application Addendum
    • Notes
    • RP 1210 Compliant - Multi-Application/Multi-Client (Ma/MC)
    • RP 1210 Compliant - Single-Application/Multi-Client (SA/MC)
    • RP 1210 Compliant - Single-Application/Dual-Client (SA/Dc)
    • RP 1210-Compliant - Single-Application/Single-Client (SA/SC)
  • RP1210_SENDMESSAGE () Formats
  • RP1210_READMESSAGE () Message Formats
  • Non-Windows Cross Platform Addendum
    • Notes
    • Any Non-Windows Implementation Is Not RP 1210-Compliant
    • RP1210 Is Essentially Platform Independent
    • Specifying Concepts For Any Non-Windows Platform
    • MICROSOFT Windows CE
      • Notes
      • File Placement
      • System APIS
      • API Changes
    • UNIX, LINUX And UNIX Variants
      • Notes
      • Accounts, Groups, Files, And Permissions
      • System APIS
      • API Changes
      • RP 1210 So (Shared Object) Files
      • RP 1210 Includes, Type Definitions, And Function Declarations For UNIX
    • Mobile Platform Addendum (I.E., IOS, Android)
  • Changes From RP1210C To RP1210D
  • Changes From RP 1210B To RP 1210C
  • Terminology
  • References
  • Revision