def wizard(path):
if not path.endswith(".yaml") and not path.endswith(".yml"):
safe_print(
"Please make your configuration file {} have the extension .yaml or .yml"
"".format(color(Fore.CYAN, path)))
return 1
if os.path.exists(path):
safe_print(
"Uh oh, it seems like {} already exists, please delete that file first "
"or chose another configuration file.".format(
color(Fore.CYAN, path)))
return 2
safe_print("Hi there!")
sleep(1.5)
safe_print("I'm the wizard of ESPHome :)")
sleep(1.25)
safe_print("And I'm here to help you get started with ESPHome.")
sleep(2.0)
safe_print(
"In 4 steps I'm going to guide you through creating a basic "
"configuration file for your custom ESP8266/ESP32 firmware. Yay!")
sleep(3.0)
safe_print()
safe_print_step(1, CORE_BIG)
safe_print("First up, please choose a " + color(Fore.GREEN, "name") +
" for your node.")
safe_print(
"It should be a unique name that can be used to identify the device later."
)
sleep(1)
safe_print(
"For example, I like calling the node in my living room {}.".format(
color(Fore.BOLD_WHITE, "livingroom")))
safe_print()
sleep(1)
name = input(color(Fore.BOLD_WHITE, "(name): "))
while True:
try:
name = cv.valid_name(name)
break
except vol.Invalid:
safe_print(
color(
Fore.RED,
f'Oh noes, "{name}" isn\'t a valid name. Names can only '
f"include numbers, lower-case letters and hyphens. ",
))
name = strip_accents(name).lower().replace(" ", "-")
name = strip_accents(name).lower().replace("_", "-")
name = "".join(c for c in name if c in ALLOWED_NAME_CHARS)
safe_print('Shall I use "{}" as the name instead?'.format(
color(Fore.CYAN, name)))
sleep(0.5)
name = default_input("(name [{}]): ", name)
safe_print('Great! Your node is now called "{}".'.format(
color(Fore.CYAN, name)))
sleep(1)
safe_print_step(2, ESP_BIG)
safe_print(
"Now I'd like to know what microcontroller you're using so that I can compile "
"firmwares for it.")
safe_print("Are you using an " + color(Fore.GREEN, "ESP32") + " or " +
color(Fore.GREEN, "ESP8266") +
" platform? (Choose ESP8266 for Sonoff devices)")
while True:
sleep(0.5)
safe_print()
safe_print("Please enter either ESP32 or ESP8266.")
platform = input(color(Fore.BOLD_WHITE, "(ESP32/ESP8266): "))
try:
platform = vol.All(vol.Upper, vol.Any("ESP32",
"ESP8266"))(platform)
break
except vol.Invalid:
safe_print(
"Unfortunately, I can't find an espressif microcontroller called "
'"{}". Please try again.'.format(platform))
safe_print("Thanks! You've chosen {} as your platform.".format(
color(Fore.CYAN, platform)))
safe_print()
sleep(1)
if platform == "ESP32":
board_link = (
"http://docs.platformio.org/en/latest/platforms/espressif32.html#boards"
)
else:
board_link = (
"http://docs.platformio.org/en/latest/platforms/espressif8266.html#boards"
)
safe_print("Next, I need to know what " + color(Fore.GREEN, "board") +
" you're using.")
sleep(0.5)
safe_print("Please go to {} and choose a board.".format(
color(Fore.GREEN, board_link)))
if platform == "ESP32":
safe_print("(Type " + color(Fore.GREEN, "esp01_1m") +
" for Sonoff devices)")
safe_print()
# Don't sleep because user needs to copy link
if platform == "ESP32":
safe_print('For example "{}".'.format(
color(Fore.BOLD_WHITE, "nodemcu-32s")))
boards = list(ESP32_BOARD_PINS.keys())
else:
safe_print('For example "{}".'.format(
color(Fore.BOLD_WHITE, "nodemcuv2")))
boards = list(ESP8266_BOARD_PINS.keys())
safe_print("Options: {}".format(", ".join(sorted(boards))))
while True:
board = input(color(Fore.BOLD_WHITE, "(board): "))
try:
board = vol.All(vol.Lower, vol.Any(*boards))(board)
break
except vol.Invalid:
safe_print(
color(Fore.RED,
f'Sorry, I don\'t think the board "{board}" exists.'))
safe_print()
sleep(0.25)
safe_print()
safe_print("Way to go! You've chosen {} as your board.".format(
color(Fore.CYAN, board)))
safe_print()
sleep(1)
safe_print_step(3, WIFI_BIG)
safe_print("In this step, I'm going to create the configuration for "
"WiFi.")
safe_print()
sleep(1)
safe_print("First, what's the " + color(Fore.GREEN, "SSID") +
f" (the name) of the WiFi network {name} should connect to?")
sleep(1.5)
safe_print('For example "{}".'.format(
color(Fore.BOLD_WHITE, "Abraham Linksys")))
while True:
ssid = input(color(Fore.BOLD_WHITE, "(ssid): "))
try:
ssid = cv.ssid(ssid)
break
except vol.Invalid:
safe_print(
color(
Fore.RED,
'Unfortunately, "{}" doesn\'t seem to be a valid SSID. '
"Please try again.".format(ssid),
))
safe_print()
sleep(1)
safe_print('Thank you very much! You\'ve just chosen "{}" as your SSID.'
"".format(color(Fore.CYAN, ssid)))
safe_print()
sleep(0.75)
safe_print(
"Now please state the " + color(Fore.GREEN, "password") +
" of the WiFi network so that I can connect to it (Leave empty for no password)"
)
safe_print()
safe_print('For example "{}"'.format(color(Fore.BOLD_WHITE, "PASSWORD42")))
sleep(0.5)
psk = input(color(Fore.BOLD_WHITE, "(PSK): "))
safe_print(
"Perfect! WiFi is now set up (you can create static IPs and so on later)."
)
sleep(1.5)
safe_print_step(4, OTA_BIG)
safe_print(
"Almost there! ESPHome can automatically upload custom firmwares over WiFi "
"(over the air) and integrates into Home Assistant with a native API.")
safe_print(
"This can be insecure if you do not trust the WiFi network. Do you want to set "
"a " + color(Fore.GREEN, "password") + " for connecting to this ESP?")
safe_print()
sleep(0.25)
safe_print("Press ENTER for no password")
password = input(color(Fore.BOLD_WHITE, "(password): "))
wizard_write(
path=path,
name=name,
platform=platform,
board=board,
ssid=ssid,
psk=psk,
password=password,
)
safe_print()
safe_print(
color(Fore.CYAN, "DONE! I've now written a new configuration file to ")
+ color(Fore.BOLD_CYAN, path))
safe_print()
safe_print("Next steps:")
safe_print(
' > Check your Home Assistant "integrations" screen. If all goes well, you '
"should see your ESP being discovered automatically.")
safe_print(" > Then follow the rest of the getting started guide:")
safe_print(
" > https://esphome.io/guides/getting_started_command_line.html")
return 0
def wizard(path):
if not path.endswith('.yaml') and not path.endswith('.yml'):
safe_print(
u"Please make your configuration file {} have the extension .yaml or .yml"
u"".format(color('cyan', path)))
return 1
if os.path.exists(path):
safe_print(
u"Uh oh, it seems like {} already exists, please delete that file first "
u"or chose another configuration file.".format(color('cyan',
path)))
return 1
safe_print("Hi there!")
sleep(1.5)
safe_print("I'm the wizard of ESPHome :)")
sleep(1.25)
safe_print("And I'm here to help you get started with ESPHome.")
sleep(2.0)
safe_print(
"In 4 steps I'm going to guide you through creating a basic "
"configuration file for your custom ESP8266/ESP32 firmware. Yay!")
sleep(3.0)
safe_print()
safe_print_step(1, CORE_BIG)
safe_print("First up, please choose a " + color('green', 'name') +
" for your node.")
safe_print(
"It should be a unique name that can be used to identify the device later."
)
sleep(1)
safe_print(
"For example, I like calling the node in my living room {}.".format(
color('bold_white', "livingroom")))
safe_print()
sleep(1)
name = safe_input(color("bold_white", "(name): "))
while True:
try:
name = cv.valid_name(name)
break
except vol.Invalid:
safe_print(
color(
"red",
u"Oh noes, \"{}\" isn't a valid name. Names can only include "
u"numbers, letters and underscores.".format(name)))
name = strip_accents(name).replace(' ', '_')
name = u''.join(c for c in name if c in cv.ALLOWED_NAME_CHARS)
safe_print(u"Shall I use \"{}\" as the name instead?".format(
color('cyan', name)))
sleep(0.5)
name = default_input(u"(name [{}]): ", name)
safe_print(u"Great! Your node is now called \"{}\".".format(
color('cyan', name)))
sleep(1)
safe_print_step(2, ESP_BIG)
safe_print(
"Now I'd like to know what microcontroller you're using so that I can compile "
"firmwares for it.")
safe_print("Are you using an " + color('green', 'ESP32') + " or " +
color('green', 'ESP8266') +
" platform? (Choose ESP8266 for Sonoff devices)")
while True:
sleep(0.5)
safe_print()
safe_print("Please enter either ESP32 or ESP8266.")
platform = safe_input(color("bold_white", "(ESP32/ESP8266): "))
try:
platform = vol.All(vol.Upper, vol.Any('ESP32',
'ESP8266'))(platform)
break
except vol.Invalid:
safe_print(
u"Unfortunately, I can't find an espressif microcontroller called "
u"\"{}\". Please try again.".format(platform))
safe_print(u"Thanks! You've chosen {} as your platform.".format(
color('cyan', platform)))
safe_print()
sleep(1)
if platform == 'ESP32':
board_link = 'http://docs.platformio.org/en/latest/platforms/espressif32.html#boards'
else:
board_link = 'http://docs.platformio.org/en/latest/platforms/espressif8266.html#boards'
safe_print("Next, I need to know what " + color('green', 'board') +
" you're using.")
sleep(0.5)
safe_print("Please go to {} and choose a board.".format(
color('green', board_link)))
if platform == 'ESP32':
safe_print("(Type " + color('green', 'esp01_1m') +
" for Sonoff devices)")
safe_print()
# Don't sleep because user needs to copy link
if platform == 'ESP32':
safe_print("For example \"{}\".".format(
color("bold_white", 'nodemcu-32s')))
boards = list(ESP32_BOARD_PINS.keys())
else:
safe_print("For example \"{}\".".format(
color("bold_white", 'nodemcuv2')))
boards = list(ESP8266_BOARD_PINS.keys())
safe_print("Options: {}".format(', '.join(boards)))
while True:
board = safe_input(color("bold_white", "(board): "))
try:
board = vol.All(vol.Lower, vol.Any(*boards))(board)
break
except vol.Invalid:
safe_print(
color('red', "Sorry, I don't think the board \"{}\" exists."))
safe_print()
sleep(0.25)
safe_print()
safe_print(u"Way to go! You've chosen {} as your board.".format(
color('cyan', board)))
safe_print()
sleep(1)
safe_print_step(3, WIFI_BIG)
safe_print("In this step, I'm going to create the configuration for "
"WiFi.")
safe_print()
sleep(1)
safe_print("First, what's the " + color('green', 'SSID') +
u" (the name) of the WiFi network {} I should connect to?".
format(name))
sleep(1.5)
safe_print("For example \"{}\".".format(
color('bold_white', "Abraham Linksys")))
while True:
ssid = safe_input(color('bold_white', "(ssid): "))
try:
ssid = cv.ssid(ssid)
break
except vol.Invalid:
safe_print(
color(
'red',
u"Unfortunately, \"{}\" doesn't seem to be a valid SSID. "
u"Please try again.".format(ssid)))
safe_print()
sleep(1)
safe_print(u"Thank you very much! You've just chosen \"{}\" as your SSID."
u"".format(color('cyan', ssid)))
safe_print()
sleep(0.75)
safe_print(
"Now please state the " + color('green', 'password') +
" of the WiFi network so that I can connect to it (Leave empty for no password)"
)
safe_print()
safe_print("For example \"{}\"".format(color('bold_white', 'PASSWORD42')))
sleep(0.5)
psk = safe_input(color('bold_white', '(PSK): '))
safe_print(
"Perfect! WiFi is now set up (you can create static IPs and so on later)."
)
sleep(1.5)
safe_print_step(4, OTA_BIG)
safe_print(
"Almost there! ESPHome can automatically upload custom firmwares over WiFi "
"(over the air) and integrates into Home Assistant with a native API.")
safe_print(
"This can be insecure if you do not trust the WiFi network. Do you want to set "
"a " + color('green', 'password') + " for connecting to this ESP?")
safe_print()
sleep(0.25)
safe_print("Press ENTER for no password")
password = safe_input(color('bold_white', '(password): '))
wizard_write(path=path,
name=name,
platform=platform,
board=board,
ssid=ssid,
psk=psk,
password=password)
safe_print()
safe_print(
color('cyan', "DONE! I've now written a new configuration file to ") +
color('bold_cyan', path))
safe_print()
safe_print("Next steps:")
safe_print(
" > Check your Home Assistant \"integrations\" screen. If all goes well, you "
"should see your ESP being discovered automatically.")
safe_print(" > Then follow the rest of the getting started guide:")
safe_print(
" > https://esphome.io/guides/getting_started_command_line.html")
return 0