forked from ttlappalainen/NMEA2000
-
Notifications
You must be signed in to change notification settings - Fork 0
/
N2kMaretron.h
320 lines (302 loc) · 16 KB
/
N2kMaretron.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/*
* N2kMaretron.h
*
* Copyright (c) 2019-2023 Vassilis Bourdakis,
* Timo Lappalainen, Kave Oy, www.kave.fi,
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**************************************************************************//**
* \file N2kMaretron.h
* \brief Collection of functions for handling NMEA2000 bus Maretron messages
*
* This is collection of functions for handling NMEA2000 bus Maretron
* messages. Library contains functions to e.g. create message named with
* PGN like SetN2kPGN130823 and inline alias for them like SetN2kLatLonRapid.
* Each Setxxx funtion sets related message PGN and its default priority. So if
* you want to change priority on function, you have to do it after Setxxx call.
*
* If you do not send any Maretron messages to NMEA2000 bus, you do not need
* this library.
*
* \note These are proprietary Message Numbers created and used by Maretron!
* see [Maretron Website] (https://www.maretron.com/)
*
* \authors Vassilis Bourdakis, Timo Lappalainen
*/
#ifndef _N2kMaretron_H_
#define _N2kMaretron_H_
#include "N2kMsg.h"
#include <stdint.h>
/************************************************************************//**
* \brief Setting up PGN 130823 for Maretron Message "Temperature High Range"
*
* This Temperature High Range Message is used e.g. by MARETRON TMP100.
* The wide range is required for very high temperature values
* (e.g. Exhaust Gas Temperatures).
* see [Maretron TMP100] (https://www.maretron.com/products/tmp100.php)
*
* \note Temperatures should be in Kelvin
*
* \param N2kMsg Reference to a N2kMsg Object,
* Output: NMEA2000 message ready to be send.
* \param SID Sequence ID. If your device is e.g. boat speed and
* heading at same time, you can set same SID for
* different messages to link this PGN to other related
* PGNs. When no linkage exists, the value of the SID
* shall be set to 255
* \param TempInstance This should be unique at least on one device. May be
* best to have it unique over all devices sending
* this PGN.
* \param TempSource Source of the temperature, see \ref tN2kTempSource
* \param ActualTemperature Temperature in K. Use function CToKelvin, if you
* want to use °C.
* \param SetTemperature Set temperature in K. Use function CToKelvin, if
* you want to use °C. This is meaningful for
* temperatures which can be controlled like cabin,
* freezer, refrigeration temperature.
*/
void SetN2kMaretronPGN130823(tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource,
double ActualTemperature, double SetTemperature=N2kDoubleNA);
/************************************************************************//**
* \brief Setting up Maretron Message "Temperature High Range" - PGN 130823
*
* Alias of PGN 130823. This alias was introduced to improve the readability
* of the source code. See parameter details on \ref SetN2kMaretronPGN130823
*
*/
inline void SetN2kMaretronTempHR(tN2kMsg &N2kMsg, unsigned char SID, unsigned char TempInstance, tN2kTempSource TempSource,
double ActualTemperature, double SetTemperature=N2kDoubleNA) {
SetN2kMaretronPGN130823(N2kMsg,SID,TempInstance,TempSource,ActualTemperature,SetTemperature);
}
/************************************************************************//**
* \brief Parsing the content of Maretron Message PGN 130823
* "Temperature High Range"
*
* This Temperature High Range Message is used e.g. by MARETRON TMP100.
* The wide range is required for very high temperature values
* (e.g. Exhaust Gas Temperatures).
* see [Maretron TMP100] (https://www.maretron.com/products/tmp100.php)
*
* \note Temperatures should be in Kelvin
*
* \param N2kMsg Reference to a N2kMsg Object,
* Output: NMEA2000 message ready to be send.
* \param SID Sequence ID. If your device is e.g. boat speed and
* heading at same time, you can set same SID for
* different messages to link this PGN to other related
* PGNs. When no linkage exists, the value of the SID
* shall be set to 255
* \param TempInstance This should be unique at least on one device. May be
* best to have it unique over all devices sending
* this PGN.
* \param TempSource Source of the temperature, see \ref tN2kTempSource
* \param ActualTemperature Temperature in K. Use function CToKelvin, if you
* want to use °C.
* \param SetTemperature Set temperature in K. Use function CToKelvin, if
* you want to use °C. This is meaningful for
* temperatures which can be controlled like cabin,
* freezer, refrigeration temperature.
*
* \return true Parsing of PGN Message successful
* \return false Parsing of PGN Message aborted
*
*/
bool ParseN2kMaretronPGN130823(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource,
double &ActualTemperature, double &SetTemperature);
/************************************************************************//**
* \brief Parsing the content of Maretron Message "Temperature High Range" -
* PGN 130823
*
* Alias of PGN 130823. This alias was introduced to improve the readability
* of the source code. See parameter details on \ref ParseN2kMaretronPGN130823
*
*/
inline bool ParseN2kMaretronTempHR(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &TempInstance, tN2kTempSource &TempSource,
double &ActualTemperature, double &SetTemperature) {
return ParseN2kMaretronPGN130823(N2kMsg, SID, TempInstance, TempSource, ActualTemperature, SetTemperature);
}
/************************************************************************//**
* \brief Setting up PGN 65286 for Maretron Message "Fluid Flow Rate"
*
* This Fluid Flow Rate Message is used e.g. by MARETRON FFM100. With this
* fuel flow rate it is possible to monitor Diesel Fuel , Gasoline/Petrol
* Fuel Flow and Cooling Water Flow.
*
* see [Maretron FFM100] (https://www.maretron.com/products/ffm100.php)
*
* \note Flow Rate should be in lt/hour
*
* \param N2kMsg Reference to a N2kMsg Object,
* Output: NMEA2000 message ready to be send.
* \param SID Sequence ID. If your device is e.g. boat speed and
* heading at same time, you can set same SID for
* different messages to link this PGN to other related
* PGNs. When no linkage exists, the value of the SID
* shall be set to 255
* \param FlowRateInstance This should be unique at least on one device. May
* be best to have it unique over all devices sending
* this PGN.
* \param FluidType Type of Fluid, see \ref tN2kFluidType [possible
* values for this field include Fuel, Fresh Water,
* Waste Water, Live Well, Oil, and Black Water]
* \param FluidFlowRate This field is used to indicate the rate of fluid
* flow in units litres/hour.
*
*/
void SetN2kMaretronPGN65286(tN2kMsg &N2kMsg, unsigned char SID, unsigned char FlowRateInstance, tN2kFluidType FluidType,
double FluidFlowRate);
/************************************************************************//**
* \brief Setting up Maretron Message "Fluid Flow Rate" - PGN 65286
*
* Alias of PGN 65286. This alias was introduced to improve the readability
* of the source code. See parameter details on \ref SetN2kMaretronPGN65286
*
*/
inline void SetN2kMaretronFluidFR(tN2kMsg &N2kMsg, unsigned char SID, unsigned char FlowRateInstance, tN2kFluidType FluidType,
double FluidFlowRate) {
SetN2kMaretronPGN65286(N2kMsg,SID,FlowRateInstance,FluidType,FluidFlowRate);
}
/************************************************************************//**
* \brief Parsing the content of Maretron Message PGN 65286 "Fluid Flow Rate"
*
* This Fluid Flow Rate Message is used e.g. by MARETRON FFM100. With this
* fuel flow rate it is possible to monitor Diesel Fuel , Gasoline/Petrol
* Fuel Flow and Cooling Water Flow.
*
* see [Maretron FFM100] (https://www.maretron.com/products/ffm100.php)
*
* \note Flow Rate should be in lt/hour
*
* \param N2kMsg Reference to a N2kMsg Object,
* Output: NMEA2000 message ready to be send.
* \param SID Sequence ID. If your device is e.g. boat speed and
* heading at same time, you can set same SID for
* different messages to link this PGN to other related
* PGNs. When no linkage exists, the value of the SID
* shall be set to 255
* \param FlowRateInstance This should be unique at least on one device. May
* be best to have it unique over all devices sending
* this PGN.
* \param FluidType Type of Fluid, see \ref tN2kFluidType [possible
* values for this field include Fuel, Fresh Water,
* Waste Water, Live Well, Oil, and Black Water]
* \param FluidFlowRate This field is used to indicate the rate of fluid
* flow in units litres/hour.
*
* \return true Parsing of PGN Message successful
* \return false Parsing of PGN Message aborted
*
*/
bool ParseN2kMaretronPGN65286(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &FlowRateInstance, tN2kFluidType &FluidType,
double &FluidFlowRate);
/************************************************************************//**
* \brief Parsing the content of Maretron Message "Fluid Flow Rate" - PGN 65286
*
* Alias of PGN 65286. This alias was introduced to improve the readability
* of the source code. See parameter details on \ref ParseN2kMaretronPGN65286
*
*/
inline bool ParseN2kMaretronFluidFR(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &FlowRateInstance, tN2kFluidType &FluidType,
double &FluidFlowRate) {
return ParseN2kMaretronPGN65286(N2kMsg, SID, FlowRateInstance, FluidType, FluidFlowRate);
}
/************************************************************************//**
* \brief Setting up PGN 65287 for Maretron Message "Trip Volume"
*
* This Trip Volume Message is used e.g. by MARETRON FFM100. With this
* Trip Volume it is possible to monitor Diesel Fuel , Gasoline/Petrol
* Fuel Flow and Cooling Water Flow.
*
* see [Maretron FFM100] (https://www.maretron.com/products/ffm100.php)
*
* \note Volume should be in litres
*
* \param N2kMsg Reference to a N2kMsg Object,
* Output: NMEA2000 message ready to be send.
* \param SID Sequence ID. If your device is e.g. boat speed and
* heading at same time, you can set same SID for
* different messages to link this PGN to other related
* PGNs. When no linkage exists, the value of the SID
* shall be set to 255
* \param VolumeInstance This should be unique at least on one device. May
* be best to have it unique over all devices sending
* this PGN.
* \param FluidType Type of Fluid, see \ref tN2kFluidType [possible
* values for this field include Fuel, Fresh Water,
* Waste Water, Live Well, Oil, and Black Water]
* \param TripVolume This field is used to indicate the trip volume
* units of litres.
*/
void SetN2kMaretronPGN65287(tN2kMsg &N2kMsg, unsigned char SID, unsigned char VolumeInstance, tN2kFluidType FluidType,
double TripVolume);
/************************************************************************//**
* \brief Setting up Maretron Message "Trip Volume" - PGN 65287
*
* Alias of PGN 65287. This alias was introduced to improve the readability
* of the source code. See parameter details on \ref SetN2kMaretronPGN65287
*
*/
inline void SetN2kMaretronTripVolume(tN2kMsg &N2kMsg, unsigned char SID, unsigned char VolumeInstance, tN2kFluidType FluidType,
double TripVolume) {
SetN2kMaretronPGN65287(N2kMsg,SID,VolumeInstance,FluidType,TripVolume);
}
/************************************************************************//**
* \brief Parsing the content of Maretron Message PGN 65287 "Trip Volume"
*
* This Trip Volume Message is used e.g. by MARETRON FFM100. With this
* Trip Volume it is possible to monitor Diesel Fuel , Gasoline/Petrol
* Fuel Flow and Cooling Water Flow.
*
* see [Maretron FFM100] (https://www.maretron.com/products/ffm100.php)
*
* \note Volume should be in litres
*
* \param N2kMsg Reference to a N2kMsg Object,
* Output: NMEA2000 message ready to be send.
* \param SID Sequence ID. If your device is e.g. boat speed and
* heading at same time, you can set same SID for
* different messages to link this PGN to other related
* PGNs. When no linkage exists, the value of the SID
* shall be set to 255
* \param VolumeInstance This should be unique at least on one device. May
* be best to have it unique over all devices sending
* this PGN.
* \param FluidType Type of Fluid, see \ref tN2kFluidType [possible
* values for this field include Fuel, Fresh Water,
* Waste Water, Live Well, Oil, and Black Water]
* \param TripVolume This field is used to indicate the trip volume
* units of litres.
*
* \return true Parsing of PGN Message successful
* \return false Parsing of PGN Message aborted
*/
bool ParseN2kMaretronPGN65287(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &VolumeInstance, tN2kFluidType &FluidType,
double &TripVolume);
/************************************************************************//**
* \brief Parsing the content of Maretron Message "Trip Volume" - PGN 65287
*
* Alias of PGN 65287. This alias was introduced to improve the readability
* of the source code. See parameter details on \ref ParseN2kMaretronPGN65287
*
*/
inline bool ParseN2kMaretronTripVolume(const tN2kMsg &N2kMsg, unsigned char &SID, unsigned char &VolumeInstance, tN2kFluidType &FluidType,
double &TripVolume) {
return ParseN2kMaretronPGN65287(N2kMsg, SID, VolumeInstance, FluidType, TripVolume);
}
#endif