ostc_companion: OSTC4Operations.h annotate

annotate OSTC4Operations.h @ 5:115cfa4a3239 default tip

Added icon upload function for OSTC 4/5 For the upload the same process as the one for the firmware update is used => CRC functionality has been copied from the ostc_pack SW

author	Ideenmodellierer
date	Tue, 30 Dec 2025 21:41:02 +0100
parents	0b3630a29ad8
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 OSTC4Operations.h
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	3 /// \brief Implementing various operations for H&W OSTC4 dive computer
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, HardwareOperations.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) 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 // 2015-09-28 jDG: Creation initial (RadioComm) version.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	39 // 2016-04-25 jDG: Final H&W version.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	40
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	41 #ifndef OSTC4_OPERATIONS_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	42 #define OSTC4_OPERATIONS_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	43
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	44 #include "OSTC3Operations.h"
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	45 #include <QRegularExpression>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	46
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	47 #include "AES/Adler16.h"
5 115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	48 #include "ostc45_icon.h"
115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	49 #include "crc_wrapper.h"
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	50 #include "Export.h"
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	51 #include <QFile>
5 115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	52 #include <QString>
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	53
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	54 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	55 /// \brief Implementing various operations for H&W OSTC4 dive computer
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	56 class OSTC4Operations
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	57 : public OSTC3Operations
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 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	60 /// \brief Custom text size (lines and columns).
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	61 EXPORT QSize nameSize() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	62
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 /// \brief Read OSTC4 computer firmware, serial and custom text.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	65 /// Everything is formated for the description() string.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	66 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	67 EXPORT void getIdentity() override;
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 EXPORT QString model() const override;
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 /// \brief Tells what is supported for a given computer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	72 EXPORT CompanionFeatures supported() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	73
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	74 struct FirmwareOSTC4 {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	75 uint length;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	76 uchar type, dummy5, dummy6, dummy7;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	77 uint checksum;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	78 struct {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	79 unsigned char x, y, z, beta;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	80 } version;
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
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	83 QFile _file;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	84
5 115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	85 std::unique_ptr<BmpToArray> bmp;
115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	86
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	87 /// \param[in] dryRun: If TRUE, do not upload FW, just check file structure.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	88 void openFirmware(const QString& fileName, bool dryRun);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	89
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	90 void loadFirmwarePart(FirmwareOSTC4& header,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	91 QByteArray& bin, int part,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	92 bool dryRun);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	93
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	94 void getSignal() override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	95 void getAllHeader(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	96 void writeAllHeader(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	97 void getAllSamples(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	98 void writeAllSamples(unsigned char* pBuffer) override;
5 115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	99 void setIcons(const QString& fileName) override;
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	100
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	101 EXPORT QString firmwareTemplate() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	102 // EXPORT QRegExp portTemplate() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	103 EXPORT QRegularExpression portTemplate() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	104 EXPORT QStringList listPorts() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	105 EXPORT void upgradeFW(const QString &fileName) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	106
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	107 Adler32 fileChecksum;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	108
5 115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	109 CrcWrapper* m_crcWrapper;
115cfa4a3239 Added icon upload function for OSTC 4/5 Ideenmodellierer parents: 1 diff changeset	110
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	111 public:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	112 EXPORT OSTC4Operations();
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
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	115 #endif // OSTC4_OPERATIONS_H

Mercurial > public > ostc_companion

annotate OSTC4Operations.h @ 5:115cfa4a3239 default tip