Starts to write the documentation for this tiny 'Eadk' module that I expose to JavaScript.

Author: Naereen

README.md

@@ -27,6 +27,72 @@ If you want a demo, use [this `javascript.py` script](https://my.numworks.com/py
 
 This programs uses [the code generated by the Espruino project](https://github.com/espruino/Espruino/blob/master/README_Building.md#embedding-in-other-applications) (`espruino_embedded.c`, `espruino_embedded.h` etc), a portable JavaScript interpreter for microcontrolers.
 
+I've started to work on [my fork of Espruino](https://github.com/Naereen/Espruino), in order to solve [this issue](https://github.com/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator/issues/2): I wanted to give access to NumWorks's EADK library (see [`eadk.h`](https://github.com/numworks/epsilon/blob/master/eadk/include/eadk/eadk.h)) to the JavaScript files that are executed in this Espruino JS interpreter.
+*It's a work in progress!*
+
+## Documentation of the `Eadk` module accessible in JavaScript on the NumWorks
+
+Here is a short documentation for each function that I've ported from their interface in [`eadk.h`](https://github.com/numworks/epsilon/blob/master/eadk/include/eadk/eadk.h) to a working version in JavaScript.
+
+### Controlling the screen's brightness
+#### `Eadk.backlight_brightness() -> int`
+
+Returns the screen's brightness, it's a 8 bits integer (`uint8_t` in C), ranging between 0 (min brightness, screen almost shut down) to 240 (for max brightness).
+
+#### `Eadk.set_backlight_brightness(int brightness)`
+
+Sets the screen's brightness to this value.
+`brightness` **must** be an integer value which fits inside a `uint8_t`, between 0 and 256.
+
+### Eadk predefined colors
+`Eadk.color_black`, `Eadk.color_white`, `Eadk.color_red`, `Eadk.color_green`, `Eadk.color_blue` are the five predefined colors.
+
+### How to add new functions to Espruino JavaScript's `Eadk` module?
+
+To add new functions, edit in [my fork of Espruino](https://github.com/Naereen/Espruino/) the files: [`libs/eadk/jswrap_eadk.c`](https://github.com/Naereen/Espruino/blob/master/libs/eadk/jswrap_eadk.c) and [`libs/eadk/jswrap_eadk.h`](https://github.com/Naereen/Espruino/blob/master/libs/eadk/jswrap_eadk.h).
+The functions already present should give a good direction to follow!
+
+----
+
+## Example of a tiny JavaScript test file
+
+The example below runs now correctly and showcases a decreasing then increasing brightness, with small pauses between every change:
+
+```javascript
+// Save this to `javascript.py` on your NumWorks, and run it with
+// the "JS interpreter" NumWorks application!
+
+function msleep(s) {
+    for (let j = 1; j <= s; j++) {
+        // Just a comment here
+    }
+}
+
+console.log("Hello world from JavaScript!");
+console.log("Testing Eadk functions:");
+msleep(5000);
+
+const brightness = Eadk.backlight_brightness();
+console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+msleep(2000);
+
+for (let dwarf = 1; dwarf <= 13; dwarf++) {
+    for (let b = brightness; b >= 0; b=b-16) {
+        Eadk.set_backlight_brightness(b);
+        console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+        msleep(50);
+    }
+
+    for (let b = 0; b <= brightness; b=b+16) {
+        Eadk.set_backlight_brightness(b);
+        console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+        msleep(50);
+    }
+}
+```
+
+----
+
 ## Build the app
 
 To build this sample app, you will need to install the [embedded ARM toolchain](https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain) and [nwlink](https://www.npmjs.com/package/nwlink).

src/test2.js

@@ -4,27 +4,28 @@
 // Highly experimental: just a for loop, to sleep
 function msleep(s) {
     for (let j = 1; j <= s; j++) {
-      // Just a comment here
+        // Just a comment here
     }
-  }
-  
-  console.log("Hello world from JavaScript!");
-  console.log("Testing Eadk functions:");
-  msleep(5000);
-  
-  const brightness = Eadk.backlight_brightness();
-  console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
-  msleep(2000);
-  
-  for (let b = brightness; b >= 0; b=b-1) {
-    Eadk.set_backlight_brightness(b);
-    console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
-    msleep(100);
-  }
-  
-  for (let b = 0; b <= brightness; b=b+1) {
-    Eadk.set_backlight_brightness(b);
-    console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
-    msleep(100);
-  }
-  
+}
+
+console.log("Hello world from JavaScript!");
+console.log("Testing Eadk functions:");
+msleep(5000);
+
+const brightness = Eadk.backlight_brightness();
+console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+msleep(2000);
+
+for (let dwarf = 1; dwarf <= 13; dwarf++) {
+    for (let b = brightness; b >= 0; b=b-16) {
+        Eadk.set_backlight_brightness(b);
+        console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+        msleep(50);
+    }
+
+    for (let b = 0; b <= brightness; b=b+16) {
+        Eadk.set_backlight_brightness(b);
+        console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+        msleep(50);
+    }
+}