//////////////////////////////////////////////////////////////////////////////
/// \file   OSTC2cOperations.h
/// \brief  Implementing various operations for H&W OSTC2, mk2, 2n, 2c dive computer
/// \author JD Gascuel.
/// \sa     ComputerOperations.h
///
/// \copyright (c) 2011-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
//  2013-10-26 : [jDG] Creation.
//  2015-03-16 : [jDG] Renamed OSTC2c

#ifndef OSTC_2c_OPERATIONS_H
#define OSTC_2c_OPERATIONS_H

#include "HardwareOperations.h"

//////////////////////////////////////////////////////////////////////////////

class  OSTC2cOperations
  : public HardwareOperations
{
    int     _computerFirmware;
    int     _computerSerial;
    QString _customText;
    QString _description;

    typedef unsigned char byte;

    //////////////////////////////////////////////////////////////////////////
    /// \{ \section Low level OSTC2 operations.

    void readBank0(byte bank0[256]);
    void readBank1(byte bank1[256]);
    void writeBank0(const byte bank0[256]);

    void getIdentity() override;

    /// \brief The fw version found during the last getIdentty().
    int firmware() const override;

    /// \brief The serial number found during the last getIdentty().
    int serialNumber() const override;

    /// \brief The user-defined string found during the last getIdentty().
    QString customText() const override;

    /// \}
    //////////////////////////////////////////////////////////////////////////
    /// \{ \section Configuration management.

    //QRegExp portTemplate() const override;
    QRegularExpression portTemplate() const override;
    QStringList listPorts() const override;

    QString model() const override;
    QString description() override;
    CompanionFeatures supported() const override;

    QString firmwareTemplate() const override;

    /// \}
    //////////////////////////////////////////////////////////////////////////
    /// \{ \section OSTC2 high-level commands.

    bool connect() override;
    void connectServiceMode() override;
    void writeText(const QString &msg) override;
    QSize nameSize() const override;
    void setDate(const QDateTime& date) override;
    void setName(const QString& newName) override;
    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;

    void setIcons(const QString& fileName) override;
    QImage dumpScreen() const override;

    void upgradeFW(const QString& fileName) override;
    void loadFirmware(HexFile& hex, const QString& fileName) const override;

    bool disconnect(bool closing = false)  override;

    /// \}
    //////////////////////////////////////////////////////////////////////////

public:
    OSTC2cOperations();
};

#endif // OSTC_2c_OPERATIONS_H