Démarrage rapide

Obtenez des données via des protocoles industriels en moins de deux minutes.

1. Démarrer Miravo

Docker

docker run --rm -p 1883:1883 -p 8080:8080 amineamaach/miravo:latest

bunx

bunx miravo start

Binaire

./miravo start

Miravo sélectionne automatiquement le template smart-factory et démarre un broker MQTT intégré sur le port 1883.

2. S’abonner aux données

Ouvrez un deuxième terminal et abonnez-vous à tous les topics avec n’importe quel client MQTT :

Avec mosquitto_sub (installation : apt install mosquitto-clients ou brew install mosquitto) :

mosquitto_sub -h 127.0.0.1 -t '#' -v

Ou avec MQTTX CLI (installation : npm install -g mqttx) :

mqttx sub -t '#' -h localhost

Les topics suivent la structure Unified Namespace :

MiravoWorks/smart-factory/production/line-1/belt-conveyor-001/speed_feedback
MiravoWorks/smart-factory/production/line-1/centrifugal-pump-001/discharge_pressure
MiravoWorks/smart-factory/utilities/compressed-air/air-compressor-001/header_pressure

Chaque message est un payload JSON :

{
  "value": 5.21,
  "timestamp": 1710000000000,
  "quality": "good",
  "unit": "bar",
  "instanceId": "centrifugal-pump-001",
  "model": "centrifugal-pump",
  "dataType": "Double"
}

3. Vérifier l’état

Consultez l’état de la simulation via l’API admin :

curl -s http://127.0.0.1:8080/state | jq .

Ou ouvrez la console web à http://127.0.0.1:8080 pour un tableau de bord en temps réel avec l’état des instances, les métriques et les événements en direct.

4. Injecter une défaillance

Déclenchez une défaillance sur une pompe en cours d’exécution :

curl -s http://127.0.0.1:8080/commands \
  -H 'content-type: application/json' \
  -d '{"type":"triggerFault","instanceId":"centrifugal-pump-001","fault":"cavitation"}'

Observez le subscriber MQTT — les valeurs de vibration augmentent, le débit chute.

5. Essayer un autre template

Docker

docker run --rm -p 1883:1883 -p 8080:8080 \
  amineamaach/miravo:latest start --template water-treatment

CLI

miravo start --template water-treatment

Quatre templates intégrés sont disponibles : smart-factory, water-treatment, commercial-building et backup-power.

Étapes suivantes

• Concepts fondamentaux — Comprendre modèles, templates, générateurs et la boucle de tick
• Modèles Twin — Définir vos propres types d’actifs
• Référence CLI — Toutes les commandes et options