From eb1c2bf5244840049c0a58e0ceecfcd9f5c290dd Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Fri, 21 Apr 2017 22:24:00 -0700 Subject: [PATCH] doc: Finish updates for v1.7 Scrub all TeleMini references and make sure they're fixed for v3. No 'emergency' mode yet. No reflashing yet. Add v1.7 release notes. Signed-off-by: Keith Packard --- doc/Makefile | 1 + doc/altosdroid.inc | 2 +- doc/altosui.inc | 4 ++-- doc/altusmetrum-docinfo.xml | 7 ++++++ doc/flight-data-recording.inc | 3 ++- doc/installation.inc | 1 - doc/intro.inc | 6 ++--- doc/release-notes-1.7.inc | 25 +++++++++++++++++++++ doc/release-notes.inc | 4 ++++ doc/specs.inc | 8 +++++++ doc/system-operation.inc | 17 +++++++++------ doc/telemetry.txt | 41 ++++++++++++++++++++++++++++++++--- doc/updating-firmware.inc | 22 +++++++++---------- 13 files changed, 112 insertions(+), 29 deletions(-) create mode 100644 doc/release-notes-1.7.inc diff --git a/doc/Makefile b/doc/Makefile index 40afbf6a..0d01279f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,6 +3,7 @@ # RELNOTES_INC=\ + release-notes-1.7.inc \ release-notes-1.6.8.inc \ release-notes-1.6.5.inc \ release-notes-1.6.4.inc \ diff --git a/doc/altosdroid.inc b/doc/altosdroid.inc index faaa13f9..dce81c3b 100644 --- a/doc/altosdroid.inc +++ b/doc/altosdroid.inc @@ -224,7 +224,7 @@ flights, there may not be any space left. TeleMetrum and TeleMega can store multiple flights, depending on the configured maximum flight log size. TeleGPS logs - data continuously. TeleMini stores only a single + data continuously. TeleMini v1.0 stores only a single flight, so it will need to be downloaded and erased after each flight to capture data. This only affects on-board flight logging; the altimeter will still diff --git a/doc/altosui.inc b/doc/altosui.inc index 76a24d91..88e7a035 100644 --- a/doc/altosui.inc +++ b/doc/altosui.inc @@ -592,8 +592,8 @@ This reprograms Altus Metrum devices with new firmware. ifdef::telemetrum,telemini[] - TeleMetrum v1.x, TeleDongle v0.2, TeleMini - and TeleBT are all reprogrammed by using another + TeleMetrum v1.x, TeleDongle v0.2, TeleMini v1.0 + and TeleBT v1.0 are all reprogrammed by using another similar unit as a programming dongle (pair programming). endif::telemetrum,telemini[] diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index e1f4eb62..6214cfd8 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -46,6 +46,13 @@ + + 1.7 + 21 Apr 2017 + + Add support for TeleMini in firmware, AltosUI and AltosDroid + + 1.6.8 4 Sep 2016 diff --git a/doc/flight-data-recording.inc b/doc/flight-data-recording.inc index 32e44840..39228908 100644 --- a/doc/flight-data-recording.inc +++ b/doc/flight-data-recording.inc @@ -25,6 +25,7 @@ endif::telemetrum[] ifdef::telemini[] |TeleMini v1.0 |2 |5kB |4 + |TeleMini v3.0 |16 |512kB |5 endif::telemini[] ifdef::easymini[] |EasyMini |16 |1MB |10 @@ -44,7 +45,7 @@ Configuration data is also stored in the flash memory on ifdef::telemetrum[TeleMetrum v1.x,] - ifdef::telemini[TeleMini and] + ifdef::telemini[TeleMini v3.0 and] ifdef::easymini[EasyMini.] This consumes 64kB of flash space. This configuration space is not available diff --git a/doc/installation.inc b/doc/installation.inc index d390551e..273b435b 100644 --- a/doc/installation.inc +++ b/doc/installation.inc @@ -6,7 +6,6 @@ apogee and main ejection charges. All Altus Metrum products are designed for use with single-cell batteries with 3.7 volts nominal. - ifdef::telemini[TeleMini v2.0 and] EasyMini may also be used with other batteries as long as they supply between 4 and 12 volts. diff --git a/doc/intro.inc b/doc/intro.inc index 28daa41a..6b0cd318 100644 --- a/doc/intro.inc +++ b/doc/intro.inc @@ -17,9 +17,9 @@ Our second device was TeleMini, a dual deploy altimeter with radio telemetry and radio direction finding. The first version of this device was only 13mm by 38mm (½ inch by 1½ inches) and - could fit easily in an 18mm air-frame. The latest version, v2.0, - includes a beeper, USB data download and extended on-board - flight logging, along with an improved barometric sensor. + could fit easily in an 18mm air-frame. The latest version, v3.0, + includes a beeper, higher power radio, extended on-board + flight logging and an improved barometric sensor. TeleMega is our most sophisticated device, including six pyro channels (four of which are fully programmable), integrated GPS, diff --git a/doc/release-notes-1.7.inc b/doc/release-notes-1.7.inc new file mode 100644 index 00000000..f2da71f3 --- /dev/null +++ b/doc/release-notes-1.7.inc @@ -0,0 +1,25 @@ += Release Notes for Version 1.7 +:toc!: +:doctype: article + + Version 1.7 includes support for our new TeleMini v3.0 + flight computer and bug fixes in in the flight software for all our boards + and ground station interfaces. + + == AltOS + + AltOS New Features + + * Add support for TeleMini v3.0 boards. + + AltOS Fixes + + * Fix interrupt priorities on STM32L processors. Run timer + interrupt at lowest priority so that device interrupts get + serviced first. + + == AltosUI and TeleGPS Applications + + AltosUI New Features + + * Add support for TeleMini v3.0 hardware diff --git a/doc/release-notes.inc b/doc/release-notes.inc index 7cd075f6..86ce95d3 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -1,6 +1,10 @@ [appendix] == Release Notes + :leveloffset: 2 + include::release-notes-1.7.raw[] + + <<<< :leveloffset: 2 include::release-notes-1.6.8.raw[] diff --git a/doc/specs.inc b/doc/specs.inc index c335b081..f09d6fc9 100644 --- a/doc/specs.inc +++ b/doc/specs.inc @@ -57,6 +57,14 @@ |10mW |3.7V + |TeleMini v3.0 + |MS5607 30km (100k') + |- + |- + |- + |512kB + |40mW + |3.7V endif::telemini[] ifdef::easymini[] diff --git a/doc/system-operation.inc b/doc/system-operation.inc index e68b2acb..67b7e693 100644 --- a/doc/system-operation.inc +++ b/doc/system-operation.inc @@ -25,8 +25,9 @@ is selected if the board is connected via USB to a computer, otherwise the board enters “flight” mode. ifdef::telemini[] - TeleMini v1.0 - selects “idle” mode if it receives a command packet within the + TeleMini + selects “idle” mode if receives a command packet is + received within the first five seconds of operation. endif::telemini[] @@ -60,7 +61,7 @@ mode for requests sent via TeleDongle. Commands can be issued in idle mode over either USB or the radio link equivalently. - ifdef::telemini[TeleMini v1.0 only has the radio link.] + ifdef::telemini[TeleMini only have the radio link.] endif::radio[] Idle mode is useful for configuring the altimeter, for extracting data from the on-board storage chip after @@ -97,11 +98,13 @@ endif::telemetrum,telemega,easymega[] ifdef::telemini[] - TeleMini v1.0 is configured solely via the radio link. Of course, that + TeleMini are configured solely via the radio link. Of course, that means you need to know the TeleMini radio configuration values or you won't be able to communicate with it. For situations - when you don't have the radio configuration values, TeleMini v1.0 - offers an 'emergency recovery' mode. In this mode, TeleMini is + when you don't have the radio configuration values, + TeleMini v1.0 + offers an 'emergency recovery' mode. In this mode, + TeleMini v1.0 is configured as follows: @@ -154,7 +157,7 @@ Any operation which can be performed with a flight computer can either be done with the device directly connected to the computer via the USB cable, or through the radio - link. TeleMini v1.0 doesn't provide a USB connector and so it is + link. TeleMini don't provide a USB connector and so it is always communicated with over radio. Select the appropriate TeleDongle device when the list of devices is presented and AltosUI will interact with an altimeter over the radio link. diff --git a/doc/telemetry.txt b/doc/telemetry.txt index 36d2edba..d7399b6a 100644 --- a/doc/telemetry.txt +++ b/doc/telemetry.txt @@ -44,18 +44,18 @@ which device has transmitted the packet, when it was transmitted and what the rest of the packet contains. - === TeleMetrum v1.x, TeleMini and TeleNano Sensor Data + === TeleMetrum v1.x, TeleMini v1.0 and TeleNano Sensor Data .Sensor Packet Type [options="border",cols="1,3"] |==== |Type |Description |0x01 |TeleMetrum v1.x Sensor Data - |0x02 |TeleMini Sensor Data + |0x02 |TeleMini v1.0 Sensor Data |0x03 |TeleNano Sensor Data |==== - TeleMetrum v1.x, TeleMini and TeleNano share this same + TeleMetrum v1.x, TeleMini v1.0 and TeleNano share this same packet format for sensor data. Each uses a distinct packet type so that the receiver knows which data values are valid and which are undefined. @@ -213,6 +213,41 @@ |32 |==== + === TeleMini v3.0 Sensor Data + + .Sensor Packet Type + [options="border",cols="1,3"] + |==== + |Type |Description + |0x11 |TeleMini v3.0 Sensor Data + |==== + + TeleMini v3.0 uses this + packet format for sensor data. + + Sensor Data packets are transmitted once per second on + the ground, 10 times per second during ascent and once + per second during descent and landing + + .Sensor Packet Contents + [options="border",cols="2,3,3,9"] + |==== + |Offset |Data Type |Name |Description + |5 |uint8_t |state |Flight state + |6 |int16_t |v_batt |battery voltage + |8 |int16_t |sense_a |apogee continuity sense + |10 |int16_t |sense_m |main continuity sense + |12 |int32_t |pres |pressure sensor (Pa * 10) + |16 |int16_t |temp |temperature sensor (°C * 100) + |18 |int16_t |acceleration |m/s² * 16 + |20 |int16_t |speed |m/s * 16 + |22 |int16_t |height |m + |24 |int16_t |ground_pres |Average barometer reading on ground + |28 |pad[4] |pad bytes | + |32 + |==== + + === Configuration Data .Configuration Packet Type diff --git a/doc/updating-firmware.inc b/doc/updating-firmware.inc index 11ea1283..91aa58f2 100644 --- a/doc/updating-firmware.inc +++ b/doc/updating-firmware.inc @@ -11,7 +11,7 @@ programmed directly over their USB connectors (self programming). ifdef::telemega[] - TeleMetrum v1, TeleMini and TeleDongle v0.2 are + TeleMetrum v1, TeleMini v1.0 and TeleDongle v0.2 are all programmed by using another device as a programmer (pair programming). It's important to recognize which kind of devices you have before trying to reprogram them. @@ -228,10 +228,10 @@ If something goes wrong, give it another try. - ==== Updating TeleMini Firmware + ==== Updating TeleMini v1.0 Firmware You'll need a special 'programming cable' to - reprogram the TeleMini. You can make your own + reprogram the TeleMini v1.0. You can make your own using an 8-pin MicroMaTch connector on one end and a set of four pins on the other. @@ -242,19 +242,19 @@ . Plug the 8-pin end of the programming cable to the matching connector on the TeleDongle v0.2 or TeleBT v1.0, and the 4-pins into the - holes in the TeleMini circuit board. Note + holes in the TeleMini v1.0 circuit board. Note that the MicroMaTch connector has an alignment pin that goes through a hole in the PC board when you have the cable oriented correctly, and that pin 1 on the - TeleMini board is marked with a square pad + TeleMini v1.0 board is marked with a square pad while the other pins have round pads. - . Attach a battery to the TeleMini board. + . Attach a battery to the TeleMini v1.0 board. . Plug the TeleDongle v0.2 or TeleBT v1.0 into your computer's USB port, and power up the - TeleMini + TeleMini v1.0 . Run AltosUI, and select 'Flash Image' from the File menu. @@ -264,7 +264,7 @@ programming device. . Select the image you want put on the - TeleMini, which should have a name in the + TeleMini v1.0, which should have a name in the form telemini-v1.0-1.0.0.ihx. It should be visible in the default directory, if not you may have to poke around your system to find @@ -276,10 +276,10 @@ you'll need to change them. . Hit the 'OK' button and the software should - proceed to flash the TeleMini with new + proceed to flash the TeleMini v1.0 with new firmware, showing a progress bar. - . Confirm that the TeleMini board seems to + . Confirm that the TeleMini v1.0 board seems to have updated OK, which you can do by configuring it over the radio link through the TeleDongle, or letting it come up in @@ -290,7 +290,7 @@ ==== Updating TeleDongle v0.2 Firmware Updating TeleDongle v0.2 firmware is just like - updating TeleMetrum v1.x or TeleMini firmware, but you + updating TeleMetrum v1.x or TeleMini v1.0 firmware, but you use either a TeleMetrum v1.x, TeleDongle v0.2 or TeleBT v1.0 as the programmer. -- 2.30.2