Updated README, added some note to pre-flight checklist

master
Richard Meadows 2015-07-05 21:20:30 +01:00
rodzic f1f7a33905
commit f1babfd5a8
2 zmienionych plików z 13 dodań i 41 usunięć

Wyświetl plik

@ -0,0 +1,7 @@
## Pre-Flight Checklist ##
- In `hw_config.h`
- `USE_XOSC` is set. Otherwise the symbol timing frequency will be
somewhat inaccurate.
- `APRS_ENABLE` is set if APRS is to be used on the flight
- `DEBUG_USE_INTWATCHDOG` can be disabled during flight. This saves some power

Wyświetl plik

@ -15,49 +15,14 @@ be built using
See [README-samd20-gcc-blackmagic.md](README-samd20-gcc-blackmagic.md)
for more details.
## Developement Framework ##
## Test Suite ##
Separate developement hardware exists, this has a separate MCU for
current and voltage measurement, as well controling the voltage at the
step-up input.
The test suite is used to run test cases on real hardware. Test cases
are written mostly in python and run using a gdb that has been built
`--with-python`. It is still a work in progress but is quite handy
when debugging.
This is part of the development framework.
The other part of the framework is several 'development scripts' that
are still TODO
## Verification Framework ##
The verification suite ultimately allows a single command to return a
PASS/FAIL vertict on the readiness of the system to fly. There should
be no user input required during the tests - A test case that requires user
input is actually a development script.
#### REAL_HARDWARE
If this flag is set, the test scripts can presume the MCU has full
access to real flight hardware.
Otherwise the tests must presume that their target is just the MCU on
a developement board and set-up any required test harnesses as appropriate.
#### DYNAMIC_TESTS
If this flag is set, then the test cases may use dynamic data from
the internet or other sources to test the tracker's performance in
current real-world conditions. This may even include uploading the
resulting test data to habhub or similar.
Otherwise test cases must be perfectly deterministic and
repeatable. Using psudo-random sequences to generate test data is
acceptable, as long as a constant seed is used.
### LONG_TEST
If this flag is set, then the test case may make as many iterations it
feels it needs for a full and thorough test.
Otherwise test cases must take less than 1 second of real world runtime.
See [test/README.md](test/README.md) for more details.
## Sources & Licensing ##