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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Uncomment **CA_USE_PERSIST_CON** in ``ConfigAssist.h`` to use this feature.
45
45
46
46
Check the <ahref="/examples/ConfigAssist-FirmwareCheck/README.txt">FirmwareCheck</a> example for more details.
47
47
48
-
These features can be disabled to save memory by commenting the lines **CA_USE_WIFISCAN**, **CA_USE_TESTWIFI**, **CA_USE_TIMESYNC**, **CA_USE_OTAUPLOAD**, and **CA_USE_FIMRMCHECK** in ``configAssist.h``.
48
+
These features can be disabled to save memory by commenting the lines **CA_USE_WIFISCAN**, **CA_USE_TESTWIFI**, **CA_USE_TIMESYNC**, **CA_USE_OTAUPLOAD**, and **CA_USE_FIMRMCHECK** in ``ConfigAssist.h``.
49
49
50
50
Device's configuration ``(*.ini files)`` can be downloaded with the **Backup** button and can be restored later with the **Restore** button.
51
51
@@ -76,7 +76,7 @@ ConfigAssist uses **c++ vectors** to dynamically allocate and store variables an
76
76
77
77
## How to use variables
78
78
79
-
**ConfigAssist** consists of single file "configAssist.h" that must be included in your application
79
+
**ConfigAssist** consists of single file "ConfigAssist.h" that must be included in your application
80
80
The application variables can be used directly by accessing the **class** itself by operator **[]**
81
81
i.e.
82
82
@@ -214,8 +214,8 @@ Other settings:
214
214
215
215
## Project definitions in your main app
216
216
217
-
+ include the **configAssist** class
218
-
-`#include <configAssist.h> //ConfigAssist class`
217
+
+ include the **ConfigAssist** class
218
+
-`#include <ConfigAssist.h> //ConfigAssist class`
219
219
220
220
+ Define your static instance with **defaults**
221
221
-`ConfigAssist conf;`
@@ -351,7 +351,7 @@ to print your messages. **ConfigAssist** can record these messages with **timest
351
351
352
352
+ if you want to enable serial print to a log file use..
353
353
```
354
-
//Enable configAssist logging to file
354
+
//Enable ConfigAssist logging to file
355
355
#define LOGGER_LOG_MODE 2 // Log to file
356
356
357
357
//Define the log filename
@@ -367,7 +367,7 @@ to print your messages. **ConfigAssist** can record these messages with **timest
367
367
368
368
## Compile
369
369
Download library files and place them on ./libraries directory under ArduinoProjects
370
-
Then include the **configAssist.h** in your application and compile..
370
+
Then include the **ConfigAssist.h** in your application and compile..
371
371
372
372
+ compile for arduino-esp3 or arduino-esp8266.
373
373
+ To use Persistent ST connections On ESP8266 devices you must install **Preferences** library to provide ESP32-compatible Preferences API using LittleFS
0 commit comments