@openrfid/readers 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +88 -0
- package/package.json +5 -4
package/README.md
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="https://raw.githubusercontent.com/rfidsoftwares/openrfid-simulator/main/assets/logo.svg" alt="OpenRFID Simulator Logo" width="180" />
|
|
4
|
+
|
|
5
|
+
# `@openrfid/readers`
|
|
6
|
+
|
|
7
|
+
### Virtual RFID Reader & Multi-Antenna Hardware Engine
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@openrfid/readers)
|
|
10
|
+
[](https://opensource.org/licenses/MIT)
|
|
11
|
+
[](https://rfidsoftwares.com)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🚀 Overview
|
|
18
|
+
|
|
19
|
+
`@openrfid/readers` models virtual RFID readers, multi-port antenna configurations (1 to 16 ports per reader), Tx Power tuning (0 to 30 dBm), Antenna Gain (dBi), and RSSI signal attenuation calculations for the **OpenRFID Simulator** ecosystem.
|
|
20
|
+
|
|
21
|
+
Developed & Maintained by **[RFID Software India Private Limited](https://rfidsoftwares.com)**.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 📦 Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# npm
|
|
29
|
+
npm install @openrfid/readers
|
|
30
|
+
|
|
31
|
+
# pnpm
|
|
32
|
+
pnpm add @openrfid/readers
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 💻 Code Example
|
|
38
|
+
|
|
39
|
+
### 1. Create and Configure Virtual Reader Hardware
|
|
40
|
+
```typescript
|
|
41
|
+
import { ReaderModel, ReaderStatus } from '@openrfid/readers';
|
|
42
|
+
|
|
43
|
+
// Instantiate 4-antenna warehouse gate reader
|
|
44
|
+
const reader = new ReaderModel({
|
|
45
|
+
id: 'READER-GATE-01',
|
|
46
|
+
name: 'North Warehouse Dock Gate',
|
|
47
|
+
ipAddress: '192.168.1.150',
|
|
48
|
+
commandPort: 9090,
|
|
49
|
+
antennas: [
|
|
50
|
+
{ portNumber: 1, enabled: true, powerDbm: 30, gainDbi: 6.0 },
|
|
51
|
+
{ portNumber: 2, enabled: true, powerDbm: 30, gainDbi: 6.0 },
|
|
52
|
+
{ portNumber: 3, enabled: true, powerDbm: 27, gainDbi: 6.0 },
|
|
53
|
+
{ portNumber: 4, enabled: false, powerDbm: 0, gainDbi: 0 }
|
|
54
|
+
]
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
console.log('Reader Status:', reader.status); // ReaderStatus.OFFLINE
|
|
58
|
+
reader.startInventory();
|
|
59
|
+
console.log('Reader Status:', reader.status); // ReaderStatus.INVENTORYING
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## 📚 API Reference
|
|
65
|
+
|
|
66
|
+
| Export | Type | Description |
|
|
67
|
+
| :--- | :--- | :--- |
|
|
68
|
+
| `ReaderModel` | Class | Manages virtual reader hardware state, antenna ports, and IP bindings |
|
|
69
|
+
| `ReaderStatus` | Enum | Reader states (`OFFLINE`, `ONLINE`, `INVENTORYING`, `FAULT`) |
|
|
70
|
+
| `AntennaPortConfig` | Interface | Antenna configuration attributes (port, power, gain, RSSI offset) |
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 🌐 Monorepo Ecosystem
|
|
75
|
+
|
|
76
|
+
| Package | Description |
|
|
77
|
+
| :--- | :--- |
|
|
78
|
+
| [`@openrfid/simulator`](https://www.npmjs.com/package/@openrfid/simulator) | High-throughput inventory simulation engine |
|
|
79
|
+
| [`@openrfid/tags`](https://www.npmjs.com/package/@openrfid/tags) | RFID tag domain models & memory generator |
|
|
80
|
+
| [`@openrfid/core`](https://www.npmjs.com/package/@openrfid/core) | Core EventBus, Config, & SQLite persistence |
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## 📄 License & Corporate Support
|
|
85
|
+
|
|
86
|
+
Licensed under the **MIT License**.
|
|
87
|
+
Brought to you by **RFID Software India Private Limited**.
|
|
88
|
+
For enterprise RFID middleware, hardware drivers, or custom protocol plugins, visit **[rfidsoftwares.com](https://rfidsoftwares.com)**.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openrfid/readers",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Virtual Reader and Antenna Engine domain models with state machine support for OpenRFID Simulator.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -13,11 +13,12 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
17
18
|
],
|
|
18
19
|
"dependencies": {
|
|
19
|
-
"@openrfid/core": "
|
|
20
|
-
"@openrfid/utils": "
|
|
20
|
+
"@openrfid/core": "1.0.0",
|
|
21
|
+
"@openrfid/utils": "1.0.0"
|
|
21
22
|
},
|
|
22
23
|
"devDependencies": {
|
|
23
24
|
"tsup": "^8.0.2",
|