You are here: MyURC.org > TR > ir-serial-codes-file1.0-20091105 > Draft

IR/Serial Codes File Format 1.0 (DRAFT)

Abstract

This document describes the format of IR or serial codes files, as used by Generic Target Adapters connecting to IR or serial-controlled legacy devices.

"IR code file" resource has property http://myurc.org/ns/res#type = http://myurc.org/TR/uch/#irconfig

"Serial code file" resource has property http://myurc.org/ns/res#type = http://myurc.org/TR/uch/#serialconfig

Status of this Document

This is a public Draft Technical Report, developed by the editor, hereby made available for review by URCC members and the public.

Comments on this document should be sent to the editor.

Publication as a Draft Technical Report does not imply endorsement by the URCC membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

Open Issues / To Dos [to be removed before release]

1. In case of a UIS variable, we want to specify the exact value to set for that variable. Current XML spec only has command name, whereas we should have command/variable name and value to be set.
2. Provide an XSD.

Change Log [to be removed before final release]

NOTE: The change log is in reverse chronological order.

2009-08-13 Plenar Technologies:

• Initial version

Table of Contents:

1. Introduction

2. IR Codes File Format

IR code XML file includes details of the device, command names and Pronto Hex codes for each command. Mapping of UI Socket commands to actual IR codes is included here. Provided such a file, a Generic IR Target Adapter can control any IR device.

A sample example of IR code file(Pronto code file) is prontocode-denonrc-1017.config.

<prontoCodes>
	<manufacturer>Manufacturer</manufacturer>
	<modelNumber>[Model Number]</modelNumber>
	<command>
		<name>[Command Name]</name>
		<code>[Pronto Code]</code>
	</command>
</prontoCodes>

Whereby:

3. Serial Codes File Format

There is currently no generic Target Adapter for serial devices. Initial implementations include a Target Adapter for serial control of the DENON 1940CI DVD player. The file formats specified in this section apply to this DVD player only, and might be replaced by a more generic format in future versions of this specification. A sample example of Serial code file is serialcode-denonrc-1017.config.

<!-- Serial codes file for DVD player DENON 1940CI -->
<serialCodes>
   <manufacturer>[Manufacturer]</manufacturer>
   <modelName>[Model Name]</modelName>
   <modelNumber>[Model Number]</modelNumber>
   <commands>
      <command>
         <name>[Command Name]</name>
         <requestCode>[Request Code]</requestCode>
         <successResp>
            <code length=[Length]>
               <value type="header"></value>
               <value type="value" position="[Position]" length="[Length]" > 
                  <uisElement name="[Element Name]"> 
                     <valueFormat>[Value Format]</valueFormat>
                     <valueMapping forPosition="[For Position]">[Value Map Name]</valueMapping> 
               </value>
            </code>
         </successResp> 
         <failureResp> 
            <code length=[Length]>  
               <value type="header"></value> 
               <value type="value" position="[Position]" length="[Length]" > 
                  <uisElement name="[Element Name]"> 
                     <valueFormat>[Value Format]</valueFormat> 
                     <valueMapping forPosition="[For Position]">[Value Map Name]</valueMapping> 
               </value>
            </code>
         </failureResp>
      </command>
   </commands>
   <updates> 
      <update> 
         <code length=[Length]> 
            <value type="header">[Value]</value> 
            <value type="value" position="[Position]" length="[Length]" >
               <uisElement name="[Element Name]">
                  <valueFormat>[Value Format]</valueFormat>
                  <valueMapping forPosition="[For Position]">[Value Map Name]</valueMapping>
            </value>
         </code>
      </update>
   </updates>
   <valueMaps> 
      <valueMap> 
         <pair>
            <hexValue>[HEX Byte]</hexValue>
            <value>[Value]</value>
         </pair>
      </valueMap>
   </valueMaps>
</serialCodes>

Whereby:

4. References

For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

[RES-PROP-VOCAB]

URC Consortium: Resource Property Vocabulary. Latest specification available at: http://myurc.org/TR/res-prop-vocab/