Skip to content

Commit 06d1c0a

Browse files
oblitumoblitum
committed
Add support for chuangmi.remote.h102a03 and v2
Fixes rytilahti#495, rytilahti#619, rytilahti#811 Closes rytilahti#501 Partially covers rytilahti#1020
1 parent 3053562 commit 06d1c0a

File tree

5 files changed

+300
-15
lines changed

5 files changed

+300
-15
lines changed

‎miio/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
from miio.aqaracamera import AqaraCamera
2828
from miio.ceil import Ceil
2929
from miio.chuangmi_camera import ChuangmiCamera
30-
from miio.chuangmi_ir import ChuangmiIr
30+
from miio.chuangmi_ir import ChuangmiIr, ChuangmiRemote, ChuangmiRemoteV2
3131
from miio.chuangmi_plug import ChuangmiPlug, Plug, PlugV1, PlugV3
3232
from miio.cooker import Cooker
3333
from miio.curtain_youpin import CurtainMiot

‎miio/chuangmi_ir.py

+97-11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
from typing import Tuple, List
2+
13
import base64
24
import re
35

@@ -17,6 +19,10 @@
1719
len_,
1820
this,
1921
)
22+
try:
23+
import heatshrink
24+
except:
25+
heatshrink = None
2026

2127
from .click_common import command, format_output
2228
from .device import Device
@@ -87,33 +93,46 @@ def play_pronto(self, pronto: str, repeats: int = 1):
8793
return self.play_raw(*self.pronto_to_raw(pronto, repeats))
8894

8995
@classmethod
90-
def pronto_to_raw(cls, pronto: str, repeats: int = 1):
91-
"""Play a Pronto Hex encoded IR command. Supports only raw Pronto format,
92-
starting with 0000.
96+
def _parse_pronto(cls, pronto: str) -> Tuple[List["ProntoBurstPair"],
97+
List["ProntoBurstPair"],
98+
int]:
99+
"""Parses Pronto Hex encoded IR command and returns a tuple containing
100+
a list of intro pairs, a list of repeat pairs and a signal carrier frequency
101+
"""
102+
try:
103+
pronto_data = Pronto.parse(bytearray.fromhex(pronto))
104+
except Exception as ex:
105+
raise ChuangmiIrException("Invalid Pronto command") from ex
106+
107+
return pronto_data.intro, pronto_data.repeat, int(round(pronto_data.frequency))
108+
109+
@classmethod
110+
def pronto_to_raw(cls, pronto: str, repeats: int = 1) -> Tuple[str, int]:
111+
"""Takes a Pronto Hex encoded IR command and number of repeats
112+
and returns a tuple containing a string encoded IR signal accepted by
113+
controller and frequency.
114+
Supports only raw Pronto format, starting with 0000.
93115
94116
:param str pronto: Pronto Hex string.
95117
:param int repeats: Number of extra signal repeats.
96118
"""
97119
if repeats < 0:
98120
raise ChuangmiIrException("Invalid repeats value")
99121

100-
try:
101-
pronto_data = Pronto.parse(bytearray.fromhex(pronto))
102-
except Exception as ex:
103-
raise ChuangmiIrException("Invalid Pronto command") from ex
122+
intro_pairs, repeat_pairs, frequency = cls._parse_pronto(pronto)
104123

105-
if len(pronto_data.intro) == 0:
124+
if len(intro_pairs) == 0:
106125
repeats += 1
107126

108127
times = set()
109-
for pair in pronto_data.intro + pronto_data.repeat * (1 if repeats else 0):
128+
for pair in intro_pairs + repeat_pairs * (1 if repeats else 0):
110129
times.add(pair.pulse)
111130
times.add(pair.gap)
112131

113132
times = sorted(times)
114133
times_map = {t: idx for idx, t in enumerate(times)}
115134
edge_pairs = []
116-
for pair in pronto_data.intro + pronto_data.repeat * repeats:
135+
for pair in intro_pairs + repeat_pairs * repeats:
117136
edge_pairs.append(
118137
{"pulse": times_map[pair.pulse], "gap": times_map[pair.gap]}
119138
)
@@ -127,7 +146,7 @@ def pronto_to_raw(cls, pronto: str, repeats: int = 1):
127146
)
128147
).decode()
129148

130-
return signal_code, int(round(pronto_data.frequency))
149+
return signal_code, frequency
131150

132151
@command(
133152
click.argument("command", type=str),
@@ -185,6 +204,73 @@ def get_indicator_led(self):
185204
return self.send("get_indicatorLamp")
186205

187206

207+
class ChuangmiRemote(ChuangmiIr):
208+
"""Class representing new type of Chuangmi IR Remote Controller
209+
identified by model "chuangmi-remote-h102a03_". The new controller uses
210+
different format for learned IR commands, which actually is the old
211+
format but with additional layer of compression.
212+
"""
213+
214+
@classmethod
215+
def pronto_to_raw(cls, pronto: str, repeats: int = 1) -> Tuple[str, int]:
216+
"""Takes a Pronto Hex encoded IR command and number of repeats
217+
and returns a tuple containing a string encoded IR signal accepted by
218+
controller and frequency.
219+
Supports only raw Pronto format, starting with 0000.
220+
221+
:raises ChuangmiIrException if heatshrink package is not installed
222+
223+
:param str pronto: Pronto Hex string.
224+
:param int repeats: Number of extra signal repeats.
225+
"""
226+
if heatshrink is None:
227+
raise ChuangmiIrException("Heatshrink library is missing")
228+
raw, frequency = super().pronto_to_raw(pronto, repeats)
229+
return base64.b64encode(
230+
heatshrink.encode('learn{}'.format(raw).encode())
231+
).decode(), frequency
232+
233+
234+
class ChuangmiRemoteV2(ChuangmiIr):
235+
"""Class representing new type of Chuangmi IR Remote Controller
236+
identified by model "chuangmi-remote-v2". The new controller uses
237+
different format for learned IR commands, which compresses an ASCII list
238+
of comma separated edge timings.
239+
"""
240+
241+
@classmethod
242+
def pronto_to_raw(cls, pronto: str, repeats: int = 1) -> Tuple[str, int]:
243+
"""Takes a Pronto Hex encoded IR command and number of repeats
244+
and returns a tuple containing a string encoded IR signal accepted by
245+
controller and frequency.
246+
Supports only raw Pronto format, starting with 0000.
247+
248+
:param str pronto: Pronto Hex string.
249+
:param int repeats: Number of extra signal repeats."""
250+
if heatshrink is None:
251+
raise ChuangmiIrException("Heatshrink library is missing")
252+
253+
if repeats < 0:
254+
raise ChuangmiIrException('Invalid repeats value')
255+
256+
intro_pairs, repeat_pairs, frequency = cls._parse_pronto(pronto)
257+
258+
if len(intro_pairs) == 0:
259+
repeats += 1
260+
261+
timings = []
262+
for pair in intro_pairs + repeat_pairs * repeats:
263+
timings.append(pair.pulse)
264+
timings.append(pair.gap)
265+
timings[-1] = 0
266+
267+
timings = '{}\0'.format(','.join(map(str, timings))).encode()
268+
269+
return base64.b64encode(
270+
heatshrink.encode(timings)
271+
).decode(), frequency
272+
273+
188274
class ProntoPulseAdapter(Adapter):
189275
def _decode(self, obj, context, path):
190276
return int(obj * context._.modulation_period)

‎miio/discovery.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
ChuangmiCamera,
2929
ChuangmiIr,
3030
ChuangmiPlug,
31+
ChuangmiRemote,
32+
ChuangmiRemoteV2,
3133
Cooker,
3234
Device,
3335
Fan,
@@ -134,7 +136,8 @@
134136
"chuangmi-camera-ipc009": ChuangmiCamera,
135137
"chuangmi-camera-ipc019": ChuangmiCamera,
136138
"chuangmi-ir-v2": ChuangmiIr,
137-
"chuangmi-remote-h102a03_": ChuangmiIr,
139+
"chuangmi-remote-h102a03_": ChuangmiRemote,
140+
"chuangmi-remote-v2": ChuangmiRemoteV2,
138141
"zhimi-humidifier-v1": partial(AirHumidifier, model=MODEL_HUMIDIFIER_V1),
139142
"zhimi-humidifier-ca1": partial(AirHumidifier, model=MODEL_HUMIDIFIER_CA1),
140143
"zhimi-humidifier-cb1": partial(AirHumidifier, model=MODEL_HUMIDIFIER_CB1),

‎miio/tests/test_chuangmi_ir.json

+152
Original file line numberDiff line numberDiff line change
@@ -111,5 +111,157 @@
111111
0
112112
]
113113
}
114+
],
115+
"test_pronto_ok_chuangmi_remote": [
116+
{
117+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - with spaces",
118+
"in": [
119+
"0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0622 015B 0057 0016 0E6C"
120+
],
121+
"out": [
122+
"tllsNyt1am1WpFBokwodBoNDslCs9BoMys4AhUq51Kg0GhVGk3eg0G81qcUGg02jTOg1GggAeAB4AHzAAuqjRaEAGoBZ0GhAKLRQC1AXKhVGlUegz0A=",
123+
38381
124+
]
125+
},
126+
{
127+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - without spaces",
128+
"in": [
129+
"0000006C00220002015B00AD001600160016001600160016001600160016001600160016001600160016001600160041001600410016004100160041001600410016004100160041001600160016001600160041001600160016004100160016001600160016001600160016001600410016001600160041001600160016004100160041001600410016004100160622015B005700160E6C"
130+
],
131+
"out": [
132+
"tllsNyt1am1WpFBokwodBoNDslCs9BoMys4AhUq51Kg0GhVGk3eg0G81qcUGg02jTOg1GggAeAB4AHzAAuqjRaEAGoBZ0GhAKLRQC1AXKhVGlUegz0A=",
133+
38381
134+
]
135+
},
136+
{
137+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - 0 repeat frames",
138+
"in": [
139+
"0000006C00220002015B00AD001600160016001600160016001600160016001600160016001600160016001600160041001600410016004100160041001600410016004100160041001600160016001600160041001600160016004100160016001600160016001600160016001600410016001600160041001600160016004100160041001600410016004100160622015B005700160E6C",
140+
0
141+
],
142+
"out": [
143+
"tllsNyt1am1WolBokwodBoNDslCs9BoNtvFFoNBo1BtVBoNEpVuu9BAA8ADwAPAAsEMgAIqNFoQAagFnQaEAooNJAFmAuVCoIA==",
144+
38381
145+
]
146+
},
147+
{
148+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - 2 repeat frames",
149+
"in": [
150+
"0000006C00220002015B00AD001600160016001600160016001600160016001600160016001600160016001600160041001600410016004100160041001600410016004100160041001600160016001600160041001600160016004100160016001600160016001600160016001600410016001600160041001600160016004100160041001600410016004100160622015B005700160E6C",
151+
2
152+
],
153+
"out": [
154+
"tllsNyt1am1WplBokwodBoNDslCs9BoMys4AhUq51Kg0GhVGk3eg0G81qcUGg02jTOg1GggAeAB4AHzAAuqjRaEAGoBZ0GhAKLRQC1AXKhVGlUeg2us0Gez0",
155+
38381
156+
]
157+
},
158+
{
159+
"desc": "Sony20, Dev 0, Subdev 0, Function 1",
160+
"in": [
161+
"00000068000000150060001800300018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001802D0"
162+
],
163+
"out": [
164+
"tllsNyt1am1WqlBo1vodBoNDmFCoNBoNhoNroNBpVCo4BRAAeAB4AHgAfQ6DUQEvAAaiAN+A3k9A",
165+
39857
166+
]
167+
},
168+
{
169+
"desc": "Sony20, Dev 0, Subdev 0, Function 1 - 0 repeats",
170+
"in": [
171+
"00000068000000150060001800300018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001802D0",
172+
0
173+
],
174+
"out": [
175+
"tllsNyt1am1VuFBo1vodBoNDmFCoNBoNhoNroNBpVCo4BRAAeAB4AHgAfQ6DUQEvAAaiUGeg",
176+
39857
177+
]
178+
},
179+
{
180+
"desc": "Sony20, Dev 0, Subdev 0, Function 1 - 2 repeats",
181+
"in": [
182+
"00000068000000150060001800300018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001802D0",
183+
2
184+
],
185+
"out": [
186+
"tllsNyt1am1WnNBo1vodBoNDmFCoNBoNhoNroNBpVCo4BRAAeAB4AHgAfQ6DUQEvAAaiAN+A34CngNxPQA==",
187+
39857
188+
]
189+
}
190+
],
191+
"test_pronto_ok_chuangmi_remote_v2": [
192+
{
193+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - with spaces",
194+
"in": [
195+
"0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0622 015B 0057 0016 0E6C"
196+
],
197+
"out": [
198+
"nMwmkwlk0mswm8sms3mYAfgB+AH4AfyyYzacgEeAR4BHgEWAH4DHgIeAH4FHgIeAh4BHgEfNJhOZhNZYJEkymU2mwCaTCAA=",
199+
38381
200+
]
201+
},
202+
{
203+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - without spaces",
204+
"in": [
205+
"0000006C00220002015B00AD001600160016001600160016001600160016001600160016001600160016001600160041001600410016004100160041001600410016004100160041001600160016001600160041001600160016004100160016001600160016001600160016001600410016001600160041001600160016004100160041001600410016004100160622015B005700160E6C"
206+
],
207+
"out": [
208+
"nMwmkwlk0mswm8sms3mYAfgB+AH4AfyyYzacgEeAR4BHgEWAH4DHgIeAH4FHgIeAh4BHgEfNJhOZhNZYJEkymU2mwCaTCAA=",
209+
38381
210+
]
211+
},
212+
{
213+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - 0 repeat frames",
214+
"in": [
215+
"0000006C00220002015B00AD001600160016001600160016001600160016001600160016001600160016001600160041001600410016004100160041001600410016004100160041001600160016001600160041001600160016004100160016001600160016001600160016001600410016001600160041001600160016004100160041001600410016004100160622015B005700160E6C",
216+
0
217+
],
218+
"out": [
219+
"nMwmkwlk0mswm8sms3mYAfgB+AH4AfyyYzacgEeAR4BHgEWAH4DHgIeAH4FHgIeAh4BHgEfMIAA=",
220+
38381
221+
]
222+
},
223+
{
224+
"desc": "NEC1, Dev 0, Subdev 127, Function 10 - 2 repeat frames",
225+
"in": [
226+
"0000006C00220002015B00AD001600160016001600160016001600160016001600160016001600160016001600160041001600410016004100160041001600410016004100160041001600160016001600160041001600160016004100160016001600160016001600160016001600410016001600160041001600160016004100160041001600410016004100160622015B005700160E6C",
227+
2
228+
],
229+
"out": [
230+
"nMwmkwlk0mswm8sms3mYAfgB+AH4AfyyYzacgEeAR4BHgEWAH4DHgIeAH4FHgIeAh4BHgEfNJhOZhNZYJEkymU2mwCaTmbTEB0gE9mEA",
231+
38381
232+
]
233+
},
234+
{
235+
"desc": "Sony20, Dev 0, Subdev 0, Function 1",
236+
"in": [
237+
"00000068000000150060001800300018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001802D0"
238+
],
239+
"out": [
240+
"mU0mE4lk2mEylkxmUwmgBCAB+AH4AfgB+AH4AfgB+AH4AfhOJOJhNppLAq/An8APwA/AD8APwA/AD8APwA/ADWYQAA==",
241+
39857
242+
]
243+
},
244+
{
245+
"desc": "Sony20, Dev 0, Subdev 0, Function 1 - 0 repeats",
246+
"in": [
247+
"00000068000000150060001800300018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001802D0",
248+
0
249+
],
250+
"out": [
251+
"mU0mE4lk2mEylkxmUwmgBCAB+AH4AfgB+AH4AfgB+AH4AfgBnMIA",
252+
39857
253+
]
254+
},
255+
{
256+
"desc": "Sony20, Dev 0, Subdev 0, Function 1 - 2 repeats",
257+
"in": [
258+
"00000068000000150060001800300018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001800180018001802D0",
259+
2
260+
],
261+
"out": [
262+
"mU0mE4lk2mEylkxmUwmgBCAB+AH4AfgB+AH4AfgB+AH4AfhOJOJhNppLAq/An8APwA/AD8APwA/AD8APwA/Cr8KvwA/AD8APwA/AD8APwA/AD8AP5lLJhAA=",
263+
39857
264+
]
265+
}
114266
]
115267
}

0 commit comments

Comments
 (0)