From 924fddf6a29e295712dab832d9695ad5821e195c Mon Sep 17 00:00:00 2001
From: Nathan Schulte <8540239+nmschulte@users.noreply.github.com>
Date: Fri, 23 Feb 2024 23:22:45 -0600
Subject: [PATCH] add ClearReason fuel cut codes (#233)

---
 .../Clear-Reason-Codes.md                     | 22 +++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 docs/05-Limits-And-Protections/Clear-Reason-Codes.md

diff --git a/docs/05-Limits-And-Protections/Clear-Reason-Codes.md b/docs/05-Limits-And-Protections/Clear-Reason-Codes.md
new file mode 100644
index 0000000..7de7c02
--- /dev/null
+++ b/docs/05-Limits-And-Protections/Clear-Reason-Codes.md
@@ -0,0 +1,22 @@
+# FOME Fuel and Ignition Cut Codes ("Clear Reason")
+
+|Code|`enum ClearReason`|TunerStudio Text|Description|
+|---|:--|:--|:--|
+|0|`None`|None|no fuel/ignition cut|
+|1|`Fatal`|Fatal Error|disabled due to fatal error|
+|2|`Settings`|Setting Disabled|disabled by setting: `isInjectionEnabled`/`isIgnitionEnabled`|
+|3|`HardLimit`|RPM Limit|disabled by hard (normal) RPM limit: `useCltBasedRpmLimit`/`cltRevLimitRpmBins`/`cltRevLimitRpm`/`rpmHardLimit`/`rpmHardLimitHyst`|
+|4|`FaultRevLimit`|Fault RPM Limit|disabled by (fault) RPM limit -- ETB Problem: 1500, Fatal Error: 0 |
+|5|`BoostCut`|Boost Cut|disabled by boost cut pressure threshold: `boostCutPressure`|
+|6|`OilPressure`|Oil Pressure|disabled due to low oil pressure after 5 seconds: `minOilPressureAfterStart`|
+|7|`StopRequested`|Stop Requested|disabled due to engine stop|
+|8|`EtbProblem`|ETB Problem|disabled due to detected ETB problem ("10 percent-seconds of integral error") -- **currently not implemented**|
+|9|`LaunchCut`|Launch Control|disabled by launch control RPM retard condition: `launchRpm`/`launchFuelCutEnable`/`launchSparkCutEnable`/`launchControlEnable`|
+|10|`InjectorDutyCycle`|Max Injector Duty|disabled due to injector duty cycle limits: `maxInjectorDutyInstant`/`maxInjectorDutySustained`/`maxInjectorDutySustainedTimeout` -- resets after falling below 20% duty|
+|11|`FloodClear`|Flood Clear|disabled to allow flood clear mode: `isCylinderCleanupEnabled` -- TPS > 95% while cranking|
+|12|`EnginePhase`|Engine Sync|disabled due to lacking engine-cam sync to avoid non-sync spark: `vvtMode[0]` -- ex: symmetrical crank (NB2, Nissan VQ/MR), uneven firing order (VTwin Harley)|
+|13|`KickStart`|Kick Start|**currently not implemented**|
+|14|`IgnitionOff`|Ignition Off|disabled because the ignition is off, exception: self-stimulation mode|
+|15|`Lua`|Lua|fueling disabled by Lua script ignition cut request|
+|16|`ACR`|ACR|disabled due to Harley Automatic Compression Release: `acrPin`/`acrRevolutions`/`acrDisablePhase` -- avoids spraying fuel everywhere|
+|17|`LambdaProtection`|Lambda Protection|disabled due to lambda protection: `lambdaProtectionTimeout`|