V1.2 Release (#10)

* Add support for multiple SPI buttons. 

* Add support for SPIButtons CS pin selection.

* Additional ShifterAnalog configurability to support G27.

* Added working DFU uploader

* Parser update: Replies have the command echoed

* Using async comms for terminal

* queue flood prevention

* No more send queue buffering

* Fixed bin to dfu script

* Moved save button handling to system ui

* using full echo of the sent command in the reply

* moved main class selector to serial ui

* Save and restore flash dumps

* ram usage display

Author: Ultrawipf

README.md

@@ -1,7 +1,9 @@
 # OpenFFBoard-configurator
 A simple GUI to configure the [Open FFBoard](https://github.com/Ultrawipf/OpenFFBoard) written in Python 3 with Qt.
 
-Requires the latest firmware version most of the time.
+This allows complete configuration of all settings in the Open FFBoard firmware at runtime.
+
+Requires the latest firmware version most of the time from a matching branch.
 
 
 Be very careful when changing motor types, drivers or the power value.
@@ -11,12 +13,13 @@ Incorrect settings may cause unintended movements or damage hardware.
 
 On older windows versions CDC drivers may not load automatically.
 
-Then you need to manually install for example the STM VCP driver for the device. (We will provide a inf installer later)
+Then you need to manually install for example the STM VCP driver for the device. (We will provide an installer later)
 
 
 ![FFB Window](screenshots/FFBwheel.png?raw=true)
 
 Dependencies:
 
 PyQt5
-pyqtgraph (For TMC graph)
+pyqtgraph (For TMC graph)
+pyusb and libusb-1.0.dll for DFU

build/.gitignore

@@ -0,0 +1,3 @@
+__pycache__/*
+dist/*
+build/*

build/OpenFFBoard.spec

@@ -10,7 +10,7 @@ delete = ["opengl32sw.dll","d3dcompiler_47.dll","libGLESv2.dll","Qt5Quick.dll","
 
 a = Analysis([os.path.join(folder,'main.py')],
              binaries=[],
-             datas=[(os.path.join(folder,'res'), 'res')],
+             datas=[(os.path.join(folder,'res'), 'res'),(os.path.join(folder,"libusb-1.0.dll"),".")],
              hiddenimports=[],
              hookspath=[],
              runtime_hooks=[],

build/bin_to_dfu.py

@@ -0,0 +1,65 @@
+import sys,struct,zlib,os
+import argparse
+
+address = 0x8000000
+DEFAULT_DEVICE="0x0483:0xdf11"
+
+# (Start,length) to skip eeprom emulation sectors
+flash_sectors_f4 = [
+(0x8000000,0x3fff),(0x800C000,-1) # multiple sectors combined. -1 size for rest
+]
+
+def compute_crc(data):
+    return 0xFFFFFFFF & -zlib.crc32(data) -1
+def build(file,targets,device=DEFAULT_DEVICE):
+    data = b''
+    for t,target in enumerate(targets):
+        tdata = b''
+        for image in target:
+          tdata += struct.pack('<2I',image['address'],len(image['data']))+image['data']
+        tdata = struct.pack('<6sBI255s2I',b'Target',0,1, b'ST...',len(tdata),len(target)) + tdata
+        data += tdata
+    data  = struct.pack('<5sBIB',b'DfuSe',1,len(data)+11,len(targets)) + data
+    v,d=map(lambda x: int(x,0) & 0xFFFF, device.split(':',1))
+    data += struct.pack('<4H3sB',0,d,v,0x011a,b'UFD',16)
+    crc   = compute_crc(data)
+    data += struct.pack('<I',crc)
+    open(file,'wb').write(data)
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Convert bin to dfu")
+    parser.add_argument('binary',  type=str, help="bin file input")
+    parser.add_argument('--address', type=str, help="flash address. Default 0x8000000",default = "0x8000000")
+    #parser.add_argument('--addroffset', type=str, help="flash address offset after eeprom emulation. Default 0xc000",default = "0xc000")
+    parser.add_argument('--out', nargs='?', type=str,help = ".dfu file output",default = None)
+
+    args = parser.parse_args()
+    binfile = args.binary
+    outfile = args.out
+
+    if not outfile:
+        outfile = binfile.replace(".bin","") + ".dfu"
+    if(args.address):
+        address = int(args.address,0)
+    # if(args.addroffset):
+    #     addroffset = int(args.addroffset,0)
+
+    if not os.path.isfile(binfile):
+        print("Invalid file '%s'." % binfile)
+    data = bytes(open(binfile,'rb').read())
+
+    ## F4 targets
+    target = []
+    for page in flash_sectors_f4:
+        start_offset = page[0]-address
+        if start_offset > len(data):
+            break
+        print("Appending %x - %x" % (page[0],page[0]+page[1]))
+        stop = min(start_offset+page[1]+1,len(data))
+        if page[1] == -1:
+            stop = len(data)
+        print("%x - %x" % (start_offset,stop))
+        target.append({'address': page[0], 'data': data[start_offset:stop]})
+
+    print("Saving to", outfile)
+    build(outfile,[target],DEFAULT_DEVICE)

build/build_nuitka.bat

@@ -0,0 +1,2 @@
+cd ..
+python -m nuitka --show-progress --standalone --windows-dependency-tool=pefile --plugin-enable=qt-plugins --plugin-enable=numpy --follow-imports --windows-icon-from-ico=build\app.ico main.py

buttonconf_ui.py

@@ -1,4 +1,6 @@
-from PyQt5.QtWidgets import QMainWindow
+from collections import namedtuple
+from PyQt5.QtCore import QTimer
+from PyQt5.QtWidgets import QGridLayout, QHBoxLayout, QLineEdit, QMainWindow
 from PyQt5.QtWidgets import QDialog
 from PyQt5.QtWidgets import QWidget,QGroupBox
 from PyQt5.QtWidgets import QMessageBox,QVBoxLayout,QCheckBox,QButtonGroup,QPushButton,QLabel,QSpinBox,QComboBox
@@ -16,8 +18,10 @@ def __init__(self,name,id, main):
         if(id == 0): # local buttons
             self.dialog = (LocalButtonsConf(name,self.main))
         elif(id == 1):
-            self.dialog = (SPIButtonsConf(name,self.main))
+            self.dialog = (SPIButtonsConf(name,self.main,1))
         elif(id == 2):
+            self.dialog = (SPIButtonsConf(name,self.main,2))
+        elif(id == 3):
             self.dialog = (ShifterButtonsConf(name,self.main))
 
         OptionsDialog.__init__(self, self.dialog,main)
@@ -84,9 +88,13 @@ def readValues(self):
 
 class SPIButtonsConf(OptionsDialogGroupBox):
 
-    def __init__(self,name,main):
+    def __init__(self,name,main,id):
         self.main = main
+        self.id = id
         OptionsDialogGroupBox.__init__(self,name,main)
+
+    def getPrefix(self):
+        return f"spi{self.id}_"
 
     def initUI(self):
         vbox = QVBoxLayout()
@@ -104,46 +112,170 @@ def initUI(self):
         vbox.addWidget(self.polBox)
         self.setLayout(vbox)
 
+        vbox.addWidget(QLabel("CS #"))
+        self.csBox = QSpinBox()
+        self.csBox.setMinimum(1)
+        self.csBox.setMaximum(3)
+        vbox.addWidget(self.csBox)
+
     def apply(self):
-        self.main.comms.serialWrite("spibtn_mode="+str(self.modeBox.currentData()))
-        self.main.comms.serialWrite("spi_btnnum="+str(self.numBtnBox.value()))
-        self.main.comms.serialWrite("spi_btnpol="+("1" if self.polBox.isChecked() else "0"))
+        self.main.comms.serialWrite(f"{self.getPrefix()}btn_mode="+str(self.modeBox.currentData()))
+        self.main.comms.serialWrite(f"{self.getPrefix()}btnnum="+str(self.numBtnBox.value()))
+        self.main.comms.serialWrite(f"{self.getPrefix()}btnpol="+("1" if self.polBox.isChecked() else "0"))
+        self.main.comms.serialWrite(f"{self.getPrefix()}btn_cs={self.csBox.value()}")
 
     def readValues(self):
-        self.main.comms.serialGetAsync("spi_btnnum?",self.numBtnBox.setValue,int)
+        self.main.comms.serialGetAsync(f"{self.getPrefix()}btnnum?",self.numBtnBox.setValue,int)
         self.modeBox.clear()
         def modecb(mode):
             modes = mode.split("\n")
             modes = [m.split(":") for m in modes if m]
             for m in modes:
                 self.modeBox.addItem(m[0],m[1])
-            self.main.comms.serialGetAsync("spibtn_mode?",self.modeBox.setCurrentIndex,int)
-        self.main.comms.serialGetAsync("spibtn_mode!",modecb)
-        self.main.comms.serialGetAsync("spi_btnpol?",self.polBox.setChecked,int)
+            self.main.comms.serialGetAsync(f"{self.getPrefix()}btn_mode?",self.modeBox.setCurrentIndex,int)
+        self.main.comms.serialGetAsync(f"{self.getPrefix()}btn_mode!",modecb)
+        self.main.comms.serialGetAsync(f"{self.getPrefix()}btnpol?",self.polBox.setChecked,int)
+        self.main.comms.serialGetAsync(f"{self.getPrefix()}btn_cs?", self.csBox.setValue, int)
 
 class ShifterButtonsConf(OptionsDialogGroupBox):
+    class Mode(namedtuple('Mode', ['index', 'name', 'uses_spi', 'uses_local_reverse'])):
+        pass
 
     def __init__(self,name,main):
         self.main = main
         OptionsDialogGroupBox.__init__(self,name,main)
 
     def initUI(self):
+        def addThreshold(name):
+            vbox.addWidget(QLabel(name))
+            numBtnBox = QSpinBox()
+            numBtnBox.setMinimum(0)
+            numBtnBox.setMaximum(4096)
+            vbox.addWidget(numBtnBox)
+            return numBtnBox
+
         vbox = QVBoxLayout()
         vbox.addWidget(QLabel("Mode"))
         self.modeBox = QComboBox()
+        self.modeBox.currentIndexChanged.connect(self.modeBoxChanged)
         vbox.addWidget(self.modeBox)
+
+        self.xPos = QLineEdit()
+        self.xPos.setReadOnly(True)
+        self.yPos = QLineEdit()
+        self.yPos.setReadOnly(True)
+        self.gear = QLineEdit()
+        self.gear.setReadOnly(True)
+
+        posGroup = QGridLayout()
+        posGroup.addWidget(QLabel("X"), 1, 1)
+        posGroup.addWidget(self.xPos, 1, 2)
+        posGroup.addWidget(QLabel("Y"), 1, 3)
+        posGroup.addWidget(self.yPos, 1, 4)
+        posGroup.addWidget(QLabel("Calculated Gear"), 2, 1, 1, 2)
+        posGroup.addWidget(self.gear, 2, 3, 1, 2)
+        posGroupBox = QGroupBox()
+        posGroupBox.setTitle("Current")
+        posGroupBox.setLayout(posGroup)
+        vbox.addWidget(posGroupBox)
+
+        vbox.addWidget(QLabel("X Channel"))
+        self.xChannel = QSpinBox()
+        self.xChannel.setMinimum(1)
+        self.xChannel.setMaximum(6)
+        vbox.addWidget(self.xChannel)
+
+        vbox.addWidget(QLabel("Y Channel"))
+        self.yChannel = QSpinBox()
+        self.yChannel.setMinimum(1)
+        self.yChannel.setMaximum(6)
+        vbox.addWidget(self.yChannel)
+
+        self.x12 = addThreshold("X 1,2 Threshold")
+        self.x56 = addThreshold("X 5,6 Threshold")
+        self.y135 = addThreshold("Y 1,3,5 Threshold")
+        self.y246 = addThreshold("Y 2,4,6 Threshold")
+
+        self.revBtnLabel = QLabel("Reverse Button Digital Input")
+        vbox.addWidget(self.revBtnLabel)
+        self.revBtnBox = QSpinBox()
+        self.revBtnBox.setMinimum(1)
+        self.revBtnBox.setMaximum(8)
+        vbox.addWidget(self.revBtnBox)
+
+        self.csPinLabel = QLabel("SPI CS Pin Number")
+        vbox.addWidget(self.csPinLabel)
+        self.csPinBox = QSpinBox()
+        self.csPinBox.setMinimum(1)
+        self.csPinBox.setMaximum(3)
+        vbox.addWidget(self.csPinBox)
+
         self.setLayout(vbox)
-  
+
+        self.timer = QTimer()
+        self.timer.timeout.connect(self.readXYPosition)
+
+    def onshown(self):
+        self.timer.start(500)
+
+    def onclose(self):
+        self.timer.stop()
+
+    def modeBoxChanged(self, _):
+        mode = self.modeBox.currentData()
+
+        if mode is not None:
+            self.revBtnLabel.setVisible(mode.uses_local_reverse)
+            self.revBtnBox.setVisible(mode.uses_local_reverse)
+            self.csPinLabel.setVisible(mode.uses_spi)
+            self.csPinBox.setVisible(mode.uses_spi)
 
     def apply(self):
-        self.main.comms.serialWrite("shifter_mode="+str(self.modeBox.currentData()))
+        self.main.comms.serialWrite(f"shifter_mode={self.modeBox.currentData().index}")
+        self.main.comms.serialWrite(f"shifter_x_chan={self.xChannel.value()}")
+        self.main.comms.serialWrite(f"shifter_y_chan={self.yChannel.value()}")
+        self.main.comms.serialWrite(f"shifter_x_12={self.x12.value()}")
+        self.main.comms.serialWrite(f"shifter_x_56={self.x56.value()}")
+        self.main.comms.serialWrite(f"shifter_y_135={self.y135.value()}")
+        self.main.comms.serialWrite(f"shifter_y_246={self.y246.value()}")
+        self.main.comms.serialWrite(f"shifter_rev_btn={self.revBtnBox.value()}")
+        self.main.comms.serialWrite(f"shifter_cs_pin={self.csPinBox.value()}")
+
+    def readXYPosition(self):
+        def updatePosition(valueStr: str):
+            x,y = valueStr.strip().split(",")
+            self.xPos.setText(x)
+            self.yPos.setText(y)
+
+        def updateGear(value: str):
+            value = value.strip()
+            if value == "0":
+                value = "N"
+            elif value == "7":
+                value = "R"
+            
+            self.gear.setText(value)
+
+        self.main.comms.serialGetAsync("shifter_vals?",updatePosition, str)
+        self.main.comms.serialGetAsync("shifter_gear?", updateGear, str)      
 
     def readValues(self):
         self.modeBox.clear()
         def modecb(mode):
             modes = mode.split("\n")
             modes = [m.split(":") for m in modes if m]
             for m in modes:
-                self.modeBox.addItem(m[0],m[1])
+                index, uses_spi, uses_local_reverse = m[1].split(',')
+                self.modeBox.addItem(m[0], ShifterButtonsConf.Mode(int(index), m[0], uses_spi == "1", uses_local_reverse == "1"))
             self.main.comms.serialGetAsync("shifter_mode?",self.modeBox.setCurrentIndex,int)
         self.main.comms.serialGetAsync("shifter_mode!",modecb)
+        self.main.comms.serialGetAsync("shifter_x_chan?",self.xChannel.setValue,int)
+        self.main.comms.serialGetAsync("shifter_y_chan?",self.yChannel.setValue,int)
+        self.main.comms.serialGetAsync("shifter_x_12?",self.x12.setValue,int)
+        self.main.comms.serialGetAsync("shifter_x_56?",self.x56.setValue,int)
+        self.main.comms.serialGetAsync("shifter_y_135?",self.y135.setValue,int)
+        self.main.comms.serialGetAsync("shifter_y_246?",self.y246.setValue,int)
+        self.main.comms.serialGetAsync("shifter_rev_btn?",self.revBtnBox.setValue,int)
+        self.main.comms.serialGetAsync("shifter_cs_pin?",self.csPinBox.setValue, int)
+        self.readXYPosition()
+

config.py

@@ -0,0 +1,40 @@
+import json
+from PyQt5.QtWidgets  import QFileDialog,QMessageBox
+
+def saveDump(buf):
+    dump = {"flash":[]} 
+    for l in buf.split("\n"):
+        if not l:
+            break
+        addr,val = l.split(":")
+        dump["flash"].append({"addr":addr,"val":val})
+    
+    dlg = QFileDialog()
+    dlg.setFileMode(QFileDialog.AnyFile)
+    dlg.setNameFilters(["Json files (*.json)"])
+    if dlg.exec_():
+        filenames = dlg.selectedFiles()
+        try:
+            with open(filenames[0],"w") as f:
+                json.dump(dump,f)
+            msg = QMessageBox(QMessageBox.Information,"Save flash dump","Saved successfully.")
+            msg.exec_()
+        except Exception as e:
+            msg = QMessageBox(QMessageBox.Warning,"Save flash dump","Error while saving flash dump:\n"+str(e))
+            msg.exec_()
+    else:
+        return
+
+def loadDump():
+    dlg = QFileDialog()
+    dlg.setFileMode(QFileDialog.ExistingFile)
+    dlg.setNameFilters(["Json files (*.json)"])
+    if dlg.exec_():
+        dump = {}
+        filenames = dlg.selectedFiles()
+        with open(filenames[0],"r") as f:
+            dump = json.load(f)
+        return dump
+
+    else:
+        return None