Skip to content

Commit 598aaed

Browse files
authored
Update README.md
1 parent b8d5ab7 commit 598aaed

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,7 @@ apart from `SPI.begin()` or `SPIFFS.begin()` as appropriate.
1616
1717
The SS Pin is D8 on the Micro SD Shield for WeMos D1 mini. It can be changed accordingly.
1818
19-
Please see the examples for full illustration of usage for the two file systems. The database need to be copied to the Micro SD card root folder before the SD example can be used.
20-
21-
## Dependencies
22-
The SdFat library is required for accessing MicroSD card. This library can be donwloaded from https://github.com/greiman/SdFat.
23-
24-
The Sqlite3 code is included with the library.
19+
Please see the examples for full illustration of usage for the two file systems. The databases need to be copied to the Micro SD card root folder before the SD example can be used. Please see the comments section of the example.
2520
2621
## Installation
2722
Please download this library, unzip it to the libraries folder of your ESP8266 sdk location. The location varies according to your OS. For example, it is usually found in the following locations:
@@ -34,15 +29,22 @@ Under Arduino15 folder please navigate to `packages/esp8266/hardware/esp8266/<ve
3429
3530
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.
3631
32+
## Dependencies
33+
The SdFat library is required for accessing MicroSD card. This library can be donwloaded from https://github.com/greiman/SdFat.
34+
35+
The Sqlite3 code is included with the library.
36+
3737
## Limitations on ESP8266
3838
* 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.
3939
* Inserting records over a 1000 records gives "Out of memory"
4040
* These problems exist on NodeMCU as well due to low memory on ESP8266
4141
* Retrieving from db having 10 million records has been tested. But it needs stack space to be increased to atleast 6144 bytes. Please modify cores/esp8266/cont.h to increase stack size.
42+
* It takes around 1 second to retrieve from such dataset, even using the index.
4243
4344
## Limitations of this library
44-
* Multiple SD Cards can be supported (using multiple CS Pins). But as of now only one SD Card is support (/SD0).
45-
* Before opening database files from SPIFFS, the vfs_set_spiffs_file_obj() should be called with a reference to SPIFFS file object
45+
* Multiple SD Cards can be supported (using multiple CS Pins). But as of now only one SD Card is supported (`/SD0`).
46+
* Before opening database files from SPIFFS, the `vfs_set_spiffs_file_obj()` should be called with a reference to SPIFFS file object
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.
4648
4749
## Acknowledgements
4850
* This library was developed by modifying the VFS layer developed by [Luiz Felipe Silva](https://github.com/luizfeliperj)

0 commit comments

Comments
 (0)