dji-log-parser

A library and CLI tool for parsing DJI txt logs with support for all log versions and encryptions.

Features

• Parse records and extract embedded images from DJI logs
• Normalize records across different log versions for a consistent frame format
• Export frames to CSV for easy analysis
• Generate flight tracks in GeoJSON and KML formats
• Support for all log versions, including encrypted logs (version 13+)

Encryption in Version 13 and Later

Starting with version 13, log records are AES encrypted and require a specific keychain for decryption. This keychain must be obtained from DJI using their API. An apiKey is necessary to access the DJI API.

Once keychains are retrieved from DJI API, they can be stored along with the original log for further offline use.

Obtaining an ApiKey

To acquire an apiKey, follow these steps:

1. Visit DJI Developer Technologies and log in.
2. Click CREATE APP, choose Open API as the App Type, and provide the necessary details like App Name, Category, and Description.
3. After creating the app, activate it through the link sent to your email.
4. On your developer user page, find your app's details to retrieve the ApiKey (labeled as the SDK key).

Cli Usage

Installation

Download binary from latest release

Basic usage

Parse one log file:

dji-log DJIFlightRecord.txt

This writes DJIFlightRecord.json next to the input file.

Parse several log files in one command:

dji-log examples/file1.txt examples/file2.txt examples/file3.txt

This writes:

examples/file1.json
examples/file2.json
examples/file3.json

You can also use your shell's wildcard expansion to decode many files:

dji-log examples/*.txt

If the directory already contains generated JSON files, this is also safe:

dji-log examples/*

In automatic output mode, .json inputs are ignored so generated outputs are not re-parsed.

By default, existing output files are not overwritten. Existing outputs are listed and skipped:

Output file(s) already exist; skipping them. Use --overwrite to replace:
  examples/file1.json
Decoded 2 file(s)

To replace existing outputs:

dji-log --overwrite examples/*.txt

To manually choose output paths, pass the same number of files to --output as input files:

dji-log examples/file1.txt examples/file2.txt --output out1.json out2.json

If a file cannot be decoded, it is skipped and reported immediately and again in a final summary. Other files continue processing.

API key

Encrypted logs, version 13 and later, require a DJI API key. The CLI resolves it in this order:

1. --api-key
2. DJI_API_KEY environment variable
3. DJI_API_KEY in a .env file found from the current directory or executable path

Example .env:

DJI_API_KEY=your_api_key_here

Additional Options

• --raw: Export raw records instead of normalized frames
• --images image%d.jpeg: Extract embedded images
• --thumbnails thumbnail%d.jpeg: Extract thumbnails
• --csv frames.csv: Generate a CSV file of frames
• --kml track.kml: Generate a KML file of the flight track
• --geojson track.json: Generate a GeoJSON file of the flight track
• --output out.json: Write JSON output to one or more explicit output paths
• --overwrite: Replace existing JSON output files

Use %d in the images or thumbnails option to specify a sequence.

Advanced Options

• --api-custom-department: Manually set the department on keychains apis request
• --api-custom-version: Manually set the department on keychains apis request

If the inferred keychain department fails with DJI's API, the CLI automatically retries common DJI app departments. Use --api-custom-department when you need to force a specific department manually.

For a complete list of options, run:

dji-log --help

Library Usage

Initialization

Initialize a DJILog instance from a byte slice to access version information and metadata:

let parser = DJILog::from_bytes(bytes).unwrap();

Access general data

General data are not encrypted and can be accessed from the parser for all log versions:

// Print the log version
println!("Version: {:?}", parser.version);

// Print the log details section
println!("Details: {}", parser.details);

Retrieve keychains

For logs version 13 and later, keychains must be retrieved from the DJI API to decode the records:

// Replace `__DJI_API_KEY__` with your actual apiKey
let keychains = parser.fetch_keychains("__DJI_API_KEY__").unwrap();

Keychains can be retrieved once, serialized, and stored along with the log file for future offline use.

Accessing Frames

Decrypt frames based on the log file version.

A Frame is a standardized representation of log data, normalized across different log versions. It provides a consistent and easy-to-use format for analyzing and processing DJI log information.

For versions prior to 13:

let frames = parser.frames(None);

For version 13 and later:

let frames = parser.frames(Some(keychains));

Accessing raw Records

Decrypt raw records based on the log file version. For versions prior to 13:

let records = parser.records(None);

For version 13 and later:

let records = parser.records(Some(keychains));

For more information, including a more detailed overview of the log format, visit the documentation.

License

dji-log-parser is available under the MIT license. See the LICENSE.txt file for more info.