From 2e5a70d33fa7e76050f1315a9e400e07adb71b5f Mon Sep 17 00:00:00 2001
From: Sven Luethi <dev@svenluthi.com>
Date: Sun, 7 Jul 2024 01:19:32 +0200
Subject: [PATCH] 	new file:   README.md 	modified:   app.php 
 renamed:    update.php -> device-api.php 	new file:   integration.php 
 deleted:    registration.php 	deleted:    report.php

---
 software/README.md                      | 13 +++++++++++++
 software/app.php                        |  9 ++++++---
 software/{update.php => device-api.php} | 15 ++++++++++-----
 software/integration.php                |  7 +++++++
 software/registration.php               | 14 --------------
 software/report.php                     | 15 ---------------
 6 files changed, 36 insertions(+), 37 deletions(-)
 create mode 100644 software/README.md
 rename software/{update.php => device-api.php} (68%)
 create mode 100644 software/integration.php
 delete mode 100644 software/registration.php
 delete mode 100644 software/report.php

diff --git a/software/README.md b/software/README.md
new file mode 100644
index 0000000..e849484
--- /dev/null
+++ b/software/README.md
@@ -0,0 +1,13 @@
+# Controller Software for DC Sensor
+
+## API definition
+
+- id
+    - GET: Returns a new ID for device to use for future communication.
+- metrics
+    - GET: Prometheus metrics endpoint for temperatures.
+- report
+    - POST: Device reports temperature back on this endpoint.
+
+## UI
+- manage
diff --git a/software/app.php b/software/app.php
index 78b501a..0dc69bd 100644
--- a/software/app.php
+++ b/software/app.php
@@ -12,7 +12,10 @@ $router->get('/', function($req) {
     http_response_code(200);
 });
 
-require_once('update.php');
-require_once('report.php');
-require_once('registration.php');
+$router->get('/favicon.ico', function() {
+    http_response_code(404);
+});
+
+require_once('device-api.php');
+require_once('integration.php');
 
diff --git a/software/update.php b/software/device-api.php
similarity index 68%
rename from software/update.php
rename to software/device-api.php
index 1d75e3c..47f1925 100644
--- a/software/update.php
+++ b/software/device-api.php
@@ -1,12 +1,18 @@
 <?php
 
-$router->get('/favicon.ico', function() {
-    http_response_code(404);
+// Returns a new ID for device to use for future communication.
+$router->get('/api/id', function($req) {
+    http_response_code(200);
 });
 
-$router->get('/update', function() {
-    //(new DumpHTTPRequestToFile)->execute( __DIR__ . '/dumprequest.txt');
+// Device reports temperature back on this endpoint.
+$router->post('/api/report', function($req) {
+    echo 'body:' . var_dump($req->getBody()) . "\n";
+    DumpHTTPRequestToFile::execute("/tmp/out.txt");
+    http_response_code(200);
+});
 
+$router->get('/api/update', function() {
     if ( $_SERVER['HTTP_USER_AGENT'] == 'ESP8266-http-Update' && isset($_SERVER['HTTP_X_ESP8266_SKETCH_MD5']) ) {
         $user_agent        = $_SERVER['HTTP_USER_AGENT'];
         $curr_firmware_md5 = $_SERVER['HTTP_X_ESP8266_SKETCH_MD5'];
@@ -29,4 +35,3 @@ $router->get('/update', function() {
 
     http_response_code(400);
 });
-
diff --git a/software/integration.php b/software/integration.php
new file mode 100644
index 0000000..4c4568e
--- /dev/null
+++ b/software/integration.php
@@ -0,0 +1,7 @@
+<?php
+
+// Prometheus metrics endpoint for temperatures.
+$router->get('/metrics', function($req) {
+    http_response_code(200);
+});
+
diff --git a/software/registration.php b/software/registration.php
deleted file mode 100644
index 1f61138..0000000
--- a/software/registration.php
+++ /dev/null
@@ -1,14 +0,0 @@
-<?php
-// Device registration endpoint
-
-$router->get('/registration', function($req) {
-    echo "Nothing to see here at registration!\n";
-    http_response_code(200);
-});
-
-$router->post('/registration', function($req) {
-    echo 'body:' . var_dump($req->getBody()) . "\n";
-    //DumpHTTPRequestToFile::execute("/tmp/out.txt");
-    http_response_code(200);
-});
-
diff --git a/software/report.php b/software/report.php
deleted file mode 100644
index f23febb..0000000
--- a/software/report.php
+++ /dev/null
@@ -1,15 +0,0 @@
-<?php
-// Reporting endpoint for sensors to report the temperature of each of its sensors etc.
-
-
-$router->get('/report', function($req) {
-    echo "Nothing to see here!\n";
-    http_response_code(200);
-});
-
-$router->post('/report', function($req) {
-    echo 'body:' . var_dump($req->getBody()) . "\n";
-    DumpHTTPRequestToFile::execute("/tmp/out.txt");
-    http_response_code(200);
-});
-