diff options
Diffstat (limited to 'lib/python/qmk/cli/doctor.py')
| -rwxr-xr-x | lib/python/qmk/cli/doctor.py | 47 | 
1 files changed, 47 insertions, 0 deletions
| diff --git a/lib/python/qmk/cli/doctor.py b/lib/python/qmk/cli/doctor.py new file mode 100755 index 0000000000..9ce765a4b5 --- /dev/null +++ b/lib/python/qmk/cli/doctor.py @@ -0,0 +1,47 @@ +"""QMK Python Doctor + +Check up for QMK environment. +""" +import shutil +import platform +import os + +from milc import cli + + [email protected]('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') | 
