PGN 127502 remote keyboard support

lib/api/GwApi.h

@@ -137,6 +137,7 @@ class GwApi{
          * thread safe methods - can directly be called from a user task
          */
         virtual GwRequestQueue *getQueue()=0;
+        virtual QueueHandle_t getKbQueue()=0;
         virtual void sendN2kMessage(const tN2kMsg &msg, bool convert=true)=0;
         /**
          * deprecated - sourceId will be ignored

lib/config/GwConverterConfig.h

@@ -71,6 +71,7 @@ class GwConverterConfig{
       int rmcInterval=1000;
       int rmcCheckTime=4000;
       int winst312=256;
+      int swBankInstance=0;
       bool unmappedXdr=false;
       unsigned long xdrTimeout=60000;
       std::vector<WindMapping> windMappings;
@@ -97,6 +98,7 @@ class GwConverterConfig{
             windMappings.push_back(mapping);
           }
         }
+        swBankInstance=config->getInt(GwConfigDefinitions::swBankInstance,0);
       }
       const WindMapping findWindMapping(const tN2kWindReference &n2k) const{
         for (const auto & it:windMappings){

lib/nmea2kto0183/N2kDataToNMEA0183.cpp

@@ -1572,6 +1572,36 @@ private:
         finalizeXdr();
     }
 
+    void Handle127502(const tN2kMsg &msg){
+        // switch bank control / receive remote key strokes
+        unsigned char instance=-1;
+        tN2kBinaryStatus bankstatus;
+        LOG_DEBUG(GwLog::LOG,"received switch bank control");
+        // check if we are addressed and our configured instance is used
+        if (! ParseN2kPGN127502(msg,instance,bankstatus)) {
+            LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN);
+            return;
+        }
+        if (! (instance == config.swBankInstance)) {
+            LOG_DEBUG(GwLog::DEBUG,"switch bank instance #%d ignored",instance);
+            return;
+        }
+        // TODO (?) multiple keys together
+
+        // only process configured key count (default 6)
+        for (uint8_t i=1; i<=6; i++) {
+            tN2kOnOff keystatus = N2kGetStatusOnBinaryStatus(bankstatus, i);
+            if (keystatus == 1) {
+                // key pressed: send key to queue
+                xQueueSend(keyboardQueue, &i, 0);
+            } else if (keystatus == 2) {
+                // long key pressed: send long key to queue
+                xQueueSend(keyboardQueue, &i, 0);
+            }
+        }
+
+    }
+
     void registerConverters()
     {
       //register all converter functions
@@ -1607,6 +1637,7 @@ private:
       converters.registerConverter(127488UL, &N2kToNMEA0183Functions::Handle127488);
       converters.registerConverter(130316UL, &N2kToNMEA0183Functions::Handle130316);
       converters.registerConverter(127257UL, &N2kToNMEA0183Functions::Handle127257);
+      converters.registerConverter(127502UL, &N2kToNMEA0183Functions::Handle127502);
 #define HANDLE_AIS
 #ifdef HANDLE_AIS
       converters.registerConverter(129038UL, &N2kToNMEA0183Functions::HandleAISClassAPosReport);  // AIS Class A Position Report, Message Type 1
@@ -1620,13 +1651,15 @@ private:
   public:
     N2kToNMEA0183Functions(GwLog *logger, GwBoatData *boatData, 
         SendNMEA0183MessageCallback callback,
-        String talkerId, GwXDRMappings *xdrMappings, const GwConverterConfig &cfg) 
+        String talkerId, GwXDRMappings *xdrMappings, const GwConverterConfig &cfg,
+        QueueHandle_t kbQueue)
     : N2kDataToNMEA0183(logger, boatData, callback,talkerId)
     {
         this->logger = logger;
         this->boatData = boatData;
         this->xdrMappings=xdrMappings;
         this->config=cfg;
+        this->keyboardQueue=kbQueue;
         registerConverters();
     }
     virtual void loop(unsigned long lastExtRmc) override
@@ -1642,8 +1675,8 @@ private:
 
 N2kDataToNMEA0183* N2kDataToNMEA0183::create(GwLog *logger, GwBoatData *boatData, 
     SendNMEA0183MessageCallback callback, String talkerId, GwXDRMappings *xdrMappings,
-    const GwConverterConfig &cfg){
+    const GwConverterConfig &cfg, QueueHandle_t kbQueue){
   LOG_DEBUG(GwLog::LOG,"creating N2kToNMEA0183");
-  return new N2kToNMEA0183Functions(logger,boatData,callback, talkerId,xdrMappings,cfg);
+  return new N2kToNMEA0183Functions(logger,boatData,callback, talkerId,xdrMappings,cfg,kbQueue);
 }
 //*****************************************************************************

lib/nmea2kto0183/N2kDataToNMEA0183.h

@@ -43,6 +43,7 @@ protected:
   GwBoatData *boatData;
   int sourceId=0;
   char talkerId[3];
+  QueueHandle_t keyboardQueue;
   SendNMEA0183MessageCallback sendNMEA0183MessageCallback;
   void SendMessage(const tNMEA0183Msg &NMEA0183Msg);
   N2kDataToNMEA0183(GwLog *logger, GwBoatData *boatData,  
@@ -50,7 +51,8 @@ protected:
 
 public:
   static N2kDataToNMEA0183* create(GwLog *logger, GwBoatData *boatData,  SendNMEA0183MessageCallback callback, 
-    String talkerId, GwXDRMappings *xdrMappings,const GwConverterConfig &cfg);
+    String talkerId, GwXDRMappings *xdrMappings,const GwConverterConfig &cfg,
+    QueueHandle_t kbQueue);
   virtual void HandleMsg(const tN2kMsg &N2kMsg, int sourceId) = 0;
   virtual void loop(unsigned long lastRmc);
   virtual ~N2kDataToNMEA0183(){}

lib/obp60task/obp60task.cpp

@@ -344,6 +344,8 @@ void OBP60Task(GwApi *api){
 
     tN2kMsg N2kMsg;
 
+    QueueHandle_t keyboardQueue = api->getKbQueue();
+
     LOG_DEBUG(GwLog::LOG,"obp60task started");
     for (auto it=allPages.pages.begin();it != allPages.pages.end();it++){
         LOG_DEBUG(GwLog::LOG,"found registered page %s",(*it)->pageName.c_str());
@@ -613,8 +615,17 @@ void OBP60Task(GwApi *api){
                 setFlashLED(true);
             }
 
+            // Keyboard messages from remote
+            uint8_t remotekey = 0;
+            if (xQueueReceive(keyboardQueue, &remotekey, 0) == pdPASS) {
+                LOG_DEBUG(GwLog::LOG, "OBP received remote key: %d", remotekey);
+                // inject into internal keyboard queue
+                 xQueueSend(allParameters.queue, &remotekey, 0);
+            }
+
             // Check the keyboard message
             int keyboardMessage=0;
+
             while (xQueueReceive(allParameters.queue,&keyboardMessage,0)){
                 LOG_DEBUG(GwLog::LOG,"new key from keyboard %d",keyboardMessage);
                 keypressed = true;

lib/usercode/GwUserCode.cpp

@@ -189,6 +189,10 @@ public:
     {
         return api->getQueue();
     }
+    virtual QueueHandle_t getKbQueue()
+    {
+        return api->getKbQueue();
+    }
     virtual void sendN2kMessage(const tN2kMsg &msg,bool convert)
     {
         GWSYNCHRONIZED(mainLock);

src/main.cpp

@@ -158,6 +158,8 @@ GwCounter<unsigned long> countNMEA2KIn("countNMEA2000in");
 GwCounter<unsigned long> countNMEA2KOut("countNMEA2000out");
 GwIntervalRunner timers;
 
+QueueHandle_t keyboardQueue = NULL;
+
 bool checkPass(String hash){
   return config.checkPass(hash);
 }
@@ -269,6 +271,10 @@ public:
   {
     return &mainQueue;
   }
+  virtual QueueHandle_t getKbQueue()
+  {
+    return keyboardQueue;
+  }
   virtual void sendN2kMessage(const tN2kMsg &msg,bool convert)
   {
     handleN2kMessage(msg,sourceId,!convert);
@@ -860,6 +866,8 @@ void setup() {
   webserver.begin();
   xdrMappings.begin();
   logger.flush();
+  // remote keyboard support
+  keyboardQueue = xQueueCreate(10, sizeof(uint8_t));
   GwConverterConfig converterConfig;
   converterConfig.init(&config,&logger);
   nmea0183Converter= N2kDataToNMEA0183::create(&logger, &boatData, 
@@ -869,7 +877,8 @@ void setup() {
     , 
     config.getString(config.talkerId,String("GP")),
     &xdrMappings,
-    converterConfig
+    converterConfig,
+    keyboardQueue
     );
 
   toN2KConverter= NMEA0183DataToN2K::create(&logger,&boatData,[](const tN2kMsg &msg, int sourceId)->bool{

web/config.json

@@ -88,6 +88,16 @@
         "description":"the brightness of the led (0..255)",
         "category":"system"
     },
+    {
+        "name": "swBankInstance",
+        "type": "number",
+        "default": 0,
+        "min": 0,
+        "max": 252,
+        "check": "checkMinMax",
+        "description": "the instance of switch bank to receive data for (0..252)",
+        "category": "system"
+    },
     {
         "name": "talkerId",
         "label": "NMEA0183 ID",