Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add UFO-R4Z description file #2785

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions docs/devices/UFO-R4Z.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "TuYa UFO-R4Z control via MQTT"
description: "Integrate your TuYa UFO-R4Z via Zigbee2MQTT with whatever smart home infrastructure you are using without the vendor's bridge or gateway."
addedAt:
pageClass: device-page
---

<!-- !!!! -->
<!-- ATTENTION: This file is auto-generated through docgen! -->
<!-- You can only edit the "Notes"-Section between the two comment lines "Notes BEGIN" and "Notes END". -->
<!-- Do not use h1 or h2 heading within "## Notes"-Section. -->
<!-- !!!! -->

# TuYa UFO-R4Z

| | |
| ----------- | ---------------------------------------------------------------------- |
| Model | UFO-R4Z |
| Vendor | [TuYa](/supported-devices/#v=TuYa) |
| Description | Universal smart IR remote control |
| Exposes | switch (state), learned_ir_code, ir_code_to_send, linkquality |
| Picture | ![TuYa UFO-R4Z](https://www.zigbee2mqtt.io/images/devices/UFO-R4Z.png) |

<!-- Notes BEGIN: You can edit here. Add "## Notes" headline if not already present. -->

## Notes

Device can learn IR codes and send already known IR codes.

### Control

By publishing to `zigbee2mqtt/FRIENDLY_NAME/set/ir_code_to_send` various device attributes can control the device:

#### Switch to a learning mode

Request:

```json
{
"learn_ir_code": "ON"
}
```

The command activates the orange light on the device. You have several seconds to take source IR remote, move it closer to the device and press a button. The learned IR code will be exposed as `learned_ir_code`.

#### Send already learned IR code

Request:

```json
{
"ir_code_to_send": "<previously learned IR code>"
}
```

<!-- Notes END: Do not edit below this line -->

## Exposes

### Switch

The current state of this switch is in the published state under the `learn_ir_code` property (value is `ON` or `OFF`).
To control this switch publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/set` with payload `{"learn_ir_code": "ON"}`, `{"learn_ir_code": "OFF"}` or `{"learn_ir_code": "undefined"}`.
It's not possible to read (`/get`) this value.

### Learned ir code (text)

The IR code learned by device.
Value can be found in the published state on the `learned_ir_code` property.
It's not possible to read (`/get`) or write (`/set`) this value.

### Ir code to send (text)

The IR code to send by device.
Value will **not** be published in the state.
It's not possible to read (`/get`) this value.
To write (`/set`) a value publish a message to topic `zigbee2mqtt/FRIENDLY_NAME/set` with payload `{"ir_code_to_send": NEW_VALUE}`.

### Linkquality (numeric)

Link quality (signal strength).
Value can be found in the published state on the `linkquality` property.
It's not possible to read (`/get`) or write (`/set`) this value.
The minimal value is `0` and the maximum value is `255`.
The unit of this value is `lqi`.
Loading