@openrfid/hopeland-discovery 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,42 @@
+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.
+ *
+ * Hopeland/Identium UDP Multicast Discovery Announcer
+ * =====================================================
+ * This plugin makes the OpenRFID Simulator behave like a real Hopeland/Identium
+ * RFID reader on the local network. It implements the exact discovery protocol
+ * used by the Hopeland MyReaderAPI SDK:
+ *
+ *  - UDP Multicast group: 230.1.1.116  (hardcoded in the SDK)
+ *  - UDP Port:            9091         (hardcoded in the SDK)
+ *  - Message format (ASCII):
+ *      ^RFID_READER_INFORMATION:<type>,IP:<ip>,MAC:<mac>,PORT:<port>,
+ *       HOST_SERVER_IP:0.0.0.0,HOST_SERVER_PORT:0,MODE:SERVER,NET_STATE:CONNECTED$
+ *
+ * The SDK's DeviceSearch class joins this multicast group, listens for these
+ * packets, and parses them into Device_Mode objects shown in the search dialog.
+ * Any middleware using MyReaderAPI (unmodified) will discover the simulator
+ * automatically.
+ *
+ * Also opens a TCP server on port 9090 so that CreateTcpConn() succeeds
+ * (Hopeland binary protocol — full implementation pending Wireshark capture).
+ */
+
+declare class HopelandDiscoveryPlugin implements IPlugin {
+    private udpSocket;
+    private tcpServer;
+    private announceTimer;
+    private context;
+    getMetadata(): PluginMetadata;
+    initialize(context: PluginContext): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+export { HopelandDiscoveryPlugin };

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+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.
+ *
+ * Hopeland/Identium UDP Multicast Discovery Announcer
+ * =====================================================
+ * This plugin makes the OpenRFID Simulator behave like a real Hopeland/Identium
+ * RFID reader on the local network. It implements the exact discovery protocol
+ * used by the Hopeland MyReaderAPI SDK:
+ *
+ *  - UDP Multicast group: 230.1.1.116  (hardcoded in the SDK)
+ *  - UDP Port:            9091         (hardcoded in the SDK)
+ *  - Message format (ASCII):
+ *      ^RFID_READER_INFORMATION:<type>,IP:<ip>,MAC:<mac>,PORT:<port>,
+ *       HOST_SERVER_IP:0.0.0.0,HOST_SERVER_PORT:0,MODE:SERVER,NET_STATE:CONNECTED$
+ *
+ * The SDK's DeviceSearch class joins this multicast group, listens for these
+ * packets, and parses them into Device_Mode objects shown in the search dialog.
+ * Any middleware using MyReaderAPI (unmodified) will discover the simulator
+ * automatically.
+ *
+ * Also opens a TCP server on port 9090 so that CreateTcpConn() succeeds
+ * (Hopeland binary protocol — full implementation pending Wireshark capture).
+ */
+
+declare class HopelandDiscoveryPlugin implements IPlugin {
+    private udpSocket;
+    private tcpServer;
+    private announceTimer;
+    private context;
+    getMetadata(): PluginMetadata;
+    initialize(context: PluginContext): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+export { HopelandDiscoveryPlugin };

package/dist/index.js

@@ -0,0 +1,182 @@
+"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, {
+  HopelandDiscoveryPlugin: () => HopelandDiscoveryPlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/hopeland-discovery-plugin.ts
+var dgram = __toESM(require("dgram"));
+var net = __toESM(require("net"));
+var os = __toESM(require("os"));
+var MULTICAST_GROUP = "230.1.1.116";
+var MULTICAST_PORT = 9091;
+var TCP_PORT = 9090;
+var ANNOUNCE_INTERVAL_MS = 2e3;
+function getLocalIpv4() {
+  const interfaces = os.networkInterfaces();
+  const allIfaces = Array.from(Object.values(interfaces));
+  for (const iface of allIfaces) {
+    if (!iface) continue;
+    for (const entry of iface) {
+      if (entry.family === "IPv4" && !entry.internal) {
+        return entry.address;
+      }
+    }
+  }
+  return "127.0.0.1";
+}
+function buildFakeMac() {
+  const hostname2 = os.hostname();
+  let hash = 0;
+  for (let i = 0; i < hostname2.length; i++) {
+    hash = (hash << 5) - hash + hostname2.charCodeAt(i);
+    hash |= 0;
+  }
+  const hex = (Math.abs(hash) + 1048576).toString(16).padStart(8, "0");
+  return `52-46-${hex.slice(0, 2)}-${hex.slice(2, 4)}-${hex.slice(4, 6)}-${hex.slice(6, 8)}`.toUpperCase();
+}
+function buildAnnouncementPacket(localIp, mac) {
+  const msg = `^RFID_READER_INFORMATION:OpenRFID-Sim,IP:${localIp},MAC:${mac},PORT:${TCP_PORT},HOST_SERVER_IP:0.0.0.0,HOST_SERVER_PORT:0,MODE:SERVER,NET_STATE:CONNECTED$`;
+  return Buffer.from(msg, "ascii");
+}
+var HopelandDiscoveryPlugin = class {
+  udpSocket = null;
+  tcpServer = null;
+  announceTimer = null;
+  context = null;
+  getMetadata() {
+    return {
+      name: "hopeland-discovery",
+      version: "0.1.0",
+      description: `Hopeland/Identium UDP multicast device discovery announcer. Makes the simulator visible as a real RFID reader on the local network (multicast ${MULTICAST_GROUP}:${MULTICAST_PORT}, TCP ${TCP_PORT}).`
+    };
+  }
+  async initialize(context) {
+    this.context = context;
+  }
+  async start() {
+    const localIp = getLocalIpv4();
+    const fakeMac = buildFakeMac();
+    const packet = buildAnnouncementPacket(localIp, fakeMac);
+    this.context?.logger.info(
+      `[HopelandDiscovery] Local IP: ${localIp}  Fake MAC: ${fakeMac}`
+    );
+    this.udpSocket = dgram.createSocket({ type: "udp4", reuseAddr: true });
+    this.udpSocket.on("error", (err) => {
+      this.context?.logger.error("[HopelandDiscovery] UDP socket error", err);
+    });
+    await new Promise((resolve, reject) => {
+      this.udpSocket.bind(0, () => {
+        try {
+          this.udpSocket.setMulticastTTL(16);
+          this.udpSocket.setMulticastLoopback(true);
+          resolve();
+        } catch (e) {
+          reject(e);
+        }
+      });
+    });
+    const sendAnnouncement = () => {
+      this.udpSocket?.send(
+        packet,
+        0,
+        packet.length,
+        MULTICAST_PORT,
+        MULTICAST_GROUP,
+        (err) => {
+          if (err) this.context?.logger.error("[HopelandDiscovery] UDP send error", err);
+        }
+      );
+    };
+    sendAnnouncement();
+    this.announceTimer = setInterval(sendAnnouncement, ANNOUNCE_INTERVAL_MS);
+    this.context?.logger.info(
+      `[HopelandDiscovery] Announcing on UDP multicast ${MULTICAST_GROUP}:${MULTICAST_PORT} every ${ANNOUNCE_INTERVAL_MS}ms`
+    );
+    this.tcpServer = net.createServer((socket) => {
+      const remote = `${socket.remoteAddress}:${socket.remotePort}`;
+      this.context?.logger.info(`[HopelandDiscovery] TCP connection from ${remote}`);
+      socket.on("error", (err) => {
+        this.context?.logger.error(`[HopelandDiscovery] TCP socket error from ${remote}`, err);
+      });
+      socket.on("close", () => {
+        this.context?.logger.info(`[HopelandDiscovery] TCP connection closed: ${remote}`);
+      });
+      socket.on("data", (_data) => {
+      });
+    });
+    this.tcpServer.on("error", (err) => {
+      if (err.code === "EADDRINUSE") {
+        this.context?.logger.error(
+          `[HopelandDiscovery] TCP port ${TCP_PORT} already in use. Is another reader application running?`
+        );
+      } else {
+        this.context?.logger.error("[HopelandDiscovery] TCP server error", err);
+      }
+    });
+    await new Promise((resolve) => {
+      this.tcpServer.listen(TCP_PORT, "0.0.0.0", () => {
+        this.context?.logger.info(
+          `[HopelandDiscovery] TCP server listening on 0.0.0.0:${TCP_PORT} \u2014 middleware can now connect`
+        );
+        resolve();
+      });
+    });
+  }
+  async stop() {
+    if (this.announceTimer) {
+      clearInterval(this.announceTimer);
+      this.announceTimer = null;
+    }
+    if (this.udpSocket) {
+      this.udpSocket.close();
+      this.udpSocket = null;
+    }
+    await new Promise((resolve) => {
+      if (this.tcpServer) {
+        this.tcpServer.close(() => resolve());
+        this.tcpServer = null;
+      } else {
+        resolve();
+      }
+    });
+    this.context?.logger.info("[HopelandDiscovery] Stopped.");
+  }
+  async dispose() {
+    await this.stop();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HopelandDiscoveryPlugin
+});

package/dist/index.mjs

@@ -0,0 +1,145 @@
+// src/hopeland-discovery-plugin.ts
+import * as dgram from "dgram";
+import * as net from "net";
+import * as os from "os";
+var MULTICAST_GROUP = "230.1.1.116";
+var MULTICAST_PORT = 9091;
+var TCP_PORT = 9090;
+var ANNOUNCE_INTERVAL_MS = 2e3;
+function getLocalIpv4() {
+  const interfaces = os.networkInterfaces();
+  const allIfaces = Array.from(Object.values(interfaces));
+  for (const iface of allIfaces) {
+    if (!iface) continue;
+    for (const entry of iface) {
+      if (entry.family === "IPv4" && !entry.internal) {
+        return entry.address;
+      }
+    }
+  }
+  return "127.0.0.1";
+}
+function buildFakeMac() {
+  const hostname2 = os.hostname();
+  let hash = 0;
+  for (let i = 0; i < hostname2.length; i++) {
+    hash = (hash << 5) - hash + hostname2.charCodeAt(i);
+    hash |= 0;
+  }
+  const hex = (Math.abs(hash) + 1048576).toString(16).padStart(8, "0");
+  return `52-46-${hex.slice(0, 2)}-${hex.slice(2, 4)}-${hex.slice(4, 6)}-${hex.slice(6, 8)}`.toUpperCase();
+}
+function buildAnnouncementPacket(localIp, mac) {
+  const msg = `^RFID_READER_INFORMATION:OpenRFID-Sim,IP:${localIp},MAC:${mac},PORT:${TCP_PORT},HOST_SERVER_IP:0.0.0.0,HOST_SERVER_PORT:0,MODE:SERVER,NET_STATE:CONNECTED$`;
+  return Buffer.from(msg, "ascii");
+}
+var HopelandDiscoveryPlugin = class {
+  udpSocket = null;
+  tcpServer = null;
+  announceTimer = null;
+  context = null;
+  getMetadata() {
+    return {
+      name: "hopeland-discovery",
+      version: "0.1.0",
+      description: `Hopeland/Identium UDP multicast device discovery announcer. Makes the simulator visible as a real RFID reader on the local network (multicast ${MULTICAST_GROUP}:${MULTICAST_PORT}, TCP ${TCP_PORT}).`
+    };
+  }
+  async initialize(context) {
+    this.context = context;
+  }
+  async start() {
+    const localIp = getLocalIpv4();
+    const fakeMac = buildFakeMac();
+    const packet = buildAnnouncementPacket(localIp, fakeMac);
+    this.context?.logger.info(
+      `[HopelandDiscovery] Local IP: ${localIp}  Fake MAC: ${fakeMac}`
+    );
+    this.udpSocket = dgram.createSocket({ type: "udp4", reuseAddr: true });
+    this.udpSocket.on("error", (err) => {
+      this.context?.logger.error("[HopelandDiscovery] UDP socket error", err);
+    });
+    await new Promise((resolve, reject) => {
+      this.udpSocket.bind(0, () => {
+        try {
+          this.udpSocket.setMulticastTTL(16);
+          this.udpSocket.setMulticastLoopback(true);
+          resolve();
+        } catch (e) {
+          reject(e);
+        }
+      });
+    });
+    const sendAnnouncement = () => {
+      this.udpSocket?.send(
+        packet,
+        0,
+        packet.length,
+        MULTICAST_PORT,
+        MULTICAST_GROUP,
+        (err) => {
+          if (err) this.context?.logger.error("[HopelandDiscovery] UDP send error", err);
+        }
+      );
+    };
+    sendAnnouncement();
+    this.announceTimer = setInterval(sendAnnouncement, ANNOUNCE_INTERVAL_MS);
+    this.context?.logger.info(
+      `[HopelandDiscovery] Announcing on UDP multicast ${MULTICAST_GROUP}:${MULTICAST_PORT} every ${ANNOUNCE_INTERVAL_MS}ms`
+    );
+    this.tcpServer = net.createServer((socket) => {
+      const remote = `${socket.remoteAddress}:${socket.remotePort}`;
+      this.context?.logger.info(`[HopelandDiscovery] TCP connection from ${remote}`);
+      socket.on("error", (err) => {
+        this.context?.logger.error(`[HopelandDiscovery] TCP socket error from ${remote}`, err);
+      });
+      socket.on("close", () => {
+        this.context?.logger.info(`[HopelandDiscovery] TCP connection closed: ${remote}`);
+      });
+      socket.on("data", (_data) => {
+      });
+    });
+    this.tcpServer.on("error", (err) => {
+      if (err.code === "EADDRINUSE") {
+        this.context?.logger.error(
+          `[HopelandDiscovery] TCP port ${TCP_PORT} already in use. Is another reader application running?`
+        );
+      } else {
+        this.context?.logger.error("[HopelandDiscovery] TCP server error", err);
+      }
+    });
+    await new Promise((resolve) => {
+      this.tcpServer.listen(TCP_PORT, "0.0.0.0", () => {
+        this.context?.logger.info(
+          `[HopelandDiscovery] TCP server listening on 0.0.0.0:${TCP_PORT} \u2014 middleware can now connect`
+        );
+        resolve();
+      });
+    });
+  }
+  async stop() {
+    if (this.announceTimer) {
+      clearInterval(this.announceTimer);
+      this.announceTimer = null;
+    }
+    if (this.udpSocket) {
+      this.udpSocket.close();
+      this.udpSocket = null;
+    }
+    await new Promise((resolve) => {
+      if (this.tcpServer) {
+        this.tcpServer.close(() => resolve());
+        this.tcpServer = null;
+      } else {
+        resolve();
+      }
+    });
+    this.context?.logger.info("[HopelandDiscovery] Stopped.");
+  }
+  async dispose() {
+    await this.stop();
+  }
+};
+export {
+  HopelandDiscoveryPlugin
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@openrfid/hopeland-discovery",
+  "version": "0.1.0",
+  "description": "Hopeland/Identium UDP multicast device discovery announcer for OpenRFID Simulator. Makes the simulator appear as a real Hopeland RFID reader on the local network.",
+  "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": {
+    "ws": "^8.16.0",
+    "@openrfid/plugin-api": "0.1.0",
+    "@openrfid/core": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.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"
+  }
+}