ganglion: fix API to integrate it to user.py, docs

Author: jfrey-xx

README.md

@@ -21,7 +21,7 @@ For additional details on connecting your board visit: http://docs.openbci.com/t
 
 ### Ganglion Board
 
-The Ganglion board relies on Bluetooth Low Energy connectivity (BLE). You should also retrieve the bluepy submodule for a more up-to-date version. To do so, clone this repo with the `--recursive` flag then type `make` inside `bluepy/bluepy`. Note that you may need to run the script with root privileges to for some functionality, e.g. auto-detect MAC address.
+The Ganglion board relies on Bluetooth Low Energy connectivity (BLE). You should also retrieve the bluepy submodule for a more up-to-date version than the version `1.0.5` available at that time through `pip`. To do so, clone this repo with the `--recursive` flag then type `make` inside `bluepy/bluepy`. Note that you may need to run the script with root privileges to for some functionality, e.g. auto-detect MAC address.
 
 ## Audience:
 

open_bci_ganglion.py

@@ -59,6 +59,9 @@ class OpenBCIBoard(object):
 
   def __init__(self, port=None, baud=0, filter_data=False,
     scaled_output=True, daisy=False, log=True, timeout=-1, max_packets_to_skip=20):
+    # unused, for compatibility with Cyton v3 API
+    self.daisy = False
+    
     self.log = log # print_incoming_text needs log
     self.streaming = False
     self.timeout = timeout
@@ -127,9 +130,9 @@ def init_steaming(self):
     self.time_last_packet = timeit.default_timer() 
 
   def find_port(self):
-    """DetectsGanglion board MAC address -- if more than 1 around, will select first. Needs root privilege."""
+    """Detects Ganglion board MAC address -- if more than 1 around, will select first. Needs root privilege."""
 
-    print("Try to detect Ganglion MAC address. NB: Turn on bluetooth and run as root for this to work!")
+    print("Try to detect Ganglion MAC address. NB: Turn on bluetooth and run as root for this to work! Might not work with every BLE dongles.")
     scan_time = 5
     print("Scanning for 5 seconds nearby devices...")
 
@@ -368,7 +371,6 @@ def parse(self, packet):
 
   def parseRaw(self, sample_id, packet):
     """ Dealing with "Raw uncompressed" """
-    print ("Raw uncompressed")
     chan_data = []
     # 4 channels of 24bits, take values one by one
     for i in range(0,12,3):

user.py

@@ -19,7 +19,8 @@
 
     print ("------------user.py-------------")
     parser = argparse.ArgumentParser(description="OpenBCI 'user'")
-    parser.add_argument('--board', default=3, type=int)
+    parser.add_argument('--board', default="cyton", 
+                        help="Choose between [cyton] and [ganglion] boards.")
     parser.add_argument('-l', '--list', action='store_true',
                         help="List available plugins.")
     parser.add_argument('-i', '--info', metavar='PLUGIN',
@@ -54,11 +55,11 @@
     if not(args.add):
         print ("WARNING: no plugin selected, you will only be able to communicate with the board. You should select at least one plugin with '--add [plugin_name]'. Use '--list' to show available plugins or '--info [plugin_name]' to get more information.")
 
-    if args.board == 3:
-        print ("Board type: open_bci_v3...")
+    if args.board == "cyton":
+        print ("Board type: OpenBCI Cyton (v3 API)")
         import open_bci_v3 as bci
-    elif args.board == 4:
-        print ("Board type: open_bci_v_ganglion...")
+    elif args.board == "ganglion":
+        print ("Board type: OpenBCI Ganglion")
         import open_bci_ganglion as bci
     else:
         raise ValueError(