-
Notifications
You must be signed in to change notification settings - Fork 0
RFXCOM Binding
The RFXtrx433 device is a very versatile transceiver that can send and receive information to and from a wide number of compatible devices from different brands and manufacturers.
Supports RF 433 Mhz protocols like: HomeEasy, Cresta, X10, La Crosse, OWL, CoCo (KlikAanKlikUit), PT2262, Oregon e.o.
Suitable for receiving this example 433.92MHz sensors
- Cent-a-meter, Electrisave, OWL ampere and power meters, Alecto, Cresta, Fine Offset, Hideki, LaCrosse, Oregon, Rubicson, TFA, Viking weather sensors,
- Avidsen, Chacon, NEXA, Flamingo, Blyss, Proove smoke detectors,
- Atlantic Meiantech, Visonic, X10 alarm sensors,
- Oregon scales,
- Maverick BBQ Rubicson sensors
- Chacon, Home Easy, COCO, NEXA, X10 remote controls.
And suitable for controlling eg 433.92MHz these devices:
- ANSLUT, BBSB, Blyss, Brennestuhl, Chacon, COCO, DI.O, ELRO, Energenie, Eurodomest, HomeEasy, Pulse, Inter Techno, K ambrook, COCO, LightwaveRF, Livolo, Mercury, NEXA, Phenix, Proove, risingsun, Sartano, Siemens , X10, XDOM dimmers / switches,
- Byron SX, Select Plus doorbell,
- A-OK, Bofu, Ematronic, Hasta, RAEX, Rohrmotor24, Roller Trol, Somfy, Yooda shutter / awning motors,
- Harrison, Forest curtain motors,
- Kingpin, Media Mount, Proluxx projection,
- Avidsen, Chacon, NEXA, Flamingo, Blyss, Proove smoke alarms with siren,
- Mertik Maxitrol fireplace,
- Aoke relay,
- TRC02 RGB, MDREMOTE LED strip controller,
- Smartwares radiator valve.
See RFXtrx User Guide for the complete list of supported sensors and devices http://www.rfxcom.com and firmware update announcements.
Whilst the range of supported devices is impressive, not all of them are compatible with the binding for openHAB yet
The binding should be compatible at least with RFXtrx433 USB 433.92MHz transceiver, which contains both receiver and transmitter functions.
Blinds1, Control, Current, Curtain1, Energy, Humidity, Interface, Lighting1, Lighting2, Lighting4, Lighting5, Lighting6, Factory, Interface, Rain, Rfy, Security1, TemperatureHumidity, Temperature, Thermostat1, Transmitter, Wind packet types.
For installation of the binding, please see Wiki page Bindings.
First of all you need to configure the following values in the openhab.cfg file (in the folder '${openhab_home}/configurations').
############## RFXCOM Binding ###################
# Serial port of RFXCOM interface
# Valid values are e.g. COM1 for Windows and /dev/ttyS0 or /dev/ttyUSB0 for Linux
rfxcom:serialPort=
# Set mode command for controller (optional)
# E.g. rfxcom:setMode=0D000000035300000C2F00000000
# rfxcom:setMode=
The rfxcom:serialPort
value is the identification of the serial port on the host system where RFXCOM controller is connected, e.g. COM1
on Windows,/dev/ttyS0
on Linux or /dev/tty.PL2303-0000103D
on Mac.
NOTE: On Linux, should the RFXCOM device be added to the dialout
group, you may get an error stating the the serial port cannot be opened when the RfxCom plugin tries to load. You can get around this by adding the openhab
user to the dialout
group like this: usermod -a -G dialout openhab
.
Also on Linux you may have issues with the USB if using two serial USB devices e.g. RFXcom and ZWave. See the wiki page for more on symlinking the USB ports symlinks
The rfxcom:setMode
value is optional. Set mode command can be used to configure RFXCOM controller to listening to various receiver protocols. This is very useful because the receiver will become more sensitive when only the required protocols are enabled.
You can use the RFXmngr application found in the Downloads section of the RFXcom website (windows is required) to get the valid configuration command. Command must be a 28 characters (14 bytes) hexadecimal string. You can also use RFXmngr to get the Device Ids needed to bind each item to openHAB.
In order to bind an item to RFXCOM device, you need to provide configuration settings. The easiest way to do so is to add some binding information in your item file (in the folder configurations/items). The syntax of the binding configuration strings accepted is the following:
in: rfxcom="<DeviceId:ValueSelector"
out: rfxcom=">DeviceId:PacketType.SubType:ValueSelector"
A common mistake when setting up this binding, is to use the wrong format for the DeviceID.
DeviceID is a valid wireless device identifier number in decimal format.
RFXmngr and the openHAB logback outputs may display something like this example from a HomeEasy wireless wall switch.
Packet Length = 0B
Packettype = Lighting2
Subtype = AC
Id = 00130FE2
Unitcode = 11
Command = Off
Dim level = 0%
You wouldn't be forgiven for thinking the id is 00130FE2 but this is not the Id you need.
This is the correct Id but it is in the wrong Hexadecimal format. You need to convert to Decimal, a Google search for HEX to DEC
will provide many online tools to do this binaryhexconverter.com is one. You simply put the HEX 00130FE2
in the correct field and press convert.
Use the converted Decimal number (easy to identify as it won't contain any letters) as the DeviceID.
So continuing with the above example. The displayed Id in HEX was 00130FE2
this is converted into DEC 1249250
. Also for this packettype (Lighting2) you need to join the Unitcode 11
to the DeviceId, so final the binding for the item is:
Switch Wall_Switch_FF_Office {rfxcom="<1249250.11:Command"}
If you want to add cheap 433 MHz devices like PT2622 remotes, contacts, sensors or wireless outlets and don't know the correct values, you can start OpenHAB in debug mode, press the buttons on the original remote or act on the sensor.
To pair the entry-level wireless remote outlets (Elro, Intertechno, Intertek, Pollin, ...) you can do the following:
- Enable Lighting4 protocol using the RFXMgr or
setMode
- Run OpenHAB in debug mode
- Press a button on the original remote controller (here I press
A ON
) and read the DeviceIdId
and the pulse widthPulse
from the output:
21:35:20.096 [DEBUG] [.b.r.internal.RFXComConnection:148 ] - Data received:
- Packet type = LIGHTING4
- Id = 1285
- Command = ON
- Pulse = 318
You can use these values to configure the binding to receive and send data.
Alternately add the following to your logback.xml
file to only see the RFXcom logs.
<logger name="org.openhab.binding.rfxcom" level="DEBUG" />
Packet | Format | Examples |
---|---|---|
Lighting1 | SensorId.UnitCode |
B.1 or B.2 or B.0 1 |
Lighting2 | SensorId.UnitCode |
636602.1 or 636602.0 1 |
Lighting4 | SensorId |
1285 |
Lighting5 | SensorId.UnitCode |
636602.1 |
Lighting6 | SensorId.GroupCode.UnitCode |
257.B.1 or 64343.B.2 or 636602.H.5 |
Curtain1 | SensorId.UnitCode |
P.1 2 |
TemperatureHumidity, Current, Energy etc | SensorId.UnitCode |
2561 |
1 Where "0" would control all items on device, 2 See the RFXcom documents/manual for more information
Weather Station
Number OutdoorTemperature { rfxcom="<2561:Temperature" }
Number OutdoorHumidity { rfxcom="<2561:Humidity" }
Number RainRate { rfxcom="<30464:RainRate" }
Number WindSpeed { rfxcom="<19968:WindSpeed" }
Switches
Switch Btn1 { rfxcom="<636602.1:Command" }
Number Btn1SignalLevel { rfxcom="<636602.1:SignalLevel" }
Dimmer Btn1DimLevel { rfxcom="<636602.1:DimmingLevel" }
String Btn2RawData { rfxcom="<636602.2:RawData" }
Switch ChristmasTreeLights { rfxcom">636602.1:LIGHTING2.AC:Command" }
Rollershutter CurtainDownstairs { rfxcom=">P.1:CURTAIN1.HARRISON:Shutter" }
Rollershutter ShutterBedroom { rfxcom=">1.0.0.1:RFY.RFY:Shutter" }
SECURITY1.X10_SECURITY_MOTION
Switch swMotion { rfxcom="<4541155:Motion" }
Number MSensor_Bat { rfxcom="<4541155:BatteryLevel" }
LIGHTING4.PT2262
Switch swWallController { rfxcom="<1285:Command" } // receive wireless wall switch
Switch pCoffeeMachine { rfxcom=">1285.315:LIGHTING4.PT2262:Command" } // control wireless outlet
THERMOSTAT1
Number RFXTemp_Living { rfxcom="<30515:Temperature" }
Number RFXTemp_LivingSP { rfxcom="<30515:SetPoint" }
Contact RFXTemp_LivingRoom_Stat { rfxcom="<30515:Contact" }
LIGHTWAVERF
Switch Light1 { rfxcom=">3155730.3:LIGHTING5.LIGHTWAVERF:Command"}
Dimmer Light2 "Light2 [%d %%]" { rfxcom=">3155730.4:LIGHTING5.LIGHTWAVERF:DimmingLevel" }
LIGHTWAVERF Mood Switch
Number Button_MoodSwitch { rfxcom="<15942554.16:Mood" }
OWL CM160 Energy Monitor
Number Owl_InstantAmps { rfxcom="<63689:InstantAmps"}
Number Owl_TotalAmpHours { rfxcom="<63689:TotalAmpHours" }
OWL CM113 Energy Monitor
Number Owl_Amps { rfxcom="<35072:Channel2Amps" }
PacketType.SubType | Description | ValueSelector |
LIGHTING1.X10 | working | Command |
LIGHTING1.ARC | working | Command |
LIGHTING1.AB400D | Untested | |
LIGHTING1.WAVEMAN | Untested | |
LIGHTING1.EMW200 | Untested | |
LIGHTING1.IMPULS | working | Command |
LIGHTING1.RISINGSUN | Untested | |
LIGHTING1.PHILIPS | Untested | |
LIGHTING1.ENERGENIE | working | Command |
LIGHTING2.AC | working | Command, DimmingLevel |
LIGHTING2.HOME_EASY_EU | working | Command,DimmingLevel |
LIGHTING2.ANSLUT | Untested | |
LIGHTING4.PT2262 | working | Command |
LIGHTING5.LIGHTWAVERF | working | Command, DimmingLevel |
LIGHTING6.BLYSS | working | Command |
CURTAIN1.HARRISON | Harrison curtain rail, e.g. Neta 12 | Shutter |
TEMPERATURE.La Crosse TX17 | working | |
TEMPERATUREHUMIDITY.Oregon 2.1 THGN122_123_132_THGR122_228_238_268 |
working | |
TEMPERATUREHUMIDITY.THGN800_THGR810 | working | |
TEMPERATUREHUMIDITY.RTGR328 | Untested | |
TEMPERATUREHUMIDITY.THGR328 | Untested | |
TEMPERATUREHUMIDITY.WTGR800 | Untested | |
TEMPERATUREHUMIDITY. THGR918_THGRN228_THGN50 |
Untested | |
TEMPERATUREHUMIDITY.TFA_TS34C__CRESTA | Working | Temperature, Humidity, HumidityStatus, BatteryLevel, SignalLevel |
TEMPERATUREHUMIDITY. WT260_WT260H_WT440H_WT450_WT450H |
Untested | |
TEMPERATUREHUMIDITY.VIKING_02035_02038 | Untested | |
SECURITY1.X10_SECURITY_MOTION | working | Motion |
THERMOSTAT1 | Digimax 210 working | Temperature, SetPoint, Contact |
ENERGY.ELEC1 | Owl CM113 Working | Channel1Amps, Channel2Amps, Channel3Amps |
ENERGY.ELEC2 | Owl CM160 Working | InstantAmps, TotalAmpHours |
RFY.RFY | Working |
ValueSelector
specify ...
Value selector | Valid OpenHAB data type | Information |
RawData | StringItem | |
Command | SwitchItem | ON, OFF, GROUP_ON, GROUP_OFF |
SignalLevel | NumberItem | |
DimmingLevel | DimmerItem | UP, DOWN, PERCENTAGE |
Temperature | NumberItem | |
Humidity | NumberItem | |
HumidityStatus | StringItem | |
BatteryLevel | NumberItem | |
Shutter | RollershutterItem | OPEN, CLOSE, STOP |
Motion | SwitchItem | MOTION, NO_MOTION |
Voltage | NumberItem | |
SetPoint | NumberItem | |
Pressure | NumberItem | |
Forecast | NumberItem | |
RainRate | NumberItem | |
RainTotal | NumberItem | |
WindDirection | NumberItem | |
WindSpeed | NumberItem | |
Gust | NumberItem | |
ChillFactor | NumberItem | |
InstantPower | NumberItem | |
TotalUsage | NumberItem | |
Voltage | NumberItem | |
InstantAmps | NumberItem | |
TotalAmpHours | NumberItem | |
Channel1Amps | NumberItem | |
Channel2Amps | NumberItem | |
Channel3Amps | NumberItem | |
Status | StringItem | |
Mood | NumberItem | |
Contact | ContactItem |
###Linux / OS X
###Windows
- Cosm Persistence
- db4o Persistence
- Exec Persistence
- InfluxDB Persistence
- JDBC Persistence
- JPA Persistence
- Logging Persistence
- mapdb Persistence
- MongoDB Persistence
- MQTT Persistence
- my.openHAB Persistence
- MySQL Persistence
- rrd4j Persistence
- Sen.Se Persistence
- SiteWhere Persistence
- AlarmDecoder Binding
- Anel Binding
- Arduino SmartHome Souliss Binding
- Asterisk Binding
- Astro Binding
- Autelis Pool Control Binding
- BenQ Projector Binding
- Bluetooth Binding
- Bticino Binding
- CalDAV Binding
- Comfo Air Binding
- Config Admin Binding
- CUL Binding
- CUL Intertechno Binding
- CUPS Binding
- DAIKIN Binding
- Davis Binding
- Denon Binding
- digitalSTROM Binding
- DMX512 Binding
- DSC Alarm Binding
- DSMR Binding
- eBUS Binding
- Ecobee Binding
- EDS OWSever Binding
- eKey Binding
- Energenie Binding
- EnOcean Binding
- Enphase Energy Binding
- Epson Projector Binding
- Exec Binding
- Freebox Binding
- Freeswitch Binding
- Frontier Silicon Radio 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
- IPX800 Binding
- IRtrans Binding
- jointSPACE-Binding
- KNX Binding
- Koubachi Binding
- LCN Binding
- LightwaveRF Binding
- Leviton/HAI Omnilink Binding
- Lg TV Binding
- Logitech Harmony Hub
- MailControl 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
- Panasonic TV Bindung
- panStamp Binding
- Philips Hue Binding
- Piface Binding
- pilight Binding
- Pioneer-AVR-Binding
- Plex Binding
- Plugwise Binding
- PLCBus Binding
- Primare Binding
- Pulseaudio Binding
- RFXCOM Binding
- RWE Smarthome Binding
- Sager WeatherCaster Binding
- Samsung AC Binding
- Samsung TV Binding
- Serial Binding
- Sallegra Binding
- Satel Alarm Binding
- Sinthesi Sapp Binding
- Snmp Binding
- Somfy URTSI II Binding
- Sonos Binding
- Squeezebox Binding
- Swegon ventilation Binding
- System Info Binding
- TA CMI Binding
- TCP/UDP Binding
- Tellstick Binding
- TinkerForge Binding
- Tivo Binding
- VDR Binding
- Velleman-K8055-Binding
- Wago 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
- Asterisk
- Google Calendar
- Linux Media Players
- ROS Robot Operating System
- Telldus Tellstick
- Zoneminder
- Wink Hub (rooted)
- Wink Monitoring
- Transformations
- XSLT
- JSON
- REST-API
- Security
- Service Discovery
- Voice Control
- BritishGasHive-Using-Ruby
- Dropbox Bundle
A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.
Please update the wiki if you do come across any out of date information.
- Comfo Air Binding
- Ecobee Examples
- Nest Examples
- Rollershutter Bindings
- Squeezebox
- WAC Binding
- WebSolarLog
- Alarm Clock
- Convert Farenheit to Celcius
- The mother of all lighting rules
- Reusable Rules via Functions
- Combining different Items
- Items, Rules and more Examples of a SmartHome
- Google Map
- Controlling openHAB with Android
- Usecase examples
- B-Control Manager
- Spell checking for foreign languages
- Flic via Tasker
- Chromecast via castnow