annotate Documentations/GPL_template.txt @ 471:73da921869d9 fix-bat-2

bugfix: implement battery charge percentage in dive header This commit is (much) less trivial than the related 919e5cb51c92. First, rename the CCRmode attribute (corresponding to byte Ox59) of the SLogbookHeaderOSTC3. This byte (according to the hwOS interface document) does not contain any CCR related value, but it contains "battery information". Already since 2017, this byte is used from libdivecomputer to interface the charge percentage. So, its renamed from CCRmode to batteryCharge, to reflect its true purpose. Now, simply add a batteryCharge attribute to the SLogbookHeader (and see below why that is possible, without breaking things). The remaining changes are trivial to implement battery charge percentage in dive header. Caveat: do not get confused by the exact role of the individual logbook header types. SLogbookHeaderOSTC3 is the formal type of the logbook format that the OSTC4 produces. This format is supposed to identical to the format, as is used in hwOS for the series of small OSTCs. Only some values of attributes are different. For example, the OSTC4 supports VPM, so byte 0x79 (deco model used for this dive) also has a value for VPM. But the SLogbookHeader type, despite its name and structure, is *not* a true logbook header, as it includes attributes that are not available in the SLogbookHeaderOSTC3 formal header type. Signed-off-by: Jan Mulder <jan@jlmulder.nl>
author Jan Mulder <jlmulder@xs4all.nl>
date Wed, 22 Apr 2020 13:08:57 +0200
parents 6237372f76a4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
2 /// -*- coding: UTF-8 -*-
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
3 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
4 /// \file $file
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
5 /// \brief $brief
35
6237372f76a4 ... more GPL License and general cleanups
jDG@sauge
parents: 31
diff changeset
6 /// \author Heinrichs Weikamp gmbh
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
7 /// \date $date
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
8 ///
31
da118222e18b [ADD]Discovery/Src licences, plus reindentation
jDG@sauge
parents: 29
diff changeset
9 /// \details
da118222e18b [ADD]Discovery/Src licences, plus reindentation
jDG@sauge
parents: 29
diff changeset
10 ///
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
11 /// $Id$
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
12 ///////////////////////////////////////////////////////////////////////////////
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
13 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
14 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
15 /// This program is free software: you can redistribute it and/or modify
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
16 /// it under the terms of the GNU General Public License as published by
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
17 /// the Free Software Foundation, either version 3 of the License, or
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
18 /// (at your option) any later version.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
19 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
20 /// This program is distributed in the hope that it will be useful,
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
21 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
22 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
23 /// GNU General Public License for more details.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
24 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
25 /// You should have received a copy of the GNU General Public License
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
26 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
27 //////////////////////////////////////////////////////////////////////////////