@pipedream/platerecognizer 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Plate Recognizer API provides robust tools for converting images of vehicle license plates into text data. Using Pipedream, you can harness this capability to automate various tasks involving vehicle identification and monitoring. This integration is particularly useful in scenarios involving security, parking management, and logistics optimization, where automated plate recognition can streamline operations significantly.
+
+# Example Use Cases
+
+- **Automated Parking Access**: Set up a workflow where a camera at a parking entrance snaps pictures of incoming vehicles. Use the Plate Recognizer API to decode the license plate and check against a database of authorized vehicles (hosted on a service like Airtable). If the vehicle is authorized, trigger an IoT device to open the gate.
+
+- **Security Alert System**: Create a workflow that monitors a feed from security cameras. Use the Plate Recognizer API to identify license plates of vehicles entering a restricted area. If a plate matches a list of flagged vehicles (maintained in a Google Sheets file), send an alert message via Slack or email to security personnel.
+
+- **Logistics Tracking**: Develop a system to track the arrival and departure of trucks at a warehouse. Capture license plate images, decode them through the Plate Recognizer API, and log the timestamps in a database. Use this data to analyze logistics efficiency and notify managers via SMS (using Twilio) if there are notable delays or early arrivals.

package/actions/run-recognition/run-recognition.mjs

@@ -0,0 +1,65 @@
+import { getFileStream } from "@pipedream/platform";
+import platerecognizer from "../../platerecognizer.app.mjs";
+
+export default {
+  key: "platerecognizer-run-recognition",
+  name: "Run Recognition",
+  description: "Triggers a recognition process using the Plate Recognizer SDK.",
+  version: "0.1.0",
+  type: "action",
+  props: {
+    platerecognizer,
+    imageFileOrUrl: {
+      type: "string",
+      label: "Image Path or URL",
+      description: "The image to be recognized. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myImage.jpg`)",
+    },
+    regions: {
+      type: "string[]",
+      label: "Regions",
+      description: "Regions to select specific license plate patterns. [See further details here](https://guides.platerecognizer.com/docs/other/country-codes/#country-codes)",
+      optional: true,
+    },
+    cameraId: {
+      type: "string",
+      label: "Camera ID",
+      description: "The ID of the camera that took the image.",
+      optional: true,
+    },
+    mmc: {
+      type: "boolean",
+      label: "MMC",
+      description: "Whether to detect vehicle make, model, and color.",
+      optional: true,
+    },
+    config: {
+      type: "object",
+      label: "Config",
+      description: "Additional configuration. [See further details here](https://guides.platerecognizer.com/docs/snapshot/api-reference/#engine-configuration)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+
+    const stream = await getFileStream(this.imageFileOrUrl);
+    const chunks = [];
+    for await (const chunk of stream) {
+      chunks.push(chunk);
+    }
+    const buffer = Buffer.concat(chunks);
+
+    const response = await this.platerecognizer.runRecognition({
+      $,
+      data: {
+        upload: buffer.toString("base64"),
+        regions: this.regions,
+        camera_id: this.cameraId,
+        mmc: this.mmc,
+        config: this.config,
+      },
+    });
+
+    $.export("$summary", "Recognition process triggered successfully");
+    return response;
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,6 @@
+export const checkTmp = (filename) => {
+  if (!filename.startsWith("/tmp")) {
+    return `/tmp/${filename}`;
+  }
+  return filename;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/platerecognizer",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream Plate Recognizer Components",
   "main": "platerecognizer.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.0"
   }
 }

package/platerecognizer.app.mjs

@@ -1,11 +1,33 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "platerecognizer",
-  propDefinitions: {},
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.platerecognizer.com/v1";
+    },
+    _headers(headers) {
+      return {
+        "Authorization": `Token ${this.$auth.api_token}`,
+        ...headers,
+      };
+    },
+    _makeRequest({
+      $ = this, path, headers = {}, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: this._headers(headers),
+        ...opts,
+      });
+    },
+    runRecognition(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/plate-reader/",
+        ...opts,
+      });
     },
   },
-};
+};