You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,11 +27,13 @@ Under Arduino15 folder please navigate to `packages/esp8266/hardware/esp8266/<ve
27
27
28
28
If you do not have the ESP8266 sdk for Arduino, please see http://esp8266.github.io/Arduino/versions/2.0.0/doc/installing.html for installing it.
29
29
30
-
## Dependencies
30
+
## Dependencies / pre-requisites
31
31
The SdFat library is required for accessing MicroSD card. This library can be donwloaded from https://github.com/greiman/SdFat.
32
32
33
33
The Sqlite3 code is included with the library.
34
34
35
+
The stack size of ESP8266 Arduino core is to be increased to atleast 6144 bytes to retrieve data from the sample databases as they are fairly large. Please change CONT_STACKSIZE in `cont.h` under `cores/esp8266`.
36
+
35
37
## Limitations on ESP8266
36
38
* The default page size of 4096 leads to "Out of memory" as the size increases over 500 records. Please use page size of 512 using the commands `PRAGMA page_size=512; VACUUM;`, if you are planning to use your own sqlite3 files.
37
39
* Inserting records over a 1000 records gives "Out of memory"
@@ -40,17 +42,16 @@ The Sqlite3 code is included with the library.
40
42
* It takes around 1 second to retrieve from such dataset, even using the index.
41
43
42
44
## Limitations of this library
43
-
* Multiple SD Cards can be supported (using multiple CS Pins). But as of now only one SD Card is supported (`/SD0`).
45
+
* Although multiple SD Cards are feasible (using multiple CS Pins), as of now only one SD Card is supported (`/SD0`).
44
46
* Before opening database files from SPIFFS, the `vfs_set_spiffs_file_obj()` should be called with a reference to SPIFFS file object
45
-
* A prefix (in front of filenames) such as `/FLASH/` is to be used for SPIFFS and `/SD0/` is to be used for Micro SD, for opening databases.
46
-
47
-
## ESP32
48
-
49
-
This library probably works with ESP32 too. I have not tested it as I don't have ESP32 module. If you test it, would appreciate if you inform me about the results.
47
+
* A prefix (in front of filenames) such as `/FLASH/` is to be used for SPIFFS and `/SD0/` is to be used for Micro SD, for opening databases.
50
48
51
49
## Acknowledgements
52
-
* This library was developed by modifying the VFS layer developed by [Luiz Felipe Silva](https://github.com/luizfeliperj). The documentation can be found [here](https://nodemcu.readthedocs.io/en/master/en/modules/sqlite3/).
50
+
* This library was developed by modifying the VFS layer for Sqlite3 developed by [Luiz Felipe Silva](https://github.com/luizfeliperj). The documentation can be found [here](https://nodemcu.readthedocs.io/en/master/en/modules/sqlite3/).
53
51
* The census2000 and baby names databases were taken from here: http://2016.padjo.org/tutorials/sqlite-data-starterpacks/. But no license information is available.
54
52
* The mdr512.db (Million Domain Rank database) was created with data from [The Majestic Million](https://majestic.com/reports/majestic-million) and is provided under CC 3.0 Attribution license.
55
53
* The [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)
56
54
* [The Arduino platform](https://arduino.cc)
55
+
56
+
## Issues
57
+
Please contact the author (Arundale Ramanathan) at arun@siara.cc if you find any problem (or create issue here).
0 commit comments