Main Content

addTrafficSource

Add data traffic source to WLAN node

Since R2023a

collapse all in page

Download Required: To use addTrafficSource, first download the Communications Toolbox Wireless Network Simulation Library add-on.

Syntax

addTrafficSource(nodeObj,trafficSource)
addTrafficSource(___,Name=Value)

Description

addTrafficSource(nodeObj,trafficSource) adds the data traffic source trafficSource to the WLAN node nodeObj.

example

addTrafficSource(___,Name=Value) specifies options using one or more name-value arguments in addition to the previous syntax.

Note

Reusing the same traffic source object in another addTrafficSource function call results in an error.

example

Examples

collapse all

This example uses:

Open Live Script

Simulate a wireless local area network (WLAN) using WLAN Toolbox™ with the Communications Toolbox™ Wireless Network Simulation Library.

In this example, you:

  1. Create and configure a WLAN with an access point (AP) node and a station (STA) node.

  2. Add application traffic from the AP node to the STA node.

  3. Simulate the WLAN and retrieve the statistics of the AP node and the STA node.

Check if the Communications Toolbox™ Wireless Network Simulation Library support package is installed. If the support package is not installed, MATLAB® returns an error with a link to download and install the support package.

wirelessnetworkSupportPackageCheck;

Create a wireless network simulator.

networksimulator = wirelessNetworkSimulator.init();

Create a wlanDeviceConfig object, specifying the operating mode and beacon interval. Use this configuration to create a WLAN node and specify its name and position.

deviceCfg = wlanDeviceConfig(Mode="AP",BeaconInterval=5);
apNode = wlanNode(Name="AP",Position=[0 10 0],DeviceConfig=deviceCfg);

Create a WLAN node with the default device configuration. Confirm that the default mode is STA.

staNode = wlanNode(Name="STA",Position=[5 0 0]);
disp(staNode.DeviceConfig.Mode)
STA

Add a random waypoint mobility model to the WLAN node with the default device configuration. Set the shape of the node's mobility area to "circle".

addMobility(staNode,BoundaryShape="circle");

Associate the STA node with the AP node using the associateStations function.

associateStations(apNode,staNode);

Create a networkTrafficOnOff object to generate an On-Off application traffic pattern. Specify the data rate in kilobits per second and the packet size in bytes.

traffic = networkTrafficOnOff(DataRate=100,PacketSize=10);

Add application traffic from the AP node to the STA node.

addTrafficSource(apNode,traffic,DestinationNode=staNode);

Add the AP node and STA node to the wireless network simulator.

addNodes(networksimulator,{apNode,staNode});

Set the simulation time in seconds and run the simulation.

simulationTime = 0.05;
run(networksimulator,simulationTime);

Get and display the physical layer (PHY) statistics that correspond to the AP node and STA node.

apStats = statistics(apNode);
staStats = statistics(staNode);
disp(apStats.PHY)
         TransmittedPackets: 135
    TransmittedPayloadBytes: 6093
            ReceivedPackets: 126
       ReceivedPayloadBytes: 1764
             DroppedPackets: 0

disp(staStats.PHY)
         TransmittedPackets: 126
    TransmittedPayloadBytes: 1764
            ReceivedPackets: 135
       ReceivedPayloadBytes: 6093
             DroppedPackets: 0

Input Arguments

collapse all

WLAN node, specified as a wlanNode object. The function adds a data traffic source to this node.

Data traffic source, specified as a networkTrafficOnOff, networkTrafficFTP, networkTrafficVideoConference, or networkTrafficVoIP object. The function adds this data traffic source to the WLAN node that you specify for the nodeObj argument.

When you add the application traffic to a WLAN node by using this object function, the nodeObj automatically calls the generate object function associated with the networkTrafficOnOff, networkTrafficFTP, networkTrafficVideoConference, or networkTrafficVoIP objects to generate the corresponding application traffic packet.

Note

The GeneratePacket property of this input does not apply to this object function.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: AccessCategory = 1 specifies that the access category of the generated traffic is from the Background category.

Destination node of the traffic, specified as a wlanNode object. If you do not specify this argument, the source node broadcasts its traffic.

If the source node is a STA multilink device (MLD) operating in EMLSR mode or an AP MLD with at least one associated EMLSR STA, you must specify this argument. (since R2024b)

Access category, specified as an integer in the range [0, 3]. The four possible values respectively correspond to the Best Effort, Background, Video, and Voice access categories.

Data Types: single | double

Version History

Introduced in R2023a

See Also

Objects