Mercurial > public > ostc4

view Discovery/Inc/tMenuEdit.h @ 471:73da921869d9 fix-bat-2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 5f11787b4f42
children 21bf40bb8151
line wrap: on
line source

///////////////////////////////////////////////////////////////////////////////
/// -*- coding: UTF-8 -*-
///
/// \file   Discovery/Inc/tMenuEdit.h
/// \brief  Header file for Menu Setting Modifications
/// \author heinrichs weikamp gmbh
/// \date   04-July-2014
///
/// $Id$
///////////////////////////////////////////////////////////////////////////////
/// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
///
///     This program is free software: you can redistribute it and/or modify
///     it under the terms of the GNU General Public License as published by
///     the Free Software Foundation, either version 3 of the License, or
///     (at your option) any later version.
///
///     This program is distributed in the hope that it will be useful,
///     but WITHOUT ANY WARRANTY; without even the implied warranty of
///     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
///     GNU General Public License for more details.
///
///     You should have received a copy of the GNU General Public License
///     along with this program.  If not, see <http://www.gnu.org/licenses/>.
//////////////////////////////////////////////////////////////////////////////

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef TMENU_EDIT_H
#define TMENU_EDIT_H

/* Includes ------------------------------------------------------------------*/
#include "tMenu.h"

#define ME_Y_LINE1					(70)
#define ME_Y_LINE_STEP			(65)
#define ME_Y_LINE_BASE			(ME_Y_LINE1 - ME_Y_LINE_STEP)
#define ME_Y_LINE2					(ME_Y_LINE1 + (1 * ME_Y_LINE_STEP))
#define ME_Y_LINE3					(ME_Y_LINE1 + (2 * ME_Y_LINE_STEP))
#define ME_Y_LINE4					(ME_Y_LINE1 + (3 * ME_Y_LINE_STEP))
#define ME_Y_LINE5					(ME_Y_LINE1 + (4 * ME_Y_LINE_STEP))
#define ME_Y_LINE6					(ME_Y_LINE1 + (5 * ME_Y_LINE_STEP))

#define EXIT_TO_INFO_COMPASS 		(248)
#define EXIT_TO_MENU_WITH_LOGO	(249)
#define EXIT_TO_HOME 						(250)
#define EXIT_TO_MENU 						(251)
#define UPDATE_DIVESETTINGS 		(252)
#define UPDATE_AND_EXIT_TO_HOME (253)
#define UPDATE_AND_EXIT_TO_MENU (255)
#define UNSPECIFIC_RETURN				(254)

void sendActionToMenuEdit(uint8_t sendAction);

void tMenuEdit_init(void);
void resetMenuEdit(uint8_t color);
void tMenuEdit_refresh_live_content(void);
void tMenuEdit_refresh_field(uint32_t editID);

void evaluateNewString	(uint32_t editID, uint32_t *pNewValue1, uint32_t *pNewValue2, uint32_t *pNewValue3, uint32_t *pNewValue4);
void tMenuEdit_newInput	(uint32_t editID, uint32_t int1, uint32_t int2, uint32_t int3, uint32_t int4);
void tMenuEdit_newButtonText(uint32_t editID, char *text);
void tMenuEdit_set_on_off(uint32_t editID, uint32_t int1);

void write_label_fix(uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle,  const tFont *Font, const char textId);
void write_label_var(uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle,  const tFont *Font, const char *text);

void clean_content(uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle,  const tFont *Font);
void write_content(uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle,  const tFont *Font, const char *text, uint8_t color);

void write_topline( char *text);
void write_buttonTextline( uint8_t left2ByteCode, char middle2ByteCode, char right2ByteCode);
void write_field_udigit(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint32_t int1,  uint32_t int2,  uint32_t int3,  uint32_t int4);
void write_field_2digit(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint32_t int1,  uint32_t int2,  uint32_t int3,  uint32_t int4);
void write_field_3digit(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint32_t int1,  uint32_t int2,  uint32_t int3,  uint32_t int4);
void write_field_select(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint8_t int1,  uint8_t int2,  uint8_t int3,  uint8_t int4);
/*void write_field_sdigit(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, int32_t int1,  int32_t int2,  int32_t int3,  int32_t int4);*/
void write_field_button(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text);
void write_field_symbol(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint8_t int1);
void write_field_toggle(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint8_t int1,  uint8_t int2);
void write_field_on_off(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, uint8_t int1);
void write_field_fpoint(uint32_t editID, uint16_t XleftGimpStyle, uint16_t XrightGimpStyle, uint16_t YtopGimpStyle, const tFont *Font, const char *text, float input);

void stop_cursor_fields(void);

void setEvent(uint32_t inputEventID, uint32_t inputFunctionCall);
void resetEnterPressedToStateBeforeButtonAction(void);

void setBackMenu(uint32_t inputFunctionCall, uint8_t functionCallParameter, uint8_t gotoMenuEditField);
void exitMenuEdit_to_BackMenu(void);

void startEdit(void);
void exitEditWithUpdate(void);
void exitMenuEdit_to_Home(void);
void exitMenuEdit_to_Home_with_Menu_Update(void);
void exitMenuEdit_to_Menu_with_Menu_Update(void);
void exitMenuEdit_to_Menu_with_Menu_Update_do_not_write_settings_for_this_only(void);

void tMenuEdit_writeSettingsToFlash(void);

#endif /* TMENU_EDIT_H */