@litmusio/miravo 0.0.0-stage → 0.15.10
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/LICENSE +199 -0
- package/NOTICE +9 -0
- package/README.md +143 -2
- package/THIRD_PARTY_LICENSES.txt +15289 -0
- package/THIRD_PARTY_NOTICES.md +995 -0
- package/bin/miravo.js +85 -0
- package/install.ps1 +230 -0
- package/install.sh +759 -0
- package/licenses/EPL-2.0.txt +80 -0
- package/licenses/GCC-exception-3.1.txt +33 -0
- package/licenses/GPL-2.0-only.txt +117 -0
- package/licenses/GPL-3.0-only.txt +232 -0
- package/licenses/LGPL-2.1-only.txt +176 -0
- package/licenses/MPL-2.0.txt +373 -0
- package/licenses/OFL-1.1.txt +93 -0
- package/licenses/overrides/@headlessui+vue@1.7.23.txt +24 -0
- package/licenses/overrides/@next+env@16.4.6.txt +24 -0
- package/licenses/overrides/@radix-ui+react-compose-refs@1.1.2.txt +24 -0
- package/licenses/overrides/@radix-ui+react-context@1.1.2.txt +24 -0
- package/licenses/overrides/@radix-ui+react-direction@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+react-id@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+react-use-callback-ref@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+react-use-escape-keydown@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+react-use-layout-effect@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+react-use-rect@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+react-use-size@1.1.1.txt +24 -0
- package/licenses/overrides/@radix-ui+rect@1.1.1.txt +24 -0
- package/licenses/overrides/@replit+codemirror-css-color-picker@6.3.0.txt +6 -0
- package/licenses/overrides/@scalar+openapi-types@0.8.0.txt +24 -0
- package/licenses/overrides/@scalar+openapi-types@0.9.10.txt +24 -0
- package/licenses/overrides/@scalar+openapi-types@0.9.7.txt +24 -0
- package/licenses/overrides/@scalar+openapi-types@0.9.9.txt +24 -0
- package/licenses/overrides/@scalar+postman-to-openapi@0.7.1.txt +24 -0
- package/licenses/overrides/@scalar+schemas@0.19.0.txt +24 -0
- package/licenses/overrides/@scalar+workspace-store@0.46.3.txt +24 -0
- package/licenses/overrides/@scalar+workspace-store@0.75.0.txt +24 -0
- package/licenses/overrides/assert-plus@1.0.0.txt +24 -0
- package/licenses/overrides/client-only@0.0.1.txt +24 -0
- package/licenses/overrides/embla-carousel-react@8.6.0.txt +24 -0
- package/licenses/overrides/embla-carousel-reactive-utils@8.6.0.txt +24 -0
- package/licenses/overrides/embla-carousel@8.6.0.txt +24 -0
- package/licenses/overrides/fastdom@1.0.12.txt +12 -0
- package/licenses/overrides/precond@0.2.3.txt +22 -0
- package/licenses/overrides/react-remove-scroll-bar@2.3.8.txt +24 -0
- package/licenses/overrides/strictdom@1.0.1.txt +12 -0
- package/licenses/overrides/victory-vendor@36.9.2.txt +33 -0
- package/licenses/runtime/Bun-1.4.3-LICENSE.md +85 -0
- package/licenses/runtime/ICU-78.1-LICENSE.txt +568 -0
- package/licenses/runtime/bun-components/boringssl.txt +238 -0
- package/licenses/runtime/bun-components/brotli.txt +19 -0
- package/licenses/runtime/bun-components/c-ares.txt +24 -0
- package/licenses/runtime/bun-components/highway.txt +371 -0
- package/licenses/runtime/bun-components/libarchive.txt +65 -0
- package/licenses/runtime/bun-components/libbase64.txt +28 -0
- package/licenses/runtime/bun-components/libdeflate.txt +22 -0
- package/licenses/runtime/bun-components/libjpeg-turbo.txt +147 -0
- package/licenses/runtime/bun-components/libspng.txt +25 -0
- package/licenses/runtime/bun-components/libuv.txt +19 -0
- package/licenses/runtime/bun-components/libwebp.txt +30 -0
- package/licenses/runtime/bun-components/llvm.txt +311 -0
- package/licenses/runtime/bun-components/lol-html.txt +27 -0
- package/licenses/runtime/bun-components/ls-hpack.txt +21 -0
- package/licenses/runtime/bun-components/ls-qpack.txt +21 -0
- package/licenses/runtime/bun-components/lsquic-chrome.txt +32 -0
- package/licenses/runtime/bun-components/lsquic.txt +21 -0
- package/licenses/runtime/bun-components/mimalloc.txt +21 -0
- package/licenses/runtime/bun-components/picohttpparser.txt +24 -0
- package/licenses/runtime/bun-components/simdutf-apache.txt +201 -0
- package/licenses/runtime/bun-components/simdutf-mit.txt +18 -0
- package/licenses/runtime/bun-components/tigerbeetle.txt +177 -0
- package/licenses/runtime/bun-components/tinycc.txt +504 -0
- package/licenses/runtime/bun-components/typescript-go.txt +55 -0
- package/licenses/runtime/bun-components/usockets.txt +201 -0
- package/licenses/runtime/bun-components/uucode.txt +30 -0
- package/licenses/runtime/bun-components/uwebsockets.txt +201 -0
- package/licenses/runtime/bun-components/xxhash.txt +31 -0
- package/licenses/runtime/bun-components/zlib-ng.txt +19 -0
- package/licenses/runtime/bun-components/zstd-copying.txt +339 -0
- package/licenses/runtime/bun-components/zstd.txt +30 -0
- package/licenses/runtime/musl-1.2.6-COPYRIGHT.txt +193 -0
- package/package.json +64 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding any notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. Please also get an
|
|
185
|
+
information on the current year at http://www.apache.org/licenses/
|
|
186
|
+
|
|
187
|
+
Copyright 2026 The Miravo Authors
|
|
188
|
+
|
|
189
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
190
|
+
you may not use this file except in compliance with the License.
|
|
191
|
+
You may obtain a copy of the License at
|
|
192
|
+
|
|
193
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
194
|
+
|
|
195
|
+
Unless required by applicable law or agreed to in writing, software
|
|
196
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
197
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
198
|
+
See the License for the specific language governing permissions and
|
|
199
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
Miravo
|
|
2
|
+
Copyright 2026 The Miravo Authors
|
|
3
|
+
|
|
4
|
+
Created by Amine Amaach (https://www.linkedin.com/in/amine-amaach).
|
|
5
|
+
|
|
6
|
+
This product includes third-party software and assets; see THIRD_PARTY_NOTICES.md and THIRD_PARTY_LICENSES.txt,
|
|
7
|
+
which ship with every release.
|
|
8
|
+
|
|
9
|
+
"Litmus" and the Litmus logos are trademarks of Litmus Automation and are not licensed under Apache-2.0.
|
package/README.md
CHANGED
|
@@ -1,3 +1,144 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://miravo.litmus.dev/miravo-logo.webp" alt="Miravo" width="120" />
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<p align="center"><strong>A simulated factory your software can connect to.</strong></p>
|
|
6
|
+
|
|
7
|
+
<p align="center"><strong>Miravo</strong> (pronounced <code>mih-RAH-voh</code>) is an open-source factory simulator. Tell your agent the plant you need and it builds it, runs it and hands you the endpoints. Then break a machine and watch your software react.</p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<img src="https://miravo.litmus.dev/console-screenshot-2026-10-04.png" alt="Miravo Console" width="80%" />
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Get started
|
|
16
|
+
|
|
17
|
+
Paste this into Claude Code, Codex or any agent that loads Agent Skills:
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
Set me up with Miravo. Fetch https://miravo.litmus.dev/agent-setup.md and follow it.
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Your agent installs Miravo and its skill, then asks how it can help. It offers four places to start, tailored to the project you have open: break a live production line, simulate the plant you run, run it through Litmus Edge, or feed your own software. Pick one, or say what you want in the same prompt. You get the Console link and every endpoint.
|
|
24
|
+
|
|
25
|
+
### Or install it yourself
|
|
26
|
+
|
|
27
|
+
macOS and Linux:
|
|
28
|
+
|
|
29
|
+
```shell
|
|
30
|
+
curl -fsSL https://miravo.litmus.dev/install | bash
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Windows (x64), in PowerShell:
|
|
34
|
+
|
|
35
|
+
```powershell
|
|
36
|
+
irm https://miravo.litmus.dev/install.ps1 | iex
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Then open a new terminal and start your first factory:
|
|
40
|
+
|
|
41
|
+
```shell
|
|
42
|
+
miravo start -t smart-factory
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
npm, on any of those platforms with Node.js 18 or later:
|
|
46
|
+
|
|
47
|
+
```shell
|
|
48
|
+
npm install -g @litmusio/miravo
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Docker:
|
|
52
|
+
|
|
53
|
+
```shell
|
|
54
|
+
docker run --rm -p 127.0.0.1:8080:8080 -p 127.0.0.1:1883:1883 -p 127.0.0.1:4840:4840 -p 127.0.0.1:1502:1502 ghcr.io/litmusautomation/miravo:latest
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The Console is served at `http://127.0.0.1:8080`. The install scripts and the standalone binaries need neither Node.js nor Docker. [All install options](https://miravo.litmus.dev/docs#install-miravo-yourself)
|
|
58
|
+
|
|
59
|
+
Miravo sends no telemetry. In an interactive terminal, the CLI checks the npm registry for a newer version at most once every 24 hours; `MIRAVO_NO_UPDATE_CHECK=1` turns that off.
|
|
60
|
+
|
|
61
|
+
## Use it with your agent
|
|
62
|
+
|
|
63
|
+
The [Miravo skill](https://miravo.litmus.dev/docs/agents) lets your agent build the plant, run it, break machines when you ask, check every endpoint and hand you the connection details. The setup prompt installs it. To add it yourself, run:
|
|
64
|
+
|
|
65
|
+
```shell
|
|
66
|
+
npx skills add litmusautomation/miravo --skill miravo
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The skill drives the `miravo` CLI, so [install Miravo](https://miravo.litmus.dev/docs#install-miravo-yourself) first. Then ask in plain language:
|
|
70
|
+
|
|
71
|
+
- "Build me a cold-storage warehouse with ammonia compressors, evaporators and dock doors. Serve it on Modbus and draw it live."
|
|
72
|
+
- "Start the smart factory on MQTT, jam the press valve and show me everything that broke downstream."
|
|
73
|
+
- "Run the commercial building at 100x until a supply fan bearing fails, then tell me which value warned first."
|
|
74
|
+
|
|
75
|
+
## What you can do
|
|
76
|
+
|
|
77
|
+
- Start from one of six [built-in templates](https://miravo.litmus.dev/docs/templates) (smart factory, water treatment, commercial building, backup power, district heating, pharma cleanroom), or have your agent build the plant you describe from 19 built-in asset models and the new ones it writes.
|
|
78
|
+
- Break it on purpose. Inject a fault and watch it reach the machines around it, or run the clock faster to see months of wear in an afternoon.
|
|
79
|
+
- Connect over OPC UA, Modbus TCP, Siemens S7, MQTT and Sparkplug B to the same running factory, and watch each built-in factory run on a live floor in the Console.
|
|
80
|
+
- Repeat a run. A fresh run with the same Miravo build, models, template, seed, speed and tick gives the same values, for CI, demos and load tests.
|
|
81
|
+
- Connect [Litmus Edge](https://miravo.litmus.dev/docs/integrations/litmus-edge). It is a built-in integration: your agent exports the running factory, so every machine arrives connected and in context.
|
|
82
|
+
|
|
83
|
+
## See a fault spread
|
|
84
|
+
|
|
85
|
+
Start the Smart Factory machining line (CNC, unload robot, wash, press, test, packing robot) at 10× speed:
|
|
86
|
+
|
|
87
|
+
```shell
|
|
88
|
+
miravo start -t smart-factory --speed 10
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Point your software at it:
|
|
92
|
+
|
|
93
|
+
| Protocol | Endpoint |
|
|
94
|
+
| ---------- | ------------------------------------------------------------------- |
|
|
95
|
+
| OPC UA | `opc.tcp://127.0.0.1:4840` |
|
|
96
|
+
| MQTT | `mqtt://127.0.0.1:1883`, topics under `MiravoWorks/smart-factory/#` |
|
|
97
|
+
| Modbus TCP | `127.0.0.1:1502`, holding registers |
|
|
98
|
+
|
|
99
|
+
Each station publishes `state`, `good_count`, `scrap_count`, cycle times and time spent per state. In a second terminal, jam a valve on the press and watch the line react:
|
|
100
|
+
|
|
101
|
+
```shell
|
|
102
|
+
miravo inject press-001 valve_stuck
|
|
103
|
+
miravo status --watch
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
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. Sparkplug B starts with `--sparkplug`. Siemens S7 needs `s7` in the template's `protocols` block. See [S7](https://miravo.litmus.dev/docs/protocols/s7) and [Sparkplug B](https://miravo.litmus.dev/docs/protocols/sparkplug).
|
|
107
|
+
|
|
108
|
+
## Who it's for
|
|
109
|
+
|
|
110
|
+
- Dashboards, historians, UNS pipelines, MES and OEE apps that need structured live data.
|
|
111
|
+
- Alarm, SCADA, HMI and BMS integrations that need faults to react to.
|
|
112
|
+
- Edge analytics and predictive maintenance that need wear and failures.
|
|
113
|
+
- Industrial AI agents that read the plant and act on it. Miravo is the live plant, with faults you place and an event log of what happened. It does not score the agent. See [Evaluate Industrial Agents](https://miravo.litmus.dev/docs/agent-testing).
|
|
114
|
+
- Demos, CI tests and load tests that need the same plant every run.
|
|
115
|
+
|
|
116
|
+
Miravo is for development and testing, not for operational control.
|
|
117
|
+
|
|
118
|
+
## Documentation
|
|
119
|
+
|
|
120
|
+
- [Quick Start](https://miravo.litmus.dev/docs) and [What is Miravo?](https://miravo.litmus.dev/docs/what-is-miravo)
|
|
121
|
+
- [AI agents](https://miravo.litmus.dev/docs/agents) and [Evaluate Industrial Agents](https://miravo.litmus.dev/docs/agent-testing)
|
|
122
|
+
- [Templates](https://miravo.litmus.dev/docs/templates) and [asset models](https://miravo.litmus.dev/docs/core/asset-models)
|
|
123
|
+
- [Protocols](https://miravo.litmus.dev/docs/protocols): OPC UA, Modbus TCP, Siemens S7, MQTT, Sparkplug B
|
|
124
|
+
- [Integrations](https://miravo.litmus.dev/docs/integrations): Litmus Edge
|
|
125
|
+
- [Console](https://miravo.litmus.dev/docs/console)
|
|
126
|
+
- [CLI reference](https://miravo.litmus.dev/docs/cli/reference)
|
|
127
|
+
|
|
128
|
+
## Contributing, security and support
|
|
129
|
+
|
|
130
|
+
Contributions are welcome. Read [CONTRIBUTING.md](https://github.com/litmusautomation/miravo/blob/main/CONTRIBUTING.md) for the development process, how to submit a pull request, and the sign-off every commit needs. Found a bug or have an idea? [Open an issue](https://github.com/litmusautomation/miravo/issues).
|
|
131
|
+
|
|
132
|
+
Every listener binds `127.0.0.1` by default, and the protocol endpoints have no authentication. Read [Security](https://miravo.litmus.dev/docs/cli/security) before you expose them. Report vulnerabilities as described in [SECURITY.md](https://github.com/litmusautomation/miravo/blob/main/SECURITY.md).
|
|
133
|
+
|
|
134
|
+
Miravo is a community-driven open-source project, not a supported Litmus commercial product. Issues and pull requests are reviewed as time permits, with no guaranteed response times or SLAs. For commercial support, see the Litmus Industrial Data Platform at [litmus.io](https://litmus.io). Please do not open Litmus product support tickets on GitHub.
|
|
135
|
+
|
|
136
|
+
## Credit
|
|
137
|
+
|
|
138
|
+
[Amine Amaach](https://www.linkedin.com/in/amine-amaach) designed and built Miravo from the ground up at [Litmus](https://litmus.io), and leads the project. Litmus open-sourced it under the [Litmus Automation GitHub organization](https://github.com/litmusautomation).
|
|
139
|
+
|
|
140
|
+
## License
|
|
141
|
+
|
|
142
|
+
Miravo is licensed under [Apache-2.0](https://github.com/litmusautomation/miravo/blob/main/LICENSE). See [NOTICE](https://github.com/litmusautomation/miravo/blob/main/NOTICE) for attribution. Third-party components are listed in [THIRD_PARTY_NOTICES.md](https://github.com/litmusautomation/miravo/blob/main/THIRD_PARTY_NOTICES.md); the full dependency list and licence texts ship inside every release package, archive and image.
|
|
143
|
+
|
|
144
|
+
"Litmus" and the Litmus logos are trademarks of Litmus Automation. The licence grants no right to use them. Forks and derivative works must use a different name and branding.
|