For each message topic you will find a short description what the message is used for and which structure it has, as well as what structure the payload is excepted to have.
Data Model (v0)
If you have events that you just want to send to the message broker / Unified Namespace without the need for it to be stored, simply send it to the
This data will not be processed by the UMH stack, but you can use it to build your own data processing pipeline.
If you have data that does not fit in the other topics (such as your PLC tags or sensor data), you can use the
processValue topic. It will be saved in the database in the processValue or processValueString and can be queried using factorysinsight or the umh-datasource Grafana plugin.
In a production environment, you should first declare products using addProduct. This allows you to create an order using addOrder. Once you have created an order, send an state message to tell the database that the machine is working (or not working) on the order.
Send count messages if the machine has produced a product, but it does not make sense to give the product its ID. Especially useful for bottling or any other use case with a large amount of products, where not each product is traced.
You can also add shifts using addShift.
Recommendation: Start with addShift and state and continue from there on
If you have accidentally sent the wrong state or if you want to modify a value, you can use the modifyState message.
Unique Product Tracking
The database stores the messages in different tables.
States are the core of the database model. They represent the state of the machine at a given point in time.