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