Creates MotionApi class and related README

README.md

@@ -0,0 +1,58 @@
+# Motion API
+
+This library aims to expose a simplistic API for the https://motion-project.github.io/ project.
+
+# Installation
+
+``` 
+npm i motion-project-api
+```
+
+# Usage
+
+Example creating a snapshot with the camera 1.
+
+```typescript
+let motionApi = new MotionApi("http://localhost:7999"); // URL of the motion web server
+motionApi.getCamera(1).createSnapshot(); // creates a snapshot for the camera 1
+```
+
+## API
+
+### Class MotionApi
+
+**MotionApi(apiUrl)**
+
++ apiUrl - (_string_) The motion web server url.
+
+**getCamera(idCamera): Camera**
+
++ idCamera - (_number_) The camera number to control.
+
+Returns an instance of `Camera`.
+
+### Class Camera
+
+**Camera(id)**
+
++ id - (_number_) The camera number to control.
+
+**startMotionDetection(): Promise<void>**
+
+Start or resume motion detection.
+
+**pauseMotionDetection(): Promise<void>**
+
+Pause the motion detection.
+
+**createSnapshot(): Promise<void>**
+
+Create a snapshot
+
+**getCurrentStatus(): Promise<MotionDetectionStatus>**
+
+Return the current status of the camera. `MotionDetectionStatus.ENABLE` is enable or `MotionDetectionStatus.DISABLE` if disabled.
+
+**getConnectionStatus(): Promise<MotionConnectionStatus>**
+
+Return the connection status of the camera. `MotionConnectionStatus.OK` if well connected otherwise `MotionConnectionStatus.DISCONNECTED`.

package.json

@@ -2,13 +2,12 @@
   "name": "motion-project-api",
   "version": "1.0.0",
   "description": "API for https://motion-project.github.io/",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
+  "main": "build/MotionApi.js",
+  "types": "build/MotionApi.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "rm -rf build/ && tsc",
-    "install": "npm run build",
-    "start": "npm run build && node build/index.js"
+    "install": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -27,6 +26,7 @@
   "homepage": "https://github.com/baudev/motion-project-api#readme",
   "dependencies": {
     "@types/node": "^13.9.2",
+    "lodash": "^4.17.15",
     "node-fetch": "^2.6.0",
     "typescript": "^3.8.3"
   }

src/Camera.ts

@@ -40,7 +40,7 @@ export class Camera {
     /**
      * Return the current status of the camera.
      */
-    public getCurrentStatus() {
+    public getCurrentStatus(): Promise<MotionDetectionStatus> {
         return WebControl.getDetectionStatus(this.id)
             .then((message) => {
                 return new RegExp(/Detection status ACTIVE/).test(message) ? MotionDetectionStatus.ENABLE : MotionDetectionStatus.DISABLE;

src/MotionApi.ts

@@ -0,0 +1,34 @@
+import {WebControl} from "./WebControl";
+import {Camera} from "./Camera";
+
+const _ = require('lodash');
+
+export class MotionApi {
+
+    private cameras: Array<Camera> = [];
+
+    /**
+     * Creates MotionApi object
+     * @param apiUrl The base url of the HTTP motion server
+     */
+    constructor(apiUrl: string) {
+        WebControl.url = apiUrl;
+    }
+
+    /**
+     * Returns an unique instance of the camera
+     * @param idCamera
+     */
+    public getCamera(idCamera: number): Camera{
+        let camera = _.find(this.cameras, function (camera: Camera) {
+            return camera.id === idCamera;
+        });
+        if (camera !== undefined) {
+            return camera;
+        } else {
+            let newCamera = new Camera(idCamera);
+            this.cameras.push(newCamera);
+            return newCamera;
+        }
+    }
+}

src/WebControl.ts

@@ -1,13 +1,11 @@
-import {throws} from "assert";
-
 const fetch = require("node-fetch");
 
 export class WebControl {
 
-    public static url = "http://192.168.1.68:7999";
+    private static _url: string;
 
     private static request(route: string){
-        return fetch(WebControl.url + "/" + route)
+        return fetch(WebControl._url + "/" + route)
             .then((res: Response) => res.text());
     }
 
@@ -51,4 +49,12 @@ export class WebControl {
         return WebControl.request(cameraId + "/action/snapshot");
     }
 
+    /**
+     * Setter for server URL
+     * @param value
+     */
+    static set url(value: string) {
+        this._url = value;
+    }
+
 }