RFXCOM Binding

Documentation of the RFXCOM binding Bundle

Introduction

Binding should be compatible at least with RFXtrx433 USB 433.92MHz transceiver, which contains both receiver and transmitter functions.

Supports RF 433 Mhz protocols like: HomeEasy, Cresta, X10, La Crosse, OWL, CoCo (KlikAanKlikUit), Oregon e.o.
See further information from http://www.rfxcom.com

RFXCOM binding support currently TemperatureHumidity, Lighting1, Lighting2 ,Curtain1 & Thermostat1 packet types.

For installation of the binding, please see Wiki page Bindings.

Binding Configuration

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.

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 none required protocols are disabled. You can use the RFXmngr application to configure the controller and get the valid configuration command. Command must be a 28 characters (14 bytes) hexadecimal string.

Item Binding Configuration

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"

where DeviceID is a valid wireless device identifier.

• Lighting1 format: SensorId.UnitCode e.g. B.1, B.2 or B.G for group functions

• Lighting2 format: SensorId.UnitCode e.g. 636602.1

• Curtain1 format: SensorId.UnitCode e.g. P.1 see RFXCOM documentation

• TemperatureHumidity format: SensorId e.g. 2561

Examples, how to configure your items:

Number OutdoorTemperature { rfxcom="<2561:Temperature" }
Number OutdoorHumidity { rfxcom="<2561:Humidity" }
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" }

SECURITY1.X10_SECURITY_MOTION packet example
Switch swMotion { rfxcom="<4541155:Motion" }
Number MSensor_Bat {rfxcom="<4541155:BatteryLevel" }

THERMOSTAT1 packet example
Number RFXTemp_Living { rfxcom=<30515:Temperature" 
Number RFXTemp_LivingSP { rfxcom="<30515:SetPoint" }
Contact RFXTemp_LivingRoom_Stat { rfxcom="<30515:Contact" }     	

PacketType.SubType specify packet and sub type information ...

PacketType.SubType	Description	ValueSelector
LIGHTING1.X10	working	Command
LIGHTING1.ARC	tested and working	Command
LIGHTING1.AB400D	Untested
LIGHTING1.WAVEMAN	Untested
LIGHTING1.EMW200	Untested
LIGHTING1.IMPULS	Untested
LIGHTING1.RISINGSUN	Untested
LIGHTING1.PHILIPS	Untested
LIGHTING2.AC	tested and working	Command, DimmingLevel
LIGHTING2.HOME_EASY_EU	Untested
LIGHTING2.ANSLUT	Untested
CURTAIN1.HARRISON	Harrison curtain rail, e.g. Neta 12	Shutter
TEMPERATURE.La Crosse TX17	tested and working
TEMPERATUREHUMIDITY.Oregon 2.1 THGN122_123_132_THGR122_228_238_268	tested and working
TEMPERATUREHUMIDITY.THGN800_THGR810	tested and working
TEMPERATUREHUMIDITY.RTGR328	Untested
TEMPERATUREHUMIDITY.THGR328	Untested
TEMPERATUREHUMIDITY.WTGR800	Untested
TEMPERATUREHUMIDITY. THGR918_THGRN228_THGN50	Untested
TEMPERATUREHUMIDITY.TFA_TS34C__CRESTA	Untested
TEMPERATUREHUMIDITY. WT260_WT260H_WT440H_WT450_WT450H	Untested
TEMPERATUREHUMIDITY.VIKING_02035_02038	Untested
SECURITY1.X10_SECURITY_MOTION	tested and working	Motion
THERMOSTAT1	Digimax 210 working	Temperature, SetPoint, Contact

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