//////////////////////////////////////////////////////////////////////////////
/// \file   OSTC4Operations.h
/// \brief  Implementing various operations for H&W OSTC4 dive computer
/// \author JD Gascuel.
/// \sa     OSTC3Operations, HardwareOperations.h
///
/// \copyright (c) 2016 JD Gascuel. All rights reserved.
/// $Id$
//////////////////////////////////////////////////////////////////////////////
//
// BSD 2-Clause License:
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////////
// HISTORY
//  2015-09-28  jDG: Creation initial (RadioComm) version.
//  2016-04-25  jDG: Final H&W version.

#ifndef OSTC4_OPERATIONS_H
#define OSTC4_OPERATIONS_H

#include "OSTC3Operations.h"
#include <QRegularExpression>

#include "AES/Adler16.h"
#include "Export.h"
#include <QFile>

//////////////////////////////////////////////////////////////////////////////
/// \brief  Implementing various operations for H&W OSTC4 dive computer
class OSTC4Operations
  : public OSTC3Operations
{
    //------------------------------------------------------------------------
    /// \brief Custom text size (lines and columns).
    EXPORT QSize nameSize() const override;

    //------------------------------------------------------------------------
    /// \brief Read OSTC4 computer firmware, serial and custom text.
    /// Everything is formated for the description() string.
    /// \throws if something goes wrong.
    EXPORT void getIdentity() override;

    EXPORT QString model() const override;

    /// \brief Tells what is supported for a given computer.
    EXPORT CompanionFeatures supported() const override;

    struct FirmwareOSTC4 {
        uint    length;
        uchar   type, dummy5, dummy6, dummy7;
        uint    checksum;
        struct {
            unsigned char x, y, z, beta;
        }       version;
    };

    QFile   _file;

    /// \param[in] dryRun: If TRUE, do not upload FW, just check file structure.
    void openFirmware(const QString& fileName, bool dryRun);

    void loadFirmwarePart(FirmwareOSTC4& header,
                          QByteArray& bin, int part,
                          bool dryRun);

    void getSignal() override;
    void getAllHeader(unsigned char* pBuffer) override;
    void writeAllHeader(unsigned char* pBuffer) override;
    void getAllSamples(unsigned char* pBuffer) override;
    void writeAllSamples(unsigned char* pBuffer) override;

    EXPORT QString firmwareTemplate() const override;
   // EXPORT QRegExp portTemplate() const override;
    EXPORT QRegularExpression portTemplate() const override;
    EXPORT QStringList listPorts() const override;
    EXPORT void upgradeFW(const QString &fileName) override;

    Adler32 fileChecksum;

public:
    EXPORT OSTC4Operations();
};

#endif // OSTC4_OPERATIONS_H