[PATCH][User-Manual][Companion-app]-Minor-changes-on-app-and-manual.patch

[Dirk Hohndel]

Salvador,

I have some questions about the changes to the manual...

On Tue, 2014-04-22 at 20:14 +0200, Salvador Cuñat wrote:
> Subsurface companion is, basically, the same from last Subsurface release, it's only 
> been added with the map feature which is depicted here.
> 
> Distance between positions takes precedence over time between them,
> so you can have positions faster than one each period set in the
> "Min Duration" setting.
> Actually this setting seems useless as you won't have a fix each
> period if distance is under "Min distance".
> 
> Lesser changes in manual involving Background Service, the dificulty on matching times
> and little personal recomendations.
> 
> 
> Signed-off-by: Salvador Cuñat <salvador.cunat at gmail.com>
> ---
>  Documentation/user-manual.txt |   55 ++++++++++++++++++++++++++++++++---------
>  1 file changed, 44 insertions(+), 11 deletions(-)
> 
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index d9c1acd..a4f709c 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -1084,6 +1084,19 @@ _Subsurface_ dive log whenever users upload or add dives to _Subsurface_.
>  After a dive trip using the Companion app, all dive locations are ready to be
>  saved on a _Subsurface_ dive log (see below).
>  
> +When you click on a dive (*not* selecting the check button as shown in the images above), the
> +name given to it, date/time and GPS coordinates will be shown, and you'll have two options:
> +
> +- Edit:  Lets you change the name given to the dive point.
> +
> +- Maps:  Will display a map showing the dive locatión (you'll be prompted to

did you mean "location" ?

> +choose which auxiliar app use from your installed apps). At this date this feature is

auxiliary or maybe just "helper app to use"

> +a bit of a proof of concept, is expected to be fully functional by end of
> +May/2014.

I wouldn't give a hard date like that :-)


> +
> +If you edit the dive, after saving it, you'll need to upload it to the web
> +service, as explained above.
> +
>  ===== Settings on the Companion app
>  
>  Selecting the _Settings_ menu option results in the right hand image above (*C*).
> @@ -1174,20 +1187,40 @@ image::images/DownloadGPS.jpg["FIGURE: Downloading Companion app GPS data",align
>  Note that the _Apply_ button is now active. By clicking on it, users can update the locations
>  of the newly entered or uploaded dives in _Subsurface_ which applies the
>  coordinates and names entered on the app for all the new dives that match the
> -date-times of the uploaded GPS localities.
> +date-times of the uploaded GPS localities. If you had hand-writen the name of the dive

maybe "entered" instead of "hand-written"

> +location in _Subsurface_ before downloading the GPS coordinates, this one will take
> +precedence over downloaded one.
> +
> +Since _Subsurface_ matches GPS locations from the Android device and dive information from the
> +dive computer based on date-time data, automatic assignment of GPS data to dives is dependent
> +on agreement of date and time between these two devices. If there is a large difference between
> +the time in the dive computer and the time in the Android device, although _Subsurface_ has a
> +wide range tolerance, it may be unable to identify the dive matching a location and nothing
> +happens.
> +
> +Similar date-times may not always be possible, and there may be many different reasons for this, or
> +_Subsurface_ may be unable to decide which is the correct position for a dive (e.g. on repetitive
> +dives while running _background service_ you may end with a lot of position fixes that would be
> +included in the time range that fit not only for first dive, but for second too).
> +
> +A dirty hack around this is manually editing the date-time of a dive in Subsurface's

You meant to say "A workaround for this situation is to manually
edit..." :-)

> +Dive List _before_ downloading the GPS data and then to edit the date-time back again _after_
> +downloading GPS data.
>  
>  [icon="images/icons/info.jpg"]
>  [NOTE]
> -_Features, issues and tips._  Since _Subsurface_ matches GPS locations from the
> -Android device and dive information from the dive computer based on date-time
> -data, automatic assignment of GPS data to dives is dependent on agreement of
> -date and time between these two devices. If there is a large difference between
> -the time in the dive computer and the time in the Android device,
> -_Subsurface_ is unable to identify the dive matching a location and nothing
> -happens. Similar date-times may be not always be possible.  A dirty hack is
> -manually editing the date-time of a dive in Subsurface's Dive List _before_
> -downloading the GPS data and then to edit the date-time back again _after_
> -downloading GPS data.
> +TIPS:
> +
> +- _Background service_, being a very powerful tool, may fill your register in web service with
> +lots of annoying fake coordinates. These coordinates are, today, dificult and bothering to
> +delete from the server. Is strongly recomended you make a clean up in your android device
> +before sending the dive points to the web server, by simply deleting the fake positions in the
> +device.
> +
> +- Same way, I would recommend to give significant names to the dives sent to the web server, or
> +, at least, use a significant name in the _Name Template_ setting while running _background service_,
> +especially if you are in a dive trip and you are piling up lots of dives and dive points waiting to
> +come back home to download them to _Subsurface_.

And the last section called TIPS... I simply disagree with what you
write there. People who use the background service don't use the
companion app the way you envision. I have several hundred records in my
companion app because I frequently let it simply run all day. The
coordinates aren't "fake" - they are real coordinates at certain time.
There is no reason to trim the list and delete any of those. That's the
whole point. Subsurface does the right thing and finds the matching
location based on time stamps. I don't want to suggest to users that
they need to do that manually - that takes the whole usefulness of the
companion app in background mode away!

/D