Devices Creating An Ir-based Driver

Transcript

Devices Creating an IR-Based Driver This solution shows how to create an IR device for K-Touch by learning the commands from an IR remote. IR learning is done with a Kramer FC-26. Note: IR learning was added to the FC-26 with firmware version 1.11.24319. Upgrade your FC-26 if necessary. 1. Download an XML Editor ■ All K-Touch commands are written in XML format. While not 100% needed, a true XML editor allows you to navigate the document more easily. ■ If you do not already have an XML editor, download a free one like Atom (www.atom.io). 2. Download the IR Template.xml ■ Attached to this knowledge base article is a file called "IR Template.xml". ■ Download the file. 3. Open the IR Template in your XML Editor ■ Open Atom (or other XML editor) and open the IR Template.xml file. 4. Enter Device Properties ■ The first tag is 'device'. It contains six properties. ■ Replace the values with ones for this IR device. Fixed: This value is "false" Model: Enter the model of the IR device in quotes. Name: Enter the name of the device as you wish to see it in the builder in quotes. Shared: This value is "false". Type: Type of device from the following list: AUX (default), AV System, Blu Ray, Cable, CD, DTV Converter, DVD, DVD/VCR Combo, Game, Home Theater System, iPod, Laser Disc, Lighting, Media Manager, Multizone System, Projector, Receiver/Preamp, Satellite, Set Top Box, Shading, Soundbar, Subwoofer, Switcher, Tuner, Thermostat, TV, TV/DVD Combo, TV/DVD/VCR Combo, TV/VCR Combo, VCR, Video Processor, Unknown Type. Vendor: Manufacturer of device in quotes. ■ The following is an example for the Apple TV device built in this tutorial. ? ■ Now you are ready to learn and enter the codes into the device 5. Go to the FC-26 Web Page ■ Connect your PC and the FC-26 to the same network and navigate to the FC-26 Web page. ■ Click on the IR Command Learner tab. 6. Learn a Command ■ Click 'Start Learning' in the FC-26 Web page. ■ Holding the IR remote that you are using, point it at the IR In on the front of the FC-26 and press one of the buttons you wish to learn. ■ Note: Be sure that when you are learning IR commands you are in an environment without any other IR interferance (flourescent lights, other IR remotes, etc.) ■ ■ Hold the IR remote as close as possible to the IR receiver "eye". The command appears in the command received box. 7. Add Command to XML Device ■ Use the copy button in the FC-26 Web page to copy the IR command. ■ Switch back to your XML editor. ■ Follow the convention of the example codes for your new code. ■ Type the name of the command between the quotes after Code name= (in this case, the menu command). ■ Enter the command after the > and before the . 8. Repeat for All Needed Commands ■ Repeat steps 6 and 7 for all the commands you need for this one device. ■ Delete the example codes. 9. Save As ■ The XML device is finished. Save the file on your computer with a .xml extension. 10. Upload your Device to the K-Touch Builder ■ Go to the device tab and click on the menu option. ■ Choose Upload devices. ■ Choose the file and click Upload. ■ View the new device in the builder with all the commands. 11. Share your IR Device with Kramer (optional) ■ We are always trying to expand our driver database. To add your driver to our global database of devices, email the XML file to [email protected] ■ We appreciate your help. Adding Devices from the Device Library In K-Touch, devices contain the commands for the products they control. Every controlled device is represented in the K-Touch Builder. 1. Devices Tab ■ Start by clicking the Devices tab on the right side of the Builder. 2. Device Menu ■ Open the device menu by clicking on the button indicated below. 3. Select Browse Devices The following options are available: ■ Create Item: Create a device from scratch ■ Upload Device: Upload a device from a K-Touch compatible XML file on your PC ■ Browse Devices: Browse Kramer’s device library to find the product you need This solution focuses on browsing Kramer’s device library since it is the most common way to add devices. 4. Choose a Library You can browse devices in two different device libraries. ■ Kramer: Devices maintained and uploaded by Kramer Electronics ■ Dealer: Devices uploaded by someone in your dealership and shared 5. Search for Your Device On the browse device screen there are four options for filtering your search results: ■ Type: Filter by device type (e.g. switcher, cable box, Blu-ray, etc.) ■ Vendor: Name of the device manufacturer ■ Model: Device model number ■ Codes: Filter by type of codes (e.g. IR, IP, RS-232) For best search results, we recommend just entering the vendor name. Since many devices share the same control codes, the exact model number of the device you want may not appear. ■ Click Search. 6. Import Devices ■ After finding the devices you want, click the check box for each device. ■ After selecting the devices, click the Import button and your sevices are uploaded into the Devices tab. 7. Finished The devices are now in the devices tab and are ready to use with your project. Requesting a Device Driver K-Touch requires a device driver for every device that it controls. Kramer maintains and updates a library of device drivers for thousands of commonly used 3rd party devices. If the device you are trying to control does not exist in our library, there are two solutions: 1. Create a new device from scratch using K-Touch Builder to directly create or edit devices. This requires knowledge of the 3 rd party device protocol to enter commands into the system. or 2. Ask Kramer to create a custom driver for you. Fill out an online form to send details of your device to Kramer’s Technical Support Department. We research the device, create the driver and add it to our database. This solution explains how to request a device driver from Kramer. 1. Go to Kramer’s Web Site ■ Using a Web browser, go to http://www.kramerelectronics.com. 2. Support Tab ■ Click on the Support tab. 3. Request a Driver ■ Scroll down on the page and click, ‘Request a Driver’. 4. Fill Out Request Form ■ A request form pops up. Fill it out. 5. Submit the Form ■ After filling out the form, click submit to send your request to Kramer Technical Support. After submitting your request, an email is automatically generated and sent to our device driver team. Although most device drivers are completed quickly, allow up to two weeks for our team to fulfill your request. Building a Device Driver While the K-Touch Builder contains thousands of RS-232/IP/IR drivers that control 3rd party devices, you may need to create a new driver for a device that doesn’t exist in our library. This article explains how to accomplish this. 1. Select the devices tab. 2. Click the + to add a new device. 3. Enter the device properties. ■ Name: Give the device a name ■ Shared: Select YES if you would like to share this device within your organization ■ Vendor: Enter the vendor of the product you are creating a device for ■ Type: Select a device type ■ Model: Enter the model number of the device 4. Expand the device, select network codes, and click the + to add a command. 5. Enter the properties for the device code. ■ Name: Give the device code a name ■ Data: Enter the data that needs to be sent to the device to achieve your action. All ASCII characters can just be written. HEX characters must be prefixed with \x (Example� Carriage Return = \x0D) 6. Repeat steps 4 and 5 until all the codes you need for this device are built.