@openrfid/readers 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,103 @@
+/**
+ * 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
+ */
+interface AntennaProps {
+    id?: string;
+    readerId: string;
+    index: number;
+    gain?: number;
+    power?: number;
+    frequency?: number;
+    rssiOffset?: number;
+    readZone?: string;
+    enabled?: boolean;
+}
+declare class Antenna {
+    id: string;
+    readerId: string;
+    index: number;
+    gain: number;
+    power: number;
+    frequency: number;
+    rssiOffset: number;
+    readZone: string;
+    enabled: boolean;
+    constructor(props: AntennaProps);
+    toJSON(): AntennaProps;
+}
+
+/**
+ * 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
+ */
+
+type ReaderStatus = 'OFFLINE' | 'ONLINE' | 'CONNECTING' | 'ERROR';
+interface ReaderProps {
+    id?: string;
+    name: string;
+    vendor?: string;
+    model?: string;
+    ip?: string;
+    port?: number;
+    protocol?: string;
+    antennasCount?: number;
+    readRate?: number;
+    readMode?: 'continuous' | 'periodic';
+    readIntervalValue?: number;
+    readIntervalUnit?: 'seconds' | 'minutes' | 'hours';
+    epcFilterStart?: string;
+    epcFilterEnd?: string;
+    epcFilterPrefix?: string;
+}
+declare class VirtualReader {
+    id: string;
+    name: string;
+    vendor: string;
+    model: string;
+    ip: string;
+    port: number;
+    protocol: string;
+    status: ReaderStatus;
+    antennas: Map<number, Antenna>;
+    createdAt: string;
+    readRate: number;
+    readMode: 'continuous' | 'periodic';
+    readIntervalValue: number;
+    readIntervalUnit: 'seconds' | 'minutes' | 'hours';
+    epcFilterStart: string;
+    epcFilterEnd: string;
+    epcFilterPrefix: string;
+    constructor(props: ReaderProps);
+    setStatus(status: ReaderStatus): void;
+    getAntenna(index: number): Antenna | undefined;
+    getActiveAntennas(): Antenna[];
+    addAntenna(props: Partial<AntennaProps>): Antenna;
+    toJSON(): {
+        id: string;
+        name: string;
+        vendor: string;
+        model: string;
+        ip: string;
+        port: number;
+        protocol: string;
+        status: ReaderStatus;
+        createdAt: string;
+        antennas: AntennaProps[];
+        readRate: number;
+        readMode: "continuous" | "periodic";
+        readIntervalValue: number;
+        readIntervalUnit: "seconds" | "minutes" | "hours";
+        epcFilterStart: string;
+        epcFilterEnd: string;
+        epcFilterPrefix: string;
+    };
+}
+
+export { Antenna, type AntennaProps, type ReaderProps, type ReaderStatus, VirtualReader };

package/dist/index.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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
+ */
+interface AntennaProps {
+    id?: string;
+    readerId: string;
+    index: number;
+    gain?: number;
+    power?: number;
+    frequency?: number;
+    rssiOffset?: number;
+    readZone?: string;
+    enabled?: boolean;
+}
+declare class Antenna {
+    id: string;
+    readerId: string;
+    index: number;
+    gain: number;
+    power: number;
+    frequency: number;
+    rssiOffset: number;
+    readZone: string;
+    enabled: boolean;
+    constructor(props: AntennaProps);
+    toJSON(): AntennaProps;
+}
+
+/**
+ * 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
+ */
+
+type ReaderStatus = 'OFFLINE' | 'ONLINE' | 'CONNECTING' | 'ERROR';
+interface ReaderProps {
+    id?: string;
+    name: string;
+    vendor?: string;
+    model?: string;
+    ip?: string;
+    port?: number;
+    protocol?: string;
+    antennasCount?: number;
+    readRate?: number;
+    readMode?: 'continuous' | 'periodic';
+    readIntervalValue?: number;
+    readIntervalUnit?: 'seconds' | 'minutes' | 'hours';
+    epcFilterStart?: string;
+    epcFilterEnd?: string;
+    epcFilterPrefix?: string;
+}
+declare class VirtualReader {
+    id: string;
+    name: string;
+    vendor: string;
+    model: string;
+    ip: string;
+    port: number;
+    protocol: string;
+    status: ReaderStatus;
+    antennas: Map<number, Antenna>;
+    createdAt: string;
+    readRate: number;
+    readMode: 'continuous' | 'periodic';
+    readIntervalValue: number;
+    readIntervalUnit: 'seconds' | 'minutes' | 'hours';
+    epcFilterStart: string;
+    epcFilterEnd: string;
+    epcFilterPrefix: string;
+    constructor(props: ReaderProps);
+    setStatus(status: ReaderStatus): void;
+    getAntenna(index: number): Antenna | undefined;
+    getActiveAntennas(): Antenna[];
+    addAntenna(props: Partial<AntennaProps>): Antenna;
+    toJSON(): {
+        id: string;
+        name: string;
+        vendor: string;
+        model: string;
+        ip: string;
+        port: number;
+        protocol: string;
+        status: ReaderStatus;
+        createdAt: string;
+        antennas: AntennaProps[];
+        readRate: number;
+        readMode: "continuous" | "periodic";
+        readIntervalValue: number;
+        readIntervalUnit: "seconds" | "minutes" | "hours";
+        epcFilterStart: string;
+        epcFilterEnd: string;
+        epcFilterPrefix: string;
+    };
+}
+
+export { Antenna, type AntennaProps, type ReaderProps, type ReaderStatus, VirtualReader };

package/dist/index.js

@@ -0,0 +1,149 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Antenna: () => Antenna,
+  VirtualReader: () => VirtualReader
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/antenna.ts
+var Antenna = class {
+  id;
+  readerId;
+  index;
+  gain;
+  power;
+  frequency;
+  rssiOffset;
+  readZone;
+  enabled;
+  constructor(props) {
+    if (props.index < 1 || props.index > 16) {
+      throw new Error(`Antenna index must be between 1 and 16 (got ${props.index})`);
+    }
+    this.readerId = props.readerId;
+    this.index = props.index;
+    this.id = props.id || `${props.readerId}_ant_${props.index}`;
+    this.gain = props.gain ?? 6;
+    this.power = props.power ?? 30;
+    this.frequency = props.frequency ?? 915;
+    this.rssiOffset = props.rssiOffset ?? 0;
+    this.readZone = props.readZone || "DefaultZone";
+    this.enabled = props.enabled ?? true;
+  }
+  toJSON() {
+    return {
+      id: this.id,
+      readerId: this.readerId,
+      index: this.index,
+      gain: this.gain,
+      power: this.power,
+      frequency: this.frequency,
+      rssiOffset: this.rssiOffset,
+      readZone: this.readZone,
+      enabled: this.enabled
+    };
+  }
+};
+
+// src/reader.ts
+var VirtualReader = class {
+  id;
+  name;
+  vendor;
+  model;
+  ip;
+  port;
+  protocol;
+  status = "OFFLINE";
+  antennas = /* @__PURE__ */ new Map();
+  createdAt;
+  readRate;
+  readMode;
+  readIntervalValue;
+  readIntervalUnit;
+  epcFilterStart;
+  epcFilterEnd;
+  epcFilterPrefix;
+  constructor(props) {
+    this.name = props.name;
+    this.id = props.id || `reader_${Date.now()}_${Math.floor(Math.random() * 1e3)}`;
+    this.vendor = props.vendor || "Generic";
+    this.model = props.model || "Simulated Reader v1";
+    this.ip = props.ip || "127.0.0.1";
+    this.port = props.port || 5084;
+    this.protocol = props.protocol || "LLRP";
+    this.createdAt = (/* @__PURE__ */ new Date()).toISOString();
+    this.readRate = props.readRate ?? 0;
+    this.readMode = props.readMode || "continuous";
+    this.readIntervalValue = props.readIntervalValue ?? 1;
+    this.readIntervalUnit = props.readIntervalUnit || "seconds";
+    this.epcFilterStart = props.epcFilterStart || "";
+    this.epcFilterEnd = props.epcFilterEnd || "";
+    this.epcFilterPrefix = props.epcFilterPrefix || "";
+    const count = props.antennasCount || 4;
+    for (let i = 1; i <= count; i++) {
+      this.antennas.set(i, new Antenna({ readerId: this.id, index: i }));
+    }
+  }
+  setStatus(status) {
+    this.status = status;
+  }
+  getAntenna(index) {
+    return this.antennas.get(index);
+  }
+  getActiveAntennas() {
+    return Array.from(this.antennas.values()).filter((ant) => ant.enabled);
+  }
+  addAntenna(props) {
+    const nextIndex = props.index || this.antennas.size + 1;
+    const antenna = new Antenna({ ...props, readerId: this.id, index: nextIndex });
+    this.antennas.set(nextIndex, antenna);
+    return antenna;
+  }
+  toJSON() {
+    return {
+      id: this.id,
+      name: this.name,
+      vendor: this.vendor,
+      model: this.model,
+      ip: this.ip,
+      port: this.port,
+      protocol: this.protocol,
+      status: this.status,
+      createdAt: this.createdAt,
+      antennas: Array.from(this.antennas.values()).map((a) => a.toJSON()),
+      readRate: this.readRate,
+      readMode: this.readMode,
+      readIntervalValue: this.readIntervalValue,
+      readIntervalUnit: this.readIntervalUnit,
+      epcFilterStart: this.epcFilterStart,
+      epcFilterEnd: this.epcFilterEnd,
+      epcFilterPrefix: this.epcFilterPrefix
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Antenna,
+  VirtualReader
+});

package/dist/index.mjs

@@ -0,0 +1,121 @@
+// src/antenna.ts
+var Antenna = class {
+  id;
+  readerId;
+  index;
+  gain;
+  power;
+  frequency;
+  rssiOffset;
+  readZone;
+  enabled;
+  constructor(props) {
+    if (props.index < 1 || props.index > 16) {
+      throw new Error(`Antenna index must be between 1 and 16 (got ${props.index})`);
+    }
+    this.readerId = props.readerId;
+    this.index = props.index;
+    this.id = props.id || `${props.readerId}_ant_${props.index}`;
+    this.gain = props.gain ?? 6;
+    this.power = props.power ?? 30;
+    this.frequency = props.frequency ?? 915;
+    this.rssiOffset = props.rssiOffset ?? 0;
+    this.readZone = props.readZone || "DefaultZone";
+    this.enabled = props.enabled ?? true;
+  }
+  toJSON() {
+    return {
+      id: this.id,
+      readerId: this.readerId,
+      index: this.index,
+      gain: this.gain,
+      power: this.power,
+      frequency: this.frequency,
+      rssiOffset: this.rssiOffset,
+      readZone: this.readZone,
+      enabled: this.enabled
+    };
+  }
+};
+
+// src/reader.ts
+var VirtualReader = class {
+  id;
+  name;
+  vendor;
+  model;
+  ip;
+  port;
+  protocol;
+  status = "OFFLINE";
+  antennas = /* @__PURE__ */ new Map();
+  createdAt;
+  readRate;
+  readMode;
+  readIntervalValue;
+  readIntervalUnit;
+  epcFilterStart;
+  epcFilterEnd;
+  epcFilterPrefix;
+  constructor(props) {
+    this.name = props.name;
+    this.id = props.id || `reader_${Date.now()}_${Math.floor(Math.random() * 1e3)}`;
+    this.vendor = props.vendor || "Generic";
+    this.model = props.model || "Simulated Reader v1";
+    this.ip = props.ip || "127.0.0.1";
+    this.port = props.port || 5084;
+    this.protocol = props.protocol || "LLRP";
+    this.createdAt = (/* @__PURE__ */ new Date()).toISOString();
+    this.readRate = props.readRate ?? 0;
+    this.readMode = props.readMode || "continuous";
+    this.readIntervalValue = props.readIntervalValue ?? 1;
+    this.readIntervalUnit = props.readIntervalUnit || "seconds";
+    this.epcFilterStart = props.epcFilterStart || "";
+    this.epcFilterEnd = props.epcFilterEnd || "";
+    this.epcFilterPrefix = props.epcFilterPrefix || "";
+    const count = props.antennasCount || 4;
+    for (let i = 1; i <= count; i++) {
+      this.antennas.set(i, new Antenna({ readerId: this.id, index: i }));
+    }
+  }
+  setStatus(status) {
+    this.status = status;
+  }
+  getAntenna(index) {
+    return this.antennas.get(index);
+  }
+  getActiveAntennas() {
+    return Array.from(this.antennas.values()).filter((ant) => ant.enabled);
+  }
+  addAntenna(props) {
+    const nextIndex = props.index || this.antennas.size + 1;
+    const antenna = new Antenna({ ...props, readerId: this.id, index: nextIndex });
+    this.antennas.set(nextIndex, antenna);
+    return antenna;
+  }
+  toJSON() {
+    return {
+      id: this.id,
+      name: this.name,
+      vendor: this.vendor,
+      model: this.model,
+      ip: this.ip,
+      port: this.port,
+      protocol: this.protocol,
+      status: this.status,
+      createdAt: this.createdAt,
+      antennas: Array.from(this.antennas.values()).map((a) => a.toJSON()),
+      readRate: this.readRate,
+      readMode: this.readMode,
+      readIntervalValue: this.readIntervalValue,
+      readIntervalUnit: this.readIntervalUnit,
+      epcFilterStart: this.epcFilterStart,
+      epcFilterEnd: this.epcFilterEnd,
+      epcFilterPrefix: this.epcFilterPrefix
+    };
+  }
+};
+export {
+  Antenna,
+  VirtualReader
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@openrfid/readers",
+  "version": "0.1.0",
+  "description": "Virtual Reader and Antenna Engine domain models with state machine support 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": {
+    "@openrfid/core": "0.1.0",
+    "@openrfid/utils": "0.1.0"
+  },
+  "devDependencies": {
+    "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"
+  }
+}