JP1 - Just How Easy Is It? - RM-IR Version
(→Starting a New Upgrade and the Setup Tab)
|Line 228:||Line 228:|
=Remote Specific Features=
=Remote Specific Features=
If you have an Xsight or Nevo remote, Remote Master has several enhancements to support
If you have an Xsight or Nevo remote, Remote Master has several enhancements to support additional features. For more information about these remotes, see [http://www.hifi-remote.com/wiki/index.php?title=Getting_started_with_Xsight_and_Nevo Getting started with Xsight and Nevo].
Revision as of 00:34, 25 January 2017
JP1 is a home-made process that you can use to re-program your UEI remote (ie, One For All and Radio Shack, and other brands) from your PC. Not only does it allow you to manage your macros, etc in a much easier way than doing it on the remote itself, it also lets you customize the remotes in ways not previously possible and it lets you add upgrades which let the remote to control devices it would not otherwise control.
Why Do I Need JP1?
If you have a JP1 compatible remote, but it doesn't control all of your devices, you need JP1 so you can add upgrades which will let your remote control those devices. While some UEI remotes are equipped with modems that allow you to download upgrades over the phone (or web), this only works if UEI has already developed an upgrade for your un-supported device. With JP1 you don't need to wait. In most cases, someone else has already developed an upgrade that you can use, and even when there's no upgrade available, you can easily create one yourself, as I will describe in this document.
Some newer JP1 remotes equipped with a USB port are programmable over the web. But even these models also benefit greatly from JP1 tools.
What Equipment Do I Need?
Well, for starters, you need a JP1 compatible remote, these are remotes made by UEI. The two main brands that you will find in the stores are ‘One For All' and ‘Radio Shack', but there are several other remotes out there that are also JP1 compatible. To see if your remote is JP1 compatible, open up the battery compartment and see if there's a 6-pin conenctor in there (like the one below). If you see 6 holes rather than a 6-pin connector, you remote probably needs extra parts to be JP1 compatible. Some newer JP1 remotes like Xsight, Nevo and Simple have a USB port instead of pins.
Next, if your remote has pins, you need a JP1 cable. If your remote has a USB port, then you don't need a JP1 cable and can skip to the next section.
There are currently two types of JP1 interfaces - referred to as simply 'JP1' for the older style interface and 'JP1.x' for the newer style interface. You can determine which version you have by referring to the remote control spreadsheet available here:
While it is possible to make a parallel port JP1, or serial port JP1.x interface fairly easily yourself, for most people it's simpler to just buy them ready made.
Windows, Mac and Linux based machines are all supported at this time.
Finally, you will need the Open Source RM-IR software, which you can download from Forum Index -> File Section -> JP1 File Section -> Tools -> Main or Directly from the SourceForge project.
How Do You Use RM-IR
This is the program that you use to configure your remote and create/manage device 'upgrades'. You can use it to download your current programming, you can save a copy of your current programming on your PC as a backup, you can make changes to the programming, including adding upgrades, etc and you can re-load it to your remote.
Installing RM-IR and preparing it for use
Most modern operating systems include Java by default. It's built into Mac OS X; most modern Linux distributions (e.g., Ubuntu and its derivatives) either include it, or an option to install it; and Microsoft has included it in recent Windows versions. If your OS does not include Java, you may download it free from Oracle. (Note: Early adopters of Mac OS X 10.7 'Lion' will need to download Java separately from Apple.)
For Windows machines, we recommend
\Program Files\RemoteMaster, or perhaps
\Program Files\JP1\RemoteMaster. EXCEPTION: If you are running Vista, you may not want to put the RemoteMaster folder in
\Program Files--some users have reported problems with this configuration. Make sure you have the latest Service Pack installed.
On the Macintosh, the best place will probably be
On Linux machines, the best place may vary a bit depending on which distro you prefer, but
/usr/local/bin are probably good choices. If you're going to be the only one using it, you can even leave it in your
The procedure for preparing RM-IR for use also varies by operating system.
On Windows, double-click the
Setup.vbs file. This will install the necessary Start Menu items and Registry keys needed to run RemoteMaster like any other application; once this is done, you may then launch RemoteMaster the usual way, by going to Start->Programs->All Programs->RemoteMaster->RM IR.
On the Mac, no preparation is needed--simply double-click the RemoteMaster.jar file, like any other application. (Lion users note: RemoteMaster.jar will not appear in Launchpad--you will need to launch RemoteMaster the old-fashioned way, in a standard Finder window.)
On Linux, the procedure is not quite as polished. The supplied
rmir.sh shell scripts are normally used to launch RemoteMaster from an xterm session; you will probably need to edit these for your particular installation. You may also need to run RemoteMaster with
sudo to access the serial, parallel or USB ports, depending on your security settings.
The first time you use RM-IR, a pop-up will appear declaring 'No RDF files were found!'. Not to worry, just press the OK button, and RM-IR will display a file dialog for you to specify where you've placed the RDFs. It defaults to the rdf subdirectory in the directory you installed RM-IR. Just navigate to the folder in which you've placed the RDFs and press the Open button. One this is done, you will receive a similar pop-up regarding the 'Maps' files. Simply repeat the procedure for the Maps directory. The location of your RDF and Map files can always be changed by selecting FILE on the Menu and Set Directory from the Drop-Down menu.
I am going to show some screen shots of the RM-IR program.
You'll notice that the RM-IR program is divided into several tabs. The actual tabs displayed will vary by remote, for example, if your remote doesn't have learning, the learning tab may not be displayed.
First things first, start up the RM-IR program and, with your remote connected to the JP1 cable, click on the ‘Download From Remote' button. You should similar to the one below below.
I am now going to briefly describe some of the basic tabs that you will use, but I will skip a couple that we will cover later.
With the General Tab selected, you can see what setup codes you have assigned to each of the device buttons on your remote (eg, on this remote, the TV/1150 code is assigned to the TV button). You can also see how any of the other settings have been programmed (eg, on this remote, Volume Punch Thru is turned on and is set to the RCVR/AMP device)
"Key Moves" are buttons programmed using the Key Mover function, which can either mean the button was copied from another button, or it was programmed using an advanced code. This tab shows you all the keymoves programmed in this remote. You can also edit, add or delete keymoves from this tab. You may notice that some of the keymoves are grayed out. This indicates that this keymove comes from a device upgrade - which will be discussed later on.
As the name implies, this tab shows you all the macros you have programmed.
Learned Signals tab
This tab shows you all the buttons that you have programmed using the remote's learning function. In addition to showing you which buttons hold learned signals, it also shows you what those learned signals look like, but more on that later.
How Do You Add an Upgrade
If you have device not supported by your remote, or want to customize and existing device, take a look in the Device Upgrades folder and see if there's one ready-made that you can use. Remember, you don't typically need to find an exact match on the model number of the device as most major brand manufacturers use the same IR signals for all similar devices (ie, for all TVs, etc).
Finding and Loading an Upgrade
If you find an upgrade, be aware that KM files (.txt) can also be used with RM-IR. These are files from an Excel spreadsheet called KeyMap Master which which can also be used to create upgrades.
This tab shows the details of the existing upgrades loaded into your remote. To add a new device, click on the 'New' button on this tab.
Loading the file will automatically populate all the required fields in RM. For this example we are going to load one of the files for Windows Media Center. The image below shows what RM looks like with an upgrade loaded.
Understanding and editing the "Functions" tab
Assuming that the person who created the Upgrade did it correctly - this should contain all of the functions from the OEM remote, and perhaps a few more such as discrete input selects/power etc. If you have additional function codes that you have obtained from elsewhere, you can add them by selecting the New button at the bottom of the screen then scroll up/down to find the newly created Function # spot (will be blank). Place your cursor on the blank Name field and enter a name for your new function. Next, enter either an EFC or OBC code. Make sure that when you enter the additional codes you put them in the correct column, either "OBC" (which stands for "Original Button Code") or "EFC" (which stands for "Extended Function Code", which are also known as "advanced codes"). Once you enter your EFC or OBC, the other fields for your new Function should populate themselves automatically. If you wish you can also add Notes to this new function.
Assigning Functions with the "Buttons" tab
The next screen of interest is the "Buttons" panel, as shown in the image below.
On this panel, you can check that the functions are assigned to the buttons of your choice. Remember, just because it made sense for the buttons to be assigned the way they are for the remote the person who created the upgrade had, doesn't mean it will make sense for your remote. You can assign functions to buttons in 4 different ways:
- Press the Auto assign button to get some functions automatically assigned. The ones that get assigned automatically are the ones where you used the default function names and there's an equivalent button on your JP1 remote for that function. You are under no obligation to accept these default assignments.
- Drag-n-drop a function from the list of Available Functions on the right into the Function Column beside the Button you wish to assign it to
- Click in the Function field next to the Button you want to assign your function too, then double-click the desired function in the Available Functions field.
Use the - Remove - function to clear the function assigned to a button.
Note: if a button is grayed out, it either doesn't exist on your remote, or it's not possible to program it.
Assigning Functions with the "Layout" tab
RM provides another way to check the assignment of functions to buttons, the Layout tab, shown below:
On this tab, buttons with assigned functions are colored in yellow, and buttons that are present in the key map for the selected device type are outlined in orange. Also, functions can be assigned to buttons in 4 different ways:
- Press the Auto assign button to get some functions automatically assigned. The ones that get assigned automatically are the ones where you used the default function names and there's an equivilent button on your JP1 remote for that function. You are under no obligation to accept these default assignments.
- Drag-n-drop a function onto the desired button
- Right-click on a button and select the desired function
- Click on a button, then double-click the desired function.
Assigning the Upgrade
Once you are done assign the buttons as you like, click 'Ok'. A Pop-Up window will show that you are attempting to create a Device Upgrade that is not assigned to a device button yet on your remote, and will ask you if you want to assign it now. You can choose the device button you would like to assign this upgrade to from the drop down window, or just press Cancel. You will now return back to the RM-IR Main window with the Devices Tab selected showing your new device added.
At this point, you may wish to change the 'Setup code' for the update you added on the 'Devices' tab, and of course don't forget to assign the new setup code that you created to an actual device button on the 'General' tab if you haven't done so yet.
On the RM-IR Command Bar select 'Remote'. Scroll down the drop down box and click on 'Upload to Remote'. The LED on your remote will flash twice when the upload is complete. If your cable is equipped with LEDs, you will see the lights on your cable flash for a few seconds while the image is being uploaded. When they stop, your remote should have the new upgrade installed and functional.
Adding an Upgrade - Summary
- Download the upgrade file from the Upgrade section.
- Load it into RM-IR by going to the Devices tab, selecting 'New' and then clicking 'Load' from the Setup tab
- Enter any addition functions that you have codes for in the Functions panel.
- Re-arrange the buttons as you see fit in the Buttons or Layout panels.
- Assign the new setup code to a device button in IR and re-load into your remote.
How Do You Create An Upgrade From Scratch
If you have an unsupported device, and you you can't find an upgrade file for it in the file section, your next step is to create one yourself. If you have a JP1 remote with learning, this is easy to do. If you don't have a learning remote, all is not lost. we'll discuss what you can do in that situation a little later.
Learning OEM Remote Functions
To create an upgrade yourself, here's what you do. First, download your remote's current memory and save it. You can always use this file to restore the remote to it's current condition later, if needed. Next, delete any learned signals that are already in the remote. The easiest way to do this is to go to the "Learned Signals" tab in RM-IR, select the first entry and click the "Delete" button until it is cleared. Then, do an upload to your remote.
Next up, you'll need to learn as many buttons from your original remote as you can. Most JP1 learning remotes can only learn about 24 buttons before the memory is full, so it's probably going to take a couple of passes to capture all the buttons from the original remote. I recommend that you start off learning all the buttons that have equivalent buttons on the JP1 learning remote (eg, the numeric buttons, volume and channel buttons, etc). When you reach the memory limit, download the memory and save the file. Then delete all the learned signals like you did before and continue learning. As soon as you reach the memory limit again, or you run out of buttons to learn, download and save the file. When you start learning the more unusual buttons from your original remote (eg, ANGLE, ZOOM, etc) be sure to make a note of which button you learned them to on your JP1 remote.
Once all the buttons are learned, you can start the process of decoding them. To do this, go to the "Learned Signals" tab in RM-IR. You will see all your learned buttons listed in the column on the left. When you click on one of these entries, the infra red info will be displayed on the right, as shown in the image below:
Here you can see that for the '1' button in CD mode RM-IR was successfully able to decode the signal and has displayed the IR info. This signal uses the Pioneer protocol, with a device code of 164. Chances are, all of the buttons for this device with use the same protocol and device codes, what will change for each button are the OBC and EFC codes.
Starting a New Upgrade and the Setup Tab
There are 2 ways to create a new device upgrade from your learned signals - manually or automatically. If the protocol, device code and sub-device code are the same for all the learned signals, then an automatic upgrade is likely possible. Click 'Create Device Upgrade', and a new device with all your selected learned signals will be created automatically, and you can skip to the next section. (If this option is not available, go to Options - Advanced and check Learn to Upgrade Conversion). To start creating an upgrade manually for this device, you should go to the 'Devices' tab and click 'New' to start a new upgrade. Then in the Setup tab, you should make the entries described in the following table.
- Description: Enter a brief description of the device being programmed. In this case we'll enter "Samsung VCR"
- Remote: Select the remote you are programming (should automatically be correct).
- Device Type: Select the type that most closely matches the device you are programming. In this case we'll select VCR.
- Setup Code: As we already know that this VCR responds to the VCR/0240 code, the standard convention for upgrades is to add 1000 to that, giving us VCR/1240. If there's no official code that works your device (as far as your know), use 2000 or greater for this entry. (The max value is 2047)
- Protocol: Select the protocol displayed in IR. In this case we'll select NECx2. If you're unsure which protocol to use, consult the readme file that's in the KM zip file.
- Device Number/Sub-Device: Enter the values displayed in the Learned Device tab Device/Sub-Device columns, in this case we'll enter 164 for Device and there is no Sub-Device. The displayed labels for these boxes varies based on the selected protocol.
- Upgrade Notes: This is the data block to the right of the screen. You can use this space to enter any notes about this upgrade that might be useful to you or to someone else who later uses this upgrade.
The image below shows the Setup panel after all the correct entries have been made:
Now you need to go to the Functions tab and enter the data for all the buttons that you learned.
When you first go to the Functions tab, you will see a lot of function names already entered. These entries are just defaults designed to save you some typing, you are under no obligation to use them. You can delete them all if you like.
The process to get the data from the 'Learned Signals' tab into the 'Functions' tab is a bit cumbersome as of this writing. This is on the list of things to improve. Here is the process:
- Hit 'Ok' and go back to the 'Learned Signal' tab in the main RM-IR window
- Highlight all of the entries in the 'Key' column and then Right-Click->Copy
- Go back to the Devices tab, and click 'Edit' on your new Upgrade
- Go to the Functional tab and Right-click->Paste in the 'Name' column
- Hit 'Ok' and go back to the 'Learned Signal' tab in the main RM-IR window
- Highlight all of the entries in the 'Hex Cmd' column and then Right-Click->Copy
- Go back to the Devices tab, and click 'Edit' on your new Upgrade
- Go to the Functional tab and Right-click->Paste in the 'Hex' column
Right now, all of the entries under 'Name' will be the buttons you 'learned' to on your JP1 remote. At this point you should change them to match the remote you learned from.
It's a good idea to understand some terminology at this point. The word "Functions" refers to the buttons that you learned from your original remote, you can use the exact names as printed on your original remote, or you can expand it a little to make it easier to understand. For example, you might have a button labeled "CHP/TME" but it might be a good idea to enter it as "Chapter/Time". Alternatively, you could enter it as "CHP/TME" then make an entry in the Notes column to describe what it does. When RM-IR refers to "Buttons", it's referring to the buttons on your JP1 remote, not your original remote.
Please enter the data for all the buttons on your original remote, even if you have no intention of programming them to physical buttons - this will make your work useful to other members of the community.
Once you have entered all the info for your learned buttons, your next step is to assign those functions to the buttons on your remote. You can do this on the Buttons or Layout tabs. Follow one of these links to finish out the Upgrade.
If you don't have a learning remote
There are sometimes other ways to get the required data. If you have found a setup code that works some of the functions, post a message in the forums following these instructions
If you have a few codes (like discrete commands) that you would like to add to an existing upgrade, just want to move around some keys, or if you want to check if a newer JP1 remote has the codes you need, you can use the Lookup Tool to find codes.
Another good source for this data in the Pronto file section at Remote Central. If you can find a file there for your device (remember, you don't necessary need to find an exact match for the model number of your device), you can download the file and run the DecodeCCF program (available in the Yahoo file section) against it. This program will create a text file, that you can open with a spreadsheet program such as Excel, that lists the protocol and other codes for all the learned signals contained within the CCF file.
Creating an Upgrade - Summary
- Learn the buttons from your original remote and download using RM-IR.
- Go to the RM-IR Devices tab and click 'New' or use "Create Device Upgrade" if all learns are the same protocol and skip to step 5
- Pick a device type, select the correct protocol and enter the correct device codes.
- Copy/Paste functions from the 'Learned' tab to the 'Functions' tab, clean up the names
- Go to the Buttons or Layout panels and assign the buttons as you see fit.
- Assign a setup code and assign the new setup code to a device button in RM-IR and re-load into your remote.
Remote Specific Features
If you have an Xsight or Nevo remote, Remote Master has several enhancements to support its additional features. For more information about these remotes, see Getting started with Xsight and Nevo.
On the Favorites tab, you can enter up to 72 favorite channels by specifying a name, channel number and icon (optional). Each channel can also be included in any of several profiles, by creating or selecting a profile and checking 'In Profile'. In the group assignments area, specify which key groups are assigned to which devices while in Favorites mode.
On the Activities tab, you can create special macros called "activities" that send a series of commands to power on and off devices and select the appropriate inputs and sound/picture modes. In the group assignments area, specify which key groups are assigned to which devices when the activity is selected. Optionally, you can select functions to include in 'Assist' screens if there are additional manual functions you wish to perform when the activity runs. Typical activities you may want to create might include 'Watch TV', 'Watch Movie' or 'Listen to Music'.
- Icons: On the General tab, Activities tab and on the Functions tab of the device editor, double click the Icon box to select an icon for the device, activity or function. (Channels and functions may have any icon from any image file you choose. But Devices, Activities and Profiles are limited to the set of built-in icons).
- Soft buttons: On the Layout tab of the device editor, drag and drop functions onto the remote screen to add functions to the display. Use the Page+ / Page- buttons to navigate to different screens (up to 12 pages of 6 functions per page). You can also use the Buttons tab to assign functions to the Soft buttons.
- Pause: Each step in a macro can have a delay of 0.1-10.0 seconds before the next step is executed.
- Hold: Each step in a macro can continuously send (hold) the signal for a specific duration (useful for things like big volume changes or power commands that must be held for a long duration).
- Volume Lock: Many JP1 remotes have a volume lock feature. But because of Xsight/Nevo activities feature, it works a little differently. On the General tab, select which master device is used for volume control and turn on/off the devices whose volume buttons are locked to the master device. Each activity also has a volume control device selection in the group pane. The device chosen in an activity takes precedence over the volume lock setting on the General tab.