Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Latest commit

 

History

History
135 lines (90 loc) · 6.72 KB

Readme.md

File metadata and controls

135 lines (90 loc) · 6.72 KB

Cleanflight Blackbox Explorer

Main explorer interface

This tool allows you to open logs recorded by Cleanflight's Blackbox feature in your web browser. You can seek through the log to examine graphed values at each timestep. If you have a flight video, you can load that in as well and it'll be played behind the log. You can export the graphs as a WebM video to share with others.

Installation

There are three methods of installation available:

Chrome Web Store method

The easiest way to get the explorer (if you have Google Chrome) is to install it from the Chrome Web Store:

https://chrome.google.com/webstore/detail/cleanflight-blackbox-expl/cahpidddaimdojnddnahjpnefajpheep

This will add it to your computer as a Chrome App.

Manual Chrome App install

Download the contents of this repository by clicking the "download ZIP" button on the right of this page. Unpack the zip somewhere on your computer. In Google Chrome, open up the Extensions page, tick the "developer mode" tickbox, click the "load unpacked extension" button, and point it at the unpacked folder. This will add it as a Chrome App.

Run as a webpage

Download the contents of this repository by clicking the "download ZIP" button on the right of this page. Unpack the zip somewhere on your computer, and double click "index.html" file to open it with your web browser.

Note that the "video export" feature is only available when opened with Google Chrome. Also, running it this way will limit the exported flight video to 500MB in size. Use one of the previous Chrome App install methods to unlock >500MB video export.

Usage

Click the "Open log file/video" button at the top right and select your logged ".TXT" file and your flight video (if you recorded one).

You can scroll through the log by clicking or dragging on the seek bar that appears underneath the main graph. The current time is represented by the vertical red bar in the center of the graph. You can also click and drag left and right on the graph area to scrub backwards and forwards.

Syncing your log to your flight video

The blackbox plays a short beep on the buzzer when arming, and this corresponds with the start of the logged data. You can sync your log against your flight video by pressing the "start log here" button when you hear the beep in the video. You can tune the alignment of the log manually by pressing the nudge left and nudge right buttons in the log sync section, or by editing the value in the "log sync" box. Positive values move the log toward the end of the video, negative values move it towards the beginning.

Customizing the graph display

Click the "Graph Setup" button on the right side of the display in order to choose which fields should be plotted on the graph. You may, for example, want to remove the default gyro plot and add separate gyro plots for each rotation axis. Or you may want to plot vbat against throttle to examine your battery's performance.

Notes

This tool has not been tested on Internet Explorer, but definitely won't work on versions earlier than version 9.

Your web browser must support the video codec that your flight video uses in order to play it. Firefox doesn't support H.264 videos on Mac, so if your video won't play, try Google Chrome instead. If it still won't play, follow the instructions in the next section to convert your video using Handbrake.

The best performing web browser tends to be Google Chrome, especially when trying to play your flight video at the same time.

This tool is currently in the Beta stage, so a number of key features have yet to be implemented:

  • There is no control over the amount of smoothing applied to the graph lines
  • There is no way to single-step between loop iterations with the arrow keys

Native app build via NW.js

Development

  1. Install node.js
  2. Change to project folder and run npm install.
  3. Run npm start to build & run the debug flavor.

App build and release

The tasks are defined in gulpfile.js and can be run either via gulp <task-name> (if the command is in PATH or via ../node_modules/gulp/bin/gulp.js <task-name>:

  1. Optional, install gulp npm install --global gulp-cli.
  2. Run gulp <taskname> [[platform] [platform] ...].

List of possible values of <task-name>:

  • dist copies all the JS and CSS files in the ./dist folder.
  • apps builds the apps in the ./apps folder [1].
  • debug builds debug version of the apps in the ./debug folder [1].
  • release zips up the apps into individual archives in the ./release folder [1].

[1] Running this task on macOS or Linux requires Wine, since it's needed to set the icon for the Windows app (build for specific platform to avoid errors).

Build or release app for one specific platform

To build or release only for one specific platform you can append the plaform after the task-name. If no platform is provided, only for the platform you are builing from will be build.

  • MacOS use gulp <task-name> --osx64
  • Linux use gulp <task-name> --linux64
  • Windows use gulp <task-name> --win32
  • ChromeOS use gulp <task-name> --chromeos

You can also use multiple platforms e.g. gulp <taskname> --osx64 --linux64.

macOS DMG installation background image

The release distribution for macOS uses a DMG file to install the application. The PSD source for the DMG backgound image can be found in the root (dmg-background.png). After changing the source, export the image to PNG format in folder ./images/.

Flight video won't load, or jumpy flight video upon export

Some flight video formats aren't supported by Chrome, so the viewer can't open them. You can fix this by re-encoding your video using the free tool Handbrake. Open your original video using Handbrake. In the output settings, choose MP4 as the format, and H.264 as the video codec.

Because of Google Bug #66631, Chrome is unable to accurately seek within H.264 videos that use B-frames. This is mostly fine when viewing the flight video inside Blackbox Explorer. However, if you use the "export video" feature, this bug will cause the flight video in the background of the exported video to occasionally jump backwards in time for a couple of frames, causing a very glitchy appearance.

To fix that issue, you need to tell Handbrake to render every frame as an intraframe, which will avoid any problematic B-frames. Do that by adding "keyint=1" into the Additional Options box:

Handbrake settings

Hit start to begin re-encoding your video. Once it finishes, you should be able to load the new video into the Blackbox Explorer.

License

This project is licensed under GPLv3.