Merge pull request #43 from miksrv/develop

Close issue #35, #42, #41, #37. Add helmet UI component, change API host path photos
miksrv · Feb 17, 2022 · 7bb0aa9 · 7bb0aa9
2 parents ee2d1c6 + 9b2c476
commit 7bb0aa9
Show file tree

Hide file tree

Showing 18 changed files with 534 additions and 46 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,206 @@ The observatory controller is based on Ardunio (AVR) and connects to the observa
 - DHT22
 - DS18B20
 
+### API methods
+The response format is JSON, the response structure is always the same, only payload will change in different APIs
+```json
+{
+  "status": true,
+  "payload": []
+}
+```
+
+#### FITS files controller
+``/api/get/file/list?object=${string}``
+```json
+{
+  "id": "fe03bc1c2cfd97de1f97edbdd57e3acb",
+  "name": "M33_Light_Red_300_secs_2020-08-27T03-45-00_010.fits",
+  "date": "2020-08-26 22:39:59",
+  "filter": "Red",
+  "exposure": 300,
+  "temp": -10,
+  "offset": 10,
+  "gain": 120,
+  "dec": 30.5457,
+  "ra": 23.4641
+}
+```
+#### Photo controller
+``/api/get/photo/list``
+```json
+{
+  "object": "NGC_896",
+  "date": "2022-02-09",
+  "file": "NGC_896-710m-2022.02.09",
+  "ext": "jpg",
+  "author": {
+    "name": "Author name",
+    "link": ""
+  }
+}
+```
+
+``/api/get/photo/list?object=${string}``
+```json
+{
+  "object": "M_33",
+  "date": "2020-12-25",
+  "file": "M33-630m-2020.12.25",
+  "ext": "jpg",
+  "author": {
+    "name": "Author name",
+    "link": ""
+  },
+  "parameters": {
+    "date": "2020-08-26 23:10:55",
+    "exposure": 45367,
+    "frames": 214,
+    "filesizes": 7016,
+    "filters": {
+      "Luminance": {
+        "exposure": 13203,
+        "frames": 45
+      },
+      "Red": {
+        "exposure": 11138,
+        "frames": 75
+      },
+      "Green": {
+        "exposure": 8722,
+        "frames": 51
+      },
+      "Blue": {
+        "exposure": 7500,
+        "frames": 25
+      },
+      "Ha": {
+        "exposure": 4804,
+        "frames": 18
+      },
+      "OIII": {
+        "exposure": 0,
+        "frames": 0
+      },
+      "SII": {
+        "exposure": 0,
+        "frames": 0
+      }
+    }
+  }
+}
+```
+
+#### Object controller
+``/api/get/object/list``
+```json
+{
+  "name": "NGC_925",
+  "date": "2021-10-10 00:51:07",
+  "exposure": 51300,
+  "frames": 171,
+  "Luminance": 12900,
+  "Red": 14700,
+  "Green": 13500,
+  "Blue": 10200,
+  "Ha": 0,
+  "OIII": 0,
+  "SII": 0
+}
+```
+
+``/api/get/object/names``
+```json
+[
+  "Vesta_A807_FA",
+  "V1405_Cas",
+  "UGC_6930",
+  "Sh2_132",
+  "Sh2_109",
+  "Sh2_103",
+  "Sh2-168"
+]
+```
+
+``/api/get/object/item?object=${string}``
+```json
+{
+  "date": "2020-08-26 23:10:55",
+  "exposure": 45367,
+  "frames": 214,
+  "filesizes": 7016,
+  "filters": {
+    "Luminance": {
+      "exposure": 13203,
+      "frames": 45
+    },
+    "Red": {
+      "exposure": 11138,
+      "frames": 75
+    },
+    "Green": {
+      "exposure": 8722,
+      "frames": 51
+    },
+    "Blue": {
+      "exposure": 7500,
+      "frames": 25
+    },
+    "Ha": {
+      "exposure": 4804,
+      "frames": 18
+    },
+    "OIII": {
+      "exposure": 0,
+      "frames": 0
+    },
+    "SII": {
+      "exposure": 0,
+      "frames": 0
+    }
+  }
+}
+```
+
+#### Catalog controller
+``/api/get/catalog/list``
+```json
+[
+  {
+    "name": "V1405_Cas",
+    "title": "Новая Кассиопеи (V1405 Cas)",
+    "text": "Вспышка классической новой звезды, представляющая собой взрыв на поверхности белого карлика.",
+    "category": "Сверхновые",
+    "ra": 351.147,
+    "dec": 61.1585
+  }
+]
+```
+
+``/api/get/catalog/item?object=${string}``
+```json
+{
+  "name": "V1405_Cas",
+  "title": "Новая Кассиопеи (V1405 Cas)",
+  "text": "Вспышка классической новой звезды, представляющая собой взрыв на поверхности белого карлика.",
+  "category": "Сверхновые",
+  "ra": 351.147,
+  "dec": 61.1585
+}
+```
+
+#### Statistic controller
+``/api/get/statistic/summary``
+```json
+{
+  "photos": 63,
+  "objects": 89,
+  "frames": 5987,
+  "exposure": 1785611,
+  "filesize": 196289
+}
+```
+
 ----------------------
 ### Project structure