-
Notifications
You must be signed in to change notification settings - Fork 0
MQTT Persistence
This service allows you to feed item states to an MQTT broker using the openHAB persistence strategies. The destination broker, topic and messages are configurable.
Note: The service only supports sending information, not retrieving information.
For installation of this persistence package please follow the same steps as you would Bindings.
Additionally, create a persistence file 'mqtt.persist
' in the ${openhab.home}/configuration/persistence
folder.
The file should follow the regular openHAB persistence format.
This persistence service can be configured in the "MQTT Persistence Service" section in openhab.cfg
.
The MQTT persistence can be configured with the following properties:
**Property** | **Description** |
mqtt-persistence:broker | The name of the broker as defined in the mqtt:``.url. See the [MQTTBinding] for more information on how to configure MQTT broker connections. |
mqtt-persistence:topic | The MQTT topic to which the persistence messages should be sent. This string may include parameters, see table below. |
mqtt-persistence:message | A string representing the persistence message content. This string may include parameters, see table below. |
Both the topic and message values are reformatted using String.format at the time of publishing. During this reformat, the following parameters are provided to the format function:
**Parameter** | **Description** |
1$ | Item name. |
2$ | Item alias as defined in the `mqtt.persist` file. |
3$ | Item state. A string representation of the item state. ON/OFF, OPEN/CLOSED and UP/DOWN states are transformed to 1/0 values respectively. |
4$ | Current DateTime in long format. |
All item and timing related configuration is done in the mqtt.persist file using the standard Persistence.
The following is an example configuration that can be used to persist item states with Xively using the csv format. The messages sent to Xively will have the format <openhab_item>, For example: light_office, 1
First, we need to define the MQTT broker connection in the openhab.cfg
file:
mqtt:xively.url=tcp://api.xively.com:1883
mqtt:xively.user=<device key>
mqtt:xively.pwd=<device key>
As <device key>
, use the device/API key you get from Xively.
Next, we need to configure the MQTT persistence service. To do this add the following entries to openhab.cfg
:
mqtt-persistence:broker=xively
mqtt-persistence:topic=/v2/feeds/<feed id>.csv
mqtt-persistence:message=%1$s, %3$s
where <feed id>
is your Xively feed id.
And finally, add a persistence strategy in the mqtt.persist
file:
Strategies {
everyHour : "0 0 * * * ?"
default = everyChange
}
Items {
// persist all items every hour and on every change
* : strategy = everyChange, everyHour
}
With this configuration, all items will persisted whenever their state changes and once per hour.
Installation
Community
- Support
- News Archive
- Presentations
- How to Contribute
- IDE Setup
- How to Implement a Binding
- How to Implement an Action
- Projects using openHAB
- User Interfaces
- Classic UI
- iOS Client
- Android Client
- GreenT UI
- CometVisu
- Automation
- Scripts
- Rules
- Actions
- Bindings
- AlarmDecoder Binding
- Anel Binding
- Asterisk Binding
- Astro Binding
- BenQ Projector Binding
- Bluetooth Binding
- Comfo Air Binding
- Config Admin Binding
- CUL Binding
- CUPS Binding
- DAIKIN Binding
- Davis Binding
- digitalSTROM Binding
- DMX512 Binding
- DSC Alarm Binding
- DSMR Binding
- Ecobee Binding
- EDS OWSever Binding
- eKey Binding
- Energenie Binding
- EnOcean Binding
- Epson Projector Binding
- Exec Binding
- Freebox Binding
- Freeswitch Binding
- Fritz AHA Binding
- Fritz!Box Binding
- FS20 Binding
- Global Cache IR Binding
- GPIO Binding
- HAI/Leviton OmniLink Binding
- HDAnywhere Binding
- Heatmiser Binding
- Homematic / Homegear Binding
- HTTP Binding
- IEC 62056-21 Binding
- IHC / ELKO Binding
- ImperiHome Binding
- Insteon Hub Binding
- Insteon PLM Binding
- IRtrans Binding
- jointSPACE-Binding
- KNX Binding
- Koubachi Binding
- Leviton/HAI Omnilink Binding
- Lg TV Binding
- MAX!Cube-Binding
- MAX! CUL Binding
- MiLight Binding
- MiOS Binding
- Modbus TCP Binding
- MPD Binding
- MQTT Binding
- MQTTitude binding
- Neohub Binding
- Nest Binding
- Netatmo Binding
- Network Health Binding
- Network UPS Tools Binding
- Nibe Heatpump Binding
- Nikobus Binding
- Novelan/Luxtronic Heatpump Binding
- NTP Binding
- One-Wire Binding
- Onkyo AV Receiver Binding
- Open Energy Monitor Binding
- OpenPaths presence detection binding
- OpenSprinkler Binding
- OSGi Configuration Admin Binding
- Philips Hue Binding
- Piface Binding
- pilight Binding
- Pioneer-AVR-Binding
- Plugwise Binding
- PLCBus Binding
- Primare Binding
- Pulseaudio Binding
- RFXCOM Binding
- Samsung AC Binding
- Samsung TV Binding
- Serial Binding
- Satel Alarm Binding
- Snmp Binding
- Somfy URTSI II Binding
- Sonos Binding
- Squeezebox Binding
- Swegon ventilation Binding
- System Info Binding
- TCP/UDP Binding
- Tellstick Binding
- TinkerForge Binding
- Tivo Binding
- VDR Binding
- Velleman-K8055-Binding
- Wake-on-LAN Binding
- Waterkotte EcoTouch Heatpump Binding
- Weather Binding
- Wemo Binding
- Withings Binding
- XBMC Binding
- xPL Binding
- Yamahareceiver Binding
- Zibase Binding
- Z-Wave Binding
- Application Integration
- Asterisk
- Google Calendar
- Linux Media Players
- ROS Robot Operating System
- Telldus Tellstick
- Zoneminder
- Rooted Wink Hub
- Persistence
- db4o Persistence
- rrd4j Persistence
- MySQL Persistence
- MongoDB Persistence
- Sen.Se Persistence
- Cosm Persistence
- Logging Persistence
- Exec Persistence
- MQTT Persistence
- InfluxDB Persistence
- JPA Persistence
- Misc
- Transformations
- REST-API
- Security
- Service Discovery
- Dropbox Bundle
- Voice Control
Samples
- Item definitions
- Sitemap definitions
- Binding configurations
- Comfo Air Binding
- Nest Binding (new)
- Nest Thermostat
- Rollershutter Groups
- Squeezebox
- WAC Binding
- WebSolarLog
- Rules
- Misc. rule examples
- Alarm Clock
- Convert Farenheit to Celcius
- Taking Rules to New Heights
- Reusable Rules via Functions
- Items, Rules and more Examples of a SmartHome
- REST Examples
- Tips and Tricks
- Scripts
- Syntax highlighting for external editors
- Update-Scripts
- Controlling openHAB with Android
- Usecase examples
Release Notes