ostc_companion: OSTC3Operations.h annotate

annotate OSTC3Operations.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 OSTC3Operations.h
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	3 /// \brief Implementing various operations for H&W OSTC3 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 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) 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 // 2013-03-17 : [jDG] Creation.
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
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	42 #ifndef OSTC3OPERATIONS_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	43 #define OSTC3OPERATIONS_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	44
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	45 #include "HardwareOperations.h"
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 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	48 /// \brief Implementing various low-level operations for OSTC3 dive computer
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	49 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	50 /// \sa OSTCSportOperations, OSTC2Operations, OSTC3pOperations,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	51 /// OSTC4Operations, OSTCcROperations.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	52 class OSTC3Operations
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	53 : public HardwareOperations
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 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	56 /// \{ \section Configuration management.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	57
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	58 // QRegExp portTemplate() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	59 QRegularExpression portTemplate() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	60 QStringList listPorts() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	61 QString model() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	62 QString description() override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	63 CompanionFeatures supported() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	64
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	65 /// \}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	66 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	67 protected:
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 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	70 /// \brief Erase OSTC3 PROM memory.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	71 /// PROM memory should be erased beforeprogramming the new firmware.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	72 /// This command is used to erase a set of 4KB pages.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	73 /// \param[in] addr: First address (24bits) to erase. Should be a multiple of 4096.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	74 /// \param[in] size: Number of bytes to erase. Will be rounded (up) to a multiple of 4096.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	75 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	76 void eraseRange(unsigned int addr, unsigned int size);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	77
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	78 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	79 /// \brief Write a big block of bytes to OSTC3 RAM memory.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	80 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	81 /// \param[in] addr: First address (24bits) to write to.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	82 /// \param[in] data: Bytes to write.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	83 /// \param[in] size: Number of bytes to write.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	84 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	85 void writeBlock(unsigned int addr,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	86 const unsigned char *data, unsigned int size);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	87
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 /// \brief Read-back a big block of bytes from OSTC3 RAM memory.
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 /// \param[in] addr: First address (24bits) to read from.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	92 /// \param[in] ptr : Where to store bytes read.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	93 /// \param[in] size: Number of bytes to read.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	94 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	95 void readBlock (unsigned int addr, unsigned char *ptr, unsigned int size);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	96
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 /// \brief Burn firmare.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	99 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	100 /// Firmware should be first uploaded to RAM memory (\sa writeBlock() ),
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	101 /// in area 0x3E0000 .. 0x3FE000,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	102 /// then the firmware command will tell the OSTC3 to use that to reprogramm
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	103 /// itself.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	104 /// A validation checksum is done to make sure a valid data have been
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	105 /// uploaded.
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 /// \param[in] checksum: Adler32 checksum of the new firmware.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	108 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	109 void upgradeFirmware(unsigned int checksum);
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 public:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	112 OSTC3Operations();
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	113 ~OSTC3Operations();
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 /// \brief The fw version found during the last getIdentty().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	116 int firmware() const override;
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 The serial number found during the last getIdentty().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	119 int serialNumber() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	120
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	121 /// \brief The user-defined string found during the last getIdentty().
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	122 QString customText() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	123
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	124 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	125 /// \{ \section OSTC3 low-level service mode commands.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	126 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	127 /// Low level commands are used to directly speak to the OSTC3 firmware.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	128 /// They all throw an Exception if some error occurs.
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 /// \brief Custom text size (lines and columns).
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	132 QSize nameSize() const override;
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 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	135 /// \brief Read OSTC3 computer firmware, serial and custom text.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	136 /// Everything is formated for the description() string.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	137 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	138 void getIdentity() override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	139
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	140 //------------------------------------------------------------------------
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	141 /// \brief Display a short text on OSTC3 while on service mode.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	142 /// OSTC3 can handle 16 chars. So the string is automatically
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	143 /// padded with spaces to clean any leftover.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	144 /// \throws if something goes wrong.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	145 void writeText(const QString &msg) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	146
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	147 QString firmwareTemplate() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	148
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	149 /// \}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	150 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	151 /// \{ \section OSTC3 high-level commands.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	152
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	153 bool connect() override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	154 bool disconnect(bool closing = false) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	155 void setDate(const QDateTime& date) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	156 void setName(const QString& newName) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	157 void getSignal() override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	158 void getAllHeader(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	159 void writeAllHeader(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	160 void getAllSamples(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	161 void writeAllSamples(unsigned char* pBuffer) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	162 void setIcons(const QString& fileName) override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	163 QImage dumpScreen() const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	164 void upgradeFW(const QString& fileName) override;
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 void loadFirmware(HexFile& hex, const QString& fileName) const override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	167
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
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	170 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	171 protected:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	172 QString descriptionString;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	173 QString emulatorName;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	174 char computerText[60];
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	175
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	176 virtual void getCommonIdentity();
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	177
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	178 void connectServiceMode() override;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	179
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	180 //////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	181 private:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	182 unsigned short _computerFirmware;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	183 unsigned short _computerSerial;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	184
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	185 protected:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	186 enum Mode {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	187 CLOSED_MODE = 0, ///< Not yet open.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	188 DOWNLOAD_MODE, ///< Open in normal mode.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	189 SERVICE_MODE ///< Open in FIRMWARE UPGRADE mode.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	190 } _connectMode;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	191 };
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	192
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	193 #endif // OSTC3OPERATIONS_H

Mercurial > public > ostc_companion

annotate OSTC3Operations.h @ 1:0b3630a29ad8