/** * Predefined AutoConnect configuration parameters. * @file AutoConnectDefs.h * @author hieromon@gmail.com * @version 1.1.0 * @date 2019-10-11 * @copyright MIT license. */ #ifndef _AUTOCONNECTDEFS_H_ #define _AUTOCONNECTDEFS_H_ // Uncomment the following AC_DEBUG to enable debug output. //#define AC_DEBUG // Debug output destination can be defined externally with AC_DEBUG_PORT #ifndef AC_DEBUG_PORT #define AC_DEBUG_PORT Serial #endif // !AC_DEBUG_PORT #ifdef AC_DEBUG #define AC_DBG_DUMB(...) do {AC_DEBUG_PORT.printf( __VA_ARGS__ );} while (0) #define AC_DBG(...) do {AC_DEBUG_PORT.print("[AC] "); AC_DEBUG_PORT.printf( __VA_ARGS__ );} while (0) #else #define AC_DBG(...) #define AC_DBG_DUMB(...) #endif // !AC_DEBUG // Indicator to specify that AutoConnectAux handles elements with JSON. // Comment out the AUTOCONNECT_USE_JSON macro to detach the ArduinoJson. #ifndef AUTOCONNECT_NOUSE_JSON #define AUTOCONNECT_USE_JSON // Indicator of whether to use the AutoConnectUpdate feature. #define AUTOCONNECT_USE_UPDATE #endif // Predefined parameters // SSID that Captive portal started. #ifndef AUTOCONNECT_APID #if defined(ARDUINO_ARCH_ESP8266) #define AUTOCONNECT_APID "esp8266ap" #elif defined(ARDUINO_ARCH_ESP32) #define AUTOCONNECT_APID "esp32ap" #endif // !ARDUINO_ARCH_ESP8266 #endif // !AUTOCONNECT_APID // Password that Captive portal started. #ifndef AUTOCONNECT_PSK #define AUTOCONNECT_PSK "12345678" #endif // !AUTOCONNECT_PSK #ifndef AUTOCONNECT_AP_IP // #define AUTOCONNECT_AP_IP 0x01F4A8C0 //*< 192.168.244.1 */ #define AUTOCONNECT_AP_IP 0x011CD9AC //*< 172.217.28.1 */ #endif // !AUTOCONNECT_AP_IP #ifndef AUTOCONNECT_AP_GW // #define AUTOCONNECT_AP_GW 0x01F4A8C0 //*< 192.168.244.1 */ #define AUTOCONNECT_AP_GW 0x011CD9AC //*< 172.217.28.1 */ #endif // !AUTOCONNECT_AP_GW #ifndef AUTOCONNECT_AP_NM #define AUTOCONNECT_AP_NM 0x00FFFFFF //*< 255.255.255.0 */ #endif // !AUTOCONNECT_AP_NM #ifndef AUTOCONNECT_AP_CH #define AUTOCONNECT_AP_CH 1 #endif // !AUTOCONNECT_AP_CH // AutoConnect menu root path #ifndef AUTOCONNECT_URI #define AUTOCONNECT_URI "/_ac" #endif // !AUTOCONNECT_URI // Root URI of home path prepared by user sketch #ifndef AUTOCONNECT_HOMEURI #define AUTOCONNECT_HOMEURI "/" #endif // !AUTOCONNECT_HOMEURI // AutoConnectAux form argument name #ifndef AUTOCONNECT_AUXURI_PARAM #define AUTOCONNECT_AUXURI_PARAM "_acuri" #endif // !AUTOCONNECT_AUXURI_PARAM // AutoConnect menu title #ifndef AUTOCONNECT_MENU_TITLE #define AUTOCONNECT_MENU_TITLE "AutoConnect" #endif // !AUTOCONNECT_MENU_TITLE // URIs of AutoConnect menu collection #define AUTOCONNECT_URI_CONFIG AUTOCONNECT_URI "/config" #define AUTOCONNECT_URI_CONNECT AUTOCONNECT_URI "/connect" #define AUTOCONNECT_URI_RESULT AUTOCONNECT_URI "/result" #define AUTOCONNECT_URI_OPEN AUTOCONNECT_URI "/open" #define AUTOCONNECT_URI_DISCON AUTOCONNECT_URI "/disc" #define AUTOCONNECT_URI_RESET AUTOCONNECT_URI "/reset" #define AUTOCONNECT_URI_SUCCESS AUTOCONNECT_URI "/success" #define AUTOCONNECT_URI_FAIL AUTOCONNECT_URI "/fail" #define AUTOCONNECT_URI_UPDATE AUTOCONNECT_URI "/update" #define AUTOCONNECT_URI_UPDATE_ACT AUTOCONNECT_URI "/update_act" #define AUTOCONNECT_URI_UPDATE_PROGRESS AUTOCONNECT_URI "/update_progress" #define AUTOCONNECT_URI_UPDATE_RESULT AUTOCONNECT_URI "/update_result" // Time-out limitation when AutoConnect::begin [ms] #ifndef AUTOCONNECT_TIMEOUT #define AUTOCONNECT_TIMEOUT 30000 #endif // !AUTOCONNECT_TIMEOUT // Captive portal timeout value [ms] #ifndef AUTOCONNECT_CAPTIVEPORTAL_TIMEOUT #define AUTOCONNECT_CAPTIVEPORTAL_TIMEOUT 0 #endif // !AUTOCONNECT_CAPTIVEPORTAL_TIMEOUT // Advance wait time [s] #ifndef AUTOCONNECT_STARTUPTIME #define AUTOCONNECT_STARTUPTIME (AUTOCONNECT_TIMEOUT/1000) #endif // !AUTOCONNECT_STARTUPTIME // Response wait time until requesting a result of connection attempt, uint:[s] as String #ifndef AUTOCONNECT_RESPONSE_WAITTIME #define AUTOCONNECT_RESPONSE_WAITTIME "2" #endif // !AUTOCONNECT_RESPONSE_WAITTIME // Default HTTP port #ifndef AUTOCONNECT_HTTPPORT #define AUTOCONNECT_HTTPPORT 80 #endif // !AUTOCONNECT_HTTPPORT // DNS port #ifndef AUTOCONNECT_DNSPORT #define AUTOCONNECT_DNSPORT 53 #endif // !AUTOCONNECT_DNSPORT // http response transfer method #ifndef AUTOCONNECT_HTTP_TRANSFER #define AUTOCONNECT_HTTP_TRANSFER PB_ByteStream #endif // !AUTOCONNECT_HTTP_TRANSFER // Reserved buffer size to build content #ifndef AUTOCONNECT_CONTENTBUFFER_SIZE #define AUTOCONNECT_CONTENTBUFFER_SIZE (13 * 1024) #endif // !AUTOCONNECT_CONTENTBUFFER_SIZE // Number of unit lines in the page that lists available SSIDs #ifndef AUTOCONNECT_SSIDPAGEUNIT_LINES #define AUTOCONNECT_SSIDPAGEUNIT_LINES 5 #endif // !AUTOCONNECT_SSIDPAGEUNIT_LINES // SPI transfer speed for SD [Hz] #ifndef AUTOCONNECT_SD_SPEED #define AUTOCONNECT_SD_SPEED 4000000 #endif // !AUTOCONNECT_SD_SPEED // Flicker signal related factors // Flicker cycle during AP operation [ms] #ifndef AUTOCONNECT_FLICKER_PERIODAP #define AUTOCONNECT_FLICKER_PERIODAP 1000 #endif // !AUTOCONNECT_FLICKER_PERIODAP // Flicker cycle while WiFi is not connected [ms] #ifndef AUTOCONNECT_FLICKER_PERIODDC #define AUTOCONNECT_FLICKER_PERIODDC (AUTOCONNECT_FLICKER_PERIODAP << 1) #endif // !AUTOCONNECT_FLICKER_PERIODDC // Flicker pulse width during AP operation (8bit resolution) #ifndef AUTOCONNECT_FLICKER_WIDTHAP #define AUTOCONNECT_FLICKER_WIDTHAP 96 #endif // !AUTOCONNECT_FLICKER_WIDTHAPSTA // Flicker pulse width while WiFi is not connected (8bit resolution) #ifndef AUTOCONNECT_FLICKER_WIDTHDC #define AUTOCONNECT_FLICKER_WIDTHDC 16 #endif // !AUTOCONNECT_FLICKER_WIDTHDISCON // Ticker port #ifndef AUTOCONNECT_TICKER_PORT #if defined(BUILDIN_LED) || defined(LED_BUILTIN) #define AUTOCONNECT_TICKER_PORT LED_BUILTIN #else // Native pin for the arduino #define AUTOCONNECT_TICKER_PORT 2 #endif #endif // ArduinoJson buffer size #ifndef AUTOCONNECT_JSONBUFFER_SIZE #define AUTOCONNECT_JSONBUFFER_SIZE 256 #endif // !AUTOCONNECT_JSONBUFFER_SIZE #ifndef AUTOCONNECT_JSONDOCUMENT_SIZE #define AUTOCONNECT_JSONDOCUMENT_SIZE (8 * 1024) #endif // !AUTOCONNECT_JSONDOCUMENT_SIZE #ifndef AUTOCONNECT_JSONPSRAM_SIZE #define AUTOCONNECT_JSONPSRAM_SIZE (16* 1024) #endif // !AUTOCONNECT_JSONPSRAM_SIZE // Available HTTP port number for the update [ms] #ifndef AUTOCONNECT_UPDATE_PORT #define AUTOCONNECT_UPDATE_PORT 8000 #endif // !AUTOCONNECT_UPDATE_PORT // HTTP client timeout limitation for the update [ms] #ifndef AUTOCONNECT_UPDATE_TIMEOUT #define AUTOCONNECT_UPDATE_TIMEOUT 8000 #endif // !AUTOCONNECT_UPDATE_TIMEOUT // Maximum wait time until transitioning AutoConnectUpdate dialog page [ms] #ifndef AUTOCONNECT_UPDATE_DURATION #define AUTOCONNECT_UPDATE_DURATION 180000 #endif // !AUTOCONNECT_UPDATE_DURATION // Interval time of progress status periodical inquiry [ms] #ifndef AUTOCONNECT_UPDATE_INTERVAL #define AUTOCONNECT_UPDATE_INTERVAL 400 #endif // !AUTOCONNECT_UPDATE_INTERVAL // Wait timer for rebooting after updated #ifndef AUTOCONNECT_UPDATE_WAITFORREBOOT #define AUTOCONNECT_UPDATE_WAITFORREBOOT 9000 #endif // !AUTOCONNECT_UPDATE_WAITFORREBOOT // A signal value that the board dependent LED turns on. // As a typical example, the ON signal of built-in LED such as the // NodeMCU is LOW and the HIGH for the NodeMCU-32S as another example. #ifndef AUTOCONNECT_UPDATE_LEDON // #define AUTOCONNECT_UPDATE_LEDON HIGH #define AUTOCONNECT_UPDATE_LEDON LOW #endif // !AUTOCONNECT_UPDATE_LEDON // URIs of the behaviors owned by the update server #ifndef AUTOCONNECT_UPDATE_CATALOG #define AUTOCONNECT_UPDATE_CATALOG "/_catalog" #endif // !AUTOCONNECT_UPDATE_CATALOG #ifndef AUTOCONNECT_UPDATE_DOWNLOAD #define AUTOCONNECT_UPDATE_DOWNLOAD "/" #endif // !AUTOCONNECT_UPDATE_DOWNLOAD #ifndef AUTOCONNECT_UPDATE_CATALOG_JSONBUFFER_SIZE #define AUTOCONNECT_UPDATE_CATALOG_JSONBUFFER_SIZE 256 #endif // !AUTOCONNECT_UPDATE_CATALOG_JSONBUFFER_SIZE // Explicitly avoiding unused warning with token handler of PageBuilder #define AC_UNUSED(expr) do { (void)(expr); } while (0) // Numeric to string deployment #define AUTOCONNECT_STRING_DEPLOY(n) _AUTOCONNECT_STRING_DEPLOY(n) #define _AUTOCONNECT_STRING_DEPLOY(s) #s // Generates a template that determines whether the class owns the // specified member function. // The purpose of this macro is to avoid the use of invalid member // functions due to differences in the version of the library which // AutoConnect depends on. #define AC_HAS_FUNC(func) \ template \ struct has_func_##func { \ private: \ typedef char one; \ typedef long two; \ template static one test(decltype(&U::func)); \ template static two test(...); \ public: \ enum { value = sizeof(test(0)) == sizeof(char) }; \ } #endif // _AUTOCONNECTDEFS_H_