RF Player HomeAssistant Integration

Integration to integrate with GCE RF Player.

This integration will set up the following platforms.

Platforms:

• binary_sensor
• sensor
• light
• climate

Services:

• send command
• simulate event

Installation

HACS

Manually

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
2. If you do not have a custom_components directory (folder) there, you need to create it.
3. In the custom_components directory (folder) create a new folder called rfplayer.
4. Download all the files from the custom_components/rfplayer/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "GCE RFPlayer"

Configuration

This integration supports configuration flow to

• select the RF Player USB device
• configure RF Player options (receiver modes, init commands...)
• configure RF device options
• add RF devices manually

Gateway configuration

For best performance, it's recommended to limit the number of enabled receiver protocols. By default all protocols are enabled.

For additional RF Player tuning, it's possible to execute a set of RF Player commands when the integration is loaded. The configuration is a list of comma-separated commands. The list of available commands is available in the RF PLAYER API documentation. For example, it's possible to fine-tune the sensivity or selectivity of the receiver.

Manual RF device configuration

By default, RF device are added automatically to HomeAssitant upon receipt of RF Player packet matching a known device that has not been already configured. The RF device will be created with the first matching RF device profiles. The automatic creation option can be disabled afterward if you don't want to add new devices anymore.

Automatic device creation is mostly useful for sensors because most actuators are only receivers and cannot send events. In that case, the RF device must be declared manually from the RF Player configuration menu.

Some generic RF devices can match several device profiles (e.g. Blyss devices). If you want to assign a more specific profile, you need to disable automatic device creation, delete the device that was automatically created and re-create it manually with the profile of your choice.

Device replacement

Some RF devices like Oregon sensors will renew their addresses after changing the battery. This integration provides a RF device option named redirect address to redirect events with a new address to the device entities created with the initial address. This is useful to keep the current user configuration of the device (area, labels...) while still being able to receive events with the new device address.

Simulation

It is possible to emulate a RF Player to try the integration without real hardware. When the RF Player integration is added, simply select the simulator device instead of a real USB device.

You can use the simulate event service to try out different JSON events as if they were received on the USB serial line. Read the RF PLAYER API documentation for details about the JSON payload format.

Device profiles

A devic profile defines the mapping between RF Player JSON events / commands and Home Assistant platforms attributes / services. The mapping is described in a YAML file. You can find the latest version of the device profiles here. Platform attributes are extracted from the JSON payload using JSON path expressions.

List of device profiles verification with real devices:

Profile	Event verified	Command verified	Comment
X10 DOMIA Switch	❌	❌
Jamming Detector	❌	❌
X10 CHACON KD101 BLYSS FS20 Switch	❌	❌
X10 CHACON KD101 BLYSS FS20 Lighting	❌	❌
X10 CHACON KD101 BLYSS FS20 On/Off	✅	❌
X10 CHACON KD101 BLYSS FS20 Motion detector	❌	❌
X10 CHACON KD101 BLYSS FS20 Smoke detector	❌	❌
Visionic Sensor/Detector	❌	❌
Visionic Remote	❌	❌
RTS Shutter	✅	❌
RTS Portal	❌	❌
Oregon Temperature Sensor	✅
Oregon Temperature/Humidity Sensor	✅
Oregon Pressure Sensor	❌	❌
Oregon Wind Sensor	❌	❌
Oregon UV Sensor	❌	❌
OWL Power Meter	❌	❌
Oregon Rain Sensor	❌	❌
X2D Thermostat Elec	✅	✅
X2D Thermostat Gas	❌	❌
X2D Detector/Sensor	❌	❌
X2D Shutter	❌	❌
Edisio Temperature Sensor	✅		No humidity sensor support

Future improvements

• Add user-defined device profiles
• Move device configuration (area,...) to new device instead of redirecting events
• Add more platforms siren, events...

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

---