basedevice.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2011 Jasem Mutlaq. All rights reserved.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.

 This library 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
 Library General Public License for more details.

 You should have received a copy of the GNU Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/

#pragma once

#include "indibase.h"
#include "indiproperty.h"

#include <string>
#include <vector>

#include <stdint.h>

#define MAXRBUF 2048

namespace INDI
{

class BaseDevice
{
  public:
    BaseDevice();
    virtual ~BaseDevice();

    enum INDI_ERROR
    {
        INDI_DEVICE_NOT_FOUND    = -1, 
        INDI_PROPERTY_INVALID    = -2, 
        INDI_PROPERTY_DUPLICATED = -3, 
        INDI_DISPATCH_ERROR      = -4  
    };

    enum DRIVER_INTERFACE
    {
        GENERAL_INTERFACE   = 0,         
        TELESCOPE_INTERFACE = (1 << 0),  
        CCD_INTERFACE       = (1 << 1),  
        GUIDER_INTERFACE    = (1 << 2),  
        FOCUSER_INTERFACE   = (1 << 3),  
        FILTER_INTERFACE    = (1 << 4),  
        DOME_INTERFACE      = (1 << 5),  
        GPS_INTERFACE       = (1 << 6),  
        WEATHER_INTERFACE   = (1 << 7),  
        AO_INTERFACE        = (1 << 8),  
        DUSTCAP_INTERFACE   = (1 << 9),  
        LIGHTBOX_INTERFACE  = (1 << 10), 
        DETECTOR_INTERFACE  = (1 << 11), 
        ROTATOR_INTERFACE   = (1 << 12), 
        AUX_INTERFACE       = (1 << 15), 
    };

    INumberVectorProperty *getNumber(const char *name);
    ITextVectorProperty *getText(const char *name);
    ISwitchVectorProperty *getSwitch(const char *name);
    ILightVectorProperty *getLight(const char *name);
    IBLOBVectorProperty *getBLOB(const char *name);
    IPState getPropertyState(const char *name);
    IPerm getPropertyPermission(const char *name);

    void registerProperty(void *p, INDI_PROPERTY_TYPE type);

    int removeProperty(const char *name, char *errmsg);

    void *getRawProperty(const char *name, INDI_PROPERTY_TYPE type = INDI_UNKNOWN);

    INDI::Property *getProperty(const char *name, INDI_PROPERTY_TYPE type = INDI_UNKNOWN);

    std::vector<INDI::Property *> *getProperties() { return &pAll; }

    bool buildSkeleton(const char *filename);

    bool isConnected();

    void setDeviceName(const char *dev);

    const char *getDeviceName();

    void addMessage(const std::string& msg);

    void checkMessage(XMLEle *root);
    void doMessage(XMLEle *msg);

    std::string messageQueue(int index) const;

    std::string lastMessage();

    void setMediator(INDI::BaseMediator *med) { mediator = med; }

    INDI::BaseMediator *getMediator() { return mediator; }

    const char *getDriverName();

    const char *getDriverExec();

    const char *getDriverVersion();

    virtual uint16_t getDriverInterface();

  protected:
    int buildProp(XMLEle *root, char *errmsg);

    int setValue(XMLEle *root, char *errmsg);
    int setBLOB(IBLOBVectorProperty *pp, XMLEle *root, char *errmsg);

  private:
    char *deviceID;

    std::vector<INDI::Property *> pAll;

    LilXML *lp;

    std::vector<std::string> messageLog;

    INDI::BaseMediator *mediator;

    friend class INDI::BaseClient;
    friend class INDI::BaseClientQt;
    friend class INDI::DefaultDevice;
};

}