Dev (#6)

* feat: local server for development without board

* fix (server): add logging and timing

* redacted the api specs (mostly)

* updated api config endpoint

* Got rid of AsyncElegantOTA, lost some weight, temporary cheap ui for file input testing (web ota)

* Added description of the replica control api (not implemented yet)

* Added version api ressource, little refactor of configuration module, rearanged build flow (yes, not the right branch for that, meh)

* Added the handlers for replica components API

* refactored components to use only static methods and members

* replica component apis now working

* Fixed some hhtp return codes end reinforced selector state api

* Added unlimited wifi capability, and updated api readme

* feat (server): Update local server specification

* feat: UI v2.0.1

* fix: remove unused files

* feat: REAME V2

* Fix (readme): add developers

* style (readme): add escape tags

* fix (readme): use svg to diplay advanced html

* Implemented "enable precocking" and "uncock after x seconds"

* fixed a little bug on saving config

* Add node_modules to .gitignore

* added missing api ressources in readme

Co-authored-by: Zao Soula <[email protected]>

Author: simonjamain

.gitignore

@@ -3,3 +3,4 @@
 .vscode/c_cpp_properties.json
 .vscode/launch.json
 .vscode/ipch
+node_modules/

.vscode/settings.json

@@ -6,6 +6,7 @@
 		"string": "cpp",
 		"vector": "cpp",
 		"unordered_map": "cpp",
-		"regex": "cpp"
+		"regex": "cpp",
+		"functional": "cpp"
 	}
 }

README.md

@@ -1,27 +1,106 @@
-# openmosfet
 
-OpenMosfet is a high quality open source airsoft mosfet based on arduino (currently esp32 board).
+[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/green?icon=github)](https://github.com/simonjamain/openmosfet)
+[![Maintenance](https://badgen.net/badge/Maintained%20%3F/Yes%21/green?icon=github)](https://github.com/simonjamain/openmosfet/graphs/commit-activity)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/simonjamain/openmosfet)
+
+<br/>
+<p align="center">
+  <a href="https://github.com/othneildrew/Best-README-Template">
+    <img src="doc/assets/images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">OpenMosfet</h3>
+
+  <p align="center">
+    An high quality open source <strong>airsoft mosfet</strong><br> based on arduino.
+    <br/><br/>
+    <a href="#"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/simonjamain/openmosfet/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/simonjamain/openmosfet/issues">Request Feature</a>
+  </p>
+</p>
+
+<details open="open">
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li>
+          <a href="#the-team">The team</a>
+          <ul>
+            <li><a href="#developers">Developers</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#installation-and-build">Installation and build</a></li>
+        <li><a href="#replica-interface-types">Replica interface types</a></li>
+        <li><a href="#custom-replica-interface-pinout">Custom replica interface pinout</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#development">Development</a>
+      <ul>
+        <li>
+          <a href="#local-ui-without-board">Local UI (without board)</a>
+          <ul>
+            <li><a href="#install-and-serve">Install and serve</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li><a href="#usage">Development</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#todo">To-Do</a></li>
+  </ol>
+</details>
+
+## About the project
+
+
+OpenMosfet is an high quality open source airsoft mosfet based on arduino (currently esp32 board).
 
 The software is meant to be modular and to allow different sensors configurations.
 
 The hardware provides all the electronics needed and allows different boards to be created.
 
-## the current team
-The team is composed of a programmer ([Simon](https://github.com/simonjamain)) and two electronitians (Romain & Marcellin), all french airsofters.
+The web dashboard allows full and easy controls over every settings as well an update manager.
 
-## installation and build
+![OpenMosfet Web Dashboard](doc/assets/images/ui.png)
+
+### The team
+
+
+The team is composed of two developers ([Simon](https://github.com/simonjamain) and [Zao Soula](https://github.com/zaosoula)) and two electronitians (Romain and Marcellin), all french airsofters.
+
+#### Developers
+
+<img src="doc/assets/images/developers.svg" alt="Logo" width="100%">
+
+
+## Getting started
+### Installation and build
 - Install platformio
 - "open" the project
 - for building the ui (mandatory) :
   - install node.js
   - inside the `ui` folder, run `npm install`
   - *Note : `ui.h` is recompiled by running the command `npm run build` inside the `ui` folder. this is done automaticaly before each platformio build (see platformio.ini and build_ui.py)*
-- OTA upload is enabled by default, if your board hasnt ota enabled or you want to upload with serial, uncomment that following parameters in `platformio.ini`
+- OTA upload is enabled by default, if your board hasn't ota enabled or you want to upload with serial, comment that following parameters in `platformio.ini`
   - `upload_protocol`
   - `upload_port`
+- default password for access point is "password"
 - I think thats about it...
 
-### replica interface types
+### Replica interface types
 Depending on your replica and the way you connect the mosfet, the signals received are not the same.
 
 ex : the original input plate on the G&G TR 16 can be used but the signals are very specific.
@@ -36,7 +115,7 @@ Here is a table (work in progress) listing the different configuration available
 ---------------------|---------------|--------------
 1 | `OM_DEFAULT_FIRINGGROUP_PIN` grounded when : trigger is pressed AND safety is off AND mag is not empty<br>`OM_DEFAULT_CUTOFF_PIN` grounded when cutoff is pressed<br>`OM_DEFAULT_SELECTOR_PIN` grounded when selector is on full auto position | G&G tr16 original input plate
 
-### custom replica interface pinout
+### Custom replica interface pinout
 For developpement reasons or other, you can change the default settings for the replica interface with the following flags :
 
 - `OM_DEFAULT_MOTOR_PIN`
@@ -47,26 +126,25 @@ For developpement reasons or other, you can change the default settings for the
 *Note: it is not recommended that you change this value in the source file, but rather as a build flag in platformio.ini for example.*  
 *Note: for example, the ESP32DEVKIT V1 doesnt have the pin 10 exposed, which is the default pin used on the board for the selector input.*
 
-## hardware
+### http rest-like API
+
+Got to the [API documentation](/doc/api).
+
+## Development
+
+### Local UI (without board)
+To serve the UI locally on your computer, we provide a fake server to simulate the board behavior.
+
+#### Install and serve
+  - inside the `/src/ui/` folder, run `npm install`
+  - run `npm run serve-dev`
+  - open http://localhost:3000/ in your browser
+  - you can now edit ``src/`` without having to re-launch the server
+
+*Note: The configuration is loaded from ``defaultConf.json`` and can be updated as long as the server is running.
+Once it stops the updated configuration is lost*
 
-## contribute
+## Contributing
 Don't hesitate to contact us via github, or your can come and talk with us on our [discord server](https://discord.gg/XuzSSbgE).
-We are french but we can chat in english no prob.
-
-## TODO
-- ~~launch in AP mode when wifi router is not available~~
-- ~~implement sleep modes to prevent battery over-discharge~~
-    - ~~ability to cut wifi off after X sec to save power~~
-    - ~~deep sleep when inactive for two long~~
-- add buzzer ?
-- implement motor vibration
-- create an example module
-- implement all battery protection types :
-  - auto
-  - predefined
-  - manual
-  - none
-- ~~change max ssid and password length to 32 chars instead of 16 : https://serverfault.com/questions/45439/what-is-the-maximum-length-of-a-wifi-access-points-ssid~~
-- add "try to connect now" button next to external wifi settings
-- check if wifi cutoff current saving is reliable
 
+We are french but we can chat in english without problems.

doc/api/README.md

@@ -0,0 +1,71 @@
+## Endpoints
+
+For now, all endpoints doesn't require any Authentication.
+
+### Firmware
+
+- **Updates** : `/api/core/update/`
+  - `POST` : auto-update replica from the github releases  
+  *Note: be carefull of timeout, this usually take 70-80 secs*
+  - `PUT` : upload a .bin to update the firmware
+    - parameters *multipart/form-data*
+      - `firmware` *application/octet-stream* : the binary file
+- **Firmware version** : `/api/core/version/`
+  - `GET` : 
+    - parameters *application/json*
+      - *string* : the current version (semver, see [releases](https://github.com/simonjamain/openmosfet/releases))
+
+### Configuration
+
+This is closely linked to [configuration.h](/src/configuration.h)
+
+- **global configuration** : `/api/config/`
+  - `GET` : reads the global configuration 
+    - parameters *application/json*
+      - `appSsid` *string [8-32]* : Access point ssid
+      - `appPasswd` *string [8-16]* : Access point password
+      - `connectToNetworkIfAvailable` *boolean* : Will try to connect at startup
+      - `availableNetworkAppSsid` *string [8-32]* : External network ssid
+      - `availableNetworkAppPasswd` *string [8-16]* : External network password
+      - `wifiShutdownDelayMinutes` *int* : delay for wifi shutdown after last network activity (0 = never shuts down)
+      - `deepSleepDelayMinutes` *int* : delay for sleep mode after replica inactivity
+      - `useBatteryProtection` *boolean* : Will monitor battery voltage
+      - `batteryNominalVoltage` *float* : Honestly I don't precisely know yet what to do with that
+      - `batteryLowVoltage` *float* : Will alert the user below this voltage
+      - `batteryShutdownVoltage` *float* : Will disable the replica below this voltage
+      - `useActiveBreaking` *float* : Duh.
+      - `enablePrecocking` *boolean* : Enable precocking based on values specified for each firemode
+      - `fireModes` *object array* :
+        - `burstMode` *int [0-2]* : Burst mode, 0=interruptible, 1=normal, 2=extendible
+        - `burstLength` *int* :  
+          normal burstmode : Number of shot fired when trigger pulled  
+          interruptible burstmode : Maximum number of shot fired during trigger pull  
+          extendible burstmode : Minimum number of shot fired when trigger pulled
+        - `precockDuration_ms` *int* : Amount of precocking time after cycle in milliseconds (may be replaced with a %)
+        - `motorPower` *float [0-1]* : Percentage of battery power delivered to the motor (with pwm)
+        - `timeBetweenShots_ms` : Time between each shots, can be used for RoF control or dmr setup
+        - `decockAfter_s` *float* : If the trigger is maintained pressed for set ammount of time after end of burst, cycle and decock ⚠this fires a bb⚠. (0 = no decocking)
+  - `POST` : Set the global configuration and retrieve the saved values in response
+    - parameters *application/json*  
+    same data format as `GET`
+
+### Replica
+ 
+This is closely linked to [components.h](/src/components.h)
+
+- **Trigger state** : `/api/components/trigger/state`
+  - `GET,POST` : set/read the trigger state
+    - parameters *application/json*
+      - *boolean* : [true, false] true for pulling the trigger, false for releasing
+- **Trigger short pull** : `/api/components/trigger/bump`
+  - `POST` : pull and release the trigger
+- **Selector state** : `/api/components/selector/state`
+  - `GET,POST` : set/read the selector state
+    - parameters *application/json*
+      - *int* : [`0`, `1`, `2`]
+- **Gearbox uncocking** : `/api/components/gearbox/uncock`
+  - `POST` : uncock the piston (if cocked) ⚠Be careful, this will eventully fire a BB⚠
+
+--------------
+
+*inspired by https://github.com/jamescooke/restapidocs/*