From 54838e3d523953e3ce4cea2319b2820c21d2c576 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Mon, 6 Aug 2018 13:15:21 +0800 Subject: Include TeleMega v3.0 firmware with releases Signed-off-by: Keith Packard --- doc/RELNOTES | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/RELNOTES b/doc/RELNOTES index 748d2b5b..e21f6f27 100644 --- a/doc/RELNOTES +++ b/doc/RELNOTES @@ -1,12 +1,12 @@ Creating documentation for a new release of AltOS +* Write release notes in release-notes-${version}.inc. Add to + Makefile + * Make sure that doc/altusmetrum-docinfo.xml has the right copyright year, and add release to the revision history at the front (release notes will be pulled in by release-notes.inc) -* Write release notes in release-notes-${version}.inc. Add to - Makefile - * Add references to that as appropriate from each of the documents: -- cgit v1.2.3 From 8dd942b59edbe6909128b88bfbb8d1e15c3857c6 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Wed, 22 Aug 2018 00:59:59 -0700 Subject: doc: Don't accidentally create zero-length PDF files The PDF files are generated at the same time the HTML files are, so the PDF versions depend on the HTML ones. However, touching the PDF files is a bad idea. Signed-off-by: Keith Packard --- doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index 3661a6d6..f460a2ff 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -258,7 +258,7 @@ DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) case $* in release-notes*) ./fix-html $*.html ;; esac .html.pdf: - @touch $@ + @echo $@ .tmpl.xsl: xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl -- cgit v1.2.3 From 0f05859d9fdef5867df888d9a8b41602e3bff7f7 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Thu, 4 Oct 2018 22:58:38 -0700 Subject: doc: Describe Packet Link usage and selecting RF param defaults for TeleMini Packet Link mode is the only communication method available for TeleMini and deserves some special mention in the docs. TeleMini allows forcing of RF parameters back to known defaults by hooking SWCLK to ground at power on (hole 7 to hole 3 on the debug connector). Describe this process so that users will be able to get TeleMini back to known values and recover. Signed-off-by: Keith Packard --- doc/telemini.inc | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) (limited to 'doc') diff --git a/doc/telemini.inc b/doc/telemini.inc index b40582a2..08893dfb 100644 --- a/doc/telemini.inc +++ b/doc/telemini.inc @@ -94,6 +94,56 @@ the left power switch wire. Hook a lead to either of the mounting holes for a ground connection. + === Using Packet Link Mode with TeleMini + + After TeleMini powers up, it will check to see if some + device is attempting to communicate with it using + Packet Link Mode. If so, it will switch to idle mode + and start communicating. To switch to flight mode, + reboot the device either over the radio link or by + powering it off and back on. + + If no ground station is attempting to communicate + using Packet Link Mode, TeleMini will enter pad mode + and prepare for flight. + + The sequence of operations to use Packet Link Mode + with TeleMini is: + + 1. Configure the ground station data rate, frequency + and callsign to match the TeleMini settings. + + 2. Start Packet Link Mode in the ground station by + selecting the desired operation (Safe Flight Data, + Configure Altimeter, Fire Igniter or Monitor + Idle). Select the TeleBT or TeleDongle device. The + red LED should begin flashing rapidly. + + 3. Turn on TeleMini. You should see the red LED flash + very rapidly during the initial communication burst, + but it should then slow down when the link is idle. + + Once TeleMini is in Idle mode, it will stay in that + mode until rebooted. That means you can stop one + Packet Link operation, wait a while and start another + Packet Link operation. + + === Forcing TeleMini radio parameters to known defaults + + If you don't know what the TeleMini frequency and + callsign settings are, you can temporarily force it + back to the original default values (frequency + 434.550MHz, callsign N0CALL) by connecting a wire + between hole 3 and hole 7 on the debug connector. Hole + 3 has the square pad around it, hole 7 is the one + nearest the MS5607 baro sensor, which is a rectangular + component with a metal cap that has two holes in it. + + Once TeleMini has been powered up with this wire + connected, the wire may be removed. The radio + parameters will stay set to these default values until + changed by the user or when the device is rebooted. + === TeleMini v1 TeleMini v1 is the earlier version of this product. It -- cgit v1.2.3 From 77c3878df78ae356c442999a99f1e1752e2cd06b Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Thu, 4 Oct 2018 23:03:12 -0700 Subject: doc: Describe Packet Link mode in the initial usage section It's not described in any detail elsewhere... Signed-off-by: Keith Packard --- doc/usage.inc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc') diff --git a/doc/usage.inc b/doc/usage.inc index d010f398..dd795bdd 100644 --- a/doc/usage.inc +++ b/doc/usage.inc @@ -323,3 +323,22 @@ different kind of battery to any of these will destroy the board. endif::telemega,easymega,telemetrum[] + + === Using Packet Link Mode + + All AltusMetrum flight computers that have a radio can + communicate with the ground station software for + configuration and other operations using the Packet + Link mode. This uses radio communication instead of a + USB cable. To set this up, the ground station software + must be configured to the correct data rate, frequency + and callsign. + + You can monitor Packet Link mode from TeleBT or + TeleDongle by watching the LEDs. Each time the device + transmits, the red LED will flash. When the link is + busy, or when the link is not working, the device will + transmit 10 times per second, so the LED will flash + rapidly. When the link is working and there is no data + to send, the link will flash once per second, and the + LED will flash more slowly. -- cgit v1.2.3 From bb740c830b58273ee72255320bcedb3b849c0e2c Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Fri, 5 Oct 2018 18:22:11 -0700 Subject: doc: Update for 1.8.7 Release notes Add HW specs for EasyMini v2.0 and TeleMega v3.0 Signed-off-by: Keith Packard --- doc/Makefile | 1 + doc/altusmetrum-docinfo.xml | 8 ++++++++ doc/micropeak-docinfo.xml | 16 +++++++++++++++- doc/release-notes-1.8.7.inc | 32 ++++++++++++++++++++++++++++++++ doc/release-notes.inc | 4 ++++ doc/specs.inc | 18 ++++++++++++++++++ 6 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 doc/release-notes-1.8.7.inc (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index f460a2ff..5e175cbe 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,6 +3,7 @@ # RELNOTES_INC=\ + release-notes-1.8.7.inc \ release-notes-1.8.6.inc \ release-notes-1.8.5.inc \ release-notes-1.8.4.inc \ diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 7b696b97..2f8b69fb 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -46,6 +46,14 @@ + + 1.8.7 + 6 Oct 2018 + + Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF + calibration to factory value when reflashing. + + 1.8.6 6 Aug 2018 diff --git a/doc/micropeak-docinfo.xml b/doc/micropeak-docinfo.xml index 37c6e770..f4d9eaff 100644 --- a/doc/micropeak-docinfo.xml +++ b/doc/micropeak-docinfo.xml @@ -5,7 +5,7 @@ keithp@keithp.com - 2014 + 2018 Keith Packard @@ -31,6 +31,20 @@ + + 1.8.7 + 6 October 2018 + + Poll for MicroPeak USB while the device dialog is open. + + + + 1.8.6 + 6 August 2018 + + Report altimeter-recorded maximum height value + + 1.3.2 12 February 2014 diff --git a/doc/release-notes-1.8.7.inc b/doc/release-notes-1.8.7.inc new file mode 100644 index 00000000..e6837232 --- /dev/null +++ b/doc/release-notes-1.8.7.inc @@ -0,0 +1,32 @@ += Release Notes for Version 1.8.7 +:toc!: +:doctype: article + + Version 1.8.7 + + == AltOS + + * Include TeleMega v3.0 firmware + + == AltosUI, TeleGPS + + * Poll for new devices while Device dialog is displayed + + * Wait for device to re-appear when flashing new firmware + + * Fetch correct TeleBT v4.0 RF calibration values from web + site when reflashing. + + * Change gyro headings in .csv files from x/y/z to + roll/pitch/yaw + + * Add documentation about Packet Link mode + + * Add documentation about forcing TeleMini RF parameters to + known values. + + == MicroPeak + + * Poll for new devices while Device dialog is displayed + + diff --git a/doc/release-notes.inc b/doc/release-notes.inc index 693699df..1183fd12 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -1,5 +1,9 @@ [appendix] == Release Notes + :leveloffset: 2 + include::release-notes-1.8.7.raw[] + + <<<< :leveloffset: 2 include::release-notes-1.8.6.raw[] diff --git a/doc/specs.inc b/doc/specs.inc index f09d6fc9..430c8789 100644 --- a/doc/specs.inc +++ b/doc/specs.inc @@ -76,6 +76,15 @@ |1MB |- |3.7-12V + + |EasyMini v2.0 + |MS5607 30km (100k') + |- + |- + |- + |1MB + |- + |3.7-12V endif::easymini[] ifdef::telemega[] @@ -96,6 +105,15 @@ |8MB |40mW |3.7V + + |TeleMega v3.0 + |MS5607 30km (100k') + |ADXL375 200g + |uBlox Max-7Q + |MPU9250 + |8MB + |40mW + |3.7V endif::telemega[] ifdef::easymega[] -- cgit v1.2.3 From a477dcbafe942af8f53e57802e228d94b526e13e Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Fri, 5 Oct 2018 18:22:59 -0700 Subject: doc: Add check for new hardware in specs.inc Signed-off-by: Keith Packard --- doc/RELNOTES | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/RELNOTES b/doc/RELNOTES index e21f6f27..678ac17e 100644 --- a/doc/RELNOTES +++ b/doc/RELNOTES @@ -34,3 +34,5 @@ Creating documentation for a new release of AltOS telemetry-docinfo.xml * Add release-notes-${version}.inc to git + +* Make sure new hardware specs are documented in specs.inc -- cgit v1.2.3 From cc70746e8efa6cadb23cbfcb11ddb51574c512a9 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Fri, 5 Oct 2018 21:40:13 -0700 Subject: doc: Use RELEASE_DATE to set PDF timestamps using faketime This ensures that the generated PDF files do not depend on the time of the build and only on the date of the release. Signed-off-by: Keith Packard --- configure.ac | 1 + doc/Makefile | 316 ------------------------------------------------------- doc/Makefile.am | 317 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 318 insertions(+), 316 deletions(-) delete mode 100644 doc/Makefile create mode 100644 doc/Makefile.am (limited to 'doc') diff --git a/configure.ac b/configure.ac index 9ad581c9..a14762b0 100644 --- a/configure.ac +++ b/configure.ac @@ -519,6 +519,7 @@ AC_OUTPUT([ Makefile src/Makedefs src/chaoskey-v1.0/org.altusmetrum.ChaosKey.metainfo.xml +doc/Makefile altoslib/Makefile altoslib/AltosVersion.java icon/Makefile diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 5e175cbe..00000000 --- a/doc/Makefile +++ /dev/null @@ -1,316 +0,0 @@ -# -# http://docbook.sourceforge.net/release/xsl/current/README -# - -RELNOTES_INC=\ - release-notes-1.8.7.inc \ - release-notes-1.8.6.inc \ - release-notes-1.8.5.inc \ - release-notes-1.8.4.inc \ - release-notes-1.8.3.inc \ - release-notes-1.8.2.inc \ - release-notes-1.8.1.inc \ - release-notes-1.8.inc \ - release-notes-1.7.inc \ - release-notes-1.6.8.inc \ - release-notes-1.6.5.inc \ - release-notes-1.6.4.inc \ - release-notes-1.6.3.inc \ - release-notes-1.6.2.inc \ - release-notes-1.6.1.inc \ - release-notes-1.6.inc \ - release-notes-1.5.inc \ - release-notes-1.4.2.inc \ - release-notes-1.4.1.inc \ - release-notes-1.4.inc \ - release-notes-1.3.2.inc \ - release-notes-1.3.1.inc \ - release-notes-1.3.inc \ - release-notes-1.2.1.inc \ - release-notes-1.2.inc \ - release-notes-1.1.1.inc \ - release-notes-1.1.inc \ - release-notes-1.0.1.inc \ - release-notes-0.9.2.inc \ - release-notes-0.9.inc \ - release-notes-0.8.inc \ - release-notes-0.7.1.inc - -IMAGES=\ - altosui.png \ - ascent.png \ - configure-altimeter.png \ - configure-altosui.png \ - configure-groundstation.png \ - configure-pyro.png \ - descent.png \ - device-selection.png \ - easymega.svg \ - easymega-v1.0-bottom.jpg \ - easymega-v1.0-top.jpg \ - easymini.svg \ - easymini-top.jpg \ - fire-igniter.png \ - graph-configure.png \ - graph-map.png \ - graph.png \ - graph-stats.png \ - ignitor.png \ - landed.png \ - launch-pad.png \ - load-maps.png \ - micropeak-app.png \ - micropeak-back.jpg \ - micropeak-device-dialog.png \ - micropeak-dime.jpg \ - micropeak-download.png \ - micropeak-graph-configure.png \ - micropeak-graph.png \ - micropeak-nofont.svg \ - micropeak-preferences.png \ - micropeak-raw-data.png \ - micropeak-save-dialog.png \ - micropeak-statistics.png \ - MicroPeakUSB-2.0-inuse.jpg \ - MicroPeakUSB-2.0.jpg \ - monitor-idle.png \ - scan-channels.png \ - site-map.png \ - table.png \ - telegps-configure.png \ - telegps-graph-configure.png \ - telegps-graph-graph.png \ - telegps-graph-map.png \ - telegps-graph-stats.png \ - telegps-info.png \ - telegps-location.png \ - telegps-map.png \ - telegps-preferences.png \ - telegps-scan.png \ - telegps-status.png \ - telegps-table.png \ - telegps-v1.0-top.jpg \ - telemega.svg \ - telemega-v1.0-top.jpg \ - telemetrum.svg \ - telemetrum-v1.1-thside.jpg \ - telemetrum-v2.0-th.jpg \ - telemini-v1.svg \ - telemini-v1-top.jpg \ - telemini-v3.svg \ - telemini-v3.0-top.jpg \ - telemini-v3.0-bottom.jpg \ - altusmetrum-oneline.svg \ - telegps-oneline.svg \ - micropeak-oneline.svg - -TXT_FILES=altusmetrum.txt - -COMMON_INC_FILES=\ - config-device.inc \ - config-ui.inc \ - load-maps.inc \ - aprs-operation.inc \ - handling.inc - -INC_FILES=\ - dedication.inc \ - intro.inc \ - getting-started.inc \ - usage.inc \ - telemetrum.inc \ - telemini.inc \ - easymini-device.inc \ - telemega.inc \ - easymega.inc \ - installation.inc \ - using-am-products.inc \ - updating-firmware.inc \ - altosui.inc \ - altosdroid.inc \ - system-operation.inc \ - pyro-channels.inc \ - flight-data-recording.inc \ - specs.inc \ - $(COMMON_INC_FILES) \ - release-notes.inc \ - $(RELNOTES_INC) - -RAW_FILES=$(TXT_FILES:.txt=.raw) $(INC_FILES:.inc=.raw) - -TELEGPS_INC_FILES=\ - telegps-dedication.inc \ - telegps-quick-start.inc \ - telegps-using.inc \ - telegps-system-operation.inc \ - telegps-application.inc \ - telegps-specs.inc \ - telegps-updating-firmware.inc \ - telegps-release-notes.inc \ - $(COMMON_INC_FILES) - -TELEGPS_TXT_FILES=\ - telegps.txt - -TELEGPS_RAW_FILES=$(TELEGPS_TXT_FILES:.txt=.raw) $(TELEGPS_INC_FILES:.inc=.raw) - -MICROPEAK_TXT_FILES=\ - micropeak.txt - -MICROPEAK_INC_FILES= - -MICROPEAK_RAW_FILES=$(MICROPEAK_TXT_FILES:.txt=.raw) $(MICROPEAK_INC_FILES:.inc=.raw) - -EASYMINI_TXT_FILES=\ - easymini.txt - -EASYMINI_INC_FILES=$(INC_FILES) easymini-release-notes.inc - - -EASYMINI_RAW_FILES=$(EASYMINI_TXT_FILES:.txt=.raw) $(EASYMINI_INC_FILES:.inc=.raw) - -OUTLINE_TXT_FILES=\ - easymega-outline.txt \ - easymini-outline.txt \ - telemega-outline.txt \ - telemetrum-outline.txt \ - telemini-v1-outline.txt \ - telemini-v3-outline.txt \ - telegps-outline.txt - -OUTLINE_RAW_FILES=$(OUTLINE_TXT_FILES:.txt=.raw) - -OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf) - -SVG=\ - easymini.svg \ - telemega.svg \ - telemetrum.svg \ - telemini-v1.svg \ - telemini-v3.svg \ - easymega.svg - -RELNOTES_HTML=$(RELNOTES_INC:.inc=.html) - -ONEFILE_TXT_FILES=\ - altos.txt \ - companion.txt \ - telemetry.txt - -ONEFILE_RAW_FILES=$(ONEFILE_TXT_FILES:.txt=.raw) -ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf) -ONEFILE_HTML_FILES=$(ONEFILE_TXT_FILES:.txt=.html) - -AM_HTML=am.html - -PUBLISH_HTML=altusmetrum.html micropeak.html telegps.html easymini.html $(ONEFILE_HTML_FILES) - -HTML=$(PUBLISH_HTML) $(RELNOTES_HTML) - -HTML_REVHISTORY=\ - altusmetrum-revhistory.html \ - micropeak-revhistory.html \ - telegps-revhistory.html \ - easymini-revhistory.html - -PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(ONEFILE_PDF_FILES) \ - $(OUTLINE_PDF_FILES) - -FOP_STYLE=am-fo.xsl -HTML_STYLE=am-html.xsl -COMMON_STYLE=common.xsl -FOP_XCONF=fop.xconf -STYLESHEET=am.css - -FONTS=\ - fonts/DejaVuSansMono-BoldOblique.ttf \ - fonts/DejaVuSansMono-Bold.ttf \ - fonts/DejaVuSansMono-Oblique.ttf \ - fonts/DejaVuSansMono.ttf \ - fonts/OpenSans-Light.ttf \ - fonts/OpenSans-LightItalic.ttf \ - fonts/OpenSans-Regular.ttf \ - fonts/OpenSans-Italic.ttf \ - fonts/OpenSans-Semibold.ttf \ - fonts/OpenSans-SemiboldItalic.ttf - -TEMPLATES_TMPL=titlepage.templates.tmpl - -TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl) - -PDF_CONFIG_FILES=$(FOP_STYLE) $(COMMON_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) -HTML_CONFIG_FILES=$(HTML_STYLE) $(COMMON_STYLE) $(TEMPLATES_XSL) - -PUBLISH_DOC=$(PUBLISH_HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) - -DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) - -.SUFFIXES: .tmpl .xsl .inc .txt .raw .pdf .html - -.txt.raw: - sed -e 's/^[ ]*//' -e 's/^\\//' $*.txt > $@ - -.inc.raw: - sed -e 's/^[ ]*//' -e 's/^\\//' $*.inc > $@ - -.raw.html: - a2x --verbose -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw - a2x --verbose -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw - case $* in release-notes*) ./fix-html $*.html ;; esac - -.html.pdf: - @echo $@ - -.tmpl.xsl: - xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl - -all: $(HTML) $(PDF) - -altusmetrum-revhistory.html: altusmetrum.html - -micropeak-revhistory.html: micropeak.html - -telegps-revhistory.html: telegps.html - -altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(RAW_FILES) $(IMAGES) - -telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_RAW_FILES) $(IMAGES) - -micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_RAW_FILES) $(IMAGES) - -easymini.pdf easymini.html: easymini-docinfo.xml $(EASYMINI_RAW_FILES) $(IMAGES) - -telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg - -telemini-v3-outline.pdf: telemini-v3-outline.txt telemini-v3.svg - -install: all - -WEB_ROOT=/home/bdale/web/ - -publish: $(PUBLISH_DOC) $(FONTS) - cp $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/ - mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ - cp $(FONTS) $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ - (cd $(WEB_ROOT)/altusmetrum ; \ - git add $(WEB_ROOT)/altusmetrum/AltOS/doc/* ; \ - git add $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ - echo "update docs" | \ - git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ - git push) - -publish-keithp: am.html $(PUBLISH_DOC) $(FONTS) - scp -p am.html $(PUBLISH_DOC) keithp.com:~keithp/public_html/altos - scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts - -clean: - rm -f am.html $(HTML) $(HTML_REVHISTORY) $(PDF) $(TEMPLATES_XSL) $(RAW_FILES) $(TELEGPS_RAW_FILES) $(MICROPEAK_RAW_FILES) - -distclean: clean - rm -f $(HTML) $(PDF) - -$(PDF): $(PDF_CONFIG_FILES) -$(HTML): $(HTML_CONFIG_FILES) - -am.html: Makefile make-am-html $(HTML) - sh ./make-am-html $(HTML) > $@ diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..0139d313 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,317 @@ +# +# http://docbook.sourceforge.net/release/xsl/current/README +# + +FAKETIME=$(RELEASE_DATE) 00:00:00 + +RELNOTES_INC=\ + release-notes-1.8.7.inc \ + release-notes-1.8.6.inc \ + release-notes-1.8.5.inc \ + release-notes-1.8.4.inc \ + release-notes-1.8.3.inc \ + release-notes-1.8.2.inc \ + release-notes-1.8.1.inc \ + release-notes-1.8.inc \ + release-notes-1.7.inc \ + release-notes-1.6.8.inc \ + release-notes-1.6.5.inc \ + release-notes-1.6.4.inc \ + release-notes-1.6.3.inc \ + release-notes-1.6.2.inc \ + release-notes-1.6.1.inc \ + release-notes-1.6.inc \ + release-notes-1.5.inc \ + release-notes-1.4.2.inc \ + release-notes-1.4.1.inc \ + release-notes-1.4.inc \ + release-notes-1.3.2.inc \ + release-notes-1.3.1.inc \ + release-notes-1.3.inc \ + release-notes-1.2.1.inc \ + release-notes-1.2.inc \ + release-notes-1.1.1.inc \ + release-notes-1.1.inc \ + release-notes-1.0.1.inc \ + release-notes-0.9.2.inc \ + release-notes-0.9.inc \ + release-notes-0.8.inc \ + release-notes-0.7.1.inc + +IMAGES=\ + altosui.png \ + ascent.png \ + configure-altimeter.png \ + configure-altosui.png \ + configure-groundstation.png \ + configure-pyro.png \ + descent.png \ + device-selection.png \ + easymega.svg \ + easymega-v1.0-bottom.jpg \ + easymega-v1.0-top.jpg \ + easymini.svg \ + easymini-top.jpg \ + fire-igniter.png \ + graph-configure.png \ + graph-map.png \ + graph.png \ + graph-stats.png \ + ignitor.png \ + landed.png \ + launch-pad.png \ + load-maps.png \ + micropeak-app.png \ + micropeak-back.jpg \ + micropeak-device-dialog.png \ + micropeak-dime.jpg \ + micropeak-download.png \ + micropeak-graph-configure.png \ + micropeak-graph.png \ + micropeak-nofont.svg \ + micropeak-preferences.png \ + micropeak-raw-data.png \ + micropeak-save-dialog.png \ + micropeak-statistics.png \ + MicroPeakUSB-2.0-inuse.jpg \ + MicroPeakUSB-2.0.jpg \ + monitor-idle.png \ + scan-channels.png \ + site-map.png \ + table.png \ + telegps-configure.png \ + telegps-graph-configure.png \ + telegps-graph-graph.png \ + telegps-graph-map.png \ + telegps-graph-stats.png \ + telegps-info.png \ + telegps-location.png \ + telegps-map.png \ + telegps-preferences.png \ + telegps-scan.png \ + telegps-status.png \ + telegps-table.png \ + telegps-v1.0-top.jpg \ + telemega.svg \ + telemega-v1.0-top.jpg \ + telemetrum.svg \ + telemetrum-v1.1-thside.jpg \ + telemetrum-v2.0-th.jpg \ + telemini-v1.svg \ + telemini-v1-top.jpg \ + telemini-v3.svg \ + telemini-v3.0-top.jpg \ + telemini-v3.0-bottom.jpg \ + altusmetrum-oneline.svg \ + telegps-oneline.svg \ + micropeak-oneline.svg + +TXT_FILES=altusmetrum.txt + +COMMON_INC_FILES=\ + config-device.inc \ + config-ui.inc \ + load-maps.inc \ + aprs-operation.inc \ + handling.inc + +INC_FILES=\ + dedication.inc \ + intro.inc \ + getting-started.inc \ + usage.inc \ + telemetrum.inc \ + telemini.inc \ + easymini-device.inc \ + telemega.inc \ + easymega.inc \ + installation.inc \ + using-am-products.inc \ + updating-firmware.inc \ + altosui.inc \ + altosdroid.inc \ + system-operation.inc \ + pyro-channels.inc \ + flight-data-recording.inc \ + specs.inc \ + $(COMMON_INC_FILES) \ + release-notes.inc \ + $(RELNOTES_INC) + +RAW_FILES=$(TXT_FILES:.txt=.raw) $(INC_FILES:.inc=.raw) + +TELEGPS_INC_FILES=\ + telegps-dedication.inc \ + telegps-quick-start.inc \ + telegps-using.inc \ + telegps-system-operation.inc \ + telegps-application.inc \ + telegps-specs.inc \ + telegps-updating-firmware.inc \ + telegps-release-notes.inc \ + $(COMMON_INC_FILES) + +TELEGPS_TXT_FILES=\ + telegps.txt + +TELEGPS_RAW_FILES=$(TELEGPS_TXT_FILES:.txt=.raw) $(TELEGPS_INC_FILES:.inc=.raw) + +MICROPEAK_TXT_FILES=\ + micropeak.txt + +MICROPEAK_INC_FILES= + +MICROPEAK_RAW_FILES=$(MICROPEAK_TXT_FILES:.txt=.raw) $(MICROPEAK_INC_FILES:.inc=.raw) + +EASYMINI_TXT_FILES=\ + easymini.txt + +EASYMINI_INC_FILES=$(INC_FILES) easymini-release-notes.inc + + +EASYMINI_RAW_FILES=$(EASYMINI_TXT_FILES:.txt=.raw) $(EASYMINI_INC_FILES:.inc=.raw) + +OUTLINE_TXT_FILES=\ + easymega-outline.txt \ + easymini-outline.txt \ + telemega-outline.txt \ + telemetrum-outline.txt \ + telemini-v1-outline.txt \ + telemini-v3-outline.txt \ + telegps-outline.txt + +OUTLINE_RAW_FILES=$(OUTLINE_TXT_FILES:.txt=.raw) + +OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf) + +SVG=\ + easymini.svg \ + telemega.svg \ + telemetrum.svg \ + telemini-v1.svg \ + telemini-v3.svg \ + easymega.svg + +RELNOTES_HTML=$(RELNOTES_INC:.inc=.html) + +ONEFILE_TXT_FILES=\ + altos.txt \ + companion.txt \ + telemetry.txt + +ONEFILE_RAW_FILES=$(ONEFILE_TXT_FILES:.txt=.raw) +ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf) +ONEFILE_HTML_FILES=$(ONEFILE_TXT_FILES:.txt=.html) + +AM_HTML=am.html + +PUBLISH_HTML=altusmetrum.html micropeak.html telegps.html easymini.html $(ONEFILE_HTML_FILES) + +HTML=$(PUBLISH_HTML) $(RELNOTES_HTML) + +HTML_REVHISTORY=\ + altusmetrum-revhistory.html \ + micropeak-revhistory.html \ + telegps-revhistory.html \ + easymini-revhistory.html + +PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(ONEFILE_PDF_FILES) \ + $(OUTLINE_PDF_FILES) + +FOP_STYLE=am-fo.xsl +HTML_STYLE=am-html.xsl +COMMON_STYLE=common.xsl +FOP_XCONF=fop.xconf +STYLESHEET=am.css + +FONTS=\ + fonts/DejaVuSansMono-BoldOblique.ttf \ + fonts/DejaVuSansMono-Bold.ttf \ + fonts/DejaVuSansMono-Oblique.ttf \ + fonts/DejaVuSansMono.ttf \ + fonts/OpenSans-Light.ttf \ + fonts/OpenSans-LightItalic.ttf \ + fonts/OpenSans-Regular.ttf \ + fonts/OpenSans-Italic.ttf \ + fonts/OpenSans-Semibold.ttf \ + fonts/OpenSans-SemiboldItalic.ttf + +TEMPLATES_TMPL=titlepage.templates.tmpl + +TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl) + +PDF_CONFIG_FILES=$(FOP_STYLE) $(COMMON_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) +HTML_CONFIG_FILES=$(HTML_STYLE) $(COMMON_STYLE) $(TEMPLATES_XSL) + +PUBLISH_DOC=$(PUBLISH_HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) + +DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) + +SUFFIXES = .tmpl .xsl .inc .txt .raw .pdf .html + +.txt.raw: + sed -e 's/^[ ]*//' -e 's/^\\//' $*.txt > $@ + +.inc.raw: + sed -e 's/^[ ]*//' -e 's/^\\//' $*.inc > $@ + +.raw.html: + a2x -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw + case $* in release-notes*) ./fix-html $*.html ;; esac + +.html.pdf: + TZ=UTC faketime -f '$(FAKETIME) i0' a2x -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw + +.tmpl.xsl: + xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl + +all: $(HTML) $(PDF) + +altusmetrum-revhistory.html: altusmetrum.html + +micropeak-revhistory.html: micropeak.html + +telegps-revhistory.html: telegps.html + +altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(RAW_FILES) $(IMAGES) + +telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_RAW_FILES) $(IMAGES) + +micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_RAW_FILES) $(IMAGES) + +easymini.pdf easymini.html: easymini-docinfo.xml $(EASYMINI_RAW_FILES) $(IMAGES) + +telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg + +telemini-v3-outline.pdf: telemini-v3-outline.txt telemini-v3.svg + +install: all + +WEB_ROOT=/home/bdale/web/ + +publish: $(PUBLISH_DOC) $(FONTS) + cp $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/ + mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ + cp $(FONTS) $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ + (cd $(WEB_ROOT)/altusmetrum ; \ + git add $(WEB_ROOT)/altusmetrum/AltOS/doc/* ; \ + git add $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ + echo "update docs" | \ + git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ + git push) + +publish-keithp: am.html $(PUBLISH_DOC) $(FONTS) + scp -p am.html $(PUBLISH_DOC) keithp.com:~keithp/public_html/altos + scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts + +clean: + rm -f am.html $(HTML) $(HTML_REVHISTORY) $(PDF) $(TEMPLATES_XSL) $(RAW_FILES) $(TELEGPS_RAW_FILES) $(MICROPEAK_RAW_FILES) + +distclean: clean + rm -f $(HTML) $(PDF) + +$(PDF): $(PDF_CONFIG_FILES) +$(HTML): $(HTML_CONFIG_FILES) + +am.html: Makefile make-am-html $(HTML) + sh ./make-am-html $(HTML) > $@ -- cgit v1.2.3 From 5a95ed9c9419c15352b8dc1d895c9adce30f99f5 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sat, 6 Oct 2018 12:00:45 -0700 Subject: Add map-loading documentation Signed-off-by: Keith Packard --- doc/.gitignore | 1 + doc/Makefile.am | 12 ++- doc/map-loading.dot | 35 +++++++++ doc/map-loading.txt | 221 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 267 insertions(+), 2 deletions(-) create mode 100644 doc/map-loading.dot create mode 100644 doc/map-loading.txt (limited to 'doc') diff --git a/doc/.gitignore b/doc/.gitignore index 786123a3..06ad43eb 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -4,3 +4,4 @@ *.raw titlepage.templates.xsl fop-cfg.xml +map-loading.svg diff --git a/doc/Makefile.am b/doc/Makefile.am index 0139d313..5f2ab026 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -197,7 +197,8 @@ RELNOTES_HTML=$(RELNOTES_INC:.inc=.html) ONEFILE_TXT_FILES=\ altos.txt \ companion.txt \ - telemetry.txt + telemetry.txt \ + map-loading.txt ONEFILE_RAW_FILES=$(ONEFILE_TXT_FILES:.txt=.raw) ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf) @@ -218,6 +219,8 @@ HTML_REVHISTORY=\ PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(ONEFILE_PDF_FILES) \ $(OUTLINE_PDF_FILES) +MAP_DOT_FILES=map-loading.dot +MAP_SVG_FILES=$(MAP_DOT_FILES:.dot=.svg) FOP_STYLE=am-fo.xsl HTML_STYLE=am-html.xsl COMMON_STYLE=common.xsl @@ -247,7 +250,10 @@ PUBLISH_DOC=$(PUBLISH_HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) -SUFFIXES = .tmpl .xsl .inc .txt .raw .pdf .html +SUFFIXES = .dot .svg .tmpl .xsl .inc .txt .raw .pdf .html + +.dot.svg: + dot -Tsvg -o$@ $*.dot .txt.raw: sed -e 's/^[ ]*//' -e 's/^\\//' $*.txt > $@ @@ -267,6 +273,8 @@ SUFFIXES = .tmpl .xsl .inc .txt .raw .pdf .html all: $(HTML) $(PDF) +map-loading.raw: $(MAP_SVG_FILES) + altusmetrum-revhistory.html: altusmetrum.html micropeak-revhistory.html: micropeak.html diff --git a/doc/map-loading.dot b/doc/map-loading.dot new file mode 100644 index 00000000..f5be02ef --- /dev/null +++ b/doc/map-loading.dot @@ -0,0 +1,35 @@ +digraph map_loading { + edge [arrowsize=0.5; style="setlinewidth(2)"] + node [style=filled; fontcolor=white; color=invis; shape=box; arrowsize=0.5; fontname="DejaVu Sans,sans-serif"; fontsize=12; height=0.2;]; + edge [decorate=true; fontname="DejaVu Sans,sans-serif"; fontsize=8]; + graph [fontname="DejaVu Sans,sans-serif"; fontsize=15; ] + rankdir="TB"; + ranksep=0.5; + nodesep=0.5; + color=invis; + fillcolor="#c0c0c0"; + fontcolor="white"; + + app -> apache [label="AltOS Map URI"] + apache -> app [label="Google Map tile"] + + apache -> cgi_script [label="AltOS Map URI"] + cgi_script -> cache_manager [label="AltOS Tile Request"] + + cgi_script -> apache [label="Google Map tile"] + + cache_manager -> cgi_script [label="AltOS Tile Reply"] + + cache_manager -> disk_files [label="AltOS tile files" dir="both"] + cache_manager -> google_maps [label="Google Map URI"] + + google_maps -> cache_manager [label="Google Map tile"] + + app [color="#885931" label="Application"] + apache [color="#d12127" label="Apache Web Server"] + cgi_script [color="#551a8b" label="AltOS Map CGI Script"] + cache_manager [color="#c75b1c" label="AltOS Map Cache Manager"] + disk_files [color="#4f81bd" label="File System"] + google_maps [color="#4cbb44" label="Google Maps"] +} + diff --git a/doc/map-loading.txt b/doc/map-loading.txt new file mode 100644 index 00000000..3dffcd04 --- /dev/null +++ b/doc/map-loading.txt @@ -0,0 +1,221 @@ += Loading Map Tiles from Google Maps +:doctype: article + +== The Google Maps Problem + +Until recently, Google Maps could be used without fee to fetch map +tiles. Applications could load map tiles anonymously or using a key; +when used anonymously, the number of tiles that could be loaded per +day and the rate at which tiles could be loaded was throttled to make +the API practical only for development purpose. With an application +key, the number of tiles available per day was much higher, and there +was no rate limiting. This was usually sufficient for Altos Metrum +customer use. + +However, this has changed and now there is no way to load map tiles +anonymously, and any application key must be tied to a credit +card. The tile cap for free usage is now monthly instead of +daily. Because the key is tied to a credit card, we should not ship it +with the application any longer. And because the cap is monthly +instead of daily, we need some way to control usage by our +applications. + +=== The Proposed Solution — An Intermediate Service + +To give us some measure of control over tile loading, we will want to +interpose a server controlled by us between the application and Google +Maps. This will let us store the Google Maps key in a secure location, +and also control tile loading by each user. + +image::map-loading.svg[align="center"] + +== AltOS Map Service + +This service receives a URL request and replies with either a map tile +or an error. It is functionally equivalent to the Google Maps service, +except that it can control use of the Google Maps API. + +=== AltOS Map CGI Script + +The AltOS Map CGI Script is a straightforward script which connects to +the AltOS Map Cache Manager, transmits a URL describing the desired +map tile and receives back a filename (or error), then sends the +contents of that file back through Apache to the requesting +application. The name of the script is 'altos-map'. + +==== Inputs + +The AltOS Map CGI Script will parse the provided AltOS Map URI or +AltOS Version URI. + +==== Outputs + +For AltOS Map URLs, the CGI Script will return either the contents of +the associated Google Map tile or an error indicating what failed: + +_200 OK_: The map tile image data or version information + +_400 Bad Request_: The URL is malformed or not compatible with the +version supported by the service + +_403 Forbidden_: The map tile is outside the areas supported by the +current AltOS Map service area + +_408 Request Timeout_: Attempts to fetch the tile from Google Maps +timed out. + +_503 Service Unavailable_: The service is temporarily refusing to +satisfy this request due to resource limitations. + +=== AltOS Map Cache Manager + +This is a service running on the local machine and available over a +local network socket. It translates an AltOS Map URL into a local +filename containing the contents of the associated Google Maps +tile. The name of the cache manager is 'altos-mapd'. It will listen +for requests on port 16717. + +=== AltOS Map URI + +AltOS uses a limited subset of the Google Maps, and the AltOS Map URIs +only encode those elements which we currently use. This specification +describes AltOS Map URI format version 1.0.0. The application is +required to provide URIs compatible with the format supported by the +server. The elements of the elements are: + + * Latitude of center point + * Longitude of center point + * Zoom level (from bushes to planets) + +Encoding this in a URI is straightforward: + +\ altos-map?center=,&zoom= + +Latitude and longitude are both encoded using decimal degrees with 6 +digits following the decimal point. + +Zoom levels can range from 1 (world) to 20 (buildings). Higher zoom +levels show smaller areas at greater detail. + +The only Google Map type supported by version 1.0.0 of the service is +“hybrid”, which combines road graphics on top of satellite images. + +Version 1.0.0 always returns images which are 512x512 pixels. + +If we need additional elements in the URL, we can add them in the +future and bump the supported version number. + +=== AltOS Version URI + +To allow applications to discover what AltOS Map URI version is supported by the +AltOS Map service, the application may query the version of the API +supported using the Version URI. The application provides the version +that it supports and the AltOS Map service returns a version not +greater than the client version: + +\ altos-map?version=.. +\ → +\ .. + +=== AltOS Tile Request + +The AltOS Map CGI Script parses the Map URI and passes that +information to the AltOS Map Cache Manager using the AltOS Tile +Specifier syntax. This is a JSON representation of the same data +provided by the URI: + +\ { +\ "lat": , +\ "lon": , +\ "zoom": , +\ "remote_addr": "" +\ } + +Latitude and longitude are both encoded using decimal degrees with 6 +digits following the decimal point. + +=== AltOS Tile Reply + +Sent back from the Cache Manager to the CGI Script, this encodes the +status of the request and the filename of any tile data available. It +is encoded in JSON format: + +\ { +\ "status": , +\ "filename": "", +\ "content_type": "" +\ } + +The “filename” and “content-type” elements are only included when +the status is _200 OK_. + +=== AltOS Tile Filename + +While the current AltOS Map URI version only supports a limited subset +of the Google Maps functionality, we'll encode more of that data in +filenames to allow for easy expansion of functionality in the +future. The elements of an AltOS Tile filename consist of : + + * Latitude, with N/S indicator (instead of a sign) + * Longitude, with E/W indicator (instead of a sign) + * Map type. + * Zoom level + * Scale factor. Scale, and the preceding hyphen are omitted for a scale factor of 1. + * Image format suffix. '.jpg' for JPEG files and '.png' for PNG files. + +Latitude and longitude are both encoded using decimal degrees with 6 +digits following the decimal point. + +Map type is one of : + + _hybrid_: Road graphics over satellite images + _roadmap_: Symbolic road map + _satellite_: Un-annotated satellite images + _terrain_: Topographic map + +Here's what map filenames look like: + +\ map-{N,S},{E,W}--[-]. +\ +\ map-N36.508532,W107.823944-hybrid-18.jpg + +To transmit this name from the AltOS Map Cache Manager back to the +Altos Map CGI script, the filename will be wrapped in a JSON string + +== Implementation + +The AltOS Map CGI Script and AltOS Map Cache Manager will both be +implemented in Java as much of the required Google Maps infrastructure +is already available in that language. + +=== Access Control + +No access control to the service is planned at this point. If +necessary, we could implement username/password access control for each +user of the service. + +=== Location Restrictions + +To avoid unbounded usage, and confine the utility of this service to +AltOS users, the service will only offer map tiles whose center +location is within 10 miles of one of the sites registered in +our launch sites database. + +To allow testing of the registered launch site database, a database of +privileged clients will be supported. Privileged clients will have +unlimited access to the service. + +=== Per-Client Restrictions + +We should implement a per-day limit on the number of tiles provided to +a particular requesting client. We can also rate limit clients to a +certain number of tiles per minute to reduce the bandwidth consumed +out of our server. + +=== Cache Lifetime Restrictions. + +The Google Maps API allows for caching of map data for no more than 30 +days. To honor this, the Cache Manager will re-fetch any requested +tiles when the cached version is older than this. If the fetch fails, +the cache manager will continue to serve the data from the cached +version of the file. -- cgit v1.2.3 From 9e29ac8ed9a48fc4ac8e769eeb131dd7c58fedc4 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sat, 6 Oct 2018 17:17:20 -0700 Subject: doc: Make use of 'faketime' configurable with configure.ac. Default to 'no' This ensures that older a2x versions don't simply wedge while building the docs. Signed-off-by: Keith Packard --- configure.ac | 6 ++++++ doc/Makefile.am | 7 +++++-- 2 files changed, 11 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/configure.ac b/configure.ac index 0a5a76ec..1705745d 100644 --- a/configure.ac +++ b/configure.ac @@ -184,6 +184,12 @@ else HAVE_GOOGLE_KEY="no" fi +AC_ARG_ENABLE(faketime, AS_HELP_STRING([--enable-faketime], + [Use faketime program to ensure pdf files are reproducible (default=no)]), + [FAKETIME=$enableval], [FAKETIME=no]) + +AM_CONDITIONAL(FAKETIME, [test x$FAKETIME = xyes]) + AC_SUBST(GOOGLEKEY) AC_PROG_CC diff --git a/doc/Makefile.am b/doc/Makefile.am index 5f2ab026..450053f1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,7 +2,9 @@ # http://docbook.sourceforge.net/release/xsl/current/README # -FAKETIME=$(RELEASE_DATE) 00:00:00 +if FAKETIME +FAKETIME=TZ=UTC faketime -f '$(RELEASE_DATE) 00:00:00 i0' +endif RELNOTES_INC=\ release-notes-1.8.7.inc \ @@ -264,9 +266,10 @@ SUFFIXES = .dot .svg .tmpl .xsl .inc .txt .raw .pdf .html .raw.html: a2x -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw case $* in release-notes*) ./fix-html $*.html ;; esac + $(FAKETIME) a2x -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw .html.pdf: - TZ=UTC faketime -f '$(FAKETIME) i0' a2x -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw + echo $@ .tmpl.xsl: xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl -- cgit v1.2.3 From ff5faf1cc710b7e9299dcaec719bc2421f4ca5b4 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sat, 6 Oct 2018 20:21:07 -0700 Subject: altoslib: Change map loading to lat=&lon= from center= This is easier to parse. Signed-off-by: Keith Packard --- altoslib/AltosMapStore.java | 2 +- doc/map-loading.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/altoslib/AltosMapStore.java b/altoslib/AltosMapStore.java index abd8c240..7e0f3fb8 100644 --- a/altoslib/AltosMapStore.java +++ b/altoslib/AltosMapStore.java @@ -57,7 +57,7 @@ public class AltosMapStore { } private static String altos_map_url(AltosLatLon center, int zoom, int maptype, int px_size, int scale, String format_string) { - return String.format("https://maps.altusmetrum.org/altos-map?center=%.6f,%.6f&zoom=%d", + return String.format("https://maps.altusmetrum.org/cgi-bin/altos-map?lat=%.6f&lon=%.6f&zoom=%d", center.lat, center.lon, zoom); } diff --git a/doc/map-loading.txt b/doc/map-loading.txt index 3dffcd04..1b39dd6b 100644 --- a/doc/map-loading.txt +++ b/doc/map-loading.txt @@ -89,7 +89,7 @@ server. The elements of the elements are: Encoding this in a URI is straightforward: -\ altos-map?center=,&zoom= +\ altos-map?lat=&lon=&zoom= Latitude and longitude are both encoded using decimal degrees with 6 digits following the decimal point. -- cgit v1.2.3 From 7f5cdd0aeb68104f474ad1736360df39dd174006 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sun, 7 Oct 2018 14:26:27 -0700 Subject: doc: Note that 1.8.7 fixes map images Signed-off-by: Keith Packard --- doc/altusmetrum-docinfo.xml | 2 +- doc/release-notes-1.8.7.inc | 2 ++ doc/telegps-docinfo.xml | 10 +++++++++- 3 files changed, 12 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 2f8b69fb..114c155c 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -51,7 +51,7 @@ 6 Oct 2018 Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF - calibration to factory value when reflashing. + calibration to factory value when reflashing. Fix map images. diff --git a/doc/release-notes-1.8.7.inc b/doc/release-notes-1.8.7.inc index e6837232..19d9c29b 100644 --- a/doc/release-notes-1.8.7.inc +++ b/doc/release-notes-1.8.7.inc @@ -25,6 +25,8 @@ * Add documentation about forcing TeleMini RF parameters to known values. + * Create a proxy server for Google Maps to re-enable map images + == MicroPeak * Poll for new devices while Device dialog is displayed diff --git a/doc/telegps-docinfo.xml b/doc/telegps-docinfo.xml index 5e347cfd..68a1d2d8 100644 --- a/doc/telegps-docinfo.xml +++ b/doc/telegps-docinfo.xml @@ -10,7 +10,7 @@ keithp@keithp.com - 2015 + 2018 Bdale Garbee and Keith Packard @@ -37,6 +37,14 @@ + + 1.8.7 + 07 Oct 2018 + + Fix TeleBT v4.0 RF calibration to factory value when + reflashing. Fix map images. + + 1.8.3 11 Dec 2017 -- cgit v1.2.3 From 625981b96e99a5dbec8180016d5e2c291378a21f Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sun, 7 Oct 2018 23:31:04 -0700 Subject: doc: Note fixes for Mac OS X Signed-off-by: Keith Packard --- doc/altusmetrum-docinfo.xml | 3 ++- doc/micropeak-docinfo.xml | 4 ++-- doc/release-notes-1.8.7.inc | 11 +++++++---- doc/telegps-docinfo.xml | 4 ++-- 4 files changed, 13 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 114c155c..18bc644d 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -48,10 +48,11 @@ 1.8.7 - 6 Oct 2018 + 8 Oct 2018 Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF calibration to factory value when reflashing. Fix map images. + Fix Mac OS X support. diff --git a/doc/micropeak-docinfo.xml b/doc/micropeak-docinfo.xml index f4d9eaff..6fab12b8 100644 --- a/doc/micropeak-docinfo.xml +++ b/doc/micropeak-docinfo.xml @@ -33,9 +33,9 @@ 1.8.7 - 6 October 2018 + 8 October 2018 - Poll for MicroPeak USB while the device dialog is open. + Poll for MicroPeak USB while the device dialog is open. Fix Mac OS X support. diff --git a/doc/release-notes-1.8.7.inc b/doc/release-notes-1.8.7.inc index 19d9c29b..f8b7b103 100644 --- a/doc/release-notes-1.8.7.inc +++ b/doc/release-notes-1.8.7.inc @@ -8,7 +8,7 @@ * Include TeleMega v3.0 firmware - == AltosUI, TeleGPS + == AltosUI, TeleGPS, MicroPeak * Poll for new devices while Device dialog is displayed @@ -25,10 +25,13 @@ * Add documentation about forcing TeleMini RF parameters to known values. - * Create a proxy server for Google Maps to re-enable map images + * Create a proxy server for Google Maps to re-enable map + images - == MicroPeak + * Fix Java version info in all distributed jar files so that + applications will run with standard Mac OS X Java. - * Poll for new devices while Device dialog is displayed + * Replace JavaApplicationStub for Mac OS X so that + applications will run with Oracle Java. diff --git a/doc/telegps-docinfo.xml b/doc/telegps-docinfo.xml index 68a1d2d8..4d3533de 100644 --- a/doc/telegps-docinfo.xml +++ b/doc/telegps-docinfo.xml @@ -39,10 +39,10 @@ 1.8.7 - 07 Oct 2018 + 08 Oct 2018 Fix TeleBT v4.0 RF calibration to factory value when - reflashing. Fix map images. + reflashing. Fix map images. Fix Mac OS X support. -- cgit v1.2.3 From 88ae4c5ebd64215f05f5efc18f9660560b409ace Mon Sep 17 00:00:00 2001 From: Bdale Garbee Date: Mon, 8 Oct 2018 16:27:33 -0600 Subject: doc: correct specs for TeleMega v3.0, which still uses the MMA6555 --- doc/specs.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/specs.inc b/doc/specs.inc index 430c8789..1b7ea74b 100644 --- a/doc/specs.inc +++ b/doc/specs.inc @@ -108,7 +108,7 @@ |TeleMega v3.0 |MS5607 30km (100k') - |ADXL375 200g + |MMA6555 102g |uBlox Max-7Q |MPU9250 |8MB -- cgit v1.2.3