//////////////////////////////////////////////////////////////////////////////
/// \file   OSTCFrogOperations.h
/// \brief  Implementing various operations for H&W Frog dive computer
/// \author JD Gascuel.
///
/// \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
//  2011-10-01 : Separate from FrogTools main.cpp
//  2014-10-23 : Mix with OSTC Companion code.

#ifndef OSTC_FROG_OPERATIONS_H
#define OSTC_FROG_OPERATIONS_H

#include "HardwareOperations.h"

class  OSTCFrogOperations
  : public HardwareOperations
{
    int     _firmware;
    int     _serialNumber;
    QString _description;
    bool    _isOpen;
    bool    _commandMode;

    //---- Low level commands
    void beginCommands();
    void endCommands();
    void eraseRange(unsigned int addr, unsigned int size);
    void startWrite(unsigned int addr);
    void stopWrite();
    void readBytes(unsigned int addr, unsigned char *ptr, unsigned int size);


    //---- Port management
    //QRegExp portTemplate() const override;
    QRegularExpression portTemplate() const override;
    QStringList listPorts() const override;
    HardwareOperations::CompanionFeatures supported() const override;

    //---- High level commands reimplemented
    bool connect() override;
    void connectServiceMode() override;
    void getIdentity() override;
    void writeText(const QString &_msg) override;
    void setDate(const QDateTime& date) override;
    QSize nameSize() const override;
    void setName(const QString& newName) override;
    void setIcons(const QString& fileName) override;
    int firmware() const override;
    int serialNumber() const override;
    QString customText() const override;
    void loadFirmware(HexFile& hex, const QString& fileName) const override;
    void upgradeFW(const QString& fileName) override;
    QString firmwareTemplate() const override;
    bool disconnect(bool closing = false) override;
    QString model() const override;
    QString description() override;
    QImage dumpScreen() const override;

public:
    OSTCFrogOperations();
    ~OSTCFrogOperations();
};

#endif // OSTC_FROG_OPERATIONS_H