[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device `vendor` and `description` #6969

mrskycriper · 2024-01-28T00:28:46Z

Idea

Cleaned up and standartaized all Aqara and Xiaomi devices vendor and description. Added alternative model numbers as whiteLabel. Removed "Doesn't work as a router and doesn't support power meter" from descriptions, will move into Notes section.

Term xiaomi was replaced with a more appropriate lumi everywhere.

New device distribution shown bellow.

`Aqara` devices

Switches

QBKG11LM - Smart wall switch (with neutral, single rocker)
QBKG12LM - Smart wall switch (with neutral, double rocker)
QBKG03LM - Smart wall switch (no neutral, double rocker) - link
QBKG04LM - Smart wall switch (no neutral, single rocker) - link
WXKG02LM - Wireless remote switch (double rocker) - link
WXKG03LM - Wireless remote switch (single rocker) - link
WXKG04LM - Wireless remote switch T1 (double rocker)
WXKG05LM - Wireless remote switch T1 (single rocker)
QBKG18LM - Smart wall switch T1 (no neutral, double rocker)
QBKG19LM - Smart wall switch T1 (with neutral, double rocker)
QBKG20LM - Smart wall switch T1 (with neutral, double rocker)
QBKG34LM - Smart wall switch T1 (with neutral, three rocker)
WXCJKG11LM - Opple wireless switch (single band)
WXCJKG12LM - Opple wireless switch (double band)
WXCJKG13LM - Opple wireless switch (triple band)
ZNCJMB14LM - Smart touch panel S1

H1

WS-EUK01 - Smart wall switch H1 EU (no neutral, single rocker) - link
WS-EUK02 - Smart wall switch H1 EU (no neutral, double rocker) - link
WS-EUK03 - Smart wall switch H1 EU (with neutral, single rocker) - link
WS-EUK04 - Smart wall switch H1 EU (with neutral, double rocker) - link
WXKG14LM - Wireless remote switch H1 (single rocker)
WXKG15LM (WRS-R02) - Wireless remote switch H1 (double rocker) - link
WXKG22LM - Wireless remote switch H1M (double rocker)
QBKG28LM - Smart wall switch H1 Pro (no neutral, double rocker)
QBKG29LM - Smart wall switch H1 (no neutral, triple rocker) - link
QBKG30LM - Smart wall switch H1 Pro (with neutral, single rocker)
QBKG31LM - Smart wall switch H1 Pro (with neutral, double rocker)
QBKG32LM - Smart wall switch H1 Pro (with neutral, triple rocker)
ZNXNKG02LM - Smart rotary knob H1 (wireless)
ZNQBKG24LM - Smart wall switch H1M (with neutral, single rocker)
ZNQBKG25LM - Smart wall switch H1M (with neutral, double rocker)
ZNQBKG26LM - Smart wall switch H1M (with neutral, triple rocker)

D1

WXKG06LM - Wireless remote switch D1 (single rocker)
WXKG07LM - Wireless remote switch D1 (double rocker)
QBKG21LM - Smart wall switch D1 (no neutral, single rocker)
QBKG22LM - Smart wall switch D1 (no neutral, double rocker)
QBKG23LM - Smart wall switch D1 (with neutral, single rocker)
QBKG24LM - Smart wall switch D1 (with neutral, double rocker)
QBKG25LM - Smart wall switch D1 (no neutral, triple rocker)
QBKG26LM - Smart wall switch D1 (with neutral, triple rocker)

E1

WXKG16LM - Wireless remote switch E1 (single rocker)
WXKG17LM - Wireless remote switch E1 (double rocker)
QBKG38LM - Smart wall switch E1 (no neutral, single rocker)
QBKG39LM - Smart wall switch E1 (no neutral, double rocker)
QBKG40LM - Smart wall switch E1 (with neutral, single rocker)
QBKG41LM - Smart wall switch E1 (with neutral, double rocker)
ZNQBKG31LM - Smart wall switch E1 (with neutral, triple rocker)

Z1

ZNQBKG38LM - Smart wall switch Z1 (single rocker)
ZNQBKG39LM - Smart wall switch Z1 (double rocker)
ZNQBKG40LM - Smart wall switch Z1 (triple rocker)
ZNQBKG41LM - Smart wall switch Z1 (quadruple rocker)

US

WS-USC01 - Smart wall switch (no neutral, single rocker), US
WS-USC02 - Smart wall switch (no neutral, double rocker), US
WS-USC03 - Smart wall switch (with neutral, single rocker), US
WS-USC04 - Smart wall switch (with neutral, double rocker), US

Buttons

WXKG11LM - Wireless mini switch - link
WXKG12LM - Wireless mini switch (with gyroscope)
WXKG13LM - Wireless mini switch T1
WXKG20LM - Wireless mini switch E1

Sensors

WSDCGQ11LM - Temperature and humidity sensor - link
WSDCGQ12LM (TH-S02D) - Temperature and Humidity Sensor T1 - link
RTCGQ11LM - Motion sensor - link
RTCGQ12LM - Motion sensor T1
RTCGQ13LM - High precision motion sensor
RTCGQ14LM (MS-S02) - Motion sensor P1 - link
RTCGQ15LM - Motion sensor E1
RTCZCGQ11LM - Presence sensor FP1
SJCGQ11LM - Water leak sensor - link
SJCGQ12LM (WL-S02D) - Water leak sensor T1 - link
SJCGQ13LM - Water leak sensor E1
DJT11LM - Vibration sensor - link
DJT12LM - Vibration sensor T1
MCCGQ11LM - Door and window sensor - link
MCCGQ12LM - Door and window sensor T1
MCCGQ13LM - Door and window sensor P1
MCCGQ14LM - Door and window sensor E1
VOCKQJK11LM (AAQS-S01) - TVOC air quality monitor - link
GZCGQ11LM - Light sensor T1
KQJCMB11LM - Air monitoring panel S1
JY-GZ-01AQ (JY-GZ-03AQ) - Smart smoke detector - link
JT-BZ-01AQ/A (JT-BZ-03AQ/A) - Smart natural gas detector - link

Relays

LLKZMK11LM - Dual relay module - link
LLKZMK12LM (DCM-K01) - Dual relay module T2 - link
SSM-U01 - Single switch module T1 (with neutral) - link
SSM-U02 - Single switch module T1 (no neutral) - link
DLKZMK11LM - Single switch module T1 (with neutral), CN
DLKZMK12LM - Single switch module T1 (no neutral), CN

Plugs

QBCZ11LM - Smart wall outlet
QBCZ14LM - Smart wall outlet T1
QBCZ15LM - Smart wall outlet H1 (USB)
WP-P01D - Smart wall outlet H2 EU - link
ZNCZ11LM - Smart plug
SP-EUC01 - Smart plug EU - link
ZNCZ15LM - Smart plug T1, CN

Lights

ZNLDP12LM - Light bulb - link
ZNLDP13LM (LEDLBT1-L01) - Light bulb T1 - link
LGYCDD01LM (RLS-K01D) - Light strip T1 - link
ZNDDMK11LM - Smart lightstrip driver
ZNXDD01LM - Ceiling light L1-350
XDD11LM - Opple MX960
XDD12LM - Opple MX650
XDD13LM - Opple MX480
JWDL001A - Embedded spot led light
JWSP001A - Jiawen LED Driver & Dimmer
TDL01LM - Spotlight T3
ZNTGMK11LM - Smart RGBW light controller
HLQDQ01LM - Smart LED controller
SSWQD02LM - Smart dimmer controller T1 Pro
SSWQD03LM - Spotlight T2

Curtains

ZNCLDJ11LM - Curtain controller - link
ZNCLDJ12LM - Curtain controller B1
ZNCLDJ14LM - Curtain controller C2
ZNGZDJ11LM (SRSC-M01) - Roller shade controller - link
ZNGZDJ16LM - Roller shade controller T1C
ZNJLBL01LM (RSD-M01) - Roller shade driver E1 - link
ZNCLBL01LM (CM-M01, CM-M01R) - Curtain driver E1 - link

Locks

ZNMS11LM - Smart door lock
ZNMS12LM - Smart door lock S2
ZNMS13LM - Smart door lock S2 Pro

Other

MFKZQ01LM (Xiaomi MFKZQ01LM) - Cube - link
MFCZQ12LM (CTP-R01) - Cube T1 Pro
SRTS-A01 - Smart radiator thermostat E1 - link
ZNCWWSQ01LM (PETC1-M01) - Smart pet feeder C1 - link

`Xiaomi` devices

Switches

Buttons

WXKG01LM (YTC4040GL, YTC4006CN, YTC4017CN, ZHTZ02LM) - Mi wireless switch

Sensors

WSDCGQ01LM (YTC4042GL, YTC4007CN, YTC4018CN) - Mi temperature and humidity sensor
RTCGQ01LM (YTC4041GL, YTC4004CN, YTC4016CN, ZHTZ02LM) - Mi motion sensor
MCCGQ01LM (YTC4039GL, YTC4005CN, YTC4015CN, ZHTZ02LM) - Mi door and window sensor
GZCGQ01LM (YTC4043GL) - Mi light sensor
JTYJ-GD-01LM/BW (YTC4020RT) - Mijia Honeywell smoke detector
JTQJ-BF-01LM/BW (YTC4019RT) - Mijia Honeywell gas leak detector

Plugs

ZNCZ02LM - Mi smart plug
ZNCZ03LM - Mi smart plug TW
ZNCZ04LM - Mi smart plug EU
ZNCZ12LM - Mi smart plug US

Locks

A6121 - Vima Smart Lock

Koenkk · 2024-01-28T13:09:04Z

Could you move them to aqara.ts?

mrskycriper · 2024-01-28T13:10:47Z

I was thinking, maybe rename xiaomi.ts to lumi.ts, would be logical based on the manufacturer.

sjorge · 2024-01-28T14:38:54Z

I was thinking, maybe rename xiaomi.ts to lumi.ts, would be logical based on the manufacturer.

+1 to renaming it to lumi.ts, this has been bothering me a bit lately while working on the TVOC sensor 😅

Koenkk · 2024-01-28T16:42:54Z

Agree!

Otnow · 2024-01-28T18:07:02Z

I would also suggest renaming to lumi:

aqara_opple:

zigbee-herdsman-converters/src/lib/xiaomi.ts

Line 1588 in e4b88b8

aqara_opple: {
aqaraOpple:
https://github.com/Koenkk/zigbee-herdsman/blob/e8387fff9a3e3297511656318a1737e296ca2f03/src/zcl/definition/cluster.ts#L4624

sjorge · 2024-01-28T18:11:06Z

+1 for renaming aqaraOpple to manuSpecificLumi to be inline with other manufacturer specific clusters

mrskycriper · 2024-01-28T18:14:12Z

Sounds like a good idea, I'll rename it to manuSpecificLumi then.

Otnow · 2024-01-28T18:29:23Z

By analogy with xiaomi_basic -> lumi_basic , you can rename aqara_opple to, for example, lumi_specific or lumi_manuSpecific:

zigbee-herdsman-converters/src/lib/xiaomi.ts

Line 1588 in e4b88b8

aqara_opple: {

mrskycriper · 2024-01-28T18:47:06Z

By analogy with xiaomi_basic -> lumi_basic , you can rename aqara_opple to, for example, lumi_specific or lumi_manuSpecific:

Thanks! Totally missed that one. Renamed from aqara_opple to lumi_specific.

I should also probably update OTA repo as well.

Koenkk · 2024-01-28T19:12:45Z

The Aqara devices can be moved to a separate aqara.ts from what I heard these are separate companies (in the early days Xiaomi invested a bit in Aqara but nothing more)

Koenkk · 2024-01-28T19:13:03Z

note to self; after this merge Koenkk/zigbee-herdsman#892

mrskycriper · 2024-01-28T19:16:16Z

The Aqara devices can be moved to a separate aqara.ts from what I heard these are separate companies (in the early days Xiaomi invested a bit in Aqara but nothing more)

Yes, Lumi United is now fully independent from Xiaomi and makes all the Zigbee devices. Nowadays Xiaomi isn't even interested in Zigbee anymore it seems.

Koenkk · 2024-01-28T19:22:38Z

Can you fix the merge conflict?
Once done, is this ready for merge?

mrskycriper · 2024-01-28T19:25:35Z

Can you fix the merge conflict?
Once done, is this ready for merge?

The option is grayed out for me, what is the merge conflict?

Koenkk · 2024-01-28T19:26:24Z

You need to fix it locally by merging the master branch into your branch.

Merge

…an-converters

Conflict

mrskycriper · 2024-01-28T19:53:00Z

Merged this one manually

src/devices/lumi.ts

Otnow · 2024-01-28T23:46:57Z

I think that you can also replace manufacturerCode: 0x115f with manufacturerCode for consistency.

There is also another question: will we replace everything with prefix aqara with lumi in the same way as we did with prefix xiaomi?

mrskycriper · 2024-01-29T12:26:34Z

I think that you can also replace manufacturerCode: 0x115f with manufacturerCode for consistency.

@Otnow What do you mean by that?

There is also another question: will we replace everything with prefix aqara with lumi in the same way as we did with prefix xiaomi?

I'll check them, some of them were definitely Aqara Opple specific.

…on; manufacturer code imports

mrskycriper · 2024-01-29T14:15:53Z

@Otnow found and replaced manufacturerCode: 0x115f with imports.
Updated a lot of aqara_ to lumi_ except for pet feeder (it has aqara in model instead of lumi, so I'm not sure), and aqara_opple related to Opple switches.

Otnow · 2024-01-29T15:58:45Z

@Otnow found and replaced manufacturerCode: 0x115f with imports.

I meant something a little different, on the contrary, to shorten (remove : 0x115f from manufacturerCode: 0x115f, leaving only manufacturerCode) as, for example, here:

zigbee-herdsman-converters/src/devices/xiaomi.ts

Line 45 in 23ecf10

await device.getEndpoint(1).write('genBasic', payload, {manufacturerCode});

Updated a lot of aqara_ to lumi_ except for pet feeder (it has aqara in model instead of lumi, so I'm not sure), and aqara_opple related to Opple switches.

Of course, I would replace all xiaomi and aqara with lumi (and its derivatives), but let @Koenkk tell us what to do in the end.

mrskycriper · 2024-01-29T17:35:32Z

I meant something a little different, on the contrary, to shorten (remove : 0x115f from manufacturerCode: 0x115f, leaving only manufacturerCode) as, for example, here:

@Otnow I see, but explicit variables look better to me. Either way it is better than using a number everywhere.

Of course, I would replace all xiaomi and aqara with lumi (and its derivatives), but let Koenkk tell us what to do in the end.

I'm currently looking into even more consolidation of functions with device model in names. Such as WXKG01LM_click, WXKG02LM_click, WXKG03LM_click and WXKG11LM_click. Would be probably better to make something like lumi_click and filter by device model inside if needed.

Koenkk · 2024-01-29T18:45:01Z

I'm currently looking into even more consolidation of functions with device model in names.

This is nice but I think it's better to do this in a separate PR, then we can merge this one quickly.

mrskycriper · 2024-01-29T18:54:47Z

This is nice but I think it's better to do this in a separate PR, then we can merge this one quickly.

@Koenkk I'm already doing it, but it is a monumental task, so I agree. I'll make a second PR after this and continue working on function refactoring. This one can be merged in a current state.

Koenkk · 2024-01-29T20:04:27Z

Got a merge conflict again, can you get a look? Then I will merge this before doing any other work in lumi.ts

mrskycriper · 2024-01-29T20:05:30Z

Got a merge conflict again, can you get a look? Then I will merge this before doing any other work in lumi.ts

I'm on it already.

merge

mrskycriper · 2024-01-29T20:19:18Z

@Koenkk Probably fine now.

Koenkk · 2024-01-30T19:29:01Z

Thanks!

mrskycriper added 3 commits January 28, 2024 03:15

Refactor all Xiaomi and Aqara device vendor and description

5927f43

Rename Mi plugs

68f2bef

lint

4452585

mrskycriper mentioned this pull request Jan 28, 2024

Move information from device description into notes Koenkk/zigbee2mqtt.io#2520

Merged

mrskycriper added 2 commits January 28, 2024 05:21

More renaming

51576ba

fix

2683837

Replace xiaomi with lumi

5e44f8c

mrskycriper changed the title ~~[Refactoring] Update all Aqara and Xiaomi device vendor and description~~ [Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description Jan 28, 2024

Consistency change

c1674c2

Replace aqaraOpple cluster name with manuSpecificLumi

c1e3a1d

lint

560d2e7

mrskycriper mentioned this pull request Jan 28, 2024

[Refactoring] Replace aqaraOpple cluster name with manuSpecificLumi Koenkk/zigbee-herdsman#892

Merged

rename aqara_opple to lumi_specific

7985e4c

mrskycriper mentioned this pull request Jan 28, 2024

[Refactoring] Rename Xiaomi to Lumi in lookup Koenkk/zigbee-OTA#436

Merged

Merge pull request #3 from Koenkk/master

f9dc821

Merge

mrskycriper added 2 commits January 28, 2024 22:50

Merge branch 'master' of https://github.com/mrskycriper/zigbee-herdsm…

5672800

…an-converters

Merge pull request #4 from mrskycriper/master

1168685

Conflict

mrskycriper commented Jan 28, 2024

View reviewed changes

src/devices/lumi.ts Show resolved Hide resolved

Aqara to lumi generalization; aqara_fp1 to lumi_presence generalizati…

46c45e2

…on; manufacturer code imports

mrskycriper changed the title ~~[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description~~ [Refactoring][Work in progress] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description Jan 29, 2024

mrskycriper changed the title ~~[Refactoring][Work in progress] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description~~ [Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description Jan 29, 2024

Fix merge conflict

1a049c0

mrskycriper added 3 commits January 29, 2024 23:16

Merge

7021b1d

Merge pull request #7 from mrskycriper/master

29d1776

merge

Merge branch 'Koenkk:master' into aqara-xiaomi-docs-cleanup

b606e20

update zh

31a7eb1

Koenkk merged commit a1ddacd into Koenkk:master Jan 30, 2024
2 checks passed

Koenkk mentioned this pull request Jan 30, 2024

chore(master): release 18.25.0 #6980

Merged

mrskycriper deleted the aqara-xiaomi-docs-cleanup branch January 30, 2024 21:05

VivantSenior mentioned this pull request Feb 3, 2024

[Wrong device]: Xiaomi JTQJ-BF-01LM/BW Koenkk/zigbee2mqtt#18597

Closed

alwillha mentioned this pull request Feb 3, 2024

Aqara WXCJKG12LM Error in Logfile after update to Zigbee2MQTT 1.35.2-1 Koenkk/zigbee2mqtt#21199

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device `vendor` and `description` #6969

[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device `vendor` and `description` #6969

mrskycriper commented Jan 28, 2024 •

edited

Loading

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

sjorge commented Jan 28, 2024

Koenkk commented Jan 28, 2024

Otnow commented Jan 28, 2024

sjorge commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Otnow commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Koenkk commented Jan 28, 2024

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Otnow commented Jan 28, 2024

mrskycriper commented Jan 29, 2024

mrskycriper commented Jan 29, 2024 •

edited

Loading

Otnow commented Jan 29, 2024

mrskycriper commented Jan 29, 2024

Koenkk commented Jan 29, 2024

mrskycriper commented Jan 29, 2024

Koenkk commented Jan 29, 2024

mrskycriper commented Jan 29, 2024 •

edited

Loading

mrskycriper commented Jan 29, 2024

Koenkk commented Jan 30, 2024

[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description #6969

[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device vendor and description #6969

Conversation

mrskycriper commented Jan 28, 2024 • edited Loading

Idea

Aqara devices

Switches

H1

D1

E1

Z1

US

Buttons

Sensors

Relays

Plugs

Lights

Curtains

Locks

Other

Xiaomi devices

Switches

Buttons

Sensors

Plugs

Locks

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

sjorge commented Jan 28, 2024

Koenkk commented Jan 28, 2024

Otnow commented Jan 28, 2024

sjorge commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Otnow commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Koenkk commented Jan 28, 2024

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Koenkk commented Jan 28, 2024

mrskycriper commented Jan 28, 2024

Otnow commented Jan 28, 2024

mrskycriper commented Jan 29, 2024

mrskycriper commented Jan 29, 2024 • edited Loading

Otnow commented Jan 29, 2024

mrskycriper commented Jan 29, 2024

Koenkk commented Jan 29, 2024

mrskycriper commented Jan 29, 2024

Koenkk commented Jan 29, 2024

mrskycriper commented Jan 29, 2024 • edited Loading

mrskycriper commented Jan 29, 2024

Koenkk commented Jan 30, 2024

[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device `vendor` and `description` #6969

[Refactoring] Update all Lumi (Aqara and Xiaomi) terminology, device `vendor` and `description` #6969

mrskycriper commented Jan 28, 2024 •

edited

Loading

`Aqara` devices

`Xiaomi` devices

mrskycriper commented Jan 29, 2024 •

edited

Loading

mrskycriper commented Jan 29, 2024 •

edited

Loading