main/sdk/assembly/RecoveryConfig/README.md

# RecoveryConfig

Platform configuration options for recovery.

<table>
    <tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
        <tr id="system_recovery">
            <td><code>system_recovery</code></td>
            <td><code><a class='link' href="../SystemRecovery">SystemRecovery</code></td>
            <td>Which system_recovery implementation to include</td>
            <td></td>
        </tr>
        <tr id="logo">
            <td><code>logo</code></td>
            <td><code>Option<Utf8PathBuf></code></td>
            <td>The path to the logo for the recovery process to use.

This must be a rive file (.riv).</td>
            <td></td>
        </tr>
        <tr id="instructions">
            <td><code>instructions</code></td>
            <td><code>Option<Utf8PathBuf></code></td>
            <td>The path to the instructions to display.

This file must be raw text for displaying.</td>
            <td></td>
        </tr>
        <tr id="factory_reset_trigger_config">
            <td><code>factory_reset_trigger_config</code></td>
            <td><code>\[object]</code></td>
            <td>Include the factory-reset-trigger package, and configure it using the given file.

This is a a map of channel names to indices, when the current OTA channel matches one of the names in the file, if a stored index is less than the index value in the file, a factory reset is triggered.</td>
            <td></td>
        </tr>
        <tr id="check_for_managed_mode">
            <td><code>check_for_managed_mode</code></td>
            <td><code>bool</code></td>
            <td>Perform a managed-mode check before doing an FDR.</td>
            <td></td>
        </tr>
</table>