Configuring the Emulator - adjacentlink/emane GitHub Wiki

Contents

Configuration Parameters

The following configuration parameters are available to tailor layer functionality:

antennaprofilemanifesturi

URI of the antenna profile manifest to load. The antenna profile manifest contains a list of antenna profile entries. Each entry contains a unique profile identifier, an antenna pattern URI and an antenna blockage URI. This parameter is required when antennaprofileenable is on or if any other NEM participating in the emulation has antennaprofileenable set on, even in the case where antennaprofileenable is off locally.

Type: string
Running-State Modifiable: no
Occurrence Range: [1,1]

controlportendpoint

IPv4 or IPv6 control port endpoint.

Type: inetaddr
Running-State Modifiable: no
Value Required: yes
Occurrence Range: [1,1]

eventservicedevice

Device to associate with the Event Service channel multicast endpoint.

Type: string
Running-State Modifiable: no
Occurrence Range: [1,1]

eventservicegroup

IPv4 or IPv6 Event Service channel multicast endpoint.

Type: inetaddr
Running-State Modifiable: no
Value Required: yes
Occurrence Range: [1,1]

eventservicettl

Device to associate with the Event Service channel multicast endpoint.

Type: uint8
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,255]
Default Value(s): 1

otamanagerchannelenable

Enable OTA channel multicast communication.

Type: bool
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [no,yes]
Default Value(s): yes

otamanagerdevice

Device to associate with the OTA channel multicast endpoint.

Type: string
Running-State Modifiable: no
Occurrence Range: [1,1]

otamanagergroup

IPv4 or IPv6 OTA channel multicast endpoint.

Type: inetaddr
Running-State Modifiable: no
Occurrence Range: [1,1]

otamanagerloopback

Enable multicast loopback on the OTA channel multicast channel.

Type: bool
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [no,yes]
Default Value(s): no

otamanagermtu

OTA channel MTU in bytes. Set to 0 to disable.

Type: uint32
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,4294967295]
Default Value(s): 0

otamanagerpartcheckthreshold

Defines the rate in seconds a check is performed to see if any OTA packet part reassembly efforts should be abandoned.

Type: uint16
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,65535]
Default Value(s): 2

otamanagerparttimeoutthreshold

Defines the threshold in seconds to wait for another OTA packet part for an existing reassembly effort before abandoning the effort.

Type: uint16
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,65535]
Default Value(s): 5

otamanagerttl

OTA channel multicast message TTL.

Type: uint8
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,255]
Default Value(s): 1

stats.event.maxeventcountrows

Event channel max event count table rows.

Type: uint32
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,4294967295]
Default Value(s): 0

stats.ota.maxeventcountrows

OTA channel max event count table rows.

Type: uint32
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,4294967295]
Default Value(s): 0

stats.ota.maxpacketcountrows

OTA channel max packet count table rows.

Type: uint32
Running-State Modifiable: no
Occurrence Range: [1,1]
Value Range: [0,4294967295]
Default Value(s): 0

Statistics

The below statistics can be accessed using emanesh.

Name Type Clearable Description
numEventChannelEventsRx uint64 yes
numEventChannelEventsTx uint64 yes
numOTAChannelDownstreamPackets uint64 yes
numOTAChannelEventsRx uint64 yes
numOTAChannelEventsTx uint64 yes
numOTAChannelUpstreamPackets uint64 yes
numOTAChannelUpstreamPacketsDroppedMissingPart uint64 yes

Statistic Tables

The below statistics can be accessed using emanesh.

Name Clearable Description
EventChannelEventCountTable yes EventChannel Event count table.
OTAChannelEventCountTable yes OTAChannel Event count table.
OTAChannelPacketCountTable yes OTA packet count table.