Merge pull request #1 from MartinStej/dev

Fixed problem with (possible) nonsesne message due to insufficient rights

HISTORY.rst

@@ -2,6 +2,13 @@
 History
 =======
 
+0.9.8 (2018-05-04)
+------------------
+* Added information how to access device s regular user (sudo not needed)
+* Added verbose option
+* When communication with device will fail, more friendly message is shown
+* Updated links in documentation
+
 0.9.0 (2017-06-13)
 ------------------
 

README.rst

@@ -130,6 +130,13 @@ which will be expanded to the same thing.
 Notes
 -----
 * Tested on Linux with Python 2.7, 3.2, 3.3 and 3.4
+* If you have **problems with permissions**, you can always use ``sudo``, but
+  better way is create rule for udev. Create file 
+  `/etc/udev/rules.d/11-alps_devices.rules`
+  and paste there following line:
+  ``SUBSYSTEM=="usb", MODE="0644", GROUP="plugdev"``.
+  Unplug USB device, restart udev, plug USB device and try again. Also make
+  sure you are at group ``plugdev``
 * Tested on Windows XP and Windows 7 with Python 2.7 (but it should work on
    version 3.2, 3.3 and so on)
 * For more info run application with "-h" parameter

concon/__init__.py

@@ -7,4 +7,4 @@
 
 __author__ = """Martin Stejskal"""
 __email__ = '[email protected]'
-__version__ = '0.9.5'
+__version__ = '0.9.8'

concon/cli.py

@@ -17,9 +17,9 @@
 DEFAULT_CONFIG = 'config/config.yml'
 DEFAULT_LOG_CONFIG = 'config/logging_global.cfg'
 
-
 # logging.basicConfig(level=logging.DEBUG)
-logger = logging.getLogger('UCA console')
+logger = logging.getLogger('ConCon')
+
 
 
 def report_errors(err):
@@ -34,13 +34,25 @@ def report_errors(err):
               help="Application specific configuration file.")
 @click.option('-d', '--device', default=None,
               help="Selected device to configure.")
+@click.option('--verbose/--quiet', default=False,
+              help="Enable / disable logging to Log.txt file")
 @click.pass_context
-def main(ctx, config, device, args=None):
+def main(ctx, config, device, verbose, args=None):
     """Tool for configuration of devices implementing "Uniprot" communication
     layer over USB (HID profile).
     """
     ctx.obj = {}
     logging.basicConfig(level=logging.ERROR)
+
+    # Check if verbose mode is on
+    if(verbose):
+        logging.config.fileConfig(
+        pkg_resources.resource_filename('concon',
+                                        DEFAULT_LOG_CONFIG),
+        None,
+        False)
+    # /if verbose
+
     # TODO: Config doesn't work...
     # logging.config.fileConfig(
     #     pkg_resources.resource_filename('concon', DEFAULT_LOG_CONFIG)
@@ -89,7 +101,7 @@ def main(ctx, config, device, args=None):
             # Show device selection prompt
             click.secho("More than one configurable devices detected.\n"
                         "Choose one from below and run concon with"
-                        " -d [0 ~ {0}] option.".format(len(found_devices)-1),
+                        " -d [0 ~ {0}] option.".format(len(found_devices) - 1),
                         fg='yellow')
             ctx.invoke(device_list)
             raise click.Abort()
@@ -99,12 +111,11 @@ def main(ctx, config, device, args=None):
         except (IndexError, ValueError):
             report_errors('Invalid device number "{0}". '
                           'Choose between 0~{1}'.format(device,
-                                                        len(found_devices)-1))
+                                                        len(found_devices) - 1))
             ctx.invoke(device_list)
             raise click.Abort()
 
 
-
 @main.command()
 @click.argument("file_name")
 @click.pass_context
@@ -124,7 +135,7 @@ def write(ctx, file_name):
         click.echo("Reading configuration from: {0}".format(file_name))
         cfg_pars.read_setting_from_file(file_name,
                                         ignore_errors=False,
-                                        try_fix_errors=True)
+                                        try_fix_errors=False)
 
         # And send changes to device
         label = "Writing configuration to {0}".format(device.name)
@@ -177,5 +188,6 @@ def device_list(ctx):
         click.echo(" Dev# {0} <{1}>".format(
             i, found_devices[i].name))
 
+
 if __name__ == "__main__":
     main()

concon/config/logging_global.cfg

@@ -9,13 +9,13 @@ keys=time_name_lvl_msg,name_lvl_msg
 
 [logger_root]
 level=DEBUG
-handlers=consoleHandler,LogFileHandler
-qualname=UCA console
+handlers=LogFileHandler
+qualname=ConCon
 propagate=0
 
 [logger_Bridge_HW_uniprot]
 level=DEBUG
-handlers=consoleHandler,LogFileHandler
+handlers=LogFileHandler
 qualname=Bridge HW <---> uniprot
 propagate=0
 
@@ -27,7 +27,7 @@ propagate=0
 
 [logger_Bridge_config_parser]
 level=DEBUG
-handlers=consoleHandler,LogFileHandler
+handlers=LogFileHandler
 qualname=Bridge config parser
 propagate=0
 

concon/core.py

@@ -106,6 +106,6 @@ def set_from_file(self, file_name):
                                       self._config['usb']['timeout'])
         cfg_pars.read_setting_from_file(file_name,
                                         ignore_errors=False,
-                                        try_fix_errors=True)
+                                        try_fix_errors=False)
 
         cfg_pars.write_setting_to_device()

concon/usb_driver/linux/usb_driver_linux.py

@@ -210,8 +210,18 @@ def usb_list_connected_devices(vid=None):
         {'find_all': True, }
     devices = []
 
-    for device in usb.core.find(**kwargs):
-        name = device.product or device.address
-        uid = device.bus * 0xff + device.address
-        devices.append((name, device.idVendor, device.idProduct, uid))
+    # Following may fail if user does not have sufficient rights
+    try:
+        for device in usb.core.find(**kwargs):
+            name = device.product or device.address
+            uid = device.bus * 0xff + device.address
+            devices.append((name, device.idVendor, device.idProduct, uid))
+    except ValueError as e:
+        msg = "{}\n\n"\
+              "It looks like you can not access USB devices."\
+              " Maybe insufficient rights?\n"\
+              "Please check if you can read/write to USB devices (refer to "\
+              "README file)"\
+              "".format(e)
+        raise Exception(msg)
     return devices

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.9.5
+current_version = 0.9.8
 commit = True
 tag = True
 

setup.py

@@ -32,7 +32,7 @@
 
 setup(
     name='concon',
-    version='0.9.5',
+    version='0.9.8',
     description="Universal configuration tool for USB devices implementing the Uniprot (HID) communication layer.",
     long_description=readme + '\n\n' + history,
     author="Martin Stejskal",