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