FEATURE: Add command line interface

README.rst

@@ -164,6 +164,12 @@ Usage
 Open the Mopidy Web UI (i.e. ``http://{MOPIDY_IP}:6680/``).
 You should see a ``pummeluff`` web client which can be used to regsiter new RFID tags.
 
+## Command line interface
+
+You can also access pummeluff through the command line interface. Write `mopidy pummeluff [COMMAND]` with available commands:
+
+* `list`: Lists all the registered tags with the alias, action and parameter.
+
 Contribution
 ============
 

mopidy_pummeluff/__init__.py

@@ -8,6 +8,7 @@
 import pkg_resources
 
 from .frontend import PummeluffFrontend
+from .commands import PummeluffCommand
 from .web import ActionsHandler, LatestHandler, RegisterHandler, RegistryHandler, UnregisterHandler
 
 __version__ = pkg_resources.get_distribution('Mopidy-Pummeluff').version
@@ -81,3 +82,9 @@ def setup(self, registry):
             'name': self.ext_name,
             'factory': app_factory,
         })
+
+    def get_command(self):
+        '''
+        Setup the CLI interface.
+        '''
+        return PummeluffCommand()

mopidy_pummeluff/actions/base.py

@@ -34,7 +34,7 @@ def execute(cls, core):  # pylint: disable=unused-argument
 
     def __init__(self, uid, alias=None, parameter=None):
         '''
-        Concstructor.
+        Constructor.
         '''
         self.uid       = uid
         self.alias     = alias
@@ -106,3 +106,14 @@ def validate(self):
 
         if not parameterised and self.parameter:
             raise ValueError('No parameter allowed for this tag')
+
+class EmptyAction(Action):
+    '''
+    An action that represents nothing but an uuid.
+    '''
+
+    def __init__(self, uid, alias=None, parameter=None):
+        '''
+        Constructor.
+        '''
+        super().__init__(uid = uid, alias = alias, parameter = parameter)

mopidy_pummeluff/commands.py

@@ -0,0 +1,39 @@
+'''
+CLI Interface of this extension.
+'''
+
+import logging
+
+from mopidy import commands
+
+from .registry import REGISTRY
+
+
+logger = logging.getLogger(__name__)
+
+
+class PummeluffCommand(commands.Command):
+    '''
+    Main Command class.
+    '''
+    def __init__(self):
+        super().__init__()
+        self.add_child("list", ListCommand())
+
+    def run(self, args, config):
+        pass
+
+
+class ListCommand(commands.Command):
+    '''
+    Prints out the stored tags and their appropriate values on the terminal.
+    '''
+    def run(self, args, config):
+        '''
+        Prints out the stored tags and values on the terminal.
+        '''
+
+        for tag in REGISTRY.values():
+            logger.info("%s -> %s",tag, tag.as_dict())
+
+        return 0

mopidy_pummeluff/frontend.py

@@ -13,6 +13,7 @@
 from mopidy import core as mopidy_core
 
 from .threads import GPIOHandler, TagReader
+from .actions.base import EmptyAction
 
 LOGGER = getLogger(__name__)
 
@@ -29,8 +30,15 @@ def __init__(self, config, core):
         self.core         = core
         self.stop_event   = Event()
         self.gpio_handler = GPIOHandler(core=core, config=config, stop_event=self.stop_event)
-        self.tag_reader   = TagReader(core=core, stop_event=self.stop_event)
+        self.tag_reader   = TagReader(stop_event=self.stop_event, success_event=self.success_event)
 
+    def success_event(self, action):
+        '''
+        Invoke the action that was stored in the registry.
+        '''
+        if not isinstance(action, EmptyAction):
+            action(self.core)
+
     def on_start(self):
         '''
         Start GPIO handler & tag reader threads.
@@ -44,3 +52,4 @@ def on_stop(self):
         stop their operations.
         '''
         self.stop_event.set()
+

mopidy_pummeluff/threads/tag_reader.py

@@ -13,6 +13,7 @@
 from pirc522 import RFID  # pylint: disable=import-error
 from RPi import GPIO  # pylint: disable=import-error
 
+from mopidy_pummeluff.actions.base import EmptyAction
 from mopidy_pummeluff.actions.base import Action
 from mopidy_pummeluff.registry import REGISTRY
 from mopidy_pummeluff.sound import play_sound
@@ -38,17 +39,17 @@ class TagReader(Thread):
     daemon = True
     latest = None
 
-    def __init__(self, core, stop_event):
+    def __init__(self, stop_event, success_event):
         '''
         Class constructor.
 
-        :param mopidy.core.Core core: The mopidy core instance
         :param threading.Event stop_event: The stop event
+        :param success_event: callback method when a tag has been read successfully
         '''
         super().__init__()
-        self.core       = core
         self.stop_event = stop_event
         self.rfid       = RFID()
+        self.success_event = success_event
 
     def run(self):
         '''
@@ -107,12 +108,12 @@ def handle_uid(self, uid):
             action = REGISTRY[str(uid)]
             LOGGER.info('Triggering action of registered tag')
             play_sound('success.wav')
-            action(self.core)
 
         except KeyError:
             LOGGER.info('Tag is not registered, thus doing nothing')
             play_sound('fail.wav')
-            action = Action(uid=uid)
-
+            action = EmptyAction(uid=uid)
+
+        self.success_event(action)
         action.scanned   = time()
         TagReader.latest = action