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.

Sign up for GitHub

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

Jump to bottom

Fixes for Busch-Jaeger devices #5299

Merged
merged 5 commits into from
Jan 23, 2023
Merged

Fixes for Busch-Jaeger devices #5299

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a08431
Report BJ switches as lights and use proper endpoint definition
klada Jan 3, 2023
8c0978c
Don't expose state for all Busch-Jaeger devices
klada Jan 8, 2023
b1d257d
Do not drop scenes cluster from Busch-Jaeger RB01
klada Jan 8, 2023
474b6ab
Keep Busch-Jaeger lights exposed as switch as well for compat reasons
klada Jan 22, 2023
ec9f361
Update busch-jaeger.js
Koenkk Jan 23, 2023
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
100 changes: 65 additions & 35 deletions devices/busch-jaeger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ module.exports = [
extend: extend.switch(),
},
{
// Busch-Jaeger 6735, 6736, and 6737 have been tested with the 6710 U (Power Adapter) and
// 6711 U (Relay) back-ends. The dimmer has not been verified to work yet, though it's
// safe to assume that it can at least been turned on or off with this integration.
// Busch-Jaeger 6735, 6736 and 6737 have been tested with the 6710 U (Power Adapter),
// 6711 U (Relay) and 6715 U (dimmer) back-ends. Unfortunately both the relay and the dimmer
// report as model 'RM01' with genLevelCtrl clusters, so we need to set up both of them
// as dimmable lights.
//
// The battery-powered version of the device ('RB01') is supported as well. These devices are
// sold as Busch-Jaeger 6735/01, 6736/01 and 6737/01.
//
// In order to manually capture scenes as described in the devices manual, the endpoint
// corresponding to the row needs to be unbound (https://www.zigbee2mqtt.io/information/binding.html)
Expand All @@ -26,59 +30,85 @@ module.exports = [
zigbeeModel: ['RM01', 'RB01'],
model: '6735/6736/6737',
vendor: 'Busch-Jaeger',
description: 'Zigbee Light Link power supply/relay/dimmer',
description: 'Zigbee Light Link power supply/relay/dimmer/wall-switch',
endpoint: (device) => {
return {'row_1': 0x0a, 'row_2': 0x0b, 'row_3': 0x0c, 'row_4': 0x0d, 'relay': 0x12};
},
exposes: [e.switch(), e.action(['row_1_on', 'row_1_off', 'row_1_up', 'row_1_down', 'row_1_stop',
'row_2_on', 'row_2_off', 'row_2_up', 'row_2_down', 'row_2_stop',
'row_3_on', 'row_3_off', 'row_3_up', 'row_3_down', 'row_3_stop',
'row_4_on', 'row_4_off', 'row_4_up', 'row_4_down', 'row_4_stop'])],
exposes: (device, options) => {
const expose = [];

// If endpoint 0x12 (18) is present this means the following two things:
// 1. The device is connected to a relay or dimmer and needs to be exposed as a dimmable light
// 2. The top rocker will not be usable (not emit any events) as it's hardwired to the relay/dimmer
if (!device || device.getEndpoint(0x12) != null) {
expose.push(e.light_brightness().withEndpoint('relay'));
// Exposing the device as a switch without endpoint is actually wrong, but this is the historic
// definition and we are keeping it for compatibility reasons.
// DEPRECATED and should be removed in the future
expose.push(e.switch());
}
// Not all devices support all actions (depends on number of rocker rows and if relay/dimmer is installed),
// but defining all possible actions here won't do any harm.
expose.push(e.action([
'row_1_on', 'row_1_off', 'row_1_up', 'row_1_down', 'row_1_stop',
'row_2_on', 'row_2_off', 'row_2_up', 'row_2_down', 'row_2_stop',
'row_3_on', 'row_3_off', 'row_3_up', 'row_3_down', 'row_3_stop',
'row_4_on', 'row_4_off', 'row_4_up', 'row_4_down', 'row_4_stop',
]));
expose.push(e.linkquality());

return expose;
},
meta: {multiEndpoint: true},
configure: async (device, coordinatorEndpoint, logger) => {
const endpoint10 = device.getEndpoint(0x0a);
if (endpoint10 != null) {
// The total number of bindings seems to be severely limited with these devices.
// In order to be able to toggle groups, we need to remove the scenes cluster

await reporting.bind(endpoint10, coordinatorEndpoint, ['genLevelCtrl']);
// Depending on the actual devices - 6735, 6736, or 6737 - there are 1, 2, or 4 endpoints for
// the rockers. If the module is installed on a dimmer or relay, there is an additional endpoint (18).
const endpoint18 = device.getEndpoint(0x12);
if (endpoint18 != null) {
await reporting.bind(endpoint18, coordinatorEndpoint, ['genOnOff', 'genLevelCtrl']);
} else {
// We only need to bind endpoint 10 (top rocker) if endoint 18 (relay/dimmer) is not present.
// Otherwise the top rocker is hard-wired to the relay/dimmer and cannot be used anyways.
const endpoint10 = device.getEndpoint(0x0a);
if (endpoint10 != null) {
await reporting.bind(endpoint10, coordinatorEndpoint, ['genLevelCtrl']);
}
}
// Depending on the actual devices - 6735, 6736, or 6737 - there are 1, 2, or 4 endpoints.
// Thef 1st endpoint ist most bound to hardware switch

// The total number of bindings seems to be severely limited with some of these devices.
// In order to be able to toggle groups, we need to remove the scenes cluster from RM01.
const dropScenesCluster = device.modelID == 'RM01';

const endpoint11 = device.getEndpoint(0x0b);
if (endpoint11 != null) {
// The total number of bindings seems to be severely limited with these devices.
// In order to be able to toggle groups, we need to remove the scenes cluster
const index = endpoint11.outputClusters.indexOf(5);
if (index > -1) {
endpoint11.outputClusters.splice(index, 1);
if (dropScenesCluster) {
const index = endpoint11.outputClusters.indexOf(5);
if (index > -1) {
endpoint11.outputClusters.splice(index, 1);
}
}
await reporting.bind(endpoint11, coordinatorEndpoint, ['genLevelCtrl']);
}
const endpoint12 = device.getEndpoint(0x0c);
if (endpoint12 != null) {
// The total number of bindings seems to be severely limited with these devices.
// In order to be able to toggle groups, we need to remove the scenes cluster
const index = endpoint12.outputClusters.indexOf(5);
if (index > -1) {
endpoint12.outputClusters.splice(index, 1);
if (dropScenesCluster) {
const index = endpoint12.outputClusters.indexOf(5);
if (index > -1) {
endpoint12.outputClusters.splice(index, 1);
}
}
await reporting.bind(endpoint12, coordinatorEndpoint, ['genLevelCtrl']);
}
const endpoint13 = device.getEndpoint(0x0d);
if (endpoint13 != null) {
// The total number of bindings seems to be severely limited with these devices.
// In order to be able to toggle groups, we need to remove the scenes cluster
const index = endpoint13.outputClusters.indexOf(5);
if (index > -1) {
endpoint13.outputClusters.splice(index, 1);
if (dropScenesCluster) {
const index = endpoint13.outputClusters.indexOf(5);
if (index > -1) {
endpoint13.outputClusters.splice(index, 1);
}
}
await reporting.bind(endpoint13, coordinatorEndpoint, ['genLevelCtrl']);
}
const endpoint18 = device.getEndpoint(0x12);
if (endpoint18 != null) {
await reporting.bind(endpoint18, coordinatorEndpoint, ['genOnOff', 'genLevelCtrl']);
}
},
fromZigbee: [fz.ignore_basic_report, fz.on_off, fz.brightness, fz.legacy.RM01_on_click, fz.legacy.RM01_off_click,
fz.legacy.RM01_up_hold, fz.legacy.RM01_down_hold, fz.legacy.RM01_stop],
Expand Down