pud: add UUID nodeId type
[olsrd.git] / lib / pud / olsrd.conf.sample
1 LoadPlugin "<olsrd plugin library path>/olsrd_pud.so.1.1.0"
2 {
3     # nodeId contains the node identification. It first describes the semantics
4     #        (meaning/code) of the identification and then specifies the node
5     #        identification itself.
6     #        For some codes the identification itself is not relevant and
7     #        therefore ignored (specified if so).
8     #
9     #        The format is "number,identification"
10     #
11     #        "Number" is a number in the range 0-255, with the following
12     #        meaning:
13     #           0 : MAC address of sending interface
14     #               (identification is not relevant)
15     #           1 : an MSISDN number with 15 digits
16     #           2 : a Tetra number with 17 digits
17     #           3 : a DNS name
18     #               (identification can be empty, in which case the hostname is
19     #                used)
20     #           4 : IPv4 address (OLSR main address) of the sending node
21     #               (identification is not relevant)
22     #           5 : an UUID number with 32 hexadecimal digits
23     #           6 : IPv6 address (OLSR main address) of the sending node
24     #               (identification is not relevant)
25     #           7 : an AIS MMSI number with 9 digits
26     #           8 : a URN number (a plain 24 bits number) with 8 digits. See
27     #               http://www.dtic.mil/cjcs_directives/cdata/unlimit/3156_01.pdf
28     #           9 : a MIP OID number with 20 digits. See
29     #               http://www.mip-site.org/publicsite (IR Annex D – DMWG,
30     #               20081211, Edition 3.7, Annex D Key Management for the MIP
31     #               Data Model, (MIR Annex D - Key Management-JC3IEDM-3.0.9.pdf)
32     #         192 : a 7 digit number conforming to 'Nationaal Nummerplan
33     #               Brandweer Nederland'
34     #         193 : a 6 digit number conforming to 'Nationaal Nummerplan
35     #               Ambulancezorg Nederland'
36     #         194 : a 4 digit number in the range [1, 8191]
37     #
38     #         other numbers are reserved
39     #
40     # Note: setting "number" to 4 or 6 is the same for olsrd: both mean 'use
41     #       the main IP address, which is either an IPv4 or an IPv6 address,
42     #       depending on the IP version under which olsrd is run.
43     #
44     # Note: Both the number and the identification are transported over OLSR,
45     #       so care must be taken to keep the size of the identification down.
46     #
47     # Default: "4" (when olsrd is run under IPv4)
48     #          "6" (when olsrd is run under IPv6)
49     #
50     #PlParam     "nodeId"                       "4"
51
52
53     #
54     # RX Parameters
55     #
56
57     # rxNonOlsrIf is a network interface on the host on which the plugin will
58     #             listen for GPS multicasts. Multiple such interfaces can be
59     #             specified by specifying the parameter multiple times.
60     #
61     # Default: none
62     #
63     #PlParam     "rxNonOlsrIf"                  ""
64
65     # rxAllowedSourceIpAddress is an IP address from which the plugin is
66     #                          allowed to process/parse GPS sentences. When
67     #                          this parameter is not configured then GPS
68     #                          sentences from ALL IP addresses are processed.
69     #                          Multiple IP addresses can be specified by
70     #                          specifying the parameter multiple times.
71     #
72     # Default: none
73     #
74     #PlParam     "rxAllowedSourceIpAddress"     ""
75
76     # rxMcAddr is the multicast address on which the plugin will listen for GPS
77     #          multicasts.
78     #
79     # Default: 224.0.0.224 (IPv4) or FF02:0:0:0:0:0:0:1 (IPv6)
80     #
81     #PlParam     "rxMcAddr"                     "224.0.0.224"
82
83     # rxMcPort is the UDP port on which the plugin will listen for GPS
84     #          multicasts.
85     #
86     # Default: 2240
87     #
88     #PlParam     "rxMcPort"                     "2240"
89
90     # positionFile is the file that contains the position information that the
91     #              plugin should use. When this parameter is set then the
92     #              file is read during olsrd startup. An example file is
93     #              available in the doc directory of olsrd.
94     #
95     # Default: none
96     #
97     #PlParam "positionFile"                     ""
98
99     # Specifies the period in milliseconds on which to read the positionFile
100     # (if it changed) and activate its new setting for the position.
101     # This setting is only relevant if positionFile has been configured.
102     # A setting of zero disables dynamic updates, the positionFile is then only
103     # read during olsrd startup.
104     #
105     # Default: 0
106     #
107     #PlParam "positionFilePeriod" "0"
108
109
110     #
111     # TX Parameters
112     #
113
114     # txNonOlsrIf is a network interface on the host on which the plugin will
115     #             transmit GPS multicasts that were received through the OLSR
116     #             network. Multiple such interfaces can be specified by
117     #             specifying the parameter multiple times.
118     #
119     # Default: none
120     #
121     #PlParam     "txNonOlsrIf"                  ""
122
123     # txMcAddr is the multicast address on which the plugin will transmit GPS
124     #          multicasts that were received through the OLSR network.
125     #
126     # Default: 224.0.0.224 (IPv4) or FF02:0:0:0:0:0:0:1 (IPv6)
127     #
128     #PlParam     "txMcAddr"                     "224.0.0.224"
129
130     # txMcPort is the UDP port on which the plugin will transmit GPS multicasts
131     #          that were received through the OLSR network.
132     #
133     # Default: 2240
134     #
135     #PlParam     "txMcPort"                     "2240"
136
137     # txTtl is the TTL that is used when transmitting GPS multicasts that were
138     #       received through the OLSR network
139     #
140     # Default: 1
141     #
142     #PlParam     "txTtl"                        "1"
143
144     # txNmeaMessagePrefix is the NMEA message prefix of GPS multicasts that the
145     #                     plugin transmits. It must be exactly 4 characters
146     #                     long.
147     #
148     # Default: NBSX
149     #
150     #PlParam     "txNmeaMessagePrefix"          "NBSX"
151
152
153     #
154     # Uplink Parameters
155     #
156
157     # uplinkAddr is the IP address to which the plugin will transmit GPS
158     #            position updates. When not set, no uplink messages will be
159     #            sent.
160     #
161     # Default: none
162     #
163     #PlParam     "uplinkAddr"                   ""
164
165     # uplinkPort is the UDP port to which the plugin will transmit GPS position
166     #            updates. Can't be the same as the downlink port.
167     #
168     # Default: 2241
169     #
170     #PlParam     "uplinkPort"                   "2241"
171
172     # downlinkPort is the UDP port on which the plugin will receive GPS position
173     #              updates. Can't be the same as the uplink port.
174     #              The downlink is only active when a proper uplink has been
175     #              configured.
176     #
177     # Default: 2242
178     #
179     #PlParam     "downlinkPort"                 "2242"
180
181
182     #
183     # OLSR Parameters
184     #
185
186     # olsrTtl is the TTL that is used when sending messages over the OLSR
187     #         networks
188     #
189     # Default: 64
190     #
191     #PlParam     "olsrTtl"                      "64"
192
193
194     #
195     # Update Parameters
196     #
197
198     # updateIntervalStationary is the interval (in seconds) between position
199     #                          updates sent over the OLSR network when the
200     #                          node is stationary
201     #
202     # Default: 60
203     #
204     #PlParam     "updateIntervalStationary"     "60"
205
206     # updateIntervalMoving is the interval (in seconds) between position
207     #                      updates sent over the OLSR network when the
208     #                      node is moving
209     #
210     # Default: 5
211     #
212     #PlParam     "updateIntervalMoving"         "5"
213
214     # uplinkUpdateIntervalStationary is the interval (in seconds) between
215     #                                position updates sent over the uplink when
216     #                                the node is stationary
217     #
218     # Default: 180
219     #
220     #PlParam     "uplinkUpdateIntervalStationary"  "180"
221
222     # uplinkUpdateIntervalMoving is the interval (in seconds) between position
223     #                            updates sent over the OLSR network when the
224     #                            node is moving
225     #
226     # Default: 15
227     #
228     #PlParam     "uplinkUpdateIntervalMoving"      "15"
229
230     # gatewayDeterminationInterval is the interval (in seconds) on which
231     #                              determination of the best gateway is
232     #                              performed
233     #
234     # Default: 1
235     #
236     #PlParam     "gatewayDeterminationInterval"    "1"
237
238     # movingSpeedThreshold is the speed from which we consider the node is
239     #                      moving
240     #
241     # Default: 9
242     #
243     #PlParam     "movingSpeedThreshold"         "9"
244
245     # movingDistanceThreshold is the distance from the previous position from
246     #                         which we consider the node is moving
247     #
248     # Default: 50
249     #
250     #PlParam     "movingDistanceThreshold"      "50"
251
252     # dopMultiplier One of the situations that is seen as movement is when the
253     #               current position with its uncertainty circle no longer
254     #               overlaps the last transmitted position with its uncertainty
255     #               circle. This parameter is used to adjust the sizes of these
256     #               uncertainty circles: setting it to a value less than 1.0
257     #               will make both uncertainty circles smaller by this factor,
258     #               resulting in earlier movement detection. Setting it to a
259     #               value larger than 1.0 will detect movement later.
260     #
261     # Default: 2.5
262     #
263     #PlParam     "dopMultiplier"                "2.5"
264
265     # defaultHdop is the default value that is taken for HDOP (in meters) in
266     #             determining whether we are moving when there is a position
267     #             available but no HDOP.
268     #
269     # Default: 50
270     #
271     #PlParam     "defaultHdop"                  "50"
272
273     # defaultVdop is the default value that is taken for VDOP (in meters) in
274     #             determining whether we are moving when there is a position
275     #             available but no VDOP.
276     #
277     # Default: 50
278     #
279     #PlParam     "defaultVdop"                  "50"
280
281     # averageDepth is the depth of the position average list, or the number
282     #              of positions that are averaged to obtain the average
283     #              position
284     #
285     # Default: 5
286     #
287     #PlParam     "averageDepth"                 "5"
288
289     # hysteresisCountToStationary is the number of position updates that
290     #                             effectuate a state transition from moving to
291     #                             stationary that must be received before the
292     #                             actual transition is taken
293     #
294     # Default: 17
295     #
296     #PlParam     "hysteresisCountToStationary"  "17"
297
298     # hysteresisCountToMoving is the number of position updates that effectuate
299     #                         a state transition from stationary to moving that
300     #                         must be received before the actual transition is
301     #                         taken
302     #
303     # Default: 5
304     #
305     #PlParam     "hysteresisCountToMoving"      "5"
306
307     # gatewayHysteresisCountToStationary is the number of times the gateway
308     #                             must be the same that effectuate a state transition from
309     #                             moving to stationary that must be received
310     #                             before the actual transition is taken
311     #
312     # Default: 17
313     #
314     #PlParam     "gatewayHysteresisCountToStationary"  "17"
315
316     # gatewayHysteresisCountToMoving is the number of gateway updates that
317     #                         effectuate a state transition from stationary to
318     #                         moving that must be received before the actual
319     #                         transition is taken
320     #
321     # Default: 5
322     #
323     #PlParam     "gatewayHysteresisCountToMoving"      "5"
324
325
326     #
327     # Other Plugin Parameters
328     #
329
330     # useDeDup determines whether duplicate message detection is to be
331     #          performed. When 0 then no such detection is performed, when 1
332     #          then the detection is performed 
333     #
334     # Default: true
335     #
336     #PlParam     "useDeDup"                     "true"
337
338     # deDupDepth the number of messages that are tracked to detect duplucates
339     #            messages received from the OLSR network
340     #
341     # Default: 256
342     #
343     #PlParam     "deDupDepth"                   "256"
344
345     # useLoopback determines whether the message that is sent over the OLSR
346     #             network should be immediately looped back, thus pretending
347     #             that the message (that is sent by this node) is received from
348     #             the OLSR network. When 0 then no loopback is performed, when
349     #             1 then the loopback is performed
350     #
351     # Default: false
352     #
353     #PlParam     "useLoopback"                  "true"
354 }