Version 1.0.0

Author: meltaxa

99-lego.rules

@@ -0,0 +1 @@
+SUBSYSTEM=="usb", ATTR{idVendor}=="0e6f", ATTR{idProduct}=="0241", MODE="0666"

README.md

@@ -0,0 +1,34 @@
+# Jukebox Portal
+
+Listen to songs, albums or playlists by placing a LEGO minifigure on the 
+LEGO Dimensions pad and enjoy the audio and light show!
+<p align="center">
+  <img src="https://cdn-images-1.medium.com/max/800/1*v3m7mg7Y_Vzy2y8O8gKXMQ.jpeg" alt="Jukebox Portal close up"/>
+</p>
+The "toys-to-life" LEGO Dimensions console game was discontinued in October 2017. 
+Now you can bring it back to life as a Spotify controller by connecting the USB 
+toy pad to a Raspberry Pi and running this Jukebox Portal app.
+<p/>
+Spotify control is not limited to LEGO minifigures. Disney Infinity 
+characters, NFC tags, stickers or cards can be assigned to a Spotify song, 
+album or playlist too.
+
+While the light show plays for the duration of the track, on the Jukebox Portal 
+web app, the album art of the current track is displayed. 
+<p align="center">
+  <img src="https://cdn-images-1.medium.com/max/640/1*A4Dv2PbAeniEmNKmR2469g.png" alt="Jukebox Portal screen shot"/>
+</p>
+
+# You will require
+
+* A Spotify Premium subscription account.
+
+and...
+
+| Hardware | NFC tags |
+| --- | --- |
+| <img src="https://cdn-images-1.medium.com/max/400/1*CAcSKjlKsD9Ld-iuKsCY-Q.jpeg"><br><ul><li>Raspberry Pi with Python 3.8 installed.</li><li>LEGO Dimensions pad from either a PS3, PS4 or Wii game console. The Xbox version is not supported.</li></ul>| <img src="https://cdn-images-1.medium.com/max/400/1*UtAav5Iu2iOGxoS7a1nzTg.png"><br>From Lego Dimensions character discs, Disney Infinity character toys, NFC NTAG213 tags, stickers or cards. |
+
+# Install
+
+* Installation instructions is available in the Medium article "[My LEGO Minifigures Play Spotify](https://medium.com/@mellican/my-lego-minifigures-play-spotify-dc397e83280e)".

VERSION

@@ -0,0 +1 @@
+1.0.0

app/__init__.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+
+from app import webhook
+from flask import Flask, render_template
+from logging.config import dictConfig
+import os
+import logging
+
+logging.config.dictConfig({
+    'version': 1,
+    'formatters': {'default': {
+        'format': '[%(asctime)s] %(levelname)s: %(message)s',
+    }},
+    'handlers': {'wsgi': {
+        'class': 'logging.StreamHandler',
+        'stream': 'ext://flask.logging.wsgi_errors_stream',
+        'formatter': 'default'
+    }},
+    'root': {
+        'level': 'INFO',
+        'handlers': ['wsgi']
+    }
+})
+logging.getLogger('werkzeug').disabled = True
+logger = logging.getLogger(__name__)
+os.environ['WERKZEUG_RUN_MAIN'] = 'true'
+
+app = Flask(__name__,
+            static_url_path='', 
+            static_folder='templates')
+
+@app.errorhandler(404)
+def not_found(error):
+    return render_template('404.html'), 404
+
+app.config.from_object('config')
+if app.config['USAGE']:
+    webhook.Requests.post("https://maker.ifttt.com/trigger/usage/with/key/%s" % app.config['USAGE_API'],
+                          {'value1': app.config['VERSION'],
+                           'value2': 'started.'})
+
+with app.app_context(), app.test_request_context():
+    from app.spotify import spotify as spotify_module
+    app.register_blueprint(spotify_module)
+    logger.info('Application started.')

app/lego.py

@@ -0,0 +1,171 @@
+#!/usr/bin/env python
+
+from app import webhook
+import app.spotify as spotify
+import app.tags as nfctags
+import binascii
+import logging
+import threading
+import time
+import random
+import usb.core
+import usb.util
+
+logger = logging.getLogger(__name__)
+
+class Dimensions():
+
+    def __init__(self):
+        try:
+           self.dev = self.init_usb()
+        except Exception:
+            return
+
+    def init_usb(self):
+        dev = usb.core.find(idVendor=0x0e6f, idProduct=0x0241)
+
+        if dev is None:
+            logger.error('Lego Dimensions pad not found')
+            raise ValueError('Device not found')
+
+        if dev.is_kernel_driver_active(0):
+            dev.detach_kernel_driver(0)
+
+        # Initialise portal
+        dev.set_configuration()
+        dev.write(1,[0x55, 0x0f, 0xb0, 0x01, 0x28, 0x63, 0x29, 0x20, 0x4c, 
+                     0x45, 0x47, 0x4f, 0x20, 0x32, 0x30, 0x31, 0x34, 0xf7, 
+                     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+                     0x00, 0x00, 0x00, 0x00, 0x00])
+        return dev
+
+    def send_command(self, command):
+        checksum = 0
+        for word in command:
+            checksum = checksum + word
+            if checksum >= 256:
+                checksum -= 256
+            message = command+[checksum]
+
+        while(len(message) < 32):
+            message.append(0x00)
+
+        try:
+            self.dev.write(1, message)
+        except Exception:
+            pass
+
+    def switch_pad(self, pad, colour):
+        self.send_command([0x55, 0x06, 0xc0, 0x02, pad, colour[0], 
+                          colour[1], colour[2],])
+        return
+
+    def fade_pad(self, pad, pulse_time, pulse_count, colour):
+        self.send_command([0x55, 0x08, 0xc2, 0x0f, pad, pulse_time, 
+                          pulse_count, colour[0], colour[1], colour[2],])
+        return
+
+    def flash_pad(self, pad, on_length, off_length, pulse_count, colour):
+        self.send_command([0x55, 0x09, 0xc3, 0x03, pad, 
+                          on_length, off_length, pulse_count, 
+                          colour[0], colour[1], colour[1],])
+        return
+
+    def update_nfc(self):
+        try:
+            inwards_packet = self.dev.read(0x81, 32, timeout = 10)
+            bytelist = list(inwards_packet)
+            if not bytelist:
+                return
+            if bytelist[0] != 0x56:
+                return
+            pad_num = bytelist[2]
+            uid_bytes = bytelist[6:13]
+            identifier = binascii.hexlify(bytearray(uid_bytes)).decode("utf-8")
+            identifier = identifier.replace('000000','')
+            removed = bool(bytelist[5])
+            if removed:
+                response = 'remove:%s:%s' % (pad_num, identifier)
+            else:
+                response = 'added:%s:%s' % (pad_num, identifier)
+            return response
+        except Exception:
+            return
+
+class Base():
+    def __init__(self):
+        self.OFF   = [0,0,0]
+        self.RED   = [255,0,0]
+        self.GREEN = [0,255,0]
+        self.BLUE  = [0,0,255]
+        self.PINK = [255,192,203]
+        self.ORANGE = [255,165,0]
+        self.PURPLE = [255,0,255]
+        self.LBLUE = [255,255,255]
+        self.OLIVE = [128,128,0]
+        self.COLOURS = ['self.RED', 'self.GREEN', 'self.BLUE', 'self.PINK', 
+                        'self.ORANGE', 'self.PURPLE', 'self.LBLUE', 'self.OLIVE']
+        self.base = self.startLego()
+
+    def randomLightshow(self,duration = 60):
+        logger.info("Lego light show started for %s seconds" % duration)
+        self.lightshowThread = threading.currentThread()
+        t = time.perf_counter()
+        while getattr(self.lightshowThread, "do_run", True) and (time.perf_counter() - t) < duration:
+            pad = random.randint(0,2)
+            self.colour = random.randint(0,len(self.COLOURS)-1)
+            self.base.switch_pad(pad,eval(self.COLOURS[self.colour]))
+            time.sleep(round(random.uniform(0,0.5), 1))
+        self.base.switch_pad(0,self.OFF)
+
+    def startLightshow(self,duration_ms):
+        self.lightshowThread = threading.Thread(target=self.randomLightshow,
+            args=([(duration_ms / 1000)]))
+        self.lightshowThread.start()
+
+    def startLego(self):
+        nfc = nfctags.Tags()
+        nfc.load_tags()
+        self.base = Dimensions()
+        logger.info("Lego Dimensions base activated.")
+        self.base.switch_pad(0,self.GREEN)
+        while True:
+            tag = self.base.update_nfc()
+            if tag:
+                status = tag.split(':')[0]
+                pad = int(tag.split(':')[1])
+                identifier = tag.split(':')[2]
+                if status == 'added':
+                    self.base.switch_pad(pad = pad, colour = self.BLUE)
+
+                    # Reload the tags config file
+                    nfc.load_tags()
+                    tags = nfc.tags
+
+                    # Stop any current songs and light shows
+                    try:
+                        self.lightshowThread.do_run = False
+                        self.lightshowThread.join()
+                    except Exception:
+                        pass
+
+                    if (identifier in tags['identifier']):
+                        # A tag has been matched
+                        if ('slack' in tags['identifier'][identifier]):
+                            webhook.Requests.post(tags['slack_hook'],{'text': tags['identifier'][identifier]['slack']})
+                        if ('spotify' in tags['identifier'][identifier]):
+                            try:
+                                position_ms = int(tags['identifier'][identifier]['position_ms'])
+                            except Exception:
+                                position_ms = 0
+                            duration_ms = spotify.spotcast(tags['identifier'][identifier]['spotify'],
+                                                           position_ms)
+                            if duration_ms > 0:
+                                self.startLightshow(duration_ms)
+                            else:
+                                self.base.flash_pad(pad = pad, on_length = 10, off_length = 10,
+                                                    pulse_count = 6, colour = self.RED)
+                    else:
+                        # Unknown tag. Display UID.
+                        logger.info('Lego unknown tag detected: %s' % identifier)
+                        self.base.switch_pad(pad, self.RED)