User manual WAVECOM REMOTE CONTROL INTERFACE - VERSION 1.4

SDK Docu Remote Control Interface V1.4 By WAVECOM ELEKTRONIK AG PUBLISHED BY WAVECOM ELEKTRONIK AG Hammerstrasse 8 CH-8180 Buelach Switzerland Phone Fax Email: Internet: +41-44-872 70 60 +41-44-872 70 66 info@wavecom.ch http://www.wavecom.ch © by WAVECOM ELEKTRONIK AG. All rights reserved. Reproduction in whole or in part in any form is prohibited without written consent of the copyright owner. The publication of information in this document does not imply freedom from patent or other protective rights of WAVECOM ELEKTRONIK AG or others. All brand names in this document are trademarks or registered trademarks of their owners. Specifications are subject to change without further notice Printed: Thursday, August 14, 2008, 14:43:21 Contents Welcome 1 Professional Version ...................................................................................... 1 Options ....................................................................................................... 1 Training ....................................................................................................... 1 Source Code ................................................................................................ 1 Company Profile ........................................................................................... 1 Revisions ..................................................................................................... 2 XML Messages 2 Coverage ..................................................................................................... 2 Restriction ................................................................................................... 2 Message categories ....................................................................................... 2 Encoding ..................................................................................................... 3 Message skeleton ......................................................................................... 3 XML header ...................................................................................... 3 Message element ............................................................................... 3 ParameterList element ....................................................................... 4 Parameter element ............................................................................ 4 Data messages 4 Main data message tag.................................................................................. 4 Data element .................................................................................... 4 Binary data messages ................................................................................... 5 Binary element .................................................................................. 5 Text data messages ...................................................................................... 5 Text element .................................................................................... 5 Translated element ............................................................................ 6 Raw element ..................................................................................... 6 Graphic data messages ................................................................................. 6 Graphic element ................................................................................ 6 AxisInfo element ............................................................................... 7 Axis element ..................................................................................... 7 GraphicData element ......................................................................... 7 Point element .................................................................................... 8 BinaryFFT element ............................................................................. 8 Result messages........................................................................................... 9 Result element .................................................................................. 9 MetaData messages 9 Main MetaData message tag .......................................................................... 9 MetaData element ............................................................................. 9 MDCode message tag .................................................................................. 10 MDCode element ............................................................................. 10 MDModulation message tag ......................................................................... 10 MDModulation element ..................................................................... 10 MDInput message tag ................................................................................. 10 MDInput element ............................................................................. 10 MDParameter message tag .......................................................................... 11 MDParameter element ...................................................................... 11 MDDefaultItem message tag ........................................................................ 11 MDDefaultItem element ................................................................... 11 Contents v SDK Docu Remote Control Interface V1.4 MDItemRange message tag ......................................................................... 12 MDItemRange element ..................................................................... 12 MDSteps, MDLowerLimit and MDUpperLimit message tag ................................ 12 MDSteps / MDLowerLimit / MDUpperLimit element .............................. 12 MDItemList message tag ............................................................................. 12 MDItemList element ......................................................................... 12 MDItem message tag .................................................................................. 13 MDItem element ............................................................................. 13 Command messages 13 Main command message tag ........................................................................ 13 Command element .......................................................................... 13 Set messages............................................................................................. 13 Set element .................................................................................... 13 Speed element ................................................................................ 14 ParameterList element ..................................................................... 14 Parameter element .......................................................................... 14 Configuration element ...................................................................... 15 Key element ................................................................................... 15 MilStanagMessageType element ........................................................ 16 ClassifierSetup element .................................................................... 16 Get messages ............................................................................................ 17 Get element .................................................................................... 17 Start messages .......................................................................................... 18 Start element .................................................................................. 18 Connect message ....................................................................................... 19 Connect element ............................................................................. 19 Card element .................................................................................. 19 Disconnect message ................................................................................... 19 Disconnect element ......................................................................... 19 Activate messages ...................................................................................... 20 Activate element ............................................................................. 20 Server element ............................................................................... 20 Information messages 21 Main information message tag ...................................................................... 21 Information element ........................................................................ 21 ParameterList message ............................................................................... 21 ParameterList element ..................................................................... 21 Parameter element .......................................................................... 21 Indicators message ..................................................................................... 22 Indicators element ........................................................................... 22 Cards message ........................................................................................... 22 Cards element ................................................................................. 22 Card element .................................................................................. 22 License message ........................................................................................ 23 License element .............................................................................. 23 Options element .............................................................................. 24 ExpiryDate element ......................................................................... 24 Key element ................................................................................... 24 BufferOverflow message .............................................................................. 25 BufferOverflow element .................................................................... 25 Error message 25 Error message tag ...................................................................................... 25 Error element.................................................................................. 25 Parameter names and values 26 Parameter element ..................................................................................... 26 List of Parameters....................................................................................... 26 vi Contents SDK Docu Remote Control Interface V1.4 Code .............................................................................................. 26 ias ................................................................................................. 30 ecc ................................................................................................ 30 polarity .......................................................................................... 30 scan-mode ..................................................................................... 31 alphabet ......................................................................................... 31 code-table ...................................................................................... 31 auto-speed ..................................................................................... 32 timeslot .......................................................................................... 32 bit-inversion ................................................................................... 32 subcode ......................................................................................... 32 frame-length ................................................................................... 33 frame-format .................................................................................. 33 free-run ......................................................................................... 33 letter-figure-mode ........................................................................... 34 shift-register ................................................................................... 34 display-mode .................................................................................. 34 display-format................................................................................. 34 modulation ..................................................................................... 34 speed ............................................................................................. 35 shift ............................................................................................... 35 center ............................................................................................ 35 auto-mode...................................................................................... 35 afc ................................................................................................. 35 input .............................................................................................. 35 inputgain ........................................................................................ 36 number-of-channels ......................................................................... 36 translation ...................................................................................... 36 bandwidth ...................................................................................... 36 fine-speed ...................................................................................... 36 ioc-module ..................................................................................... 36 agc ................................................................................................ 36 als ................................................................................................. 37 filter .............................................................................................. 37 passband-center.............................................................................. 37 passband-bandwidth ........................................................................ 37 twinshift-1 ...................................................................................... 37 twinshift-2 ...................................................................................... 37 twinshift-3 ...................................................................................... 37 twin-v1 .......................................................................................... 37 twin-v2 .......................................................................................... 37 am-offset ....................................................................................... 38 am-gain ......................................................................................... 38 data-blocklength ............................................................................. 38 data-speed ..................................................................................... 38 data-interleaver .............................................................................. 38 data-blocksize ................................................................................. 38 dte-databits .................................................................................... 38 dte-parity ....................................................................................... 38 dte-startbits.................................................................................... 38 dte-stopbits .................................................................................... 38 diversity (mil-188-110-39tone only) .................................................. 38 threshold-level (W61PC/W-CODE only)............................................... 39 TCP/IP Interface 39 Overview ................................................................................................... 39 Architecture ............................................................................................... 39 Win32 Remote Control Interface API ............................................................. 40 C Application Programming Interface ............................................................ 40 Source ........................................................................................... 40 Sink ............................................................................................... 41 C++ Application Programming Interface ........................................................ 42 Source ........................................................................................... 42 SDK Docu Remote Control Interface V1.4 Contents vii Sink ............................................................................................... 43 XML Message Format .................................................................................. 43 XMLFormatting ................................................................................ 44 XMLEncoding .................................................................................. 44 XMLEOLType ................................................................................... 44 XML Remote Control Interface ...................................................................... 44 Data Package Protocol ...................................................................... 45 Messages ....................................................................................... 45 Connecting to the server .................................................................. 47 Sample Code 49 XML commands sample ............................................................................... 50 CONNECT TO CARD ......................................................................... 50 GET STATUS ................................................................................... 50 SET FFT .......................................................................................... 50 SET BITSTREAM .............................................................................. 50 SET FFTs PER SECOND ..................................................................... 50 GET METADATA FOR FEC-A ............................................................... 50 GET METADATA CODELIST ................................................................ 51 SET FEC-A ...................................................................................... 51 SET BAUDOT ................................................................................... 51 SET COQUELET-8 ............................................................................ 51 SET PACKET-9600 ........................................................................... 51 SET CCIR-1 .................................................................................... 52 SET INMARSAT-C-TDM ..................................................................... 52 SET PACTOR-II................................................................................ 52 SET PSK-31 .................................................................................... 52 SET MIL-188-110A .......................................................................... 52 SET INMARSAT-MINI-M .................................................................... 53 SET ALS ......................................................................................... 53 GET STATUS ................................................................................... 53 SET FFTs PER SECOND ..................................................................... 53 XML RCI: Picture Modes............................................................................... 53 Left to right codes (FELD-HELL and FM-HELL) ..................................... 53 Top down codes .............................................................................. 54 C-Sample .................................................................................................. 56 Appendix 56 Questions & Answers................................................................................... 56 Conditions of Sale ....................................................................................... 57 General .......................................................................................... 57 Prices ............................................................................................. 57 Delivery time .................................................................................. 57 Dispatch ......................................................................................... 57 Return of goods............................................................................... 57 Payments ....................................................................................... 57 Reservation of ownership ................................................................. 57 Cancellation .................................................................................... 58 Changes of order Quantities .............................................................. 58 Legal Domicile................................................................................. 58 Warranty ........................................................................................ 58 Obligation ....................................................................................... 58 Copyright ....................................................................................... 58 Liability .......................................................................................... 58 Laws and Regulations....................................................................... 58 Addresses and Dealer.................................................................................. 58 Manufacturer and International Distribution ........................................ 58 WAVECOM Dealer ............................................................................ 59 Literature .................................................................................................. 59 Registration Form ....................................................................................... 59 Glossary of Terms viii Contents 61 SDK Docu Remote Control Interface V1.4 Index 63 SDK Docu Remote Control Interface V1.4 Contents ix Welcome Congratulations on your purchase of a WAVECOM decoder. The product that you bought incorporates the latest technology in data decoding together with the latest software release available at the time of shipment. Please, check our website http://www.wavecom.ch for software updates. Always check the latest documentation on the installation CD or on our website. We thank you for choosing a WAVECOM decoder and look forward to work with you in the future. This chapter introduces WAVECOM, the field of activity of the company, and how you may benefit from the expertise of WAVECOM. Professional Version This documentation is only available in the professional version of the WAVECOM decoder software. Professional versions are only available to government bodies. WAVECOM maintains a mailing list of our professional customers. For registration details, see Appendix at the end of this manual. Options Different additional options are available from WAVECOM. In the manual, options are marked with (Option). Options are only available to government bodies. Training Please, note that when required WAVECOM is able to provide training on the WAVECOM XML interface. Training can be ordered to take place at the customer location or at our offices in Switzerland. Source Code Source code is available for professional users. Please, inquire to receive an offer from WAVECOM if you plan to add your own modes. Company Profile WAVECOM ELEKTRONIK GmbH was founded in 1985 in Hohentengen, Germany, close to the Swiss border. In 1991 the company moved to Switzerland and established itself as WAVECOM ELEKTRONIK AG. Now located in Buelach it is within close vicinity of Zuerich airport. The company has focused on decoding and analysis systems for wireless data transmissions. The wide product range spans from professional, high performance systems to devices for private and amateur radio use. The very high quality standards combined with high system performance are appreciated by all customers worldwide. A global network of authorized sales partners ensures that local assistance and basic level support can be provided in most places. More than 95% of all units sold are exported. The majority of the customers are government agencies, defense organizations and the telecommunication industry. About 40% of the turnover is invested in research and development. The employees at WAVECOM ELEKTRONIK AG are mainly engineers with experience in DSP technology, computer and RF hardware development, software engineering and radio data transmission. Access to external know-how and human resources enlarges the capabilities for realizing projects. Manufacturing is outsourced to specialized companies within Switzerland which can handle today's needs for processing surface mount components and fine-pitch structures. SDK Docu Remote Control Interface V1.4 Welcome 1 WAVECOM ELEKTRONIK AG does not have any juridical or financial links or connections to other companies or official bodies and is completely owned by its general manager, Mr. Christian Kesselring. Revisions Version Beta Release 1.1 Date 20.Jul.2005 25.Jan.2006 15.July 2006 Changes Initial draft BinaryFFT element fft-data-format frame-length frame-format minor bug fixes passband-center passband-bandwidth MilStanagMessageType element ClassifierSetup element Get element - item classifiersetup settings New codes in table New diversity parameter New threshold-level parameter New layout W-CODE added 1.2 7.5.2007 1.3 25.3.2008 1.4 13.8.2008 XML Messages Coverage This document describes all the available XML messages used to interact with the WAVECOM Remote Control Interface (RCI). This document contains all the information from the DTD (Document Type Definition) plus information to the attributes where additional explanations are needed. Restriction The used values in the description of the messages are only valid in a XML context. In the context of business logic of the WAVECOM card the values can be invalid. Message categories Messages are split into the four categories: Category Data MetaData Command Information Error Direction server to the client Text, binary data, analysis data server to the client Information about parameters. client to the server server to the client server to the client Typ Settings Settings Data, MetaData, Information and Error messages are from the server to the client, Command messages from the client to the server. Data messages contain transformed data from the radio signal, like text, pictures, binary or analysis data. With the command messages the client controls the behavior of the server and its underlying cards. Information messages provide information about the hardware, versions, the state of the cards, state and configuration of the server. Error messages inform about errors of the server system (not errors in decoded data). Encoding The XML files are encoded in UTF-8, UTF-16 or Unicode. Message skeleton Content serial-nr="0210125807" date="20050412" XML header The XML header is not interpreted by the server, it can be included or not. It is also not filled in server messages Message element The implied attributes; card, serial-nr, date and time are only filled by the server if it extended messageheader is set. This can be done by sending a set configuration message. Attribute List version attribute The message version is formatted like major.minor. A server can handle all messages from a client as long as the major versions are equal and the minor version of the server is equal or greater then the minor version from the client. This attribute is Fixed in a specific dtd to the version of the dtd. instance/subinstance attribute In the future multiple codes can be instantiated on a single card, that the server knows to whom a message is assigned to or the client knows from whom the message is coming. This attributes are implied and are not used in this release. serial-nr attribute The serial number of the card assigned to this client. This attribute is implied and represents a string. date attribute Date of message creation. This attribute is implied and represents a string, the format of the date is YYYYMMDD. time attribute Time of message creation. This attribute is implied and represents a string, the format of the time is hh:mm:ss:milliseconds. content attribute The content is a choice of the elements; Data, MetaData, Command, Information and Error. SDK Docu Remote Control Interface V1.4 XML Messages 3 ParameterList element content Content The content is a sequence of 1 or more Parameter elements. Parameter element Attribute List name attribute Name of the parameter. This attribute is required and is a string. value attribute Value of the parameter. This attribute is required and is an integer, a floating point or a string value just depending on the parameter. Content This element has no content. Note: A detailed description of the name and value pairs are listed later in this document and can be received with the MetaData message (receiving MetaData can be initiated with the Get Message). Data messages Main data message tag Content Data element Content The content is a choice of 1 or more of the element Binary, Text, Graphic or Result. Binary data messages Binary element Content Attribute List Encoding attribute Informs how the content is encoded. This attribute is required and is a choice of "base2", "base16", "base64" and "base64-mime". The difference between "base64" and "base64-mime" is how the end of the encoded string looks like, both uses the same character set but "base64-mime" follows the specification made for SMTP messages. It aligns the string to 4 character and fills unused with the padding character "=", "base64" cuts down the characters to the only needed ones depending on the bit-count. bit-count attribute Informs how many bits are transferred, because there are trailing zero (8-Bit Alignment) which are not part of the data. This attribute is required and is a string representing a positive integer. Content The content is a string of encoded binary data, which was decoded by the card. Text data messages Text element Content Attribute List channel attribute Informs from which channel the decoded data came from, in single channel codes it is always channel "A". This attribute is required and is a choice of "A", "B", "C" and "D". error-indication attribute Indicates an error in the decoded data. This attribute is required and is a choice of "no" and "yes". Note: The channel information and error indication is valid for all the content of a single text element. Content The content is a sequence of 0 or 1 Translated element and 0 or 1 Raw element. Note It can be configured if only translated text, raw text or both together is transferred (see message Command/Set/Configuration). SDK Docu Remote Control Interface V1.4 Data messages 5 Translated element Text Content Attribute List alphabet attribute Informs with which alphabet the decoded data was translated. This attribute is required and represents a string. Content The content is a translated text data. Raw element Content Text Content The content is a the raw text data. Graphic data messages Graphic element Content Attribute List type attribute Informs about what type of graphic data is sent. This attribute is required and is a string. Possible values are "FFT", "SSTV", "Fax". Content The content is a sequence of AxisInfo and GraphicData element. AxisInfo element Content Content Attribute List count attribute Informs about how many axis are described. This attribute is required and represents a integer. Content The content is a sequence of 1 or more Axis elements. Axis element Content Attribute List name attribute The name of the axis. This attribute is a choice of "x", "y" or "z". unit attribute Unit of the values. This attribute is required and is a string. max attribute Maximum value possible. This attribute is required and represents a integer. min attribute Minimum value possible. This attribute is required and represents a integer. Content This element has no content. GraphicData element Content Content Attribute List SDK Docu Remote Control Interface V1.4 Data messages 7 count attribute Informs about how many points are sent. This attribute is required and represents a integer. Content The content is a sequence of 1 or more Point elements or a single Binary FFT element. Point element Content Content Attribute List x/y/z attributes The coordinates of the value. This attributes are implied and represents an integer or a floating point value just depending of what type of graphic is sent. rgb attribute RGB color Information values. This attribute is implied and is a string. It is sent in the following hex format: "0xRRGGBB". Content This element has no content. BinaryFFT element 023F023FAAAA....023F023F Attribute List This element has no attributes. Content The content is the binary encoded FFT data. The encoding type (base2, base16, base64 or base64-mime) is set by the Set Configuration Message. According to the selected encoding type, characters are converted into bits. Encoding type base2 base16 base64 base64-mime Bits per character 1 4 6 6 Character set 0,1 0-9,A-F 0-9,A-Z,a-z,+,/ 0-9,A-Z,a-z,+,/ ("=" for 8bit aligning) Each FFT value is represented by a signed 16 bit word, where 12 bits are used for the integer part and 4 bits are used for the real part of the value. The following example shows how to get the FFT value out of a bit stream: Received: Mirrored: Integer-part: Real-part: FFT value = 1101 0101 0011 1111 1111 1100 1010 1011 (due to network order) 1111 1100 1010 = -54 (two's complement) 1011 value = 11/16 = 0.6875 -54 + 0.6875 = -53.3125 dB Result messages Result element content Attribute List description attribute Description of the result. This attributes is required and is a string. Content The content is the result in a text format. MetaData messages Main MetaData message tag MetaData element Content Attribute List info attribute Informs about what kind of MetaData. This attribute is required and is a choice of "code" and "code-list". Content The content is a sequence of 1 or more MDCode elements. SDK Docu Remote Control Interface V1.4 MetaData messages 9 MDCode message tag MDCode element Content Attribute List value attribute Code. This attribute is required and is a choice of all possible codes. Content The content is a sequence of 0 or more MDParameter elements, 0 or more MDModulation elements and 0 or more MDInput elements. MDModulation message tag MDModulation element Content Attribute List value attribute Modulation. This attribute is required and is a choice of all possible modulations. Content The content is a sequence of 0 or more MDParameter elements. MDInput message tag MDInput element Content Attribute List value attribute Input. This attribute is required and is a choice of all possible inputs. description attribute Additional information about the input Content The content is a sequence of 0 or more MDParameter elements. MDParameter message tag MDParameter element Content Attribute List name attribute Name of the parameter. This attribute is required and is a string. info attribute Information of the parameter format. This attribute is required and is a choice of "integer", "floating-point" or "string". access attribute Access rights to a parameter. This attribute is required and is a choice of "read-only" or "read-write". Content The content is a sequence of MDDefaultItem elements, 0 or 1 MDItemRange element and 0 or 1 MDItemList element. MDDefaultItem message tag MDDefaultItem element Content Content The content is a MDItem element. SDK Docu Remote Control Interface V1.4 MetaData messages 11 MDItemRange message tag MDItemRange element Content Content The content is a sequence of 0 or 1 MDSteps element, a MDLowerLimit element and a MDUpperLimit element. MDSteps, MDLowerLimit and MDUpperLimit message tag MDSteps / MDLowerLimit / MDUpperLimit element Content Content Content Content The content is a MDItem element. MDItemList message tag MDItemList element Content Content The content is 1 or more MDItem element. MDItem message tag MDItem element Attribute List value attribute This attribute is required and represents an integer, a floating point or a string, it depends on the info attribute of the MDParameter tag. Command messages Main command message tag Command element Content Content The content is a choice of the elements Set, Get, Start, Connect, Disconnect and Activate. Set messages Set element Content Content The content is a choice of the elements Speed, ParameterList, Configuration and Key. SDK Docu Remote Control Interface V1.4 Command messages 13 Speed element Attribute List limit attribute Speed limit of the connection to the server. This attribute is required and a choice of "9600", "14400", "19200", "56k", "64k", "128k", "512k", "1M", "2M", "5M", "10M" and "no" for unlimited. Content This element has no content. ParameterList element content Content The content is a sequence of 1 or more Parameter elements. Parameter element Attribute List name attribute Name of the parameter. This attribute is required and is a string. value attribute Value of the parameter. This attribute is required and is an integer, a floating point or a string value just depending on the parameter. Content This element has no content. Note: A detailed description of the name and value pairs are listed later in this document and can be received with the MetaData message (receiving MetaData can be initiated with the Get Message). Configuration element Attribute List message-header The Message tag has a few implied attributes (see message skeleton) which are only filled by the server if recommended by the client, this attribute sets the filling preferences. This attribute is implied and is a choice of "short" or "extended". text-data-format Specifies how the content is displayed in the text data message. This attribute is implied and is a choice of "translated", "raw" and "all". Translated means the detected text is translated with the chosen alphabet. Raw means it is the raw detected text. All means all forms of displaying the text are transferred. binary-data-format Specifies how the content is encoded in the binary data message. This attribute is implied and is a choice of "base2", "base16", "base64" and "base64-mime". The difference between "base64" and "base64-mime" is how the end of the encoded string looks like, both uses the same character set but "base64-mime" follows the specification made for SMTP messages it aligns the string to 4 character and fills unused with the padding character "=", "base64" cuts down the characters to the only needed ones depending on the bitcount. information-indicators-interval-per-minute Here it can be configured how many information indicators messages are sent to the client. It is a maximum value, if it is configured to 60 messages per minute the client receives between 0 ­ 60 Messages every minute. This attribute is implied and represents an integer, 0 means no message at all, greater 6000 means all messages. fft-interval-per-second Here it can be configured how many fft graphic messages are sent to the client. It is a maximum value, if it is configured to 20 messages per second the client receives between 0 ­ 20 Messages every second. This attribute is implied and represents an integer, 0 means no message at all, greater 100 means all messages. fft-data-format The user has the choice between "text" and "binary" FFT format, where the default setting is text. Content This element has no content. Key element XADF3BDFERTP233QWWTR2WQ66 Attribute List This element has no attributes. SDK Docu Remote Control Interface V1.4 Command messages 15 Content The content is the key to be set. MilStanagMessageType element Attribute List sync-mode The sync mode is a choice between "async" and "sync". data-bits The number of data bits from 5 to 8. parity-bits The number of parity bits from 0 to 1. stop-bits The number of stop bits from 0 to 2. bit-sequence The bit sequence order is a choice between "lsb" and "msb". display-format The display format is a choice among "ascii", "ita2", "ita5", "hex" and "binary". The Stanag-4285 code has an additional display format: "s5066". ClassifierSetup element Attribute List mode The classifier mode is a choice between "manual-mode" and "continuous-mode". data-acquisition Data-acquisition is a choice between "previous-samples" and "new-samples". refresh-list Set the refreshing of the list "on" or "off". cw-protection Set the cw-protection "on" or "off". ofdm-mode The ofdm-mode is a choice between "partial-analysis" and "full-analysis". restart-cycle The number of seconds for the restart period is a value between 4 and 3600. sample-time The sample-time is a choice between "1.6" and "3.2". options-mode The options-mode is a choice between the following operation-modes: "auto-classify-codecheck-confidence" "auto-classify-codecheck-confidence-restart" "auto-classify-codecheck-level" "auto-classify-codecheck-level-restart" "man-classify-auto-codecheck" "man-classify-man-codecheck" "man-classify-codecheck-only" Please refer to the W51PC/W61PC/W-CODE manual in the HF Classifier Code Check section for detailed information. modulation-mode Set the signals to be classified. Modulation-mode is either a collection of "fsk", "f7b", "mfsk", "cw", "2psk", "4psk", "8psk", "16psk", "oqpsk", separated by comma, or the sole value "all". E.g. "fsk,mfsk,8psk" or "cw,oqpsk" etc. Get messages Get element Attribute List item The item the client wants to have. This attribute is required and is a string. If the string is not recognized by the server it will return an error message. Description of possible item values "card status" Returns the card state of all cards in a system. The client doesn't have to be connected to a specific card on the system. "license" Returns the license information for the actual connected card. "license with check" Returns the license information for the actual connected card. It forces a check of the license information on the DSP. SDK Docu Remote Control Interface V1.4 Command messages 17 "metadata" Returns meta data. What kind of meta data is specified in the information attribute. The client doesn't have to be connected to a specific card on the system. "milstanag message type" Returns the current message type for mil/stanag codes. "parameter-list" Returns the parameter list for the current code. "classifiersetup-settings" Returns the current classifier configuration. information Information about the item the client wants to have. This attribute is implied and is a string. Description of possible information for the item "metadata" "code-list" Returns a list of all codes supported by that server. "code" Returns all information about a specific code. The specific Code has to be set in the additional-information attribute additional-information Additional information about the item the client wants to have. This attribute is implied and is a string. It is only used if item="metadata" and information="code". The additional information describes the name of the code. A list of all possible codes can be received by selecting "code-list" in the information attribute. Content This element has no content. Start messages Start element Attribute List item The item the client wants to have started. This attribute is required and is a string. If the string is not recognized by the server it will return an error message. Description of possible item values "ASCS auto analysis" Starts the ASCS auto analysis. Returns an error if the ASCS auto analysis is not supported by the code which is set on the connected card. "resync" Resynchronizes the actual code. Content This element has no content. Connect message Content Connect element Attribute List This element has no attributes. Content The content is a sequence of one Card element. Card element Attribute List number Number of the card. This attribute is implied and represents an integer between 1 and 8. name name of the card. This attribute is implied and represents a string. serial-nr Serial number of the card. This attribute is implied and represents an unsigned integer. Note: The card element actually has more attributes then the three described here, but they are irrelevant inside of the connect message and are ignored if they are set in this case. To connect to a card only one of the three above described attributes is needed. If more then one is set with a valid value, the priority for which card is set is: 1. serial-nr (recommended) 2. number 3. name Content This element has no content. Disconnect message Disconnect element It disconnects from the actually connected card. SDK Docu Remote Control Interface V1.4 Command messages 19 Attribute List This element has no attributes. Content This element has no content. Activate messages Content Activate element Attribute List item The item to activate. This attribute is required and is "GUI-Application" (starts the GUI Application on the specified server and connects it to the same server and card the remote client is connected to). Content The content is a choice of server element. Server element Attribute List address IP Address or network name. "local" or "127.0.0.1" stands for the same machine as the client is running on. This attribute is required and is a string. port SCI (Server Control Interface) port of the server on the chosen address. This attribute is required and is a String, if it is empty it takes the standard SCI port. Content This element has no content. Information messages Main information message tag Content Information element Content The content is a choice of the elements ParameterList, Indicators, Cards, License and BufferOverflow. ParameterList message ParameterList element content Content The content is a sequence of 1 or more Parameter elements. Parameter element Attribute List name attribute Name of the parameter. This attribute is required and is a string. value attribute Value of the parameter. This attribute is required and is an integer, a floating point or a string value just depending on the parameter. Content This element has no content. Note: A detailed description of the name and value pairs are listed later in this document and can be received with the MetaData message (receiving MetaData can be initiated with the Get Message). SDK Docu Remote Control Interface V1.4 Information messages 21 Indicators message Content Cards element Attribute List This element has no attributes. Content The content is a sequence of one ore more of the element Card.