This project implements a Girs server for the Arduino. That is, it is an interactive server that can send and receive IR signals, with some bells and whistles. The interactive server is mainly meant for interact with other programs. communicating over a serial line (likely in USB disguise), TCP-, or UDP sockets, acting as server (accepting incoming requests) or client (initiating connections).
It implements some of the functionality of [Chris Young's IRLib](http://tech.cyborg5.com/irlib/, https://github.com/cyborg5/IRLib), which is a major rewrite of a previous library called IRremote, published by Ken Shirriff in his blog, but does not use it directly. It uses Michael Dreher's IrWidget (article in German), see also this forum contribution. Michael's code is included, in somewhat modified form, in the files IrWidget.[cpp,h] and IrWidgetAggregating.[cpp,h].
The project contains a library, contained in the directory GirsLib,
and a few applications, presently Girs, GirsLite, Listener,
and others. The directory GirsLib should
be copied to
the library area, typically $HOME/Arduino/libraries/GirsLib, while the
application directories can be processed by the Arduino IDE
directly. The directory Girs contains the AGirs application
interactive program. Listener is a uni-directional program that just
emits decodes on the serial interface. It is intended to be used in
conjunction with my Java program
dispatcher. (It may
possibly be discontinued in the future.)
It is a modular program that is heavily based on CPP symbols, defined
in the configuration file config.h. This determines the capacities of the
compiled program, and adapts the configuration to the underlying
hardware. The options are (somewhat) documented in Girs/config.h.
Not all combination are sensible or implemented. Some of the non-sensible
combinations will be detected and will generate a compilation error.
Caused by the limitations of the Arduino build process, it may be necessary to adjust
the path to config.h in the included statement of GirsLib/LedLcdManager.cpp.
There is a "library" (in the Arduino sense), src/GirsLib, which should be copied/moved/linked to the Arduino library area,
typically ~/Arduino/libraries or C:\Arduino\libraries.
The other sub-directories of src contain different sketches that can
be compiled and run on the Arduino.
Due to the quirks of the preprocessor of the Arduino IDE, the following rule is used:
The _program_.ino is kept empty, except for some dummy #includes,
necessary for the IDE to find the libraries. The real code goes into _program_.cpp.
For further motivation, see this article.
(however, "Third" therein does not appear to be valid with current software.)
I have written a fairly detailed description of using an Arduino Nano (clone) by soldering suitable components to the PCB. This is a small handy gadget at the size of a (large) stamp and the price of a (small) pizza, perfect for using with IrScrutinizer and Lirc.
The hardware configuration is determined by including a suitable header file. It describes the attach sensor(s) and the pins they are connected to. To allow soldering sensors directly to the holes in some boards, the program supports defining e.g. SENSOR_GND and SENSOR_VSS, which will make the program define these pins as digital outputs, being fed by constant 0 and 5 volts respectively.
Note that the sending pin and the capture pin (as opposed to the receive pin) are not configurable, but has to follow the following table:
Sender Pin Capture Pin Uno/Nano (ATmega328P) 3 8 Leonardo/Micro (ATmega32U4) 9 4 Mega2560 (ATmega2560) 9 49
RF signals (433 MHz and other carrier frequencies) do not use the IR typical modulation. Also there are a few IR protocols (like Revox, Barco, Archer) not using modulation. These signals can be sent by defining the symbol NON_MOD, and connecting some hardware capable of sending non-modulated signals (IR- or RF-) to the GPIO pin defined as NON_MOD_PIN. Then transmitted signals having frequency 0 will be directed to that device. (Later versions may use different syntax and semantic.)
The flashed unit can be tested with a standard terminal program, like the
serial monitor of the Arduino IDE. For this, set the baud rate to 115200, and
the line ending to carriage return. It is now possible to communicate
with the unit using the commands of
Girs. Just type the command to
the program, and the unit will respond.
Exactly which commands are
available depends on the configuration. In all cases, the
version and the modules commands are
available. If receive is implemented, just type
"r" (without the
quotes), followed by return, and fire a suitable IR signal at the
receiver. The raw capture will be output to the terminal program. Using
the clipboard, it can be pasted to IrScrutinizer, and analyzed. Of course, also
the other commands can be tested in this way.
- Infrared4Arduino by myself. Current version is 1.0.0. Can be installed by the library manager within the Arduino IDE (Sketch -> Include library -> Manage libraries, name Infrared). In earlier versions of this project, this was integrated in AGirs, but it is now an independent project.
- Ethernet (if enabling the ETHERNET configure option). Contained in the Arduino IDE.
- SPI (if enabling the ETHERNET or LCD_I2C configure option). Contained in the Arduino IDE.
- Wire (if enabling the LCD_I2C configure option). Contained in the Arduino IDE.
- Arduino-LiquidCrystal-I2C version 1.1.3. (Version 1.1.1 will not work with current Arduino IDE, 1.1.2 probably will.) (The Frank de Brabander version does not work.) Needed if defining LCD_I2C, i.e. connecting an LCD display with an I2C interface card.
- What are Makefiles doing in an Arduino project?
To build the project for the Arduino, use the Arduino IDE from arduino.cc, as in most Arduino projects. The Makefile is used for building a "Software-in-the-loop" test version for the PC; of interest for developers only.
Please follow the links given. Differently put, "receive" uses a demodulating receiver, "capture" a non-demodulating decoder. Note that this is not universally accepted terminology (yet!).
- What Ethernet modules are supported?
Only cards based on the W5100 chip (and compatible), like the official shield. There are both cheap clones of the original available, as well as smallish W5100-based cards.
- What about "GirsLite"?
As indicated by the
name, it is a minimalist Girs server
for the Arduino, that implements only the
capture and the
transmit modules,
without all options. It is meant to be used with
IrScrutinizer
versions 1.1.*, as well as with Lirc, using the Lirc
girs driver by yours truly. Documentation is found with the Lirc
driver, in the Lirc sources the file girs.html.
It is not an independent program, it is just AGirs with certain options enabled, namely the CPP symbols TRANSMIT, CAPTURE, LED, and (optionally) NON_MOD defined. Alternatively, if RECEIVE is defined, but not CAPTURE, the program mimics the capture command with a demodulating sensor, for usage with IrScrutinizer without a non-demodulating sensor.
- What about Girs4Lirc?
Now discontinued, replaced by GirsLite. Just as GirsLite, this was just a certain configuration of AGirs, "optimized" for Lirc, supporting TRANSMIT, NON_MOD (optionally), RECEIVE, LED, LCD, DECODE (only to the LCD), TRANSMITTERS (only a dummy implementation).
The entire work is licensed under the GPL2 license, or later. Chris' as well as Ken's code is licensed under the LGPL 2.1-license. Michael's code carries the GPL2-license, although he is willing to agree to "or later versions".