#!/usr/bin/env python # # Copyright 2018 Espressif Systems (Shanghai) PTE LTD # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # from __future__ import print_function import argparse import time import os import sys idf_path = os.environ['IDF_PATH'] sys.path.insert(0, idf_path + "/components/protocomm/python") sys.path.insert(1, idf_path + "/tools/esp_prov") import security import transport import prov # Set this to true to allow exceptions to be thrown config_throw_except = False def on_except(err): if config_throw_except: raise RuntimeError(err) else: print(err) def get_security(secver, pop=None, verbose=False): if secver == 1: return security.Security1(pop, verbose) elif secver == 0: return security.Security0(verbose) return None def get_transport(sel_transport, softap_endpoint=None, ble_devname=None): try: tp = None if (sel_transport == 'softap'): tp = transport.Transport_Softap(softap_endpoint) elif (sel_transport == 'ble'): tp = transport.Transport_BLE(devname = ble_devname, service_uuid = '0000ffff-0000-1000-8000-00805f9b34fb', nu_lookup = { 'prov-session': 'ff51', 'prov-config' : 'ff52', 'proto-ver' : 'ff53' }) elif (sel_transport == 'console'): tp = transport.Transport_Console() return tp except RuntimeError as e: on_except(e) return None def version_match(tp, protover): try: response = tp.send_data('proto-ver', protover) if response != "SUCCESS": return False return True except RuntimeError as e: on_except(e) return None def establish_session(tp, sec): try: response = None while True: request = sec.security_session(response) if request == None: break response = tp.send_data('prov-session', request) if (response == None): return False return True except RuntimeError as e: on_except(e) return None def custom_config(tp, sec, custom_info, custom_ver): try: message = prov.custom_config_request(sec, custom_info, custom_ver) response = tp.send_data('custom-config', message) return (prov.custom_config_response(sec, response) == 0) except RuntimeError as e: on_except(e) return None def send_wifi_config(tp, sec, ssid, passphrase): try: message = prov.config_set_config_request(sec, ssid, passphrase) response = tp.send_data('prov-config', message) return (prov.config_set_config_response(sec, response) == 0) except RuntimeError as e: on_except(e) return None def apply_wifi_config(tp, sec): try: message = prov.config_apply_config_request(sec) response = tp.send_data('prov-config', message) return (prov.config_set_config_response(sec, response) == 0) except RuntimeError as e: on_except(e) return None def get_wifi_config(tp, sec): try: message = prov.config_get_status_request(sec) response = tp.send_data('prov-config', message) return prov.config_get_status_response(sec, response) except RuntimeError as e: on_except(e) return None if __name__ == '__main__': parser = argparse.ArgumentParser(description="Generate ESP prov payload") parser.add_argument("--ssid", dest = 'ssid', type = str, help = "SSID of Wi-Fi Network", required = True) parser.add_argument("--passphrase", dest = 'passphrase', type = str, help = "Passphrase of Wi-Fi network", default = '') parser.add_argument("--sec_ver", dest = 'secver', type = int, help = "Security scheme version", default = 1) parser.add_argument("--proto_ver", dest = 'protover', type = str, help = "Protocol version", default = 'V0.1') parser.add_argument("--pop", dest = 'pop', type = str, help = "Proof of possession", default = '') parser.add_argument("--softap_endpoint", dest = 'softap_endpoint', type = str, help = ", http(s):// shouldn't be included", default = '192.168.4.1:80') parser.add_argument("--ble_devname", dest = 'ble_devname', type = str, help = "BLE Device Name", default = '') parser.add_argument("--transport", dest = 'provmode', type = str, help = "provisioning mode i.e console or softap or ble", default = 'softap') parser.add_argument("--custom_config", help="Provision Custom Configuration", action = "store_true") parser.add_argument("--custom_info", dest = 'custom_info', type = str, help = "Custom Config Info String", default = '') parser.add_argument("--custom_ver", dest = 'custom_ver', type = int, help = "Custom Config Version Number", default = 2) parser.add_argument("-v","--verbose", help = "increase output verbosity", action = "store_true") args = parser.parse_args() print("==== Esp_Prov Version: " + args.protover + " ====") security = get_security(args.secver, args.pop, args.verbose) if security == None: print("---- Invalid Security Version ----") exit(1) transport = get_transport(args.provmode, args.softap_endpoint, args.ble_devname) if transport == None: print("---- Invalid provisioning mode ----") exit(2) print("\n==== Verifying protocol version ====") if not version_match(transport, args.protover): print("---- Error in protocol version matching ----") exit(3) print("==== Verified protocol version successfully ====") print("\n==== Starting Session ====") if not establish_session(transport, security): print("---- Error in establishing session ----") exit(4) print("==== Session Established ====") if args.custom_config: print("\n==== Sending Custom config to esp32 ====") if not custom_config(transport, security, args.custom_info, args.custom_ver): print("---- Error in custom config ----") exit(5) print("==== Custom config sent successfully ====") print("\n==== Sending Wi-Fi credential to esp32 ====") if not send_wifi_config(transport, security, args.ssid, args.passphrase): print("---- Error in send Wi-Fi config ----") exit(6) print("==== Wi-Fi Credentials sent successfully ====") print("\n==== Applying config to esp32 ====") if not apply_wifi_config(transport, security): print("---- Error in apply Wi-Fi config ----") exit(7) print("==== Apply config sent successfully ====") while True: time.sleep(5) print("\n==== Wi-Fi connection state ====") ret = get_wifi_config(transport, security) if (ret == 1): continue elif (ret == 0): print("==== Provisioning was successful ====") else: print("---- Provisioning failed ----") break