137 lines
4.6 KiB
C++
137 lines
4.6 KiB
C++
#ifndef _GWAPI_H
|
|
#define _GWAPI_H
|
|
#include "GwMessage.h"
|
|
#include "N2kMsg.h"
|
|
#include "NMEA0183Msg.h"
|
|
#include "GWConfig.h"
|
|
#include "GwBoatData.h"
|
|
//API to be used for additional tasks
|
|
class GwApi{
|
|
public:
|
|
class BoatValue{
|
|
const String name;
|
|
String format;
|
|
bool formatSet=false;
|
|
public:
|
|
double value=0;
|
|
bool valid=false;
|
|
int source=-1;
|
|
bool changed=false; //will be set by getBoatDataValues
|
|
BoatValue(){}
|
|
BoatValue(const String &n):name(n){
|
|
}
|
|
void setFormat(const String &format){
|
|
if (formatSet) return;
|
|
this->format=format;
|
|
formatSet=true;
|
|
}
|
|
const String & getName() const{
|
|
return name;
|
|
}
|
|
const String & getFormat() const{
|
|
return format;
|
|
}
|
|
};
|
|
|
|
class Status{
|
|
public:
|
|
bool wifiApOn=false;
|
|
bool wifiClientOn=false;
|
|
bool wifiClientConnected=false;
|
|
String wifiApIp;
|
|
String systemName; //is also AP SSID
|
|
String wifiApPass;
|
|
String wifiClientIp;
|
|
String wifiClientSSID;
|
|
unsigned long usbRx=0;
|
|
unsigned long usbTx=0;
|
|
unsigned long serRx=0;
|
|
unsigned long serTx=0;
|
|
unsigned long tcpSerRx=0;
|
|
unsigned long tcpSerTx=0;
|
|
int tcpClients=0;
|
|
unsigned long tcpClRx=0;
|
|
unsigned long tcpClTx=0;
|
|
bool tcpClientConnected=false;
|
|
unsigned long n2kRx=0;
|
|
unsigned long n2kTx=0;
|
|
void empty(){
|
|
wifiApOn=false;
|
|
wifiClientOn=false;
|
|
wifiClientConnected=false;
|
|
wifiApIp=String();
|
|
systemName=String(); //is also AP SSID
|
|
wifiApPass=String();
|
|
wifiClientIp=String();
|
|
wifiClientSSID=String();
|
|
usbRx=0;
|
|
usbTx=0;
|
|
serRx=0;
|
|
serTx=0;
|
|
tcpSerRx=0;
|
|
tcpSerTx=0;
|
|
tcpClients=0;
|
|
tcpClRx=0;
|
|
tcpClTx=0;
|
|
tcpClientConnected=false;
|
|
n2kRx=0;
|
|
n2kTx=0;
|
|
}
|
|
};
|
|
/**
|
|
* thread safe methods - can directly be called from a user task
|
|
*/
|
|
virtual GwRequestQueue *getQueue()=0;
|
|
virtual void sendN2kMessage(const tN2kMsg &msg, bool convert=true)=0;
|
|
/**
|
|
* deprecated - sourceId will be ignored
|
|
*/
|
|
virtual void sendNMEA0183Message(const tNMEA0183Msg &msg, int sourceId,bool convert=true)=0;
|
|
virtual void sendNMEA0183Message(const tNMEA0183Msg &msg, bool convert=true)=0;
|
|
virtual int getSourceId()=0;
|
|
/**
|
|
* the returned config data must only be read in a user task
|
|
* writing to it is not thread safe and could lead to crashes
|
|
*/
|
|
virtual GwConfigHandler *getConfig()=0;
|
|
virtual GwLog *getLogger()=0;
|
|
virtual const char* getTalkerId()=0;
|
|
/**
|
|
* get a set of boat data values
|
|
* the provided list of BoatValue must be initialized with
|
|
* empty boatValues (see exampleTask source code)
|
|
* the method will fill the valid flag, the value and the format string of
|
|
* each boat value
|
|
* just make sure to have the list being of appropriate size (numValues)
|
|
*/
|
|
virtual void getBoatDataValues(int numValues,BoatValue **list)=0;
|
|
|
|
/**
|
|
* fill the status information
|
|
*/
|
|
virtual void getStatus(Status &status);
|
|
/**
|
|
* not thread safe methods
|
|
* accessing boat data must only be executed from within the main thread
|
|
* you need to use the request pattern as shown in GwExampleTask.cpp
|
|
*/
|
|
virtual GwBoatData *getBoatData()=0;
|
|
virtual ~GwApi(){}
|
|
};
|
|
#ifndef DECLARE_USERTASK
|
|
#define DECLARE_USERTASK(task)
|
|
#endif
|
|
#ifndef DECLARE_USERTASK_PARAM
|
|
#define DECLARE_USERTASK_PARAM(task,...)
|
|
#endif
|
|
#ifndef DECLARE_INITFUNCTION
|
|
#define DECLARE_INITFUNCTION(task)
|
|
#endif
|
|
#ifndef DECLARE_CAPABILITY
|
|
#define DECLARE_CAPABILITY(name,value)
|
|
#endif
|
|
#ifndef DECLARE_STRING_CAPABILITY
|
|
#define DECLARE_STRING_CAPABILITY(name,value)
|
|
#endif
|
|
#endif
|