ostc_companion: HardwareOperations.h annotate

annotate HardwareOperations.h @ 1:0b3630a29ad8

Initial version based on previous repository. Project was ported to QT6 and in now cmake based.

author	Ideenmodellierer <tiefenrauscher@web.de>
date	Thu, 27 Nov 2025 18:40:28 +0100
parents
children

rev	line source
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	1 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	2 /// \file HardwareOperations.h
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	3 /// \brief API for HW dive computer drivers.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	4 /// \author JD Gascuel.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	5 /// \sa OSTC3Operations.h
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	6 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	7 /// \copyright (c) 2011-2016 JD Gascuel. All rights reserved.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	8 /// $Id$
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	9 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	10 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	11 // BSD 2-Clause License:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	12 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	13 // Redistribution and use in source and binary forms, with or without
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	14 // modification, are permitted provided that the following conditions
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	15 // are met:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	16 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	17 // 1. Redistributions of source code must retain the above copyright notice,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	18 // this list of conditions and the following disclaimer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	19 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	20 // 2. Redistributions in binary form must reproduce the above copyright notice,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	21 // this list of conditions and the following disclaimer in the documentation
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	22 // and/or other materials provided with the distribution.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	23 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	25 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	26 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	27 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	28 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	29 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	30 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	31 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	32 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	33 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	34 // THE POSSIBILITY OF SUCH DAMAGE.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	35 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	36 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	37 // HISTORY
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	38 // 2012-09-22 : [jDG] Initial version, made for OSTC Companion.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	39 // 2014-07-07 : [jDG] Cleanups for Subsurface google-summer-of-code.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	40 // 2014-07-25 : [jDG] BSD 2-clause license.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	41 // 2016-07-14 : ÍjDG] Adding codes for hardware variants of OSTC2/3/4.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	42
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	43 #ifndef HARDWARE_OPERATIONS_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	44 #define HARDWARE_OPERATIONS_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	45
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	46 #include <QDateTime>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	47 #include <QImage>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	48 #include <QString>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	49 #include <QStringList>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	50 #include <QSize>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	51 #include <QRegularExpression>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	52
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	53 #ifdef TEST_MODE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	54 # include "test/SerialTest.h"
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	55 #else
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	56 # include "Serial.h"
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	57 #endif
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	58
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	59 class HexFile;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	60
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	61 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	62 /// \brief API for HW dive computer drivers.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	63 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	64 /// This class include high level commands used by the Companion GUI,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	65 /// and other generic services:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	66 /// - List of currently known serial ports:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	67 /// listBluetoothPorts() or listUSBPorts().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	68 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	69 /// - Send a command, and wait for the proper acknowledge: retryCommand().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	70 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	71 /// \sa OSTCFrogOperations, OSTC2cOperations, OSTC3Operations,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	72 /// \nosubgrouping
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	73 class HardwareOperations
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	74 {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	75 protected:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	76 #ifdef TEST_MODE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	77 /// \brief Fake communication port used for mockup operations.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	78 SerialTest _serial;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	79 #else
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	80 /// \brief Communication port used for all I/O operations.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	81 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	82 /// Note that in emulation mode, aka TEST_MODE, this is replaced by
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	83 /// an instance of SerialTest.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	84 Serial _serial;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	85 #endif
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	86
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	87 public:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	88 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	89 /// \name Class management
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	90 /// \{
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	91 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	92 /// Managing the hierarchy of driver classes used to handle the various
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	93 /// existing H&W devices.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	94
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	95 /// \brief mandatory (and empty) virtual descructor in the base class.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	96 virtual ~HardwareOperations() {}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	97
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	98 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	99 /// \brief The name of the computer driver.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	100 /// \returns the name of a particular driver implementation,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	101 /// eg. "OSTCSport", "OSTC2c", "OSTC3", ...
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	102 virtual QString model() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	103
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	104 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	105 /// \brief Gives access to serial port in use.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	106 /// Used for other high and low level operations, eg. in OSTC Planner.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	107 inline Serial& serial() { return _serial; }
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	108
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	109 /// \}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	110 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	111 /// \name Introspection
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	112 /// \{
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	113 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	114 /// Methods available to ask the connected device what it does support,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	115 /// and how to manage it.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	116
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	117 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	118 /// \brief Optional features present in the dive computer hardware.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	119 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	120 /// 8 bit mask. See HardwareDescriptor for known combinations.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	121 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	122 enum HardwareOption {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	123 HW_CHARGEABLE_BATTERY= 0x01, ///< Recharge option.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	124 HW_LIGHT_SENSOR = 0x02, ///< Detects light level, and tune screen.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	125 HW_S8_COM = 0x04, ///< Analog connector to O2 cells.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	126 HW_OPTICAL_COM = 0x08, ///< Digital connector to O2 cells.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	127 HW_BLUETOOTH_COM = 0x10, ///< Bluetooth, hence no USB connection.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	128 HW_DUALCORE = 0x20, ///< Dual core processor.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	129 };
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	130
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	131 ///-----------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	132 /// \brief Dive computer set of features.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	133 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	134 /// Set of features present on a given H&W dive computers.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	135 /// \note that several versions exists of a given computer, and there
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	136 /// is not a uniq mapping of a given feature set to a dive computer
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	137 /// (eg. 0x13 is ambiguous).
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	138 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	139 enum HardwareDescriptor {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	140 HW_UNKNOWN_OSTC = 0,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	141 HW_Frog = HW_BLUETOOTH_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	142 HW_OSTCSport_a = HW_LIGHT_SENSOR \| HW_BLUETOOTH_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	143 HW_OSTCSport_b = HW_OSTCSport_a \| HW_CHARGEABLE_BATTERY,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	144 HW_OSTC2c = HW_CHARGEABLE_BATTERY,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	145 HW_OSTC2_a = HW_CHARGEABLE_BATTERY \| HW_BLUETOOTH_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	146 HW_OSTC2_b = HW_OSTCSport_b,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	147 HW_OSTC2_c = HW_OSTC2_b \| HW_OPTICAL_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	148 HW_OSTC3 = HW_LIGHT_SENSOR \| HW_OPTICAL_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	149 HW_OSTC3p_a = HW_LIGHT_SENSOR \| HW_OPTICAL_COM \| HW_BLUETOOTH_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	150 HW_OSTC3p_b = HW_OSTCSport_b,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	151 HW_OSTCcR_a = HW_CHARGEABLE_BATTERY \| HW_S8_COM,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	152 HW_OSTCcR_b = HW_OSTCcR_a \| HW_LIGHT_SENSOR,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	153 HW_OSTC4 = HW_DUALCORE\|HW_BLUETOOTH_COM\|
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	154 HW_OPTICAL_COM\|HW_LIGHT_SENSOR\|HW_CHARGEABLE_BATTERY
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	155 };
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	156
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	157 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	158 /// \brief Ask the connect device for its hardware options.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	159 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	160 /// This is used to guess the device model, even if there is no unicity.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	161 HardwareDescriptor hardwareDescriptor();
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	162
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	163 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	164 /// \brief Features supported by OSTC Companion on the connected device.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	165 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	166 /// Each driver (instance of this class) is requested to tell Companion
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	167 /// what are the supported command.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	168 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	169 enum CompanionFeatures {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	170 PARAMETERS = (1<<0), ///< Download/Edit/Upload various parameters.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	171 DATE = (1<<1), ///< Set date & time.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	172 NAME = (1<<2), ///< Set custom text displayed on main screen.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	173 ICON = (1<<3), ///< Set custom image displayed on main screen.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	174 DUMPSCREEN = (1<<4), ///< Makes copy of current screen.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	175 FIRMWARE = (1<<5), ///< Do firmware upgrades.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	176 HELIUM_DIVE = (1<<6), ///< Computes deco stops for trimix dives.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	177 CCR_DIVE = (1<<7), ///< Computes deco stops for rebreather dives.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	178 BLUETOOTH = (1<<8), ///< Use Bluetooh communication (instead of USB)
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	179 VPM_MODEL = (1<<9), ///< Also propose VPM deco stops.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	180 SIGNAL_CHECK = (1<<10) ///< Echo signal quality for bluetooth computer
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	181 };
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	182
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	183 /// \brief Tells what is supported for a given computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	184 virtual CompanionFeatures supported() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	185
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	186 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	187 /// \brief Length of the custom text displayed by the device.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	188 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	189 /// \returns (w,h), where \a w is text width (in chars), and \a h is the
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	190 /// number of lines.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	191 /// Used by Companion GUI to format user input.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	192 virtual QSize nameSize() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	193
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	194 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	195 /// \brief filename matching template for compatible firmware.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	196 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	197 /// Used by the Upgrade Firmware... command to propose only firmwares
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	198 /// designed for the connected device.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	199 virtual QString firmwareTemplate() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	200
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	201 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	202 /// \brief Read in the specific firmware file format.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	203 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	204 /// History is a bit complex here, and the published firmware have
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	205 /// different file formats (due to support tool, and/or need for
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	206 /// encryption).
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	207 /// So each driver have to implement its specific loader.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	208 virtual void loadFirmware(HexFile&, const QString& fileName) const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	209
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	210 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	211 /// \brief Regular expression to filter USB or Bluetooth port names.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	212 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	213 /// Used to propose only the list of ports that matches the serial ports
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	214 /// compatible with USB/Bluetooth emulation and the connected dive
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	215 /// computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	216 // virtual QRegExp portTemplate() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	217 virtual QRegularExpression portTemplate() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	218 /// \}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	219 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	220 /// \name High level commands
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	221 /// \{
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	222 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	223 /// Commands that implement the specific protocol for a device, to perform
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	224 /// all services needed by OSTC Copmanion.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	225
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	226 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	227 /// \brief Open download mode communication to the dive computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	228 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	229 /// Open comm port, start download mode, check the blessed reply,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	230 /// and get the computer identity (for description() ).
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	231 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	232 /// \note this mode allows common commands to be processed, but not
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	233 /// firmware upgrade.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	234 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	235 /// \returns TRUE is everything went well.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	236 /// \sa connectServiceMode() and disconnect().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	237 virtual bool connect() = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	238
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	239 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	240 /// \brief Open service mode communication to the dive computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	241 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	242 /// Open comm port, start service mode, check the blessed reply.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	243 /// \note this mode is mandatory to allow upgradeFW().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	244 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	245 /// \returns TRUE is everything went well.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	246 /// \sa connect() and disconnect().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	247 virtual void connectServiceMode() = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	248
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	249 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	250 /// \brief Echo a message on the connected device screen.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	251 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	252 /// Used on most devices to display commands as they are processed,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	253 /// so the user can see OSTC Companion is working properly, by seeing
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	254 /// progress on the dive computer itself.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	255 virtual void writeText(const QString& msg) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	256
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	257 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	258 /// \brief Set HW dive computer date and time.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	259 virtual void setDate(const QDateTime& date) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	260
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	261 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	262 /// \brief Set HW dive computer user text.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	263 virtual void setName(const QString& newName) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	264
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	265 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	266 /// \brief Display signal quality at OSTC.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	267 virtual void getSignal() = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	268
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	269 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	270 /// \brief Read all header from OSTC
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	271 virtual void getAllHeader(unsigned char* pBuffer) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	272
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	273 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	274 /// \brief Write all header from OSTC
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	275 virtual void writeAllHeader(unsigned char* pBuffer) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	276
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	277
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	278 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	279 /// \brief Read all samples from OSTC
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	280 virtual void getAllSamples(unsigned char* pBuffer) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	281
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	282 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	283 /// \brief Write all samples to OSTC
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	284 virtual void writeAllSamples(unsigned char* pBuffer) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	285
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	286 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	287 /// \brief Set HW dive computer icon set
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	288 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	289 /// Currently only supported by Frog dive computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	290 virtual void setIcons(const QString& fileName) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	291
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	292 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	293 /// \brief Take a snapshot of the connected computer's screen.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	294 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	295 /// Currently only supported by OSTC mk2/2n/2c dive computers.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	296 virtual QImage dumpScreen() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	297
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	298 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	299 /// \brief Upgrade HW dive computer firmware.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	300 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	301 /// \note needs service mode connection.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	302 /// \sa connectServiceMode().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	303 virtual void upgradeFW(const QString& fileName) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	304
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	305 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	306 /// \brief Close connection.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	307 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	308 /// Exit service mode, and close everything.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	309 /// \p closing should be set when ending Companion, so
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	310 /// an error make a won't crash if the interface is already
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	311 /// deleted.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	312 virtual bool disconnect(bool closing = false) = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	313
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	314 /// \}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	315 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	316 /// \name Low level protocol
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	317 /// \{
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	318 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	319 /// Command and methods that have to be implemented for each device
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	320 /// to retrieve device descriptions.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	321
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	322 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	323 /// \brief List all communication ports
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	324 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	325 /// That are (or might be) used by HW dive computers.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	326 virtual QStringList listPorts() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	327
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	328 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	329 /// \brief Send a command, wait ack, and retry on error.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	330 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	331 /// Service common to all current H&W dive computer: send a command byte,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	332 /// and wait it is dully acknowledged.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	333 /// Allow up to 10x retries when the computer does not answer anything,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	334 /// or reply something else.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	335 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	336 /// \param [in,out] serial: the connected port to use.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	337 /// \param [in] cmd: command byte to send.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	338 /// \param [in] retries: Optional max number of retries. Default to 10.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	339 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	340 /// \returns the ack byte (if any), or 0xFF if never received.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	341 static unsigned char retryCommand(Serial& serial,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	342 unsigned char cmd,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	343 int retries = 10);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	344
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	345 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	346 /// \brief Read and check connected dive computer identity.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	347 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	348 /// Read fw's version, serial number and custom text from connected computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	349 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	350 /// \throws when the connected device does not matches the driver
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	351 /// implementation.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	352 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	353 /// \sa description(), firmware(), serialNumber() and customtext().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	354 virtual void getIdentity() = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	355
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	356 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	357 /// \brief The fw's version found during the last getIdentty().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	358 /// \sa getIDentity().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	359 virtual int firmware() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	360
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	361 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	362 /// \brief The serial number found during the last getIdentty().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	363 /// \sa getIDentity().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	364 virtual int serialNumber() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	365
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	366 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	367 /// \brief The user-defined string found during the last getIdentty().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	368 /// \sa getIDentity().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	369 virtual QString customText() const = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	370
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	371 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	372 /// \brief A human readable description of connected computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	373 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	374 /// Returns driver name, and identity data found during the last call to
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	375 /// getIdentity().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	376 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	377 /// \sa model(), getIntentity()
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	378 virtual QString description() = 0;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	379
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	380 /// \}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	381 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	382
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	383 protected:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	384 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	385 /// \brief List serial ports for Bluetooth based devices.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	386 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	387 /// Ask OS for the list of Bluetooth serial emulations whose name
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	388 /// matches the portTemplate() regular expression.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	389 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	390 QStringList listBluetoothPorts() const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	391
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	392 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	393 /// \brief List serial ports for USB based devices.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	394 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	395 /// Ask OS for the list of USB serial emulation currently connected whose name
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	396 /// matches the portTemplate() regular expression.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	397 QStringList listUSBPorts() const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	398
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	399 };
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	400
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	401 #endif // COMPUTEROPERATIONS_H

Mercurial > public > ostc_companion

annotate HardwareOperations.h @ 1:0b3630a29ad8