A bit in advance on the example script, I need to test these additions, then write the documentation.

Author: Naereen

README.md

@@ -23,29 +23,61 @@ This script should be located in the `javascript.py` file, that you can create,
 
 If you want a demo, use [this `javascript.py` script](https://my.numworks.com/python/lilian-besson-1/javascript), that you can install on your NumWorks calculator, directly from their website (from my user space).
 
+[![TODO: Video documentation showing the icon in my list of applications](screenshot-documentations/video-documentation-icon-of-application.gif)](screenshot-documentations/video-documentation-icon-of-application.gif)
+
+----
+
 ## Dependencies
 
 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.
 
+### My fork of Espruino
+
 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!*
 
+To rebuild the two `espruino_embedded.c` and `espruino_embedded.h` files from Espruino's source code, you must run this in its main directory (of my fork, not the main project):
+
+```bash
+BOARD=EMBED RELEASE=1 V=1 make
+```
+
+----
+
 ## 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`
+### Eadk predefined colors
+`Eadk.color_black`, `Eadk.color_white`, `Eadk.color_red`, `Eadk.color_green`, `Eadk.color_blue` are the five predefined colors.
+
+### Screen width and height
+`Eadk.SCREEN_WIDTH` and `Eadk.SCREEN_HEIGHT` are the screen's width and height, respectively.
+
+### ✅ Controlling the screen's brightness
+#### ✅ `int Eadk.backlight_brightness()`
 
 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)`
+#### ✅ `void 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.
+### Accessing the Battery levels
+
+### `bool eadk_battery_is_charging()`
+
+Indicates whether the battery is charging.
+
+### `uint8_t eadk_battery_level()`
+
+Returns a 8 bits integer giving the battery level.
+
+### `float eadk_battery_voltage()`
+
+Returns a floating value of the battery voltage (in Volt, I guess?).
+
 
 ### How to add new functions to Espruino JavaScript's `Eadk` module?
 

src/main.c

@@ -38,7 +38,9 @@ void ejs_print(const char *str) {
 // int main(int argc, char ** argv) {
 int main() {
 
-  printf("Embedded Espruino v0.0.1\n");
+  printf("NumWorks's Embedded JavaScript interpreter v0.0.2\n");
+  eadk_timing_msleep(1000);
+  printf("Based on Espruino, by Naereen\n");
   eadk_timing_msleep(1000);
 
   ejs_create(1000);
@@ -55,7 +57,7 @@ int main() {
   // DONE: I wasn't able to compile while depending on external data, but it works if reading from a local 'javascript.py' file.
   // const char * code = eadk_external_data;
 
-  const char * code = (code_from_file == NULL && file_len <= 0) ? "console.log(\"\\nHi from JavaScript interpreter! sleep(3s)\")\n// eadk.timing_msleep(3000)\ntypeof(NaN)" : (code_from_file + 1);
+  const char * code = (code_from_file == NULL && file_len <= 0) ? "console.log(\"Hi from JavaScript interpreter! sleep(3s)\");\n// Eadk.timing_msleep(3000);\ntypeof(NaN);" : (code_from_file + 1);
 
   printf("Executing code...\n");
   eadk_timing_msleep(1000);

src/test.js

@@ -1,42 +1,84 @@
 // This is NOT a Python script
 // This is a JavaScript file!
 
-console.log("Hello world from JavaScript! Testing.\n");
-console.log("Hello world from JavaScript! Testing.\n");
-console.log("Hello world from JavaScript! Testing.\n");
-Eadk.timing_msleep(1000);
+// A bit hacky experimental: just a for loop, to sleep
+function msleep(s) {
+  if (Eadk.timing_msleep instanceof Function) {
+      Eadk.timing_msleep(s);
+  } else {
+      for (let j = 1; j <= s; j++) {
+          // Just a comment here
+      }
+  }
+}
 
-const brightness = Eadk.backlight_brightness();
-console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
-Eadk.timing_msleep(1000);
+console.log("Hello world from JavaScript!");
+console.log("Testing Eadk functions:");
+msleep(5000);
 
-Eadk.set_backlight_brightness(0);
+const brightness = Eadk.backlight_brightness();
 console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
-Eadk.timing_msleep(1000);
+msleep(2000);
 
-Eadk.set_backlight_brightness(brightness);
-console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
-Eadk.timing_msleep(1000);
+// Iterate some times from full brightness to zero brightness
+const number_of_dwarfs = 13;
+for (let dwarf = 1; dwarf <= number_of_dwarfs; dwarf++) {
 
-for (let j = 1; j <= 1; j++) {
-  // Just a comment here
-  for (let i = 1; i <= 2; i++) {
-    Eadk.display_draw_string("Hello", 10 * i, 10 * i + 20 * j, 1); // 1 pour grand texte
+  // Let's go into the dark
+  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 i = 3; i <= 4; i++) {
-    Eadk.display_draw_string("Hello", 10 * i, 10 * i + 20 * j, 0); // 0 pour petit texte
-  }
-  for (let i = 5; i <= 6; i++) {
-    Eadk.display_draw_string("Hello", 10 * i, 10 * i + 20 * j, 0);
+
+  // And back into the light!
+  for (let b = 0; b <= brightness; b=b+16) {
+      Eadk.set_backlight_brightness(b);
+      console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
+      msleep(50);
   }
+}
 
-  let i = 7;
-  Eadk.display_draw_string("Hello", 10 * i, 10 * i + 20 * j, 0, Eadk.color_red);
-  i++;
-  Eadk.display_draw_string("Hello", 10 * i, 10 * i + 20 * j, 0, Eadk.color_green);
-  i++;
-  Eadk.display_draw_string("Hello", 10 * i, 10 * i + 20 * j, 0, Eadk.color_blue);
-  i++;
+msleep(1000);
 
-  Eadk.timing_msleep(1000);
-}
+// Let's test the constants SCREEN_WIDTH, SCREEN_HEIGHT
+console.log("Eadk.SCREEN_WIDTH =", Eadk.SCREEN_WIDTH);
+msleep(1000);
+console.log("Eadk.SCREEN_HEIGHT =", Eadk.SCREEN_HEIGHT);
+msleep(1000);
+
+// Let's test the battery API
+console.log("Eadk.battery_is_charging() =", Eadk.battery_is_charging());
+msleep(1000);
+console.log("Eadk.battery_level() =", Eadk.battery_level());
+msleep(1000);
+console.log("Eadk.battery_voltage() =", Eadk.battery_voltage());
+msleep(1000);
+
+
+// Let's test the colors and display_draw_string
+// First display on white background, and big text
+const big_text   = 1; // 1 for big text
+Eadk.display_draw_string("Hello in red on white ?", 20, 10, big_text, Eadk.color_red, Eadk.color_white);
+msleep(1000);
+Eadk.display_draw_string("Hello in green on white ?", 40, 10, big_text, Eadk.color_green, Eadk.color_white);
+msleep(1000);
+Eadk.display_draw_string("Hello in blue on white ?", 60, 10, big_text, Eadk.color_blue, Eadk.color_white);
+msleep(1000);
+Eadk.display_draw_string("Hello in black on white ?", 60, 10, big_text, Eadk.color_black, Eadk.color_white);
+msleep(1000);
+
+// Then display on black background, and small text
+const small_text = 0; // 0 for small text
+Eadk.display_draw_string("Hello in red on black ?", 20, 10, small_text, Eadk.color_red, Eadk.color_black);
+msleep(1000);
+Eadk.display_draw_string("Hello in green on black ?", 40, 10, small_text, Eadk.color_green, Eadk.color_black);
+msleep(1000);
+Eadk.display_draw_string("Hello in blue on black ?", 60, 10, small_text, Eadk.color_blue, Eadk.color_black);
+msleep(1000);
+Eadk.display_draw_string("Hello in white on black ?", 60, 10, small_text, Eadk.color_white, Eadk.color_black);
+msleep(1000);
+
+// Finish for this test script
+console.log("End for the tests of Eadk functions!");
+msleep(1000);