@openrfid/hopeland-discovery 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 +85 -0
- package/package.json +5 -4
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
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/hopeland-discovery`
|
|
6
|
+
|
|
7
|
+
### Hopeland / Identium UDP Multicast Discovery & TCP Command Server Protocol Plugin
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@openrfid/hopeland-discovery)
|
|
10
|
+
[](https://opensource.org/licenses/MIT)
|
|
11
|
+
[](https://rfidsoftwares.com)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🚀 Overview
|
|
18
|
+
|
|
19
|
+
`@openrfid/hopeland-discovery` is an industrial hardware protocol plugin for **OpenRFID Simulator**. It emulates **Hopeland** and **Identium** RFID reader communication protocols, including **UDP Multicast Auto-Discovery** (`230.1.1.116:9091`) and **TCP Binary Command Servers** (`port 9090`). It enables enterprise software built against official C# or Java Hopeland SDKs (`MyReaderAPI.dll`) to seamlessly discover and connect to virtual simulated readers.
|
|
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/hopeland-discovery
|
|
30
|
+
|
|
31
|
+
# pnpm
|
|
32
|
+
pnpm add @openrfid/hopeland-discovery
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 💻 Code Example
|
|
38
|
+
|
|
39
|
+
### 1. Register Plugin into OpenRFID Simulator Instance
|
|
40
|
+
```typescript
|
|
41
|
+
import { SimulationEngine } from '@openrfid/simulator';
|
|
42
|
+
import { HopelandDiscoveryPlugin } from '@openrfid/hopeland-discovery';
|
|
43
|
+
|
|
44
|
+
const engine = new SimulationEngine();
|
|
45
|
+
|
|
46
|
+
// Instantiate Hopeland discovery plugin (UDP 9091 + TCP 9090)
|
|
47
|
+
const hopelandPlugin = new HopelandDiscoveryPlugin({
|
|
48
|
+
multicastAddress: '230.1.1.116',
|
|
49
|
+
multicastPort: 9091,
|
|
50
|
+
commandPort: 9090,
|
|
51
|
+
readerMac: '00:0E:C6:8A:12:34',
|
|
52
|
+
readerIp: '192.168.1.100'
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
// Register plugin into simulation lifecycle
|
|
56
|
+
await engine.pluginManager.registerPlugin(hopelandPlugin);
|
|
57
|
+
await engine.start();
|
|
58
|
+
|
|
59
|
+
console.log('Hopeland Discovery Plugin active on UDP 230.1.1.116:9091 and TCP 9090');
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## 📡 Protocol Details
|
|
65
|
+
|
|
66
|
+
* **UDP Multicast Beacon**: Broadcasts periodic JSON payload on `230.1.1.116:9091` containing reader MAC, IP address, firmware version, and online status.
|
|
67
|
+
* **TCP Server Command Protocol**: Listens on `port 9090` for binary packet framing: `0xA0` (Header), Payload Length, Command Code, and Checksum validation.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 🌐 Monorepo Ecosystem
|
|
72
|
+
|
|
73
|
+
| Package | Description |
|
|
74
|
+
| :--- | :--- |
|
|
75
|
+
| [`@openrfid/plugin-api`](https://www.npmjs.com/package/@openrfid/plugin-api) | Plugin lifecycle interfaces & sandbox manager |
|
|
76
|
+
| [`@openrfid/simulator`](https://www.npmjs.com/package/@openrfid/simulator) | High-throughput inventory simulation engine |
|
|
77
|
+
| [`@openrfid/readers`](https://www.npmjs.com/package/@openrfid/readers) | Virtual reader hardware and antenna models |
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## 📄 License & Corporate Support
|
|
82
|
+
|
|
83
|
+
Licensed under the **MIT License**.
|
|
84
|
+
Brought to you by **RFID Software India Private Limited**.
|
|
85
|
+
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/hopeland-discovery",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"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.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -13,12 +13,13 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
17
18
|
],
|
|
18
19
|
"dependencies": {
|
|
19
20
|
"ws": "^8.16.0",
|
|
20
|
-
"@openrfid/
|
|
21
|
-
"@openrfid/
|
|
21
|
+
"@openrfid/core": "1.0.0",
|
|
22
|
+
"@openrfid/plugin-api": "1.0.0"
|
|
22
23
|
},
|
|
23
24
|
"devDependencies": {
|
|
24
25
|
"@types/node": "^20.11.0",
|