Some links in this post may be affiliate links. We may get paid if you buy something or take an action after clicking one of these, but without addictional costs for you compared to direct buying.
Infrared sensors are really common to devices which need to be controlled from a remote within reduced distances. Typical applications are in remoting TV, media center, robots, air conditioning systems, etc.
With the growth of mass production, their prices have plummeted and can be found on e-commerce websites.
Linux systems have a spread package called LIRC (Linux Infrared Remote Control). This is a really handy package with most common remotes, but it becomes a little tricky when you havea remote not included in LIRC remotes database because you have to know you remote infrared signal map to create your custom configuration file.
A second chance comes from ir-keytable package. This package is really simple to use and allows you to record one by one you remote keys signals and map them to your custom config file, even without knowing signal profile of your remote.
In this article, I’ll show how to connect your Raspberry PI to an IR receiver and control it from a remote with ir-keytable. For this article, I’m going to use a Raspberry PI Zero W, but the same procedure works also with newer Raspberry PI boards.
IR detectors are little microchips with a photocell that are tuned to listen to infrared light. They are almost always used for remote control detection – every TV and DVD player has one of these in the front to listen for the IR signal from the clicker. Inside the remote control is a matching IR LED, which emits IR pulses to tell the TV to turn on, off or change channels. IR light is not visible to the human eye, which means it takes a little more work to test a setup. There are a few difference between these and say a CdS Photocells:
– IR detectors are specially filtered for Infrared light, they are not good at detecting visible light. On the other hand, photocells are good at detecting yellow/green visible light, not good at IR light – IR detectors have a demodulator inside that looks for modulated IR at 38 KHz. Just shining an IR LED wont be detected, it has to be PWM blinking at 38KHz. Photocells do not have any sort of demodulator and can detect any frequency (including DC) within the response speed of the photocell (which is about 1KHz) – IR detectors are digital out – either they detect 38KHz IR signal and output low (0V) or they do not detect any and output high (5V). Photocells act like resistors, the resistance changes depending on how much light they are exposed to.
What We Need
As usual, I suggest adding from now to your favourite e-commerce shopping cart all the needed hardware, so that at the end you will be able to evaluate overall costs and decide if to continue with the project or remove them from the shopping cart. So, hardware will be only:
Add GPIO to Device Tree overlay in boot config. Edit /boot/config.txt
sudo nano /boot/config.txt
Uncomment and change dtoverlay row as following (GPIO pin parameter refers to BCM naming for RPI pins):
dtoverlay=gpio-ir,gpio_pin=17
Close and save. Reboot your Raspberry PI:
sudo reboot
After restart, please login again from terminal and install ir-keytable package:
sudo apt install ir-keytable
Map Your Remote With ir-Keytable
Before starting to customize our remote mapping, we can try our luck to find supported remotes. To list supported pre-built Keymaps:
ls /lib/udev/rc_keymaps/
ir-keytable has less pre-built remotes than LIRC, but I prefer it because – as said – it is simpler to customize. If you was lucky and found your remote in pre-built ones, than you can simply test it by typing “ir-keytable -t” on terminal and testing if buttons work. If it returns key names, then you are ok and this procedure ended.
Create Your Custom Mapping
For not so lucky people, list supported kernel protocols with ir-keytable command:
pi@raspberrypi:~ $ sudo ir-keytable
Found /sys/class/rc/rc0/ (/dev/input/event0) with:
Name: gpio_ir_recv
Driver: gpio_ir_recv, table: rc-rc6-mce
LIRC device: /dev/lirc0
Attached BPF protocols: Operation not permitted
Supported kernel protocols: lirc rc-5 rc-5-sz jvc sony nec sanyo mce_kbd rc-6 sharp xmp imon
Enabled kernel protocols: lirc rc-6
bus: 25, vendor/product: 0001:0001, version: 0x0100
Repeat delay = 500 ms, repeat period = 125 ms
In next step we’ll use ir-keytable in test mode to identify and take note about supported protocol and keys pressure ID. Let’s start test procedure with all protocols supported:
you are now prompted to generate key pressure events. Point your remote to IR sensor and press a key. In my test, with an Elegoo remote, the following rows are generated:
1274.230088: lirc protocol(nec): scancode = 0x45
1274.230144: event type EV_MSC(0x04): scancode = 0x45
1274.230144: event type EV_SYN(0x00).
The first line shows that my remote uses “nec” protocol. trace this in your notes. Protocol will be the same for all buttons.
The first and second rows show that my key pressure generated a “0x45” scancode. I had this event by pressing my Power button on remote. So my first matching is:
0x45 = Power key
Repeat this step for each remote button and create a mapping table similar to the following one:
In this section, we are going to create our custom .toml file that will be used by ir-keytable at kernel level. A .toml file is a simple file with a short description of remote name and a map of system buttons to scancodes. Usable system buttons are listed in following text file you can get from my dowload area:
Usually, the correct ones are these keys starting with “KEY_” prefix.
Create a toml file similar to (or download from the next link) my Elegoo.toml, but with your data you noted in the previous step and related kernel keys:
To test our toml file, we need to clean current keytable, load toml file, read i to check and then we can test (diring test, consider that if you press power button and if it works, then your Raspberry PI will shut down):
If you have a similar behaviour and keys showed are the same you pressed, then your toml file is valid and working.
Make Your Mapping Permanent
We need now to make our configuration permanent after reboot.
Move your toml file to “/etc/rc_keymaps/”
sudo mv /pathToFile/your.toml /etc/rc_keymaps/
Edit /etc/rc_maps.cfg to add a row
sudo nano /etc/rc_maps.cfg
Add a row on the devices table referencing your toml file. Use * wildcard both on the driver and table columns. In my case, my file is named Elegoo.toml and my rc_maps.cfg section will appear as the following:
.....
.....
# Table to automatically load the rc maps for the bundled IR's provided with the
# devices supported by the linux kernel
# driver table file
* * Elegoo.toml
* rc-adstech-dvb-t-pci adstech_dvb_t_pci.toml
* rc-alink-dtu-m alink_dtu_m.toml
* rc-anysee anysee.toml
.....
.....
Test configuration loading:
sudo ir-keytable -a /etc/rc_maps.cfg -s rc0
This should return something like the following (keycodes number and protocol may vary according to your toml:
Old keytable cleared
Wrote 21 keycode(s) to driver
Protocols changed to nec
Moreover, “ir-keytable -r” terminal command should show your mapping.
To make it permanent after reboot, edit /etc/rc.local
sudo nano /etc/rc.local
and add loading configuration command before “exit 0” final row:
.....
.....
printf "My IP address is %s\n" "$_IP"
fi
ir-keytable -a /etc/rc_maps.cfg -s rc0
exit 0
Reboot and check if it is persistent.
Enjoy!
How useful was this post?
Click on a star to rate it anonymously!
Average rating 5 / 5. Vote count: 13
No votes so far! Be the first to rate this post.
We are sorry that this post was not useful for you!
23 thoughts on “Setup Raspberry PI Infrared Remote from terminal”
thank you for your very usefull article.
I had my IR-receiver installed in no time and it works.
Great.
The only thing after a reboot, it did not work anymore.
I had to put sudo in front of the line in rc.local file:
sudo ir-keytable -a /etc/rc_maps.cfg -s rc0
After that it worked after a reboot as well.
hy peppe80
I removed the sudo in the rc.local file as you stated that it runs as root.
Then I performed a reboot and bingo, it did work.
Just to be sure, I powered off, powered up, and it still works.
So why it did not after the very first try, I don’t know. The rc.local file is like you posted.
Thanks again.
Yes, thank you again!
Over the past two days, I’ve mapped keys on my remote and made some keybindings (using a method I found elsewhere) to make buttons initiate a shutdown or reboot of the host Raspberry Pi. Next, I’m going to use the IR remote to control a string of RGB LEDs…. seems like a good match. I’m thinking the approach should be based on a python script that watches for inputs and gives outputs.
Have you done anything like this in your tutorials or playing around with the Pi…?
This is a very good idea. This shouln’t be too complicated from theorical perspective as with python subprocess library you can execute shell commands. But requires time, as you should manage a command running in background (ir-keytable when collecting test data) and at same time ask user what key he pressed to save matching. But the most time with programs is managing exceptions, differences between a huge IR hardware world and so on. Writing new programs is a quite simple job, but the hard part is managing them
I just wanted to say Thanks! I’ve been struggling with my IR receiver and my Buster raspberryOS install for weeks. I’ve read countless tutorials with different ways to get my various IR remotes to work with my RaspberryPi and none of them completely worked. Your information here worked 1st try. I am running a headless Pi and am going to use an old IR remote to control my Mopidy install.
This is incredible. Got my Elegoo working quickly and learned a lot about keycodes and persistent changes.
Learned more from 20 minutes of this article than 20 hours of the Arch Wiki
Thank you for your feedback, Jonathan. I’m very happy when my tutorials help people in learning. I hope you will enjoy also the other articles available in my blog
Hi Peppe, thanks for the wonderful guide!! I just have a problem with sending commands can you help me? How do I send stored commands using an IR-TX connected to the Raspberry?
Thank you!!
Hi Dante,
Thank you for your appreciation. This tutorial is about an RX sensor and the remote sends IR commands. To solve your issue we need to know the model of your TX/RX sensor and Search for tutorials about that
I got a tx card on ebay. What I need to do is control a hi-fi device via infrared by sending commands from the raspberry. I tried using Lirc but the guides are a bit dated and when I go to send the irsend command the status LED on the tx board flashes but does not transmit anything. Can you help me ? Thank you in advance 😊
Hello,
Thank you for this tutorial!
I have manged to complete your tutorial for my remote and I get correct mapping of scan keys to the scan codes.
For my remote that uses nec protocol, scan codes 0x16, 0x19 and 0x47 are mapped to KEY_VOLUMEDOWN, KEY_VOLUMEUP, and KEY_MUTE.
I expected that I can reboot my RPi (4b or zero 2w) and expect the IR remote to control volume and mute? It’s not doing it. The RPi is headless and running Bookworm x64 Lite.
Could you kindly let me know if I need to do anything more? I am not a coder and so need some hand-holding, please. I will provide additional information as needed.
Thank-you!
We use cookies on our website to give you the most relevant experience by remembering your preferences and repeat visits. By clicking “Accept”, you consent to the use of ALL the cookies.
This website uses cookies to improve your experience while you navigate through the website. Out of these, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may affect your browsing experience.
Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Cookie
Duration
Description
AWSELBCORS
session
This cookie is used by Elastic Load Balancing from Amazon Web Services to effectively balance load on the servers.
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Cookie
Duration
Description
_ga_*
1 year 1 month 4 days
Google Analytics sets this cookie to store and count page views.
Advertisement cookies are used to provide visitors with relevant ads and marketing campaigns. These cookies track visitors across websites and collect information to provide customized ads.
Cookie
Duration
Description
__qca
1 year 26 days
The __qca cookie is associated with Quantcast. This anonymous data helps us to better understand users' needs and customize the website accordingly.
_dlt
1 day
Zendesk set this cookie to create a unique ID for the session. This enables the website to collect data on visitor behaviour for statistical purposes.
mc
1 year 1 month
Quantserve sets the mc cookie to track user behaviour on the website anonymously.
thank you for your very usefull article.
I had my IR-receiver installed in no time and it works.
Great.
The only thing after a reboot, it did not work anymore.
I had to put sudo in front of the line in rc.local file:
sudo ir-keytable -a /etc/rc_maps.cfg -s rc0
After that it worked after a reboot as well.
Really strange: rc.local should run as root… however happy that it worked also for you!
hy peppe80
I removed the sudo in the rc.local file as you stated that it runs as root.
Then I performed a reboot and bingo, it did work.
Just to be sure, I powered off, powered up, and it still works.
So why it did not after the very first try, I don’t know. The rc.local file is like you posted.
Thanks again.
This is THE BEST tutorial for enabling your Raspberry Pi to see IR input…. I’ve worked thru quite a few!
Thank you!
Thank you, Mike. Glad this helped you too.
Yes, thank you again!
Over the past two days, I’ve mapped keys on my remote and made some keybindings (using a method I found elsewhere) to make buttons initiate a shutdown or reboot of the host Raspberry Pi. Next, I’m going to use the IR remote to control a string of RGB LEDs…. seems like a good match. I’m thinking the approach should be based on a python script that watches for inputs and gives outputs.
Have you done anything like this in your tutorials or playing around with the Pi…?
This is a very good idea. This shouln’t be too complicated from theorical perspective as with python subprocess library you can execute shell commands. But requires time, as you should manage a command running in background (ir-keytable when collecting test data) and at same time ask user what key he pressed to save matching. But the most time with programs is managing exceptions, differences between a huge IR hardware world and so on. Writing new programs is a quite simple job, but the hard part is managing them
I would have loved to meet this guide 6 hours ago….. just golden. Funny enough I have the same remote control. super eaaaasy.
Thank you for your feedback, Carlo
I just wanted to say Thanks! I’ve been struggling with my IR receiver and my Buster raspberryOS install for weeks. I’ve read countless tutorials with different ways to get my various IR remotes to work with my RaspberryPi and none of them completely worked. Your information here worked 1st try. I am running a headless Pi and am going to use an old IR remote to control my Mopidy install.
Glad it helped you too. If you want to give back, share this post with your friends 😉
This is incredible. Got my Elegoo working quickly and learned a lot about keycodes and persistent changes.
Learned more from 20 minutes of this article than 20 hours of the Arch Wiki
Thank you for your feedback, Jonathan. I’m very happy when my tutorials help people in learning. I hope you will enjoy also the other articles available in my blog
Hi Peppe, thanks for the wonderful guide!! I just have a problem with sending commands can you help me? How do I send stored commands using an IR-TX connected to the Raspberry?
Thank you!!
Hi Dante,
Thank you for your appreciation. This tutorial is about an RX sensor and the remote sends IR commands. To solve your issue we need to know the model of your TX/RX sensor and Search for tutorials about that
So this in the link is the IR transmitter. What I would like to do is control a hifi device via raspberry. I have already taken the commands from the LIRC database, only that once the configuration is done, when I go to send the command the presence LED on the TX card lights up but nothing happens on the device. Is there any recent guide for configuring LIRC as a transmitter? because the ones I found are all dated. Thank you in advance for your availability
https://www.ebay.it/itm/284116631419?mkcid=16&mkevt=1&mkrid=711-127632-2357-0&ssspo=-KjvLcpwRNS&sssrc=2047675&ssuid=2UkpvlBvSRq&var=585607060562&widget_ver=artemis&media=COPY
I got a tx card on ebay. What I need to do is control a hi-fi device via infrared by sending commands from the raspberry. I tried using Lirc but the guides are a bit dated and when I go to send the irsend command the status LED on the tx board flashes but does not transmit anything. Can you help me ? Thank you in advance 😊
Hello,
Thank you for this tutorial!
I have manged to complete your tutorial for my remote and I get correct mapping of scan keys to the scan codes.
For my remote that uses nec protocol, scan codes 0x16, 0x19 and 0x47 are mapped to KEY_VOLUMEDOWN, KEY_VOLUMEUP, and KEY_MUTE.
I expected that I can reboot my RPi (4b or zero 2w) and expect the IR remote to control volume and mute? It’s not doing it. The RPi is headless and running Bookworm x64 Lite.
Could you kindly let me know if I need to do anything more? I am not a coder and so need some hand-holding, please. I will provide additional information as needed.
Thank-you!
Hi Ravindra. Please let me understand better the problem. After you reboot the raspberry PI, the keys doesn’t work? (sorry for the late reply)
Hi
How can I use the remote codes of my remote controller in Python?
Thanks
Hi Paulo,
Python allows you to execute and read any bash command output with the
subprocesslibrary. You can use it to read the ir-keytable outputsThanks
You’re welcome! 😉