Main Content

bluetoothPathLossConfig

Bluetooth BR/EDR or LE path loss configuration parameters

Since R2022b

expand all in page

    Description

    The bluetoothPathLossConfig object specifies parameters for the bluetoothPathLoss function. Use the bluetoothPathLoss function to estimate the path loss between Bluetooth® basic rate/enhanced data rate (BR/EDR) or low energy (LE) devices.

    Creation

    Syntax

    cfgPathLoss = bluetoothPathLossConfig
    cfgPathLoss = bluetoothPathLossConfig(Name=Value)

    Description

    cfgPathLoss = bluetoothPathLossConfig creates a default Bluetooth BR/EDR or LE path loss estimation configuration object.

    cfgPathLoss = bluetoothPathLossConfig(Name=Value) sets properties by using one or more name-value arguments. For example, Environment="Home" sets the signal propagation environment to home.

    example

    Properties

    expand all

    Signal propagation environment, specified as "Home", "Industrial", "Office", or "Outdoor".

    Data Types: char | string

    Transmitter antenna gain, specified as a scalar or a row vector of values in the range [–10, 10]. Units are in dBi.

    Data Types: double

    Receiver antenna gain, specified as a scalar or a row vector of values in the range [–10, 10]. Units are in dBi.

    Data Types: double

    Transmitter cable loss, specified as a nonnegative scalar or a row vector. Units are in dB.

    Data Types: double

    Receiver cable loss, specified as a nonnegative scalar or a row vector. Units are in dB.

    Data Types: double

    Transmitter antenna height, specified as a positive scalar or a row vector. Units are in meters.

    Dependencies

    To enable this property, set the Environment property to "Outdoor".

    Data Types: double

    Receiver antenna height, specified as a positive scalar or a row vector. Units are in meters.

    Dependencies

    To enable this property, set the Environment property to "Outdoor".

    Data Types: double

    Path loss exponent of the specified environment, specified as a positive scalar.

    Dependencies

    To enable this property, set the Environment property to "Industrial".

    Data Types: double

    Standard deviation, specified as a nonnegative scalar. Units are in dB.

    Dependencies

    To enable this property, set the Environment property to "Industrial" or "Outdoor".

    Data Types: double

    Random number source, specified as "Global stream" or "mt19937ar with seed".

    • "Global stream" — The object generates a normally distributed random number by using the current global random number stream.

    • "mt19937ar with seed" — The object generates a normally distributed random number by using the mt19937ar algorithm.

    Data Types: char | string

    Initial seed for mt19937ar, specified as a nonnegative scalar.

    Dependencies

    To enable this property, set the RandomStream property to "mt19937ar with seed".

    Data Types: double

    This property is read-only.

    Path loss model of the specified environment, returned as 'TwoRayGroundReflection', 'LogNormalShadowing', or 'NISTPAP02Task6'.

    • If you set the Environment property to "Outdoor", this property returns the 'TwoRayGroundReflection' value.

    • If you set the Environment property to "Industrial", this property returns the 'LogNormalShadowing' value.

    • If you set the Environment property to "Home" or "Office", this property returns the 'NISTPAP02Task6' value.

    Data Types: char

    Examples

    collapse all

    Open Live Script

    Create a default Bluetooth path loss estimation configuration object. By default, the object specifies an outdoor environment.

    cfgPathLossOutdoor = bluetoothPathLossConfig;

    Specify the transmitter and receiver antenna heights, in meters.

    cfgPathLossOutdoor.TransmitterAntennaHeight = 2;
cfgPathLossOutdoor.ReceiverAntennaHeight = 3;

    Specify the standard deviation, in dB.

    cfgPathLossOutdoor.StandardDeviation = 1.6667
    cfgPathLossOutdoor = 
  bluetoothPathLossConfig with properties:

                 Environment: 'Outdoor'
      TransmitterAntennaGain: 0
         ReceiverAntennaGain: 0
        TransmitterCableLoss: 0
           ReceiverCableLoss: 0
    TransmitterAntennaHeight: 2
       ReceiverAntennaHeight: 3
           StandardDeviation: 1.6667
                RandomStream: 'Global stream'

   Read-only properties:
               PathLossModel: 'TwoRayGroundReflection'

    Create a Bluetooth path loss estimation configuration object for an industrial environment, specifying the path loss exponent as 2 and standard deviation as 0 dB. A path loss exponent value of 2 and a standard deviation of 0 dB signifies that the Bluetooth signal propagates in free space.

    cfgPathLossIndustrial = bluetoothPathLossConfig(Environment="Industrial", ...
    PathLossExponent=2,StandardDeviation=0)
    cfgPathLossIndustrial = 
  bluetoothPathLossConfig with properties:

               Environment: 'Industrial'
    TransmitterAntennaGain: 0
       ReceiverAntennaGain: 0
      TransmitterCableLoss: 0
         ReceiverCableLoss: 0
          PathLossExponent: 2
         StandardDeviation: 0
              RandomStream: 'Global stream'

   Read-only properties:
             PathLossModel: 'LogNormalShadowing'

    References

    [1] Bluetooth Technology Website. “Bluetooth Technology Website | The Official Website of Bluetooth Technology.” Accessed March 22, 2022. https://www.bluetooth.com/.

    [2] Bluetooth Core Specification 5.3. Bluetooth Special Interest Group (SIG), Accessed March 22, 2022. https://www.bluetooth.com/.

    Extended Capabilities

    C/C++ Code Generation
    Generate C and C++ code using MATLAB® Coder™.

    Version History

    Introduced in R2022b

    See Also

    Functions