All KPIs added

README.md

@@ -4,20 +4,64 @@ Mean Time Between Failures: MTBF is a key indicator of asset reliability. It rep
 - Formula: MTBF = runtime / failures
 
 Mean Time to Repair: MTTR focuses on the speed of failure recovery. It indicates how long it takes on average to repair a failure and restore the system to operational condition. The lower the value, the better.
-- Formula: MTTR = downtime / failures
+- Formula: MTTR = maintenance_time / failures
 
 Asset Availability: Asset availability indicates how often machines are available for use. Higher availability means that the equipment experiences fewer breakdowns and remains operational for a greater amount of time.
 - Formula: availability = MTBF / (MTBF + MTTR) * 100% 
 
 Asset Health Index: A score ranging from 0 (optimal condition) to 5 (worst case) that reflects the overall health status of an asset.
+        How Asset Health Index is being calculated: 
+        1. Hard rule first: If the machine state is "maintenance", the health index is set straight to 5 (worst).
 
+        2. Otherwise it uses 3 inputs:
+            Unavailability = 1 - availability
+                If the machine is often down (low availability), this gets higher → worse health.
+
+            Drift score = how much measured vs. predicted pressure/flow/power differ over time.
+                More mismatch → higher drift score → worse health.
+
+            Efficiency penalty = how far the current efficiency is from the best efficiency point.
+                Further from the peak efficiency → higher penalty → worse health.
+
+        3. These are combined into one score:
+            score01 = 0.4 * unavailability
+                    + 0.4 * driftScore
+                    + 0.2 * effPenalty;
+
+            So: availability (40%) + drift (40%) + efficiency loss (20%).
+
+        4. Convert to index 0–5:
+            index = round(score01 * 5)
+            Clamp between 0 and 5 and store in this.assetHealth.index.
+
+        Summary: Health index = mix of downtime, sensor/prediction mismatch, and efficiency loss, scaled to a 0–5 scale (0 good, 5 bad).
+
+Remaining Useful Life: the estimated amount of time an asset has until it becomes unusable or requires replacement.
+        How RUL is being calculated: combination of MTBF and Asset Health Index
 
 ---KPI message---
 The message consists of the following components:
-- asset tagnumber: 
+- asset tagnumber: unique identifier of an asset
+- Maintenance mode: If asset in maintenance, this returns true, else this return false
+- Maintenance Time: Total time the asset has been in maintenance
 - asset availability
 - mean time between failures
 - mean time to repair
 - asset health index
 - asset health color: Gives a color based on the asset health index (0 = Darkgreen, 1 = Green, 2 = Yellow, 3 = Orange, 4 = Red, 5 = Darkred.)
-- total failures: the total number of failures that have occured for a particular asset
+- total failures: the total number of failures that have occured for a particular asset
+- Remaining Useful Life: the length from the current time to the end of the useful life
+
+Example message:
+{
+    asset_tag_number: "L001"
+    maintenance_mode: false
+    maintenance_time: 0.23494861111111115
+    kpi_asset_availability: 95.83
+    kpi_mtbf: 1.3505209027777778
+    kpi_mttr: 0.05873715277777779
+    kpi_asset_health_index: 2
+    kpi_asset_health_color: "#FFFF00"
+    kpi_total_failures: 4
+    remaining_useful_life: 1.0804167222222223
+}