doc: Finish updates for v1.7
authorKeith Packard <keithp@keithp.com>
Sat, 22 Apr 2017 05:24:00 +0000 (22:24 -0700)
committerKeith Packard <keithp@keithp.com>
Sat, 22 Apr 2017 05:25:03 +0000 (22:25 -0700)
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 <keithp@keithp.com>
13 files changed:
doc/Makefile
doc/altosdroid.inc
doc/altosui.inc
doc/altusmetrum-docinfo.xml
doc/flight-data-recording.inc
doc/installation.inc
doc/intro.inc
doc/release-notes-1.7.inc [new file with mode: 0644]
doc/release-notes.inc
doc/specs.inc
doc/system-operation.inc
doc/telemetry.txt
doc/updating-firmware.inc

index 40afbf6a534adf07eb3833ee1bc77f7a251154b7..0d01279fbe819d4d533fd38c38c2314396fb0bfd 100644 (file)
@@ -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 \
index faaa13f9720eb3f2308e5054af4e8dbb1058a3e9..dce81c3bbe65b206b2f9656f35a68f696709f766 100644 (file)
                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
index 76a24d918960872663d42bfb2d9a869bc762210a..88e7a03558dd75ad03a57ad0735f16c22f2279ff 100644 (file)
                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[]
index e1f4eb62b86148d59c4fc7b3ce24c9e7715e95af..6214cfd8858f50fb9674f4470b258b73481d9f7c 100644 (file)
 </legalnotice>
 <revhistory>
   <?dbhtml filename="altusmetrum-revhistory.html"?>
+  <revision>
+    <revnumber>1.7</revnumber>
+    <date>21 Apr 2017</date>
+    <revremark>
+      Add support for TeleMini in firmware, AltosUI and AltosDroid
+    </revremark>
+  </revision>
   <revision>
     <revnumber>1.6.8</revnumber>
     <date>4 Sep 2016</date>
index 32e44840fc86bbd9a7ad2e3292e6670c794f0910..392289083e1323d39070793ee3e19085199fd547 100644 (file)
@@ -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
index d390551efe319733aaf74641c8783040c668c56f..273b435bda80c5c63dd51c2a1b53833e467b16a6 100644 (file)
@@ -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.
 
index 28daa41a12d0fe3026b1d3098b348c35786d55e7..6b0cd31872f08b7704d41a8fea0f358c6d01ef36 100644 (file)
@@ -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 (file)
index 0000000..f2da71f
--- /dev/null
@@ -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
index 7cd075f624a2e629988825175c28a16db90893c3..86ce95d3b69172a5786f3bf57ac8749ace3ef199 100644 (file)
@@ -1,6 +1,10 @@
 [appendix]
 == Release Notes
 
+       :leveloffset: 2
+       include::release-notes-1.7.raw[]
+
+       <<<<
        :leveloffset: 2
        include::release-notes-1.6.8.raw[]
 
index c335b081e0a42c6e1f063d029417a652dfa620da..f09d6fc9e7290587fce1099c17235ba76147291a 100644 (file)
        |10mW
        |3.7V
 
+       |TeleMini v3.0
+       |MS5607 30km (100k')
+       |-
+       |-
+       |-
+       |512kB
+       |40mW
+       |3.7V
        endif::telemini[]
 
        ifdef::easymini[]
index e68b2acbc5dca491c7c2bd3858a5334402149628..67b7e6933ec5f64f1b4eed36c7cd701c79b407f5 100644 (file)
@@ -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
                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:
 
 
                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.
index 36d2edba775088e9a340eb41e936bd594d759d9a..d7399b6a5fbd99a8e8b8bd5bb6ae8418846fac63 100644 (file)
                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.
                |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
index 11ea12838d06904f0b026839bb559b4f4e976e32..91aa58f2b3309c87cc00edc79da6362f61c211e3 100644 (file)
@@ -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.
 
                        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.
 
                        . 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.
                          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
                          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
                ==== 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.