Back to EveryPatent.com
United States Patent | 6,267,061 |
Katzer | July 31, 2001 |
A system which operates a digitally controlled model railroad transmitting a first command from a first client program to a resident external controlling interface through a first communications transport. A second command is transmitted from a second client program to the resident external controlling interface through a second communications transport. The first command and the second command are received by the resident external controlling interface which queues the first and second commands. The resident external controlling interface sends third and fourth commands representative of the first and second commands, respectively, to a digital command station for execution on the digitally controlled model railroad.
Inventors: | Katzer; Matthew A. (Portland, OR) |
Assignee: | KAM Industries (Hillsboro, OR) |
Appl. No.: | 550904 |
Filed: | April 17, 2000 |
Current U.S. Class: | 105/1.5; 105/1.4; 105/29.2; 246/62; 246/297; 701/19; 701/20 |
Intern'l Class: | A63H 019/00 |
Field of Search: | 105/1.5,1.4,29.2 246/197,62 701/19,20 |
4853883 | Aug., 1989 | Nickles et al. | |
5475818 | Dec., 1995 | Molyneaux et al. | |
5681015 | Oct., 1997 | Kull. | |
5787371 | Jul., 1998 | Balukin et al. | |
6065406 | May., 2000 | Katzer | 105/1. |
David Chappell, Understanding Activex and Ole from Strategic Technology Series, pp. 1-329; at least, one year prior to filing date. |
Table of contents 1. OVERVIEW 1.1 System Architecture 2. TUTORIAL 2.1 Visual BASIC Throttle Example Application 2.2 Visual BASIC Throttle Example Source Code 3. IDL COMMAND REFERENCE 3.1 Introduction 3.2 Data Types 3.3 Commands to access the server configuration variable database KamCVGetValue KamCVPutValue KamCVGetEnable KamCVPutEnable KamCVGetName KamCVGetMinRegister KamCVGetMaxRegister 3.4 Commands to program configuration variables KamProgram KamProgramGetMode KamProgramGetStatus KamProgramReadCV KamProgramCV KamProgramReadDecoderToDataBase KamProgramDecoderFromDataBase 3.5 Commands to control all decoder types KamDecoderGetMaxModels KamDecoderGetModelName KamDecoderSetModelToObj KamDecoderGetMaxAddress KamDecoderChangeOldNewAddr KamDecoderMovePort KamDecoderGetPort KamDecoderCheckAddrInUse KamDecoderGetModelFromObj KamDecoderGetModelFacility KamDecoderGetObjCount KamDecoderGetObjAtIndex KamDecoderPutAdd KamDecoderPutDel KamDecoderGetMfgName KamDecoderGetPowerMode KamDecoderGetMaxSpeed 3.6 Commands to control locomotive decoders KamEngGetSpeed KamEngPutSpeed KamEngGetSpeedSteps KamEngPutSpeedSteps KamEngGetFunction KamEngPutFunction KamEngGetFunctionMax KamEngGetName KamEngPutName KamEngGetFunctionName KamEngPutFunctionName KamEngGetConsistMax KamEngPutConsistParent KamEngPutConsistChild KamEngPutConsistRemoveObj 3.7 Commands to control accessory decoders KamAccGetFunction KamAccGetFunctionAll KamAccPutFunction KamAccPutFunctionAll KamAccGetFunctionMax KamAccGetName KamAccPutName KamAccGetFunctionName KamAccPutFunctionName KamAccRegFeedback KamAccRegFeedbackAll KamAccDelFeedback KamAccDelFeedbackAll 3.8 Commands to control the command station KamOprPutTurnOnStation KamOprPutStartStation KamOprPutClearStation KamOprPutStopStation KamOprPutPowerOn KamOprPutPowerOff KamOprPutHardReset KamOprPutEmergencyStop KamOprGetStationStatus 3.9 Commands to configure the command station communication port KamPortPutConfig KamPortGetConfig KamPortGetName KamPortPutMapController KamPortGetMaxLogPorts KamPortGetMaxPhysical 3.10 Commands that control command flow to the command station KamCmdConnect KamCmdDisConnect KamCmdCommand 3.11 Cab Control Commands KamCabGetMessage KamCabPutMessage KamCabGetCabAddr KamCabPutAddrToCab 3.12 Miscellaneous Commands KamMiscGetErrorMsg KamMiscGetClockTime KamMiscPutClockTime KamMiscGetInterfaceVersion KamMiscSaveData KamMiscGetControllerName KamMiscGetControllerNameAtPort KamMiscGetCommandStationValue KamMiscSetCommandStationValue KamMiscGetCommandStationIndex KamMiscMaxControllerID KamMiscGetControllerFacility I. OVERVIEW This document is divided into two sections, the Tutorial, and the IDL Command Reference. The tutorial shows the complete code for a simple Visual BASIC program that controls all the major functions of a locomotive. This program makes use of many of the commands described in the reference section. The IDL Command Reference describes each command in detail. I. TUTORIAL A. Visual BASIC Throttle Example Application The following application is created using the Visual BASIC source code in the next section. It controls all major locomotive functions such as speed, direction, and auxiliary functions. A. Visual BASIC Throttle Example Source Code ' Copyright 1998, KAM Industries. All rights reserved. ' ' This is a demonstration program showing the ' integration of VisualBasic and Train Server .TM. ' interface. You may use this application for non ' commercial usage. ' '$Date: $ '$Author: $ '$Revision: $ '$Log: $ ' Engine Commander, Computer Dispatcher, Train Server, ' Train Tools, The Conductor and kamind are registered ' Trademarks of KAM Industries. All rights reserved. ' ' This first command adds the reference to the Train ' ServerT Interface object Dim EngCmd As New EngComIfc ' ' Engine Commander uses the term Ports, Devices and ' Controllers ' Ports --> These are logical ids where Decoders are ' assigned to. Train ServerT Interface supports a ' limited number of logical ports. You can also think ' of ports as mapping to a command station type. This ' allows you to move decoders between command station ' without losing any information about the decoder ' ' Devices --> These are communications channels ' configured in your computer. ' You may have a single device (com1) or multiple ' devices ' (COM 1 - COM8, LPT1, Other). You are required to ' map a port to a device to access a command station. ' Devices start from ID 0 --> max id (FYI; devices do ' not necessarily have to be serial channel. Always ' check the name of the device before you use it as ' well as the maximum number of devices supported. ' The Command ' EngCmd.KamPortGetMaxPhysical (lMaxPhysical, lSerial, ' lParallel) provides means that . . . lMaxPhysical = ' lSerial + lParallel + lOther ' ' Controller - These are command the command station ' like LENZ, Digitrax ' Northcoast, EasyDCC, Marklin . . . It is recommend ' that you check the command station ID before you ' use it. ' ' Errors - All commands return an error status. If ' the error value is non zero, then the ' other return arguments are invalid. In ' general, non zero errors means command was ' not executed. To get the error message, ' you need to call KamMiscErrorMessage and ' supply the error number ' ' To Operate your layout you will need to perform a ' mapping between a Port (logical reference), Device ' (physical communications channel) and a Controller ' (command station) for the program to work. All ' references uses the logical device as the reference ' device for access. ' ' Addresses used are an object reference. To use an ' address you must add the address to the command ' station using KamDecoderPutAdd . . . One of the return ' values from this operation is an object reference ' that is used for control. ' ' We need certain variables as global objects; since ' the information is being used multiple times Dim iLogicalPort, iController, iComPort Dim iPortRate, iPortParity, iPortStop, iPortRetrans, iPortWatchdog, iPortFlow, iPortData Dim lEngineObject As Long, iDecoderClass As Integer, iDecoderType As Integer Dim lMaxController As Long Dim lMaxLogical As Long, lMaxPhysical As Long, lMaxSerial As Long, lMaxParallel As Long '******************************** 'Form load function '- Turn of the initial buttons '- Set he interface information '******************************** Private Sub Form_load( ) Dim strVer As String, strCom As String, strCntrl As String Dim iError As Integer 'Get the interface version information SetButtonState (False) iError = EngCmd.KamMiscGetInterfaceVersion (strVer) If (iError) Then MsgBox (("Train Server not loaded. Check DCOM-95")) iLogicalPort = 0 LogPort.Caption = iLogicalPort ComPort.Caption = "???" Controller.Caption = "Unknown" Else MsgBox (("Simulation(COM1) Train Server -- " & strVer)) '******************************** 'Configuration information; Only need to change these values to use a different controller . . . '******************************** ' UNKNOWN 0 // Unknown control type ' SIMULAT 1 // Interface simulator ' LENZ_1x 2 // Lenz serial support module ' LENZ_2x 3 // Lenz serial support module ' DIGIT_DT200 4 // Digitrax direct drive
support using DT200 ' DIGIT_DCS100 5 // Digitrax direct drive support using DCS100 ' MASTERSERIES 6 // North Coast engineering master Series ' SYSTEMONE 7 // System One ' RAMFIX 8 // RAMFIxx system ' DYNATROL 9 // Dynatrol system ' Northcoast binary 10 // North Coast binary ' SERIAL 11 // NMRA Serial interface ' EASYDCC 12 // NMRA Serial interface ' MRK6050 13 // 6050 Marklin interface (AC and DC) ' MRK6023 14 // 6023 Marklin hybrid interface (AC) ' ZTC 15 // ZTC Systems ltd ' DIGIT_PR1 16 // Digitrax direct drive support using PR1 ' DIRECT 17 // Direct drive interface routine '******************************************************** iLogicalPort = 1 'Select Logical port 1 for communications iController = 1 'Select controller from the list above. iComPort = 0 ' use COM1; 0 means com1 (Digitrax must use Com1 or Com2) 'Digitrax Baud rate requires 16.4K! 'Most COM ports above Com2 do not 'support 16.4K. Check with the 'manufacture of your smart com card 'for the baud rate. Keep in mind that 'Dumb com cards with serial port 'support Com1 - Com4 can only support '2 com ports (like com1/com2 'or com3/com4) 'If you change the controller, do not 'forget to change the baud rate to 'match the command station. See your 'user manual for details '******************************************************** ' 0: // Baud rate is 300 ' 1: // Baud rate is 1200 ' 2: // Baud rate is 2400 ' 3: // Baud rate is 4800 ' 4: // Baud rate is 9600 ' 5: // Baud rate is 14.4 ' 6: // Baud rate is 16.4 ' 7: // Baud rate is 19.2 iPortRate = 4 ' Parity values 0-4 --> no, odd, even, mark, space iPortParity = 0 ' Stop bits 0,1,2 --> 1, 1.5, 2 iPortStop = 0 iPortRetrans = 10 iPortWatchdog = 2048 iPortFlow = 0 ' Data bits 0 --> 7 Bits, 1-> 8 bits iPortData = 1 'Display the port and controller information iError = EngCmd.KamPortGetMaxLogPorts (lMaxLogical) iError = EngCmd.KamPortGetMaxPhysical (lMaxPhysical, lMaxSerial, lMaxParallel) ' Get the port name and do some checking . . . iError = EngCmd.KamPortGetName(iComPort, strCom) SetError (iError) If (iComPort > lMaxSerial) Then MsgBox ("Com port our of range") iError = EngCmd.KamMiscGetControllerName(iController, strCntrl) If (iLogicalPort > lMaxLogical) Then MsgBox ("Logical port out of range") SetError (iError) End If 'Display values in Throttle . . LogPort.Caption = iLogicalPort ComPort.Caption = strCom Controller.Caption = strCntrl End Sub '******************************** 'Send command 'Note: ' Please follow the command order. Order is important ' for the application to work! '******************************** Private Sub Command_Click( ) 'Send the command from the interface to the command station, use the engineObject Dim iError, iSpeed As Integer If Not Connect.Enabled Then 'TrainTools interface is a caching interface. 'This means that you need to set up the CV's or 'other operations first; then execute the 'command. iSpeed = Speed.Text iError = EngCmd.KamEngPutFunction (lEngineObject, 0, F0.Value) iError = EngCmd.KamEngPutFunction (lEngineObject, 1, F1.Value) iError = EngCmd.KamEngPutFunction (lEngineObject, 2, F2.Value) iError = EngCmd.KamEngPutFunction (lEngineObject, 3, F3.Value) iError = EngCmd.KamEngPutSpeed (lEngineObject, iSpeed, Direction.Value) If iError = 0 Then iError = EngCmd.KamCmdCommand (lEngineObject) SetError (iError) End If End Sub '******************************** 'Connect Controller '******************************** Private Sub Connect_Click( ) Dim iError As Integer 'These are the index values for setting up the port for use ' PORT_RETRANS 0 // Retrans index ' PORT_RATE 1 // Retrans index ' PORT_PARITY 2 // Retrans index ' PORT_STOP 3 // Retrans index ' PORT_WATCHDOG 4 // Retrans index ' PORT_FLOW 5 // Retrans index ' PORT_DATABITS 6 // Retrans index ' PORT_DEBUG 7 // Retrans index ' PORT_PARALLEL 8 // Retrans index 'These are the index values for setting up the port for use ' PORT_RETRANS 0 // Retrans index ' PORT_RATE 1 // Retrans index ' PORT_PARITY 2 // Retrans index ' PORT_STOP 3 // Retrans index ' PORT_WATCHDOG 4 // Retrans index ' PORT_FLOW 5 // Retrans index ' PORT_DATABITS 6 // Retrans index ' PORT_DEDUG 7 // Retrans index ' PORT_PARALLEL 8 // Retrans index iError = EngCmd.KamPortPutConfig (iLogicalPort, 0, iPortRetrans, 0) ' setting PORT_RETRANS iError = EngCmd.KamPortPutConfig (iLogicalPort, 1, iPortRate, 0) ' setting PORT_RATE iError = EngCmd.KamPortPutConfig (iLogicalPort, 2, iPortParity, 0) ' setting PORT_PARITY iError = EngCmd.KamPortPutConfig (iLogicalPort, 3, iPortStop, 0) ' setting PORT_STOP iError = EngCmd.KamPortPutConfig (iLogicalPort, 4 iPortWatchdog, 0) ' setting PORT_WATCHDOG iError = EngCmd.KamPortPutConfig (iLogicalPort, 5, iPortFlow, 0) ' setting PORT_FLOW iError = EngCmd.KamPortPutContig (iLogicalPort, 6, iPortData, 0) ' setting PORT_DATABITS ' We need to set the appropriate debug mode for display . . ' this command can only be sent if the following is true ' -Controller is not connected ' -port has not been mapped ' -Not share ware version of application (Shareware ' always set to 130) ' Write Display Log Debug ' File Win Level Value ' 1 + 2 + 4 = 7 --> LEVEL1 -- put packets into ' queues ' 1 + 2 + 8 = 11 --> LEVEL2 -- Status messages ' send to window ' 1 + 2 + 16 = 19 --> LEVEL3 -- ' 1 + 2 + 32 = 35 --> LEVEL4 -- All system ' semaphores/critical sections ' 1 + 2 + 64 = 67 --> LEVEL5 -- detailed ' debugging information ' 1 + 2 + 128 = 131 --> COMMONLY -- Read comm write ' comm ports ' 'You probably only want to use values of 130. This will 'give you a display what is read or written to the 'controller. If you want to write the information to 'disk, use 131. The other information is not valid for 'end users. ' Note: 1. This does effect the performance of you ' system; 130 is a save value for debug ' display. Always set the key to 1, a value ' of 0 will disable debug ' 2. The Digitrax control codes displayed are ' encrypted. The information that you ' determine from the control codes is that ' information is sent (S) and a response is ' received (R) ' iDebugMode = 130 iValue = Value.Text' Display value for reference iError = EngCmd.KamPortPutConfig (iLogicalPort, 7, iDebug, iValue)' setting PORT_DEBUG 'Now map the Logical Port, Physical device, Command station and Controller iError = EngCmd.KamPortPutMapController (iLogicalPort, iController, iComPort) iError = EngCmd.KamCmdConnect (iLogicalPort) iError = EngCmd.KamOprPutTurnOnStation (iLogicalPort) If (iError) Then SetButtonState (False) Else SetButtonState (True) End If SetError (iError) 'Displays the error message and error number End Sub '******************************** 'Set the address button '******************************** Private Sub DCCAddr_Click ( ) Dim iAddr, iStatus As Integer ' All addresses must be match to a logical port to operate iDecoderType = 1 ' Set the decoder type to an NMRA baseline decoder (1-8 reg) iDecoderClass = 1 ' Set the decoder class to Engine decoder (there are only two classes of decoders; Engine and Accessory 'Once we make a connection, we use the lEngineObject 'as the reference object to send control information If (Address.Text > 1) Then iStatus = EngCmd.KamDecoderPutAdd (Address.Text, iLogicalPort, iLogicalPort, 0, iDecoderType, lEngineObject) SetError (iStatus) If (lEngineObject) Then Command.Enabled = True 'turn on the control (send) button Throttle.Enabled = True ' Turn on the throttle Else MsgBox ("Address not set, check error message") End If Else MsgBox ("Address must be greater then 0 and less then 128") End If End Sub '******************************** 'Disconenct button '******************************** Private Sub Disconnect_Click ( ) Dim iError As Integer
iError = EngCmd.KamCmdDisConnect (iLogicalPort) SetError (iError) SetButtonState (False) End Sub '******************************** 'Display error message '******************************** Private Sub SetError (iError As Integer) Dim szError As String Dim iStatus ' This shows how to retrieve a sample error message from the interface for the status received. iStatus = EngCmd.KamMiscGetErrorMsg (iError, szError) ErrorMsg.Caption = szError Result.Caption = Str (iStatus) End Sub '******************************** 'Set the Form button state '******************************** Private Sub SetButtonState (iState As Boolean) 'We set the state of the buttons; either connected or disconnected If (iState) Then Connect.Enabled = False Disconnect.Enabled = True ONCmd.Enabled = True OffCmd.Enabled = True DCCAddr.Enabled = True UpDownAddress.Enabled = True 'Now we check to see if the Engine Address has been 'set; if it has we enable the send button If (lEngineObject > 0) Then Command.Enabled = True Throttle.Enabled = True Else Command.Enabled = False Throttle.Enabled = False End If Else Connect.Enabled = True Disconnect.Enabled = False Command.Enabled = False ONCmd.Enabled = False OffCmd.Enabled = False DCCAddr.Enabled = False UpDownAddress.Enabled = False Throttle.Enabled = False End If End Sub '******************************** 'Power Off function '******************************** Private Sub OffCmd_Click ( ) Dim iError As Integer iError = EngCmd.KamOprPutPowerOff (iLogicalPort) SetError (iError) End Sub '******************************** 'Power On function '******************************** Private Sub ONCmd_Click ( ) Dim iError As Inteqer iError = EngCmd.KamOprPutPowerOn (iLogicalPort) SetError (iError) End Sub '******************************** 'Throttle slider control '******************************** Private Sub Throttle_Click ( ) If (lEngineObject) Then If (Throttle.Value > 0) Then Speed.Text = Throttle.Value End If End If End Sub I. IDL COMMAND REFERENCE A. Introduction This document describes the IDL interface to the KAM Industries Engine Commander Train Server. The Train Server DCOM server may reside locally or on a network node This server handles all the background details of controlling your railroad. You write simple, front end programs in a variety of languages such as BASIC, Java, or C++ to provide the visual interface to the user while the server handles the details of communicating with the command station, etc. A. Data Types Data is passed to and from the IDL interface using a several primitive data types. Arrays of these simple types are also used. The exact type passed to and from your program depends on the programming language your are using. The following primitive data types are used: IDL Type BASIC Type C++ Type Java Type Description short short short short Short signed integer int int int int Signed integer BSTR BSTR BSTR BSTR Text string long long long long Unsigned 32 bit value Name ID CV Range Valid CV's Functions Address Range Speed Steps NMRA Compatible 0 None None 2 1-99 14 Baseline 1 1-8 1-8 9 1-127 14 Extended 2 1-106 1-9, 17, 18, 19, 23, 24, 29, 30, 49, 66-95 9 1-10239 14, 28, 128 All Mobile 3 1-106 1-106 9 1-10239 14, 28, 128 Address Name ID CV Range Valid CV's Functions Range Accessory 4 513-593 513-593 8 0-511 All Stationary 5 513-1024 513-1024 8 0-511 A long /DecoderObject/D value is returned by the KamDecoderPutAdd call if the decoder is successfully registered with the server. This unique opaque ID should be used for all subsequent calls to reference this decoder. A. Commands to access the server configuration variable database This section describes the commands that access the server configuration variables (CV) database. These CVs are stored in the decoder and control many of its characteristics such as its address. For efficiency, a copy of each CV value is also stored in the server database. Commands such as KamCVGetValue and KamCVPutValue communicate only with the server, not the actual decoder. You then use the programming commands in the next section to transfer CVs to and from the decoder. 0KamCVGetValue Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 1-1024 2 In CV register pCVValue int * 3 Out Pointer to CV value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Range is 1-1024. Maximum CV for this decoder is given by KamCVGetMaxRegister. 3 CV Value pointed to has a range of 0 to 255. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVGetValue takes the decoder object ID and configuration variable (CV) number as parameters. It sets the memory pointed to by pCVValue to the value of the server copy of the configuration variable. 0KamCVPutValue Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 1-1024 2 In CV register iCVValue int 0-255 In CV value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum CV is 1024. Maximum CV for this decoder is given by KamCVGetMaxRegister. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVPutValue takes the decoder object ID, configuration variable (CV) number, and a new CV value as parameters. It sets the server copy of the specified decoder CV to iCVValue. 0KamCVGetEnable Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 1-1024 2 In CV number pEnable int * 3 Out Pointer to CV bit mask 1 Opaque object ID handle returned by KamDecoderPutAdd 2 Maximum CV is 1024. Maximum CV for this decoder is given by KamCVGetMaxRegister. 3 0x0001 - SET.sub.- CV.sub.- INUSE 0x0002 - SET.sub.- CV.sub.- READ.sub.- DIRTY 0x0004 - SET.sub.- CV.sub.- WRITE.sub.- DIRTY 0x0008 - SET.sub.- CV.sub.- .sub.- ERROR.sub.- READ 0x0010 - SET.sub.- CV.sub.- ERROR.sub.- WRITE Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVGetEnable takes the decoder object ID, configuration variable (CV) number, and a pointer to store the enable flag as parameters. It sets the location pointed to by pEnable. 0KamCVPutEnable Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 1-1024 2 In CV number iEnableint 3 In CV bit mask 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum CV is 1024. Maximum CV for this decoder is given by KamCVGetMaxRegister. 3 0x0001 - SET.sub.- CV.sub.- INUSE 0x0002 - SET.sub.- CV.sub.- READ.sub.- DIRTY 0x0004 - SET.sub.- CV.sub.- WRITE.sub.- DIRTY 0x0008 - SET.sub.- CV.sub.- .sub.- ERROR.sub.- READ 0x0010 - SET.sub.- CV.sub.- ERROR.sub.- WRITE Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVPutEnable takes the decoder object ID, configuration variable (CV) number, and a new enable state as parameters. It sets the server copy of the CV bit mask to iEnable. 0KamCVGetName Parameter List Type Range Direction Description iCV int 1-1024 In CV number pbsCVNameString BSTR * 1 Out Pointer to CV name string 1 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVGetName takes a configuration variable (CV) number as a parameter. It sets the memory pointed to by pbsCVNameString to the name of the CV as defined in NMRA Recommended Practice RP 9.2.2. 0KamCVGetMinRegister Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID pMinRegister int * 2 Out Pointer to min CV register number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Normally 1-1024.
0 on error or if decoder does not support CVs. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVGetMinRegister takes a decoder object ID as a parameter. It sets the memory pointed to by pMinRegister to the minimum possible CV register number for the specified decoder. 0KamCVGetMaxRegister Parameter List Type Range Direction Description iDecoderObjectID long 1 In Decoder object ID pMaxRegister int * 2 Out Pointer to max CV register number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Normally 1-1024. 0 on error or if decoder does not support CVs. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCVGetMaxRegister takes a decoder object ID as a parameter. It sets the memory pointed to by pMaxRegister to the maximum possible CV register number for the specified decoder. A. Commands to program configuration variables This section describes the commands read and write decoder configuration variables (CVs). You should initially transfer a copy of the decoder CVs to the server using the KamProgramReadDecoderToDataBase command. You can then read and modify this server copy of the CVs. Finally, you can program one or more CVs into the decoder using the KamProgramCV or KamProgramDecoderFromDataBase command. Not that you must first enter programming mode by issuing the KamProgram command before any programming can be done. 0KamProgram Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iProgLogPort int 1-65535 2 In Logical programming port ID iProgMode int 3 In Programming mode 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value for this server given by KamPortGetMaxLogPorts. 3 0 - PROGRAM_MODE_NONE 1 - PROGRAM_MODE_ADDRESS 2 - PROGRAM_MODE_REGISTER 3 - PROGRAM_MODE_PAGE 4 - PROGRAM_MODE_DIRECT 5 - DCODE_PRGMODE_OPS_SHORT 6 - PROGRAM_MODE_OPS_LONG Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgram take the decoder object ID, logical programming port ID, and programming mode as parameters. It changes the command station mode from normal operation (PROGRAM_MODE_NONE) to the specified programming mode. Once in programming modes, any number of programming commands may be called. When done, you must call KamProgram with a parameter of PROGRAM_MODE_NONE to return to normal operation. 0KamProgramGetMode Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iProgLogPort int 1-65535 2 In Logical programming port ID piProgMode int * 3 Out Programming mode 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value for this server given by KamPortGetMaxLogPorts. 3 0 - PROGRAM_MODE_NONE 1 - PROGRAM_MODE_ADDRESS 2 - PROGRAM_MODE_REGISTER 3 - PROGRAM_MODE_PAGE 4 - PROGRAM_MODE_DIRECT 5 - DCODE_PRGMODE_OPS_SHORT 6 - PROGRAM_MODE_OPS_LONG Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgramGetMode take the decoder object ID, logical programming port ID, and pointer to a place to store the programming mode as parameters. It sets the memory pointed to by piProgMode to the present programming mode. 0KamProgramGetStatus Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 0-1024 2 In CV number piCVAllStatus int * 3 Out Or'd decoder programming status 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 0 returns OR'd value for all CVs. Other values return status for just that CV. 3 0x0001 - SET_CV_INUSE 0x0002 - SET_CV_READ_DIRTY 0x0004 - SET_CV_WRITE_DIRTY 0x0008 - SET_CV_ERROR_READ 0x0010 - SET_CV_ERROR_WRITE Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgramGetStatus take the decoder object ID and pointer to a place to store the OR'd decoder programming status as parameters. It sets the memory pointed to by piProgMode to the present programming mode. 0KamProgramReadCV Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 2 In CV number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum CV is 1024. Maximum CV for this decoder is given by KamCVGetMaxRegister. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgramCV takes the decoder object ID, confiquration variable (CV) number as parameters. It reads the specified CV variable value to the server database. 0KamProgramCV Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCVRegint 2 In CV number iCVValue int 0-255 In CV value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum CV is 1024. Maximum CV for this decoder is given by KamCVGetMaxRegister. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgramCV takes the decoder object ID, configuration variable (CV) number, and a new CV value as parameters. It programs (writes) a single decoder CV using the specified value as source data. 0KamProgramReadDecoderToDataBase Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgramReadDecoderToDataBase takes the decoder object ID as a parameter. It reads all enabled CV values from the decoder and stores them in the server database. 0KamProgramDecoderFromDataBase Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamProgramDecoderFromDataBase takes the decoder object ID as a parameter. It programs (writes) all enabled decoder CV values using the server copy of the CVs as source data. A. Commands to control all decoder types This section describes the commands that all decoder types. These commands do things such getting the maximum address a given type of decoder supports, adding decoders to the database, etc. 0KamDecoderGetMaxModels. Parameter List Type Range Direction Description piMaxModels int * 1 Out Pointer to Max model ID 1 Normally 1-65535. 0 on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetMaxModels takes no parameters. It sets the memory pointed to by piMaxModels to the maximum decoder type ID. 0KamDecoderGetModelName Parameter List Type Range Direction Description iModel int 1-65535 1 In Decoder type ID pbsModelName BSTR * 2 Out Decoder name string 1 Maximum value for this server given by KamDecoderGetMaxModels. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortGetModelName takes a decoder type ID and a pointer to a string as parameters. It sets the memory pointed to by pbsModelName to a BSTR containing the decoder name. 0KamDecoderSetModelToObj Parameter List Type Range Direction Description iModel int 1 In Decoder model ID lDecoderObjectID long 1 In Decoder object ID 1 Maximum value for this server given by KamDecoderGetMaxModels 2 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderSetModelToObj takes a decoder ID and decoder object ID as parameters. It sets the decoder model type of the decoder at address lDecoderObjectID to the type
specified by iModel. 0KamDecoderGetMaxAddress Parameter List Type Range Direction Description iModel int 1 In Decoder type ID piMaxAddress int * 2 Out Maximum decoder address 1 Maximum value for this server given by KamDecoderGetMaxModels. 2 Model dependent. 0 returned on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetMaxAddress takes a decoder type ID and a pointer to store the maximum address as parameters. It sets the memory pointed to by piMaxAddress to the maximum address supported by the specified decoder. 0KamDecoderChangeOldNewAddr Parameter List Type Range Direction Description lOldObjID long 1 In Old decoder object ID iNewAddr int 2 In New decoder address plNewObjID long * 1 Out New decoder object ID 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 1-127 for short locomotive addresses. 1-10239 for long locomotive decoders. 0-511 for accessory decoders. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderChangeOldNewAddr takes an old decoder object ID and a new decoder address as parameters. It moves the specified locomotive or accessory decoder to iNewAddr and sets the memory pointed to by plNewObjID to the new object ID. The old object ID is now invalid and should no longer be used. 0KamDecoderMovePort Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iLogicalPortID int 1-65535 2 In Logical port ID 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderMovePort takes a decoder object ID and logical port ID as parameters. It moves the decoder specified by lDecoderObjectID to the controller specified by iLogicalPortID. 0KamDecoderGetPort Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piLogicalPortID int * 1-65535 2 Out Pointer to logical port ID 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderMovePort takes a decoder object ID and pointer to a logical port ID as parameters. It sets the memory pointed to by piLogicalPortID to the logical port ID associated with lDecoderObjectID. 0KamDecoderCheckAddrInUse Parameter List Type Range Direction Description iDecoderAddress int 1 In Decoder address iLogicalPortID int 2 In Logical Port ID iDecoderClass int 3 In Class of decoder 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value for this server given by KamPortGetMaxLogPorts. 3 1 - DECODER_ENGINE_TYPE, 2 - DECODER_SWITCH_TYPE, 3 - DECODER_SENSOR_TYPE. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for successful call and address not in use. Nonzero an error number (see KamMiscGetErrorMsg). IDS_ERR_ADDRESSEXIST returned if call succeeded but the address exists. KamDecoderCheckAddrInUse takes a decoder address, logical port, and decoder class as parameters. It returns zero if the address is not in use. It will return IDS_ERR_ADDRESSEXIST if the call succeeds but the address already exists. It will return the appropriate non zero error number if the calls fails. 0KamDecoderGetModelFromObj Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piModelint * 1-65535 2 Out Pointer to decoder type ID 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value for this server given by KamDecoderGetMaxModels. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetModelFromObj takes a decoder object ID and pointer to a decoder type ID as parameters. It sets the memory pointed to by piModel to the decoder type ID associated with iDCCAddr. 0KamDecoderGetModelFacility Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID pdwFacility long * 2 Out Pointer to decoder facility mask 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 0 - DCODE_PRGMODE_ADDR 1 - DCODE_PRGMODE_REG 2 - DCODE_PRGMODE_PAGE 3 - DCODE_PRGMODE_DIR 4 - DCODE_PRGMODE_FLYSHT 5 - DCODE_PRGMODE_FLYLNG 6 - Reserved 7 - Reserved 8 - Reserved 9 - Reserved 10 - Reserved 11 - Reserved 12 - Reserved 13 - DCODE_FEAT_DIRLIGHT 14 - DCODE_FEAT_LNGADDR 15 - DCODE_FEAT_CVENABLE 16 - DCODE_FEDMODE_ADDR 17 - DCODE_FEDMODE_REG 18 - DCODE_FEDMODE_PAGE 19 - DCODE_FEDMODE_DIR 20 - DCODE_FEDMODE_FLYSHT 21 - DCODE_FEDMODE_FLYLNG Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetModelFacility takes a decoder object ID and pointer to a decoder facility mask as parameters. It sets the memory pointed to by pdwFacility to the decoder facility mask associated with iDCCAddr. 0KamDecoderGetObjCount Parameter List Type Range Direction Description iDecoderClass int 1 In Class of decoder piObjCount int * 0-65535 Out Count of active decoders 1 1 - DECODER_ENGINE_TYPE, 2 - DECODER_SWITCH_TYPE, 3 - DECODER_SENSOR_TYPE. Return Value Type Range Description.sup.. iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetObjCount takes a decoder class and a pointer to an address count as parameters. It sets the memory pointed to by piObjCount to the count of active decoders of the type given by iDecoderClass. 0KamDecoderGetObjAtIndex Parameter List Type Range Direction Description.sup.. iIndex int 1 In Decoder array index iDecoderClass int 2 In Class of decoder plDecoderObjectID long * 3 Out Pointer to decoder object ID 1 0 to (KamDecoderGetAddressCount - 1). 2 1 - DECODER_ENGINE_TYPE, 2 - DECODER_SWITCH_TYPE, 3 - DECODER_SENSOR_TYPE. 3 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetObjCount takes a decoder index, decoder class, and a pointer to an object ID as parameters. It sets the memory pointed to by plDecoderObjectID to the selected object ID. 0KamDecoderPutAdd Parameter List Type Range Direction Description iDecoderAddress int 1 In Decoder address iLogicalCmdPortID int 1-65535 2 In Logical command port ID iLogicalProgPortID int 1-65535 2 In Logical programming port ID iClearState int 3 In Clear state flag iModel int 4 In Decoder model type ID plDecoderObjectID long * 5 Out Decoder object ID 1 1-127 for short locomotive addresses. 1-10239 for long locomotive decoders. 0-511 for accessory decoders. 2 Maximum value for this server given by KamPortGetMaxLogPorts. 3 0 - retain state, 1 - clear state. 4 Maximum value for this server given by KamDecoderGetMaxModels. 5 Opaque object ID handle. The object ID is used to reference the decoder. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderPutAdd takes a decoder object ID, command logical port, programming logical port, clear flag, decoder model ID, and a pointer to a decoder object ID as parameters. It creates a new locomotive object in the locomotive database and sets the memory pointed to by plDecoderObjectID to the decoder object ID used by the server as a key. 0KamDecoderPutDel Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iClearState int 2 In Clear state flag 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 0 - retain state, 1 - clear state. Return Value Type Range Description. iError short 1 Error flag
1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderPutDel takes a decoder object ID and clear flag as parameters. It deletes the locomotive object specified by lDecoderObjectID from the locomotive database. 0KamDecoderGetMfgName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID pbsMfgName BSTR * 2 Out Pointer to manufacturer name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetMfgName takes a decoder object ID and pointer to a manufacturer name string as parameters. It sets the memory pointed to by pbsMfgName to the name of the decoder manufacturer. 0KamDecoderGetPowerMode Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID pbsPowerMode BSTR * 2 Out Pointer to decoder power mode 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description. iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetPowerMode takes a decoder object ID and a pointer to the power mode string as parameters. It sets the memory pointed to by pbsPowerMode to the decoder power mode. 0KamDecoderGetMaxSpeed Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piSpeedStep int * 2 Out Pointer to max speed step 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 14, 28, 56, or 128 for locomotive decoders. 0 for accessory decoders. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamDecoderGetMaxSpeed takes a decoder object ID and a pointer to the maximum supported speed step as parameters. It sets the memory pointed to by piSpeedStep to the maximum speed step supported by the decoder. A. Commands to control locomotive decoders This section describes the commands that control locomotive decoders. These commands control things such as locomotive speed and direction. For efficiency, a copy of all the engine variables such speed is stored in the server. Commands such as KamEngGetSpeed communicate only with the server, not the actual decoder. You should first make any changes to the server copy of the engine variables. You can send all changes to the engine using the KamCmdCommand command. 0KamEngGetSpeed Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID lpSpeed int * 2 Out Pointer to locomotive speed lpDirection int * 3 Out Pointer to locomotive direction 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Speed range is dependent on whether the decoder is set to 14, 18, or 128 speed steps and matches the values defined by NMRA S9.2 and RP 9.2.1. 0 is stop and 1 is emergency stop for all modes. 3 Forward is boolean TRUE and reverse is boolean FALSE. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetSpeed takes the decoder object ID and pointers to locations to store the locomotive speed and direction as parameters. It sets the memory pointed to by lpSpeed to the locomotive speed and the memory pointed to by lpDirection to the locomotive direction. 0KamEngPutSpeed Parameter List Type Range Direction Description. lDecoderObjectID long 1 In Decoder object ID iSpeed int 2 In Locomotive speed iDirection int 3 In Locomotive direction 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Speed range is dependent on whether the decoder is set to 14, 18, or 128 speed steps and matches the values defined by NMRA S9.2 and RP 9.2.1. 0 is stop and 1 is emergency stop for all modes. 3 Forward is boolean TRUE and reverse is boolean FALSE. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutSpeed takes the decoder object ID, new locomotive speed, and new locomotive direction as parameters. It sets the locomotive database speed to iSpeed and the locomotive database direction to iDirection. Note: This command only changes the locomotive database. The data is not sent to the decoder until execution of the KamCmdCommand command. Speed is set to the maximum possible for the decoder if iSpeed exceeds the decoders range. 0KamEngGetSpeedSteps Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID lpSpeedSteps int * 14, 28, 128 Out Pointer to number of speed steps 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetSpeedSteps takes the decoder object ID and a pointer to a location to store the number of speed steps as a parameter. It sets the memory pointed to by lpSpeedSteps to the number of speed steps. 0KamEngPutSpeedSteps Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iSpeedSteps int 14, 28, 128 In Locomotive speed steps 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutSpeedSteps takes the decoder object ID and a new number of speed steps as a parameter. It sets the number of speed steps in the locomotive database to iSpeedSteps. Note: This command only changes the locomotive database. The data is not sent to the decoder until execution of the KamCmdCommand command. KamDecoderGetMaxSpeed returns the maximum possible speed for the decoder. An error is generated if an attempt is made to set the speed steps beyond this value. 0KamEngGetFunction Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-8 2 In Function ID number lpFunction int * 3 Out Pointer to function value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 FL is 0. F1-F8 are 1-8 respectively. Maximum for this decoder is given by KamEngGetFunctionMax. 3 Function active is boolean TRUE and inactive is boolean FALSE. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetFunction takes the decoder object ID, a function ID, and a pointer to the location to store the specified function state as parameters. It sets the memory pointed to by lpFunction to the specified function state. 0KamEngPutFunction Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-8 2 In Function ID number iFunction int 3 In Function value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 FL is 0. F1-F8 are 1-8 respectively. Maximum for this decoder is given by KamEngGetFunctionMax. 3 Function active is boolean TRUE and inactive is boolean FALSE. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutFunction takes the decoder object ID, a function ID, and a new function state as parameters. It sets the specified locomotive database function state to iFunction. Note: This command only changes the locomotive database. The data is not sent to the decoder until execution of the KamCmdCommand command. 0KamEngGetFunctionMax Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piMaxFunction int * 0-8 Out Pointer to maximum function number 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetFunctionMax takes a decoder object ID and a pointer to the maximum function ID as parameters. It sets the memory pointed to by piMaxFunction to the maximum possible function number for the specified decoder. 0KamEngGetName
Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID pbsEngName BSTR * 2 Out Pointer to locomotive name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetName takes a decoder object ID and a pointer to the locomotive name as parameters. It sets the memory pointed to by pbsEngName to the name of the locomotive. 0KamEngPutName Parameter List Type Range Direction Description.sup.. lDecoderObjectID long 1 In Decoder object ID bsEngName BSTR 2 Out Locomotive name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutName takes a decoder object ID and a BSTR as parameters. It sets the symbolic locomotive name to bsEngName. 0KamEngGetFunctionName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-8 2 In Function ID number pbsFcnNameString BSTR * 3 Out Pointer to function name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 FL is 0. F1-F8 are 1-8 respectively. Maximum for this decoder is given by KamEngGetFunctionMax. 3 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError.sup.. = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetFuncntionName takes a decoder object ID, function ID, and a pointer to the function name as parameters. It sets the memory pointed to by pbsFcnNameString to the symbolic name of the specified function. 0KamEngPutFunctionName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-8 2 In Function ID number bsFcnNameString BSTR 3 In Function name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 FL is 0. F1-F8 are 1-8 respectively. Maximum for this decoder is given by KamEngGetFunctionMax. 3 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutFunctionName takes a decoder object ID, function ID, and a BSTR as parameters. It sets the specified symbolic function name to bsFcnNameString. 0KamEngGetConsistMax Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piMaxConsist int * 2 Out Pointer to max consist number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Command station dependent. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngGetConsistMax takes the decoder object ID and a pointer to a location to store the maximum consist as parameters. It sets the location pointed to by piMaxConsist to the maximum number of locomotives that can but placed in a command station controlled consist. Note that this command is designed for command station consisting. CV consisting is handled using the CV commands. 0KamEngPutConsistParent Parameter List Type Range Direction Description lDCCParentObjID long 1 In Parent decoder object ID iDCCAliasAddr int 2 In Alias decoder address 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 1-127 for short locomotive addresses. 1-10239 for long locomotive decoders. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutConsistParent takes the parent object ID and an alias address as parameters. It makes the decoder specified by lDCCParentObjID the consist parent referred to by iDCCAliasAddr. Note that this command is designed for command station consisting. CV consisting is handled using the CV commands. If a new parent is defined for a consist; the old parent becomes a child in the consist. To delete a parent in a consist without deleting the consist, you must add a new parent then delete the old parent using KamEngPutConsistRemoveObj. 0KamEngPutConsistChild Parameter List Type Range Direction Description lDCCParentObjID long 1 In Parent decoder object ID iDCCObjID long 1 In Decoder object ID 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutConsistChild takes the decoder parent object ID and decoder object ID as parameters. It assigns the decoder specified by lDCCObjID to the consist identified by lDCCParentObjID. Note that this command is designed for command station consisting. CV consisting is handled using the CV commands. Note: This command is invalid if the parent has not been set previously using KamEngPutConsistParent. 0KamEngPutConsistRemoveObj Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamEngPutConsistRemoveObj takes the decoder object ID as a parameter. It removes the decoder specified by lDecoderObjectID from the consist. Note that this command is designed for command station consisting. CV consisting is handled using the CV commands. Note: If the parent is removed, all children are removed also. A. Commands to control accessory decoders This section describes the commands that control accessory decoders. These commands control things such as accessory decoder activation state. For efficiency, a copy of all the engine variables such speed is stored in the server. Commands such as KamAccGetFunction communicate only with the server, not the actual decoder. You should first make any changes to the server copy of the engine variables. You can send all changes to the engine using the KamCmdCommand command. 0KamAccGetFunction Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-31 2 In Function ID number lpFunction int * 3 Out Pointer to function value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum for this decoder is given by KamAccGetFunctionMax. 3 Function active is boolean TRUE and inactive is boolean FALSE. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccGetFunction takes the decoder object ID, a function ID, and a pointer to the location to store the specified function state as parameters. It sets the memory pointed to by lpFunction to the specified function state. 0KamAccGetFunctionAll Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piValue int * 2 Out Function bit mask 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Each bit represents a single function state. Maximum for this decoder is given by KamAccGetFunctionMax. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccGetFunctionAll takes the decoder object ID and a pointer to a bit mask as parameters. It sets each bit in the memory pointed to by piValue to the corresponding function state. 0KamAccPutFunction Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-31 2 In Function ID number iFunction int 3 In Function value 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum for this decoder is given by KamAccGetFunctionMax. 3 Function active is boolean TRUE and inactive is boolean FALSE. Return Value Type Range Description.sup.. iError short 1 Error flag
1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccPutFunction takes the decoder object ID, a function ID, and a new function state as parameters. It sets the specified accessory database function state to iFunction. Note: This command only changes the accessory database. The data is not sent to the decoder until execution of the KamCmdCommand command. 0KamAccPutFunctionAll Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iValue int 2 In Pointer to function state array 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Each bit represents a single function state. Maximum for this decoder is given by KamAccGetFunctionMax. Return Value Type Range Description.sup.. iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccPutFunctionAll takes the decoder object ID and a bit mask as parameters. It sets all decoder function enable states to match the state bits in iValue. The possible enable states are TRUE and FALSE. The data is not sent to the decoder until execution of the KamCmdCommand command. 0KamAccGetFunctionMax Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID piMaxFunction int * 0-31 2 Out Pointer to maximum function number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum for this decoder given by KamAccGetFunctionMax. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccGetFunctionMax takes a decoder object ID and pointer to the maximum function number as parameters. It sets the memory pointed to by piMaxFunction to the maximum possible function number for the specified decoder. 0KamAccGetName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID pbsAccNameString BSTR * 2 Out Accessory name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccGetName takes a decoder object ID and a pointer to a string as parameters. It sets the memory pointed to by pbsAccNameString to the name of the accessory. 0KamAccPutName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID bsAccNameString BSTR 2 In Accessory name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccPutName takes a decoder object ID and a BSTR as parameters. It sets the symbolic accessory name to bsAccName. 0KamAccGetFunctionName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-31 2 In Function ID number pbsFcnNameString BSTR * 3 Out Pointer to function name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum for this decoder is given by KamAccGetFunctionMax. 3 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccGetFuncntionName takes a decoder object ID, function ID, and a pointer to a string as parameters. It sets the memory pointed to by pbsFcnNameString to the symbolic name of the specified function. 0KamAccPutFunctionName Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iFunctionID int 0-31 2 In Function ID number bsFcnNameString BSTR 3 In Function name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum for this decoder is given by KamAccGetFunctionMax. 3 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccPutFunctionName takes a decoder object ID, function ID, and a BSTR as parameters. It sets the specified symbolic function name to bsFcnNameString. 0KamAccRegFeedback Parameter List Type Range Direction Description.sup.. lDecoderObjectID long 1 In Decoder object ID bsAccNode BSTR 1 In Server node name iFunctionID int 0-31 3 In Function ID number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact parameter type depends on language. It is LPCSTR for C++. 3 Maximum for this decoder is given by KamAccGetFunctionMax. Return Value Type Range Description iError short 1 Error flag 1 iError.sup.. = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccRegFeedback takes a decoder object ID, node name string, and function ID, as parameters. It registers interest in the function given by iFunctionID by the method given by the node name string bsAccNode. bsAccNode identifies the server application and method to call if the function changes state. Its format is ".backslash..backslash.{Server}.backslash.{App}.{Method}" where {Server} is the server name, {App} is the application name, and {Method} is the method name. 0KamAccRegFeedbackAll Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID bsAccNode BSTR 2 In Server node name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccRegFeedbackAll takes a decoder object ID and node name string as parameters. It registers interest in all functions by the method given by the node name string bsAccNode. bsAccNode identifies the server application and method to call if the function changes state. Its format is ".backslash..backslash.{Server}.backslash.{App}.{Method}" where {Server} is the server name, {App} is the appiication name, and {Method} is the method name. 0KamAccDelFeedback Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID bsAccNode BSTR 2 In Server node name. iFunctionID int 0-31 3 In Function ID number 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact parameter type depends on language. It is LPCSTR for C++. 3 Maximum for this decoder is given by KamAccGetFunctionMax. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccDelFeedback takes a decoder object ID, node name string, and function ID, as parameters. It deletes interest in the function given by iFunctionID by the method given by the node name string bsAccNode. bsAccNode identifies the server application and method to call if the function changes state. Its format is ".backslash..backslash.{Server}.backslash.{App}.{Method}" where {Server} is the server name, {App} is the application name, and {Method} is the method name. 0KamAccDelFeedbackAll Parameter List Type Range Direction Description.sup.. lDecoderObjectID long 1 In Decoder object ID bsAccNode BSTR 2 In Server node name 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamAccDelFeedbackAll takes a decoder object ID and node name string as parameters. It deletes interest in all functions by the method given by the node name string bsAccNode. bsAccNode identifies the server application and method to call if the function changes state. Its format is ".backslash..backslash.{Server}.backslash.{App}.{Method}" where {Server} is the server name, {App} is the application name, and (Method) is the method name. A. Commands to control the command station This section describes the commands that control the command station. These commands do things such as controlling command station power. The steps to control a given command station vary depending on the type of command station.
0KamOprPutTurnOnStation Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutTurnOnStation takes a logical port ID as a parameter. It performs the steps necessary to turn on the command station. This command performs a combination of other commands such as KamOprPutStartStation, KamOprPutClearStation, and KamOprPutPowerOn. 0KamOprPutStartStation Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutStartStation takes a logical port ID as a parameter. It performs the steps necessary to start the command station. 0KamOprPutClearStation Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutClearStation takes a logical port ID as a parameter. It performs the steps necessary to clear the command station queue. 0KamOprPutStopStation Parameter List Type Range. Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutStopStation takes a logical port ID as a parameter. It performs the steps necessary to stop the command station. 0KamOprPutPowerOn Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutPowerOn takes a logical port ID as a parameter. It performs the steps necessary to apply power to the track. 0KamOprPutPowerOff Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutPowerOff takes a logical port ID as a parameter. It performs the steps necessary to remove power from the track. 0KamOprPutHardReset Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprPutHardReset takes a logical port ID as a parameter. It performs the steps necessary to perform a hard reset of the command station. 0KamOprPutEmergencyStop Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamNiscGetErrorMsg). KamOprPutEmergencyStop takes a logical port ID as a parameter. It performs the steps necessary to broadcast an emergency stop command to all decoders. 0KamOprGetStationStatus Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID pbsCmdStat BSTR * 2 Out Command station status string 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 Exact return type depends on language. It is Cstring * for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamOprGetStationStatus takes a logical port ID and a pointer to a string as parameters. It set the memory pointed to by pbsCmdStat to the command station status. The exact format of the status BSTR is vendor dependent. A. Commands to configure the command station communication part This section describes the commands that configure the command station communication port. These commands do things such as setting BAUD rate. Several of the commands in this section use the numeric controller ID (iControllerID) to identify a specific type of command station controller. The following table shows the mapping between the controller ID (iControllerID) and controller name (bsControllerName) for a given type of command station controller. iControl- lerID bsControllerName Description 0 UNKNOWN Unknown controller type 1 SIMULAT Interface simulator 2 LENZ_1x Lenz version 1 serial support module 3 LENZ_2x Lenz version 2 serial support module 4 DIGIT_DT200 Digitrax direct drive support using DT200 5 DIGIT_DCS100 Digitrax direct drive support using DCS100 6 MASTERSERIES North coast engineering master series 7 SYSTEMONE System one 8 RAMFIX RAMFIxx system 9 SERIAL NMRA serial interface 10 EASYDCC CVP Easy DCC 11 MRK6050 Marklin 6050 interface (AC and DC) 12 MRK6023 Marklin 6023 interface (AC) 13 DIGIT_PR1 Digitrax direct drive using PR1 14 DIRECT Direct drive interface routine 15 ZTC ZTC system ltd 16 TRIX TRIX controller iIndex Name iValue Values 0 RETRANS 10-255 1 RATE 0 - 300 BAUD, 1 - 1200 BAUD, 2 - 2400 BAUD, 3 - 4800 BAUD, 4 - 9600 BAUD, 5 - 14400 BAUD, 6 - 16400 BAUD, 7 - 19200 BAUD 2 PARITY0 - NONE, 1 - ODD, 2 - EVEN, 3 - MARK, 4 - SPACE 3 STOP 0 - 1 bit, 1 - 1.5 bits, 2 - 2 bits 4 WATCHDOG 500 - 65535 milliseconds. Recommended value 2048 5 FLOW 0 - NONE, 1 - XON/XOFF, 2 - RTS/CTS, 3 BOTH 6 DATA 0 - 7 bits, 1 - 8 bits 7 DEBUGBit mask. Bit 1 sends messages to debug file. Bit 2 sends messages to the screen. Bit 3 shows queue data. Bit 4 shows UI status. Bit 5 is reserved. Bit 6 shows semaphore and critical sections. Bit 7 shows miscellaneous messages. Bit 8 shows comm port activity. 130 decimal is recommended for debugging. 8 PARALLEL 0KamPortPutConfig Parameter List Type Range Direction Description.sup.. iLogicalPortID int 1-65535 1 In Logical port ID iIndex int 2 In Configuration type index iValue int 2 In Configuration value, iKey int 3 In Debug key 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 See FIG. 7: Controller configuration Index values for a table of indexes and values. 3 Used only for the DEBUG iIndex value. Should be set to 0. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortPutConfig takes a logical port ID, configuration index, configuration value, and key as parameters. It sets the port parameter specified by iIndex to the value specified by iValue. For the DEBUG iIndex value, the debug file path is C:.backslash.Temp.backslash.Debug{PORT}.txt where {PORT} is the physical comm port ID. 0KamPortGetConfig Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID iIndex int 2 In Configuration type index piValue int * 2 Out Pointer to configuration value 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 See FIG. 7: Controller configuration Index values for a table of indexes and values. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortGetConfig takes a logical port ID, configuration index, and a pointer to a configuration value as parameters. It sets the memory pointed to by piValue to the specified configuration value. 0KamPortGetName Parameter List Type Range Direction Description iPhysicalPortID int 1-65535 1 In Physical port number pbsPortName BSTR * 2 Out Physical port name 1 Maximum value for this server given by KamPortGetMaxPhysical. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error.
Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortGetName takes a physical port ID number and a pointer to a port name string as parameters. It sets the memory pointed to by pbsPortName to the physical port name such as "COMM1." 0KamPortPutMapController Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID iControllerID int 1-65535 2 In Command station type ID iCommPortID int 1-65535 3 In Physical comm port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 See FIG. 6: Controller ID to controller name mapping for values. Maximum value for this server is given by KamMiscMaxControllerID. 3 Maximum value for this server given by KamPortGetMaxPhysical. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortPutMapController takes a logical port ID, a command station type ID, and a physical cominunications port ID as parameters. It maps iLogicalPortID to iCommPortID for the type of command station specified by iControllerID. 0KamPortGetMaxLogPorts Parameter List Type Range Direction Description.sup.. piMaxLogicalPorts int * 1 Out Maximum logical port ID 1 Normally 1-65535. 0 returned on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortGetMaxLogPorts takes a pointer to a logical port ID as a parameter. It sets the memory pointed to by piMaxLogicalPorts to the maximum logical port ID. 0KamPortGetMaxPhysical Parameter List Type Range Direction Description pMaxPhysical int * 1 Out Maximum physical port ID pMaxSerial int * 1 Out Maximum serial port ID pMaxParallel int * 1 Out Maximum parallel port ID 1 Normally 1-65535. 0 returned on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamPortGetMaxPhysical takes a pointer to the number of physical ports, the number of serial ports, and the number of parallel ports as parameters. It sets the memory pointed to by the parameters to the associated values A. Commands that control command flow to the command station This section describes the commands that control the command flow to the command station. These commands do things such as connecting and disconnecting from the command station. 0KamCmdConnect Parameter List Type Range Direction Description.sup.. iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCmdConnect takes a logical port ID as a parameter. It connects the server to the specified command station. 0KamCmdDisConnect Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID 1 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCmdDisConnect takes a logical port ID as a parameter. It disconnects the server to the specified command station. 0KamCmdCommand Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID 1 Opaque object ID handle returned by KamDecoderPutAdd. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCmdCommand takes the decoder object ID as a parameter. It sends all state changes from the server database to the specified locomotive or accessory decoder. A. Cab Control Commands This section describes commands that control the cabs attached to a command station. 0KamCabGetMessage Parameter List Type Range Direction Description iCabAddress int 1-65535 1 In Cab address pbsMsg BSTR * 2 Out Cab message string 1 Maximum value is command station dependent. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCabGetMessage takes a cab address and a pointer to a message string as parameters. It sets the memory pointed to by pbsMsg to the present cab message. 0KamCabPutMessage Parameter List Type Range Direction Description iCabAddress int 1 In Cab address bsMsg BSTR 2 Out Cab message string 1 Maximum value is command station dependent. 2 Exact parameter type depends on language. It is LPCSTR for C++. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCabPutMessage takes a cab address and a BSTR as parameters. It sets the cab message to bsMsg. 0KamCabGetCabAddr Parameter List Type Range Direction Description.sup.. lDecoderObjectID long 1 In Decoder object ID piCabAddress int * 1-65535 2 Out Pointer to Cab address 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value is command station dependent. Return Value Type Range Description.sup.. Error short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCabGetCabAddr takes a decoder object ID and a pointer to a cab address as parameters. It set the memory pointed to by piCabAddress to the address of the cab attached to the specified decoder. 0KamCabPutAddrToCab Parameter List Type Range Direction Description lDecoderObjectID long 1 In Decoder object ID iCabAddress int 1-65535 2 In Cab address 1 Opaque object ID handle returned by KamDecoderPutAdd. 2 Maximum value is command station dependent. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamCabPutAddrToCab takes a decoder object ID and cab address as parameters. It attaches the decoder specified by iDCCAddr to the cab specified by iCabAddress. A. Miscellaneous Command's This section describes miscellaneous commands that do not fit into the other categories. 0KamMiscGetErrorMsg Parameter List Type Range Direction Description iError int 0-65535 1 In Error flag 1 iError = 0 for success. Nonzero indicates an error. Return Value Type Range Description bsErrorString BSTR 1 Error string 1 Exact return type depends on language. It is Cstring for C++. Empty string on error. KamMiscGetErrorMsg takes an error flag as a parameter. It returns a BSTR containing the descriptive error message associated with the specified error flag. 0KamMiscGetClockTime Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID iSelectTimeMode int 2 In Clock source piDay int * 0-6 Out Day of week piHours int * 0-23 Out Hours piMinutes int * 0-59 Out Minutes piRatio int * 3 Out Fast clock ratio 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 0 - Load from command station and sync server. 1 - Load direct from server. 2 - Load from cached server copy of command station time. 3 Real time clock ratio. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetClockTime takes the port ID, the time mode, and pointers to locations to store the day, hours, minutes, and fast clock ratio as parameters. It sets the memory pointed to by piDay to the fast clock day, sets pointed to by piHours to the fast clock hours, sets the memory pointed to by piMinutes to the fast clock minutes, and the memory pointed to by piRatio to the fast clock ratio. The servers local time will be returned if the command station does not support a fast clock. 0KamMiscPutClockTime Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID iDay int 0-6 In Day of week iHours int 0-23 In Hours iMinutes int 0-59 In Minutes iRatio int 2 In Fast clock ratio 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 Real time clock ratio. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscPutClockTime takes the fast clock logical port, the fast clock day, the fast clock hours, the fast clock minutes, and the fast clock ratio as parameters. It sets
the fast clock using specified parameters. 0KamMiscGetInterfaceVersion Parameter List Type Range Direction Description pbsInterfaceVersion BSTR * 1 Out Pointer to interface version string 1 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetInterfaceVersion takes a pointer to an interface version string as a parameter. It sets the memory pointed to by pbsInterfaceVersion to the interface version string. The version string may contain multiple lines depending on the number of interfaces supported. 0KamMiscSaveData Parameter List Type Range Direction Description NONE Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscSaveData takes no parameters. It saves all server data to permanent storage. This command is run automatically whenever the server stops running. Demo versions of the program cannot save data and this command will return an error in that case. 0KamMiscGetControllerName Parameter List Type Range Direction Description iControllerID int 1-65535 1 In Command station type ID pbsName BSTR * 2 Out Command station type name 1 See FIG. 6: Controller ID to controller name mapping for values. Maximum value for this server is given by KamMiscMaxControllerID. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description bsName BSTR 1 Command station type name Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetControllerName takes a command station type ID and a pointer to a type name string as parameters. It sets the memory pointed to by pbsName to the command station type name. 0KamMiscGetControllerNameAtPort Parameter List Type Range Direction Description iLogicalPortID int 1-65535 1 In Logical port ID pbsName BSTR * 2 Out Command station type name 1 Maximum value for this server given by KamPortGetMaxLogPorts. 2 Exact return type depends on language. It is Cstring * for C++. Empty string on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetControllerName takes a logical port ID and a pointer to a command station type name as parameters. It sets the memory pointed to by pbsName to the command station type name for that logical port. 0KamMiscGetCommandStationValue Parameter List Type Range Direction Description iControllerID int 1-65535 1 In Command station type ID iLogicalPortID int 1-65535 2 In Logical port ID iIndex int 3 In Command station array index. piValue int * 0-65535 Out Command station value 1 See FIG. 6: Controller ID to controller name mapping for values. Maximum value for this server is given by KamMiscMaxControllerID. 2 Maximum value for this server given by KamPortGetMaxLogPorts. 3 0 to KamMiscGetCommandStationIndex. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetCommandStationValue takes the controller ID, logical port, value array index, and a pointer to the location to store the selected value. It sets the memory pointed to by piValue to the specified command station miscellaneous data value. 0KamMiscSetCommandStationValue Parameter List Type Range Direction Description iControllerID int 1-65535 1 In Command station type ID iLogicalPortID int 1-65535 2 In Logical port ID iIndex int 3 In Command station array index iValue int 0-65535 In Command station value 1 See FIG. 6: Controller ID to controller name mapping for values. Maximum value for this server is given by KamMiscMaxControllerID. 2 Maximum value for this server given by KamPortGetMaxLogPorts. 3 0 to KamMiscGetCommandStationIndex. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscSetCommandStationValue takes the controller ID, logical port, value array index, and new miscellaneous data value. It sets the specified command station data to the value given by piValue. 0KamMiscGetCommandStationIndex Parameter List Type Range Direction Description iControllerID int 1-65535 1 In Command station type ID iLogica1PortID int 1-65535 2 In Logical port ID piIndex int 0-65535 Out Pointer to maximum index 1 See FIG. 6: Controller ID to controller name mapping for values. Maximum value for this server is given by KamMiscMaxControllerID. 2 Maximum value for this server given by KamPortGetMaxLogPorts. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetCommandStationIndex takes the controller ID, logical port, and a pointer to the location to store the maximum index. It sets the memory pointed to by piIndex to the specified command station maximum miscellaneous data index. 0KamMiscMaxControllerID Parameter List Type Range Direction Description piMaxControllerID int * 1-65535 1 Out Maximum controller type ID 1 See FIG. 6: Controller ID to controller name mapping for a list of controller ID values. 0 returned on error. Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscMaxControllerID takes a pointer to the maximum controller ID as a parameter. It sets the memory pointed to by piMaxControllerID to the maximum controller type ID. 0KamMiscGetControllerFacility Parameter List Type Range Direction Description iControllerID int 1-65535 1 In Command station type ID pdwFacility long * 2 Out Pointer to command station facility mask 1 See FIG. 6: Controller ID to controller name mapping for values. Maximum value for this server is given by KamMiscMaxControllerID. 2 0 - CMDSDTA_PRGMODE_ADDR 1 - CMDSDTA_PRGMODE_REG 2 - CMDSDTA_PRGMODE_PAGE 3 - CMDSDTA_PRGMODE_DIR 4 - CMDSDTA_PRGMODE_FLYSHT 5 - CMDSDTA_PRGMODE_FLYLNG 6 - Reserved 7 - Reserved 8 - Reserved 9 - Reserved 10 - CMDSDTA_SUPPORT_CONSIST 11 - CMDSDTA_SUPPORT_LONG 12 - CMDSDTA_SUPPORT_FEED 13 - CMDSDTA_SUPPORT_2TRK 14 - CMDSDTA_PROGRAM_TRACK 15 - CMDSDTA_PROGMAIN_POFF 16 - CMDSDTA_FEDMODE_ADDR 17 - CMDSDTA_FEDMODE_REG 18 - CMDSDTA_FEDMODE_PAGE 19 - CMDSDTA_FEDMODE_DIR 20 - CMDSDTA_FEDMODE_FLYSHT 21 - CMDSDTA_FEDMODE_FLYLNG 30 - Reserved 31 - CMDSDTA_SUPPORT_FASTCLK Return Value Type Range Description iError short 1 Error flag 1 iError = 0 for success. Nonzero is an error number (see KamMiscGetErrorMsg). KamMiscGetControllerFacility takes the controller ID and a pointer to the location to store the selected controller facility mask. It sets the memory pointed to by pdwFacility to the specified command station facility mask.