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
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ It has been tested with Arduino Uno with SparkFun MicroSD Shield, WeMos ESP8266
11
11
# Features
12
12
13
13
- Low Memory requirement: `page_size` + some stack
14
-
- Can log using Arduino UNO (2kb RAM) with 512kb page size
14
+
- Can log using Arduino UNO (`2kb` RAM) with 512 bytes page size
15
15
- Can do quick binary search on RowID or Timestamp without any index in logarithmic time
16
16
- Recovery possible in case of power failure
17
17
- Rolling logs are possible (not implemented yet)
@@ -29,6 +29,10 @@ For example, locating any record in a 70 MB db having 1 million records on Ardui
29
29
30
30
The examples `ESP8266_Console` and `ESP32_Console` can be used to log and retrieve from ESP8266 and ESP32 boards respectively on Micro SD and SPIFFS filesystems.
31
31
32
+
# API
33
+
34
+
For finding out how the logger works and a complete description of API visit [Sqlite Micro Logger C Library](https://github.com/siara-cc/sqlite_micro_logger_c).
35
+
32
36
# Ensuring integrity
33
37
34
38
If there is power failure during logging, the data can be recovered using `Recover database` option in the menu.
@@ -42,7 +46,14 @@ Following are limitations of this library:
42
46
-`Select`, `Insert` are not supported. Instead C API similar to that of Sqlite API is available.
43
47
- Index creation and lookup not possible (as of now)
44
48
45
-
However, the database created can be copied to a desktop PC and further operations such as index creation and summarization can be carried out from there as though its a regular Sqlite database.
49
+
However, the database created can be copied to a desktop PC and further operations such as index creation and summarization can be carried out from there as though its a regular Sqlite database. But after doing so, it may not be possible to use it with this library any longer.
50
+
51
+
# Future plans
52
+
53
+
- Index creation when finalizing a database
54
+
- Allow modification of records
55
+
- Rolling logs
56
+
- Show how this library can be used in a multi-core, multi-threaded environment
0 commit comments