@openrfid/rest

Fastify REST API Plugin for OpenRFID Simulator

🚀 Overview

@openrfid/rest is the official Fastify HTTP REST API plugin for OpenRFID Simulator. It exposes RESTful endpoints (/api/v1/readers, /api/v1/tags, /api/v1/simulation, /api/v1/events) for programmatically starting/stopping simulations, managing virtual readers, and querying scan history.

Developed & Maintained by RFID Software India Private Limited.

📦 Installation

# npm
npm install @openrfid/rest

# pnpm
pnpm add @openrfid/rest

💻 Code Example

import { SimulationEngine } from '@openrfid/simulator';
import { RestPlugin } from '@openrfid/rest';

const engine = new SimulationEngine();

// Instantiate Fastify REST API plugin on port 3000
const restPlugin = new RestPlugin({
  port: 3000,
  host: '0.0.0.0',
  cors: true
});

await engine.pluginManager.registerPlugin(restPlugin);
await engine.start();

console.log('REST API server listening at http://localhost:3000/api/v1');

📡 REST API Endpoint Reference

| Method | Endpoint | Description | | :--- | :--- | :--- | | GET | /api/v1/health | System health check & memory usage | | GET | /api/v1/readers | List all configured virtual readers | | POST | /api/v1/readers | Create a new virtual reader instance | | GET | /api/v1/tags | Retrieve active tag inventory pool | | POST | /api/v1/simulation/start | Trigger simulation inventory loop | | POST | /api/v1/simulation/stop | Pause active inventory simulation | | GET | /api/v1/events/recent | Query recent tag scan events |

🌐 Monorepo Ecosystem

| Package | Description | | :--- | :--- | | @openrfid/plugin-api | Plugin lifecycle interfaces & sandbox manager | | @openrfid/simulator | High-throughput inventory simulation engine | | @openrfid/websocket | WebSocket real-time tag stream broadcaster |

📄 License & Corporate Support

Licensed under the MIT License.
Brought to you by RFID Software India Private Limited.
For enterprise RFID middleware, hardware drivers, or custom protocol plugins, visit rfidsoftwares.com.