import argparse import functools import logging import os import sys from datetime import datetime from esphome import const, writer, yaml_util import esphome.codegen as cg from esphome.config import iter_components, read_config, strip_default_ids from esphome.const import ( CONF_BAUD_RATE, CONF_BROKER, CONF_LOGGER, CONF_OTA, CONF_PASSWORD, CONF_PORT, CONF_ESPHOME, CONF_PLATFORMIO_OPTIONS, ) from esphome.core import CORE, EsphomeError, coroutine, coroutine_with_priority from esphome.helpers import color, indent from esphome.util import ( run_external_command, run_external_process, safe_print, list_yaml_files, get_serial_ports, ) _LOGGER = logging.getLogger(__name__) def choose_prompt(options): if not options: raise EsphomeError( "Found no valid options for upload/logging, please make sure relevant " "sections (ota, api, mqtt, ...) are in your configuration and/or the " "device is plugged in." ) if len(options) == 1: return options[0][1] safe_print("Found multiple options, please choose one:") for i, (desc, _) in enumerate(options): safe_print(f" [{i+1}] {desc}") while True: opt = input("(number): ") if opt in options: opt = options.index(opt) break try: opt = int(opt) if opt < 1 or opt > len(options): raise ValueError break except ValueError: safe_print(color("red", f"Invalid option: '{opt}'")) return options[opt - 1][1] def choose_upload_log_host(default, check_default, show_ota, show_mqtt, show_api): options = [] for port in get_serial_ports(): options.append((f"{port.path} ({port.description})", port.path)) if (show_ota and "ota" in CORE.config) or (show_api and "api" in CORE.config): options.append((f"Over The Air ({CORE.address})", CORE.address)) if default == "OTA": return CORE.address if show_mqtt and "mqtt" in CORE.config: options.append(("MQTT ({})".format(CORE.config["mqtt"][CONF_BROKER]), "MQTT")) if default == "OTA": return "MQTT" if default is not None: return default if check_default is not None and check_default in [opt[1] for opt in options]: return check_default return choose_prompt(options) def get_port_type(port): if port.startswith("/") or port.startswith("COM"): return "SERIAL" if port == "MQTT": return "MQTT" return "NETWORK" def run_miniterm(config, port): import serial from esphome import platformio_api if CONF_LOGGER not in config: _LOGGER.info("Logger is not enabled. Not starting UART logs.") return baud_rate = config["logger"][CONF_BAUD_RATE] if baud_rate == 0: _LOGGER.info("UART logging is disabled (baud_rate=0). Not starting UART logs.") _LOGGER.info("Starting log output from %s with baud rate %s", port, baud_rate) backtrace_state = False with serial.Serial(port, baudrate=baud_rate) as ser: while True: try: raw = ser.readline() except serial.SerialException: _LOGGER.error("Serial port closed!") return line = ( raw.replace(b"\r", b"") .replace(b"\n", b"") .decode("utf8", "backslashreplace") ) time = datetime.now().time().strftime("[%H:%M:%S]") message = time + line safe_print(message) backtrace_state = platformio_api.process_stacktrace( config, line, backtrace_state=backtrace_state ) def wrap_to_code(name, comp): coro = coroutine(comp.to_code) @functools.wraps(comp.to_code) @coroutine_with_priority(coro.priority) def wrapped(conf): cg.add(cg.LineComment(f"{name}:")) if comp.config_schema is not None: conf_str = yaml_util.dump(conf) conf_str = conf_str.replace("//", "") cg.add(cg.LineComment(indent(conf_str))) yield coro(conf) return wrapped def write_cpp(config): generate_cpp_contents(config) return write_cpp_file() def generate_cpp_contents(config): _LOGGER.info("Generating C++ source...") for name, component, conf in iter_components(CORE.config): if component.to_code is not None: coro = wrap_to_code(name, component) CORE.add_job(coro, conf) CORE.flush_tasks() def write_cpp_file(): writer.write_platformio_project() code_s = indent(CORE.cpp_main_section) writer.write_cpp(code_s) return 0 def compile_program(args, config): from esphome import platformio_api _LOGGER.info("Compiling app...") return platformio_api.run_compile(config, CORE.verbose) def upload_using_esptool(config, port): path = CORE.firmware_bin first_baudrate = config[CONF_ESPHOME][CONF_PLATFORMIO_OPTIONS].get( "upload_speed", 460800 ) def run_esptool(baud_rate): cmd = [ "esptool.py", "--before", "default_reset", "--after", "hard_reset", "--baud", str(baud_rate), "--chip", "esp8266", "--port", port, "write_flash", "0x0", path, ] if os.environ.get("ESPHOME_USE_SUBPROCESS") is None: import esptool # pylint: disable=protected-access return run_external_command(esptool._main, *cmd) return run_external_process(*cmd) rc = run_esptool(first_baudrate) if rc == 0 or first_baudrate == 115200: return rc # Try with 115200 baud rate, with some serial chips the faster baud rates do not work well _LOGGER.info( "Upload with baud rate %s failed. Trying again with baud rate 115200.", first_baudrate, ) return run_esptool(115200) def upload_program(config, args, host): # if upload is to a serial port use platformio, otherwise assume ota if get_port_type(host) == "SERIAL": from esphome import platformio_api if CORE.is_esp8266: return upload_using_esptool(config, host) return platformio_api.run_upload(config, CORE.verbose, host) from esphome import espota2 if CONF_OTA not in config: raise EsphomeError( "Cannot upload Over the Air as the config does not include the ota: " "component" ) ota_conf = config[CONF_OTA] remote_port = ota_conf[CONF_PORT] password = ota_conf[CONF_PASSWORD] return espota2.run_ota(host, remote_port, password, CORE.firmware_bin) def show_logs(config, args, port): if "logger" not in config: raise EsphomeError("Logger is not configured!") if get_port_type(port) == "SERIAL": run_miniterm(config, port) return 0 if get_port_type(port) == "NETWORK" and "api" in config: from esphome.api.client import run_logs return run_logs(config, port) if get_port_type(port) == "MQTT" and "mqtt" in config: from esphome import mqtt return mqtt.show_logs( config, args.topic, args.username, args.password, args.client_id ) raise EsphomeError("No remote or local logging method configured (api/mqtt/logger)") def clean_mqtt(config, args): from esphome import mqtt return mqtt.clear_topic( config, args.topic, args.username, args.password, args.client_id ) def setup_log(debug=False, quiet=False): if debug: log_level = logging.DEBUG CORE.verbose = True elif quiet: log_level = logging.CRITICAL else: log_level = logging.INFO logging.basicConfig(level=log_level) fmt = "%(levelname)s %(message)s" colorfmt = f"%(log_color)s{fmt}%(reset)s" datefmt = "%H:%M:%S" logging.getLogger("urllib3").setLevel(logging.WARNING) try: import colorama colorama.init(strip=True) from colorlog import ColoredFormatter logging.getLogger().handlers[0].setFormatter( ColoredFormatter( colorfmt, datefmt=datefmt, reset=True, log_colors={ "DEBUG": "cyan", "INFO": "green", "WARNING": "yellow", "ERROR": "red", "CRITICAL": "red", }, ) ) except ImportError: pass def command_wizard(args): from esphome import wizard return wizard.wizard(args.configuration[0]) def command_config(args, config): _LOGGER.info("Configuration is valid!") if not CORE.verbose: config = strip_default_ids(config) safe_print(yaml_util.dump(config)) return 0 def command_vscode(args): from esphome import vscode CORE.config_path = args.configuration[0] vscode.read_config(args) def command_compile(args, config): exit_code = write_cpp(config) if exit_code != 0: return exit_code if args.only_generate: _LOGGER.info("Successfully generated source code.") return 0 exit_code = compile_program(args, config) if exit_code != 0: return exit_code _LOGGER.info("Successfully compiled program.") return 0 def command_upload(args, config): port = choose_upload_log_host( default=args.upload_port, check_default=None, show_ota=True, show_mqtt=False, show_api=False, ) exit_code = upload_program(config, args, port) if exit_code != 0: return exit_code _LOGGER.info("Successfully uploaded program.") return 0 def command_logs(args, config): port = choose_upload_log_host( default=args.serial_port, check_default=None, show_ota=False, show_mqtt=True, show_api=True, ) return show_logs(config, args, port) def command_run(args, config): exit_code = write_cpp(config) if exit_code != 0: return exit_code exit_code = compile_program(args, config) if exit_code != 0: return exit_code _LOGGER.info("Successfully compiled program.") port = choose_upload_log_host( default=args.upload_port, check_default=None, show_ota=True, show_mqtt=False, show_api=True, ) exit_code = upload_program(config, args, port) if exit_code != 0: return exit_code _LOGGER.info("Successfully uploaded program.") if args.no_logs: return 0 port = choose_upload_log_host( default=args.upload_port, check_default=port, show_ota=False, show_mqtt=True, show_api=True, ) return show_logs(config, args, port) def command_clean_mqtt(args, config): return clean_mqtt(config, args) def command_mqtt_fingerprint(args, config): from esphome import mqtt return mqtt.get_fingerprint(config) def command_version(args): safe_print(f"Version: {const.__version__}") return 0 def command_clean(args, config): try: writer.clean_build() except OSError as err: _LOGGER.error("Error deleting build files: %s", err) return 1 _LOGGER.info("Done!") return 0 def command_dashboard(args): from esphome.dashboard import dashboard return dashboard.start_web_server(args) def command_update_all(args): import click success = {} files = list_yaml_files(args.configuration[0]) twidth = 60 def print_bar(middle_text): middle_text = f" {middle_text} " width = len(click.unstyle(middle_text)) half_line = "=" * ((twidth - width) // 2) click.echo(f"{half_line}{middle_text}{half_line}") for f in files: print("Updating {}".format(color("cyan", f))) print("-" * twidth) print() rc = run_external_process( "esphome", "--dashboard", f, "run", "--no-logs", "--upload-port", "OTA" ) if rc == 0: print_bar("[{}] {}".format(color("bold_green", "SUCCESS"), f)) success[f] = True else: print_bar("[{}] {}".format(color("bold_red", "ERROR"), f)) success[f] = False print() print() print() print_bar("[{}]".format(color("bold_white", "SUMMARY"))) failed = 0 for f in files: if success[f]: print(" - {}: {}".format(f, color("green", "SUCCESS"))) else: print(" - {}: {}".format(f, color("bold_red", "FAILED"))) failed += 1 return failed PRE_CONFIG_ACTIONS = { "wizard": command_wizard, "version": command_version, "dashboard": command_dashboard, "vscode": command_vscode, "update-all": command_update_all, } POST_CONFIG_ACTIONS = { "config": command_config, "compile": command_compile, "upload": command_upload, "logs": command_logs, "run": command_run, "clean-mqtt": command_clean_mqtt, "mqtt-fingerprint": command_mqtt_fingerprint, "clean": command_clean, } def parse_args(argv): parser = argparse.ArgumentParser(description=f"ESPHome v{const.__version__}") parser.add_argument( "-v", "--verbose", help="Enable verbose esphome logs.", action="store_true" ) parser.add_argument( "-q", "--quiet", help="Disable all esphome logs.", action="store_true" ) parser.add_argument("--dashboard", help=argparse.SUPPRESS, action="store_true") parser.add_argument( "-s", "--substitution", nargs=2, action="append", help="Add a substitution", metavar=("key", "value"), ) parser.add_argument( "configuration", help="Your YAML configuration file.", nargs="*" ) subparsers = parser.add_subparsers(help="Commands", dest="command") subparsers.required = True subparsers.add_parser("config", help="Validate the configuration and spit it out.") parser_compile = subparsers.add_parser( "compile", help="Read the configuration and compile a program." ) parser_compile.add_argument( "--only-generate", help="Only generate source code, do not compile.", action="store_true", ) parser_upload = subparsers.add_parser( "upload", help="Validate the configuration " "and upload the latest binary." ) parser_upload.add_argument( "--upload-port", help="Manually specify the upload port to use. " "For example /dev/cu.SLAB_USBtoUART.", ) parser_logs = subparsers.add_parser( "logs", help="Validate the configuration " "and show all MQTT logs." ) parser_logs.add_argument("--topic", help="Manually set the topic to subscribe to.") parser_logs.add_argument("--username", help="Manually set the username.") parser_logs.add_argument("--password", help="Manually set the password.") parser_logs.add_argument("--client-id", help="Manually set the client id.") parser_logs.add_argument( "--serial-port", help="Manually specify a serial port to use" "For example /dev/cu.SLAB_USBtoUART.", ) parser_run = subparsers.add_parser( "run", help="Validate the configuration, create a binary, " "upload it, and start MQTT logs.", ) parser_run.add_argument( "--upload-port", help="Manually specify the upload port/ip to use. " "For example /dev/cu.SLAB_USBtoUART.", ) parser_run.add_argument( "--no-logs", help="Disable starting MQTT logs.", action="store_true" ) parser_run.add_argument( "--topic", help="Manually set the topic to subscribe to for logs." ) parser_run.add_argument( "--username", help="Manually set the MQTT username for logs." ) parser_run.add_argument( "--password", help="Manually set the MQTT password for logs." ) parser_run.add_argument("--client-id", help="Manually set the client id for logs.") parser_clean = subparsers.add_parser( "clean-mqtt", help="Helper to clear an MQTT topic from " "retain messages." ) parser_clean.add_argument("--topic", help="Manually set the topic to subscribe to.") parser_clean.add_argument("--username", help="Manually set the username.") parser_clean.add_argument("--password", help="Manually set the password.") parser_clean.add_argument("--client-id", help="Manually set the client id.") subparsers.add_parser( "wizard", help="A helpful setup wizard that will guide " "you through setting up esphome.", ) subparsers.add_parser( "mqtt-fingerprint", help="Get the SSL fingerprint from a MQTT broker." ) subparsers.add_parser("version", help="Print the esphome version and exit.") subparsers.add_parser("clean", help="Delete all temporary build files.") dashboard = subparsers.add_parser( "dashboard", help="Create a simple web server for a dashboard." ) dashboard.add_argument( "--port", help="The HTTP port to open connections on. Defaults to 6052.", type=int, default=6052, ) dashboard.add_argument( "--username", help="The optional username to require " "for authentication.", type=str, default="", ) dashboard.add_argument( "--password", help="The optional password to require " "for authentication.", type=str, default="", ) dashboard.add_argument( "--open-ui", help="Open the dashboard UI in a browser.", action="store_true" ) dashboard.add_argument("--hassio", help=argparse.SUPPRESS, action="store_true") dashboard.add_argument( "--socket", help="Make the dashboard serve under a unix socket", type=str ) vscode = subparsers.add_parser("vscode", help=argparse.SUPPRESS) vscode.add_argument("--ace", action="store_true") subparsers.add_parser("update-all", help=argparse.SUPPRESS) return parser.parse_args(argv[1:]) def run_esphome(argv): args = parse_args(argv) CORE.dashboard = args.dashboard setup_log(args.verbose, args.quiet) if args.command != "version" and not args.configuration: _LOGGER.error("Missing configuration parameter, see esphome --help.") return 1 if sys.version_info < (3, 6, 0): _LOGGER.error( "You're running ESPHome with Python <3.6. ESPHome is no longer compatible " "with this Python version. Please reinstall ESPHome with Python 3.6+" ) return 1 if args.command in PRE_CONFIG_ACTIONS: try: return PRE_CONFIG_ACTIONS[args.command](args) except EsphomeError as e: _LOGGER.error(e) return 1 for conf_path in args.configuration: CORE.config_path = conf_path CORE.dashboard = args.dashboard config = read_config(dict(args.substitution) if args.substitution else {}) if config is None: return 1 CORE.config = config if args.command not in POST_CONFIG_ACTIONS: safe_print(f"Unknown command {args.command}") try: rc = POST_CONFIG_ACTIONS[args.command](args, config) except EsphomeError as e: _LOGGER.error(e) return 1 if rc != 0: return rc CORE.reset() return 0 def main(): try: return run_esphome(sys.argv) except EsphomeError as e: _LOGGER.error(e) return 1 except KeyboardInterrupt: return 1 if __name__ == "__main__": sys.exit(main())