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. 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. [. . . ] It is sent in the following hex format: "0xRRGGBB". Content This element has no content. BinaryFFT element <Message version="1. 0"> <Data> <Graphic type="FFT"> <AxisInfo count="2"> <Axis name="x" unit="Hz" max="1050" min="950"/> <Axis name="y" unit="db" max="0" min="-60"/> </AxisInfo> <GraphicData count="2048"> <BinaryFFT>023F023FAAAA. . . . 023F023F</BinaryFFT> </GraphicData> </Graphic> </Data> </Message> 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 <Message version="1. 0"> <Data> <Result description="status-line"> content </Result> </Data> </Message> 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 <Message version="1. 0"> <MetaData info="code"> Content </MetaData> </Message> 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 <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> Content </MDCode> </MetaData> </Message> 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 <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDModulation value="dsp"> Content </MDModulation> </MetaData> </Message> 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 <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDInput value="inp1" description="AFIF#1:0-25 MHz input"> Content </MDInput> </MetaData> </Message> 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 <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDParameter name="shift" info="integer" access="read-write"> Content </MDParameter> </MetaData> </Message> 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 <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDParameter name="shift" info="integer" access="read-write"> <MDDefaultItem> Content </MDDefaultItem> </MDParameter> </MetaData> </Message> Content The content is a MDItem element. SDK Docu Remote Control Interface V1. 4 MetaData messages 11 MDItemRange message tag MDItemRange element <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDParameter name="shift" info="integer" access="read-write"> <MDItemRange> Content </MDItemRange> </MDParameter> </MetaData> </Message> 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 <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDParameter name="shift" info="integer" access="read-write"> <MDItemRange> <MDSteps> Content </MDSteps> <MDLowerLimit> Content </MDLowerLimit> <MDUpperLimit> Content </MDUpperLimit> </MDItemRange> </MDParameter> </MetaData> </Message> Content The content is a MDItem element. MDItemList message tag MDItemList element <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDParameter name="shift" info="integer" access="read-write"> <MDItemList> Content </MDItemList> </MDParameter> </MetaData> </Message> Content The content is 1 or more MDItem element. MDItem message tag MDItem element <Message version="1. 0"> <MetaData info="code"> <MDCode value="fec-a"> <MDParameter name="shift" info="integer" access="read-write"> <MDDefaultItem> <MDItem value="50"/> </MDDefaultItem> </MDParameter> </MetaData> </Message> 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 <Message version="1. 0"> <Command> Content </Command> </Message> Content The content is a choice of the elements Set, Get, Start, Connect, Disconnect and Activate. Set messages Set element <Message version="1. 0"> <Command> <Set> Content </Set> </Command> </Message> 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 <Message version="1. 0"> <Command> <Set> <Speed limit="no"/> </Set> </Command> </Message> 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 <Message version="1. 0"> <Command> <Set> <ParameterList> content </ParameterList> </Set> </Command> </Message> Content The content is a sequence of 1 or more Parameter elements. Parameter element <Message version="1. 0"> <Command> <Set> <ParameterList> <Parameter name="code" value="fec-a"/> <Parameter name="modulation" value="dsp"/> </ParameterList> </Set> </Command> </Message> 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 <Message version="1. 0"> <Command> <Set> <Configuration message-header="short" text-data-format="translated" binary-dataformat="base64" information-indicators-interval-per-minute="60" fft-interval-per-second="5" fft-data-format="text"/> </Set> </Command> </Message> 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. 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 hexadecimal number system is a base-16 numbering system. It is the numbering system used to condense binary bytes into a compact form for transmitting or analysis of computer data. It is composed of the numbers 0-9 and the letters A-F. Each "nibble" (4 bits) of a byte can be represented by one of the 16 digits. base2 Scheme used to transmit binary data. [. . . ]