Merge pull request #3 from openairmx/eagle-onlineHEADmain

Eagle online controller

1 files changed, 12 insertions, 1 deletions

diff --git a/README.md b/README.md
index 86994e5..e042ce3 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ HOSTNAME="127.0.0.1" PORT=8080 node server.mjs
     seconds back to the device.
   </dd>
 
-  <dt>GET /eagle</dt>
+  <dt>GET /eagle?path=eagle/GET/genId</dt>
   <dd>
     During the pairing process, when the device receives the Wi-Fi credentials
     you provide, it registers itself with this endpoint along with its MAC
@@ -49,6 +49,17 @@ HOSTNAME="127.0.0.1" PORT=8080 node server.mjs
     the final stage of the pairing process.
   </dd>
 
+  <dt>GET /eagle?path=eagle/GET/online</dt>
+  <dd>
+    <p>The device will access this endpoint immediately after it receives the
+    Wi-Fi credentials during the pairing process. Based on the hints from
+    the path name and payload, we believe this endpoint allows the device to
+    determine if it has successfully connected to the AIRMX network.</p>
+    <p>Therefore, regardless of the parameters the API receives, we will
+    always provide it with a predetermined response, making it appear as
+    though the air monitor and the AIRMX Pro unit are already connected.</p>
+  </dd>
+
   <dt>GET /exchange</dt>
   <dd>
     To streamline device pairing, we introduce an unofficial API that enables