-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
InstaxBLE.py
549 lines (463 loc) · 22.7 KB
/
InstaxBLE.py
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
#!/usr/bin/env python3
from math import ceil
from struct import pack, unpack_from
from time import sleep
# Try to import Types with a relative import first
try:
from .Types import EventType, InfoType, PrinterSettings
from . import LedPatterns
except ImportError:
# If that fails (which it will if this file is being run directly),
# try an absolute import instead
from Types import EventType, InfoType, PrinterSettings
import LedPatterns
import argparse
import simplepyble
import sys
from PIL import Image
from io import BytesIO
class InstaxBLE:
def __init__(
self,
device_address=None,
device_name=None,
print_enabled=False,
dummy_printer=False,
verbose=False,
quiet=False,
image_path=None):
"""
Initialize the InstaxBLE class.
deviceAddress: if specified, will only connect to a printer with this address.
printEnabled: by default, actual printing is disabled to prevent misprints.
"""
# BLE
self.serviceUUID = '70954782-2d83-473d-9e5f-81e1d02d5273'
self.writeCharUUID = '70954783-2d83-473d-9e5f-81e1d02d5273'
self.notifyCharUUID = '70954784-2d83-473d-9e5f-81e1d02d5273'
self.peripheral = None
self.quiet = quiet
self.dummyPrinter = dummy_printer
self.printerSettings = PrinterSettings['mini'] if self.dummyPrinter else None
self.chunkSize = PrinterSettings['mini']['chunkSize'] if self.dummyPrinter else 0
self.printEnabled = print_enabled
self.deviceName = device_name.upper() if device_name else None
self.deviceAddress = device_address.upper() if device_address else None
self.image_path = image_path
self.verbose = verbose if not self.quiet else False
self.packetsForPrinting = []
self.pos = (0, 0, 0, 0)
self.batteryState = 0
self.batteryPercentage = 0
self.photosLeft = 0
self.isCharging = False
self.imageSize = (PrinterSettings['mini']['width'], PrinterSettings['mini']['height']) if self.dummyPrinter else (0, 0)
self.waitingForResponse = False
self.cancelled = False
adapters = simplepyble.Adapter.get_adapters()
if len(adapters) == 0:
if not self.quiet:
sys.exit("No bluetooth adapters found (are they enabled?)")
else:
sys.exit()
if len(adapters) > 1:
self.log(f"Found multiple adapters: {', '.join([adapter.identifier() for adapter in adapters])}")
self.log(f"Using the first one: {adapters[0].identifier()}")
self.adapter = adapters[0]
def log(self, msg):
""" Print a debug message"""
if self.verbose:
print(msg)
def display_current_status(self):
""" Display an overview of the current printer state """
print("\nPrinter details: ")
# print(f"Device name: {self.printerSettings['modelName']}")
print(f"Model: {self.printerSettings['modelName']}")
print(f"Photos left: {self.photosLeft}/10")
print(f"Battery level: {self.batteryPercentage}%")
print(f"Charging: {self.isCharging}")
print(f"Required image size: {self.printerSettings['width']}x{self.printerSettings['height']}px")
if self.peripheral.mtu:
print(f"MTU: {self.peripheral.mtu()}")
print("")
def parse_printer_response(self, event, packet):
""" Parse the response packet and print the result """
# self.log(f"event: {event}")
self.waitingForResponse = False
if event == EventType.XYZ_AXIS_INFO:
x, y, z, o = unpack_from('<hhhB', packet[6:-1])
self.pos = (x, y, z, o)
elif event == EventType.LED_PATTERN_SETTINGS:
pass
elif event == EventType.SUPPORT_FUNCTION_INFO:
try:
infoType = InfoType(packet[7])
except ValueError:
self.log(f'Unknown InfoType: {packet[7]}')
return
if infoType == InfoType.IMAGE_SUPPORT_INFO:
w, h = unpack_from('>HH', packet[8:12])
# self.log(self.prettify_bytearray(packet[8:12]))
# self.log(f'image size: {w}x{h}')
self.imageSize = (w, h)
if (w, h) == (600, 800):
self.printerSettings = PrinterSettings['mini']
elif (w, h) == (800, 800):
self.printerSettings = PrinterSettings['square']
elif (w, h) == (1260, 840):
self.printerSettings = PrinterSettings['wide']
else:
exit(f'Unknown image size from printer: {w}x{h}')
self.chunkSize = self.printerSettings['chunkSize']
elif infoType == InfoType.BATTERY_INFO:
self.batteryState, self.batteryPercentage = unpack_from('>BB', packet[8:10])
# self.log(f'battery state: {self.batteryState}, battery percentage: {self.batteryPercentage}')
elif infoType == InfoType.PRINTER_FUNCTION_INFO:
dataByte = packet[8]
self.photosLeft = dataByte & 15
self.isCharging = (1 << 7) & dataByte >= 1
# self.log(f'photos left: {self.photosLeft}')
# if self.isCharging:
# self.log('Printer is charging')
# else:
# self.log('Printer is running on battery')
elif event == EventType.PRINT_IMAGE_DOWNLOAD_START:
self.handle_image_packet_queue()
elif event == EventType.PRINT_IMAGE_DOWNLOAD_DATA:
self.handle_image_packet_queue()
elif event == EventType.PRINT_IMAGE_DOWNLOAD_END:
self.handle_image_packet_queue()
elif event == EventType.PRINT_IMAGE_DOWNLOAD_CANCEL:
pass
elif event == EventType.PRINT_IMAGE:
self.log('received print confirmation')
pass
else:
self.log(f'Uncaught response from printer. Eventype: {event}')
def handle_image_packet_queue(self):
if len(self.packetsForPrinting) > 0 and not self.cancelled:
if len(self.packetsForPrinting) % 10 == 0:
self.log(f"Img packets left to send: {len(self.packetsForPrinting)}")
packet = self.packetsForPrinting.pop(0)
self.send_packet(packet)
def notification_handler(self, packet):
""" Gets called whenever the printer replies and handles parsing the received data """
# self.log('Notification handler:')
# self.log(f'\t{self.prettify_bytearray(packet[:40])}')
if not self.quiet:
if len(packet) < 8:
self.log(f"\tError: response packet size should be >= 8 (was {len(packet)})!")
return
elif not self.validate_checksum(packet):
self.log("\tResponse packet checksum was invalid!")
return
header, length, op1, op2 = unpack_from('>HHBB', packet)
# self.log('\theader: ', header, '\t', self.prettify_bytearray(packet[0:2]))
# self.log('\tlength: ', length, '\t', self.prettify_bytearray(packet[2:4]))
# self.log('\top1: ', op1, '\t\t', self.prettify_bytearray(packet[4:5]))
# self.log('\top2: ', op2, '\t\t', self.prettify_bytearray(packet[5:6]))
try:
event = EventType((op1, op2))
# self.log(f'\tResponse event: {event}')
except ValueError:
self.log(f"Unknown EventType: ({op1}, {op2})")
return
self.parse_printer_response(event, packet)
def connect(self, timeout=0):
""" Connect to the printer. Stops trying after <timeout> seconds. """
if self.dummyPrinter:
return
self.peripheral = self.find_device(timeout=timeout)
if self.peripheral:
try:
self.log(f"Connecting to {self.peripheral.identifier()} [{self.peripheral.address()}]")
self.peripheral.connect()
except Exception as e:
if not self.quiet:
self.log(f'error on connecting: {e}')
if self.peripheral.is_connected():
# check if we're using a version of simplepyble that supports reading mtu
self.log(f"Connected")
# self.log('Attaching notification_handler')
try:
self.peripheral.notify(self.serviceUUID, self.notifyCharUUID, self.notification_handler)
except Exception as e:
if not self.quiet:
self.log(f'Error on attaching notification_handler: {e}')
return
self.get_printer_info()
sleep(1)
self.display_current_status()
def disconnect(self):
""" Disconnect from the printer (if connected) """
if self.dummyPrinter:
return
if self.peripheral:
if self.peripheral.is_connected():
# if len(self.packetsForPrinting) > 0 and not self.cancelled:
# self.log('sending cancel command')
# self.send_packet(self.create_packet(EventType.PRINT_IMAGE_DOWNLOAD_CANCEL))
self.log('Disconnecting...')
self.peripheral.disconnect()
self.log("Disconnected")
def cancel_print(self):
self.packetsForPrinting = []
self.waitingForResponse = False
self.send_packet(self.create_packet(EventType.PRINT_IMAGE_DOWNLOAD_CANCEL))
def enable_printing(self):
""" Enable printing. """
self.printEnabled = True
def disable_printing(self):
""" Disable printing. """
self.printEnabled = False
def find_device(self, timeout=0):
"""" Scan for our device and return it when found """
self.log('Searching for instax printer...')
secondsTried = 0
try:
while True:
self.adapter.scan_for(2000)
peripherals = self.adapter.scan_get_results()
for peripheral in peripherals:
foundName = peripheral.identifier()
foundAddress = peripheral.address()
# if foundName.startswith('INSTAX'):
# self.log(f"Found: {foundName} [{foundAddress}]")
if (self.deviceName and foundName.startswith(self.deviceName)) or \
(self.deviceAddress and foundAddress == self.deviceAddress) or \
(self.deviceName is None and self.deviceAddress is None and
foundName.startswith('INSTAX-') and foundName.endswith('(IOS)')):
# if foundAddress.startswith('FA:AB:BC'): # start of IOS endpooint
# to convert to ANDROID endpoint, replace 'FA:AB:BC' with '88:B4:36')
if peripheral.is_connectable():
return peripheral
elif not self.quiet:
self.log(f"Can't connect to printer at {foundAddress}")
secondsTried += 2
if timeout != 0 and secondsTried >= timeout:
return None
except KeyboardInterrupt:
self.cancel_print()
self.disconnect()
sys.exit()
def create_color_payload(self, colorArray, speed, repeat, when):
"""
Create a payload for a color pattern. See send_led_pattern for details.
"""
payload = pack('BBBB', when, len(colorArray), speed, repeat)
for color in colorArray:
payload += pack('BBB', color[0], color[1], color[2])
return payload
def send_led_pattern(self, pattern, speed=5, repeat=255, when=0):
""" Send a LED pattern to the Instax printer.
colorArray: array of BGR(!) values to use in animation, e.g. [[255, 0, 0], [0, 255, 0], [0, 0, 255]]
speed: time per frame/color: higher is slower animation
repeat: 0 = don't repeat (so play once), 1-254 = times to repeat, 255 = repeat forever
when: 0 = normal, 1 = on print, 2 = on print completion, 3 = pattern switch """
payload = self.create_color_payload(pattern, speed, repeat, when)
packet = self.create_packet(EventType.LED_PATTERN_SETTINGS, payload)
self.send_packet(packet)
def prettify_bytearray(self, value):
""" Helper funtion to convert a bytearray to a string of hex values. """
return ' '.join([f'{x:02x}' for x in value])
def create_checksum(self, bytearray):
""" Create a checksum for a given packet. """
return (255 - (sum(bytearray) & 255)) & 255
def create_packet(self, eventType, payload=b''):
""" Create a packet to send to the printer. """
if isinstance(eventType, EventType): # allows passing in an event or a value directly
eventType = eventType.value
header = b'\x41\x62' # 'Ab' means client to printer, 'aB' means printer to client
opCode = bytes([eventType[0], eventType[1]])
packetSize = pack('>H', 7 + len(payload))
packet = header + packetSize + opCode + payload
packet += pack('B', self.create_checksum(packet))
return packet
def validate_checksum(self, packet):
""" Validate the checksum of a packet. """
return (sum(packet) & 255) == 255
def send_packet(self, packet):
""" Send a packet to the printer """
if not self.dummyPrinter and not self.quiet:
if not self.peripheral:
self.log("no peripheral to send packet to")
elif not self.peripheral.is_connected():
self.log("peripheral not connected")
try:
while self.waitingForResponse and not self.dummyPrinter and not self.cancelled:
# self.log("sleep")
sleep(0.05)
header, length, op1, op2 = unpack_from('>HHBB', packet)
try:
event = EventType((op1, op2))
except Exception:
event = 'Unknown event'
# self.log(f'sending eventtype: {event}')
self.waitingForResponse = True
smallPacketSize = 182
numberOfParts = ceil(len(packet) / smallPacketSize)
# self.log(f"> number of parts to send: {numberOfParts}")
for subPartIndex in range(numberOfParts):
# self.log((subPartIndex + 1), '/', numberOfParts)
subPacket = packet[subPartIndex * smallPacketSize:subPartIndex * smallPacketSize + smallPacketSize]
if not self.dummyPrinter:
self.peripheral.write_command(self.serviceUUID, self.writeCharUUID, subPacket)
except KeyboardInterrupt:
self.cancelled = True
self.cancel_print()
# sleep(1)
self.disconnect()
sys.exit('Cancelled')
def print_image(self, imgSrc):
"""
print an image. Either pass a path to an image (as a string) or pass
the bytearray to print directly
"""
self.log(f'printing image "{imgSrc}"')
if self.photosLeft == 0 and not self.dummyPrinter:
self.log("Can't print: no photos left")
return
imgData = imgSrc
if isinstance(imgSrc, str): # if it's a path, load the image contents
image = Image.open(imgSrc)
imgData = self.pil_image_to_bytes(image, max_size_kb=105)
elif isinstance(imgSrc, BytesIO):
imgSrc.seek(0) # Go to the start of the BytesIO object
image = Image.open(imgSrc)
imgData = self.pil_image_to_bytes(image, max_size_kb=105)
# self.log(f"len of imagedata: {len(imgData)}")
self.packetsForPrinting = [
self.create_packet(EventType.PRINT_IMAGE_DOWNLOAD_START, b'\x02\x00\x00\x00' + pack('>I', len(imgData)))
]
# divide image data up into chunks of <chunkSize> bytes and pad the last chunk with zeroes if needed
imgDataChunks = [imgData[i:i + self.chunkSize] for i in range(0, len(imgData), self.chunkSize)]
if len(imgDataChunks[-1]) < self.chunkSize:
imgDataChunks[-1] = imgDataChunks[-1] + bytes(self.chunkSize - len(imgDataChunks[-1]))
# create a packet from each of our chunks, this includes adding the chunk number
for index, chunk in enumerate(imgDataChunks):
imgDataChunks[index] = pack('>I', index) + chunk # add chunk number as int (4 bytes)
self.packetsForPrinting.append(self.create_packet(EventType.PRINT_IMAGE_DOWNLOAD_DATA, imgDataChunks[index]))
self.packetsForPrinting.append(self.create_packet(EventType.PRINT_IMAGE_DOWNLOAD_END))
if self.printEnabled:
self.packetsForPrinting.append(self.create_packet(EventType.PRINT_IMAGE))
self.packetsForPrinting.append(self.create_packet((0, 2), b'\x02'))
elif not self.quiet:
self.log("Printing is disabled, sending all packets except the actual print command")
# for packet in self.packetsForPrinting:
# self.log(self.prettify_bytearray(packet))
# exit()
# send the first packet from our list, the packet handler will take care of the rest
if not self.dummyPrinter:
packet = self.packetsForPrinting.pop(0)
self.send_packet(packet)
# try:
# while len(self.packetsForPrinting) > 0:
# sleep(0.1)
# except KeyboardInterrupt:
# self.cancelled = True
# self.disconnect()
# sys.exit('Cancelled')
def print_services(self):
""" Get and display and overview of the printer's services and characteristics """
self.log("Successfully connected, listing services...")
services = self.peripheral.services()
service_characteristic_pair = []
for service in services:
for characteristic in service.characteristics():
service_characteristic_pair.append((service.uuid(), characteristic.uuid()))
for i, (service_uuid, characteristic) in enumerate(service_characteristic_pair):
self.log(f"{i}: {service_uuid} {characteristic}")
def get_printer_orientation(self):
""" Get the current XYZ orientation of the printer """
packet = self.create_packet(EventType.XYZ_AXIS_INFO)
self.send_packet(packet)
def get_printer_status(self):
""" Get the printer's status"""
packet = self.create_packet(EventType.SUPPORT_FUNCTION_INFO, pack('>B', InfoType.PRINTER_FUNCTION_INFO.value))
self.send_packet(packet)
def get_printer_info(self):
""" Get and display the printer's status and info, like photos left and battery level """
# self.log("Getting function info...")
packet = self.create_packet(EventType.SUPPORT_FUNCTION_INFO, pack('>B', InfoType.IMAGE_SUPPORT_INFO.value))
self.send_packet(packet)
packet = self.create_packet(EventType.SUPPORT_FUNCTION_INFO, pack('>B', InfoType.BATTERY_INFO.value))
self.send_packet(packet)
self.get_printer_status()
def pil_image_to_bytes(self, img: Image.Image, max_size_kb: int = None) -> bytearray:
""" Convert a PIL image to a bytearray """
img_buffer = BytesIO()
# Convert the image to RGB mode if it's in RGBA mode
if img.mode == 'RGBA':
img = img.convert('RGB')
# Resize the image to <imageSize> pixels
img = img.resize(self.imageSize, Image.Resampling.LANCZOS)
def save_img_with_quality(quality):
img_buffer.seek(0)
img.save(img_buffer, format='JPEG', quality=quality)
return img_buffer.tell() / 1024
if max_size_kb is not None:
low_quality, high_quality = 1, 100
current_quality = 75
closest_quality = current_quality
min_target_size_kb = max_size_kb * 0.9
while low_quality <= high_quality:
output_size_kb = save_img_with_quality(current_quality)
# self.log(f"current output quality: {current_quality}, current size: {output_size_kb}")
if output_size_kb <= max_size_kb and output_size_kb >= min_target_size_kb:
closest_quality = current_quality
break
if output_size_kb > max_size_kb:
high_quality = current_quality - 1
else:
low_quality = current_quality + 1
current_quality = (low_quality + high_quality) // 2
closest_quality = current_quality
# Save the image with the closest_quality
save_img_with_quality(closest_quality)
self.log(f'Saved img with quality of {closest_quality}')
else:
img.save(img_buffer, format='JPEG')
return bytearray(img_buffer.getvalue())
def main(args={}):
""" Example usage of the InstaxBLE class """
instax = InstaxBLE(**args)
try:
# To prevent misprints during development this script sends all the
# image data except the final 'go print' command. To enable printing
# uncomment the next line, or pass --print-enabled when calling
# this script
# instax.enable_printing()
instax.connect()
# Set a rainbow effect to be shown while printing and a pulsating
# green effect when printing is done
instax.send_led_pattern(LedPatterns.rainbow, when=1)
instax.send_led_pattern(LedPatterns.pulseGreen, when=2)
# you can also read the current accelerometer values if you want
# while True:
# instax.get_printer_orientation()
# sleep(.5)
# send your image (.jpg) to the printer by
# passing the image_path as an argument when calling
# this script, or by specifying the path in your code
if instax.image_path:
instax.print_image(instax.image_path)
else:
instax.print_image(instax.printerSettings['exampleImage'])
except Exception as e:
print(type(e).__name__, __file__, e.__traceback__.tb_lineno)
instax.log(f'Error: {e}')
finally:
sleep(60)
print('finally, disconnect')
instax.disconnect() # all done, disconnect
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('-a', '--device-address')
parser.add_argument('-n', '--device-name')
parser.add_argument('-p', '--print-enabled', action='store_true')
parser.add_argument('-d', '--dummy-printer', action='store_true')
parser.add_argument('-v', '--verbose', action='store_true')
parser.add_argument('-q', '--quiet', action='store_true')
parser.add_argument('-i', '--image-path', help='Path to the image file')
args = parser.parse_args()
main(vars(args))