add smart_config example

2025-08-06 07:00:05 +08:00 · 2015-05-11 16:20:25 +08:00
parent 43585fa745
commit 65d34be48b
7 changed files with 522 additions and 0 deletions
--- a/examples/smart_config/Makefile
+++ b/examples/smart_config/Makefile
@ -0,0 +1,120 @@
+#############################################################
+# Required variables for each makefile
+# Discard this section from all parent makefiles
+# Expected variables (with automatic defaults):
+#   CSRCS (all "C" files in the dir)
+#   SUBDIRS (all subdirs with a Makefile)
+#   GEN_LIBS - list of libs to be generated ()
+#   GEN_IMAGES - list of object file images to be generated ()
+#   GEN_BINS - list of binaries to be generated ()
+#   COMPONENTS_xxx - a list of libs/objs in the form
+#     subdir/lib to be extracted and rolled up into
+#     a generated lib/image xxx.a ()
+#
+TARGET = eagle
+#FLAVOR = release
+FLAVOR = debug
+
+#EXTRA_CCFLAGS += -u
+
+ifndef PDIR # {
+GEN_IMAGES= eagle.app.v6.out
+GEN_BINS= eagle.app.v6.bin
+SPECIAL_MKTARGETS=$(APP_MKTARGETS)
+SUBDIRS=    \
+	user
+
+endif # } PDIR
+
+APPDIR = .
+LDDIR = ../ld
+
+CCFLAGS += -Os
+
+TARGET_LDFLAGS =		\
+	-nostdlib		\
+	-Wl,-EL \
+	--longcalls \
+	--text-section-literals
+
+ifeq ($(FLAVOR),debug)
+    TARGET_LDFLAGS += -g -O2
+endif
+
+ifeq ($(FLAVOR),release)
+    TARGET_LDFLAGS += -g -O0
+endif
+
+COMPONENTS_eagle.app.v6 = \
+	user/libuser.a
+
+LINKFLAGS_eagle.app.v6 = \
+	-L../lib        \
+	-nostdlib	\
+    -T$(LD_FILE)   \
+	-Wl,--no-check-sections	\
+    -u call_user_start	\
+	-Wl,-static						\
+	-Wl,--start-group					\
+	-lgcc					\
+	-lhal					\
+	-lphy	\
+	-lpp	\
+	-lnet80211	\
+	-lwpa	\
+	-lmain	\
+	-lfreertos	\
+	-llwip	\
+	-ludhcp	\
+	-lsmartconfig \
+	$(DEP_LIBS_eagle.app.v6)					\
+	-Wl,--end-group
+
+DEPENDS_eagle.app.v6 = \
+                $(LD_FILE) \
+                $(LDDIR)/eagle.rom.addr.v6.ld
+
+#############################################################
+# Configuration i.e. compile options etc.
+# Target specific stuff (defines etc.) goes in here!
+# Generally values applying to a tree are captured in the
+#   makefile at its root level - these are then overridden
+#   for a subtree within the makefile rooted therein
+#
+
+#UNIVERSAL_TARGET_DEFINES =		\
+
+# Other potential configuration flags include:
+#	-DTXRX_TXBUF_DEBUG
+#	-DTXRX_RXBUF_DEBUG
+#	-DWLAN_CONFIG_CCX
+CONFIGURATION_DEFINES =	-DICACHE_FLASH
+
+DEFINES +=				\
+	$(UNIVERSAL_TARGET_DEFINES)	\
+	$(CONFIGURATION_DEFINES)
+
+DDEFINES +=				\
+	$(UNIVERSAL_TARGET_DEFINES)	\
+	$(CONFIGURATION_DEFINES)
+
+
+#############################################################
+# Recursion Magic - Don't touch this!!
+#
+# Each subtree potentially has an include directory
+#   corresponding to the common APIs applicable to modules
+#   rooted at that subtree. Accordingly, the INCLUDE PATH
+#   of a module can only contain the include directories up
+#   its parent path, and not its siblings
+#
+# Required for each makefile to inherit from the parent
+#
+
+INCLUDES := $(INCLUDES) -I $(PDIR)include
+PDIR := ../$(PDIR)
+sinclude $(PDIR)Makefile
+
+.PHONY: FORCE
+FORCE:
+
--- a/examples/smart_config/gen_misc.bat
+++ b/examples/smart_config/gen_misc.bat
@ -0,0 +1,121 @@
+@echo off
+
+echo Please follow below steps(1-5) to generate specific bin(s):
+echo STEP 1: choose boot version(0=boot_v1.1, 1=boot_v1.2+, 2=none)
+set input=default
+set /p input=enter(0/1/2, default 2):
+
+if %input% equ 0 (
+    set boot=old
+) else (
+if %input% equ 1 (
+    set boot=new
+) else (
+    set boot=none
+)
+)
+
+echo boot mode: %boot%
+echo.
+
+echo STEP 2: choose bin generate(0=eagle.flash.bin+eagle.irom0text.bin, 1=user1.bin, 2=user2.bin)
+set input=default
+set /p input=enter (0/1/2, default 0):
+
+if %input% equ 1 (
+    if %boot% equ none (
+        set app=0
+        echo choose no boot before
+        echo generate bin: eagle.flash.bin+eagle.irom0text.bin
+    ) else (
+        set app=1
+        echo generate bin: user1.bin
+    )
+) else (
+if %input% equ 2 (
+    if %boot% equ none (
+        set app=0
+        echo choose no boot before
+        echo generate bin: eagle.flash.bin+eagle.irom0text.bin
+    ) else (
+        set app=2
+        echo generate bin: user2.bin
+    )
+) else (
+    if %boot% neq none (
+        set boot=none
+        echo ignore boot
+    )
+    set app=0
+    echo generate bin: eagle.flash.bin+eagle.irom0text.bin
+))
+
+echo.
+
+echo STEP 3: choose spi speed(0=20MHz, 1=26.7MHz, 2=40MHz, 3=80MHz)
+set input=default
+set /p input=enter (0/1/2/3, default 2):
+
+if %input% equ 0 (
+    set spi_speed=20
+) else (
+if %input% equ 1 (
+    set spi_speed=26.7
+) else (
+if %input% equ 3 (
+    set spi_speed=80
+) else (
+    set spi_speed=40
+)))
+
+echo spi speed: %spi_speed% MHz
+echo.
+
+echo STEP 4: choose spi mode(0=QIO, 1=QOUT, 2=DIO, 3=DOUT)
+set input=default
+set /p input=enter (0/1/2/3, default 0):
+
+if %input% equ 1 (
+    set spi_mode=QOUT
+) else (
+if %input% equ 2 (
+    set spi_mode=DIO
+) else (
+if %input% equ 3 (
+    set spi_mode=DOUT
+) else (
+    set spi_mode=QIO
+)))
+
+echo spi mode: %spi_mode%
+echo.
+
+echo STEP 5: choose spi size(0=256KB, 1=512KB, 2=1024KB, 3=2048KB, 4=4096KB)
+set input=default
+set /p input=enter (0/1/2/3/4, default 1):
+
+if %input% equ 0 (
+    set spi_size=256
+) else (
+if %input% equ 2 (
+    set spi_size=1024
+) else (
+if %input% equ 3 (
+    set spi_size=2048
+) else (
+if %input% equ 4 (
+    set spi_size=4096
+) else (
+    set spi_size=512
+))))
+
+echo spi size: %spi_size% KB
+
+touch user/user_main.c
+
+echo.
+echo start...
+echo.
+
+make BOOT=%boot% APP=%app% SPI_SPEED=%spi_speed% SPI_MODE=%spi_mode% SPI_SIZE=%spi_size%
+
--- a/examples/smart_config/gen_misc.sh
+++ b/examples/smart_config/gen_misc.sh
@ -0,0 +1,126 @@
+#!/bin/bash
+
+echo "Please follow below steps(1-5) to generate specific bin(s):"
+echo "STEP 1: choose boot version(0=boot_v1.1, 1=boot_v1.2+, 2=none)"
+echo "enter(0/1/2, default 2):"
+read input
+
+if [ -z "$input" ]; then
+    boot=none
+elif [ $input == 0 ]; then
+	boot=old
+elif [ $input == 1 ]; then
+    boot=new
+else
+    boot=none
+fi
+
+echo "boot mode: $boot"
+echo ""
+
+echo "STEP 2: choose bin generate(0=eagle.flash.bin+eagle.irom0text.bin, 1=user1.bin, 2=user2.bin)"
+echo "enter (0/1/2, default 0):"
+read input
+
+if [ -z "$input" ]; then
+    if [ $boot != none ]; then
+    	boot=none
+	echo "ignore boot"
+    fi
+    app=0
+    echo "generate bin: eagle.flash.bin+eagle.irom0text.bin"
+elif [ $input == 1 ]; then
+    if [ $boot == none ]; then
+    	app=0
+	echo "choose no boot before"
+	echo "generate bin: eagle.flash.bin+eagle.irom0text.bin"
+    else
+	app=1
+        echo "generate bin: user1.bin"
+    fi
+elif [ $input == 2 ]; then
+    if [ $boot == none ]; then
+    	app=0
+	echo "choose no boot before"
+	echo "generate bin: eagle.flash.bin+eagle.irom0text.bin"
+    else
+    	app=2
+    	echo "generate bin: user2.bin"
+    fi
+else
+    if [ $boot != none ]; then
+    	boot=none
+	echo "ignore boot"
+    fi
+    app=0
+    echo "generate bin: eagle.flash.bin+eagle.irom0text.bin"
+fi
+
+echo ""
+
+echo "STEP 3: choose spi speed(0=20MHz, 1=26.7MHz, 2=40MHz, 3=80MHz)"
+echo "enter (0/1/2/3, default 2):"
+read input
+
+if [ -z "$input" ]; then
+    spi_speed=40
+elif [ $input == 0 ]; then
+    spi_speed=20
+elif [ $input == 1 ]; then
+    spi_speed=26.7
+elif [ $input == 3 ]; then
+    spi_speed=80
+else
+    spi_speed=40
+fi
+
+echo "spi speed: $spi_speed MHz"
+echo ""
+
+echo "STEP 4: choose spi mode(0=QIO, 1=QOUT, 2=DIO, 3=DOUT)"
+echo "enter (0/1/2/3, default 0):"
+read input
+
+if [ -z "$input" ]; then
+    spi_mode=QIO
+elif [ $input == 1 ]; then
+    spi_mode=QOUT
+elif [ $input == 2 ]; then
+    spi_mode=DIO
+elif [ $input == 3 ]; then
+    spi_mode=DOUT
+else
+    spi_mode=QIO
+fi
+
+echo "spi mode: $spi_mode"
+echo ""
+
+echo "STEP 5: choose spi size(0=256KB, 1=512KB, 2=1024KB, 3=2048KB, 4=4096KB)"
+echo "enter (0/1/2/3/4, default 1):"
+read input
+
+if [ -z "$input" ]; then
+    spi_size=512
+elif [ $input == 0 ]; then
+    spi_size=256
+elif [ $input == 2 ]; then
+    spi_size=1024
+elif [ $input == 3 ]; then
+    spi_size=2048
+elif [ $input == 4 ]; then
+    spi_size=4096
+else
+    spi_size=512
+fi
+
+echo "spi size: $spi_size KB"
+echo ""
+
+touch user/user_main.c
+
+echo ""
+echo "start..."
+echo ""
+
+make COMPILE=gcc BOOT=$boot APP=$app SPI_SPEED=$spi_speed SPI_MODE=$spi_mode SPI_SIZE=$spi_size
--- a/examples/smart_config/include/user_config.h
+++ b/examples/smart_config/include/user_config.h
@ -0,0 +1,5 @@
+#ifndef __USER_CONFIG_H__
+#define __USER_CONFIG_H__
+
+#endif
+
--- a/examples/smart_config/readme.txt
+++ b/examples/smart_config/readme.txt
@ -0,0 +1,40 @@
+1<EFBFBD><EFBFBD>compile options
+
+(1) COMPILE
+    Possible value: gcc
+    Default value: 
+    If not set, use xt-xcc by default.
+
+(2) BOOT
+    Possible value: none/old/new
+      none: no need boot
+      old: use boot_v1.1
+      new: use boot_v1.2
+    Default value: none
+
+(3) APP
+    Possible value: 0/1/2
+      0: original mode, generate eagle.app.v6.flash.bin and eagle.app.v6.irom0text.bin
+      1: generate user1
+      2: generate user2
+    Default value: 0
+
+(3) SPI_SPEED
+    Possible value: 20/26.7/40/80
+    Default value: 40
+
+(4) SPI_MODE
+    Possible value: QIO/QOUT/DIO/DOUT
+    Default value: QIO
+
+(4) SPI_SIZE
+    Possible value: 256/512/1024/2048/4096
+    Default value: 512
+
+For example:
+    make COMPILE=gcc BOOT=new APP=1 SPI_SPEED=40 SPI_MODE=QIO SPI_SIZE=512
+
+2<EFBFBD><EFBFBD>You can also use gen_misc to make and generate specific bin you needed.
+    Linux: ./gen_misc.sh
+    Windows: gen_misc.bat
+    Follow the tips and steps.
--- a/examples/smart_config/user/Makefile
+++ b/examples/smart_config/user/Makefile
@ -0,0 +1,43 @@
+
+#############################################################
+# Required variables for each makefile
+# Discard this section from all parent makefiles
+# Expected variables (with automatic defaults):
+#   CSRCS (all "C" files in the dir)
+#   SUBDIRS (all subdirs with a Makefile)
+#   GEN_LIBS - list of libs to be generated ()
+#   GEN_IMAGES - list of images to be generated ()
+#   COMPONENTS_xxx - a list of libs/objs in the form
+#     subdir/lib to be extracted and rolled up into
+#     a generated lib/image xxx.a ()
+#
+ifndef PDIR
+GEN_LIBS = libuser.a
+endif
+
+
+#############################################################
+# Configuration i.e. compile options etc.
+# Target specific stuff (defines etc.) goes in here!
+# Generally values applying to a tree are captured in the
+#   makefile at its root level - these are then overridden
+#   for a subtree within the makefile rooted therein
+#
+#DEFINES += 
+
+#############################################################
+# Recursion Magic - Don't touch this!!
+#
+# Each subtree potentially has an include directory
+#   corresponding to the common APIs applicable to modules
+#   rooted at that subtree. Accordingly, the INCLUDE PATH
+#   of a module can only contain the include directories up
+#   its parent path, and not its siblings
+#
+# Required for each makefile to inherit from the parent
+#
+
+INCLUDES := $(INCLUDES) -I $(PDIR)include
+PDIR := ../$(PDIR)
+sinclude $(PDIR)Makefile
+
--- a/examples/smart_config/user/user_main.c
+++ b/examples/smart_config/user/user_main.c
@ -0,0 +1,67 @@
+/******************************************************************************
+ * Copyright 2013-2014 Espressif Systems (Wuxi)
+ *
+ * FileName: user_main.c
+ *
+ * Description: entry file of user application
+ *
+ * Modification history:
+ *     2014/12/1, v1.0 create this file.
+*******************************************************************************/
+#include "esp_common.h"
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+#include "lwip/sockets.h"
+#include "lwip/dns.h"
+#include "lwip/netdb.h"
+
+#include "udhcp/dhcpd.h"
+
+#define server_ip "192.168.101.142"
+#define server_port 9669
+
+void ICACHE_FLASH_ATTR
+smartconfig_done(void *data)
+{
+	struct station_config *sta_conf = data;
+	
+	wifi_station_set_config(sta_conf);
+	wifi_station_disconnect();
+	wifi_station_connect();
+}
+
+void ICACHE_FLASH_ATTR
+smartconfig_task(void *pvParameters)
+{
+    smartconfig_start(SC_TYPE_ESPTOUCH, smartconfig_done);//SC_TYPE_AIRKISS
+
+    vTaskDelete(NULL);
+}
+
+void ICACHE_FLASH_ATTR
+sc_smartconfig_check(void)
+{
+    if(SC_STATUS_LINK_OVER == smartconfig_get_status()) {
+        smartconfig_stop();
+    }
+    
+}
+/******************************************************************************
+ * FunctionName : user_init
+ * Description  : entry of user application, init user function here
+ * Parameters   : none
+ * Returns      : none
+*******************************************************************************/
+void ICACHE_FLASH_ATTR
+user_init(void)
+{
+    printf("SDK version:%s\n", system_get_sdk_version());
+
+    /* need to set opmode before you set config */
+    wifi_set_opmode(STATION_MODE);
+
+    xTaskCreate(smartconfig_task, "smartconfig_task", 256, NULL, 2, NULL);
+}
+