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. [. . . ] 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 <Message version="1. 0"> <Data> <Text channel="A" error-indication="no"> <Translated alphabet="ita2-latin"> Text </Translated> Content </Text> </Data> </Message> Attribute List alphabet attribute Informs with which alphabet the decoded data was translated. Content The content is a translated text data. Raw element <Message version="1. 0"> <Data> <Text channel="A" error-indication="no"> Content <Raw> Text </Raw> </Text> </Data> </Message> Content The content is a the raw text data. Graphic data messages Graphic element <Message version="1. 0"> <Data> <Graphic type="FFT"> Content </Graphic> </Data> </Message> Attribute List type attribute Informs about what type of graphic data is sent. Possible values are "FFT", "SSTV", "Fax". Content The content is a sequence of AxisInfo and GraphicData element. AxisInfo element <Message version="1. 0"> <Data> <Graphic type="FFT"> <AxisInfo count="2"> Content </AxisInfo> Content </Graphic> </Data> </Message> 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 <Message version="1. 0"> <Data> <Graphic type="FFT"> <AxisInfo count="2"> <Axis name="x" unit="Hz" max="4000" min="0"/> <Axis name="y" unit="db" max="0" min="-60"/> </AxisInfo> Content </Graphic> </Data> </Message> 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 <Message version="1. 0"> <Data> <Graphic type="FFT"> Content <GraphicData count="2"> Content </GraphicData> </Graphic> </Data> </Message> 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 <Message version="1. 0"> <Data> <Graphic type="FFT"> Content <GraphicData count="2"> <Point x="0" y="-20. 25" z="" rgb=""/> <Point x="1" y="--40. 5" z="" rgb=""/> </GraphicData> Content </Graphic> </Data> </Message> 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. 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. [. . . ] It is the responsibility of the users of the equipment to determine whether the reception of the transmissions which may be decoded, is permitted or not. The manufacturer or vendor is not liable for violations of law of copyright or telecommunication regulations. Addresses and Dealer Manufacturer and International Distribution WAVECOM ELEKTRONIK AG Hammerstrasse 8 CH-8180 Buelach Switzerland Phone: +41-44-872 70 60 Fax: Web: +41-44-872 70 66 www. wavecom. ch E-mail: info@wavecom. ch WAVECOM Dealer Please, check our dealer list on the Internet www. WAVECOM. ch Literature David Hunter BEGINNING XML 2nd EDITION ISBN: 0-7645-4394-6 Wiley Publishing, Indianapolis Registration Form We added an online product registration form on the Internet. For the registration go to the following page: http://www. wavecom. ch/HTML/product_registration. htm SDK Docu Remote Control Interface V1. 4 Appendix 59 Glossary of Terms base16 Scheme used to transmit binary data. It is the numbering system used to condense binary bytes into a compact form for transmitting or analysis of computer data. [. . . ]