Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gpongelli/broadlink-listener
Broadlink IR codes listener and SmartIR json generator.
https://github.com/gpongelli/broadlink-listener
broadlink python smartir
Last synced: 3 months ago
JSON representation
Broadlink IR codes listener and SmartIR json generator.
- Host: GitHub
- URL: https://github.com/gpongelli/broadlink-listener
- Owner: gpongelli
- License: mit
- Created: 2022-12-04T17:33:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-24T16:26:57.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T04:18:15.021Z (4 months ago)
- Topics: broadlink, python, smartir
- Language: Python
- Homepage:
- Size: 802 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSES/MIT.txt
Awesome Lists containing this project
README
# Broadlink Listener
[](https://pypi.org/project/broadlink-listener/)
[](https://pypi.org/project/broadlink-listener/)
[](https://github.com/gpongelli/broadlink-listener/actions/workflows/dev.yml)
[](https://codecov.io/github/gpongelli/broadlink-listener)
Broadlink IR codes listener and SmartIR json generator.
This project will install a `broadlink-listener` command line tool that can be used to generate a climate [SmartIR](https://github.com/smartHomeHub/SmartIR)
compatible json, starting from an initial structure that defines climate behavior, putting Broadlink IR remote to
listening state, until all IR code combination will being scan.
* Documentation:
* GitHub:
* PyPI:
* Free software: MIT
## Features
* Discover Broadlink IR remote
* Starting from SmartIR json structure like
```json
{
"supportedController": "Broadlink",
"minTemperature": 16,
"maxTemperature": 31,
"precision": 1,
"operationModes": [
"op_a",
"op_b"
],
"fanModes": [
"fan_a",
"fan_b"
],
"swingModes": [
"swing_a",
"swing_b"
]
}
```
it helps you listen all the defined IR codes to create a json like
```json
{
"supportedController": "Broadlink",
"minTemperature": 16,
"maxTemperature": 31,
"precision": 1,
"operationModes": [
"op_a",
"op_b"
],
"fanModes": [
"fan_a",
"fan_b"
],
"swingModes": [
"swing_a",
"swing_b"
],
"commands": {
"off": "...",
"op_a": {
"fan_a": {
"swing_a": {
"16": "....",
"31": "...."
},
"swing_b": {
"16": "....",
"31": "...."
}
},
"fan_b": {
"swing_a": {
"16": "....",
"31": "...."
},
"swing_b": {
"16": "....",
"31": "...."
}
}
},
"op_b": {
"fan_a": {
"swing_a": {
"16": "....",
"31": "...."
},
"swing_b": {
"16": "....",
"31": "...."
}
},
"fan_b": {
"swing_a": {
"16": "....",
"31": "...."
},
"swing_b": {
"16": "....",
"31": "...."
}
}
}
}
}
```
* Mandatory fields into starting json
* `supportedController`, `minTemperature`, `maxTemperature`, `precision`
* Optional fields (at least one must be present or nothing will be listened):
* `operationModes`, `fanModes`,`swingModes`
* Generated file can be used into SmartIR HomeAssistant component
* It's possible to interrupt with CTRL-C at any moment, a temporary file will be saved
* Temporary files are also saved at the end of each temperature range
* In case of existing temporary file, the already learnt combination will be skipped
## Example
Example of cli command:
```bash
$ broadlink-listener generate-smart-ir ./real_data/1124.json -n dry -n fan_only -s eco_cool
```
`real_data/1124.json` file is [this one from SmartIR GitHub repo](https://github.com/smartHomeHub/SmartIR/blob/master/codes/climate/1124.json)
in which I've added the missing "swingModes" array, supported by climate but not present on json:
```json
"swingModes": [
"auto",
"high",
"mid_high",
"middle",
"mid_low",
"low",
"swing"
],
```
``, ``, `` parameter can be obtained running:
```bash
$ broadlink-listener discover_ir
```
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter)
and the [gpongelli/cookiecutter-pypackage](https://github.com/gpongelli/cookiecutter-pypackage) project template.