A pure python module to connect to a pilight daemon to send and receive commands.
Project description
# A pure python client to connect to a pilight daemon
[![Build Status](https://travis-ci.org/DavidLP/pilight.svg?branch=master)](https://travis-ci.org/DavidLP/pilight)
[![Coverage Status](https://coveralls.io/repos/github/DavidLP/pilight/badge.svg?branch=master)](https://coveralls.io/github/DavidLP/pilight?branch=master)
This client interfaces with the `pilight-daemon` to send and receive RF codes (https://www.pilight.org/).
Sending and receiving is implemented in an asychronous way. A callback function can be defined
that reacts on received data. Automatic acknowledge if the send data was transmitted by the pilight-daemon
is implemented.
All `pilight-send` commands can be used by this client (https://wiki.pilight.org/doku.php/psend).
The API is mentioned here: https://manual.pilight.org/en/api.
# Installation
The latest release is hosted on PyPi. Thus for installation type:
```
pip install pilight
```
Otherwise download the code and
```
python setup.py install
```
You can run the unit tests to check the installation
```
nosetests pilight
```
# Usage
```
from pilight import pilight
pilight_connection = pilight.Client() # Connect to the pilight-daemon at localhost:5000
pilight_connection.send_code(data={"protocol": [ "kaku_switch" ], # https://manual.pilight.org/en/api
"id": 1,
"unit": 0,
"off": 1
})
```
Also check the examples folder.
[![Build Status](https://travis-ci.org/DavidLP/pilight.svg?branch=master)](https://travis-ci.org/DavidLP/pilight)
[![Coverage Status](https://coveralls.io/repos/github/DavidLP/pilight/badge.svg?branch=master)](https://coveralls.io/github/DavidLP/pilight?branch=master)
This client interfaces with the `pilight-daemon` to send and receive RF codes (https://www.pilight.org/).
Sending and receiving is implemented in an asychronous way. A callback function can be defined
that reacts on received data. Automatic acknowledge if the send data was transmitted by the pilight-daemon
is implemented.
All `pilight-send` commands can be used by this client (https://wiki.pilight.org/doku.php/psend).
The API is mentioned here: https://manual.pilight.org/en/api.
# Installation
The latest release is hosted on PyPi. Thus for installation type:
```
pip install pilight
```
Otherwise download the code and
```
python setup.py install
```
You can run the unit tests to check the installation
```
nosetests pilight
```
# Usage
```
from pilight import pilight
pilight_connection = pilight.Client() # Connect to the pilight-daemon at localhost:5000
pilight_connection.send_code(data={"protocol": [ "kaku_switch" ], # https://manual.pilight.org/en/api
"id": 1,
"unit": 0,
"off": 1
})
```
Also check the examples folder.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pilight-0.1.1.tar.gz
(19.5 kB
view details)
File details
Details for the file pilight-0.1.1.tar.gz
.
File metadata
- Download URL: pilight-0.1.1.tar.gz
- Upload date:
- Size: 19.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a13b6a96439f2d4be632cd76442f45c418df25412b927bf43c997fb865adaa87 |
|
MD5 | bb8b52e379d00e3e1635fe33316d7db2 |
|
BLAKE2b-256 | be24bee3980c42d5f82f1cb86e7661fce1acbc19e506a6327f993e12fb98378a |