The WHAT and WHY of JP1 - Revision history

The Robman: 9 revisions imported

2025-11-02T18:41:11Z

9 revisions imported

← Older revision	Revision as of 18:41, 2 November 2025
(No difference)

The Robman at 21:57, 11 January 2020

2020-01-11T21:57:06Z

Show changes

The Robman: /* Devices4 */

2020-01-11T19:07:41Z

Devices4

← Older revision		Revision as of 19:07, 11 January 2020
Line 345:		Line 345:

	Finally, RM also supports an external functions capability, i.e., the ability for a function on a device other than the one being upgraded to be triggered by a keypress on the device to which upgrade applies - essentially the converse of a Keymove described in the preceding paragraph. Using a similar example to that above, RM's external functions capability allows a function, and hence a key, to be specified in, say, a TV upgrade that would select the appropriate input source on the Audio device. This is accomplished by specifying the external device type/setup code in place of the KM function name and, in the EFC column, specifying the EFC of the relevant function on the external device. Subsequently, this external function would be assigned to a button in the upgrade.		Finally, RM also supports an external functions capability, i.e., the ability for a function on a device other than the one being upgraded to be triggered by a keypress on the device to which upgrade applies - essentially the converse of a Keymove described in the preceding paragraph. Using a similar example to that above, RM's external functions capability allows a function, and hence a key, to be specified in, say, a TV upgrade that would select the appropriate input source on the Audio device. This is accomplished by specifying the external device type/setup code in place of the KM function name and, in the EFC column, specifying the EFC of the relevant function on the external device. Subsequently, this external function would be assigned to a button in the upgrade.

	~~==Devices4==~~
	When planning to create an upgrade "from scratch", Devices4.xls should be run to obtain basic information for the setup code on which the upgrade is to be based. The setup code is entered in the "Type" and "Code" fields below the instructions "Select here:". Please note that Devices4 was developed for use with a RS-1994 remote. Therefore, it may not support some of the manufacturer's codes pre-programmed into other remotes, particularly newer remotes.

	Devices4.xls, another MS Excel application, will identify the required IR protocol, its device, sub-device and other parameters and the basic EFCs (i.e., extended function codes - another name for advanced codes) for that particular setup code. Note, however, that where a protocol is not pre-programmed into a remote, it will be necessary to "paste" a protocol upgrade from KM or RM into IR.exe. Both KM and RM will flag this requirement.

	==Extenders==		==Extenders==

The Robman: /* Keymap-Master (KM) */

2020-01-11T19:07:24Z

Keymap-Master (KM)

← Older revision		Revision as of 19:07, 11 January 2020
Line 329:		Line 329:
	RMIR monitors the use of the advanced code and upgrade of memory and displays the number of bytes remaining in each.		RMIR monitors the use of the advanced code and upgrade of memory and displays the number of bytes remaining in each.

	==~~Keymap-~~Master (KM)==		==Remote Master (RM)==
	RM ~~(Remote Master)~~'s job is to facilitate the development of device upgrades. Those upgrades are then transferred to RMIR.		RM's job is to facilitate the development of device upgrades. Those upgrades are then transferred to RMIR.

	RM permits users to create entirely new device upgrades and to modify upgrades previously created by others. (Users are encouraged to store any unique upgrades they develop in the JP1 file section so as to make them available to others.) If you plan to create an upgrade for one of your devices, rather than starting from scratch, you should search the JP1 file section first to see if someone else has already done the hard part. If you must start from scratch, hifi-remote.com provides basic advanced code information for a wide variety of devices.		RM permits users to create entirely new device upgrades and to modify upgrades previously created by others. (Users are encouraged to store any unique upgrades they develop in the JP1 file section so as to make them available to others.) If you plan to create an upgrade for one of your devices, rather than starting from scratch, you should search the JP1 file section first to see if someone else has already done the hard part. If you must start from scratch, hifi-remote.com provides basic advanced code information for a wide variety of devices.

The Robman: /* RemoteMaster (RM) */

2020-01-11T19:06:44Z

RemoteMaster (RM)

← Older revision		Revision as of 19:06, 11 January 2020
Line 345:		Line 345:

	Finally, RM also supports an external functions capability, i.e., the ability for a function on a device other than the one being upgraded to be triggered by a keypress on the device to which upgrade applies - essentially the converse of a Keymove described in the preceding paragraph. Using a similar example to that above, RM's external functions capability allows a function, and hence a key, to be specified in, say, a TV upgrade that would select the appropriate input source on the Audio device. This is accomplished by specifying the external device type/setup code in place of the KM function name and, in the EFC column, specifying the EFC of the relevant function on the external device. Subsequently, this external function would be assigned to a button in the upgrade.		Finally, RM also supports an external functions capability, i.e., the ability for a function on a device other than the one being upgraded to be triggered by a keypress on the device to which upgrade applies - essentially the converse of a Keymove described in the preceding paragraph. Using a similar example to that above, RM's external functions capability allows a function, and hence a key, to be specified in, say, a TV upgrade that would select the appropriate input source on the Audio device. This is accomplished by specifying the external device type/setup code in place of the KM function name and, in the EFC column, specifying the EFC of the relevant function on the external device. Subsequently, this external function would be assigned to a button in the upgrade.

	~~==RemoteMaster (RM)==~~
	RemoteMaster is a Java-based program currently still under development. Its capabilities at time of writing (pre-release version RemoteMaster.v0.96) were generally equivalent to those of KM, with the exception that:
	*RM supports the programming of x-shifted keys, whereas KM does not
	*certain device protocols supported by KM are not yet supported by RM (KM tends to lead RM in implementation of new protocols)
	*while RM supports the specification of external functions, it does not yet offer functionality equivalent to KM's KeyMove capability (but that latter feature is currently under consideration).

	Why choose RM over KM or move from KM to RM? Unless you happen to need external keymoves or one of the recently added protocols, RM's functionality is at least equal to KM's. RM's user interface is more elegant than KM's. It is intended that RM will eventually provide the capability of the entire JP1 toolset. So, RM likely will evolve to a much greater extent than KM. As well, the more RM is used, the more quickly any "bugs"/ design deficiencies will be discovered and, hence the better tool it likely will become. However, if you're concerned about the potential instability of RM as it evolves or if you're just plain happy with KM, stay with KM for a while. RM can read KM's output files, so you can easily move to KM at any time in the future. So, take your pick.

	~~Full user instructions for RemoteMaster are included in its ReadMe files.~~

	==Devices4==		==Devices4==

The Robman: /* Keymap-Master (KM) */

2020-01-11T19:06:01Z

Keymap-Master (KM)

← Older revision		Revision as of 19:06, 11 January 2020
Line 330:		Line 330:

	==Keymap-Master (KM)==		==Keymap-Master (KM)==
	~~Keymap-~~Master's job is to facilitate the development of device ~~and protocol~~ upgrades. Those upgrades are then transferred to IR.exe using the computer's copy/paste facility. As noted earlier, KM is a MS Excel application (keymap-master-v8.16.xls at time of last update). As for IR.exe, "JP1 for Beginners" provides exhaustive instructions on KM's use.		RM (Remote Master)'s job is to facilitate the development of device upgrades. Those upgrades are then transferred to RMIR.

	KM permits users to create entirely new device upgrades and to modify upgrades previously created by others. (Users are encouraged to store any unique upgrades they develop in ~~Yahoo! Groups~~ JP1~~, subsection Files\|Device Codes~~ so as to make them available to others.) If you plan to create an upgrade for one of your devices, rather than starting from scratch, you should ~~scan that Yahoo! subsection~~ first to see if someone else has already done the hard part. If you must start from scratch, hifi-remote.com provides basic advanced code information for a wide variety of devices~~, as does Devices4~~.		RM permits users to create entirely new device upgrades and to modify upgrades previously created by others. (Users are encouraged to store any unique upgrades they develop in the JP1 file section so as to make them available to others.) If you plan to create an upgrade for one of your devices, rather than starting from scratch, you should search the JP1 file section first to see if someone else has already done the hard part. If you must start from scratch, hifi-remote.com provides basic advanced code information for a wide variety of devices.

	As noted earlier, button maps control which keys on the remote may be assigned using JP1. Several button maps are included in each RDF file, each associated with a specific device types. In a device upgrade, the applicable button map is not selected directly. Instead, it is determined by the device type assigned to the upgrade.		As noted earlier, button maps control which keys on the remote may be assigned using JP1. Several button maps are included in each RDF file, each associated with a specific device types. In a device upgrade, the applicable button map is not selected directly. Instead, it is determined by the device type assigned to the upgrade.
Line 338:		Line 338:
	Device types bear the names of common types of home theater equipment, e.g., TV, DVD, Cable, etc. The button map associated with a given device type generally includes all the keys typically required by the HT equipment of the type implied by the device type. But, there is no other correlation between the device type of an upgrade and the type of HT equipment to which the upgrade applies and it is not necessary that the device type reflect the nature of the physical equipment. There may be instances where more keys are required than are made available through this association. Generally, device type "Cable" allows programming of the most buttons. ("Amp" and Tuner" offer the least.) So, if you're developing a device upgrade for your TV using device type "TV" and you want to use a button on the remote that is not included for device type "TV", change the device type to "Cable". This will, almost magically, make additional buttons available. The remote won't care - so long as you tell it your TV uses a setup code of device type "Cable".		Device types bear the names of common types of home theater equipment, e.g., TV, DVD, Cable, etc. The button map associated with a given device type generally includes all the keys typically required by the HT equipment of the type implied by the device type. But, there is no other correlation between the device type of an upgrade and the type of HT equipment to which the upgrade applies and it is not necessary that the device type reflect the nature of the physical equipment. There may be instances where more keys are required than are made available through this association. Generally, device type "Cable" allows programming of the most buttons. ("Amp" and Tuner" offer the least.) So, if you're developing a device upgrade for your TV using device type "TV" and you want to use a button on the remote that is not included for device type "TV", change the device type to "Cable". This will, almost magically, make additional buttons available. The remote won't care - so long as you tell it your TV uses a setup code of device type "Cable".

	Keys which are excluded from device upgrades (see Section 5.5), other than x-shifted keys, may also be programmed with KM. However, KM will implement those assignments as keymoves. The names of the keys so affected are preceded by the symbol "@" in KM's Button ~~sheet~~. While such keymoves will seem to be an integral part of the device upgrade, IR.exe will segregate them from the upgrade and thereafter handle them like any other keymove. X-shifted keys cannot be programmed with KM; they must be programmed with IR.exe.		Keys which are excluded from device upgrades (see Section 5.5), other than x-shifted keys, may also be programmed with RM. However, RM will implement those assignments as keymoves. The names of the keys so affected are preceded by the symbol "*" in RM's Button tab.

	In some unextended remotes, certain buttons cannot be programmed using JP1. The remote treats these buttons specially and will ignore any custom programming. KM will "gray-out" buttons that cannot be programmed at all. (In an extended remote, generally, every button can be programmed.)		In some unextended remotes, certain buttons cannot be programmed using JP1. The remote treats these buttons specially and will ignore any custom programming. RM will "gray-out" buttons that cannot be programmed at all. (In an extended remote, generally, every button can be programmed.)

	KM supports the specification of externally triggered functions i.e., the ability to have a function on the device to which the upgrade applies be "triggered" by a keypress when another device is active. This capability is labelled, simply, "KeyMoves". It permits, for example, when creating an upgrade for a receiver that has a variety of signal input selections, the specification of a key on another device that will select the appropriate input on the receiver when that other device is the active device on the remote.		RM supports the specification of externally triggered functions i.e., the ability to have a function on the device to which the upgrade applies be "triggered" by a keypress when another device is active. This capability is labelled, simply, "KeyMoves". It permits, for example, when creating an upgrade for a receiver that has a variety of signal input selections, the specification of a key on another device that will select the appropriate input on the receiver when that other device is the active device on the remote.

	Finally, KM also supports ~~a rudimentary~~ external functions capability, i.e., the ability for a function on a device other than the one being upgraded to be triggered by a keypress on the device to which upgrade applies - essentially the converse of a Keymove described in the preceding paragraph. Using a similar example to that above, KM's external functions capability allows a function, and hence a key, to be specified in, say, a TV upgrade that would select the appropriate input source on the Audio device. This is accomplished by specifying the external device type/setup code in place of the KM function name and, in the EFC column, specifying the EFC of the relevant function on the external device. Subsequently, this external function would be assigned to a button in the upgrade~~. Full details are provided in the KM ReadMe file~~.		Finally, RM also supports an external functions capability, i.e., the ability for a function on a device other than the one being upgraded to be triggered by a keypress on the device to which upgrade applies - essentially the converse of a Keymove described in the preceding paragraph. Using a similar example to that above, RM's external functions capability allows a function, and hence a key, to be specified in, say, a TV upgrade that would select the appropriate input source on the Audio device. This is accomplished by specifying the external device type/setup code in place of the KM function name and, in the EFC column, specifying the EFC of the relevant function on the external device. Subsequently, this external function would be assigned to a button in the upgrade.

	==RemoteMaster (RM)==		==RemoteMaster (RM)==

The Robman: /* IR.exe */

2020-01-11T19:01:32Z

IR.exe

← Older revision		Revision as of 19:01, 11 January 2020
Line 307:		Line 307:
	However, due to the inconvenience of physically using the shift and x-shift functions, shifted and x-shifted keys are more likely to be used like phantom keys than to initiate ordinary keyboard functions. As well, the number of phantom keys is limited and the available phantom keys may be quickly consumed. Macros and keymoves that don't need to be directly associated with a keypress usually are then assigned to shifted and x-shifted keys that are unlikely ever to be required to generate keypresses.		However, due to the inconvenience of physically using the shift and x-shift functions, shifted and x-shifted keys are more likely to be used like phantom keys than to initiate ordinary keyboard functions. As well, the number of phantom keys is limited and the available phantom keys may be quickly consumed. Macros and keymoves that don't need to be directly associated with a keypress usually are then assigned to shifted and x-shifted keys that are unlikely ever to be required to generate keypresses.

	==~~IR.exe~~==		==RMIR==
	~~IR.exe~~ (currently version 4.02), among other things:		RMIR (currently version 2.09 build 8), among other things:
	*receives device and protocol upgrades from ~~KM or~~ RM		*receives device and protocol upgrades from RM
	*relates those upgrades and pre-programmed manufacturer's codes to physical devices		*relates those upgrades and pre-programmed manufacturer's codes to physical devices
	*allows the user to program keymoves and macros		*allows the user to program keymoves and macros
	*using the RDF as reference, assembles all this data into an eeProm image and		*using the RDF as reference, assembles all this data into an eeProm or flash image and
	*controls the uploading and downloading of the data to/from the remote's eeProm.		*controls the uploading and downloading of the data to/from the remote's eeProm.

	~~"JP1 for Beginners" provides exhaustive, (though now somewhat dated) instructions on how to use IR.exe. This section will concentrate, instead, on what actually gets put in the eeProm by IR.exe.~~

	In an unextended remote, eeProm is partitioned into:		In an unextended remote, eeProm is partitioned into:
Line 329:		Line 327:
	As with most projects, JP1 programming requires compromises - especially when it comes to memory consumption. In an unextended remote (extenders are discussed in Section 10), advanced code memory is usually quite limited, whereas there is usually adequate upgrade memory. Unfortunately, simple keymoves, which are stored in advanced code memory, require five or six bytes each (four bytes of overhead and one or two bytes for the code to be sent to the device). So, advanced code memory may be quickly consumed. (Remember, UEI never intended for the user to be entering keymoves with such ease from a computer.) On the other hand, if a key is handled in an upgrade, the cost may be as little as one byte. So, given the particular circumstances, it may be preferable to install a complete upgrade even if only a few keymoves would otherwise be required.		As with most projects, JP1 programming requires compromises - especially when it comes to memory consumption. In an unextended remote (extenders are discussed in Section 10), advanced code memory is usually quite limited, whereas there is usually adequate upgrade memory. Unfortunately, simple keymoves, which are stored in advanced code memory, require five or six bytes each (four bytes of overhead and one or two bytes for the code to be sent to the device). So, advanced code memory may be quickly consumed. (Remember, UEI never intended for the user to be entering keymoves with such ease from a computer.) On the other hand, if a key is handled in an upgrade, the cost may be as little as one byte. So, given the particular circumstances, it may be preferable to install a complete upgrade even if only a few keymoves would otherwise be required.

	~~IR.exe~~ monitors the use of the advanced code and upgrade of memory and displays the number of bytes remaining in each.		RMIR monitors the use of the advanced code and upgrade of memory and displays the number of bytes remaining in each.

	==Keymap-Master (KM)==		==Keymap-Master (KM)==

The Robman: /* System Components */

2020-01-11T18:58:30Z

System Components

The Robman: /* ToadTog */

2015-09-10T01:00:41Z

ToadTog

← Older revision		Revision as of 01:00, 10 September 2015
Line 456:		Line 456:

	===ToadTog===		===ToadTog===
	ToadTog, reputedly, the hardest to understand of the special protocols, manages device toggle functions, e.g., i.e., on/off, yes/no. A device that uses toggle functions is known as a Toad - Toggle Only Actuated Device - hence, the name "ToadTog" - to toggle a Toad. A device that supports discrete functions, i.e., "on" is a different command from "off", is known as a Dude - Device Utilizing Discrete Extensions . . . or so it is reported in the Forums.		[[ToadTog]], reputedly, the hardest to understand of the special protocols, manages device toggle functions, e.g., i.e., on/off, yes/no. A device that uses toggle functions is known as a Toad - Toggle Only Actuated Device - hence, the name "ToadTog" - to toggle a Toad. A device that supports discrete functions, i.e., "on" is a different command from "off", is known as a Dude - Device Utilizing Discrete Extensions . . . or so it is reported in the Forums.
	The special protocol ToadTog allows one of a set of eight bits to be tested, toggled, set or reset at the direction of the user. In the latter two cases (i.e., set or reset), action is only taken if the bit is not in the desired state already. The ToadTog bit to be tested together with the command to test/toggle/set/reset the bit is encoded in byte 5 of the keymove (the command byte). This leaves up to twelve bytes to specify the actions to be taken (which may be no action whatsoever) depending on whether the ToadTog bit was previously set or reset. A ToadTog keymove has the following form:		The special protocol ToadTog allows one of a set of eight bits to be tested, toggled, set or reset at the direction of the user. In the latter two cases (i.e., set or reset), action is only taken if the bit is not in the desired state already. The ToadTog bit to be tested together with the command to test/toggle/set/reset the bit is encoded in byte 5 of the keymove (the command byte). This leaves up to twelve bytes to specify the actions to be taken (which may be no action whatsoever) depending on whether the ToadTog bit was previously set or reset. A ToadTog keymove has the following form:

The Robman: Created page with "'''The WHAT and WHY of JP1'''
''by Don Grovestine'' (March 22, 2004) ==Introduction== A few months ago, my coffee table was littered with remote controls. The one most..."

2014-09-27T16:10:15Z

Created page with "'''The WHAT and WHY of JP1'''<br> ''by Don Grovestine'' (March 22, 2004) ==Introduction== A few months ago, my coffee table was littered with remote controls. The one most..."

Show changes

← Older revision		Revision as of 18:58, 11 January 2020
Line 84:		Line 84:
	*a personal computer on which the following programs/files are available:		*a personal computer on which the following programs/files are available:
	*RDF files, which defines the characteristics of the remote controls of interest		*RDF files, which defines the characteristics of the remote controls of interest
	*~~IR.exe~~ program to format the data to be uploaded to the remote and handle the communications between computer and remote		*RMIR program to format the data to be uploaded to the remote and handle the communications between computer and remote
	*~~either Keymap-Master (a MS Excel-based tool commonly referred to as "KM") or the still-under-development~~ RemoteMaster (a Java-based tool referred to as "RM"), both of which support the development of device and protocol upgrade files		*RemoteMaster (a Java-based tool referred to as "RM"), both of which support the development of device and protocol upgrade files
	*Devices4, another MS Excel-based tool that provides, for a given device setup code, the associated protocol details and the enhanced function codes and
	*if planning to use an extender:
	*ExtenderCodeCalc, a MS-Excel-based tool that is useful in setting up and debugging some of the features useable with extenders and		*ExtenderCodeCalc, a MS-Excel-based tool that is useful in setting up and debugging some of the features useable with extenders and
	*ExtInstall, a special installation program that will consolidate your remote's existing configurations, i.e., keymoves, macros, etc. with an extender and its special protocols.		*ExtInstall, a special installation program that will consolidate your remote's existing configurations, i.e., keymoves, macros, etc. with an extender and its special protocols.

	All these software tools are available from the Files section of ~~Yahoo! Groups~~ JP1. ExtInstall can be downloaded from the Files\|Extenders subsection; most of the others can be found in the Files\|Tools subsection. Note that the actual names of the program files stored ~~at Yahoo! Groups JP1~~ may include a version number.		All these software tools are available from the <span class="plainlinks">[http://www.hifi-remote.com/forums/dload.php Files section]</span> of the JP1 forum. ExtInstall can be downloaded from the Files\|Extenders subsection; most of the others can be found in the Files\|Tools subsection. Note that the actual names of the program files stored in the file section may include a version number.

	Each of these programs has one or more ReadMe files which, among other things, describe the installation and operating procedures and identifies other special requirements. As well, "JP1 for Beginners", available from the Files\|Help subsection includes detailed downloading and operating instructions for ~~IR.exe, KM~~ and ~~Devices4~~.		Each of these programs has one or more ReadMe files which, among other things, describe the installation and operating procedures and identifies other special requirements. As well, "JP1 for Beginners", available from the Files\|Help subsection includes detailed downloading and operating instructions for RM and RMIR.

	The JP1 tools are continually being enhanced and otherwise upgraded. To minimize preventable difficulties, you should always use the most recent version.		The JP1 tools are continually being enhanced and otherwise upgraded. To minimize preventable difficulties, you should always use the most recent version.
Line 104:		Line 102:
	*IRTool - decodes Pronto hex text files typical of those found at remotecentral.com in that website's Files\|Pronto\|Discrete section.		*IRTool - decodes Pronto hex text files typical of those found at remotecentral.com in that website's Files\|Pronto\|Discrete section.

	The latter four programs require DecodeIR.dll to be present in the Windows\system directory. These tools also are available from the Files section of ~~Yahoo! Groups~~ JP1.		The latter four programs require DecodeIR.dll to be present in the Windows\system directory. These tools also are available from the Files section of the JP1 forum.

	If you are simply programming a JP1 remote to manage devices for which you have, or can learn, the advanced codes and that use protocols already pre-programmed in the remote or supported by KM/RM, you will have no need for these specialized utilities.		If you are simply programming a JP1 remote to manage devices for which you have, or can learn, the advanced codes and that use protocols already pre-programmed in the remote or supported by RM/RMIR, you will have no need for these specialized utilities.

	===The JP1 Cable===		===The JP1 Cable===

The WHAT and WHY of JP1 - Revision history

The Robman: 9 revisions imported

The Robman at 21:57, 11 January 2020

The Robman: /* Devices4 */

The Robman: /* Keymap-Master (KM) */

The Robman: /* RemoteMaster (RM) */

The Robman: /* Keymap-Master (KM) */

The Robman: /* IR.exe */

The Robman: /* System Components */

The Robman: /* ToadTog */

The Robman: Created page with "'''The WHAT and WHY of JP1''' ''by Don Grovestine'' (March 22, 2004) ==Introduction== A few months ago, my coffee table was littered with remote controls. The one most..."

The Robman: Created page with "'''The WHAT and WHY of JP1'''
''by Don Grovestine'' (March 22, 2004) ==Introduction== A few months ago, my coffee table was littered with remote controls. The one most..."