summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 444ef4ede3b6fd49035cdf6ba4b681a874d62b55 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# LIRC

> Interact with the LIRC daemon

![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue)
[![Version](https://img.shields.io/pypi/v/lirc)](https://pypi.org/project/lirc/)
[![Black](https://img.shields.io/badge/style-black-black)](https://pypi.org/project/black/)
[![Documentation Status](https://readthedocs.org/projects/lirc/badge/?version=latest)](https://lirc.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/eugenetriguba/lirc/workflows/python%20package%20ci/badge.svg?branch=master)](https://github.com/eugenetriguba/lirc/actions/)
[![Codecov](https://codecov.io/gh/eugenetriguba/lirc/graph/badge.svg)](https://codecov.io/gh/eugenetriguba/lirc)

LIRC is a python package that allows you to interact with
the daemon in the Linux Infrared Remote Control package.

More information on the lircd daemon, socket interface,
reply packet format, etc. can be found at https://www.lirc.org/html/lircd.html

## Installation

The package is hosted on PyPI and can be installed
through pip.

```
$ pip install lirc
```

However since this is a wrapper around the LIRC daemon, it
is expected that LIRC is installed and setup on the given
system.

## Usage

```python
from lirc import Lirc

lirc = Lirc()
response = lirc.version()

print(response.command)
>>> 'VERSION'
print(response.success)
>>> True
print(response.data)
>>> ['0.10.1']
```

To get started with the package, we import `Lirc` and can
initialize it with the defaults by passing it no arguments.

This will assume a socket path of `/var/run/lirc/lircd`.
Furthermore, this will also then assume a socket connection
using AF_UNIX and SOCK_STREAM. These are both the defaults
that should work on a Linux system. There are ports of LIRC
to Windows and macOS but using the package there is far less
common. However, both of these are configurable through options
passed to `Lirc` to allow it to be used on those operating systems
as well.

After sending any command to the LIRC daemon, this package will create
a `LircResponse` for us that it returns. That response contains the
command we sent to LIRC, whether it was successful, and any data that
was returned back to us.

Further documentation and a full API specification is available at
https://lirc.readthedocs.org

## License

The [MIT](./LICENSE) License