Overview
Comment: | Added basic functionality |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
b4c11741e1d997771a2a0e065fe81628 |
User & Date: | rkeene on 2020-04-28 16:31:12 |
Other Links: | manifest | tags |
Context
2020-04-28
| ||
16:31 | Added ignores check-in: 4e8659777a user: rkeene tags: trunk | |
16:31 | Added basic functionality check-in: b4c11741e1 user: rkeene tags: trunk | |
16:30 | initial empty check-in check-in: 09d3b4e2a7 user: rkeene tags: trunk | |
Changes
Added __init__.py version [1d38bdb4f5].
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 | #! /usr/bin/env python3 import random import time import math class remote: _remote_type_alias_map = { 'fut089': 'rgb+cct' } _remote_type_parameters_map = { 'rgbw': { 'channels': [9, 40, 71], 'syncword': [0x258B, 0x147A], 'features': [ 'can_set_brightness', 'has_brightness', 'has_white', 'has_color' ], 'brightness_range': [0, 25], 'button_map': { 'slider': 0x00, 'on': 0x01, 'white': 0x11, 'off': 0x02, 'night': 0x12, 'zone_on:1': 0x03, 'zone_on:2': 0x05, 'zone_on:3': 0x07, 'zone_on:4': 0x09, 'zone_white:1': 0x13, 'zone_white:2': 0x15, 'zone_white:3': 0x17, 'zone_white:4': 0x19, 'zone_off:1': 0x04, 'zone_off:2': 0x06, 'zone_off:3': 0x08, 'zone_off:4': 0x0A, 'zone_night:1': 0x14, 'zone_night:2': 0x16, 'zone_night:3': 0x18, 'zone_night:4': 0x1A, 'speed_up': 0x0B, 'speed_down': 0x0C, 'change_color_mode': 0x0D, 'zone_set_brightness': 0x0E, 'set_color': 0x0F } }, 'cct': { 'channels': [4, 39, 74], 'syncword': [0x55AA, 0x050A], 'brightness_range': [0, 9], 'temperature_output_range': [0, 9], 'temperature_input_range': [3000, 9000], 'features': [ 'has_max_brightness', 'has_brightness', 'has_temperature', 'is_white' ], 'button_map': { 'on': 0x05, 'off': 0x09, 'max': 0x15, 'night': 0x19, 'zone_on:1': 0x08, 'zone_on:2': 0x0D, 'zone_on:3': 0x07, 'zone_on:4': 0x02, 'zone_max:1': 0x18, 'zone_max:2': 0x1D, 'zone_max:3': 0x17, 'zone_max:4': 0x12, 'zone_off:1': 0x0B, 'zone_off:2': 0x03, 'zone_off:3': 0x0A, 'zone_off:4': 0x06, 'zone_night:1': 0x1B, 'zone_night:2': 0x13, 'zone_night:3': 0x1A, 'zone_night:4': 0x16, 'brightness_up': 0x0C, 'brightness_down': 0x04, 'temperature_up': 0x0E, 'temperature_down': 0x0F } }, 'rgb+cct': { 'channels': [8, 39, 70], 'syncword': [0x1809, 0x7236] }, 'rgb': { 'channels': [3, 38, 73], 'syncword': [0xBCCD, 0x9AAB] }, 'fut020': { 'channels': [6, 41, 76], 'syncword': [0xAA55, 0x50A0] } } def __init__(self, radio, remote_type, remote_id, message_id = None, config = None): if not radio.initialize(): raise ValueError('Radio initialization failed') # Pull in the config for this remote type self._config = self._get_type_parameters(remote_type) # Allow the user to specify some more parameters if config is not None: self._config.update(config) # Store parameters self._radio = radio self._type = remote_type self._id = remote_id # Initialize the message ID for this remote if message_id is None: self._message_id = random.randint(0, 255) else: self._message_id = message_id return None def _scale_int(self, input_value, input_range_low, input_range_high, output_range_low, output_range_high): input_range = input_range_high - input_range_low output_range = output_range_high - output_range_low input_value = input_value - input_range_low output = input_value * (output_range / input_range) output = output + output_range_low output = int(output + 0.5) return output def _debug(self, message): print("MILITE DEBUG: " + message) return None def _get_type_parameters(self, remote_type): config = self._remote_type_parameters_map[remote_type] # Supply default config values if 'retries' not in config: config['retries'] = 3 if 'delay' not in config: config['delay'] = 0.1 setattr(self, '_compute_button_message', getattr(self, '_compute_button_message_' + remote_type)) setattr(self, '_parse_button_message', getattr(self, '_parse_button_message_' + remote_type)) return config def _compute_button_and_zone_from_button_id(self, button_id): button_info = {} button_info['button'] = 'unknown=' + str(button_id) for button_name, button_value in self._config['button_map'].items(): if button_value == button_id: button_info['button'] = button_name break # If the button name has a zone, split it out into its own parameter if button_info['button'].find(':') != -1: button_name_zone = button_info['button'].split(':') button_info['button'] = button_name_zone[0] button_info['zone'] = int(button_name_zone[1]) return button_info def _compute_button_message_cct(self, button_info): remote_id = button_info['remote_id'] message_id = button_info['message_id'] # Header consists of magic (0x5A), follow by 16-bit remote ID header = [0x5A, (remote_id >> 8) & 0xff, remote_id & 0xff] # Determine zone, default to all zone = button_info.get('zone', 0) # Some buttons need to be converted to zones button_name = button_info['button'] if button_name in ['zone_on', 'zone_off', 'zone_max', 'zone_night']: button_name = button_name + ':' + str(zone) # Look up the button button_id = self._config['button_map'][button_name] # Compute message body body = [zone, button_id, message_id] # Compute message trailer ## Include a CRC, for good measure ? crc = 0 for byte in header + body: crc = crc + byte crc = crc & 0xff trailer = [crc] message = header + body + trailer return message def _parse_button_message_cct(self, button_message): button_info = {} # Verify the header -- if it is not valid, return None if button_message[0] != 0x5A: return None # Parse out common parts of the message button_info['remote_id'] = (button_message[1] << 8) | button_message[2] button_info['zone'] = button_message[3] button_info['message_id'] = button_message[5] # Remove the all zone if button_info['zone'] == 0: del button_info['zone'] # Map the button ID to a button name button_id = button_message[4] button_info.update(self._compute_button_and_zone_from_button_id(button_id)) return button_info def _compute_button_message_rgbw(self, button_info): remote_id = button_info['remote_id'] message_id = button_info['message_id'] # Allow setting brightness for all zones if button_info['button'] == 'set_brightness': button_info['button'] = 'zone_set_brightness' if 'zone' in button_info: del button_info['zone'] # Header consists of magic (0xB0), follow by 16-bit remote ID header = [0xB0, (remote_id >> 8) & 0xff, remote_id & 0xff] # Default value for most buttons, since they do not need it brightness = 0 color = 0 # Some buttons need to be converted to zones button_name = button_info['button'] if button_name in ['zone_on', 'zone_off', 'zone_white', 'zone_night']: button_name = button_name + ':' + str(button_info['zone']) button_id = self._config['button_map'][button_name] # Brightness and Color buttons should also set the appropriate # parameters if button_info['button'] == 'zone_set_brightness': ## Brightness is a range of [0..25] (26 steps) ## Shifted 3 bitsleft brightness = button_info['brightness'] if brightness < 0: brightness = 0 elif brightness > 25: brightness = 25 brightness = 31 - ((brightness + 15) % 32) brightness = brightness << 3 if 'zone' in button_info: brightness = brightness | button_info['zone'] elif button_info['button'] == 'set_color': color = button_info['color'] # Compute message body = [color, brightness, button_id, message_id] # Compute whole message message = header + body return message def _parse_button_message_rgbw(self, button_message): button_info = {} # Verify the header -- if it is not valid, return None if button_message[0] != 0xB0: return None # Parse out common parts of the message button_info['remote_id'] = (button_message[1] << 8) | button_message[2] button_info['color'] = button_message[3] button_info['brightness'] = button_message[4] button_info['message_id'] = button_message[6] # Map the button ID to a button name button_id = button_message[5] button_info.update(self._compute_button_and_zone_from_button_id(button_id)) if button_info['button'] == 'zone_set_brightness': brightness = button_info['brightness'] zone = brightness & 0b111 if zone != 0: button_info['zone'] = zone else: button_info['button'] = 'set_brightness' # Compute brightness value, there are 26 brightness steps, [16, 0][31, 23] brightness = brightness >> 3 brightness = 31 - ((brightness + 15) % 32) button_info['brightness'] = brightness return button_info def _get_next_message_id(self): # Determine next message ID self._message_id = (self._message_id + 1) & 0xff return self._message_id def _send_button(self, button_info): # Configure radio parameters self._radio.set_syncword(self._config['syncword']) # Include the remote ID unless one was supplied if 'remote_id' not in button_info: button_info['remote_id'] = self._id # Get the next message ID for this remote if 'message_id' not in button_info: message_id = self._get_next_message_id() button_info['message_id'] = message_id else: self._message_id = button_info['message_id'] # Compute message message = self._compute_button_message(button_info) # Transmit self._debug("Sending {}={} n={} times with a {}s delay".format(button_info, message, self._config['retries'], self._config['delay'])) self._radio.multi_transmit(message, self._config['channels'], self._config['retries'], self._config['delay']) return True def _set_brightness(self, brightness, zone = None): if zone is None: message = {'button': 'set_brightness'} else: message = { 'button': 'zone_set_brightness', 'zone': zone } message['brightness'] = brightness return self._send_button(message) def _step_value(self, target_value, target_range_min, target_range_max, button_prefix, zone): # Step all the way to the nearest extreme before moving it to # where it should be target_range = target_range_max - target_range_min + 1 midpoint = (target_range / 2) + target_range_min # Move to the "initial" value where we force the value # to the extreme, then move it to its final value initial_steps = target_range if target_value < midpoint: initial_direction = 'down' final_direction = 'up' initial_value = target_range_min else: initial_direction = 'up' final_direction = 'down' initial_value = target_range_max # If this remote has a "max" feature, use that instead of stepping use_max_button = False if initial_value == target_range_max: if 'has_max_{}'.format(button_prefix) in self._config['features']: use_max_button = True if use_max_button: self._debug("[INITIAL] Going to max {}".format(button_prefix)) getattr(self, "max_{}".format(button_prefix))(zone) else: # Otherwise, step it for step in range(initial_steps): self._debug("[INITIAL] Stepping {} {}".format(button_prefix, initial_direction)) self._send_button({'button': "{}_{}".format(button_prefix, initial_direction)}) # Now that we have forced the value to the extreme, move in # steps from that value to the desired value if initial_value < target_value: final_steps = target_value - initial_value else: final_steps = initial_value - target_value for step in range(final_steps): self._debug("[FINAL] Stepping {} {}".format(button_prefix, final_direction)) self._send_button({'button': "{}_{}".format(button_prefix, final_direction)}) return True def _step_brightness(self, brightness, brightness_min, brightness_max, zone = None): # Select the appropriate zone before sending the steps # to ensure they reach the correct bulbs self.on(zone) time.sleep(0.1) return self._step_value(brightness, brightness_min, brightness_max, 'brightness', zone) def _step_temperature(self, temperature, temperature_min, temperature_max, zone = None): # Select the appropriate zone before sending the steps # to ensure they reach the correct bulbs self.on(zone) time.sleep(0.1) return self._step_value(temperature, temperature_min, temperature_max, 'temperature', zone) def _rgb_to_hue(self, r, g, b): r = r / 255.0 g = g / 255.0 b = b / 255.0 cmax = max(r, max(g, b)) cmin = min(r, min(g, b)) diff = cmax - cmin if cmax == cmin: h = 0 elif cmax == r: h = (60 * ((g - b) / diff) + 360) % 360 elif cmax == g: h = (60 * ((b - r) / diff) + 120) % 360 elif cmax == b: h = (60 * ((r - g) / diff) + 240) % 360 return h def _rgb_to_color(self, rgb): r = (rgb >> 16) & 0xff g = (rgb >> 8) & 0xff b = rgb & 0xff if r == g and g == b: return (r * -1) - 1 h = self._rgb_to_hue(r, g, b) color = ((h / 360.0) * 255.0) + 26 color = int(color + 0.5) self._debug("RGB = \x1b[38;2;%i;%i;%im%06x\x1b[0m; Hue = %s; Color = %i" % (r, g, b, rgb, str(h * 360), color)) return color def rgb_to_color(self, rgb): return self._rgb_to_color(rgb) def raw_send_button(self, button_info): return self._send_button(button_info) def raw_read_button(self): channel = self._config['channels'][0] self._radio.set_syncword(self._config['syncword']) data = self._radio.receive(channel = channel, wait = True, wait_time = 1) message = self._parse_button_message(data) return message def set_brightness(self, brightness, zone = None): if 'has_brightness' not in self._config['features']: return False if brightness < 0 or brightness > 255: return False self._debug("Setting brightness to {}".format(brightness)) if brightness == 0: self._debug("Really setting to off") return self.off(zone) if brightness == 255: if 'has_max_brightness' in self._config['features']: return self.max_brightness(zone) brightness_min = self._config['brightness_range'][0] brightness_max = self._config['brightness_range'][1] brightness = self._scale_int(brightness, 1, 255, self._config['brightness_range'][0], self._config['brightness_range'][1]) if 'can_set_brightness' in self._config['features']: return self._set_brightness(brightness, zone) else: return self._step_brightness(brightness, brightness_min, brightness_max, zone) def set_color(self, rgb, zone = None): # Compute the color value from the RGB value value = self._rgb_to_color(rgb) # If the color selected is really a shade of grey, turn the # bulbs white at that brightness if value < 0: brightness = (value + 1) * -1 self._debug("Brightness = {}".format(brightness)) if self.white(zone): return self.set_brightness(brightness, zone) else: return False # If the bulbs do not support color, nothing needs to be done if 'has_color' not in self._config['features']: return False # Turn on the appropriate zone to select it self.on(zone) time.sleep(0.1) # Press the button return self._send_button({'button': 'set_color', 'color': value}) def set_temperature(self, kelvins, zone = None): if 'has_temperature' not in self._config['features']: return False temperature_input_low = self._config['temperature_input_range'][0] temperature_input_high = self._config['temperature_input_range'][1] temperature_output_low = self._config['temperature_output_range'][0] temperature_output_high = self._config['temperature_output_range'][1] # Clamp the color temperature to something this remote supports if kelvins < temperature_input_low: kelvins = temperature_input_low elif kelvins > temperature_input_high: kelvins = temperature_input_high temperature = self._scale_int(kelvins, temperature_input_low, temperature_input_high, temperature_output_low, temperature_output_high) if 'can_set_temperature' in self._config['features']: return self._set_temperature(temperature, zone) else: return self._step_temperature(temperature, temperature_output_low, temperature_output_high, zone) def on(self, zone = None): if zone is None: message = {'button': 'on'} else: message = { 'button': 'zone_on', 'zone': zone } return self._send_button(message) def off(self, zone = None): if zone is None: message = {'button': 'off'} else: message = { 'button': 'zone_off', 'zone': zone } return self._send_button(message) def max_brightness(self, zone = None): if 'has_max_brightness' not in self._config['features']: return self.set_brightness(255, zone) if zone is None: message = {'button': 'max'} else: message = { 'button': 'zone_max', 'zone': zone } return self._send_button(message) def white(self, zone = None): # If the bulbs are already white, nothing needs to be done if 'is_white' in self._config['features']: return True # If the bulbs do not support white, nothing needs to be done if 'has_white' not in self._config['features']: return False if zone is None: message = {'button': 'white'} else: message = { 'button': 'zone_white', 'zone': zone } return self._send_button(message) def pair(self, zone): # XXX return False def unpair(self, zone): # XXX return False |