Merge branch 'master' of github.com:FarsetLabs/doorbot

Conflicts:
	doorbot/interfaces.py

README.md

@@ -1,22 +1,26 @@
-python-package-boilerplate
-==========================
+# Doorbot
 
-[![Build Status](https://travis-ci.org/mtchavez/python-package-boilerplate.png?branch=master)](https://travis-ci.org/mtchavez/python-package-boilerplate)
+==========================
 
-Boilerplate for a Python Package
+Doorbot Package for Farset Labs
 
 ## Package
 
 Basic structure of package is
 
 ```
---- packagename
-  \ packagename.py
+--- doorbot
+  \ doorbot.py
   \ version.py
+  \ interfaces.py
+  \ jsonify.py
+  \ views.py
 --- tests
   \ tests_helper.py
   --- unit    # Unit Tests
   --- helpers # Test Helpers
+\ Doorbot.apache.conf
+\ doorbot.wsgi
 \ requirements.txt
 \ setup.py
 ```
@@ -29,6 +33,86 @@ Package requirements are handled using pip. To install them do
 pip install -r requirements.txt
 ```
 
+## Setup
+
+Doorbot is designed to be setup under `/opt/`, where `Doorbot.apache.conf` is copied into the Apache `sites-available` directory (usually `/etc/apache2/sites-available`)
+
+Then, enable the site with `sudo a2ensite Doorbot.apache.conf; sudo service apache2 reload`
+
+## Configuration
+
+Doorbot is configured using two JSON dotfiles in the operating-users home directory (`/home/username`, depending on usecase)
+
+### `.doorbot_users`
+
+Contains authentication information of the form:
+
+  { "username": "PassWord", "otheruser":"otherPass" }
+
+These are 'authorised accounts' that can perform admin tasks, specifically opening the doors.
+
+The intention is not for this file to be populated with each and every member or user of the system, but rather that authentication responsibility is delegated to secondary systems, eg a web front end, RFID reader, etc. Muliple usernames are enabled to support service-based monitoring (as in the RFID would have it's own username, etc.)
+
+
+### `.doorbot_config`
+
+Multiple doors can be configured based on the available interfaces. There is also a `dummy` interface that provides logging-based debugging.
+
+In the case of the `piface` interface, the `interfaceopt` is the output port which triggers the doors opening/unlocking.
+
+  {
+      'doors':[
+          {'door_name':"Front Door",
+           'doorid':"front",
+          'interface': "piface",
+          'interfaceopt':0},
+
+          {'door_name':"Back Door",
+           'doorid':"back",
+          'interface': "piface",
+          'interfaceopt':1},
+      ]
+  }
+
+## API Routes
+
+### `/`
+
+Dummy 'Hello World', shuold probably be populated with an api catalogue
+
+### `/open/<doorid>`
+
+Authenticated route: opens the given doorid based on the `doorbot_config`
+
+### `/status`
+
+Currently Authenticated but doesn't need to be; returns a list of the doorids
+
+## Current Hardware Config in Farset Labs
+
+### Wiring
+
+Inside the enclosure above the network rack in the co-working space, the piface as as wired up as it needs to be for the foreseeable.
+
+**IF ANYONE WANTS TO INTERFACE WITH OR EVEN CONSIDER OPENING THE ENCLOSURE, WRITTEN DIRECTOR CONFIRMATION IS REQUIRED IN ADVANCE AND THE ENCLOSURE MUST BE RESEALED BY A DIRECTOR OR NEM AFTERWARDS**
+
+There are 12 interface lines wired up to the terminal strip in the top lid of the enclosure; they are split into two 'sectors' of 6, which represent the two proposed 'door' controls, with the front door on the 'left' and the currently unpopulated back door on the right.
+
+| Terminal No | Connection | Notes                                |
+| ----------- | ---------- | ------------------------------------ |
+| 1           | Relay 0 NO | Front Door Keypad Input (Blue)       |
+| 2           | Relay 0 C  | Front Door Keypad Input (Blue/White) |
+| 3           | Input 0    | Front Door Not Used (Green)          |
+| 4           | Ground     | Front Door Not Used (Green/White)    |
+| 5           | Output 2   | Front Door Not Used (Orange)         |
+| 6           | +5v        | Front Door Not Used (Orange/White)   |
+| 7           | Relay 1 NO | Back Door Not Wired                  |
+| 8           | Relay 1 C  | Back Door Not Wired                  |
+| 9           | Input 1    | Back Door Not Wired                  |
+| 10          | Ground     | Back Door Not Wired                  |
+| 11          | Output 3   | Back Door Not Wired                  |
+| 12          | +5v        | Back Door Not Wired                  |
+
 ## Tests
 
 Testing is set up using [pytest](http://pytest.org) and coverage is handled
@@ -39,13 +123,13 @@ Run your tests with ```py.test``` in the root directory.
 Coverage is ran by default and is set in the ```pytest.ini``` file.
 To see an html output of coverage open ```htmlcov/index.html``` after running the tests.
 
+There are no currently valid tests yet.
+
 ## Travis CI
 
 There is a ```.travis.yml``` file that is set up to run your tests for python 2.7
 and python 3.2, should you choose to use it.
 
 ## License
 
-Written by Chavez
-
 Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

doorbot/doorbot.py

@@ -11,26 +11,17 @@
 user_db = json.load(
     open(os.path.expanduser("~/.doorbot_users"), 'r')
 )
+config_settings = json.load(
+    open(os.path.expanduser("~/.doorbot_config"), 'r')
+)
 
 @auth.get_password
 def get_pw(username):
     if username in user_db:
         return user_db.get(username)
     return None
 
-config_settings = {
-    'doors':[
-        {'door_name':"Front Door",
-         'doorid':"front",
-        'interface': "piface",
-        'interfaceopt':0},
-
-        {'door_name':"Back Door",
-         'doorid':"back",
-        'interface': "piface",
-        'interfaceopt':1},
-    ]
-}
+
 
 
 

doorbot/interfaces.py

@@ -1,4 +1,5 @@
 import time
+from doorbot import app
 
 def pick(choice):
     """
@@ -7,10 +8,16 @@ def pick(choice):
     :return:
     """
 
-    return {
+    candidate_cls = {
         'dummy': Dummy,
         'piface':PiFace
     }.get(choice)
+    try:
+        candidate_cls.import_prerequisites()
+        return candidate_cls
+    except ImportWarning as e:
+        app.log.error("Prequsite Failed, loading dummy interface: {}".format(e))
+        return Dummy
 
 
 class Abstract_Interface(object):
@@ -67,6 +74,12 @@ def __repr__(self):
 
         return("{type}(door_name=\"{door_name}\")".format(door_name=self.door_name, type=self.__class__.__name_))
 
+    @classmethod
+    def import_prerequisites(cls):
+        """
+        Lay the ground work
+        """
+        pass
 
 class Logging_MixIn(Abstract_Interface):
     """
@@ -138,10 +151,6 @@ class PiFace(Logging_MixIn):
     open_time = None
 
     def __init__(self, *args, **kwargs):
-        try:
-            import pifacedigitalio
-        except ImportError:
-            raise ImportWarning("No PiFaceDigitalIO Module, Cannot instantiate PiFace")
 
         super(PiFace, self).__init__(*args, **kwargs)
         self.open_time = "Never"
@@ -181,3 +190,14 @@ def __repr__(self):
         """
 
         return("{type}(door_name=\"{door_name}\", open={status}, open_time={open_time}, relay={relay})".format(door_name=self.door_name, type=self.__class__.__name__, status=self.is_open(), relay=self.relay, open_time=self.open_time))
+
+    @classmethod
+    def import_prerequisites(cls):
+        """
+        Lay the ground work
+        """
+        try:
+            import pifacedigitalio
+        except ImportError:
+            raise ImportWarning("No PiFaceDigitalIO Module, Cannot instantiate PiFace")
+