Merge pull request #139 from ExpressLRS/fix-devices-with-spaces

Validate vendor and device JSON keys, fix "tunerc 2.4g nano pa rx" device name

Author: pkendall64

.github/hardware.py

@@ -213,7 +213,7 @@ def validate(target, layout, device, type):
     for field in dict(filter(ignore_undef_pins, layout.items())):
         # Ensure that the layout field is a valid field from the hardware list
         if field not in hardware_fields.keys():
-            print(f'device "{target}" has an unknown field name {field}')
+            print(f'ERROR: device "{target}" has an unknown field name {field}')
             had_error = True
         else:
             had_error |= validate_pin_uniqueness(target, layout, field)
@@ -244,15 +244,15 @@ def validate_field_grouping(target, layout, field, field_group):
         if field in group[0]:
             for must in group[0] + group[1]:
                 if must not in layout:
-                    print(f'device "{target}" because "{field}" is defined all other related fields must also be defined {must}')
+                    print(f'ERROR: device "{target}" because "{field}" is defined all other related fields must also be defined {must}')
                     print(f'\t{group[0] + group[1]}')
                     had_error = True
             found = True if group[2] == [] else False
             for one in group[2]:
                 if one in layout:
                     found = True
             if not found:
-                print(f'device "{target}" because "{field}" is defined at least one of the following fields must also be {group[2]}')
+                print(f'ERROR: device "{target}" because "{field}" is defined at least one of the following fields must also be {group[2]}')
                 had_error = True
     return had_error
 
@@ -267,7 +267,7 @@ def validate_pin_uniqueness(target, layout, field):
                 if field in duplicate and used_pins[pin] in duplicate:
                     allowed = True
             if not allowed:
-                print(f'device "{target}" PIN {pin} "{field}" is already assigned to "{used_pins[pin]}"')
+                print(f'ERROR: device "{target}" PIN {pin} "{field}" is already assigned to "{used_pins[pin]}"')
                 had_error = True
         else:
             used_pins[pin] = field
@@ -284,32 +284,32 @@ def validate_power_config(target, layout):
         power_default = layout['power_default']
         power_high = layout['power_high']
         if power_min > power_max:
-            print(f'device "{target}" power_min must be less than or equal to power_max')
+            print(f'ERROR: device "{target}" power_min must be less than or equal to power_max')
             had_error = True
         if power_default < power_min or power_default > power_max:
-            print(f'device "{target}" power_default must lie between power_min and power_max')
+            print(f'ERROR: device "{target}" power_default must lie between power_min and power_max')
             had_error = True
         if power_high < power_min or power_high > power_max:
-            print(f'device "{target}" power_high must lie between power_min and power_max')
+            print(f'ERROR: device "{target}" power_high must lie between power_min and power_max')
+            had_error = True
+        if power_values and power_max - power_min + 1 > len(power_values):
+            print(f'ERROR: device "{target}" power_values must have the correct number of entries to match all values from power_min to power_max')
+            had_error = True
+        if power_values_dual and power_max - power_min + 1 > len(power_values_dual):
+            print(f'ERROR: device "{target}" power_values_dual must have the correct number of entries to match all values from power_min to power_max')
             had_error = True
-        if power_values and power_max - power_min + 1 != len(power_values):
-            print(f'device "{target}" power_values must have the correct number of entries to match all values from power_min to power_max')
-            had_error = power_max - power_min + 1 > len(power_values)
-        if power_values_dual and power_max - power_min + 1 != len(power_values_dual):
-            print(f'device "{target}" power_values_dual must have the correct number of entries to match all values from power_min to power_max')
-            had_error = power_max - power_min + 1 > len(power_values_dual)
         if layout['power_control'] == 3 and 'power_apc2' not in layout:
-            print(f'device "{target}" defines power_control as DACWRITE and power_apc2 is undefined')
+            print(f'ERROR: device "{target}" defines power_control as DACWRITE and power_apc2 is undefined')
             had_error = True
         if 'power_values2' in layout:
             if len(layout['power_values2']) != len(power_values):
-                print(f'device "{target}" power_values2 must have the same number of entries as power_values')
+                print(f'ERROR: device "{target}" power_values2 must have the same number of entries as power_values')
                 had_error = True
             if layout['power_control'] != 3:
-                print(f'device "{target}" power_values2 is defined so power_control must be set to 3 (DACWRITE)')
+                print(f'ERROR: device "{target}" power_values2 is defined so power_control must be set to 3 (DACWRITE)')
                 had_error = True
             if 'power_apc2' not in layout:
-                print(f'device "{target}" power_values2 is defined so the power_apc2 pin must also be defined')
+                print(f'ERROR: device "{target}" power_values2 is defined so the power_apc2 pin must also be defined')
                 had_error = True
     return had_error
 
@@ -318,10 +318,10 @@ def validate_backpack(target, layout):
     had_error = False
     if 'passthrough_baud' in layout:
         if layout['serial_rx'] == layout['serial_tx'] and layout['passthrough_baud'] != 230400:
-            print(f'device "{target}" an external module with a backpack should set the baud rate to 230400')
+            print(f'ERROR: device "{target}" an external module with a backpack should set the baud rate to 230400')
             had_error = True
         if layout['serial_rx'] != layout['serial_tx'] and layout['passthrough_baud'] != 460800:
-            print(f'device "{target}" an internal module with a backpack should set the baud rate to 460800')
+            print(f'ERROR: device "{target}" an internal module with a backpack should set the baud rate to 460800')
             had_error = True
     return had_error
 
@@ -330,18 +330,18 @@ def validate_joystick(target, layout):
     had_error = False
     if 'joystick' in layout or 'joystick_values' in layout:
         if 'joystick' not in layout:
-            print(f'device "{target}" joystick_values is defined so the joystick pin must also be defined')
+            print(f'ERROR: device "{target}" joystick_values is defined so the joystick pin must also be defined')
             had_error = True
         elif 'joystick_values' not in layout:
-            print(f'device "{target}" joystick is defined so the joystick_values must also be defined')
+            print(f'ERROR: device "{target}" joystick is defined so the joystick_values must also be defined')
             had_error = True
         elif len(layout['joystick_values']) != 6:
-            print(f'device "{target}" joystick_values must have 6 values defined')
+            print(f'ERROR: device "{target}" joystick_values must have 6 values defined')
             had_error = True
         else:
             for value in layout['joystick_values']:
                 if value < 0 or value > 4095:
-                    print(f'device "{target}" joystick_values must be between 0 and 4095 inclusive')
+                    print(f'ERROR: device "{target}" joystick_values must be between 0 and 4095 inclusive')
                     had_error = True
     return had_error
 
@@ -354,7 +354,7 @@ def validate_pwm_outputs(target, layout):
                     field in layout and \
                     layout[field] in layout['pwm_outputs'] and \
                     field not in allowable_pwm_shared:
-                print(f'device "{target}" pwm_output pin {layout[field]} is not allowed to be shared with {field}')
+                print(f'ERROR: device "{target}" pwm_output pin {layout[field]} is not allowed to be shared with {field}')
                 had_error = True
     return had_error
 
@@ -363,10 +363,10 @@ def validate_pin_function(target, layout, field, platform):
     if hardware_fields[field].value > FieldType.PIN.value:
         function = get_pin_function(platform, layout[field])
         if function is None:
-            print(f'device "{target}" has an invalid pin number for {field}, {layout[field]}')
+            print(f'ERROR: device "{target}" has an invalid pin number for {field}, {layout[field]}')
             return True
         if hardware_fields[field] == FieldType.INPUT and not (function & 1):
-            print(f'device "{target}" pin for {field} must be assigned to a pin that supports INPUT')
+            print(f'ERROR: device "{target}" pin for {field} must be assigned to a pin that supports INPUT')
             return True
     return False
 
@@ -375,5 +375,5 @@ def validate_vtx_amp_pwm(target, layout, platform):
     if platform == 'esp32' and 'vtx_amp_pwm' in layout:
         function = get_pin_function(platform, layout['vtx_amp_pwm'])
         if function is not None and function & 8 != 8:
-            print(f'device "{target}" "vtx_amp_pwm" is preferred to be a DAC pin if possible, but PWM output is supported')
+            print(f'NOTICE: device "{target}" "vtx_amp_pwm" is preferred to be a DAC pin if possible, but PWM output is supported')
     return False

.github/targets_validator.py

@@ -3,21 +3,25 @@
 import glob
 import argparse
 import hardware
+import re
 
 hadError = False
 warnEnabled = False
 firmwares = set()
 
+
 def error(msg):
     global hadError
     hadError = True
-    print(msg)
+    print("ERROR: " + msg)
+
 
 def warn(msg):
     if warnEnabled:
         global hadError
         hadError = True
-        print(msg)
+        print("WARNING: " + msg)
+
 
 def validate_stm32(vendor, type, devname, device):
     for method in device['upload_methods']:
@@ -37,6 +41,7 @@ def validate_stm32(vendor, type, devname, device):
             error(f'The "stlink" attribute for target "{vendor}.{type}.{devname}" must have a valid "bootloader"')
     # could check the existence of the bootloader file
 
+
 def validate_esp(vendor, type, devname, device):
     if 'lua_name' not in device:
         error(f'device "{vendor}.{type}.{devname}" must have a "lua_name" child element')
@@ -80,21 +85,25 @@ def validate_esp(vendor, type, devname, device):
         if '_ESP8285_' not in device['firmware']:
             error(f'device "{vendor}.{type}.{devname}" firmware and platform MUST match')
 
+
 def validate_esp32(vendor, type, devname, device):
     for method in device['upload_methods']:
         if method not in ['uart', 'etx', 'wifi', 'betaflight']:
             error(f'Invalid upload method "{method}" for target "{vendor}.{type}.{devname}"')
     validate_esp(vendor, type, devname, device)
 
+
 def validate_esp8285(vendor, type, devname, device):
     for method in device['upload_methods']:
         if method not in ['uart', 'wifi', 'betaflight']:
             error(f'Invalid upload method "{method}" for target "{vendor}.{type}.{devname}"')
     validate_esp(vendor, type, devname, device)
 
 def validate_devices(vendor, type, devname, device):
-    if devname != devname.lower():
-        error(f'device tag "{devname}" should be lowercase')
+    allowed_json_key_characters = re.compile("^[a-z0-9_-]+$")
+    if not allowed_json_key_characters.match(devname):
+        error(f'device tag "{devname}" can only include lowercase a-z, 0-9, and underscores and dashes')
+
     if 'product_name' not in device:
         error(f'device "{vendor}.{type}.{devname}" must have a "product_name" child element')
     if 'upload_methods' not in device:
@@ -132,19 +141,21 @@ def validate_devices(vendor, type, devname, device):
                 error(f'features must contain one or more of [\'buzzer\', \'unlock-higher-power\', \'fan\', \'sbus-uart\'], if present in target "{vendor}.{type}.{devname}"')
 
 def validate_vendor(name, types):
-    if name != name.lower():
-        error(f'vendor tag "{vendor}" should be lowercase')
+    allowed_json_key_characters = re.compile("^[a-z0-9_-]+$")
+    if not allowed_json_key_characters.match(name):
+        error(f'vendor tag "{name}" can only include lowercase a-z, 0-9, and underscores and dashes')
 
     if 'name' not in types:
         error(f'vendor "{vendor}" must have a "name" child element')
 
     for type in types:
         if type not in ['rx_2400', 'rx_900', 'rx_dual', 'tx_2400', 'tx_900', 'tx_dual', 'name']:
             error(f'invalid tag "{type}" in "{vendor}"')
-        if type in  ['rx_2400', 'rx_900', 'rx_dual', 'tx_2400', 'tx_900', 'tx_dual']:
+        if type in ['rx_2400', 'rx_900', 'rx_dual', 'tx_2400', 'tx_900', 'tx_dual']:
             for device in types[type]:
                 validate_devices(name, type, device, types[type][device])
 
+
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(description="Configure Binary Firmware")
     parser.add_argument("--warn", "-w", action='store_true', default=False, help="Print warnings")
@@ -175,7 +186,7 @@ def validate_vendor(name, types):
                         target = line
                     if line.startswith('board_config'):
                         eq = line.find('=')
-                        board = line[eq+1:].strip()
+                        board = line[eq + 1:].strip()
                         parts = board.split('.')
                         if len(parts) != 3:
                             error(f'{inifile}: board_config must have 3 parts')
@@ -191,4 +202,4 @@ def validate_vendor(name, types):
                                 error(f'{inifile}: targets.json "{vendor}.{type}" does not contain device {device}')
     if hadError:
         sys.exit(1)
-    sys.exit(0)
+    sys.exit(0)

.gitignore

@@ -1 +1,3 @@
 .DS_Store
+.idea
+__pycache__

targets.json

@@ -119,7 +119,7 @@
                 "overlay": {
                     "vbat_offset": 0,
                     "vbat_scale": 908,
-                    "vbat_atten": 7                  
+                    "vbat_atten": 7
                 },
                 "upload_methods": ["uart", "wifi", "betaflight"],
                 "min_version": "3.5.0",
@@ -3016,7 +3016,7 @@
     "tunerc": {
         "name": "TuneRC",
         "rx_2400": {
-            "tunerc 2.4g nano pa rx": {
+            "tunerc_2400_nano_pa_rx": {
                 "product_name": "TuneRC 2.4G nano PA RX",
                 "lua_name": "TuneRC 2G4 nano",
                 "layout_file": "Generic C3 2400 PA.json",