Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johanson/irur
Infrared Universal Remote webUI Home Assistant add-on. Provides a simple web UI to record and manage buttons for your virtual IR remote. Supports ingress.
https://github.com/johanson/irur
esp32 home-automation homeassistant iot iot-application sonoff tasmota
Last synced: 2 months ago
JSON representation
Infrared Universal Remote webUI Home Assistant add-on. Provides a simple web UI to record and manage buttons for your virtual IR remote. Supports ingress.
- Host: GitHub
- URL: https://github.com/johanson/irur
- Owner: johanson
- Created: 2020-07-22T19:47:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T18:07:55.000Z (over 1 year ago)
- Last Synced: 2023-08-01T04:27:10.640Z (over 1 year ago)
- Topics: esp32, home-automation, homeassistant, iot, iot-application, sonoff, tasmota
- Language: Vue
- Homepage:
- Size: 2.72 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# IRUR: IR remote control add-on for Home Assistant
![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armv7 Architecture][armv7-shield]
Infrared Universal Remote webUI for Tasmota ESP8266 based devices over MQTT.
Provides a simple web UI to record and manage buttons for your virtual IR remote. Supports ingress and an option to show in sidebar. Comes with around 150 icons, but you can also use text or emojis.
## ![IRUR logo][logo]
## Installation
Flash your ESP8266 board with Tasmota (tasmota-ir.bin) firmware. All the builds support common IR protocols but use tasmota-ir.bin for all available protocols provided by IRremoteESP8266 library). Install your IR emitter and receiver and configure the right pins from Tasmota configuration (`irrecv` and `irsend` respectively).
![Example Tasmota config][tasmoconf]
### Home Assistant
- Supervisor ⇒ Add-on store ⇒ Click on the right-top menu ⇒ Add Repositories ⇒ https://github.com/johanson/irur ⇒ Add
- The repository should appear underneath the official and community add-ons.
- Install the add-on, make sure you to configure correct topic(s) for receiving and sending messages corresponding to your Tasmota configuration. You can use [MQTT Explorer][mqttexplorer] if you have problems figuring it out. HA provides MQTT broker's credentials automatically.
### Configuration
```
topic_listen: irur/tele/RESULT
topic_send:
- irur/cmnd/IRsend
```
```
topic_listen (str)
```
MQTT topic for receiving IR codes
```
topic_send (list)
```
MQTT topic for sending IR codes.
### Screenshots
![Irur screenshots][irur-screensots-comp-1]
![Irur screenshots][irur-screensots-comp-2]
Changelog is [here][changelog].
## Keyboard Shortcuts
```
Shift+N: New knob
Shift+T: New tab
Esc: Cancel/Close
Enter: Save (while editing)
```
## Development
Clone the repo, install npm dependencies. Install fabric3 (pip3 install fabric3) , do `fab -list` from terminal in the project dir for all the available tasks.
```
$ fab -l
Available commands:
api Start a node server for the backend api.
build Compile and minify for production and push to live (master).
:param bump_version: Bump addon version number before
building, defaults to `True`
:type bump_version: bool, optional
:param push: Push to master branch, defaults to `False`
:type push: bool, optional
Arguments: bump_version=False, push=False
deploy: Compile and upload the project to the HA server for Docker.
:param bump_version: Bump addon version number before
pushing to remote server, defaults to `True`
:type bump_version: bool, optional
:param sync: Synchronize working directy to remote server
:type sync: bool, optional
:param reload: Reload and update addon over SSH
:type reload: bool, optional
Arguments: bump_version=True, sync=True, reload=True
lint Lint and fix files.
serve Compile with hot-reload for development.
test Run unit tests with Cypress.
```
If you prefer npm scripts: `npm run build` to build with webpack (or `npm run serve` for development), `node server.js --dev` to start the server.
### Dependencies
- Node.js
- Express
For developing: Vue cli, npm, Cypress (testing), pip3 Fabric3, pip3 python-dotenv
# Credits
Icons made by Roundicons, Freepik, Pixel perfect, hirschwolf, Kiranshastry, Good Ware, Becris, srip, dmitri13, surang, Nikita Golubev, Linector, Icongeek26, Smashicons, photo3idea_studio, bqlqn from [www.flaticon.com](https://www.flaticon.com/ "Flaticon")
---
This project is licensed under the terms of the [MIT license][mit].
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[logo]: https://github.com/johanson/irur/blob/master/irur/logo.png?raw=true
[tasmoconf]: https://github.com/johanson/irur/blob/master/irur/screenshots/tasmota.png?raw=true
[mqttexplorer]: https://github.com/thomasnordquist/MQTT-Explorer
[irur-screensots-comp-1]: https://github.com/johanson/irur/blob/master/irur/screenshots/irur-screensots-comp-1.png?raw=true
[irur-screensots-comp-2]: https://github.com/johanson/irur/blob/master/irur/screenshots/irur-screensots-comp-2.png?raw=true
[mit]: https://github.com/johanson/irur/blob/master/irur/LICENSE
[changelog]: https://github.com/johanson/irur/blob/master/irur/CHANGELOG.md