miravo 0.8.1 → 0.10.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.
Files changed (2) hide show
  1. package/README.md +73 -15
  2. package/package.json +9 -9
package/README.md CHANGED
@@ -2,45 +2,103 @@
2
2
  <img src="https://miravo.dev/miravo-logo.webp" alt="Miravo" width="120" />
3
3
  </p>
4
4
 
5
- <p align="center">Industrial environments as code.</p>
5
+ <p align="center"><strong>A simulated factory your software can connect to.</strong></p>
6
6
 
7
- <p align="center"><strong>Miravo</strong> is an open-source industrial modeling and simulation platform. Describe the plant once. Miravo runs it with real topology, lifecycle wear, and cascading faults — and speaks MQTT, OPC UA, and Modbus TCP at the same time, the way a real plant does.</p>
7
+ <p align="center"><strong>Miravo</strong> (pronounced <code>mih-RAH-voh</code>) is an open-source factory simulator that generates realistic industrial data for whatever you're building.</p>
8
8
 
9
9
  <p align="center">
10
- <img src="https://miravo.dev/console-screenshot-2026-05-02.png" alt="Miravo Console" width="80%" />
10
+ <img src="https://miravo.dev/console-screenshot-2026-10-04.png" alt="Miravo Console" width="80%" />
11
11
  </p>
12
12
 
13
13
  ---
14
14
 
15
- ## Quickstart
15
+ Build and test software on industrial data against equipment that runs, wears and fails on demand.
16
+
17
+ Software that runs on industrial data gets built against fake data. Real equipment is off-limits, failures can't be triggered on demand, and wear takes months to show up. So teams test against random tags and homemade scripts, and find the problems in production.
18
+
19
+ ## What Miravo does
20
+
21
+ 1. Define your factory in YAML. Start from a template, write your own, or have your agent build it.
22
+ 2. Test beyond normal operation. Model equipment cycles, wear and part flow through production lines. Accelerate time and trigger faults that affect other assets.
23
+ 3. Test across industrial protocols. Read the same live values through OPC UA, Modbus TCP and MQTT, with more to come.
24
+ 4. Run it the same way every time. Seeded, repeatable runs for CI, demos and load tests.
25
+
26
+ ## Who it's for
27
+
28
+ Miravo is for anyone building software on industrial data: dashboards, historians, MES and OEE apps, UNS pipelines, SCADA and BMS integrations, edge and analytics platforms, predictive maintenance. Also demos, CI tests and load tests.
16
29
 
17
- Install Miravo on Linux/macOS.
30
+ ## What it's not
31
+
32
+ - Not for PLC logic testing, virtual commissioning, 3D visualization or throughput/layout optimization.
33
+ - Not physics-grade.
34
+ - No PackML.
35
+ - MQTT payloads are custom JSON, not Sparkplug B.
36
+
37
+ ## Built-in templates
38
+
39
+ - [Smart Factory (production line)](https://miravo.dev/docs/templates/smart-factory)
40
+ - [Water Treatment Plant](https://miravo.dev/docs/templates/water-treatment)
41
+ - [Commercial Building](https://miravo.dev/docs/templates/commercial-building)
42
+ - [Backup Power Facility](https://miravo.dev/docs/templates/backup-power)
43
+ - [District Heating](https://miravo.dev/docs/templates/district-heating)
44
+ - [Pharma Cleanroom](https://miravo.dev/docs/templates/pharma-cleanroom)
45
+
46
+ ## Install
47
+
48
+ Install Miravo on Linux/macOS with the install script.
18
49
 
19
50
  ```shell
20
51
  curl -fsSL https://miravo.dev/install | bash
21
52
  ```
22
53
 
54
+ Or install from npm on Linux, macOS, or Windows (x64).
55
+
23
56
  ```shell
24
57
  npm install -g miravo
25
58
  ```
26
59
 
27
- Use Node.js >= 18.
60
+ The npm package requires Node.js 18 or later. The install script and the standalone binaries do not need Node.js.
28
61
 
29
- [Full install options: Docker, Windows guidance, and standalone binaries.](https://miravo.dev/docs#1-install-miravo)
62
+ [Full install options: Docker, Windows, and standalone binaries.](https://miravo.dev/docs#1-install-miravo)
30
63
 
31
- Get started with the [`Smart Factory`](https://miravo.dev/docs/environments/smart-factory) environment — the Console opens at `http://127.0.0.1:8080`.
64
+ ## Quickstart
65
+
66
+ Start the built-in Smart Factory machining line (CNC → wash → press → test) at 10× speed:
67
+
68
+ ```shell
69
+ miravo start --template smart-factory --speed 10
70
+ ```
71
+
72
+ The [Console](https://miravo.dev/docs/console) is served at `http://127.0.0.1:8080`. Point your software at the same data:
73
+
74
+ | Protocol | Endpoint |
75
+ |---|---|
76
+ | OPC UA | `opc.tcp://127.0.0.1:4840` |
77
+ | MQTT | `mqtt://127.0.0.1:1883`, topics under `MiravoWorks/smart-factory/#` |
78
+ | Modbus TCP | `127.0.0.1:1502`, holding registers |
79
+
80
+ Each station publishes `state`, `good_count`, `scrap_count`, cycle times and time spent per state. In a second terminal, inject a stuck valve on the press and watch the line react:
32
81
 
33
82
  ```shell
34
- miravo start
83
+ miravo inject press-001 valve_stuck
84
+ miravo status --watch
35
85
  ```
36
86
 
87
+ The press stops. The wash station blocks as its buffer fills, the test station starves, and every station's counters and state times keep the record your OEE logic needs.
88
+
89
+ All listeners (Console, MQTT, OPC UA, Modbus) bind `127.0.0.1` by default. Protocol endpoints have no authentication. See [Security](https://miravo.dev/docs/cli/security) before exposing them.
90
+
91
+ ### Privacy
92
+
93
+ No telemetry. The CLI checks GitHub Releases for a newer version at most once per 24 hours in interactive terminals. Disable with `MIRAVO_NO_UPDATE_CHECK=1`.
94
+
37
95
  ## Docs
38
96
 
39
- - [**Documentation**](https://miravo.dev/docs)
40
- - [**Core concepts**](https://miravo.dev/docs/core/concepts)
41
- - [**Twin models**](https://miravo.dev/docs/core/twin-models)
42
- - [**CLI reference**](https://miravo.dev/docs/cli/reference)
43
- - [**Protocols**](https://miravo.dev/docs/protocols) — MQTT, OPC UA, Modbus TCP
44
- - [**Platforms**](https://miravo.dev/docs/platforms) — Litmus Edge today; Ignition, AWS IoT, Azure IoT in the works
97
+ - [Documentation](https://miravo.dev/docs)
98
+ - [Core concepts](https://miravo.dev/docs/core/concepts)
99
+ - [Asset models](https://miravo.dev/docs/core/asset-models)
100
+ - [CLI reference](https://miravo.dev/docs/cli/reference)
101
+ - [Protocols](https://miravo.dev/docs/protocols): MQTT, OPC UA, Modbus TCP
102
+ - [Integrations](https://miravo.dev/docs/integrations): Litmus Edge today, with Ignition, AWS IoT SiteWise, and Azure IoT coming
45
103
 
46
104
  This repository is licensed under the [Apache-2.0 License](LICENSE).
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "miravo",
3
- "version": "0.8.1",
4
- "description": "Industrial environment platform — Node launcher that runs the platform-specific Miravo binary.",
3
+ "version": "0.10.0",
4
+ "description": "Open-source factory simulator that generates realistic industrial data for whatever you're building. Node launcher for the Miravo binary.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
7
7
  "type": "git",
@@ -20,13 +20,13 @@
20
20
  "node": ">=18"
21
21
  },
22
22
  "optionalDependencies": {
23
- "@miravo/cli-linux-x64": "0.8.1",
24
- "@miravo/cli-linux-arm64": "0.8.1",
25
- "@miravo/cli-linux-x64-musl": "0.8.1",
26
- "@miravo/cli-linux-arm64-musl": "0.8.1",
27
- "@miravo/cli-darwin-x64": "0.8.1",
28
- "@miravo/cli-darwin-arm64": "0.8.1",
29
- "@miravo/cli-windows-x64": "0.8.1"
23
+ "@miravo/cli-linux-x64": "0.10.0",
24
+ "@miravo/cli-linux-arm64": "0.10.0",
25
+ "@miravo/cli-linux-x64-musl": "0.10.0",
26
+ "@miravo/cli-linux-arm64-musl": "0.10.0",
27
+ "@miravo/cli-darwin-x64": "0.10.0",
28
+ "@miravo/cli-darwin-arm64": "0.10.0",
29
+ "@miravo/cli-windows-x64": "0.10.0"
30
30
  },
31
31
  "exports": {
32
32
  "./package.json": "./package.json"