Documentation and release 1.1.0

Author: martinber

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "noaa-apt"
-version = "1.0.1-dev"
+version = "1.1.0"
 authors = ["Martin Bernardi <martinber.710@gmail.com>"]
 build = "src/build.rs"
 

Cargo.toml

@@ -1,3 +1,12 @@
+noaa-apt (1.1.0-1) testing; urgency=medium
+
+  * GUI tool for editing file modification timestamps.
+  * Preserve file modification timestamps when resampling.
+  * Fixed Usage and Guide GUI buttons on Windows.
+  * Fixed progress bar on resample mode.
+
+ -- Martin Bernardi <martin@mbernardi.com.ar>  Sun, 19 May 2019 14:52:20 -0300
+
 noaa-apt (1.0.0-1) testing; urgency=medium
 
   * Fixed truncation issues on Raspberry Pi and 32 bit systems.
@@ -10,7 +19,7 @@ noaa-apt (1.0.0-1) testing; urgency=medium
   * Added checks against overflows when using strange sample rates.
   * Added static OpenSSL as a Cargo feature.
 
- -- Martin Bernardi <mbernardi@mbernardi-pc>  Sun, 07 Apr 2019 22:48:20 -0300
+ -- Martin Bernardi <martin@mbernardi.com.ar>  Sun, 07 Apr 2019 22:48:20 -0300
 
 noaa-apt (0.9.8-1) testing; urgency=medium
 
@@ -21,7 +30,7 @@ noaa-apt (0.9.8-1) testing; urgency=medium
   * Better font for GUI on Windows.
   * Small fixes and improvements.
 
- -- Martin Bernardi <mbernardi@mbernardi-pc>  Sat, 23 Feb 2019 20:08:25 -0300
+ -- Martin Bernardi <martin@mbernardi.com.ar>  Sat, 23 Feb 2019 20:08:25 -0300
 
 noaa-apt (0.9.7+dev-1) testing; urgency=medium
 

debian/changelog

@@ -80,9 +80,6 @@ Notes:
     - Wait for new release of gtk-rs and point dependencies on `Cargo.toml` to
       crates.io instead of git.
 
-    - show time zone on GUI, explain Linux commands
-      on the documentation, explain the feature everywhere on the documentation.
-
     - Log everything to a file, especially for Windows since it doesn't have a
       console to see output.
 
@@ -107,6 +104,8 @@ Notes:
 
 - Someday:
 
+    - Show telemetry bands on GUI.
+
     - Investigate about despeckle.
 
     - Make OSX binaries, I don't have a Mac. I should cross-compile or get a virtual

docs/development.md

@@ -72,9 +72,9 @@ installed what you need:
 My builds use a statically linked libssl, so you don't need libssl unless you
 compiled noaa-apt yourself.
 
-[amd64_deb]: https://github.com/martinber/noaa-apt/releases/download/v1.0.0/noaa-apt_1.0.0-1_amd64.deb
-[x86_64_windows_gnu_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.0.0/noaa-apt-1.0.0-x86_64-windows-gnu.zip
-[x86_64_linux_gnu_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.0.0/noaa-apt-1.0.0-x86_64-linux-gnu.zip
-[x86_64_linux_gnu_nogui_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.0.0/noaa-apt-1.0.0-x86_64-linux-gnu-nogui.zip
-[armv7_linux_gnueabihf_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.0.0/noaa-apt-1.0.0-armv7-linux-gnueabihf.zip
-[armv7_linux_gnueabihf_nogui_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.0.0/noaa-apt-1.0.0-armv7-linux-gnueabihf-nogui.zip
+[amd64_deb]: https://github.com/martinber/noaa-apt/releases/download/v1.1.0/noaa-apt_1.1.0-1_amd64.deb
+[x86_64_windows_gnu_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.1.0/noaa-apt-1.1.0-x86_64-windows-gnu.zip
+[x86_64_linux_gnu_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.1.0/noaa-apt-1.1.0-x86_64-linux-gnu.zip
+[x86_64_linux_gnu_nogui_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.1.0/noaa-apt-1.1.0-x86_64-linux-gnu-nogui.zip
+[armv7_linux_gnueabihf_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.1.0/noaa-apt-1.1.0-armv7-linux-gnueabihf.zip
+[armv7_linux_gnueabihf_nogui_zip]: https://github.com/martinber/noaa-apt/releases/download/v1.1.0/noaa-apt-1.1.0-armv7-linux-gnueabihf-nogui.zip

docs/download.md

@@ -154,21 +154,17 @@ If you want to decode your WAV file on WXtoIMG:
 
 - Select _Satellite > NOAA_.
 
-- Select _Options > Disable map overlay_ because it's going to be wrong unless
-    you correct the timestamp of the file.
+- Select _Options > Disable map overlay_ because it could be wrong if you have a
+    wrong timestamp on your file.
 
 - _File > Decode_.
 
 If you want map overlay:
 
-- If you resampled the WAV file, the modification timestamp of the new file
-    should be the moment of the end of the pass. Check with `stat file.wav`.
-
-    - Generally you just have to copy the timestamp from the old file to the new
-        one using: `touch -r original_file.wav resampled_file.wav`.
-
-    - You can also set any timestamp you want with
-       `touch -d "2019-01-31 18:31:20.579283000" resampled_file.wav`.
+- The modification timestamp of the new file should be the moment of the end of
+    the pass. If you resampled the file using noaa-apt it should be OK,
+    otherwise change it if necessary using the noaa-apt GUI or using your
+    terminal.
 
 - Uncheck _Options > Disable map overlay_.
 

docs/guide.md

@@ -23,19 +23,9 @@ <h2>Receive and decode images from weather satellites</h2>
 			</header>
 
 			<p>
-				You can buy a
-				<a href="https://osmocom.org/projects/rtl-sdr/wiki/Rtl-sdr">RTL-SDR</a>
-				for less than 30USD, it looks like a USB drive but it has a connector
-				for antennas. Using SDR software like <em>GQRX</em> and <em>SDR#</em>
-				you can receive FM signals, for example broadcast FM (around 100MHz) or
-				better, APT signals from NOAA satellites (around 137MHz).
-			</p>
-
-			<p>
-				<em>noaa-apt</em> takes a recorded WAV file (from <em>GQRX</em>,
-				<em>SDR#</em>, etc.) and decodes the image. As an example,
-				<a href="{{ site.baseurl }}/examples/argentina.wav">
-					this is a WAV file I recorded using GQRX</a>
+				<em>noaa-apt</em> takes a recorded WAV file and decodes the image. As an
+				example,
+				<a href="{{ site.baseurl }}/examples/argentina.wav"> this is a WAV file I recorded using GQRX</a>
 				using a RTL-SDR and a double cross antenna.
 				When loading that file on <em>noaa-apt</em>, you get as a result
 				<a href="{{ site.baseurl }}/examples/argentina.png">this image</a>.
@@ -44,7 +34,17 @@ <h2>Receive and decode images from weather satellites</h2>
 			<h3>Why?</h3>
 
 			<p>
-				NOAA satellite reception is fun, cheap and relatively easy. I made
+				NOAA satellite reception is fun, cheap and relatively easy. You can buy
+				a <a href="https://osmocom.org/projects/rtl-sdr/wiki/Rtl-sdr">RTL-SDR</a>
+				for less than 30USD, it looks like a USB drive but it has a connector
+				for antennas. Using SDR software like <em>GQRX</em> and <em>SDR#</em>
+				you can receive FM signals, for example broadcast FM (around 100MHz) or
+				better, receive APT signals from NOAA satellites (around 137MHz) and
+				then decode them with <em>noaa-apt</em>.
+			</p>
+
+			<p>
+				I made
 				<em>noaa-apt</em> because <em>WXtoIMG</em>, the most popular decoding
 				software, it's propietary and
 				<a href="https://www.rtl-sdr.com/notice-wxtoimg-website-down/">no longer maintained</a>,
@@ -56,6 +56,14 @@ <h3>Why?</h3>
 				are not that obvious.
 			</p>
 
+			<p>
+				<em>WXtoIMG</em> requires WAV files with a sample rate of 11025Hz, also
+				needs correct file modification timestamps for post processing. For
+				convenience, you can use <em>noaa-apt</em> for resampling your files to
+				any sample rate preserving the timestamps. <em>noaa-apt</em> also
+				includes a tool that allows to set arbitrary timestamps on your files
+			</p>
+
 			<p>
 				There are lots of really good
 				<a href="{{ site.baseurl }}/alternatives.html">Alternatives</a>, but all
@@ -68,22 +76,35 @@ <h3>Why?</h3>
 			<h3>Disadvantages</h3>
 
 			<p>
-				WXtoIMG has lots of features you might want that noaa-apt does not have,
-				for example false-color images, live decoding or map overlay. Anyways,
-				the quality of the black and white image should be the same.
+				<em>WXtoIMG</em> has lots of features you might want that
+				<em>noaa-apt</em> does not have, for example false-color images, live
+				decoding or map overlay. Anyways, the quality of the black and white
+				image should be the same.
 			</p>
 
 			<p>
-				If you get some kind of error or bad result don't hesitate to open a
-				Issue or to send me an email. Also I'm not a native english speaker so
-				please correct me. Both the code and the website is on the
+				If you get some kind of error or bad result open a Issue or send me an
+				email. Also I'm not a native english speaker so please let me know where
+				I made mistakes. Both the code and the website is on the
 				<a href="https://github.com/martinber/noaa-apt">GitHub repository</a>.
 			</p>
 
 			<h3>Screenshot</h3>
 
 			<img src="images/gui.png" alt="GUI"/>
 
+			<h3>Features</h3>
+
+			<ul>
+				<li>Decode raw images from WAV files.</li>
+				<li>Really easy to use GUI.</li>
+				<li>You can disable syncing and export every step of the decoding
+					process, useful for corrupted recordings.</li>
+				<li>Telemetry band reading.</li>
+				<li>Resample WAV files preserving modification timestamps.</li>
+				<li>Modify timestamps of files.</li>
+				<li>Edit filter parameters from a configuration file.</li>
+			</ul>
 
 			<!-- Content -->
 			<!--

docs/index.html

@@ -34,6 +34,13 @@ On _Tools > Resample WAV_ you can resample a WAV into another WAV, this is
 useful if you want to try a program like [WXtoIMG] or [atp-dec/apt-dec] that
 requires a specific sample rate.
 
+On _Tools > Timestamp WAV_ you can change the modification date and time present
+on the metadata of a file. Useful when you want to decode a WAV file on
+[WXtoIMG] and you need to change the timestamp to fix the map overlay. You can
+load a timestamp from another file in the case you want to copy the timestamp
+from one file to another. Otherwise just select time, date and write the
+timestamp to your WAV recording.
+
 ![GUI]({{ site.baseurl }}/images/gui.png)
 
 ### Terminal
@@ -76,6 +83,18 @@ Optional arguments:
                         will be decoded.
 ```
 
+If resampling, the modification timestamp should be preserved correctly.
+
+The timestamp modification tool is only available via the GUI, if you need to
+set arbitrary timestamps to files using the terminal use your OS commands. On
+GNU/Linux:
+
+- Generally you just have to copy the timestamp from one file to another
+    one using: `touch -r reference_file.wav recording.wav`.
+
+- Set any timestamp you want with
+    `touch -d "2019-01-31 18:31:20.579283000" recording.wav`.
+
 ## Advanced settings
 
 ### Disable syncing

docs/usage.md

@@ -1 +1 @@
-1.0.0
+1.1.0

docs/version_check

@@ -1,20 +1,20 @@
 id ICON "icon.ico"
 1 VERSIONINFO
-FILEVERSION     1,0,0,0
-PRODUCTVERSION  1,0,0,0
+FILEVERSION     1,1,0,0
+PRODUCTVERSION  1,1,0,0
 BEGIN
 BLOCK "StringFileInfo"
 BEGIN
     BLOCK "040904E4"
     BEGIN
         VALUE "CompanyName", "Martin Bernardi"
         VALUE "FileDescription", "noaa-apt image decoder"
-        VALUE "FileVersion", "1.0.0"
+        VALUE "FileVersion", "1.1.0"
         VALUE "InternalName", "noaa-apt"
         VALUE "LegalCopyright", "Martin Bernardi"
         VALUE "OriginalFilename", "noaa-apt.exe"
         VALUE "ProductName", "noaa-apt"
-        VALUE "ProductVersion", "1.0.0"
+        VALUE "ProductVersion", "1.1.0"
     END
 END
 BLOCK "VarFileInfo"