Improved documentation, and almost done for EADK functions, but some fail on the linker part.

Author: Naereen

README.md

@@ -5,6 +5,8 @@
 This apps lets you run a [JavaScript](https://en.wikipedia.org/wiki/JavaScript) script on your [NumWorks calculator](https://www.numworks.com)!
 [![JavaScript logo](./src/icon.png)](https://en.wikipedia.org/wiki/JavaScript)
 
+----
+
 ## Install the app
 
 [![Screenshot documentation showing the icon in my list of applications](screenshot-documentations/screenshot-documentation-icon-of-application.png)](screenshot-documentations/screenshot-documentation-icon-of-application.png)
@@ -15,6 +17,8 @@ Installing is rather easy:
 2. This Release page is not-yet ready, on this project, use [this folder instead](https://perso.crans.org/besson/publis/Numworks-apps/), and [this direct link](https://perso.crans.org/besson/publis/Numworks-apps/javascript.nwa) ;
 3. Head to [my.numworks.com/apps](https://my.numworks.com/apps) to send the `nwa` file on your calculator (on Google Chrome browser). On [this page](https://my.numworks.com/python/lilian-besson-1/javascript) you will be able to also send a default example of a JavaScript file (a tiny test script), and you can edit it yourself later on, on your calculator!
 
+----
+
 ## How to use the app
 
 Just launch the app, and it will read and execute your script `javascript.py`!
@@ -42,42 +46,84 @@ To rebuild the two `espruino_embedded.c` and `espruino_embedded.h` files from Es
 BOARD=EMBED RELEASE=1 V=1 make
 ```
 
+Then remove these lines from the `espruino_embedded.c` file:
+
+```c
+typedef unsigned char __u_char;
+typedef unsigned short int __u_short;
+...
+typedef __intmax_t intmax_t;
+typedef __uintmax_t uintmax_t;
+```
+
+Copy the files you obtained to the `./src/javascript/` folder on this project (they are included, you shouldn't have to do this, unless you want to help me developping this!).
+
 ----
 
 ## 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.
 
-### Eadk predefined colors
+### ✅? 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
+### ✅? 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).
 
-#### ✅ `void Eadk.set_backlight_brightness(int brightness)`
+#### ✅ `void Eadk.backlight_set_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.
 
-### Accessing the Battery levels
+### ❌ Accessing the Battery levels
 
-### `bool eadk_battery_is_charging()`
+#### ❌ `bool Eadk.battery_is_charging()`
 
 Indicates whether the battery is charging.
 
-### `uint8_t eadk_battery_level()`
+#### ❌ `uint8_t Eadk.battery_level()`
 
 Returns a 8 bits integer giving the battery level.
 
-### `float eadk_battery_voltage()`
+#### ❌ `float Eadk.battery_voltage()`
 
 Returns a floating value of the battery voltage (in Volt, I guess?).
 
+### Display
+
+#### ❌ `void Eadk.display_draw_string(const char* text, uint16_t x, uint16_t y, bool large_font, uint16_t text_color, uint16_t background_color)`
+
+TODO: I still haven't been able to define this one correctly, due to the `char* text` that I don't know how to declare in JSON (in the JSON to C process used by `jswrap_` to generate the corresponding C code).
+
+### Timing
+
+#### ✅? `void Eadk.timing_usleep(uint32_t us)`
+
+Sleep for `us` micro-seconds
+
+#### ✅? `void Eadk.timing_msleep(uint32_t ms)`
+
+Sleep for `ms` micro-seconds
+
+#### ❌ `uint64_t Eadk.timing_millis()`
+
+Time since boot of the machine? Not clear. FIXME:
+
+### Miscellanious
+
+#### ❌ `bool Eadk.usb_is_plugged()`
+
+Indicates whether the USB is plugging.
+
+#### ✅? `uint32_t Eadk.random()`
+
+Returns an almost truly random number, generated from the hardware RNG (a uint32_t, unsigned 32 bits integer).
+
 
 ### How to add new functions to Espruino JavaScript's `Eadk` module?
 

src/main.c

@@ -24,12 +24,12 @@ void __exidx_end() { }
 void jshKickSoftWatchDog() {
 }
 
-// XXX: do we need this, for our app?
+// We don't need this, for our app, but apparently Espruino needs it
 uint64_t ejs_get_microseconds() {
   return (uint64_t) (eadk_timing_millis() * 1000);
 }
 
-// TODO: do we need this, for our app?
+// We don't need this, for our app, but apparently Espruino needs it
 void ejs_print(const char *str) {
   printf("%s", str);
 }
@@ -38,7 +38,7 @@ void ejs_print(const char *str) {
 // int main(int argc, char ** argv) {
 int main() {
 
-  printf("NumWorks's Embedded JavaScript interpreter v0.0.2\n");
+  printf("NumWorks's Embedded JavaScript interpreter v0.0.3\n");
   eadk_timing_msleep(1000);
   printf("Based on Espruino, by Naereen\n");
   eadk_timing_msleep(1000);

src/test.js

@@ -1,11 +1,12 @@
 // This is NOT a Python script
 // This is a JavaScript file!
 
-// A bit hacky experimental: just a for loop, to sleep
+// A function around timing_msleep
 function msleep(s) {
   if (Eadk.timing_msleep instanceof Function) {
-      Eadk.timing_msleep(s);
+    Eadk.timing_msleep(s);
   } else {
+    // A bit hacky experimental: just a for loop, to sleep
       for (let j = 1; j <= s; j++) {
           // Just a comment here
       }
@@ -16,12 +17,14 @@ console.log("Hello world from JavaScript!");
 console.log("Testing Eadk functions:");
 msleep(5000);
 
+// Brightness
+
 const brightness = Eadk.backlight_brightness();
 console.log("Eadk.backlight_brightness() =", Eadk.backlight_brightness());
 msleep(2000);
 
 // Iterate some times from full brightness to zero brightness
-const number_of_dwarfs = 13;
+const number_of_dwarfs = 3;
 for (let dwarf = 1; dwarf <= number_of_dwarfs; dwarf++) {
 
   // Let's go into the dark
@@ -39,46 +42,89 @@ for (let dwarf = 1; dwarf <= number_of_dwarfs; dwarf++) {
   }
 }
 
-msleep(1000);
+msleep(5000);
 
+//
 // Let's test the constants SCREEN_WIDTH, SCREEN_HEIGHT
+//
 console.log("Eadk.SCREEN_WIDTH =", Eadk.SCREEN_WIDTH);
-msleep(1000);
+msleep(5000);
 console.log("Eadk.SCREEN_HEIGHT =", Eadk.SCREEN_HEIGHT);
-msleep(1000);
+msleep(5000);
 
+// FIXME: these functions seem to not be available in NumWorks' EADK library.
+//
 // Let's test the battery API
+//
 console.log("Eadk.battery_is_charging() =", Eadk.battery_is_charging());
-msleep(1000);
+msleep(5000);
 console.log("Eadk.battery_level() =", Eadk.battery_level());
-msleep(1000);
+msleep(5000);
 console.log("Eadk.battery_voltage() =", Eadk.battery_voltage());
-msleep(1000);
+msleep(5000);
 
+//
+// Display
+//
 
-// 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);
+// // 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);
+// // 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);
+
+//
+// Timing
+//
+
+// Let's test the function Eadk.timing_usleep(5000000)
+console.log("Eadk.timing_usleep(5000000)...");
+Eadk.timing_usleep(5000000);
+
+// Let's test the function Eadk.timing_msleep(5000)
+console.log("Eadk.timing_msleep(5000)...");
+Eadk.timing_msleep(5000);
 
+// FIXME: these functions seem to not be available in NumWorks' EADK library.
+// Let's test the function Eadk.timing_millis()
+console.log("Eadk.timing_millis() =", Eadk.timing_millis());
+msleep(5000);
+
+//
+// Misc
+//
+
+// FIXME: these functions seem to not be available in NumWorks' EADK library.
+// Let's test the function Eadk.eadk_usb_is_plugged()
+console.log("Eadk.eadk_usb_is_plugged() =", Eadk.eadk_usb_is_plugged());
+msleep(5000);
+
+// Let's test the function Eadk.eadk_random()
+for (let index = 0; index < 100; index++) {
+  console.log("Eadk.eadk_random() =", Eadk.eadk_random());
+  msleep(50);
+}
+
+//
 // Finish for this test script
+//
+
 console.log("End for the tests of Eadk functions!");
 msleep(1000);