bluetoothLENode

Bluetooth LE node

Since R2022a

expand all in page

    Description

    Use the bluetoothLENode object to create and configure a Bluetooth® low energy (LE) node. This feature also requires the Wireless Network Toolbox™ product.

    Creation

    Syntax

    LENode = bluetoothLENode
    LENode = bluetoothLENode(role)
    LENode = bluetoothLENode(___,Name=Value)

    Description

    LENode = bluetoothLENode creates a default Bluetooth LE node object with a "peripheral" role.

    LENode = bluetoothLENode(role) creates a Bluetooth LE node object with the Role property set to role.

    example

    LENode = bluetoothLENode(___,Name=Value) sets writable properties using one or more name-value arguments, in addition to any combination of input arguments from previous syntaxes. For example, TransmitterPower=0 sets the transmitter power of the Bluetooth LE Node to 0 dBm.

    As long as the Role property is not "broadcaster-observer", you can use this syntax to generate a row vector of Bluetooth LE node objects by specifying the Position property.

    Name-Value Arguments

    expand all

    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: bluetoothLENode(InterferenceModeling="non-overlapping-adjacent-channel") sets the type of interference modeling to "non-overlapping-adjacent-channel".

    Type of interference modeling, specified as "overlapping-adjacent-channel" or "non-overlapping-adjacent-channel".

    • "overlapping-adjacent-channel" — The object considers signals overlapping in time and frequency to be interference. In this figure, fS, fE, and fC are the starting, ending, and center frequencies of the signal of interference (SOI), respectively.

    • "non-overlapping-adjacent-channel" — In addition to signals that satisfy the conditions described under "overlapping-adjacent-channel", the object considers signals that overlap with the SOI in time and with the interval [fS – fD, fE + fD] in frequency to be interference. fS, fE, and fC are the starting, ending, and center frequencies of the SOI, respectively. fD is the value of the MaxInterferenceOffset property.

    This name-value argument sets the InterferenceModeling property.

    Data Types: char | string

    Maximum frequency offset for determining signal interference, specified as a nonnegative scalar. Units are in Hz. This property specifies the offset between the edge of the SOI frequency and the edge of the interfering signal. If you specify this property as Inf, the object considers all the signals that overlap in time, regardless of their frequency, to be interference. If you specify this property as a finite nonnegative scalar, the object considers all the signals overlapping in time and with frequency in the range [(f1 – MaxInterferenceOffset), (f2 + MaxInterferenceOffset)], to be interference.

    This name-value argument sets the MaxInterferenceOffset property.

    Dependencies

    To use this argument, you must specify the InterferenceModeling argument as "non-overlapping-adjacent-channel".

    Data Types: double

    Properties

    expand all

    This property is read-only.

    Role of the Bluetooth LE node, specified as one of these values.

    Role Value Description
    "central"Simulate Bluetooth LE piconet (data and audio)
    "peripheral"Simulate Bluetooth LE piconet (data and audio)
    "broadcaster"

    Simulate Bluetooth LE node scenario with periodic or legacy advertisements

    "observer"Simulate Bluetooth LE node scenario with periodic advertisements
    "isochronous-broadcaster"Simulate Bluetooth LE broadcast audio network
    "synchronized-receiver"Simulate Bluetooth LE broadcast audio network
    "broadcaster-observer"Simulate Bluetooth LE mesh network

    The role argument sets the value of this property.

    Data Types: char | string

    Node Position in 3-D Cartesian coordinates, specified as a numeric N-by-3 matrix. N specifies the number of Bluetooth LE nodes. This value specifies the position of the node in Cartesian x-, y-, and z-coordinates. When you specify this value as a matrix with N > 1, you create a 1-by-N vector of the bluetoothLENode object. Units are in meters. Note that if the Role value is "broadcaster-observer" and you specify the MeshConfig property to create mesh nodes, you can only create one node at a time, and N must be 1.

    Data Types: double

    Node name, specified as a character vector, string scalar, string vector, or cell array of character vectors. The default format of this value is "NodeN", where N is the node identifier specified by the ID property. When you specify the Position property to create a row vector of the bluetoothNode objects, you can simultaneously name each node in the vector by providing this value as a string vector or a cell array of character vectors. If you specify this value as a vector that exceeds the number of nodes, the object does not use the surplus names. Conversely, if you specify this value as a vector that is smaller than the number of nodes, the object assigns default names to the additional nodes.

    Note

    Since R2026a, you can set this property only when you create the object. After creation, the property is read-only. In releases R2025b and earlier, after creating the object, you can set the value of this property for one Bluetooth LE node object at a time.

    Data Types: char | string

    Signal transmission power, specified as a scalar in the range [-20, 20]. Specify this value in dBm. This value specifies the average power that the transmitter applies to the Bluetooth LE signal before sending it to the antenna.

    Data Types: double

    Transmitter antenna gain, specified as a finite numeric scalar. Specify this value in dB.

    Data Types: double

    Note

    The Bluetooth LE node transmits each packet at a total power equal to the sum of its TransmitPower and TransmitGain properties.

    Receiver antenna gain, specified as a finite numeric scalar. Specify this value in dB.

    Data Types: double

    Receiver sensitivity, specified as a finite numeric scalar. Specify this value in dBm. This property sets the minimum received power to detect the incoming signal. If the received power of an incoming signal is below this value, the node considers the signal invalid.

    Data Types: double

    Noise figure, specified as a finite nonnegative numeric scalar. Specify this value in dB. Use this value to add thermal noise to the received signal.

    Data Types: double

    Periodic interval between consecutive advertising events, specified as a scalar in the range [0.02, 10485.759375]. Specify this value in seconds. You must set this value as an integer multiple of 0.625 milliseconds. This value specifies the interval of an advertising event during which the transmission of advertising packets occurs.

    Data Types: double

    Random selection of advertising channels, specified as 0 (false) or 1 (true). To model the random selection of advertising channels, set this value to true.

    Data Types: logical

    Interval between consecutive scan events, specified as a scalar in the range [0.0025, 40.960]. Specify this value in seconds. You must set this value as an integer multiple of 0.625 milliseconds. This value specifies the interval in which the node listens for the advertising packets.

    Data Types: double

    Bluetooth mesh profile configuration parameters, specified as a bluetoothMeshProfileConfig object.

    Dependencies

    To enable this property, set the Role property to "broadcaster-observer".

    Since R2026a

    Bluetooth LE generic access profile (GAP) configuration parameters for the connection procedure, specified as a bluetoothLEGAPConfig object.

    This property is read-only.

    Type of interference modeling, specified as "overlapping-adjacent-channel" or "non-overlapping-adjacent-channel".

    • "overlapping-adjacent-channel" — The object considers signals overlapping in time and frequency to be interference. In this figure, fS, fE, and fC are the starting, ending, and center frequencies of the signal of interference (SOI), respectively.

    • "non-overlapping-adjacent-channel" — In addition to signals that satisfy the conditions described under "overlapping-adjacent-channel", the object considers signals that overlap with the SOI in time and with the interval [fS – fD, fE + fD] in frequency to be interference. fS, fE, and fC are the starting, ending, and center frequencies of the SOI, respectively. fD is the value of the MaxInterferenceOffset property.

    Data Types: char | string

    This property is read-only.

    Maximum frequency offset for determining signal interference, specified as a nonnegative scalar. Units are in Hz. This property specifies the offset between the edge of the SOI frequency and the edge of the interfering signal. If you specify this property as Inf, the object considers all the signals that overlap in time, regardless of their frequency, to be interference. If you specify this property as a finite nonnegative scalar, the object considers all the signals overlapping in time and with frequency in the range [(f1 – MaxInterferenceOffset), (f2 + MaxInterferenceOffset)], to be interference.

    Dependencies

    To enable this property, set the InterferenceModeling property to "non-overlapping-adjacent-channel".

    Data Types: double

    This property is read-only.

    Node identifier, returned as an integer. This value specifies a unique identifier for the node in the simulation.

    Note

    If you create and store the Bluetooth LE nodes in an uninitialized matrix, the IDs that this property allocates to the nodes can be nonsequential because of the memory allocation to the object in the matrix. For more information about MATLAB memory allocation, see How MATLAB Allocates Memory.

    Data Types: double

    This property is read-only.

    Bluetooth LE LL connection configuration parameters, returned as a bluetoothLEConnectionConfig object.

    Dependencies

    To enable this property, set the Role property to "central" or "peripheral".

    This property is read-only.

    Connected isochronous stream (CIS) connection configuration object, specified as a bluetoothLECISConfig object or a vector of objects of the type bluetoothLECISConfig. To configure multiple CIS connections, set this property as a vector of objects of the type bluetoothLECISConfig. Note that you can configure a maximum of 31 CIS connections.

    Dependencies

    To enable this property, set the Role property to "central" or "peripheral".

    This property is read-only.

    Periodic advertising configuration object, returned as an object or a vector of objects of the type bluetoothLEPeriodicAdvConfig. This property specifies the synchronization information shared between the Broadcaster and Observer as part of the periodic advertisements establishment process.

    Dependencies

    To enable this property, set the Role property to "broadcaster" or "observer".

    This property is read-only.

    Bluetooth LE BIG configuration parameters, returned as a bluetoothLEBIGConfig object.

    Dependencies

    To enable this property, set the Role property to "isochronous-broadcaster" or "synchronized-receiver".

    This property is read-only.

    Friendship configuration object for Friend and LPN, returned as a bluetoothMeshFriendshipConfig object.

    Dependencies

    To enable this property, set the Role property to "broadcaster-observer".

    Since R2026a

    Node mobility model, represented as an object of a subclass of wnet.Mobility class.

    Note

    Only the bluetoothLENode subclass can set the Mobility property in its constructor or methods. The addMobility object function of the bluetoothLENode object adds a mobility model to Bluetooth LE nodes.

    Since R2026a

    This property is read-only.

    Node velocity in 3-D Cartesian coordinates, represented as a three-element numeric row vector. The units are in meters per second.

    Data Types: double

    Object Functions

    expand all

    addMobilityAdd random waypoint mobility model to Bluetooth LE node
    addTrafficSourceAdd data traffic source to Bluetooth LE node
    updateChannelListProvide updated channel list to Bluetooth LE node
    kpiReturns key performance indicators (KPIs) for Bluetooth LE nodes
    registerEventCallbackRegister callback for event from Bluetooth LE node
    statisticsGet statistics of Bluetooth LE node

    Examples

    collapse all

    This example uses:

    Open Live Script

    This example enables you to:

    1. Create and configure a Bluetooth LE piconet with Central and Peripheral nodes.

    2. Create and configure a link layer (LL) connection between Central and Peripheral nodes.

    3. Add application traffic from the Central to Peripheral nodes.

    4. Create a custom channel, and plug it into the wireless network simulator.

    5. Simulate Bluetooth LE network and retrieve the statistics of the Central and Peripheral nodes.

    Create a wireless network simulator.

    networkSimulator = wirelessNetworkSimulator.init;

    Create a Bluetooth LE node, specifying the role as "central". Specify the name and position of the node.

    centralNode = bluetoothLENode("central",Name="CentralNode");
centralNode.Position = [0 0 0];                 % In x-, y-, and z-coordinates in meters

    Create a Bluetooth LE node, specifying the role as "peripheral". Specify the name and position of the node.

    peripheralNode = bluetoothLENode("peripheral",Name="PeripheralNode");
peripheralNode.Position = [10 0 10]              % In x-, y-, and z-coordinates in meters
    peripheralNode = 
  bluetoothLENode with properties:

        TransmitterPower: 20
         TransmitterGain: 0
            ReceiverGain: 0
     ReceiverSensitivity: -100
             NoiseFigure: 0
    InterferenceModeling: "overlapping-adjacent-channel"
                    Role: "peripheral"
        ConnectionConfig: [0×0 bluetoothLEConnectionConfig]
               CISConfig: [0×0 bluetoothLECISConfig]
                Position: [10 0 10]
                    Name: "PeripheralNode"
                Mobility: []

   Read-only properties:
                      ID: 2
                Velocity: [0 0 0]

    Add a random waypoint mobility model to the Bluetooth peripheral node. Set the shape of the node's mobility area to "circle".

    addMobility(peripheralNode,BoundaryShape="circle",RefreshInterval=0.1)

    Create a default Bluetooth LE configuration object to share the LL connection between the Central and Peripheral nodes.

    cfgConnection = bluetoothLEConnectionConfig;

    Specify the connection interval and connection offset. Throughout the simulation, the object establishes LL connection events for the duration of each connection interval. The connection offset is from the beginning of the connection interval. 

    cfgConnection.ConnectionInterval = 0.01; % In seconds
cfgConnection.ConnectionOffset = 0;      % In seconds

    Specify the active communication period after the connection event is established between the Central and Peripheral nodes.

    cfgConnection.ActivePeriod = 0.01 % In seconds
    cfgConnection = 
  bluetoothLEConnectionConfig with properties:

    ConnectionInterval: 0.0100
         AccessAddress: "5DA44270"
          UsedChannels: [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36]
             Algorithm: 1
          HopIncrement: 5
     CRCInitialization: "012345"
    SupervisionTimeout: 1
               PHYMode: "LE1M"
         InstantOffset: 6
      ConnectionOffset: 0
          ActivePeriod: 0.0100
                MaxPDU: 251
                  TIFS: 1.5000e-04
                 TMCES: 1.5000e-04

    Configure the connection between Central and Peripheral nodes by using the configureConnection object function of the bluetoothLEConnectionConfig object.

    configureConnection(cfgConnection,centralNode,peripheralNode);

    Create a networkTrafficOnOff (Wireless Network Toolbox) object to generate an On-Off application traffic pattern. Specify the data rate in kb/s and the packet size in bytes. Enable packet generation to generate an application packet with a payload.

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

    Add application traffic from the Central to the Peripheral node by using the addTrafficSource object function.

    addTrafficSource(centralNode,traffic,DestinationNode=peripheralNode);

    Create a Bluetooth LE network consisting of a Central and a Peripheral node.

    nodes = {centralNode peripheralNode};

    Add the Central and Peripheral nodes to the wireless network simulator.

    addNodes(networkSimulator,nodes)

    Add the custom channel to the wireless network simulator.

    addChannelModel(networkSimulator,@addImpairment);

    Set the simulation time in seconds and run the simulation.

    simulationTime = 0.5;
run(networkSimulator,simulationTime)

    Retrieve application, link layer (LL), and physical layer (PHY) statistics corresponding to the Central and Peripheral nodes. For more information about the statistics, see Bluetooth LE Node Statistics.

    centralStats = statistics(centralNode)
    centralStats = struct with fields:
    Name: "CentralNode"
      ID: 1
     App: [1×1 struct]
      LL: [1×1 struct]
     PHY: [1×1 struct]


    peripheralStats = statistics(peripheralNode)
    peripheralStats = struct with fields:
    Name: "PeripheralNode"
      ID: 2
     App: [1×1 struct]
      LL: [1×1 struct]
     PHY: [1×1 struct]

    Follow these steps to create a custom channel that models Bluetooth path loss for an industrial scenario.

    • Create a custom function with this syntax: rxData = customFcnName(rxInfo,txData). The rxInfo input specifies the receiver node information as a structure, and the txData input specifies the transmitted packets as a structure. The simulator automatically passes information about the receiver node and the packets transmitted by a transmitter node as inputs to the custom function. For more information about creating custom channel, see the addChannelModel (Wireless Network Toolbox) object function.

    • Use the bluetoothPathLossConfig object to set path loss configuration parameters for an industrial scenario.

    • Calculate path loss between the Central and Peripheral nodes using the bluetoothPathLoss function. Specify the transmitter and receiver positions.

    • Apply path loss to the transmitted packets.

    function rxData = addImpairment(rxInfo,txData)

    pathlossCfg = bluetoothPathLossConfig(Environment="Industrial");

    % Apply path loss and update output signal
    rxData = txData;

    % Calculate the distance between transmitter and receiver in meters
    distance = norm(rxData.TransmitterPosition - rxInfo.Position);
    pathloss = bluetoothPathLoss(distance,pathlossCfg);
    rxData.Power = rxData.Power-pathloss;                           % In dBm
    scale = 10.^(-pathloss/20);
    [numSamples,~] = size(rxData.Data);
    rxData.Data(1:numSamples,:) = rxData.Data(1:numSamples,:)*scale;
end

    More About

    expand all

    References

    [1] Bluetooth Technology Website. “Bluetooth Technology Website | The Official Website of Bluetooth Technology.” Accessed January 10, 2026. https://www.bluetooth.com/.

    [2] Bluetooth Core Specifications Working Group. "Bluetooth Core Specification" v6.1. https://www.bluetooth.com/specifications/specs/core-specification-6-1/.

    Version History

    Introduced in R2022a

    expand all

    See Also

    Objects

    Topics