{IDO Device Log Interface Description}

1. Function Overview

Provides the ability to query whether obtaining firmware logs is supported, query log directory addresses, start and cancel log retrieval.

2. Interface Abilities

1. Query if Obtaining Firmware Logs is Supported:

1.1 Function Summary:

None.

1.2 API ID:

bool get getLogIng;

1.3 API Parameter Explanation:

@return: bool Supported feature flag, false: Not supported, true: Supported. ////TODO?

2. Query All Log Directory Addresses:

2.1 Function Summary:

None.

2.2 API ID:

Future<String> get logDirPath;

2.3 API Parameter Explanation:

@return: String Directory addresses of all logs. Each log directory contains files named with timestamps. The names of all log directories are:

Flash Log Directory -> Flash
Battery Log Directory -> Battery
Heat Log Directory -> Heat
Old Reboot Log Directory -> Reboot

3. Start Log Retrieval:

3.1 Function Summary:

None.

3.2 API ID:

Stream<bool> startGet(List<IDOLogType> types);

3.3 API Parameter Explanation:

@return: bool Supported feature flag, false: Not supported, true: Supported.

@param: types List of logs to retrieve. Log types include:

enum IDOLogType {
  init          = 0,
  reboot        = 1, // Old reboot logs
  general       = 2, // General logs
  reset         = 3, // Reset logs
  hardware      = 4, // Hardware logs
  algorithm     = 5, // Algorithm logs
  restart       = 6, // New reboot logs
  battery       = 7, // Battery logs
  heat          = 8  // Heat logs
}

4. Cancel Log Retrieval:

4.1 Function Summary:

None.

4.2 API ID:

void cancel();

4.3 API Parameter Explanation:

None.