From 946faa1541f69c6cf2759c13760fa9bc16e2298e Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Tue, 26 Nov 2019 15:47:07 -0800 Subject: [PATCH] doc: Update docs to reference TeleMetrum v3 where appropriate Mostly just add 'or newer' to various TeleMetrum v2 bits. Also add specs for the v3 board. Signed-off-by: Keith Packard --- doc/altosui.inc | 5 +++-- doc/config-device.inc | 2 +- doc/flight-data-recording.inc | 5 +++-- doc/getting-started.inc | 15 ++++++++------- doc/intro.inc | 4 ++-- doc/specs.inc | 9 +++++++++ doc/system-operation.inc | 2 +- doc/telemetrum.inc | 2 +- doc/telemetry.txt | 20 ++++++++++---------- doc/updating-firmware.inc | 6 +++--- 10 files changed, 41 insertions(+), 29 deletions(-) diff --git a/doc/altosui.inc b/doc/altosui.inc index 3e38702a..d497ad2f 100644 --- a/doc/altosui.inc +++ b/doc/altosui.inc @@ -634,8 +634,9 @@ programming). endif::telemetrum,telemini[] ifdef::telemega,easymega,telemetrum[] - TeleMega, EasyMega, TeleMetrum v2, - EasyMini and TeleDongle v3 are all + TeleMega, EasyMega, TeleMetrum v2 or newer, + EasyMini, TeleBT v3 or newer and TeleDongle v3 + or newer are all endif::telemega,easymega,telemetrum[] ifndef::telemega,easymega,telemetrum[] EasyMini is diff --git a/doc/config-device.inc b/doc/config-device.inc index 144b1e8f..5e3bdbf0 100644 --- a/doc/config-device.inc +++ b/doc/config-device.inc @@ -90,7 +90,7 @@ ifdef::radio[] transmission is disabled. ifdef::altusmetrum[] This option is - available on TeleMetrum v2 and TeleMega + available on TeleMetrum v2 or newer and TeleMega boards. TeleMetrum v1 boards cannot transmit APRS packets. endif::altusmetrum[] diff --git a/doc/flight-data-recording.inc b/doc/flight-data-recording.inc index 39228908..af79d532 100644 --- a/doc/flight-data-recording.inc +++ b/doc/flight-data-recording.inc @@ -22,6 +22,7 @@ |TeleMetrum v1.0 |8 |1MB |20 |TeleMetrum v1.1 v1.2 |8 |2MB |40 |TeleMetrum v2.0 |16 |8MB |80 + |TeleMetrum v3.0 |16 |8MB |80 endif::telemetrum[] ifdef::telemini[] |TeleMini v1.0 |2 |5kB |4 @@ -52,7 +53,7 @@ for storing flight log data. ifdef::telemetrum,telemega,easymega[] - TeleMetrum v2.0, TeleMega and EasyMega + TeleMetrum v2 or newer, TeleMega and EasyMega store configuration data in a bit of eeprom available within the processor chip, leaving that space available in flash for more flight data. @@ -65,7 +66,7 @@ together. That will slightly under-estimate the storage (in bytes) needed for the flight. ifdef::telemetrum[] - For instance, a TeleMetrum v2.0 flight spending + For instance, a TeleMetrum v2 or newer flight spending 20 seconds in ascent and 150 seconds in descent will take about (20 * 1600) + (150 * 160) = 56000 bytes of storage. You could store dozens of these flights in the on-board flash. diff --git a/doc/getting-started.inc b/doc/getting-started.inc index decaf4d4..5e60986a 100644 --- a/doc/getting-started.inc +++ b/doc/getting-started.inc @@ -42,13 +42,14 @@ to trickle charge. It can take several hours to fully recharge a deeply discharged battery. - TeleMetrum v2.0, TeleMega and EasyMega use a higher power battery charger, - allowing them to charge the battery while running the board at - maximum power. When the battery is charging, or when the board - is consuming a lot of power, the red LED will be lit. When the - battery is fully charged, the green LED will be lit. When the - battery is damaged or missing, both LEDs will be lit, which - appears yellow. + TeleMetrum v2 or newer, TeleMega and EasyMega use a + higher power battery charger, allowing them to charge + the battery while running the board at maximum + power. When the battery is charging, or when the board + is consuming a lot of power, the red LED will be + lit. When the battery is fully charged, the green LED + will be lit. When the battery is damaged or missing, + both LEDs will be lit, which appears yellow. ==== endif::telemetrum,telemega,easymega[] diff --git a/doc/intro.inc b/doc/intro.inc index bff009c0..a95247a2 100644 --- a/doc/intro.inc +++ b/doc/intro.inc @@ -20,8 +20,8 @@ The first device created for our community was TeleMetrum, a dual deploy altimeter with fully integrated GPS and radio telemetry as standard features, and a “companion interface” that will - support optional capabilities in the future. The latest version - of TeleMetrum, v2.0, has all of the same features but with + support optional capabilities in the future. The later versions + of TeleMetrum, v2 and newer, have all of the same features but with improved sensors and radio to offer increased performance. Our second device was TeleMini, a dual deploy altimeter with diff --git a/doc/specs.inc b/doc/specs.inc index 48d73f96..e6310e52 100644 --- a/doc/specs.inc +++ b/doc/specs.inc @@ -46,6 +46,15 @@ |40mW |3.7V + |TeleMetrum v3.0 + |MS5607 30km (100k') + |ADXL375 200g + |uBlox Max-8Q + |- + |8MB + |40mW + |3.7V + endif::telemetrum[] ifdef::telemini[] |TeleMini v1.0 diff --git a/doc/system-operation.inc b/doc/system-operation.inc index 1e130976..6cc9986b 100644 --- a/doc/system-operation.inc +++ b/doc/system-operation.inc @@ -295,7 +295,7 @@ endif::radio[] ifdef::gps+radio[] - :aprsdevices: TeleMetrum v2.0 and TeleMega + :aprsdevices: TeleMetrum v2 and newer and TeleMega :configure_section: _configure_altimeter include::aprs-operation.adoc[] endif::gps+radio[] diff --git a/doc/telemetrum.inc b/doc/telemetrum.inc index 35aec6cc..3247db95 100644 --- a/doc/telemetrum.inc +++ b/doc/telemetrum.inc @@ -18,7 +18,7 @@ bay for TeleMetrum should have at least 10 inches of interior length. There are two generations of the TeleMetrum design. The - major changes in the v2 generation are: + major changes after v1 generation are: * uBlox GPS chip certified for altitude records diff --git a/doc/telemetry.txt b/doc/telemetry.txt index 4a7edad8..6949b607 100644 --- a/doc/telemetry.txt +++ b/doc/telemetry.txt @@ -173,7 +173,7 @@ Keith Packard ; Bdale Garbee |32 |==== - === TeleMetrum v2 Sensor Data + === TeleMetrum v2 and newer Sensor Data .TeleMetrum v2 Packet Type [options="border",cols="1,3"] @@ -183,17 +183,17 @@ Keith Packard ; Bdale Garbee |0x0B |TeleMetrum v2 Calibration Data |==== - TeleMetrum v2 has higher resolution barometric data than + TeleMetrum v2 and newer have higher resolution barometric data than TeleMetrum v1, and so the constant calibration data is split out into a separate packet. - TeleMetrum v2 Sensor Data packets are transmitted once per second on the + TeleMetrum v2 and newer 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 - TeleMetrum v2 Calibration Data packets are always transmitted once per second. + TeleMetrum v2 and newer Calibration Data packets are always transmitted once per second. - .TeleMetrum v2 Sensor Packet Contents + .TeleMetrum v2 and newer Sensor Packet Contents [options="border",cols="2,3,3,9"] |==== |Offset |Data Type |Name |Description @@ -211,7 +211,7 @@ Keith Packard ; Bdale Garbee |32 |==== - .TeleMetrum v2 Calibration Data Packet Contents + .TeleMetrum v2 and newer Calibration Data Packet Contents [options="border",cols="2,3,3,9"] |==== |Offset |Data Type |Name |Description @@ -461,19 +461,19 @@ Keith Packard ; Bdale Garbee |CC1111 |10mW transceiver with integrated SoC - |TeleDongle v0.2, TeleBT v1.0, TeleMetrum v1.x, TeleMini + |TeleDongle v0.2, TeleBT v1.0, TeleMetrum v1.x, TeleMini v1 |CC1120 |35mW transceiver with SW FEC - |TeleMetrum v2, TeleMega + |TeleMetrum v2, TeleMega v1 |CC1200 |35mW transceiver with HW FEC - |TeleDongle v3.0, TeleBT v3.0 + |TeleMetrum v3, TeleMega v2, TeleDongle v3.0, TeleMini v3, TeleBT v3.0, TeleGPS v2 |CC115L |14mW transmitter with SW FEC - |TeleGPS + |TeleGPS v1 |==== diff --git a/doc/updating-firmware.inc b/doc/updating-firmware.inc index 0c75fdee..b1047ffa 100644 --- a/doc/updating-firmware.inc +++ b/doc/updating-firmware.inc @@ -2,7 +2,7 @@ == Updating Device Firmware ifdef::telemega[] - TeleMega, TeleMetrum v2, EasyMega, EasyMini and TeleDongle v3 + TeleMega, TeleMetrum v2 and newer, EasyMega, EasyMini and TeleDongle v3 are all endif::telemega[] ifndef::telemega[] @@ -28,7 +28,7 @@ ifdef::telemega[] - === Updating TeleMega, TeleMetrum v2, EasyMega, EasyMini or TeleDongle v3 Firmware + === Updating TeleMega, TeleMetrum v2 or newer, EasyMega, EasyMini, TeleDongle v3 or TeleBT v3 Firmware endif::telemega[] ifndef::telemega[] @@ -106,7 +106,7 @@ endif::easymega[] ifdef::telemetrum[] - TeleMetrum v2:: + TeleMetrum v2 and newer:: Connect pin 6 and pin 1 of the companion connector. Pin 1 can be identified by the square pad -- 2.30.2