Migrated to typescript

Author: marcelkottmann

.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "inclusive-language"],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  rules: {
+    "inclusive-language/use-inclusive-words": "error",
+  },
+};

.github/workflows/ci.yml

@@ -8,4 +8,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v1
       - name: Build
-        run: docker run -v ${PWD}:/opt/esp32-javascript -w /opt/esp32-javascript -t espressif/idf idf.py build
+        run: |
+          docker build  -t esp32-javascript:latest -f tools/Dockerfile .
+          docker run -t esp32-javascript:latest bash -c '. ./tools/install-node.sh; idf.py build'

.gitignore

@@ -1,3 +1,5 @@
 build
 sdkconfig.old*
-main/project.cpp
+main/project.cpp
+node_modules
+

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.vscode/c_cpp_properties.json

@@ -1,28 +1,20 @@
 {
-    "configurations": [
-        {
-            "name": "ESP32",
-            "includePath": [
-                "${workspaceRoot}/**",
-                "${workspaceRoot}/components/**",
-                "${workspaceRoot}/build/**",
-                "${workspaceRoot}/build/include/**",
-                "${env:IDF_PATH}/components/**"
-            ],
-            "intelliSenseMode": "clang-x64",
-            "browse": {
-                "path": [
-                    "${workspaceRoot}/**",
-                    "${workspaceRoot}/components/**",
-                    "${workspaceRoot}/build/**",
-                    "${workspaceRoot}/build/include/**",
-                    "${env:IDF_PATH}/components/**"
-                    ],
-                "limitSymbolsToIncludedHeaders": true
-            },
-            "cStandard": "c11",
-            "cppStandard": "c++17"
-        }
-    ],
-    "version": 4
+  "configurations": [
+    {
+      "name": "ESP32",
+      "includePath": [
+        "${workspaceRoot}/**",
+        "${workspaceRoot}/components/**",
+        "${workspaceRoot}/build/**",
+        "${IDF_PATH}/components/**",
+        "${IDF_PATH}/../xtensa-esp32-elf/xtensa-esp32-elf/include/",
+        "${IDF_PATH}/../xtensa-esp32-elf/xtensa-esp32-elf/include/**"
+      ],
+      "intelliSenseMode": "gcc-x86",
+      "cStandard": "c18",
+      "cppStandard": "c++17"
+    }
+  ],
+  "enableConfigurationSquiggles": true,
+  "version": 4
 }

.vscode/settings.json

@@ -37,6 +37,9 @@
         "time.h": "c",
         "reent.h": "c",
         "thread": "cpp",
-        "cmath": "cpp"
-    }
+        "cmath": "cpp",
+        "string": "cpp",
+        "*.contiki": "cpp"
+    },
+    "C_Cpp.errorSquiggles": "Enabled"
 }

.vscode/tasks.json

@@ -0,0 +1,22 @@
+{
+  "tasks": [
+    {
+      "type": "process",
+      "label": "C/C++: g++ build active file",
+      "command": "zsh",
+      "args": ["-i", "-c", "idf.py build"],
+      "options": {
+        "cwd": "${workspaceFolder}",
+        "env": {
+          "IDF_PYTHON_ENV_PATH": "/home/marric/.espressif/python_env/idf4.2_py3.8_env"
+        }
+      },
+      "problemMatcher": ["$gcc"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ],
+  "version": "2.0.0"
+}

CMakeLists.txt

@@ -20,5 +20,5 @@ add_custom_target(cp_modules ALL
     COMMAND scripts/copy-modules.sh
     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
 
-spiffs_create_partition_image(storage build/modules FLASH_IN_PROJECT
+spiffs_create_partition_image(modules build/modules FLASH_IN_PROJECT
     DEPENDS cp_modules)

README.md

@@ -46,7 +46,7 @@ Use the keyboard shortcut `AltGr + ]` to leave serial monitor.
 
 Now you have installed the pre-configured boot script.
 
-If this is your first install, your onboard LED should blink now. Blinking signals that your board has started a soft ap with the ssid "esp32". With your mobile or desktop connect to the WLAN SSID "esp32" and open http://192.168.4.1/setup (if you have not changed the default credentials your username / password is esp32 / esp32 ).
+If this is your first install, your onboard LED should blink now. Blinking signals that your board has started a soft ap with the ssid "esp32". With your mobile or desktop connect to the WLAN SSID "esp32" and open http://192.168.4.1/setup (if you have not changed the default credentials your username / password is esp32 / esp32 ). You can change the default password in `./sdkconfig` by changing the value of `CONFIG_ESP32_JS_BASIC_AUTH_PASSWORD`.  
 
 On the Setup page you can configure your WLAN settings and an URL to download your JS main script from.
 
@@ -80,18 +80,34 @@ See [ESP Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp
 
 ### Clean        
 
-You can clean the project with
+You can clean the project by executing
 
 ```shell
     idf.py fullclean
 ```
 
+### Factory reset        
+
+You can erase the persistent flash memory, which will be equivalent to a factory reset, by executing
+
+```shell
+    idf.py erase_flash
+```
+
 ## Compatibility
 
 Tested with esp-idf (master branch commit hash 2e14149b).
 
 ## API
-[API documentation](api.md)
+[API documentation](docs/README.md)
+
+### Update docs
+
+Update documentation by executing
+
+```shell
+    npm run doc
+```
 
 ## License
 See source files.