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