FieldServer FS-8700-56 Caterpillar M5X

FieldServerFS-8700-56 Caterpillar M5XDriver Manual(Supplement to the FieldServer Instruction Manual)APPLICABILITY & EFFECTIVITYEffective for all systems manufactured after November 2015Kernel Version:Document Revision:1.041

FS-8700-56 Caterpillar M5X Driver ManualContact Information:Thank you for purchasing the FieldServer.Please call us for Technical support of the FieldServer product.Contact Information:Sierra Monitor Corporation1991 Tarob CourtMilpitas, CA 95035Contact number: 1 408 262-6611 1 800 727-4377Email: info@sierramonitor.comWebsite: www.sierramonitor.comContact Information

FS-8700-56 Caterpillar M5X Driver ManualTABLE OF CONTENTS1Caterpillar M5X Driver Description . 42Driver Scope of Supply . 42.1Supplied by Sierra Monitor Corporation for this driver. . 4rd2.2Provided by Supplier of 3 Party Equipment. 43Hardware Connections . 53.1Hardware Connection Hints/Tips . 54Data Array Parameters . 65Configuring the FieldServer as a Caterpillar M5X Client . 75.1Client Side Connection Parameters . 75.2Client Side Node Parameters . 85.3Client Side Map Descriptor Parameters . 85.3.15.3.25.3.35.3.45.3.56FieldServer Specific Map Descriptor Parameters . 8Driver Specific Map Descriptor Parameters . 9Timing Parameters . 9Map Descriptor Example 1 . 10Map Descriptor Example 2 . 11Configuring the FieldServer as a Caterpillar M5X Server . 126.1Server Side Connection Descriptors . 126.2Server Side Node Descriptors . 126.3Server Side Map Descriptors . 136.3.16.3.26.3.36.3.4FieldServer Specific Map Descriptor Parameters . 13Driver Specific Map Descriptor Parameters . 13Timing Parameters . 14Map Descriptor Example. . 15Appendix A. Useful Features . 16Appendix A.1. Data Retrieval from Multiple Hosts . 16Appendix A.2. Passwords . 16Appendix A.2.1. Example 1 – Cat device has blank password. . 16Appendix A.2.2. Example 2 – Cat device has password. . 16Appendix A.2.3. Example 3 – Password causes Configuration file Errors. . 17Appendix A.3. Scaling . 17Appendix A.3.1. Using the driver as a Server . 17Appendix A.4. Map Descriptor Lengths . 17Appendix B. Reference . 18Appendix B.1. Node ID’s . 18Appendix B.2. Engine Parameter Keywords & PID’s . 19Appendix B.3. Data Extraction Methods . 23Appendix B.4. Driver Error Messages . 24Appendix B.5. Driver Stats . 26LIST OF FIGURESFigure 1 - Generic Connection Diagram . 5Table of Contents

FS-8700-56 Caterpillar M5X Driver Manual1CATERPILLAR M5X DRIVER DESCRIPTIONThe Caterpillar M5X driver allows the FieldServer to transfer data to and from devices over RS-232 usingCaterpillar M5X protocol. The FieldServer can emulate either a Server or Client.The driver is capable of communications with any device that uses the Caterpillar M5X protocol but hasbeen designed primarily for connection to a Caterpillar CCM which is in turn connected to the Caterpillarengines to be monitored/controlled.The driver provides a limited set of M5X protocol commands and may address a sub-set of theparameters available in each device. Details are available in 0.The driver provides formal support for 3500 engines and EMCPII devices only. Other devices may bepolled using the address of the parameter required as opposed to user friendly parameter names.Establishing the correct Node ID’s for the engines being communicated with can be challenging andrequires careful research. See Appendix B.1 for further details.22.1DRIVER SCOPE OF SUPPLYSupplied by Sierra Monitor Corporation for this driver.Sierra Monitor Corporation PART #FS-8917-042.2DescriptionRJ45 to DB25M connection adapterProvided by Supplier of 3 rd Party EquipmentPart #DescriptionCaterpillar CCM ModulePower SupplyPage 4 of 27

FS-8700-56 Caterpillar M5X Driver Manual3HARDWARE CONNECTIONSThe FieldServer is connected to the Caterpillar CCM module as shown below.Configure the Caterpillar CCM module according to manufacturer’s instructions.RS232FieldServerCABLE ANUALDRIVER, CATERPILLAR M5XBASE NAME:FILE NAME: T28700-56.VSDDATE: 5/31/01BY:MNFigure 1 - Connection Diagram3.1Hardware Connection Hints/Tips The FieldServer cannot be connected directly to the generator/engine controller but must beconnected via the CCM module. To establish the caterpillar Node ID, set the Node ID to 0 in the configuration. Watch the errorscreen on reboot - the remote device will send a message back with an error stating that it cannotaccept a response message from a certain Node ID. That Node ID is the relevant Node ID.Page 5 of 27

FS-8700-56 Caterpillar M5X Driver Manual4DATA ARRAY PARAMETERSData Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It isnecessary to declare the data format of each of the Data Arrays to facilitate correct storage of the relevantdata.Section TitleData ArraysColumn TitleFunctionData Array NameProvide name for Data ArrayData Array FormatProvide data format. Each Data Array can onlytake on one format.Data Array LengthNumber of Data Objects. Must be larger thanthe data storage area required by the MapDescriptors for the data being placed in thisarray.Example// Data ArraysData ArraysData Array NameDA AI 01DA AO 01DA DI 01DA DO 01, Data Array Format, UInt16, UInt16, Bit, Bit, Data Array Length, 200, 200, 200, 200Page 6 of 27Legal ValuesUpto15alphanumericcharactersFLOAT, BIT, UInt16, SInt16,Packed Bit, Byte, Packed Byte,Swapped Byte1-10, 000

FS-8700-56 Caterpillar M5X Driver Manual5CONFIGURING THE FIELDSERVER AS A CATERPILLAR M5X CLIENTFor a detailed discussion on FieldServer configuration, please refer to the FieldServer ConfigurationManual. The information that follows describes how to expand upon the factory defaults provided in theconfiguration files included with the FieldServer (See “.csv” files provided).This section documents and describes the parameters necessary for configuring the FieldServer tocommunicate with a Caterpillar M5X Server.The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order toenable the FieldServer for Caterpillar M5X communications, the driver independent FieldServer buffersneed to be declared in the “Data Arrays” section, the destination device addresses need to be declared inthe “Client Side Nodes” section, and the data required from the servers needs to be mapped in the “ClientSide Map Descriptors” section. Details on how to do this can be found below.Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.5.1Client Side Connection ParametersSection TitleConnectionsColumn TitlePortFunctionSpecify which port the device is connected tothe FieldServerBaud*Specify baud rateParity*Data Bits*Stop Bits*ProtocolPoll Delay*Specify paritySpecify data bitsSpecify stop bitsSpecify protocol usedTime between internal pollsSpecify whether it is necessary to re-login fornext transaction if target Node is differentfrom current node. See Appendix A.1 fordetail.ApplicationLegal ValuesP1-P81110 – 115200, standard baud ratesonly. ,9600.None7, 81CATM5X0-32000s, 1sSingle Node, MultidropExample//Client Side ConnectionsConnectionsPortP1, Baud, 9600, Parity, None, Protocol, CatM5X, Poll Delay, 0.100s1, Application, MultidropNot all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the portsavailable on specific hardware.Page 7 of 27

FS-8700-56 Caterpillar M5X Driver Manual5.2Client Side Node ParametersSection TitleNodesColumn TitleNode NameNode IDProtocolPortPassword*FunctionProvide name for nodeThe address of the device (engine)connected to the CCM module to be polled.This is also termed the UNIT number orUNIT ID of the engine being polled. Referto Appendix B.1 for more information.Specify protocol usedSpecify which port the device is connectedto the FieldServerSpecify the node password. The driver logsin to the Cat device before it starts polling.Additional notes provided in Appendix A.2Legal ValuesUp to 32 alphanumeric characters0-255CATM5XP1-P82Max 8 Alpha-Numeric characters, nologin, -Example//Client Side NodesNodesNode NameEngine1Generator5.3, Node ID, 33, 88, Protocol, CATM5X, CATM5X, Port, P8, P1, Password,,-Client Side Map Descriptor Parameters5.3.1 FieldServer Specific Map Descriptor ParametersColumn TitleMap Descriptor NameData Array NameFunctionName of this Map DescriptorName of Data Array where data is tobe stored in the FieldServerData Array LocationStarting location in Data ArrayFunctionFunction of Client Map Descriptor2Legal ValuesUp to 32 alphanumeric charactersOne of the Data Array names fromSection 40 to (Data Array Length -1) asspecified in Section 4)Rdbc, Wrbc, WrbxNot all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the portsavailable on specific hardware.Page 8 of 27

FS-8700-56 Caterpillar M5X Driver Manual5.3.2 Driver Specific Map Descriptor ParametersColumn TitleFunctionNode NameName of Node to fetch data s how many Data Array storage locations are reservedfor the Map Descriptor. Additional information is provided inAppendix A.4Each parameter has been allocated a name.Use theparameter name with this keyword to tell the driver whichparameter in the engine or generator to be read / written.1, 2 .Refer to 0.The parameter may be specified in this alternate format in caseparameters are added by Caterpillar for which this driver has nokeyword description and for engines unknown to this driver.Use catPID1 & catPID2. Specify the values in the hexadecimalformat provided in the caterpillar documentation.E.g.CatPID1 00CatPID2 F8Used to override the data extraction method - allows the driverto parse messages with unknown parameters. The methodparameter depends on the number and arrangement of databytes. A table is provided in Appendix B.3Non zerointegers.5.3.3 Timing ParametersColumn TitleScan IntervalLegal ValuesOne of the Nodenames specified inSection 5.2.FunctionRate at which data is polledLegal Values 0.1sPage 9 of 27positive

FS-8700-56 Caterpillar M5X Driver Manual5.3.4 Map Descriptor Example 1In this example the driver reads the hour meter from a node called Engine 5.//Client Side Map DescriptorsMap DescriptorsMap Descriptor NameENGINE5 HOURS, Data Array Name, HOUR DATAMap Descriptor names are usedby the driver when printingvalidation errors.Data read by this Map Descriptor willbe placed in a Data Array calledHOUR DATA., Data Array Offset,5The result of this pollwill be stored inarray element indexth5 (6 element as thefirst element has anindex of zero.)., Function, Rdbc, Node Name, Engine5, Scan Interval,5Read continuously.This node name connects this MapDescriptor to a Node definition which in turnis connected to a port. This Map Descriptoris thus uniquely tied to a port. It is thuspossible to process engines with duplicateunit numbers (Node ID) as long as they areconnected to different ports.Page 10 of 27, CatParam, ECM Hourmeter, Length,1This Map Descriptor reads oneparameter from the engine. Theparameter must be spelled in exactlythe same way as in 0. The singlespace between ECM and Hourmeteris important as is the lack of a spacebetween Hour & meter. The spacepreceding ECM and followingHourmeter is not important.