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 documentation for device type option #12279

Merged
merged 12 commits into from
Apr 20, 2020
51 changes: 50 additions & 1 deletion source/_integrations/broadlink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ mac:
description: Device MAC address.
required: true
type: string
type:
description: Device type.
required: false
type: integer
timeout:
description: Timeout in seconds for the connection to the device.
required: false
Expand Down Expand Up @@ -174,6 +178,51 @@ script:
- turn off display
```

### Troubleshooting

Many users are experiencing problems with Broadlink RM Mini 3 0x5f36 and the entire RM4 series.

If you have these devices, you need to follow these steps:
- Remove the device from Broadlink App
- Reset the device
- Add the device to your local network using the app
- Do not set up a cloud (not now, not ever)
- Use [Broadlink Manager](https://sourceforge.net/projects/broadlink-manager/) to get your device type
- Specify the device type in the configuration file

Example 1: Set up 0x5f36 as a remote

```yaml
# Example configuration.yaml entry
remote:
- platform: broadlink
host: IP_ADDRESS
mac: MAC_ADDRESS
type: 0x5f36
```

Example 2: Set up 0x5f36 as switch

```yaml
# Example configuration.yaml entry
switch:
- platform: broadlink
host: IP_ADDRESS
mac: MAC_ADDRESS
type: 'rm_mini3_5f36'
```

Example 3: Set up RM4 as switch

```yaml
# Example configuration.yaml entry
switch:
- platform: broadlink
host: IP_ADDRESS
mac: MAC_ADDRESS
type: 'rm4'
```

## Sensor

The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air. There is currently no support for the cloud API.
Expand Down Expand Up @@ -316,7 +365,7 @@ friendly_name:
required: false
type: string
type:
description: "Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2`, `spminiplus` or `mp1`. `SC1` devices can be registered as `sp2`."
description: "Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `rm_mini3_5f36`, `rm4`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2`, `spminiplus` or `mp1`. `SC1` devices can be registered as `sp2`."
required: true
type: string
switches:
Expand Down