JP1 Remotes Wiki - User contributions [en]

Importing Foreign IR Remotes in RemoteMaster

2022-05-15T10:05:13Z

Barf: /* Example */

= Ultra-short version =

* Perform an "Girr" export from IrScrutinizer to a file,
* Open the above created file in RemoteMaster. Perform desired fixes.

= History =

The previous version of this article described a faily "dumb" method of exporting a Girr file from IrScrutinizer to a stripped-down RemoteMaster rmdu file, using a effectively empty, dummy executor called "ImportOnly". This is imported in RemoteMaster, after which the user has to chose the executor manually.
The previous version can be access through the Wiki history function, or directly [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster&oldid=880 here].

Since then, amazing work has been done in RemoteMaster on importing foreign IR signals, or more exactly, mapping the foreign protocols on the JP1's executors. Accordingly, Girr files can be imported directly, which makes the importing procedure almost automatic.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format. It is the native format of [http://www.hifi-remote.com/wiki/index.php/IrScrutinizer_Guide IrScrutinizer].

First, acquire or generate a suitable Girr file. IrScrutinizer can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, RM inquires the user to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail, so the import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We have downloaded the Excel file and saved it as a csv (comma separated values) file. Here we show the import from that csv file:

[[Image:Screenshot%20from%202022-05-14%2022-16-25.png]]

We now assume that this command set has been imported as parametrized in IrScrutinizer, see the screenshot below.
Every row of the table denotes a command, has a (unique) name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:Screenshot%20from%202022-05-14%2021-54-01.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported, by selecting the "Export" pane, selecting "Girr" as the Export format, checking "Parameters" and pressing "Export param. remote".
This creates a girr file.

[[Image:Screenshot%20from%202022-05-14%2021-15-25.png]]

After starting RMDU, the just-created simple girr file is imported through File -> Open.

[[Image:rm_opening_file.png]]

Next screenshot shows RMDU after the import:

[[Image:Screenshot%20from%202022-05-14%2021-32-52.png]]

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:Screenshot%20from%202022-05-14%2021-33-56.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select setup code and the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Remarks =

== Import ict files from IrScope ==

RMDU can also import ("open") ict files from the program [http://www.hifi-remote.com/wiki/index.php/IR_Scope_and_IR_Widget_User%27s_Guide IrScope].

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2022-05-15T10:00:36Z

Barf: /* Solution */

= Ultra-short version =

* Perform an "Girr" export from IrScrutinizer to a file,
* Open the above created file in RemoteMaster. Perform desired fixes.

= History =

The previous version of this article described a faily "dumb" method of exporting a Girr file from IrScrutinizer to a stripped-down RemoteMaster rmdu file, using a effectively empty, dummy executor called "ImportOnly". This is imported in RemoteMaster, after which the user has to chose the executor manually.
The previous version can be access through the Wiki history function, or directly [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster&oldid=880 here].

Since then, amazing work has been done in RemoteMaster on importing foreign IR signals, or more exactly, mapping the foreign protocols on the JP1's executors. Accordingly, Girr files can be imported directly, which makes the importing procedure almost automatic.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format. It is the native format of [http://www.hifi-remote.com/wiki/index.php/IrScrutinizer_Guide IrScrutinizer].

First, acquire or generate a suitable Girr file. IrScrutinizer can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, RM inquires the user to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail, so the import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) Here we show the import from a csv file:

[[Image:Screenshot%20from%202022-05-14%2022-16-25.png]]

We now assume that this command set has been imported in IrScrutinizer, see the screenshot below.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:Screenshot%20from%202022-05-14%2021-54-01.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

This is exported by selecting the "Export" pane, selecting "Girr" as the Export format, checking "Parameters" and pressing "Export param. remote".
This creates a girr file.

[[Image:Screenshot%20from%202022-05-14%2021-15-25.png]]

After starting RMDU, the just-created simple girr file is imported through File -> Open.

[[Image:rm_opening_file.png]]

Next screenshot shows RMDU after the import:

[[Image:Screenshot%20from%202022-05-14%2021-32-52.png]]

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:Screenshot%20from%202022-05-14%2021-33-56.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select setup code and the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Remarks =

== Import ict files from IrScope ==

RMDU can also import ("open") ict files from the program [http://www.hifi-remote.com/wiki/index.php/IR_Scope_and_IR_Widget_User%27s_Guide IrScope].

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2022-05-15T09:47:42Z

Barf: /* Importing Foreign IR Remotes in RemoteMaster */

= Ultra-short version =

* Perform an "Girr" export from IrScrutinizer to a file,
* Open the above created file in RemoteMaster. Perform desired fixes.

= History =

The previous version of this article described a faily "dumb" method of exporting a Girr file from IrScrutinizer to a stripped-down RemoteMaster rmdu file, using a effectively empty, dummy executor called "ImportOnly". This is imported in RemoteMaster, after which the user has to chose the executor manually.
The previous version can be access through the Wiki history function, or directly [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster&oldid=880 here].

Since then, amazing work has been done in RemoteMaster on importing foreign IR signals, or more exactly, mapping the foreign protocols on the JP1's executors. Accordingly, Girr files can be imported directly, which makes the importing procedure almost automatic.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format.

First, acquire or generate a suitable Girr file. [IrScrutinizer_Guide IrScrutinizer] can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, the useer is required to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail. The import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) Here we show the import from a csv file:

[[Image:Screenshot%20from%202022-05-14%2022-16-25.png]]

We now assume that this command set has been imported in IrScrutinizer, see the screenshot below.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:Screenshot%20from%202022-05-14%2021-54-01.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

This is exported by selecting the "Export" pane, selecting "Girr" as the Export format, checking "Parameters" and pressing "Export param. remote".
This creates a girr file.

[[Image:Screenshot%20from%202022-05-14%2021-15-25.png]]

After starting RMDU, the just-created simple girr file is imported through File -> Open.

[[Image:rm_opening_file.png]]

Next screenshot shows RMDU after the import:

[[Image:Screenshot%20from%202022-05-14%2021-32-52.png]]

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:Screenshot%20from%202022-05-14%2021-33-56.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select setup code and the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Remarks =

== Import ict files from IrScope ==

RMDU can also import ("open") ict files from the program [http://www.hifi-remote.com/wiki/index.php/IR_Scope_and_IR_Widget_User%27s_Guide IrScope].

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T20:43:32Z

Barf: /* Ultra-short version */

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T20:40:00Z

Barf: /* Support and help */

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T20:26:29Z

Barf: /* Example */

File:Screenshot from 2022-05-14 21-15-25.png

2022-05-14T20:25:43Z

Barf:

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T20:22:19Z

Barf: /* Solution */

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T20:21:51Z

Barf: /* Preparation */

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T20:20:39Z

Barf: /* Example */

File:Screenshot from 2022-05-14 22-16-25.png

2022-05-14T20:18:46Z

Barf:

File:Screenshot from 2022-05-14 21-33-56.png

2022-05-14T20:11:58Z

Barf:

File:Screenshot from 2022-05-14 21-32-52.png

2022-05-14T20:11:16Z

Barf:

File:Screenshot from 2022-05-14 21-54-01.png

2022-05-14T19:58:15Z

Barf:

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T19:49:18Z

Barf: /* Outline of Solution */

= Importing Foreign IR Remotes in RemoteMaster =

''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.''
''The procedure requires some knowledge by the user, who have to make some manual decisions. The guide is not aimed at beginning users. Some prior knowledge about RemoteMaster and IrScrutinizer is assumed. Also, importing raw or unknown codes are not covered.''

= Ultra-short version =

* Perform an "RemoteMaster" export from IrScrutinizer 1.3 (or later) to a temporary file,
* Open the above created file in RemoteMaster. Select a usable executor manually. Perform other desired fixes.

= History =

The previous version of this article described a faily "dumb" method of exporting a Girr file from IrScrutinizer to a stripped-down RemoteMaster rmdu file, using a effectively empty, dummy executor called "ImportOnly". This is imported in RemoteMaster, after which the user has to chose the executor manually.
The previous version can be access through the Wiki history function, or directly [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster&oldid=880 here].

Since then, amazing work has been done in RemoteMaster on importing foreign IR signals, or more exactly, mapping the foreign protocols on the JP1's executors. Accordingly, Girr files can be imported directly, which makes the importing procedure almost automatic.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

= Preparation =
Two things needs to be done once-and-for all to RM. These need not be repeated.

== Extending '''protocols.ini''' ==

RemoteMaster's data base '''protocols.ini''', located in
the base directory of RM, already contains '''ImportOnly''' since version 2.04 build 9. If using an earlier version,
add the following lines

<pre># Add this to the end of protocols.ini of Remotemaster in order
# to import IrScrutinizer rmdu exports.
[ImportOnly]
PID=99 99
DevParms=Device:8=0,Sub Device:8=0
DeviceTranslator=Translator()
CmdParms=OBC:16=0
DefaultCmd=00
CmdTranslator=Translator()
Notes=This is a trival dummy executor (protocol), intended to import third-party incomplete device updates, allowing the user to manually fix it up. It will preserve Device, Sub Device, and OBC.\n\nThe user must select a usable protocol instead of this one. First please check Options -> "Allow preserve Control", and then select "Preserve: OBC and function parameters" on the "Setup" pane.
</pre>

to '''protocols.ini'''.

== Selecting '''Allow preserve control''' ==
The RM parameter '''Allow preserve control''' has to be selected; see figure
[[Image:rm_select_allow_preserve.png]]

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format.

First, acquire or generate a suitable Girr file. [IrScrutinizer_Guide IrScrutinizer] can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, the useer is required to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail. The import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

== Remark ==

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We assume that this command set has been imported in IrScrutinizer, see figure.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:irscrutinizer_param_table.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

[[Image:irscrutinizer_param_export_rmdu.png]]

by selecting the "Export" pane, selecting "RemoteMaster" as the Export format, and pressing "Export param. remote".
This creates a simple rmdu file.

We assume that RM has been prepared as per above. After starting, the just-created simple rmdu file is opened (File -> Open).

[[Image:rm_opening_file.png]]

After opening the file, RM will present an error popup:

[[Image:rm_popup.png]]

This simply means that, although RM understood the protocol (executor really) named '''ImportOnly'''
(because _we_ put it into its '''protocols.ini'''!), it says that the currently selected remote does not support it, and the
user must select another one. (Just as we would expect!) We know that the desired protocol is called "NEC1",
so we next have to select an executor implementing that protocol. For the purpose of this example, we select the
executor named '''NEC1''', using the "Protocol" combo box. Make sure that as "Preserve" "OBC and function parameters" is selected.

[[Image:rm_selected_executor.png]]

Check that the protocol parameters (executor parameters really) make sense.
Here, the "D" in the protocol has been successfully turned into the parameter "Device" (= 73),
and the "Sub Device" is empty, as expected.

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:rm_imported_functions.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T19:45:10Z

Barf: /* Background (Mythbuster's lingo: Danger: Science!) */

= Importing Foreign IR Remotes in RemoteMaster =

''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.''
''The procedure requires some knowledge by the user, who have to make some manual decisions. The guide is not aimed at beginning users. Some prior knowledge about RemoteMaster and IrScrutinizer is assumed. Also, importing raw or unknown codes are not covered.''

= Ultra-short version =

* Perform an "RemoteMaster" export from IrScrutinizer 1.3 (or later) to a temporary file,
* Open the above created file in RemoteMaster. Select a usable executor manually. Perform other desired fixes.

= History =

The previous version of this article described a faily "dumb" method of exporting a Girr file from IrScrutinizer to a stripped-down RemoteMaster rmdu file, using a effectively empty, dummy executor called "ImportOnly". This is imported in RemoteMaster, after which the user has to chose the executor manually.
The previous version can be access through the Wiki history function, or directly [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster&oldid=880 here].

Since then, amazing work has been done in RemoteMaster on importing foreign IR signals, or more exactly, mapping the foreign protocols on the JP1's executors. Accordingly, Girr files can be imported directly, which makes the importing procedure almost automatic.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

= Outline of Solution =
A deliberately "dumb" solution is proposed.
A trivial "mock" executor, '''ImportOnly''', having hex = OBC, has been added to '''protocols.ini'''.
An export is performed using this executer.
We then rely on the user to select a usable executor, and on RM to compute the corresponding parameters.

= Preparation =
Two things needs to be done once-and-for all to RM. These need not be repeated.

== Extending '''protocols.ini''' ==

RemoteMaster's data base '''protocols.ini''', located in
the base directory of RM, already contains '''ImportOnly''' since version 2.04 build 9. If using an earlier version,
add the following lines

<pre># Add this to the end of protocols.ini of Remotemaster in order
# to import IrScrutinizer rmdu exports.
[ImportOnly]
PID=99 99
DevParms=Device:8=0,Sub Device:8=0
DeviceTranslator=Translator()
CmdParms=OBC:16=0
DefaultCmd=00
CmdTranslator=Translator()
Notes=This is a trival dummy executor (protocol), intended to import third-party incomplete device updates, allowing the user to manually fix it up. It will preserve Device, Sub Device, and OBC.\n\nThe user must select a usable protocol instead of this one. First please check Options -> "Allow preserve Control", and then select "Preserve: OBC and function parameters" on the "Setup" pane.
</pre>

to '''protocols.ini'''.

== Selecting '''Allow preserve control''' ==
The RM parameter '''Allow preserve control''' has to be selected; see figure
[[Image:rm_select_allow_preserve.png]]

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format.

First, acquire or generate a suitable Girr file. [IrScrutinizer_Guide IrScrutinizer] can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, the useer is required to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail. The import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

== Remark ==

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We assume that this command set has been imported in IrScrutinizer, see figure.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:irscrutinizer_param_table.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

[[Image:irscrutinizer_param_export_rmdu.png]]

by selecting the "Export" pane, selecting "RemoteMaster" as the Export format, and pressing "Export param. remote".
This creates a simple rmdu file.

We assume that RM has been prepared as per above. After starting, the just-created simple rmdu file is opened (File -> Open).

[[Image:rm_opening_file.png]]

After opening the file, RM will present an error popup:

[[Image:rm_popup.png]]

This simply means that, although RM understood the protocol (executor really) named '''ImportOnly'''
(because _we_ put it into its '''protocols.ini'''!), it says that the currently selected remote does not support it, and the
user must select another one. (Just as we would expect!) We know that the desired protocol is called "NEC1",
so we next have to select an executor implementing that protocol. For the purpose of this example, we select the
executor named '''NEC1''', using the "Protocol" combo box. Make sure that as "Preserve" "OBC and function parameters" is selected.

[[Image:rm_selected_executor.png]]

Check that the protocol parameters (executor parameters really) make sense.
Here, the "D" in the protocol has been successfully turned into the parameter "Device" (= 73),
and the "Sub Device" is empty, as expected.

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:rm_imported_functions.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T19:40:16Z

Barf: /* Introduction */

= Importing Foreign IR Remotes in RemoteMaster =

''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.''
''The procedure requires some knowledge by the user, who have to make some manual decisions. The guide is not aimed at beginning users. Some prior knowledge about RemoteMaster and IrScrutinizer is assumed. Also, importing raw or unknown codes are not covered.''

= Ultra-short version =

* Perform an "RemoteMaster" export from IrScrutinizer 1.3 (or later) to a temporary file,
* Open the above created file in RemoteMaster. Select a usable executor manually. Perform other desired fixes.

= History =

The previous version of this article described a faily "dumb" method of exporting a Girr file from IrScrutinizer to a stripped-down RemoteMaster rmdu file, using a effectively empty, dummy executor called "ImportOnly". This is imported in RemoteMaster, after which the user has to chose the executor manually.
The previous version can be access through the Wiki history function, or directly [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster&oldid=880 here].

Since then, amazing work has been done in RemoteMaster on importing foreign IR signals, or more exactly, mapping the foreign protocols on the JP1's executors. Accordingly, Girr files can be imported directly, which makes the importing procedure almost automatic.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

= Background (Mythbuster's lingo: Danger: Science!) =
The protocol and the corresponding parameter values constitute a mathematical description of how to render the signal as
a sequence of on/off durations. This is good for us to examine, generate, exchange with others. Unfortunately, it is not
quite the language the UEI remotes speak: Instead of "protocols", they contain a number of "executors",
which are a small programs in machine code, responsible for computing the IR signal. Unfortunately, they are
in general differently parameterized, and not in 1-1 correspondence with the protocols.
Many executors implement several different protocols,
so-called "combos". Also, for a particular protocol, there are often more than one executor to choose from. To make things extra
interesting, "executors" are in the RM program and documentation in general referred to as "protocols".

For example, the NEC1 protocol is implemented by a number of different executors, '''NEC1''', '''NEC 1or2 Combo''', '''NEC 2DEV Combo''', '''NEC 4DEV Combo''',
and others. Some of these also implement other protocols (like NEC2), some allow several different "D"s. All have slightly different
properties.

Another problem is that the master parameter for the individual commands is the "F" parameter (called "OBC" in RM)
in the protocol,
but the '''hex''' parameter in RM. The details are outside of the scope of this article, but we just state some facts
about the mapping OBC <-> hex:
* it depends on the executor (i.e., it is different for different executors),
* the '''hex''' parameter might depend on more input data than the OBC,
* it is "complicated", but deterministic and memory-less,
* RM can do this computation, provided that '''Allow Preserve Control'''
(accessable as Options -> Allow Preserve control) has been selected.

Importing a set of IR commands basically boils down to selecting an executor, computing its parameters,
and, for all contained commands, compute the hex parameter.

For this reason, it has not been attempted to automatically selecting the executor from input data.
Instead, this is delegated to the user. The following solution is proposed:

= Outline of Solution =
A deliberately "dumb" solution is proposed.
A trivial "mock" executor, '''ImportOnly''', having hex = OBC, has been added to '''protocols.ini'''.
An export is performed using this executer.
We then rely on the user to select a usable executor, and on RM to compute the corresponding parameters.

= Preparation =
Two things needs to be done once-and-for all to RM. These need not be repeated.

== Extending '''protocols.ini''' ==

RemoteMaster's data base '''protocols.ini''', located in
the base directory of RM, already contains '''ImportOnly''' since version 2.04 build 9. If using an earlier version,
add the following lines

<pre># Add this to the end of protocols.ini of Remotemaster in order
# to import IrScrutinizer rmdu exports.
[ImportOnly]
PID=99 99
DevParms=Device:8=0,Sub Device:8=0
DeviceTranslator=Translator()
CmdParms=OBC:16=0
DefaultCmd=00
CmdTranslator=Translator()
Notes=This is a trival dummy executor (protocol), intended to import third-party incomplete device updates, allowing the user to manually fix it up. It will preserve Device, Sub Device, and OBC.\n\nThe user must select a usable protocol instead of this one. First please check Options -> "Allow preserve Control", and then select "Preserve: OBC and function parameters" on the "Setup" pane.
</pre>

to '''protocols.ini'''.

== Selecting '''Allow preserve control''' ==
The RM parameter '''Allow preserve control''' has to be selected; see figure
[[Image:rm_select_allow_preserve.png]]

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format.

First, acquire or generate a suitable Girr file. [IrScrutinizer_Guide IrScrutinizer] can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, the useer is required to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail. The import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

== Remark ==

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We assume that this command set has been imported in IrScrutinizer, see figure.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:irscrutinizer_param_table.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

[[Image:irscrutinizer_param_export_rmdu.png]]

by selecting the "Export" pane, selecting "RemoteMaster" as the Export format, and pressing "Export param. remote".
This creates a simple rmdu file.

We assume that RM has been prepared as per above. After starting, the just-created simple rmdu file is opened (File -> Open).

[[Image:rm_opening_file.png]]

After opening the file, RM will present an error popup:

[[Image:rm_popup.png]]

This simply means that, although RM understood the protocol (executor really) named '''ImportOnly'''
(because _we_ put it into its '''protocols.ini'''!), it says that the currently selected remote does not support it, and the
user must select another one. (Just as we would expect!) We know that the desired protocol is called "NEC1",
so we next have to select an executor implementing that protocol. For the purpose of this example, we select the
executor named '''NEC1''', using the "Protocol" combo box. Make sure that as "Preserve" "OBC and function parameters" is selected.

[[Image:rm_selected_executor.png]]

Check that the protocol parameters (executor parameters really) make sense.
Here, the "D" in the protocol has been successfully turned into the parameter "Device" (= 73),
and the "Sub Device" is empty, as expected.

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:rm_imported_functions.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2022-05-14T19:38:06Z

Barf: /* Procedure */

= Importing Foreign IR Remotes in RemoteMaster =

''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.''
''The procedure requires some knowledge by the user, who have to make some manual decisions. The guide is not aimed at beginning users. Some prior knowledge about RemoteMaster and IrScrutinizer is assumed. Also, importing raw or unknown codes are not covered.''

= Ultra-short version =

* Perform an "RemoteMaster" export from IrScrutinizer 1.3 (or later) to a temporary file,
* Open the above created file in RemoteMaster. Select a usable executor manually. Perform other desired fixes.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

This article only deals with decoded signals, i.e., the IR signals are considered as consisting of a parametrized protocol,
together with its parameters. Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

It turns out that, with the current state of technology, the process is not fully automatic, but necessarily involves human interaction.

= Background (Mythbuster's lingo: Danger: Science!) =
The protocol and the corresponding parameter values constitute a mathematical description of how to render the signal as
a sequence of on/off durations. This is good for us to examine, generate, exchange with others. Unfortunately, it is not
quite the language the UEI remotes speak: Instead of "protocols", they contain a number of "executors",
which are a small programs in machine code, responsible for computing the IR signal. Unfortunately, they are
in general differently parameterized, and not in 1-1 correspondence with the protocols.
Many executors implement several different protocols,
so-called "combos". Also, for a particular protocol, there are often more than one executor to choose from. To make things extra
interesting, "executors" are in the RM program and documentation in general referred to as "protocols".

For example, the NEC1 protocol is implemented by a number of different executors, '''NEC1''', '''NEC 1or2 Combo''', '''NEC 2DEV Combo''', '''NEC 4DEV Combo''',
and others. Some of these also implement other protocols (like NEC2), some allow several different "D"s. All have slightly different
properties.

Another problem is that the master parameter for the individual commands is the "F" parameter (called "OBC" in RM)
in the protocol,
but the '''hex''' parameter in RM. The details are outside of the scope of this article, but we just state some facts
about the mapping OBC <-> hex:
* it depends on the executor (i.e., it is different for different executors),
* the '''hex''' parameter might depend on more input data than the OBC,
* it is "complicated", but deterministic and memory-less,
* RM can do this computation, provided that '''Allow Preserve Control'''
(accessable as Options -> Allow Preserve control) has been selected.

Importing a set of IR commands basically boils down to selecting an executor, computing its parameters,
and, for all contained commands, compute the hex parameter.

For this reason, it has not been attempted to automatically selecting the executor from input data.
Instead, this is delegated to the user. The following solution is proposed:

= Outline of Solution =
A deliberately "dumb" solution is proposed.
A trivial "mock" executor, '''ImportOnly''', having hex = OBC, has been added to '''protocols.ini'''.
An export is performed using this executer.
We then rely on the user to select a usable executor, and on RM to compute the corresponding parameters.

= Preparation =
Two things needs to be done once-and-for all to RM. These need not be repeated.

== Extending '''protocols.ini''' ==

RemoteMaster's data base '''protocols.ini''', located in
the base directory of RM, already contains '''ImportOnly''' since version 2.04 build 9. If using an earlier version,
add the following lines

<pre># Add this to the end of protocols.ini of Remotemaster in order
# to import IrScrutinizer rmdu exports.
[ImportOnly]
PID=99 99
DevParms=Device:8=0,Sub Device:8=0
DeviceTranslator=Translator()
CmdParms=OBC:16=0
DefaultCmd=00
CmdTranslator=Translator()
Notes=This is a trival dummy executor (protocol), intended to import third-party incomplete device updates, allowing the user to manually fix it up. It will preserve Device, Sub Device, and OBC.\n\nThe user must select a usable protocol instead of this one. First please check Options -> "Allow preserve Control", and then select "Preserve: OBC and function parameters" on the "Setup" pane.
</pre>

to '''protocols.ini'''.

== Selecting '''Allow preserve control''' ==
The RM parameter '''Allow preserve control''' has to be selected; see figure
[[Image:rm_select_allow_preserve.png]]

= Solution =

The [http://www.harctoolbox.org/Girr.html Girr format for IR signals] is an open and very versatile format for collections of IR signals. These can be parametrized, or in raw format. It is an XML based format.

First, acquire or generate a suitable Girr file. [IrScrutinizer_Guide IrScrutinizer] can generate such files, either by (using a suitable hardware receiver) "learning" an available physical remote, or by importing/converting from other format. (See the example below).

This file is then imported into RMDU, by "Open"-ing them. (See pictures in the next section). If the Girr file contains more than one remote, the useer is required to select one of them. In rare cases, the user is requested to select between several possible alternative executors. Although the import almost always succeeds, in rare cases it may fail. The import should be checked for plausibility. Assign the keys to functions, and make other desired fixes. The thus created device update can now be used as any other update.

== Remark ==

Importing remotes is still a quite complicated process. Limitations (for example by "uncommon" protocols, or if signals from several substantially different protocols are present), and in rare cases even bugs, may show up. In this case, please report in the forum.

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We assume that this command set has been imported in IrScrutinizer, see figure.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:irscrutinizer_param_table.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

[[Image:irscrutinizer_param_export_rmdu.png]]

by selecting the "Export" pane, selecting "RemoteMaster" as the Export format, and pressing "Export param. remote".
This creates a simple rmdu file.

We assume that RM has been prepared as per above. After starting, the just-created simple rmdu file is opened (File -> Open).

[[Image:rm_opening_file.png]]

After opening the file, RM will present an error popup:

[[Image:rm_popup.png]]

This simply means that, although RM understood the protocol (executor really) named '''ImportOnly'''
(because _we_ put it into its '''protocols.ini'''!), it says that the currently selected remote does not support it, and the
user must select another one. (Just as we would expect!) We know that the desired protocol is called "NEC1",
so we next have to select an executor implementing that protocol. For the purpose of this example, we select the
executor named '''NEC1''', using the "Protocol" combo box. Make sure that as "Preserve" "OBC and function parameters" is selected.

[[Image:rm_selected_executor.png]]

Check that the protocol parameters (executor parameters really) make sense.
Here, the "D" in the protocol has been successfully turned into the parameter "Device" (= 73),
and the "Sub Device" is empty, as expected.

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:rm_imported_functions.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

IrScrutinizer Guide

2020-04-17T16:58:29Z

Barf: clarified installation instructions.

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

As a tutorial, this document is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOS. For Windows and MacOS, native installation packages are available; for Windows it is the setup file *.exe, for Mac the zipped app *.MacOS.zip. Users of (most) 64-bit Linux-es can use the AppImage (*x86_64.AppImage) version. In all these cases, they come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.
(Files ending with md5, sha1, and sha512 are checksum files, and are not required for installation.)

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

Some programs use the word "render" instead of "generate".

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyUSB0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

As the IrWidget firmware does not contain a version, the Version field is empty, as can be seen from the picture.

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (for example [http://www.harctoolbox.org/arduino_nano.html this project]) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T14:01:29Z

Barf: Stylistic fixes

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

As a tutorial, this document is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

Some programs use the word "render" instead of "generate".

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyUSB0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

As the IrWidget firmware does not contain a version, the Version field is empty, as can be seen from the picture.

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (for example [http://www.harctoolbox.org/arduino_nano.html this project]) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:51:58Z

Barf: linked to my arduino nano instead of soft description

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

Some programs use the word "render" instead of "generate".

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyUSB0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

As the IrWidget firmware does not contain a version, the Version field is empty, as can be seen from the picture.

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (for example [http://www.harctoolbox.org/arduino_nano.html this project]) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:48:01Z

Barf: Remove "only fw version 2.2.2 is supported".

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

Some programs use the word "render" instead of "generate".

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyUSB0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

As the IrWidget firmware does not contain a version, the Version field is empty, as can be seen from the picture.

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:45:03Z

Barf: changed Linux example, mentioned empty version.

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

Some programs use the word "render" instead of "generate".

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyUSB0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

As the IrWidget firmware does not contain a version, the Version field is empty, as can be seen from the picture.

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:41:13Z

Barf: describe "render"

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

Some programs use the word "render" instead of "generate".

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:38:14Z

Barf: Stylistic fixes

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is in general similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all''', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these; IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer, rather it is a an "executor", either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Thus, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:26:07Z

Barf: Updated wrt current version

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the fields corresponding to parameters not used by the current protocols are disabled. Also, some protocols need other parameters. In this case, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.xml, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:21:55Z

Barf: Updated wrt current version

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrutinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he or she wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol (case not being recognized). There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:18:13Z

Barf: Updated wrt current version

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of the decode and (if selected through Options -> Invoke Analyzer) a computed IRP form, possibly together with some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture one IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving, until the button is pressed again.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scrutinize it (the button '''Paste & Scr.''' makes it in one click).

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is strictly speaking no protocol named NEC; this is the decoder's way of saying that it has identified a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T13:04:41Z

Barf: Updated installation instructions.

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. Users of (most) 64-bit Linux-es can use the AppImage version. In all cases, these come with its own Java installation, although the Windows version allows for using a previously installed Java. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads of the currently latest released version are found [https://github.com/bengtmartensson/harctoolboxbundle/releases/latest here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2020-04-16T12:57:32Z

Barf: Updated wrt current version

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpTransmogrifier IR-renderer and -decoder, which means that almost all IR protocols known to the Internet community (over 100) can be generated as well as decoded.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features. As a tutorial, it is not updated as often as the program, or even as the documentation. So the current program may have slightly different features and slightly different look than shown here.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] (also included under the Help menu of the program) may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
In 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It was invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The first versions of the present program, IrScrutinizer, was also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. (IrScrutizer almost completely replaces IrMaster, which is no longer maintained.) In 2019, IrpMaster, and the decoding engine DecodeIR, was replaced by IrpTransmogrifier, which is an even more developed rendering and decoding engine.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2017-03-15T12:40:52Z

Barf: /* Scrutinizing a single IR signal */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* Again assuming suitable hardware opened, pressing '''Capt. (cont)''' will start a capturing thread, capturing signals over and over again, without saving.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

File:Irscrutinizer F9.png

2017-03-15T12:09:21Z

Barf: Barf uploaded a new version of "File:Irscrutinizer F9.png"

IrScrutinizer Guide

2017-03-15T11:51:19Z

Barf:

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) <code>/dev/lirc</code> devices. All but <code>/dev/lirc</code> and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

In order to keep the tutorial nature, not all devices are described.

== USB IrToy ==
This is configured at the [[#USB IrToy Sending|Sending hw]] pane.

== IrWidget ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like COM8: or such. (If not found, install the driver.) Using Linux, it is in general assigned a name like /dev/ttyACM0. Now go to the IrWidget sub pane within the Capturing hw pane. Select the appropriate serial port, the one observed in the device manager or in the /dev directory. Press Open. See picture:

[[Image:irscrutinizer_irwidget.png]]

If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==

Configured at the [[#arduino sending|sending page]].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
To keep the tutorial nature, we only describe a few of the devices. Configuration of the other devices are in general similar.

==USB IrToy==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM8:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) For the IrToy, only firmware version 2.2 ("V222" in the report) is supported. See picture:

[[Image:irscrutinizer_irtoy.png]]

==Arduino==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

This is configured as a [http://www.harctoolbox.org/Girs.html Girs] client. A Girs client can be configure using USB Serial or using Ethernet with TCP sockets. In this tutorial, we only cover the first possibility. For this, the device is identified as above, selected, and opened. See screenshot.

[[Image:irscrutinizer_girs_client.png]]

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

File:Irscrutinizer girs client.png

2017-03-15T11:39:55Z

Barf:

File:Irscrutinizer irwidget.png

2017-03-15T10:58:50Z

Barf:

File:Irscrutinizer irtoy.png

2017-03-15T10:41:08Z

Barf: Barf uploaded a new version of "File:Irscrutinizer irtoy.png": Now configured as sending device.

IrScrutinizer Guide

2017-03-15T10:39:32Z

Barf: /* Configuring Hardware for Capturing */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) '''/dev/lirc''' devices. All but '''/dev/lirc''' and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

Many devices are capable both of sending and capturing. These in general have to be configured and opened on the "Sending hw" pane,
but for capturing still selected on the "Capturing hw" pane.

== USB IrToy ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM(:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

== IrWidget ==
Using the IrWidget is entirely similar to IrToy. However, it does not report a firmware version. If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
Configuring the sending hardware is essentially the same as configuring the hardware for capturing. We just make the following few remarks:

* For the IrToy, only firmware version 2.2 ("V222" in the report) is supported.
* A LIRC server, patched with [http://www.harctoolbox.org/lirc_ccf.html this patch], listening on a network port, can be used for sending.

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2017-03-15T09:05:00Z

Barf: /* Configuring Hardware for Capturing */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.4 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor (see for example [http://www.harctoolbox.org/arduino_nano.html this]), the [http://www.commandfusion.com/hardware/irlearner CommandFusion learner], (Linux only) Lirc mode 2 devices, and (Linux only) '''/dev/lirc''' devices. All but '''/dev/lirc''' and the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

== USB IrToy ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM(:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

== IrWidget ==
Using the IrWidget is entirely similar to IrToy. However, it does not report a firmware version. If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
Configuring the sending hardware is essentially the same as configuring the hardware for capturing. We just make the following few remarks:

* For the IrToy, only firmware version 2.2 ("V222" in the report) is supported.
* A LIRC server, patched with [http://www.harctoolbox.org/lirc_ccf.html this patch], listening on a network port, can be used for sending.

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2017-03-15T08:40:59Z

Barf: /* Exporting IR Signals */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a [http://www.harctoolbox.org/Glossary.html#CSV CVS file], fields separated by TABs. This is suitable for importing in a spreadsheet program.
;RemoteMaster
:Generates a rudimentary RemoteMaster device upgrade that can be imported in RemoteMaster, see [http://www.hifi-remote.com/wiki/index.php?title=Importing_Foreign_IR_Remotes_in_RemoteMaster this guide].
;Arduino *
:Generates Arduino C++ code for generating and sending IR signals, using one of the popular Arduino libraries.
;AnyMote, irplus
:Generates files for the mentioned smartphone remote apps.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.1.2 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor, and (experimentally, Linux only) Lirc mode 2 devices. All but the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

== USB IrToy ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM(:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

== IrWidget ==
Using the IrWidget is entirely similar to IrToy. However, it does not report a firmware version. If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
Configuring the sending hardware is essentially the same as configuring the hardware for capturing. We just make the following few remarks:

* For the IrToy, only firmware version 2.2 ("V222" in the report) is supported.
* A LIRC server, patched with [http://www.harctoolbox.org/lirc_ccf.html this patch], listening on a network port, can be used for sending.

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2017-03-15T08:20:07Z

Barf: /* Importing Wave files */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
IrScrutinizer can import IR signal packed in wave files (*.wav). The details are outside of the scope of an introduction. (Leave "Half carrier frequency" selected, unless you know what you are doing.)

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a CVS file, fields separated by TABs, that is suitable for importing in a spreadsheet program.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.1.2 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor, and (experimentally, Linux only) Lirc mode 2 devices. All but the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

== USB IrToy ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM(:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

== IrWidget ==
Using the IrWidget is entirely similar to IrToy. However, it does not report a firmware version. If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
Configuring the sending hardware is essentially the same as configuring the hardware for capturing. We just make the following few remarks:

* For the IrToy, only firmware version 2.2 ("V222" in the report) is supported.
* A LIRC server, patched with [http://www.harctoolbox.org/lirc_ccf.html this patch], listening on a network port, can be used for sending.

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2017-03-15T08:10:28Z

Barf: /* Capturing in Parametric Remote */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First of all, setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
The issue of packaging IR signal in wave files is outside of the scope of this introduction :-).

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a CVS file, fields separated by TABs, that is suitable for importing in a spreadsheet program.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.1.2 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor, and (experimentally, Linux only) Lirc mode 2 devices. All but the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

== USB IrToy ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM(:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

== IrWidget ==
Using the IrWidget is entirely similar to IrToy. However, it does not report a firmware version. If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
Configuring the sending hardware is essentially the same as configuring the hardware for capturing. We just make the following few remarks:

* For the IrToy, only firmware version 2.2 ("V222" in the report) is supported.
* A LIRC server, patched with [http://www.harctoolbox.org/lirc_ccf.html this patch], listening on a network port, can be used for sending.

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

IrScrutinizer Guide

2017-03-15T08:07:11Z

Barf: /* Installation */

[[Image:irscrutinizer_splash.png]]

= Introduction =
IrScrutinizer is a powerful program for capturing, generating, analyzing, importing, and exporting of infrared (IR) signals. For capturing and sending IR signals several different hardware sensors and senders are supported. IR Signals can be imported not only by capturing from one of the supported hardware sensors (among others: IrWidget, Global Caché, and Arduino), but also from a number of different file formats (among others: LIRC, Wave, Pronto Classic and professional, RMDU (partially), and different text based formats; not only from files, but also from the clipboard, from URLs, and from file hierarchies), as well as the Internet IR Databases by Global Caché and by IRDB. Imported signals can be decoded, analyzed, edited, and plotted. A collection of IR signal can thus be assembled and edited, and finally exported in one of the many supported formats. In addition, the program contains the powerful IrpMaster IR-renderer, which means that almost all IR protocols known to the Internet community (over 100) can be generated.

This document is not a manual for IrScrutinizer. (The full manual is found [http://www.harctoolbox.org/IrScrutinizer here], which should be read for questions not addressed here). Instead, it is a gentle guide to a program that can possibly look somewhat overwhelming at the first look. It focuses on what tasks can be achieved, and on the general "why", instead of a detailed description of all features.

== Prerequisites ==
For the sequel, a basic understanding of IR signals is required. My favorite introduction is [http://www.sbprojects.com/knowledge/ir/index.php the one by San Bergmans]. My [http://www.harctoolbox.org/Glossary.html glossary] may come in handy. In particular, there is a concise description of the [http://www.harctoolbox.org/Glossary.html#ProntoSemantics semantics of the Prono hex format].

== History ==
First, in 2011, I wrote an IR signal "engine" implementing the [http://www.hifi-remote.com/wiki/index.php?title=IRP_Notation IRP notation], called [http://www.harctoolbox.org/IrpMaster.html IrpMaster]. It is invoked as a command line program. Later that year, a program called [http://www.harctoolbox.org/IrMaster.html IrMaster] was released, which among other things constitutes a user friendly GUI front end to IrpMaster. The present program, IrScrutinizer, is also based on IrpMaster, and adds functionality from IrMaster, in particular the possibility to collect IR signals, a vastly improved import and export facility, and edit collections of IR commands. IrScrutizer almost completely replaces IrMaster, which is no longer maintained.

== Copyright ==
The program is copyright(c) by Bengt Martensson, and is Free Software published under the [http://www.gnu.org/licenses/gpl.html GPL3 license]. My copyright does not extend to the embedded "components", which are published under similar, but compatible licenses. Details are given in the [http://www.harctoolbox.org/IrScrutinizer.html#Copyright+and+License manual].

= Concepts =
For anyone familiar with the IR signals, the program is believed to be intuitive and easy to use. Almost all user interface elements have tool-help texts. Different panes have their own pop-up help. Many panes have a context menu, bound to the right mouse button.

Next picture shows the program immediately after startup.

[[Image:irscrutinizer_startup.png]]

In the upper row, there are six pull-down menus, named '''File, Edit, Actions, Options, Tools''', and '''Help'''. Their usage is believed to be mainly self explanatory.

Options to the program are in general found in the '''Options''' menu, or its subordinate menus. Some parameters for particular export formats are found in the sub-panes of the '''Export''' pane. Also the hardware configuring panes contain user parameters.

The main window is composed of seven sub panes denoted by '''Scrutinize signal''' (for processing single signal), '''Scrutinize remote''' (for collecting several signals to one "remote"), '''Generate''' (generates IR signal from protocol name and parameters), '''Import''', '''Export''', '''Capturing Hardware''', and '''Sending Hardware''' respectively.

= Installation =
IrScrutinizer takes great pride of being a portable program, and runs on Windows, Linux (including RaspberryPi), and MacOsX. For Windows and MacOS, native installation packages are available. In all cases, Java must first be installed. Users of (most) 64-bit Linux-es can use the AppImage version. Others, and those who do not like preinstalled binaries, can install the generic binary package, or install from the sources directly.

Details are given [http://www.harctoolbox.org/IrScrutinizer.html#Installation in the manual]. Downloads are found [https://github.com/bengtmartensson/harctoolboxbundle/releases here].

= Scrutinizing a single IR signal =
The '''Scrutinize signal''' pane is used to analyze a single IR signal. Press F9 to see a sample IR signal directly. The program will now look like this:
[[Image:irscrutinizer_F9.png]]

The upper sub-window shows the signal either as [http://www.harctoolbox.org/Glossary.html#CCF Pronto Hex] (the default) or as a number of timings in microseconds (selected by Options -> Output text format). Then there follows an output area for the results of [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] and (if selected) [http://www.harctoolbox.org/Glossary.html#Analyzer AnalyzeIR], as well as some other identified parameters. The plot windows shows the signal, with the [http://www.harctoolbox.org/Glossary.html#ModulationFrequency modulation] removed. The [http://www.harctoolbox.org/Glossary.html#IrSignal Intro sequence] is shown red (if present), the repeat signal blue (if present), while the ending signal (only present in rare cases) is shown green.

Basically, the user enters something in the upper subwindow, or capturing something with hardware. The program will then analyze the signal. Things that can be done on this pane:
* If suitable capturing hardware is connected and opened, pressing '''Capture''' will capture an IR signal form the hardware, and scrutinize it.
* The user can enter something in the upper window, often by pasting from the clipboard, or hand modifying already present content. This requires pressing the '''Scrutinize''' button.
* If suitable sending hardware is connected and opened, pressing the '''Transmit''' button will transmit the signal with the selected hardware.
* If a suitable export format is selected, the '''Export''' button will export the signal in the export format selected.

Different formats are accepted in the input window: Pronto Hex, Timing list with or without signs, "UEI Learned" format, as well as the Global Cache irsend formats are currently understood.

The plotter can be zoomed (of course, only on the horizontal scale) by pressing the left mouse button at the desired start point, and dragging to the desired new ending point. To reset, use "Reset plot" from the context menu or the Actions menu. For comparison with other signals, the plot can be "torn off" by Action -> Clone plot menu entry.

There are a number of other possibilities offered by the top menus, and the context menus in the different sub-windows.

=== Excercise 1. ===
Find an "arbitrary" IR signal in the JP1 or RemoteCentral forums, for example [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7443 this one]. Copy the signal to the clipboard, and paste it, and scutinize it (the button '''Paste & Scr.''' makes it in one click). (Although sent from one key press on the , [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR] consider this signal as two signals.)

=== Excercise 2. ===
Make sure that Pronto Hex is selected as output text format. (Options -> Output text format). Press F9, which will show a NEC1 signal. Using the keyboard, remove the last four hexadecimal numbers ("015B 0057 0016 0E6C"). Press '''Scrutinize'''. This will produce an error message, since the signal length is now inconsistent with the header. So we fix that: Change the forth number from 0002 to 0000. Pressing '''Scrutinize''' again shows that the signal now decodes, but instead of "NEC1" as [http://www.harctoolbox.org/Glossary.html#IrProtocol protocol], we now have "NEC". There is no protocol named NEC; this is [http://www.harctoolbox.org/Glossary.html#DecodeIR DecodeIR's] way of saying that it has identifed a NEC-type signal, but the repeat part is missing.

= Scrutinizing a remote (several IR signals) =
Often, we would like to consider a whole set of IR signals, for example, all that can be used for controlling a piece of consumer electronics. The word ''remote'' will be used in the sequel to denote such a set of IR signals, having something in common.

IrScrutinizer, as well as most other IR signal programs, can consider an IR signal either as a [http://www.harctoolbox.org/Glossary.html#IrProtocol Protocol] and parameteres (''parameteric'') or as (one, two, or three) sequences of durations, denoting on- and off-periods, a [http://www.harctoolbox.org/Glossary.html#RawIrSignal raw signal]. Whenever possible, the parametric form should be preferred.

The '''Scrutinize remote''' pane, has two sub-panes: '''Parametric Remote''' and '''Raw Remote'''. This tutorial will only consider the parametric remote sub-pane.

The pane consists of a table, like in a spreadsheet program. There are columns for protocol name, the more common protocol parameters, name, etc. It is used for capturing a number of signals using connected hardware, or to edit/inspect a previously captured, or imported, remote. See picture.

[[Image:irscrutinizer_parametric_remote.png]]

Just like in a program like Excel, the columns can be resized, edited (using the text area on top of the table), and sorted from an arbitrary column (requires enabling the sorter in the context menu). The colums can also be reordered by dragging them with the mouse.

== Capturing in Parametric Remote ==
First setup and test the hardware is to be used. Make sure that the capturing hardware has been opened. To capture parametric signals, the user just presses '''Capture''', which now stays active, until pressed again. IrScrtinizer will now use a separate thread for collecting the captures, entered into the table. The user can intermix captures and entering of names with the keyboard in any order he wishes.

The table can be edited the keyboard. New signals can be entered, having any recognized protocol name as protocol. There are also a number of interesting things that can be done with the context menu.

When finished, the table is [[#Exporting_IR_Signals | exported]] in a suitable file format. Alternatively, the table can be copied to the clipboard, for being pasted into a spreadsheet program, or the [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual#Functions_Tab functions tab of RemoteMaster].

= Generating IR Signals =
IrScrutinizer can generate well over 100 different IR protocols. For this, select the desired protocol from the combo box. Different protocol require different parameters. The four most common are D ("device"), S ("subdevice"), F ("function"), and T ("toggle"). After having selected protocol, the not needed parameters among D, S, F, and T are disabled. Some protocols need other parameters. If so, these are entered in the '''Additional parameters''' text field, using the format like '''X=0 Y=42'''. Note that there are no spaces around the equals sign, however, space between the assignments.

The signal is generated by pressing '''Generate'''. See the picture.

[[Image:irscrutinizer_generate.png]]

The thus generated signal can be [[#Exporting_IR_Signals | exported]], or transmitted with suitable connected sending hardware. The three buttons in the lower row transfers the signal to the '''Scrutinize signal''' pane, or adds it to the '''Parametric Remote''' or '''Raw Remote''' panes.

It is also possible to extend IrScrutinizer with new protocols. This is done by adding protocols to the protocol data base, the file IrpProtocols.ini, but is well outside of the scope of this introductory guide.

= Importing IR Signals =
The Internet is a vast resource for IR signals for different devices. Unfortunately, there is no universally accepted exchange format for a "remote", i.e. a collection of IR signals with names. For this reason, IrScrutinizer implements a number of different importers. These serves to fill the table '''Parametric Remote''' or '''Raw Remote''', where the imports can be further edited. That table does on clear on subsequent imports, so it can be used to merge signals from different sources. Data bases, local files (even zip-ped), directory hierarchies, and URLs, and even the clipboard can be imported.

In this introductory guide, we do not describe all the different importers. Usage of the not described importers is entirely similar to the ones described.

== The IRDB Database ==
[http://www.irdb.tk IRDB] is "one of the largest crowd-sourced, manufacturer-independent databases of infrared remote control codes on the web, and aspiring to become the most comprehensive and most accurate one."

To use, select the '''IRDB''' sub-pane within the '''Import''' pane. First, select "Select me to load" in the '''Manufacturer''' combo box, in order to load the list of known manufacturers. Select the desired one. This loads the list of '''Device Type''''s known for that manufacturer. The '''Protocol & Parameters''' combo box is now loaded by the known "devices". Select one, and press the '''Load''' button. This downloads the information from the data base and pushes it to the tree in the left middle part. Alternatively, the button '''Load all''' will load all of of the entries under '''Protocol & Parameters'''. The next picture shows IrScrutinizer after having '''Load all''' Sony video projectors.

[[Image:irscrutinizer_irdb_sony.png]]

(During import, IrScrutinizer detected some inconsistencies in the imported data, as indicated by the messages in the console.)

The import tree is organized like this: The top level note is always "Remotes". Its immediate children are the remotes in the import, and can be opened or closed by clicking on the symbol to the left of the folder symbol. (The picture shows the first remote closed, and the second remote opened.) The children of the remotes are the named IR signals. By hovering the mouse over one such, its protocol and parameters (if available) are displayed as tooltips. (See the picture, where "DYNAMIC" is selected.)

The signal can now be imported by pressing '''Import all'', which transfers them to the '''Parametric Remote''' sub-pane in '''Scrutinizer remote''' pane. Alternatively, a subset can be selected with mouse clicks, (Shift-left and Ctrl-left works as espected for selecting multiple signals) and imported by '''Import selection'''. The button '''Import signal''' transfers the (single) selected signal to the '''Scrutinizer signal''' pane. If suitable sending hardware is opened, a selected signal can be transmitted directly by the '''Transmit selected''' button.

== Importing Lirc files ==
Both inside and outside of the Lirc community, there is often a need either to analyze or to extract the information in a Lirc configuration file. IrScrutinizer is very well fit for this task, as it contains a great deal of the Lirc code (translated to Java). The [http://sourceforge.net/p/lirc-remotes/code/ci/master/tree Lirc remotes data base] is also a considerable resource, to be considered when hunting the Internet for IR codes.

To import a single Lirc file posted in a web page or in a mail, it is easiest to just copy it to the clipboard, got to the '''Lirc''' import pane, and click '''Load from clipbard'''. To load a local file, use the '''...'''-Button to navigate to the file, and press '''Load File/URL''' to perform the actual import. This can also be used import directories containing Lirc configuration files. (In this way, the whole Lirc remote data base can be imported, at least if sufficient memory is available. On my computer, it takes less than one minute.)

Often, the imported Lirc files contain problems of different types. During import, there may be warnings in the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

The entire Lirc data base can be browsed [http://lirc-remotes.sourceforge.net/remotes-table.html here]. (Note that the remotes without "Timing" are usable only with specialized hardware, for example a certain notebook computer, and unusable for the rest of us.)

Assuming [http://git-scm.com/ Git] is installed as a command line program, the entire Lirc remote data base can be checked out to a local disc by a command like

<code>git clone git://git.code.sf.net/p/lirc-remotes/code lirc-remotes</code>

As the name of the text area and button suggests, also URLs, like <code>
http://sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/yamaha/RX-V995.lircd.conf?format=raw</code>, can be directly imported by entering it into the '''File/URL''' area.

== Importing Pronto Classic (ccf) files ==
In particular on [http://files.remotecentral.com/pronto/index.html RemoteCentral], there is a huge number of [http://www.harctoolbox.org/Glossary.html#ccfFileFormat CCF Files] for the Philips Pronto Classic. They are not really a data base for IR signals, rather a complete configuration for the probably best remote control there was, around 15 years ago. IrScrutinizer only considers them for importing the contained IR signals.

When downloading files from e.g. RemoteCentral, these are often zipped. There is no need to unzip these, as IrScrutinizer will open the zip files directly.

When importing a CCF file, the contained devices (in the Pronto sense) will be mapped to different "remotes" in the import tree. Sub-pages of a device will all be merged together.

Unfortunately, there are often small problems within the imported files, in particular invalid IR signals. These problems are listed to the console. IrScrutinizer handles these problems gracefully, in general by just ignoring the entries that it could not make sense of.

[http://files.remotecentral.com/view/3491-7440-1/aaron_guenthers_pronto_ccf.html Here] is a file to exercise on, it contains several devices, there are sensible IR signals, as well as signals not recognized, likely bad learns.

== Importing RemoteMaster files ==
The [http://www.hifi-remote.com/forums/index.php JP1 forum] is also a vast source of IR signals, see [http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 the file section] and [http://www.hifi-remote.com/jp1/lookup/ the lookup tool]. Their files are in general "Device upgrades" configuration files for different remotes manufactured by UEI (Universal Electronics), meant to be maintained by the program [http://www.hifi-remote.com/wiki/index.php?title=Remote_Master_Manual RemoteMaster]. This means that the "protocol" used in a device upgrade can sometimes be hard to understand. The "protocol" in a device upgrade does not quite correspond to the meaning of "protocol" in IrScrutinizer and DecodeIR, rather it is a an executor, either built-in in the UEI remote, or a custom protocol, which is a small machine code chunk contained in the device upgrade, particular to the very microprocessor of the remote. In these cases, either an instance of that processor, or an emulator for it, would be required to faithfully render the signal. Fortunately, this is not always the case, and the contained protocols can be mapped onto the known IR protocols easily. Having said that, the RemoteMaster import facility is by necessity limited and incomplete.

=== Excercise ===
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=6721 Here] is a file to try, that imports fine. (The "Download" button is only visible for logged-in users.)

== Importing Wave files ==
The issue of packaging IR signal in wave files is outside of the scope of this introduction :-).

=== Excercise ===
Try importing [http://www.hifi-remote.com/forums/dload.php?action=file&file_id=12096 this file]. Note that some information on the content of the file is written to the console.

== Importing "text" files ==
In the absence of a universally accepted exchange format for remotes (in the sense of sets of named IR signals) -- a gap that the format [http://www.harctoolbox.org/Girr.html Girr] is trying to fill -- IR signals are often published in different text formats, or as spreadsheets. IrScrutinizer has quite some facilities for importing that sort of files. It can (at least not presently) not open Excel <code>.xsl</code>-files directly. Instead a spreadsheet program like Excel, OpenOffice/Libreoffice or Gnumeric can export (a subset of) its data as comma (or tab) separated values, a text file where the fields are divided by a certain character, in general the comma (,), the semicolon (;), the TAB character (ASCII 9), or general whitespace. We will cover the three sub-panes of the '''Text''' importer pane next.

=== Raw, line-based ===
"Raw, line-based" means that raw codes (e.g. in the Pronto Hex format) are found on lines by itself, preceded by a name, also on a line by itself. Many postings on RemoteCentral and JP1 follow this scheme. IrScrutinizer finds the "payload" (IR signal in any of the recognized formats, like Pronto Hex (also short format), UEI learned, timing lists, sendir) among other content, and imports it.

==== Exercise ====
Consider [http://www.remotecentral.com/cgi-bin/mboard/rc-discrete/thread.cgi?7222 this thread on RemoteCentral]. Copy the whole thread to the clipboard (Ctrl-A, Ctrl-C). Go to the '''Raw, line-based''' pane, and press '''Load from clipboard'''. There should now be 24 properly decoded signals in the tree view.

=== Raw ===
This is for importing raw formats in a spreadsheet like format (comma separate values etc). To use, select the character separating the fields as "Field separator". Select the column containing the name of the IR Signal/command, and the column containing the raw data.

==== Excercise ====
Download this [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls Excel file] containing the IR commands for the Oppo 103/105 Bluray player. Using a spreadsheet program (e.g. Excel or LibreOffice), convert the first worksheet of it to a CSV file using any suitable field separator (e.g. TAB). Using the '''Raw''' pane, select the column containing the name, and the column containing the Pronto hex data, as well as the field separator. Import by pressing the '''Load File/URL''' button. There should now be 57 signals in the tree view, all NEC1 with D=73, varying F.

=== Parametric ===
This pane imports IR signals given as protocol and parameters. As the excercise shows, some manual work may be necessary. There are combo boxes to select the column number for the name, protocol, and the parameters D, S, and F. Also the number base for parsing the numbers can be selected.

==== Exercise ====
Use the same csv file as in the previous exercise. Select the name column, and ''either'' the column for the hexadecimal command number (=F) (in which case 16 has number number base should be selected), or the column for the decimal command number (in which case 10 has number number base should be selected). Note the warnings in the console, stating that some lines did not make sense as IR signals.

[[Image:irscrutinizer_oppo_parametric.png]]

Press '''Import all''' to transfer the result to the '''Parametric Remote'''. In that pane, note first that there are a few ''junk'' entries, not corresponding to IR signal, so remove them by marking the line, press the right mouse button, and select '''Delete selected''' from the context menu. Since the protocol and the D are the same for all signals, the file did not put in on every line, which means that the import missed it, and it has to be entered manually. For this, the individual lines can be edited, however, there is a shortcut: From the context menu, select '''Advanced''' -> '''Set protocol...''' and enter the protocol name (here NEC1) in the popup. Similarly, select '''Advanced''' -> '''Select D (deviceno) ...''', and enter D (73).

Note: Unfortunately, there is a bug in version 1.1.2, affecting import of csv files using colon (:), TAB, and WHITESPACE. To avoid, use comma (,) or semicolon (;) instead.

= Exporting IR Signals =
IrScrutinizer does not have a "save" feature, because that would be of very limited use. Instead, there is the possibility to "export" in a number of different formats.

Next picture shows the '''Export''' pane.

[[Image:irscrutinizer_export.png]]

The combo box to the left selects the export format. There is a large number of different export formats implemented, and the user can even add his own by adding them to a configuration file.

Different export formats have different properties. There are some options (see the picture) that do not make sense on some export formats. They will be disabled when selecting certain protocols.

Some formats (Girr and Text) can contain several "representation" of the same IR signal. These are the checkboxes to the right of the combo box.

There are four "things" that can be exported: The signal on the '''Scrutinize signal''' pane (the button '''Export signal'''), the '''Parametric remote''' pane within '''Scrutinize remote''' ('''Export param. remote'''), the '''Raw remote''' pane within '''Scrutinize remote''' ('''Export raw remote'''), and the signal(s) from the '''Generate''' pane ('''Export generated''').

The lower part of the pane allows to set a few format-specific parameters.

Next we give some comments on some of the export formats.

;[http://www.harctoolbox.org/Girr.html Girr]
: This is the native format of IrScrutinizer. It is an XML file that can contain different content, as selected by the checkboxes.
;Text
: Exports the IR signals in the form of normal ASCII files, not really suitable for anything but forums and such.
;LIRC
: Exports a set of IR signals as a Lirc configuration file.
;Wave
: Exports a single IR signal as a wave file.
;Pronto Classic
: Generates a Pronto Classic CCF file, complete with one button for every IR signal. (This can be considered to be a modern replacement of the IrPanels/CCF Panels program.)
;Spreadsheet
: Generates a CVS file, fields separated by TABs, that is suitable for importing in a spreadsheet program.

= Configuring Hardware for Capturing =
To capture real IR signals, some sort of hardware is needed. Version 1.1.2 of IrScrutinizer supports [http://www.globalcache.com Global Caché’] units with learner, Kevin Timmerman's [http://www.compendiumarcana.com/irwidget/ IrWidget], Dangerous Prototype's [http://dangerousprototypes.com/docs/USB_Infrared_Toy USB IrToy], Arduinos with a connected non-demodulating sensor, and (experimentally, Linux only) Lirc mode 2 devices. All but the Lirc mode2 devices are capable of determining the modulation frequency of the captured signal.

The splash image, also shown on top of this page, shows, from left to right, a Global Caché iTach Flex, an IrToy, and an Arduino Nano.

== USB IrToy ==
Connect the device to the computer and determine the device that the operating system assigns to it. For this, on Windows, use the device manager to find it. It should have a name like <code>COM(:</code> or such. (If not found, install the [https://code.google.com/p/dangerous-prototypes-open-hardware/downloads/detail?name=USBIRToy.package.v22.zip driver].) Using Linux, it is in general assigned a name like <code>/dev/ttyACM0</code>. Now go to the '''IrToy''' sub pane within the '''Capturing hw''' pane. Select the appropriate serial port, the one observed in the device manager or in the <code>/dev</code> directory. Press '''Open'''. The version of the firmware in the IrToy should now be reported in the '''Ver:''' text field, here "V222". (This serves as a test that the communication is working.) See picture:

[[Image:irscrutinizer_irtoy.png]]

== IrWidget ==
Using the IrWidget is entirely similar to IrToy. However, it does not report a firmware version. If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].

== Arduino ==
A suitably equipped Arduino (essentially a Uno or Nano with non-demodulating sensor and the ArduinoGirsLite firmware) makes an excellent IR capturer. Usage is analogous to the IrToy. If Windows needs a particular driver, visit the [http://www.arduino.cc Arduino home page].

== Global Caché ==
Global Caché's with a build in learner, like the new [http://www.globalcache.com/products/itachflex/ iTach Flex] work well with IrScrutinizer. Devices on the local network, having firmware from the last few years, are detected automatically by IrScrutinizer. Just select the desired one from the combo box.

Whatever hardware has been selected and opened, it can/should be tested directly on the pane. Press the '''Test button''' and fire an IR signal at the sensor within the next few seconds. It should now print the timing of the captured signal, the measured modulation frequency, and possible decodes. See the picture:

[[Image:irscrutinizer_irtoy_test.png]]

Please note that the Test facility is just what the name says, a testing facility -- productive captures should be make on the '''Scrutinize signal''' or '''Scrutinize remote''' panes.

= Configuring Hardware for Sending =
Configuring the sending hardware is essentially the same as configuring the hardware for capturing. We just make the following few remarks:

* For the IrToy, only firmware version 2.2 ("V222" in the report) is supported.
* A LIRC server, patched with [http://www.harctoolbox.org/lirc_ccf.html this patch], listening on a network port, can be used for sending.

= Feedback =
IrScrutinizer is actively developed. ''Your'' feedback and suggestions for improvements is actively solicited. Suggestions and bug report can, e.g., be left in the forum here, or raised as [https://github.com/bengtmartensson/harctoolboxbundle/issues issues at Github] (requires a Github account). Apart from this forum, I participate on [http://www.remotecentral.com/cgi-bin/mboard/forums.cgi RemoteCentral forum] (in both cases with the user name [http://en.wikipedia.org/wiki/Spaceballs#Heroes Barf]) and on the [https://lists.sourceforge.net/lists/listinfo/lirc-list Lirc mailing list].

For feedback on this page, as well as improvements, either use the forum, or register on this Wiki.

== Sources ==
The sources to the program are maintained at [https://github.com/bengtmartensson/harctoolboxbundle Github]. Contributions (Forks and push requests) are welcome.

Importing Foreign IR Remotes in RemoteMaster

2016-12-19T09:47:14Z

Barf: protocols.ini already contains ImportOnly since RM 2.04build10. Fixed broken link to Oppo codes.

= Importing Foreign IR Remotes in RemoteMaster =

''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.''
''The procedure requires some knowledge by the user, who have to make some manual decisions. The guide is not aimed at beginning users. Some prior knowledge about RemoteMaster and IrScrutinizer is assumed. Also, importing raw or unknown codes are not covered.''

= Ultra-short version =

* Perform an "RemoteMaster" export from IrScrutinizer 1.3 (or later) to a temporary file,
* Open the above created file in RemoteMaster. Select a usable executor manually. Perform other desired fixes.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

This article only deals with decoded signals, i.e., the IR signals are considered as consisting of a parametrized protocol,
together with its parameters. Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

It turns out that, with the current state of technology, the process is not fully automatic, but necessarily involves human interaction.

= Background (Mythbuster's lingo: Danger: Science!) =
The protocol and the corresponding parameter values constitute a mathematical description of how to render the signal as
a sequence of on/off durations. This is good for us to examine, generate, exchange with others. Unfortunately, it is not
quite the language the UEI remotes speak: Instead of "protocols", they contain a number of "executors",
which are a small programs in machine code, responsible for computing the IR signal. Unfortunately, they are
in general differently parameterized, and not in 1-1 correspondence with the protocols.
Many executors implement several different protocols,
so-called "combos". Also, for a particular protocol, there are often more than one executor to choose from. To make things extra
interesting, "executors" are in the RM program and documentation in general referred to as "protocols".

For example, the NEC1 protocol is implemented by a number of different executors, '''NEC1''', '''NEC 1or2 Combo''', '''NEC 2DEV Combo''', '''NEC 4DEV Combo''',
and others. Some of these also implement other protocols (like NEC2), some allow several different "D"s. All have slightly different
properties.

Another problem is that the master parameter for the individual commands is the "F" parameter (called "OBC" in RM)
in the protocol,
but the '''hex''' parameter in RM. The details are outside of the scope of this article, but we just state some facts
about the mapping OBC <-> hex:
* it depends on the executor (i.e., it is different for different executors),
* the '''hex''' parameter might depend on more input data than the OBC,
* it is "complicated", but deterministic and memory-less,
* RM can do this computation, provided that '''Allow Preserve Control'''
(accessable as Options -> Allow Preserve control) has been selected.

Importing a set of IR commands basically boils down to selecting an executor, computing its parameters,
and, for all contained commands, compute the hex parameter.

For this reason, it has not been attempted to automatically selecting the executor from input data.
Instead, this is delegated to the user. The following solution is proposed:

= Outline of Solution =
A deliberately "dumb" solution is proposed.
A trivial "mock" executor, '''ImportOnly''', having hex = OBC, has been added to '''protocols.ini'''.
An export is performed using this executer.
We then rely on the user to select a usable executor, and on RM to compute the corresponding parameters.

= Preparation =
Two things needs to be done once-and-for all to RM. These need not be repeated.

== Extending '''protocols.ini''' ==

RemoteMaster's data base '''protocols.ini''', located in
the base directory of RM, already contains '''ImportOnly''' since version 2.04 build 9. If using an earlier version,
add the following lines

<pre># Add this to the end of protocols.ini of Remotemaster in order
# to import IrScrutinizer rmdu exports.
[ImportOnly]
PID=99 99
DevParms=Device:8=0,Sub Device:8=0
DeviceTranslator=Translator()
CmdParms=OBC:16=0
DefaultCmd=00
CmdTranslator=Translator()
Notes=This is a trival dummy executor (protocol), intended to import third-party incomplete device updates, allowing the user to manually fix it up. It will preserve Device, Sub Device, and OBC.\n\nThe user must select a usable protocol instead of this one. First please check Options -> "Allow preserve Control", and then select "Preserve: OBC and function parameters" on the "Setup" pane.
</pre>

to '''protocols.ini'''.

== Selecting '''Allow preserve control''' ==
The RM parameter '''Allow preserve control''' has to be selected; see figure
[[Image:rm_select_allow_preserve.png]]

= Procedure =

* First, a "dumb" rmdu file is generated, using the '''ImportOnly''' executor, using IrScrutinizer 1.3 (or another tool),
* This is imported in RM. The user there selects a usable executor. If RM computes the parameters correctly, this will produce a working rmdu device update.

== Caveat ==

As is probably clear to the user, some prior knowledge is required of the user. If RM do the computations correctly, this should
result in usable rmdu file. However, this functionality is not very widely used, and bugs may show up. (In that case, please report
in the forum.)

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [http://download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls published set of IR commands].
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We assume that this command set has been imported in IrScrutinizer, see figure.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:irscrutinizer_param_table.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

[[Image:irscrutinizer_param_export_rmdu.png]]

by selecting the "Export" pane, selecting "RemoteMaster" as the Export format, and pressing "Export param. remote".
This creates a simple rmdu file.

We assume that RM has been prepared as per above. After starting, the just-created simple rmdu file is opened (File -> Open).

[[Image:rm_opening_file.png]]

After opening the file, RM will present an error popup:

[[Image:rm_popup.png]]

This simply means that, although RM understood the protocol (executor really) named '''ImportOnly'''
(because _we_ put it into its '''protocols.ini'''!), it says that the currently selected remote does not support it, and the
user must select another one. (Just as we would expect!) We know that the desired protocol is called "NEC1",
so we next have to select an executor implementing that protocol. For the purpose of this example, we select the
executor named '''NEC1''', using the "Protocol" combo box. Make sure that as "Preserve" "OBC and function parameters" is selected.

[[Image:rm_selected_executor.png]]

Check that the protocol parameters (executor parameters really) make sense.
Here, the "D" in the protocol has been successfully turned into the parameter "Device" (= 73),
and the "Sub Device" is empty, as expected.

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:rm_imported_functions.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

Importing Foreign IR Remotes in RemoteMaster

2016-12-18T16:38:33Z

Barf: Created page with "= Importing Foreign IR Remotes in RemoteMaster = ''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.'' ''The..."

= Importing Foreign IR Remotes in RemoteMaster =

''This guide will take the reader through a method for importing foreign (i.e. non-JP1) IR remotes into RemoteMaster.''
''The procedure requires some knowledge by the user, who have to make some manual decisions. The guide is not aimed at beginning users. Some prior knowledge about RemoteMaster and IrScrutinizer is assumed. Also, importing raw or unknown codes are not covered.''

= Ultra-short version =

* Perform an "RemoteMaster" export from IrScrutinizer 1.3 (or later) to a temporary file,
* Add the '''ImportOnly''' executor to '''protocols.ini''',
* Open the above created file in RemoteMaster. Select a usable executor manually. Perform other desired fixes.

= Introduction =

The Internet is a vast source of infrared code sets, see for example [http://harctoolbox.org/IR-resources.html this list].
For usage with RemoteMaster ("RM"), this information is in general not directly usable.
Often, usable RM device update files ("rmdu") can be found in the
[http://www.hifi-remote.com/forums/dload.php?action=category&cat_id=4 JP1 device update repository] (see also
[http://www.hifi-remote.com/forums/dload.php?action=file&file_id=8487 the master list] and
[http://www.getzweb.net/jp1/ the lookup tool]).
But still some cases remain; in particular self captured ("learned") remotes.

This article only deals with decoded signals, i.e., the IR signals are considered as consisting of a parametrized protocol,
together with its parameters. Of course, one way to solve the problem would be to manually type the signals
(protocol, parameters, name, possible comment) in the function editor of RM, possibly the help of cut-n-paste.
This is a very tedious and error prone approach.
Importing these in a systematic way, with minimal interaction, is the topic of the current article.

It turns out that, with the current state of technology, the process is not fully automatic, but necessarily involves human interaction.

= Background (Mythbuster's lingo: Danger: Science!) =
The protocol and the corresponding parameter values constitute a mathematical description of how to render the signal as
a sequence of on/off durations. This is good for us to examine, generate, exchange with others. Unfortunately, it is not
quite the language the UEI remotes speak: Instead of "protocols", they contain a number of "executors",
which are a small programs in machine code, responsible for computing the IR signal. Unfortunately, they are
in general differently parameterized, and not in 1-1 correspondence with the protocols.
Many executors implement several different protocols,
so-called "combos". Also, for a particular protocol, there are often more than one executor to choose from. To make things extra
interesting, "executors" are in the RM program and documentation in general referred to as "protocols".

For example, the NEC1 protocol is implemented by a number of different executors, '''NEC1''', '''NEC 1or2 Combo''', '''NEC 2DEV Combo''', '''NEC 4DEV Combo''',
and others. Some of these also implement other protocols (like NEC2), some allow several different "D"s. All have slightly different
properties.

Another problem is that the master parameter for the individual commands is the "F" parameter (called "OBC" in RM)
in the protocol,
but the '''hex''' parameter in RM. The details are outside of the scope of this article, but we just state some facts
about the mapping OBC <-> hex:
* it depends on the executor (i.e., it is different for different executors),
* the '''hex''' parameter might depend on more input data than the OBC,
* it is "complicated", but deterministic and memory-less,
* RM can do this computation, provided that '''Allow Preserve Control'''
(accessable as Options -> Allow Preserve control) has been selected.

Importing a set of IR commands basically boils down to selecting an executor, computing its parameters,
and, for all contained commands, compute the hex parameter.

For this reason, it has not been attempted to automatically selecting the executor from input data.
Instead, this is delegated to the user. The following solution is proposed:

= Outline of Solution =
A deliberately "dumb" solution is proposed.
An almost trivial "mock" protocol, '''ImportOnly''', having hex = OBC, is defined by extending '''protocols.ini'''.
An export is performed using this executer.
We then rely on the user to select a usable executor, and on RM to compute the corresponding parameters.

= Preparation =
Two things needs to be done once-and-for all to RM. These need not be repeated.

== Extending '''protocols.ini''' ==

RM needs to be told about the "executor" '''ImportOnly'''. Its data base is the text file '''protocols.ini''', located in
the base directory of RM. The necessary modification is simply to append
this text segment

<pre># Add this to the end of protocols.ini of Remotemaster in order
# to import IrScrutinizer rmdu exports.
[ImportOnly]
PID=99 99
DevParms=Device:8=0,Sub Device:8=0
DeviceTranslator=Translator()
CmdParms=OBC:16=0
DefaultCmd=00
CmdTranslator=Translator()
Notes=This is a trival dummy executor (protocol), intended to import third-party incomplete device updates, allowing the user to manually fix it up. It will preserve Device, Sub Device, and OBC.\n\nThe user must select a usable protocol instead of this one. First please check Options -> "Allow preserve Control", and then select "Preserve: OBC and function parameters" on the "Setup" pane.
</pre>

to '''protocols.ini'''.

== Selecting '''Allow preserve control''' ==
The RM parameter '''Allow preserve control''' has to be selected; see figure
[[Image:rm_select_allow_preserve.png]]

= Procedure =

* First, a "dumb" rmdu file is generated, using the '''ImportOnly''' executor, using IrScrutinizer 1.3 (or another tool),
* This is imported in RM. The user there selects a usable executor. If RM computes the parameters correctly, this will produce a working rmdu device update.

== Caveat ==

As is probably clear to the user, some prior knowledge is required of the user. If RM do the computations correctly, this should
result in usable rmdu file. However, this functionality is not very widely used, and bugs may show up. (In that case, please report
in the forum.)

= Example =
We consider the Oppo BDP 103 BluRay player, which has a [published set of IR commands](download.oppodigital.com/BDP103/BDP-103_BDP-105_Remote_Code_v1.1.xls).
(The [http://www.hifi-remote.com/wiki/index.php?title=IrScrutinizer_Guide#Importing_.22text.22_files IrScrutinizer Tutorial]
describes how such files can be imported into IrScrutinizer.) We assume that this command set has been imported in IrScrutinizer, see figure.
Note that every row denotes a command, has a name, a protocol, and one or more parameters. A comment may describe the command further.

[[Image:irscrutinizer_param_table.png]]

Typically, the protocol and all but one parameter, in general called "F", are constant.
Here, the protocol is "NEC1", D = 73, and S is "nonexistent".
Having inspected this table, and made
any desirable changes, the table is exported,

[[Image:irscrutinizer_param_export_rmdu.png]]

by selecting the "Export" pane, selecting "RemoteMaster" as the Export format, and pressing "Export param. remote".
This creates a simple rmdu file.

We assume that RM has been prepared as per above. After starting, the just-created simple rmdu file is opened (File -> Open).

[[Image:rm_opening_file.png]]

After opening the file, RM will present an error popup:

[[Image:rm_popup.png]]

This simply means that, although RM understood the protocol (executor really) named '''ImportOnly'''
(because _we_ put it into its '''protocols.ini'''!), it says that the currently selected remote does not support it, and the
user must select another one. (Just as we would expect!) We know that the desired protocol is called "NEC1",
so we next have to select an executor implementing that protocol. For the purpose of this example, we select the
executor named '''NEC1''', using the "Protocol" combo box. Make sure that as "Preserve" "OBC and function parameters" is selected.

[[Image:rm_selected_executor.png]]

Check that the protocol parameters (executor parameters really) make sense.
Here, the "D" in the protocol has been successfully turned into the parameter "Device" (= 73),
and the "Sub Device" is empty, as expected.

Now, select the "Functions" pane, and check the sanity of its content, in particular hex- and OBC values.

[[Image:rm_imported_functions.png]]

The import has been successful! It now remains to tune the device update (rmdu) to your needs:
adjusting description, notes, device type as desired, select the target remote, assigning the functions to its buttons, saving the
file to a suitable name, etc.
This is outside of the scope of this article, and described in detail the RM documentation.

= Support and help =

Please post help requests in the forum.

Suggestions for improvements, both of the procedure here described, and of the present document,
are solicited.

File:Rm selected executor.png

2016-12-18T16:16:52Z

Barf:

File:Rm select allow preserve.png

2016-12-18T16:16:33Z

Barf:

File:Rm popup.png

2016-12-18T16:16:10Z

Barf:

File:Rm opening file.png

2016-12-18T16:15:46Z

Barf:

File:Rm imported functions.png

2016-12-18T16:15:28Z

Barf:

File:Irscrutinizer param table.png

2016-12-18T16:14:45Z

Barf: