Skip to content

Commit 24bea8b

Browse files
committed
update library.properties
1 parent 29f0f4b commit 24bea8b

File tree

4 files changed

+16
-14
lines changed

4 files changed

+16
-14
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Arduino Homekit ESP8266
1+
# Arduino HomeKit ESP8266
22

33
## Apple HomeKit accessory server library for ESP8266 Arduino
44

5-
This Arduino library is a native Apple HomeKit accessory implementation for the ESP8266, and works without any additional bridges.
5+
This Arduino library is a native Apple HomeKit accessory implementation for the [ESP8266 Arduino core](https://github.com/esp8266/Arduino), and works without any additional bridges.
66

77
This project is mainly based on [esp-homekit](https://github.com/maximkulkin/esp-homekit) for [ESP-OPEN-RTOS](https://github.com/SuperHouse/esp-open-rtos).
88

@@ -85,15 +85,15 @@ Here are the free heap values of running the example sketch:
8585

8686
* Based on wolfssl-3.13.0-stable.
8787
* Clean source code: the unused files are removed.
88-
* `CURVE25519_SMALL` and `ED25519_SMALL`: ESP8266 can not directly run without `SMALL` defined since the memory is not sufficient. But the NO `SMALL` version is faster. I mark the big `ge_precomp base[32][8]` with PROGMEM to store it in Flash (around 70KB). Also the `ge_double_scalarmult_vartime` can not run caused by lack of heap. I define `ESP_GE_DOUBLE_SCALARMULT_VARTIME_LOWMEM` in `user_settings.h` to use LOWMEM version of `ge_double_scalarmult_vartime` in `ge_low_mem.c`. This is a trade-off of performance and memory. If you want more Flash space, you should define `CURVE25519_SMALL` and `ED25519_SMALL` and undefine `ESP_GE_DOUBLE_SCALARMULT_VARTIME_LOWMEM` in `user_settings.h`.
89-
* `integer.c`(big integer operations): `MP_16BIT` and `ESP_FORCE_S_MP_EXPTMOD` are defined for better performance in ESP8266. `ESP_INTEGER_WINSIZE` (value is 3) is defined to avoid crash caused by memory exhaust and the values of {3, 4, 5} are of similar performance (this will lead the Pair Verify Steps take 1.2s + 0.9s).
88+
* `CURVE25519_SMALL` and `ED25519_SMALL`: ESP8266 can not directly run without `SMALL` defined since the memory is not sufficient. But the NO `SMALL` version is faster. I mark the big `ge_precomp base[32][8]` with PROGMEM to store it in Flash (around 70KB). Also the `ge_double_scalarmult_vartime` can not run caused by lack of heap. I define `ESP_GE_DOUBLE_SCALARMULT_VARTIME_LOWMEM` in `user_settings.h` to use LOWMEM version of `ge_double_scalarmult_vartime` in `ge_low_mem.c`. This is a trade-off of performance and memory. If you want more Flash space, you should define `CURVE25519_SMALL` and `ED25519_SMALL` and undefine `ESP_GE_DOUBLE_SCALARMULT_VARTIME_LOWMEM` in `user_settings.h` (this will lead the Pair Verify Steps to take 1.2s + 0.9s).
89+
* `integer.c`(big integer operations): `MP_16BIT` and `ESP_FORCE_S_MP_EXPTMOD` are defined for better performance in ESP8266. `ESP_INTEGER_WINSIZE` (value is 3) is defined to avoid crash caused by memory exhaust and the values of {3, 4, 5} are of similar performance.
9090

9191
## Storage
9292

9393
* The pairing data is stored in the `EEPROM` address in ESP8266 Arduino core.
9494
* This project does not use the `EEPROM` library with data-cache to reduce memory use (directly call flash_read and write).
9595
* The `EEPROM` is 4096B in ESP8266, this project uses max [0, 1408B).
96-
* See the comments in `storge.c` and [esp8266-EEPROM-doc](https://arduino-esp8266.readthedocs.io/en/2.6.3/libraries.html#eeprom).
96+
* See the comments in `storge.c` and [ESP8266-EEPROM-doc](https://arduino-esp8266.readthedocs.io/en/2.6.3/libraries.html#eeprom).
9797
* `EEPROM` of [1408, 4096) is safe for you to use.
9898
* This project do NOT use `FS(file system)`, so you can use `FS` freely.
9999

@@ -133,11 +133,13 @@ Here are the free heap values of running the example sketch:
133133

134134
## Troubleshooting
135135

136-
* Check your serial output with [example_serial_output.txt](https://raw.github.com/Mixiaoxiao/Arduino-HomeKit-ESP8266/master/example_serial_output.txt)
136+
* Check your serial output with [example_serial_output.txt](https://raw.github.com/Mixiaoxiao/Arduino-HomeKit-ESP8266/master/extras/example_serial_output.txt)
137137

138138
## Thanks
139-
- [esp-homekit](https://github.com/maximkulkin/esp-homekit)
140-
- [esp-homekit-demo](https://github.com/maximkulkin/esp-homekit-demo)
141-
- [esp_hw_wdt](https://github.com/ComSuite/esp_hw_wdt)
142-
- [WolfSSL/WolfCrypt](https://www.wolfssl.com/products/wolfcrypt-2/)
139+
* [esp-homekit](https://github.com/maximkulkin/esp-homekit)
140+
* [esp-homekit-demo](https://github.com/maximkulkin/esp-homekit-demo)
141+
* [esp_hw_wdt](https://github.com/ComSuite/esp_hw_wdt)
142+
* [WolfSSL/WolfCrypt](https://www.wolfssl.com/products/wolfcrypt-2/)
143+
* [cJSON](https://github.com/DaveGamble/cJSON)
144+
* [cQueue](https://github.com/SMFSW/cQueue)
143145

File renamed without changes.

library.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name":"Arduino-HomeKit-ESP8266",
3-
"description":"Apple HomeKit accessory server library for ESP8266 Arduino core.",
2+
"name":"HomeKit-ESP8266",
3+
"description":"Apple HomeKit accessory server library for the ESP8266 Arduino core.",
44
"keywords":"homekit,esp8266,esp32,apple homekit",
55
"authors":
66
{

library.properties

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
name=Arduino-HomeKit-ESP8266
1+
name=HomeKit-ESP8266
22
version=1.0.0
33
author=Mixiaoxiao
44
maintainer=Mixiaoxiao
5-
sentence=Apple HomeKit accessory server library for ESP8266 Arduino core without any additional bridges.
5+
sentence=Native Apple HomeKit accessory implementation for the ESP8266 Arduino core.
66
paragraph=Native Apple HomeKit Accessory Implementation for the ESP8266 Arduino core.
77
category=Communication
88
url=https://github.com/Mixiaoxiao/Arduino-HomeKit-ESP8266.git

0 commit comments

Comments
 (0)