Update documentation to include Plugin Programming Guide and Plugin D…

…ocumentation template

examples/tmx-exampleapps/SampleBSMPlugin/CMakeLists.txt

@@ -2,4 +2,4 @@ PROJECT ( SampleBSMPlugin VERSION 5.0 LANGUAGES CXX )
 
 BuildTmxPlugin ( )
 
-TARGET_LINK_LIBRARIES (${PROJECT_NAME} tmxutils jsoncpp)
+TARGET_LINK_LIBRARIES (${PROJECT_NAME} tmxutils)

examples/tmx-exampleapps/SampleBSMPlugin/README.md

@@ -0,0 +1,29 @@
+# SampleBSMPlugin
+
+This is an example plugin used for demostrating how to develop new **V2X Hub** plugins. Any developed plugin should include accompanying documentation in the form of a `README.md` with the sections outlined here.
+
+## Documentation Template
+
+### Introduction
+
+A brief introduction to the Plugin and the functionality it introduces. Well developed plugins are modular and function independently.
+
+### Related Plugins
+
+A list of plugins related to the documented plugin. Often to enable Connected Automated Vehicle (CAV) use-cases, requires multiple **V2X-Hub**  plugins running conccurently. This section should described other plugins required for end-user functionality and their role.
+
+### Configuration/Deployment
+
+This section should provide documentation about how to configure and deploy the  plugin. This should include descriptions of plugin configuration parameters as well as step by step instructions for enabling the plugin.
+
+### Design (Recommended)
+
+This is an optional, but recommended section that can be used to outline the high-level design of your plugin. This should include insights into data-flow, communication sequence and relevant data transforms/translations.
+
+### Messages (Recommended)
+
+This is an optional, but recommended section that is intended to described the TMX Messages used by the plugin to communicate with other plugins in V2X-Hub
+
+### Testing (Recommended)
+
+This final section is optional, but recommended and is intended to described methods used to confirm the deployed plugin is functioning correctly. This can include testing scripts used to send mock data through the plugin and/or UI status fields to check to confirm working functionality.

examples/tmx-exampleapps/SampleBSMPlugin/src/SampleBSMPlugin.cpp

@@ -1,11 +1,27 @@
+/**
+ * Copyright (C) 2024 LEIDOS.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
 #include "SampleBSMPlugin.h"
 using namespace tmx;
 using namespace tmx::utils;
 using namespace tmx::messages;
 
 namespace SampleBSMPluginNS
 {
-    SampleBSMPlugin::SampleBSMPlugin(std::string name) : PluginClient(name)
+    SampleBSMPlugin::SampleBSMPlugin(std::string name) : PluginClientClockAware(name)
     {
         AddMessageFilter<BsmMessage>(this, &SampleBSMPlugin::HandleBasicSafetyMessage);
         SubscribeToMessages();
@@ -31,7 +47,6 @@ namespace SampleBSMPluginNS
 
         routeable_message *rMsg = dynamic_cast<routeable_message *>(&bsmEncodeMessage);
         BroadcastMessage(*rMsg);
-        PLOG(logERROR) << " SampleBSMPlugind :: Broadcast BSM:: " << bsmEncodeMessage.get_payload_str();
         free(frame_msg.get_j2735_data().get()); 
         delete bsmMessage;
 
@@ -63,7 +78,7 @@ namespace SampleBSMPluginNS
             bsmEncoded.refresh_timestamp();
             routeable_message *rMsg = dynamic_cast<routeable_message *>(&bsmEncoded);
             BroadcastMessage(*rMsg);
-            PLOG(logERROR) << " SampleBSMPlugin :: Broadcast CREATED BSM:: " << bsmEncoded.get_payload_str();
+            PLOG(logINFO) << "Broadcasted CREATED BSM : " << bsmEncoded.get_payload_str();
         }       
     }
 
@@ -111,12 +126,10 @@ namespace SampleBSMPluginNS
         bsm->coreData.size.length = 500;
         bsm->coreData.size.width = 300;
 
-        std::cout << "createAndSendBSM 7" << std::endl;         
+        PLOG(logINFO) << "Create and Send BSM." ;         
         BsmMessage*  bsmMessage = new BsmMessage(bsm);
         MessageFrameMessage messageFrame( bsmMessage->get_j2735_data() );
-        std::cout << "createAndSendBSM 7.1" << std::endl;
         bsmEncoded.set_data( TmxJ2735EncodedMessage<BasicSafetyMessage>::encode_j2735_message<codec::uper<MessageFrameMessage>>(messageFrame) );
-        std::cout << "createAndSendBSM 7.2" << std::endl;
         free(bsm);
         free(messageFrame.get_j2735_data().get());     
     }
@@ -125,7 +138,7 @@ namespace SampleBSMPluginNS
 
     int SampleBSMPlugin::Main()
     {
-        FILE_LOG(logINFO) << "Starting plugin";
+        PLOG(logINFO) << "Starting plugin";
         while (_plugin->state != IvpPluginState_error)
         {
             if (IsPluginState(IvpPluginState_registered))