31#include <wx/fileconf.h>
32#include <wx/jsonval.h>
33#include <wx/jsonreader.h>
34#include <wx/tokenzr.h>
36#include "model/base_platform.h"
37#include "model/comm_appmsg.h"
40#include "model/comm_drv_n2k.h"
45#include "model/comm_drv_factory.h"
49 auto msg = UnpackEvtPointer<Nmea2000Msg>(ev);
54 auto msg = UnpackEvtPointer<Nmea2000Msg>(ev);
55 return msg->source->to_string();
59 auto msg = UnpackEvtPointer<Nmea0183Msg>(ev);
64 auto msg = UnpackEvtPointer<PluginMsg>(ev);
69 auto msg = UnpackEvtPointer<SignalkMsg>(ev);
72 reader.
Parse(wxString(msg->raw_message), &data);
80 for (
size_t i = 0; i < reader.
GetErrors().GetCount(); i++)
81 root[
"Errors"].Append(reader.
GetErrors().Item(i));
84 for (
size_t i = 0; i < reader.
GetWarnings().GetCount(); i++)
85 root[
"Warnings"].Append(reader.
GetWarnings().Item(i));
87 root[
"Context"] = msg->context;
88 root[
"ContextSelf"] = msg->context_self;
90 return static_pointer_cast<void>(std::make_shared<wxJSONValue>(root));
95 auto msg = UnpackEvtPointer<NotificationMsg>(ev);
96 auto note = msg->notification;
97 auto rv = std::make_shared<PI_Notification>(
99 note->GetTimeoutStart(), note->GetTimeoutLeft(), note->GetGuid());
100 rv->action_verb = msg->action_verb;
106 return make_shared<ObservableListener>(
Nmea2000Msg(
id.
id), eh, et);
111 return make_shared<ObservableListener>(
Nmea0183Msg(
id.
id), eh, et);
116 return make_shared<ObservableListener>(
SignalkMsg(), eh, et);
126 return make_shared<ObservableListener>(
PluginMsg(
id.
id,
""), eh, et);
136 auto msg = UnpackEvtPointer<BasicNavDataMsg>(ev);
139 data.
lat = msg->pos.lat;
140 data.lon = msg->pos.lon;
145 data.time = msg->time;
152 std::vector<DriverHandle> result;
154 auto& registry = CommDriverRegistry::GetInstance();
155 const std::vector<DriverPtr>& drivers = registry.GetDrivers();
157 for (
auto& driver : drivers) result.push_back(driver->Key());
164 auto& registry = CommDriverRegistry::GetInstance();
165 auto& drivers = registry.GetDrivers();
166 auto func = [handle](
const DriverPtr d) {
return d->Key() == handle; };
168 for (
auto& d : drivers)
169 if (d->Key() == handle) found = d.get();
171 return found->GetAttributes();
177 DriverHandle handle,
const std::shared_ptr<std::vector<uint8_t>>& payload) {
179 auto& registry = CommDriverRegistry::GetInstance();
180 auto& drivers = registry.GetDrivers();
182 for (
auto& d : drivers)
183 if (d->Key() == handle) found = d.get();
189 std::unordered_map<std::string, std::string> attributes =
191 auto protocol_it = attributes.find(
"protocol");
193 std::string protocol = protocol_it->second;
195 if (protocol ==
"nmea0183") {
198 std::string msg(payload->begin(), payload->end());
199 std::string
id = msg.substr(1, 5);
200 auto address = std::make_shared<NavAddr>();
201 auto msg_out = std::make_shared<Nmea0183Msg>(
id, msg, address);
202 bool xmit_ok = d0183->SendMessage(msg_out, address);
204 }
else if (protocol ==
"internal") {
205 std::string msg(payload->begin(), payload->end());
206 size_t space_pos = msg.find(
" ");
208 auto plugin_msg = std::make_shared<PluginMsg>(msg.substr(0, space_pos),
209 msg.substr(space_pos + 1));
210 NavMsgBus::GetInstance().
Notify(static_pointer_cast<NavMsg>(plugin_msg));
218 DriverHandle handle,
int PGN,
int destinationCANAddress,
int priority,
219 const std::shared_ptr<std::vector<uint8_t>>& payload) {
224 auto& registry = CommDriverRegistry::GetInstance();
225 auto& drivers = registry.GetDrivers();
228 for (
auto& d : drivers)
229 if (d->Key() == handle) found = d.get();
234 std::make_shared<const NavAddr2000>(found->
iface, destinationCANAddress);
236 std::make_shared<const Nmea2000Msg>(_PGN, *payload, dest_addr, priority);
237 bool result = found->SendMessage(msg, dest_addr);
243 std::vector<int>& pgn_list) {
247 auto& registry = CommDriverRegistry::GetInstance();
248 auto& drivers = registry.GetDrivers();
250 for (
auto& d : drivers)
251 if (d->Key() == handle) found = d.get();
259 for (
size_t i = 0; i < pgn_list.size(); i++) {
263 while (nTry && iresult < 0) {
264 iresult = dn2k->SetTXPGN(pgn_list[i]);
279void ReloadConfigConnections() {
281 auto& registry = CommDriverRegistry::GetInstance();
282 registry.CloseAllDrivers();
287 pConf->SetPath(_T (
"/Settings/NMEADataSource" ));
289 wxString connectionconfigs;
290 pConf->Read(_T(
"DataConnections" ), &connectionconfigs);
291 if (!connectionconfigs.IsEmpty()) {
292 wxArrayString confs = wxStringTokenize(connectionconfigs, _T(
"|"));
293 TheConnectionParams().clear();
294 for (
size_t i = 0; i < confs.Count(); i++) {
296 if (!prm->Valid)
continue;
297 TheConnectionParams().push_back(prm);
303 for (
auto* cp : TheConnectionParams()) {
306 cp->b_IsSetup = TRUE;
316 const std::string& _message,
317 int _timeout_start,
int _timeout_left,
319 severity = _severity;
321 auto_timeout_start = _timeout_start;
322 auto_timeout_left = _timeout_left;
326int GetActiveNotificationCount() {
327 auto& noteman = NotificationManager::GetInstance();
328 return noteman.GetNotificationCount();
332 auto& noteman = NotificationManager::GetInstance();
337 const std::string& _message,
int timeout_secs) {
338 auto& noteman = NotificationManager::GetInstance();
339 auto notification = std::make_shared<Notification>(
340 (NotificationSeverity)_severity, _message, timeout_secs);
341 return noteman.AddNotification(notification);
344bool AcknowledgeNotification(
const std::string& guid) {
345 auto& noteman = NotificationManager::GetInstance();
346 return noteman.AcknowledgeNotification(guid);
349std::vector<std::shared_ptr<PI_Notification>> GetActiveNotifications() {
350 auto& noteman = NotificationManager::GetInstance();
351 std::vector<std::shared_ptr<PI_Notification>> pi_notes;
352 for (
auto note : noteman.GetNotifications()) {
353 auto pi_note = std::make_shared<PI_Notification>(
355 note->GetTimeoutStart(), note->GetTimeoutLeft(), note->GetGuid());
356 pi_notes.push_back(pi_note);
Common interface for all drivers.
const std::string iface
Physical device for 0183, else a unique string.
NMEA0183 drivers common part.
void Notify(std::shared_ptr< const NavMsg > message)
Accept message received by driver, make it available for upper layers.
A regular Nmea0183 message.
See: https://github.com/OpenCPN/OpenCPN/issues/2729#issuecomment-1179506343.
Custom event class for OpenCPN's notification system.
PI_Notification(PI_NotificationSeverity _severity, const std::string &_message, int _timeout_start, int _timeout_left, std::string _guid)
Plugin Notification Framework support.
A plugin to plugin json message over the REST interface.
A parsed SignalK message over ipv4.
const wxArrayString & GetWarnings() const
Return a reference to the warning message's array.
const wxArrayString & GetErrors() const
Return a reference to the error message's array.
int GetErrorCount() const
Return the size of the error message's array.
int GetWarningCount() const
Return the size of the warning message's array.
int Parse(const wxString &doc, wxJSONValue *val)
Parse the JSON document.
The JSON value class implementation.
Driver registration container, a singleton.
Raw messages layer, supports sending and recieving navmsg messages.
Class NotificationManager.
PlugIn Object Definition/API.
CommDriverResult
Error return values
@ RESULT_COMM_INVALID_PARMS
Invalid parameters provided to operation.
@ RESULT_COMM_TX_ERROR
Error occurred during transmission.
@ RESULT_COMM_REGISTER_PGN_ERROR
Failed to register PGN parameters.
@ RESULT_COMM_NO_ERROR
Operation completed successfully.
@ RESULT_COMM_INVALID_HANDLE
Invalid or unknown driver handle specified.
PI_NotificationSeverity
Plugin Notification Framework support.
std::string DriverHandle
Plugin API supporting direct access to comm drivers for output purposes.
wxFileConfig * GetOCPNConfigObject(void)
Gets OpenCPN's configuration object.
std::string GetPluginMsgPayload(PluginMsgId id, ObservedEvt ev)
Retrieve the string in a plugin message, internal or received on the REST insterface.
std::string GetN0183Payload(NMEA0183Id id, ObservedEvt ev)
Return payload in a received n0183 message of type id in ev.
PluginNavdata GetEventNavdata(ObservedEvt ev)
Return BasicNavDataMsg decoded data available in ev.
std::shared_ptr< PI_Notification > GetNotificationMsgPayload(NotificationMsgId id, ObservedEvt ev)
Retrieve the Notification Event in a Notification message.
CommDriverResult WriteCommDriverN2K(DriverHandle handle, int PGN, int destinationCANAddress, int priority, const std::shared_ptr< std::vector< uint8_t > > &payload)
Send a PGN message to an NMEA2000 address.
shared_ptr< ObservableListener > GetListener(NMEA2000Id id, wxEventType et, wxEvtHandler *eh)
Gets listener for NMEA 2000 messages.
std::vector< DriverHandle > GetActiveDrivers()
Comm port plugin TX support methods
const std::unordered_map< std::string, std::string > GetAttributes(DriverHandle handle)
Query a specific driver for attributes.
std::string GetN2000Source(NMEA2000Id id, ObservedEvt ev)
Return source identifier (iface) of a received n2000 message of type id in ev.
vector< uint8_t > GetN2000Payload(NMEA2000Id id, ObservedEvt ev)
Return N2K payload for a received n2000 message of type id in ev.
std::shared_ptr< void > GetSignalkPayload(ObservedEvt ev)
Get SignalK status payload after receiving a message.
wxString * GetpPrivateApplicationDataLocation(void)
Gets private application data directory.
CommDriverResult WriteCommDriver(DriverHandle handle, const std::shared_ptr< std::vector< uint8_t > > &payload)
Send a non-NMEA2000 message.
CommDriverResult RegisterTXPGNs(DriverHandle handle, std::vector< int > &pgn_list)
Register PGNs that this application intends to transmit for some NMEA 2000 adapters like Actisense NG...
Identifier for NMEA 0183 sentence types.
Identifier for NMEA 2000 message types.
Navigation data message identifier.
Facade for NotificationMsg.
Facade for NavAddrPluginMsg.
Basic navigation data structure.
double lat
Latitude in decimal degrees.
Identifier for Signal K paths.