Skip to content

Commit

Permalink
Merge pull request #80 from dronekit/prep-for-0.5
Browse files Browse the repository at this point in the history
Prep for 0.5
  • Loading branch information
mrpollo committed Jan 29, 2016
2 parents 2c11a4e + 9ae8abb commit 2ed2f7a
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 42 deletions.
8 changes: 6 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ INCS += -I. # for <DataFlash/DataFlash.h> in MsgHandler
WARNFLAGS= -Wall -Werror -Wextra -Wunused -Wredundant-decls -D_FORTIFY_SOURCE=2 -Wfloat-equal -fstack-protector -Wformat -Werror=format-security -Werror=pointer-arith -Wpedantic

ifeq ($(OS),Windows_NT)
CXX=i686-w64-mingw32-g++.exe
CC=i686-w64-mingw32-gcc.exe
CXX=x86_64-w64-mingw32-g++.exe
CC=x86_64-w64-mingw32-gcc.exe
LIBS += -lws2_32
LIBS += -lpthread # for clock_gettime/clock_settime on Windows
STATIC=-static
Expand Down Expand Up @@ -114,3 +114,7 @@ install-dronekit-la: dronekit-la
install -D dronekit-la $(DESTDIR)/usr/bin/dronekit-la

install: install-dronekit-la

VERSION=0.5
windows-zip: dronekit-la
zip dronekit-la-$(VERSION).zip dronekit-la.exe README.md LICENSE
26 changes: 13 additions & 13 deletions docs/_tests/analysis_summary.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
DK-LA Version: Version: 0.3
Git-Version: v0.1-200-g2d60
DK-LA Version: Version: 0.5
Git-Version: v0.1-221-g67b8

DK-LA HELP:

Expand Down Expand Up @@ -40,7 +40,7 @@ Gyro Drift
Attitude Control
AutoPilot Health
Battery
Brownout
Truncated Log
Position Estimate Divergence
Crash Test
Sensor Health
Expand Down Expand Up @@ -77,6 +77,10 @@ Description: The autopilot reports both the craft's attitude and the attitude th
* Fail: Desired attitude not achieved
* Warn: Desired attitude not achieved

TEST: Truncated Log
Description: A log should not end while the vehicle appears to be moving under its own power. This test will FAIL if the vehicle still appears to be moving when the log ends.
* Fail: Log ended while craft still flying

TEST: Battery
Description: Many autopilots are capable of monitoring their flight batteries. This test will FAIL if the battery level falls below the battery failsafe threshold level, or if a battery failsafe event is received.
* Pass: Battery never below failsafe
Expand All @@ -93,9 +97,8 @@ TEST: Ever Flew
Description: Determining whether a vehicle has ever flown in a log is done heuristically based on things like motor speeds. This test will FAIL if the craft did not ever seem to fly.
* Pass: The vehicle appeared to fly

TEST: Sensor Health
Description: A UAV can self-assess its sensors' health. This test will FAIL if any sensor is detected as failed.
* Fail: The craft's assessment of its sensors indicate a problem
TEST: Velocity Estimate Divergence
Description: A UAV typically has several estimates of its velocity. This test will FAIL if the craft's velocity estimates diverge.

TEST: Crash Test
Description: Crashes are detected both heuristically and by explicit log messages. This test will FAIL if the vehicle appears to crash.
Expand All @@ -108,10 +111,6 @@ TEST: Vehicle Definition
Description: The vehicle type is normally automatically detected by dronekit-la from the log. Sometimes the log does not contain sufficient information to make this determination. This test will FAIL if the craft type is never defined
* Pass: Vehicle was appropriately defined

TEST: Brownout
Description: A log should not end while the vehicle appears to be moving under its own power. This test will FAIL if the vehicle still appears to be moving when the log ends.
* Fail: Log ended while craft still flying

TEST: Position Estimate Divergence
Description: A UAV often has several estimates of its position. This test will FAIL or WARN if the various vehicle's position estimates diverge.
* Fail: This position estimate differs from the canonical craft position
Expand All @@ -122,13 +121,14 @@ Description: The strength and direction of the Earth's magnetic field should be
TEST: Arming Checks
Description: An autopilot checks many aspects of the aircraft's state before allowing it to be armed - for example, that it has a good GPS fix. This test will FAIL if the craft ever arms when some arming checks are disabled.

TEST: Velocity Estimate Divergence
Description: A UAV typically has several estimates of its velocity. This test will FAIL if the craft's velocity estimates diverge.
TEST: Sensor Health
Description: A UAV can self-assess its sensors' health. This test will FAIL if any sensor is detected as failed.
* Fail: The craft's assessment of its sensors indicate a problem

TEST: Attitude Estimate Divergence
Description: A UAV often has several estimates of its attitude. This test will FAIL or WARN if the various vehicle's attitude estimates diverge.
* Fail: This attitude estimate differs from the canonical craft attitude

TEST: Compass Offsets
Description: Compass calibration produces a set of parameters that specify expected compass discrepancies. This test will WARN or FAIL depending on the degree that these compass offset parameters exceed specified thresholds.
* Fail: Compass offsets in parameters are out of bounds
* Fail: Compass offsets in parameters are out of bounds
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@
# built documents.
#
# The short X.Y version.
version = '0.4'
version = '0.5'
# The full version, including alpha/beta/rc tags.
release = '0.4'
release = '0.5'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/other_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can list them using the ``-l`` flag. At time of writing (DroneKit-LA 0.3) th
Attitude Control
AutoPilot Health
Battery
Brownout
Truncated Log
Position Estimate Divergence
Crash Test
Sensor Health
Expand Down
46 changes: 23 additions & 23 deletions docs/reference/analyzers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,29 +157,6 @@ threshold level, or if a battery failsafe event is received.
Brownout
========

A log should not end while the vehicle appears to be moving under its own power.
This test will FAIL if the vehicle still appears to be moving when the log ends.

* Fail: Log ended while craft still flying
* Warn: Altitude never changed
* Pass: No brownout detected

.. note::

There are several possible causes for a truncated log (including power failure due to brownout,
running out of memory for the log file, or failure of the logging sub-system). Failing this test
does not necessarily mean a brownout actually occurred.


.. internalnotes
- defined in:
https://github.com/dronekit/dronekit-la/blob/master/analyzer/analyzer_brownout.cpp
https://github.com/dronekit/dronekit-la/blob/master/analyzer/analyzer_brownout.h
Compass Offsets
Expand Down Expand Up @@ -387,6 +364,29 @@ A UAV can self-assess its sensors' health. This test will FAIL if any sensor is
https://github.com/dronekit/dronekit-la/blob/master/analyzer/analyzer_sensor_health.h
Truncated Log
=============

A log should not end while the vehicle appears to be moving under its own power.
This test will FAIL if the vehicle still appears to be moving when the log ends.

* Fail: Log ended while craft still flying
* Warn: Altitude never changed


.. note::

There are several possible causes for a truncated log (including power failure due to brownout,
running out of memory for the log file, or failure of the logging sub-system).


.. internalnotes
- defined in:
https://github.com/dronekit/dronekit-la/blob/prep-for-0.5/analyzer/analyzer_truncated_log.cpp
https://github.com/dronekit/dronekit-la/blob/prep-for-0.5/analyzer/analyzer_truncated_log.h
.. _analyzer_listing_vehicle_definition:

Vehicle Definition
Expand Down
2 changes: 1 addition & 1 deletion loganalyzer.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// if you modify this, modify the debian metadata using e.g.
// debchange -r -e (FIXME)

#define DRONEKIT_LA_VERSION "0.3"
#define DRONEKIT_LA_VERSION "0.5"

#include "INIReader.h"

Expand Down

0 comments on commit 2ed2f7a

Please sign in to comment.