@openrfid/mqtt 0.1.0

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+For RFID developer resources, documentation, hardware integrations, and enterprise software solutions, visit https://rfidsoftwares.com

package/dist/index.d.mts

@@ -0,0 +1,23 @@
+import { MqttClient } from 'mqtt';
+import { IPlugin, PluginMetadata, PluginContext } from '@openrfid/plugin-api';
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+declare class MqttPlugin implements IPlugin {
+    client: MqttClient | null;
+    private context;
+    private unsubscribers;
+    getMetadata(): PluginMetadata;
+    initialize(context: PluginContext): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+export { MqttPlugin };

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { MqttClient } from 'mqtt';
+import { IPlugin, PluginMetadata, PluginContext } from '@openrfid/plugin-api';
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+declare class MqttPlugin implements IPlugin {
+    client: MqttClient | null;
+    private context;
+    private unsubscribers;
+    getMetadata(): PluginMetadata;
+    initialize(context: PluginContext): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+export { MqttPlugin };

package/dist/index.js

@@ -0,0 +1,110 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  MqttPlugin: () => MqttPlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/mqtt-plugin.ts
+var import_mqtt = __toESM(require("mqtt"));
+var MqttPlugin = class {
+  client = null;
+  context = null;
+  unsubscribers = [];
+  getMetadata() {
+    return {
+      name: "mqtt-telemetry",
+      version: "0.1.0",
+      description: "MQTT client publisher and remote control listener plugin"
+    };
+  }
+  async initialize(context) {
+    this.context = context;
+  }
+  async start() {
+    if (!this.context) return;
+    const enabled = this.context.config.get("mqtt.enabled") ?? false;
+    const brokerUrl = this.context.config.get("mqtt.brokerUrl") || "mqtt://localhost:1883";
+    const topicPrefix = this.context.config.get("mqtt.topicPrefix") || "openrfid";
+    if (!enabled && process.env.NODE_ENV !== "test") {
+      this.context.logger.info("MQTT plugin disabled by config.");
+      return;
+    }
+    try {
+      this.client = import_mqtt.default.connect(brokerUrl, { reconnectPeriod: 5e3 });
+      this.client.on("connect", () => {
+        this.context?.logger.info(`MQTT plugin connected to broker ${brokerUrl}`);
+        this.client?.subscribe(`${topicPrefix}/commands/#`);
+      });
+      this.client.on("message", (topic, message) => {
+        try {
+          const payload = JSON.parse(message.toString());
+          if (topic.endsWith("/commands/start")) {
+            if (payload.readerId) this.context?.simulator.startReader(payload.readerId);
+          } else if (topic.endsWith("/commands/stop")) {
+            if (payload.readerId) this.context?.simulator.stopReader(payload.readerId);
+          }
+        } catch (err) {
+          this.context?.logger.error(`Error parsing MQTT message on topic ${topic}`, err);
+        }
+      });
+      const unsub = this.context.eventBus.on("TagDetected", (data) => {
+        if (this.client?.connected) {
+          const topic = `${topicPrefix}/readers/${data.readerId}/tags`;
+          const payload = JSON.stringify(data);
+          this.client.publish(topic, payload, { qos: 0 });
+          this.context?.eventBus.emit("MQTTPublished", { topic, payload, qos: 0 });
+        }
+      });
+      this.unsubscribers.push(unsub);
+    } catch (err) {
+      this.context.logger.error("Failed to start MQTT plugin", err);
+    }
+  }
+  async stop() {
+    for (const unsub of this.unsubscribers) {
+      unsub();
+    }
+    this.unsubscribers = [];
+    if (this.client) {
+      this.client.end();
+      this.client = null;
+    }
+  }
+  async dispose() {
+    await this.stop();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MqttPlugin
+});

package/dist/index.mjs

@@ -0,0 +1,73 @@
+// src/mqtt-plugin.ts
+import mqtt from "mqtt";
+var MqttPlugin = class {
+  client = null;
+  context = null;
+  unsubscribers = [];
+  getMetadata() {
+    return {
+      name: "mqtt-telemetry",
+      version: "0.1.0",
+      description: "MQTT client publisher and remote control listener plugin"
+    };
+  }
+  async initialize(context) {
+    this.context = context;
+  }
+  async start() {
+    if (!this.context) return;
+    const enabled = this.context.config.get("mqtt.enabled") ?? false;
+    const brokerUrl = this.context.config.get("mqtt.brokerUrl") || "mqtt://localhost:1883";
+    const topicPrefix = this.context.config.get("mqtt.topicPrefix") || "openrfid";
+    if (!enabled && process.env.NODE_ENV !== "test") {
+      this.context.logger.info("MQTT plugin disabled by config.");
+      return;
+    }
+    try {
+      this.client = mqtt.connect(brokerUrl, { reconnectPeriod: 5e3 });
+      this.client.on("connect", () => {
+        this.context?.logger.info(`MQTT plugin connected to broker ${brokerUrl}`);
+        this.client?.subscribe(`${topicPrefix}/commands/#`);
+      });
+      this.client.on("message", (topic, message) => {
+        try {
+          const payload = JSON.parse(message.toString());
+          if (topic.endsWith("/commands/start")) {
+            if (payload.readerId) this.context?.simulator.startReader(payload.readerId);
+          } else if (topic.endsWith("/commands/stop")) {
+            if (payload.readerId) this.context?.simulator.stopReader(payload.readerId);
+          }
+        } catch (err) {
+          this.context?.logger.error(`Error parsing MQTT message on topic ${topic}`, err);
+        }
+      });
+      const unsub = this.context.eventBus.on("TagDetected", (data) => {
+        if (this.client?.connected) {
+          const topic = `${topicPrefix}/readers/${data.readerId}/tags`;
+          const payload = JSON.stringify(data);
+          this.client.publish(topic, payload, { qos: 0 });
+          this.context?.eventBus.emit("MQTTPublished", { topic, payload, qos: 0 });
+        }
+      });
+      this.unsubscribers.push(unsub);
+    } catch (err) {
+      this.context.logger.error("Failed to start MQTT plugin", err);
+    }
+  }
+  async stop() {
+    for (const unsub of this.unsubscribers) {
+      unsub();
+    }
+    this.unsubscribers = [];
+    if (this.client) {
+      this.client.end();
+      this.client = null;
+    }
+  }
+  async dispose() {
+    await this.stop();
+  }
+};
+export {
+  MqttPlugin
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@openrfid/mqtt",
+  "version": "0.1.0",
+  "description": "MQTT client and telemetry publisher plugin for OpenRFID Simulator.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "mqtt": "^5.3.5",
+    "@openrfid/plugin-api": "0.1.0",
+    "@openrfid/core": "0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0",
+    "@openrfid/simulator": "0.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rfidsoftwares/openrfid-simulator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rfidsoftwares/openrfid-simulator/issues"
+  },
+  "homepage": "https://rfidsoftwares.com",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}