Merge pull request #47 from Rexeh/1.3

Version 1.3 Merge

Author: Rexeh

config.cfg

@@ -1,4 +1,7 @@
-[DEFAULT]
+[Preferences]
+NoBindText = No Bind
+
+[Logging]
 EnableLogging = 1
 # 1 = Minimum, 3 = Full Debug
 LogLevel = 1

dill.dll

@@ -2,59 +2,13 @@
 
 ![Joystick Diagrams](https://s3-eu-west-1.amazonaws.com/joystick-diagram.com/Joystick-Diagram-info.png#2)
 
-## Current Release (1.2.1) - 23/01/2020
+# Official Website
+http://joystick-diagram.com/
 
-### What's new?
-
-- Hotfix to DCS folder structure crashing app
-
-[Release Notes - V1.2.1](https://github.com/Rexeh/joystick-diagrams/releases/tag/V1.2.1)
-
-[Download - Joystick Diagrams (V1.2.1)](https://github.com/Rexeh/joystick-diagrams/releases/download/V1.2.1/joystick_diagrams_1_2_1.zip)
-
-## What is this tool for?
-Learning flight simulators is a daunting task, with lots of buttons to remember. I built this tool for myself, and then thought others might also enjoy it, automating what is a time consuming task!
-
-- Export your joystick/throttle/custom HID buttons to a SVG, and print with your browser
-- Overlay your buttons onto an actual Joystick profile/picture
-- Learn your joystick setup easier and be a better pilot!
-
-## What it's do?
-
-### General
-- Custom SVG templates can be built to suit your joystick, throttle, custom HID device
-- Diagram style only limited by your design skills! :)
-
-### Joystick Gremlin
-- Importing/inheriance of base templates into button profile exports
-- Support for multiple profiles in Joystick Gremlin
-
-### DCS World
-- Export any of your plane/helicopter configurations to diagram
-- Select which profiles you want to export
-
-## What's it not do?
-- Output POV hats (Coming V1.3)
-- Output AXIS binds (Coming V1.3)
-- Make toast
-
-### Support for other games
-Have a game you want support added for? Get in touch, send me configs and I'll take a look
-
-## Installation
-None required, extract the latest .zip, and run joystick-diagrams.exe
-
-### From Source
-Want to run from source? You'll need Python 3.8+
-Use setup.py to get up and running
-
-# Templates/Supported Joysticks
-It comes with a set of templates for popular sticks/throttles, but you're also able to create your own with ease!
-
-[Please read the about templates here](templates/readme.md)
+Please use the website for documentation and information
 
 # Bugs
-This is still an early release, if you find any bugs, or think you have a slightly different configuration that I might not support let me know!
+This project is still early days, if you encounter any issues please raise a bug ticket or reach out on Discord.
 
 # Support / Beer fund
 

images/discord.png

@@ -6,8 +6,8 @@
 import ply.yacc as yacc
 import functions.helper as helper
 import adaptors.joystick_diagram_interface as jdi
-import adaptors.dcs_world_lex # Do not remove - PLY production requirement
-import adaptors.dcs_world_parse # Do not remove - PLY production requirement
+import adaptors.dcs_world_lex # pylint: disable=unused-import
+import adaptors.dcs_world_parse # pylint: disable=unused-import
 
 class DCSWorld_Parser(jdi.JDinterface):
 
@@ -62,15 +62,26 @@ def __validateProfile(self, item):
     def getValidatedProfiles(self):
         ''' Expose Valid Profiles only to UI '''
         if self.remove_easy_modes:
-                return list(filter(lambda x: False if self.__easy_mode in x else True, self.valid_profiles))
+            return list(filter(lambda x: False if self.__easy_mode in x else True, self.valid_profiles))
         else:
             return self.valid_profiles
 
     def convert_button_format(self, button):
         ''' Convert DCS Buttons to match expected "BUTTON_X" format '''
-        new = button.split('_')[1]
-        rep = new.replace("BTN", "BUTTON_")
-        return rep
+        split = button.split('_')
+
+        if len(split) == 2:
+            if split[1][0:3] == "BTN":
+                return split[1].replace("BTN","BUTTON_")
+            elif split[1].isalpha():
+                return "AXIS_{}".format(split[1])
+            elif split[1][0:6] == "SLIDER":
+                return "AXIS_SLIDER_{}".format(split[1][6:])
+            else:
+                return split[1]
+
+        elif len(split) == 4:
+            return "{button}_{pov}_{dir}".format(button = split[1].replace("BTN","POV"), pov = split[2][3], dir = split[3])
 
     def processProfiles(self, profile_list=[]):
         if len(profile_list)>0:
@@ -99,25 +110,46 @@ def processProfiles(self, profile_list=[]):
                     except FileNotFoundError:
                         raise FileExistsError("DCS: File {} no longer found - It has been moved/deleted from directory".format(joystick_file))
                     else:
-                        data = self.parseFile()
-                        writeVal = False
-                        buttonArray = {}
-                        if 'keyDiffs' in data.keys():
-                            for value in data['keyDiffs'].values():
-                                for item, attribute in value.items():
-                                    if item=='name':
-                                        name = attribute
-                                    if item=='added':
-                                        button = self.convert_button_format(attribute[1]['key'])
-                                        writeVal = True
-                                if writeVal:
-                                    buttonArray.update({
-                                        button : name
-                                    })
-                                    writeVal = False
-                            self.update_joystick_dictionary(joystick_device,profile, False, buttonArray)
+                        dictionary_2 = self.parseFile()
+  
+                        button_map = self.create_joystick_map(dictionary_2)
+
+                        self.update_joystick_dictionary(joystick_device,profile, False, button_map)
         return self.joystick_dictionary
 
+    def create_joystick_map(self, data):
+        writeVal = False
+        buttonArray = {}
+
+        if 'keyDiffs' in data.keys():
+            for value in data['keyDiffs'].values():
+                for item, attribute in value.items():
+                    if item=='name':
+                        name = attribute
+                    if item=='added':
+                        button = self.convert_button_format(attribute[1]['key'])
+                        writeVal = True
+                if writeVal:
+                    buttonArray.update({
+                            button : name
+                    })
+                    writeVal = False
+
+        if 'axisDiffs' in data.keys():
+            for value in data['axisDiffs'].values():
+                for item, attribute in value.items():
+                    if item=='name':
+                        name = attribute
+                    if item in ['added', 'changed']:
+                        axis = self.convert_button_format(attribute[1]['key'])
+                        writeVal = True
+                if writeVal:
+                    buttonArray.update({
+                            axis : name
+                    })
+                    writeVal = False
+        return buttonArray
+
     def parseFile(self):
         # pylint: disable=unused-variable
         tokens = ('LCURLY', 'RCURLY', 'STRING', 'NUMBER', 'LBRACE', 'RBRACE', 'COMMA', 'EQUALS', 'TRUE', 'FALSE', 'DOUBLE_VAL')
@@ -216,5 +248,6 @@ def p_error(t):
         try:
             data = parser.parse(self.file)
         except Exception as error:
-            print(error)
+            helper.log(error, "error")
+            raise ("DCS Parser Exception")
         return data

images/donate.png

@@ -9,7 +9,7 @@ def __init__(self):
     def update_joystick_dictionary(self, device, mode, inherit, buttons):
         data = {
             "Buttons": buttons,
-            "Axis": "",
+            "Axis": '',
             "Inherit": inherit}
 
         if device in self.joystick_dictionary:

readme.md

@@ -25,6 +25,16 @@ def __init__(self,filepath):
         self.buttonArray = None
         self.inheritModes = {}
         self.usingInheritance = False
+        self. position_map = {
+        1 : 'U',
+        2 : 'UR',
+        3 : 'R',
+        4 : 'DR',
+        5 : 'D',
+        6 : 'DL',
+        7 : 'L',
+        8 : 'UL'
+    }
 
     def get_device_names(self):
         self.devices = self.getDevices()
@@ -64,7 +74,9 @@ def createDictionary(self, profiles=[]):
                 self.currentMode = self.getSingleMode()
                 helper.log("Selected Mode: {}".format(self.currentMode), 'debug')
                 self.buttons = self.getModeButtons()
+                self.hats = self.getModeHats()
                 self.extractButtons()
+                self.extractHats()
                 self.update_joystick_dictionary(self.currentdevice,
                                     self.currentMode,
                                     self.currentInherit,
@@ -92,6 +104,9 @@ def getDevices(self):
     def getModeButtons(self):
         return self.mode.getElementsByTagName('button')
 
+    def getModeHats(self):
+        return self.mode.getElementsByTagName('hat')
+
     def getDeviceModes(self):
         return self.device.getElementsByTagName('mode')
 
@@ -125,5 +140,55 @@ def extractButtons(self):
                 })
         return self.buttonArray
 
+    def extractHats(self):
+
+        for i in self.hats:
+            hat_id = i.getAttribute('id')
+            helper.log("Hat ID: {}".format(hat_id), 'debug')
+
+            if i.getAttribute('description'):
+                hat_description = i.getAttribute('description')
+                helper.log("Hat has description: {}".format(hat_description), 'debug')
+            else:
+                hat_description = ''
+
+            hat_containers = i.getElementsByTagName('container')
+
+            if(hat_containers):
+                helper.log("Has containers: {}".format(hat_containers.length), 'debug')
+
+                for c in hat_containers:
+                    
+                    hat_positions = c.getElementsByTagName('action-set')
+                    hat_count = hat_positions.length
+                    increment = 8/hat_count
+                    pos = 1
+                    helper.log("We have {} hat positions".format(hat_count), 'debug')
+
+                    for hp in hat_positions:
+
+                        if hp.getElementsByTagName('description'):
+                            # Ignore more than 1 description. always use first
+                            hat_direction_description = hp.getElementsByTagName('description')[0].getAttribute('description')
+                        else:
+                            hat_direction_description = hat_description
+
+                        helper.log("POV Position: {}".format(self.position_map[pos]), 'debug')
+
+                        self.buttonArray.update ({
+                        'POV_{ID}_{DIR}'.format(
+                            ID=i.getAttribute('id'),
+                            DIR=self.position_map[pos]
+                            ):str(hat_direction_description)
+                        })
+
+                        pos = pos + increment
+            else:
+                helper.log("No container found for hat: {}".format(hat_id), 'error')
+
+
+        
+    
+
     def getDeviceCount(self):
         return self.file.getElementsByTagName('device').length

src/adaptors/dcs_world.py

@@ -1,11 +1,13 @@
 from os import path
 import os
 from pathlib import Path
+import config
 import re
 import html
 import functions.helper as helper
 from PyQt5 import QtWidgets, uic, QtGui
 
+
 class Export:
 
     def __init__(self, joystick_listing, parser_id="UNKNOWN", custom_no_bind="No Bind"):
@@ -14,14 +16,17 @@ def __init__(self, joystick_listing, parser_id="UNKNOWN", custom_no_bind="No Bin
         self.file_name_divider = "_"
         self.joystick_listing = joystick_listing
         self.export_progress = None
-        self.no_bind_text = custom_no_bind
+        self.no_bind_text = config.noBindText
         self.executor = parser_id
         self.error_bucket = []
 
     def export_config(self, progress_bar=None):
 
         joystick_count = len(self.joystick_listing)
 
+        helper.log('Export Started with {} joysticks'.format(joystick_count), 'debug')
+        helper.log('Export Data: {}'.format(self.joystick_listing), 'debug')
+
         if isinstance(progress_bar, QtWidgets.QProgressBar):
             progress_bar.setValue(0)
             progress_increment = 100/joystick_count
@@ -39,7 +44,7 @@ def export_config(self, progress_bar=None):
                     if isinstance(progress_bar, QtWidgets.QProgressBar):
                         progress_bar.setValue(progress_bar.value() + (progress_increment/progress_increment_modes))
             else:
-                self.error_bucket.append("No Template for: {}".format(joystick))
+                self.error_bucket.append("No Template file found for: {}".format(joystick))
 
             if isinstance(progress_bar, QtWidgets.QProgressBar):
                 progress_bar.setValue(progress_bar.value() + progress_increment)
@@ -64,14 +69,17 @@ def create_directory(self,directory):
             return False
 
     def get_template(self, joystick):
+
+        joystick = joystick.strip()
+
         if path.exists(self.templates_directory + joystick + ".svg"):
             data = Path(os.path.join(self.templates_directory, joystick + ".svg")).read_text(encoding="utf-8")
             return data
         else:
             return False
 
     def save_template(self, joystick, mode, template):
-        output_path = self.export_directory + self.executor + "_" + joystick + "_" + mode + ".svg"
+        output_path = self.export_directory + self.executor + "_" + joystick.strip() + "_" + mode + ".svg"
         if not os.path.exists(self.export_directory):
             self.create_directory(self.export_directory)
         try:

src/adaptors/joystick_diagram_interface.py

@@ -5,12 +5,15 @@
 Config.read('./config.cfg')
 
 # Write logs
-debug = Config.getboolean('DEFAULT', 'EnableLogging')
-debugLevel = Config.getint('DEFAULT', 'LogLevel')
+debug = Config.getboolean('Logging', 'EnableLogging', fallback=1)
+debugLevel = Config.getint('Logging', 'LogLevel', fallback=1)
+
+# Params
+noBindText = Config.get('Preferences', 'NoBindText', fallback='No Bind')
 
 # Export out SVG files - for development only (leave as = 1)
 export = 1
 
 ## Program can automatically open in browser as it creates, specify below if you want this. Only supports Chrome right now.
-openinbrowser = Config.getboolean('BROWSER', 'OpenTemplatesInBrowser')
-chrome_path=Config.get('BROWSER', 'ChromePath')
+openinbrowser = Config.getboolean('BROWSER', 'OpenTemplatesInBrowser', fallback=0)
+chrome_path=Config.get('BROWSER', 'ChromePath', fallback="")