Installing Embedis

Use the Arduino Library Installer :

Sketch -> Include Library -> Manage Libraries

Library Manager

Under "Filter Search", enter "embedis" :

Search for Embedis

and Click on the "Install" Button :

Install

Now you can explore the Embedis examples under :

Files -> Examples -> Embedis -> Embedis

Note Bene : The default example uses EEPROM only, and will only function on boards with support for internal EEPROM (i.e. Arduino Uno/Leo/Mega/etc.), or boards with support for emulated EEPROM, such as the ESP8266. There are specific examples for boards with different capabilities, such as the Arduino Due, that do NOT include EEPROM internal to the microprocessor.

The Embedis command line interface (CLI) uses familiar SET/GET/DEL commands for storing, retriving, and deleting key-value pairs in the persistant memory stores. For example :

```
set mykey somevalue
+OK
get mykey
+somevalue
del mykey
:1
```

For more information on using Embedis, please see the -> Embedis WIKI

The git repository includes a submodule for the testing framework and a branch 'gh-pages' for the development generated documentation. The recommended commands to use are as follows:

git clone {origin_url} embedis
cd embedis
git submodule init
git submodule update
git clone {origin_url} html --branch gh-pages

You'll need a few tools to build the tests and documentation. These are commonly tools available for all operating systems so you shouldn't have too much trouble getting them installed.

• CMake

• Doxygen

CMake can create a typical Makefile as well as project files for Xcode, Visual Studio, and many others. Here's a quick start for Makefile users:

$ cmake .
$ make && ctest
$ make doc