Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hnesland/telldusmq
MQTT broker for reading and transmitting events via Tellstick (telldusd).
https://github.com/hnesland/telldusmq
mqtt telldus tellstick
Last synced: about 1 month ago
JSON representation
MQTT broker for reading and transmitting events via Tellstick (telldusd).
- Host: GitHub
- URL: https://github.com/hnesland/telldusmq
- Owner: hnesland
- License: apache-2.0
- Created: 2016-12-29T10:01:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-27T21:36:51.000Z (over 7 years ago)
- Last Synced: 2024-10-15T18:41:01.765Z (3 months ago)
- Topics: mqtt, telldus, tellstick
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 5
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MQTT Broker for Telldus Core (Tellstick)
Uses libtelldus-core (Tellstick) to transmit events to MQTT. These events can then be used from different home automation / smart home utilities like [Home Assistant](https://home-assistant.io/) and [OpenHAB](http://www.openhab.org/) or your own custom handlers and loggers.
# Installation
The broker is installed with standard [Go](https://golang.org) tools:
```
go get github.com/hnesland/telldusmq
```
The broker depends on telldus-core to communicate with Tellstick.
Other dependencies are handled by Go.
It's currently known to work on Ubuntu 16.04, but should also work on other Linux distributions. The C-based API for Telldus works on Linux, MacOS and Windows. This broker should also work on MacOS, but it is untested. If you're adventurous enough, maybe Windows even works ;-)
# Usage
After installation the broker can be started directly and will look for a configuration file. A sample configuration file is provided in the repository. The broker currently does not accept any parameters.
# Configuration
The broker is configured using a [Viper](https://github.com/spf13/viper) compatible configuration file (JSON, TOML, YAML, HCL or Java properties). Currently the file must be named `telldusmq.` like `telldusmq.json`. We'll look for the configuration file in `/etc/telldusmq/`, `$HOME/.telldusmq/` or the current working directory.
## Receiving Events From Tellstick
The MQTT parameters for topic and payload, can contain template variables (from Go text/template package). The templates are executed on an object containing the event from Tellstick with the following properties:
- Class
- Protocol
- Model
- Code
- House
- Unit
- Group
- Method
- Id
- Temp
- Humidity
- Value
- DataType
We can then use the variables like this: `Temperature for id#{{.Id}} is: {{.Temp}}`
Some sensors supports both temperature and humidity and if you wish to have a separate event for both these types, you can set the configuration item `Tellstick => SplitTemperatureAndHumidity` to `true`. The `Value` property will contain the value (temperature or humidity) and the `DataType` property will contain `temp` or `humidity`. The sample configuration reflects this.
Telldus Core reports device methods as `turnon` or `turnoff` by default. If you wish to map these to other values like `ON` or `OFF`, `1` or `0` etc, this can be configured with setting `Tellstick => MapTurnOnTo` and `Tellstick => MapTurnOffTo` to the appropriate strings.
## Transmitting Events To Tellstick
Telldus-core allows to transmit commands to devices. The broker subscribes to the MQTT-topic defined in `MQTT => Events => SubscribeTopic`. Currently we support two methods for transmitting commands; devices from tellstick.conf and raw commands.
### Tellstick.conf Device
A few methods in telldus-core for transmitting actions are implemented. These are `turnoff`, `turnon`, `learn` and `dim`. The MQTT-payload for these events must be formatted like this:
```json
{"protocol":"telldusdevice", "method":"turnon", "device_id": 145}
```
```json
{"protocol":"telldusdevice", "method":"dim", "device_id": 145, "level": 25}
```
The `method` can be one of the described methods above, and `device_id` must be a device defined in tellstick.conf. Protocol must be `telldusdevice`.
We also listen to the topic defined in `MQTT => Events => SubscribeDeviceEvents`. This topic can either be a specified device id like `tellstick/device/events/13` or a wild card defining all devices `tellstick/device/events/#`. The payload for these events is simply the Tellstick method described above.
### Raw Commands
We don't really support raw commands yet, but we hopefully will very soon. There is some initial support for archtech, but it probably won't work.
The WIP is published anyway. MQTT-payload for these are:
```json
{"protocol":"archtech", "house": 12345, "unit": 9, "method": "turnoff"}
```
```json
{"protocol":"archtech", "house": 12345, "unit": 9, "method": "dim", "level": 25}
```
#### Raw Commands TODO
- Implement archtech properly
- Implement more protocols
- Implement proper protocol-switching
# Reporting Bugs
Please report bugs by raising issues for this project in [Github](https://github.com/hnesland/telldusmq/issues).