ArduinoDevice.hpp

/*
 * Copyright 2021 Marcus Behel
 *
 * This file is part of ArPiRobot-CoreLib.
 * 
 * ArPiRobot-CoreLib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * ArPiRobot-CoreLib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with ArPiRobot-CoreLib.  If not, see <https://www.gnu.org/licenses/>. 
 */
 
#pragma once
 
#include <arpirobot/arduino/iface/BaseArduinoInterface.hpp>
 
#include <string>
#include <vector>
 
namespace arpirobot{
 
    class ArduinoDevice{
    public:
 
        ArduinoDevice(bool createDevice, int deviceId);
    
        virtual ~ArduinoDevice() = default;
 
        virtual std::string getDeviceName();
 
    protected:
        static std::vector<uint8_t> stringToData(const std::string &str);
 
        void setArduino(BaseArduinoInterface *arduino);
        void setDeviceId(int deviceId);
 
        bool sendData(const std::vector<uint8_t> &data);
        bool sendData(const std::string &data);
 
        // Device specific
        virtual void applyDefaultState() = 0;
        virtual std::vector<uint8_t> getCreateData() = 0;
        virtual void handleData(const std::vector<uint8_t> &data) = 0;
 
        bool createDevice;
        int deviceId;
 
        std::string deviceName;
 
        // Not a shared_ptr because this is set and cleared by the managing ArduinoInterface
        // This should not keep an ArduinoInterface in scope. The interface keeps devices
        // in scope. When interface goes out of scope, devices can as well;
        BaseArduinoInterface *arduino = nullptr;
 
        friend class BaseArduinoInterface;
    };
}