IrScrutinizer Guide - Revision history

The Robman: 21 revisions imported

2025-11-02T18:52:33Z

21 revisions imported

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

Barf: clarified installation instructions.

2020-04-17T16:58:29Z

clarified installation instructions.

← Older revision		Revision as of 16:58, 17 April 2020
Line 32:		Line 32:

	= Installation =		= 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.		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].		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].

Barf: Stylistic fixes

2020-04-16T14:01:29Z

Stylistic fixes

← Older revision		Revision as of 14:01, 16 April 2020
Line 5:		Line 5:


	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.		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 ==		== Prerequisites ==

Barf: linked to my arduino nano instead of soft description

2020-04-16T13:51:58Z

linked to my arduino nano instead of soft description

← Older revision		Revision as of 13:51, 16 April 2020
Line 268:		Line 268:

	==<span id="arduino sending">Arduino</span>==		==<span id="arduino sending">Arduino</span>==
	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].		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.		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.

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

2020-04-16T13:48:01Z

Remove "only fw version 2.2.2 is supported".

← Older revision		Revision as of 13:48, 16 April 2020
Line 263:		Line 263:

	==<span id="USB IrToy Sending">USB IrToy</span>==		==<span id="USB IrToy Sending">USB IrToy</span>==
	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:		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]]		[[Image:irscrutinizer_irtoy.png]]

Barf: changed Linux example, mentioned empty version.

2020-04-16T13:45:03Z

changed Linux example, mentioned empty version.

← Older revision		Revision as of 13:45, 16 April 2020
Line 237:		Line 237:

	== IrWidget ==		== 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:		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]]		[[Image:irscrutinizer_irwidget.png]]

	If Windows needs a driver, install the [http://www.ftdichip.com/Drivers/VCP.htm FTDI Virtual comm-port driver].		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 ==		== Arduino ==

Barf: describe "render"

2020-04-16T13:41:13Z

describe "render"

← Older revision		Revision as of 13:41, 16 April 2020
Line 95:		Line 95:
	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.		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.		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.

Barf: Stylistic fixes

2020-04-16T13:38:14Z

Stylistic fixes

← Older revision		Revision as of 13:38, 16 April 2020
Line 103:		Line 103:


	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.		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 ==		== The IRDB Database ==
Line 116:		Line 116:
	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 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.		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 ==		== Importing Lirc files ==
Line 137:		Line 137:
	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.		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 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.		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.
Line 146:		Line 146:

	== Importing RemoteMaster files ==		== 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.		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 ===		=== Excercise ===

Barf: Updated wrt current version

2020-04-16T13:26:07Z

Updated wrt current version

← Older revision		Revision as of 13:26, 16 April 2020
Line 87:		Line 87:

	= Generating IR Signals =		= 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.		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.		The signal is generated by pressing '''Generate'''. See the picture.
Line 97:		Line 97:


	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.		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 =		= Importing IR Signals =

Barf: Updated wrt current version

2020-04-16T13:21:55Z

Updated wrt current version

← Older revision		Revision as of 13:21, 16 April 2020
Line 78:		Line 78:

	== Capturing in Parametric Remote ==		== 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.		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. There are also a number of interesting things that can be done with the context menu.		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.