v1.1.0

Author: Mixiaoxiao

README.md

@@ -12,6 +12,8 @@ Enjoy the "one-key" build, "one-key" upload, and work to link various other Ardu
 
 Here is a [discussion](https://github.com/HomeACcessoryKid/Arduino-HomeKit/issues/1) about the RTOS is required for running Apple HomeKit, and this project is a proof of concept that Apple HomeKit can be implemented and work fine without the RTOS.
 
+This library is built with ESP8266 Arduino Core 2.6.3. Lower versions may compile with errors.
+
 ## Preview
 
 ![Preview](https://raw.github.com/Mixiaoxiao/Arduino-HomeKit-ESP8266/master/extras/preview.jpg) 
@@ -74,11 +76,19 @@ I tried to make WolfSSL crypto work safely on ESP8266 with better performance an
 
 Here are the free heap values of running the example sketch:
 
-* Boot: ~26000
-* Preinit over: ~22000
-* Pairing: ~17000 (or even low when crypto computing)
-* Paired and connected with one iOS device: ~21700
-* Paired and no iOS device connected: ~23400
+* ~~Boot: ~26000~~
+* ~~Preinit over: ~22000~~
+* ~~Pairing: ~17000 (or even low when crypto computing)~~
+* ~~Paired and connected with one iOS device: ~21700~~
+* ~~Paired and no iOS device connected: ~23400~~
+
+After memory optimization in v1.1.0:
+
+* Boot: ~46000
+* Preinit over: ~41000
+* Pairing: ~37000 (or even low when crypto computing)
+* Paired and connected with one iOS device: ~41700
+* Paired and no iOS device connected: ~43000
 
 
 ## WolfSSL
@@ -138,6 +148,10 @@ Here are the free heap values of running the example sketch:
 
 ## Change Log
 
+#### v1.1.0
+* Memory optimization: moved String/byte constants as much as possible to Flash. The `RODATA` section of `bin` is only 4672. Extra ~20K free-heap is available compared with v1.0.1.
+* Upload a [`nossl` and `noleak` version](https://raw.github.com/Mixiaoxiao/Arduino-HomeKit-ESP8266/master/extras/ESP8266WiFi_nossl_noleak) of the official `ESP8266WiFi` library of Arduino Core 2.6.3. Removed all codes of `SSL` to save memory (extra ~3K) since the HomeKit does not require SSL. Fix the memory-leak in `WiFiClinet.stop()` by adding `tcp_abandon(_pcb, 0)` in `stop()`, based on the idea of [esp8266/Arduino/pull/2767](https://github.com/esp8266/Arduino/pull/2767).
+
 #### v1.0.1 
 * Reduce `winsize` from `3` to `2`(same performance) to lower the heap required. Pairing can be done with low free-heap of ~14000.
 * Specify the MDNS runs on the IPAddress of STA to ensure the HomeKit can work with some SoftAP-based WiFi-Config libraries.

examples/simple_led/simple_led.ino

@@ -19,9 +19,6 @@
 #include "ButtonDebounce.h"
 #include "ButtonHandler.h"
 
-#define PL(s) Serial.println(s)
-#define P(s) Serial.print(s)
-
 //D0 16 //led
 //D3  0 //flash button
 //D4  2 //led
@@ -31,6 +28,8 @@
 const char *ssid = "your-ssid";
 const char *password = "your-password";
 
+#define SIMPLE_INFO(fmt, ...)   printf_P(PSTR(fmt "\n") , ##__VA_ARGS__);
+
 void blink_led(int interval, int count) {
 	for (int i = 0; i < count; i++) {
 		builtinledSetStatus(true);
@@ -52,27 +51,26 @@ void setup() {
 	WiFi.setAutoReconnect(true);
 	WiFi.begin(ssid, password);
 
-	printf("\n");
-	printf("SketchSize: %d B\n", ESP.getSketchSize());
-	printf("FreeSketchSpace: %d B\n", ESP.getFreeSketchSpace());
-	printf("FlashChipSize: %d B\n", ESP.getFlashChipSize());
-	printf("FlashChipRealSize: %d B\n", ESP.getFlashChipRealSize());
-	printf("FlashChipSpeed: %d\n", ESP.getFlashChipSpeed());
-	printf("SdkVersion: %s\n", ESP.getSdkVersion());
-	printf("FullVersion: %s\n", ESP.getFullVersion().c_str());
-	printf("CpuFreq: %dMHz\n", ESP.getCpuFreqMHz());
-	printf("FreeHeap: %d B\n", ESP.getFreeHeap());
-	printf("ResetInfo: %s\n", ESP.getResetInfo().c_str());
-	printf("ResetReason: %s\n", ESP.getResetReason().c_str());
-	DEBUG_HEAP();
+	SIMPLE_INFO("");
+	SIMPLE_INFO("SketchSize: %d", ESP.getSketchSize());
+	SIMPLE_INFO("FreeSketchSpace: %d", ESP.getFreeSketchSpace());
+	SIMPLE_INFO("FlashChipSize: %d", ESP.getFlashChipSize());
+	SIMPLE_INFO("FlashChipRealSize: %d", ESP.getFlashChipRealSize());
+	SIMPLE_INFO("FlashChipSpeed: %d", ESP.getFlashChipSpeed());
+	SIMPLE_INFO("SdkVersion: %s", ESP.getSdkVersion());
+	SIMPLE_INFO("FullVersion: %s", ESP.getFullVersion().c_str());
+	SIMPLE_INFO("CpuFreq: %dMHz", ESP.getCpuFreqMHz());
+	SIMPLE_INFO("FreeHeap: %d", ESP.getFreeHeap());
+	SIMPLE_INFO("ResetInfo: %s", ESP.getResetInfo().c_str());
+	SIMPLE_INFO("ResetReason: %s", ESP.getResetReason().c_str());
+	INFO_HEAP();
 	homekit_setup();
-	DEBUG_HEAP();
+	INFO_HEAP();
 	blink_led(200, 3);
 }
 
 void loop() {
 	homekit_loop();
-	delay(5);
 }
 
 void builtinledSetStatus(bool on) {
@@ -96,55 +94,46 @@ void IRAM_ATTR btnInterrupt() {
 	btn.update();
 }
 
-uint32_t next_heap_millis = 0;
-
 void homekit_setup() {
 	accessory_init();
 	uint8_t mac[WL_MAC_ADDR_LENGTH];
 	WiFi.macAddress(mac);
 	int name_len = snprintf(NULL, 0, "%s_%02X%02X%02X",
 			name.value.string_value, mac[3], mac[4], mac[5]);
-	char *name_value = (char*)malloc(name_len + 1);
+	char *name_value = (char*) malloc(name_len + 1);
 	snprintf(name_value, name_len + 1, "%s_%02X%02X%02X",
 			name.value.string_value, mac[3], mac[4], mac[5]);
 	name.value = HOMEKIT_STRING_CPP(name_value);
 
 	arduino_homekit_setup(&config);
 
-	btn.setCallback([](const bool down) {
-		btnHandler.handleChange(down);
-	});
+	btn.setCallback(std::bind(&ButtonHandler::handleChange, &btnHandler,
+			std::placeholders::_1));
 	btn.setInterrupt(btnInterrupt);
-
-	btnHandler.setIsDownFunction([](void) {
-		return btn.checkIsDown();
+	btnHandler.setIsDownFunction(std::bind(&ButtonDebounce::checkIsDown, &btn));
+	btnHandler.setCallback([](button_event e) {
+		if (e == BUTTON_EVENT_SINGLECLICK) {
+			SIMPLE_INFO("Button Event: SINGLECLICK");
+			led_toggle();
+		} else if (e == BUTTON_EVENT_DOUBLECLICK) {
+			SIMPLE_INFO("Button Event: DOUBLECLICK");
+			occupancy_toggle();
+		} else if (e == BUTTON_EVENT_LONGCLICK) {
+			SIMPLE_INFO("Button Event: LONGCLICK");
+			SIMPLE_INFO("Rebooting...");
+			homekit_storage_reset();
+			ESP.restart(); // or system_restart();
+		}
 	});
-	btnHandler.setCallback([](const button_event e) {
-		P(F("Button Event: "));
-		switch (e) {
-		case BUTTON_EVENT_SINGLECLICK:
-		PL(F("SINGLECLICK"));
-		led_toggle();
-		break;
-	case BUTTON_EVENT_DOUBLECLICK:
-		PL(F("DOUBLECLICK"));
-		occupancy_toggle();
-		break;
-	case BUTTON_EVENT_LONGCLICK:
-		PL(F("LONGCLICK"));
-		homekit_storage_reset();
-		system_restart();
-		break;
-	}
-}	);
 }
 
 void homekit_loop() {
 	btnHandler.loop();
 	arduino_homekit_loop();
+	static uint32_t next_heap_millis = 0;
 	uint32_t time = millis();
 	if (time > next_heap_millis) {
-		INFO("heap: %d, sockets: %d",
+		SIMPLE_INFO("heap: %d, sockets: %d",
 				ESP.getFreeHeap(), arduino_homekit_connected_clients_count());
 		next_heap_millis = time + 5000;
 	}

extras/ESP8266WiFi_nossl_noleak/src/ESP8266WiFi.cpp

@@ -0,0 +1,90 @@
+/*
+ ESP8266WiFi.cpp - WiFi library for esp8266
+
+ Copyright (c) 2014 Ivan Grokhotkov. All rights reserved.
+ This file is part of the esp8266 core for Arduino environment.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+ Reworked on 28 Dec 2015 by Markus Sattler
+
+ */
+
+#include "ESP8266WiFi.h"
+
+extern "C" {
+#include "c_types.h"
+#include "ets_sys.h"
+#include "os_type.h"
+#include "osapi.h"
+#include "mem.h"
+#include "user_interface.h"
+#include "smartconfig.h"
+#include "lwip/opt.h"
+#include "lwip/err.h"
+#include "lwip/dns.h"
+}
+
+#include "debug.h"
+
+// -----------------------------------------------------------------------------------------------------------------------
+// ---------------------------------------------------------- Debug ------------------------------------------------------
+// -----------------------------------------------------------------------------------------------------------------------
+
+
+/**
+ * Output WiFi settings to an object derived from Print interface (like Serial).
+ * @param p Print interface
+ */
+void ESP8266WiFiClass::printDiag(Print& p) {
+    const char* const modes[] = { "NULL", "STA", "AP", "STA+AP" };
+    p.print(F("Mode: "));
+    p.println(modes[wifi_get_opmode()]);
+
+    const char* const phymodes[] = { "", "B", "G", "N" };
+    p.print(F("PHY mode: "));
+    p.println(phymodes[(int) wifi_get_phy_mode()]);
+
+    p.print(F("Channel: "));
+    p.println(wifi_get_channel());
+
+    p.print(F("AP id: "));
+    p.println(wifi_station_get_current_ap_id());
+
+    p.print(F("Status: "));
+    p.println(wifi_station_get_connect_status());
+
+    p.print(F("Auto connect: "));
+    p.println(wifi_station_get_auto_connect());
+
+    struct station_config conf;
+    wifi_station_get_config(&conf);
+
+    char ssid[33]; //ssid can be up to 32chars, => plus null term
+    memcpy(ssid, conf.ssid, sizeof(conf.ssid));
+    ssid[32] = 0; //nullterm in case of 32 char ssid
+    p.printf_P(PSTR("SSID (%d): %s\n"), strlen(ssid), ssid);
+
+    char passphrase[65];
+    memcpy(passphrase, conf.password, sizeof(conf.password));
+    passphrase[64] = 0;
+    p.printf_P(PSTR("Passphrase (%d): %s\n"), strlen(passphrase), passphrase);
+
+    p.print(F("BSSID set: "));
+    p.println(conf.bssid_set);
+
+}
+
+ESP8266WiFiClass WiFi;

extras/ESP8266WiFi_nossl_noleak/src/ESP8266WiFi.h

@@ -0,0 +1,91 @@
+/*
+ ESP8266WiFi.h - esp8266 Wifi support.
+ Based on WiFi.h from Arduino WiFi shield library.
+ Copyright (c) 2011-2014 Arduino.  All right reserved.
+ Modified by Ivan Grokhotkov, December 2014
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#ifndef WiFi_h
+#define WiFi_h
+
+#include <stdint.h>
+
+extern "C" {
+#include "include/wl_definitions.h"
+}
+
+#include "IPAddress.h"
+
+#include "ESP8266WiFiType.h"
+#include "ESP8266WiFiSTA.h"
+#include "ESP8266WiFiAP.h"
+#include "ESP8266WiFiScan.h"
+#include "ESP8266WiFiGeneric.h"
+
+#include "WiFiClient.h"
+#include "WiFiServer.h"
+//#include "WiFiServerSecure.h"
+//#include "WiFiClientSecure.h"
+//#include "BearSSLHelpers.h"
+//#include "CertStoreBearSSL.h"
+
+#ifdef DEBUG_ESP_WIFI
+#ifdef DEBUG_ESP_PORT
+#define DEBUG_WIFI(fmt, ...) DEBUG_ESP_PORT.printf_P( (PGM_P)PSTR(fmt), ##__VA_ARGS__ )
+#endif
+#endif
+
+#ifndef DEBUG_WIFI
+#define DEBUG_WIFI(...) do { (void)0; } while (0)
+#endif
+
+
+class ESP8266WiFiClass : public ESP8266WiFiGenericClass, public ESP8266WiFiSTAClass, public ESP8266WiFiScanClass, public ESP8266WiFiAPClass {
+    public:
+
+        // workaround same function name with different signature
+        using ESP8266WiFiGenericClass::channel;
+
+        using ESP8266WiFiSTAClass::SSID;
+        using ESP8266WiFiSTAClass::RSSI;
+        using ESP8266WiFiSTAClass::BSSID;
+        using ESP8266WiFiSTAClass::BSSIDstr;
+
+        using ESP8266WiFiScanClass::SSID;
+        using ESP8266WiFiScanClass::encryptionType;
+        using ESP8266WiFiScanClass::RSSI;
+        using ESP8266WiFiScanClass::BSSID;
+        using ESP8266WiFiScanClass::BSSIDstr;
+        using ESP8266WiFiScanClass::channel;
+        using ESP8266WiFiScanClass::isHidden;
+
+        // ----------------------------------------------------------------------------------------------
+        // ------------------------------------------- Debug --------------------------------------------
+        // ----------------------------------------------------------------------------------------------
+
+    public:
+
+        void printDiag(Print& dest);
+
+        friend class WiFiClient;
+        friend class WiFiServer;
+
+};
+
+extern ESP8266WiFiClass WiFi;
+
+#endif