QMK CLI and JSON keymap support (#6176)
* Script to generate keymap.c from JSON file. * Support for keymap.json * Add a warning about the keymap.c getting overwritten. * Fix keymap generating * Install the python deps * Flesh out more of the python environment * Remove defunct json2keymap * Style everything with yapf * Polish up python support * Hide json keymap.c into the .build dir * Polish up qmk-compile-json * Make milc work with positional arguments * Fix a couple small things * Fix some errors and make the CLI more understandable * Make the qmk wrapper more robust * Add basic QMK Doctor * Clean up docstrings and flesh them out as needed * remove unused compile_firmware() function
This commit is contained in:
		
							
								
								
									
										47
									
								
								lib/python/qmk/cli/doctor.py
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										47
									
								
								lib/python/qmk/cli/doctor.py
									
									
									
									
									
										Executable file
									
								
							| @@ -0,0 +1,47 @@ | ||||
| """QMK Python Doctor | ||||
|  | ||||
| Check up for QMK environment. | ||||
| """ | ||||
| import shutil | ||||
| import platform | ||||
| import os | ||||
|  | ||||
| from milc import cli | ||||
|  | ||||
|  | ||||
| @cli.entrypoint('Basic QMK environment checks') | ||||
| def main(cli): | ||||
|     """Basic QMK environment checks. | ||||
|  | ||||
|     This is currently very simple, it just checks that all the expected binaries are on your system. | ||||
|  | ||||
|     TODO(unclaimed): | ||||
|         * [ ] Run the binaries to make sure they work | ||||
|         * [ ] Compile a trivial program with each compiler | ||||
|         * [ ] Check for udev entries on linux | ||||
|     """ | ||||
|  | ||||
|     binaries = ['dfu-programmer', 'avrdude', 'dfu-util', 'avr-gcc', 'arm-none-eabi-gcc'] | ||||
|  | ||||
|     cli.log.info('QMK Doctor is Checking your environment') | ||||
|  | ||||
|     ok = True | ||||
|     for binary in binaries: | ||||
|         res = shutil.which(binary) | ||||
|         if res is None: | ||||
|             cli.log.error('{fg_red}QMK can\'t find ' + binary + ' in your path') | ||||
|             ok = False | ||||
|  | ||||
|     OS = platform.system() | ||||
|     if OS == "Darwin": | ||||
|         cli.log.info("Detected {fg_cyan}macOS") | ||||
|     elif OS == "Linux": | ||||
|         cli.log.info("Detected {fg_cyan}linux") | ||||
|         test = 'systemctl list-unit-files | grep enabled | grep -i ModemManager' | ||||
|         if os.system(test) == 0: | ||||
|             cli.log.warn("{bg_yellow}Detected modem manager. Please disable it if you are using Pro Micros") | ||||
|     else: | ||||
|         cli.log.info("Assuming {fg_cyan}Windows") | ||||
|  | ||||
|     if ok: | ||||
|         cli.log.info('{fg_green}QMK is ready to go') | ||||
		Reference in New Issue
	
	Block a user