Engee documentation

EngeeRF.rfantenna

Creates an antenna element modeled as a transmitter, receiver, or transceiver.

Library

EngeeRF

Description

Use the system object EngeeRF.rfantenna to create an antenna element that can be modeled as a transmitter, receiver, or transceiver. When designing an RF system using an object rfbudget, it is possible to simulate an RF antenna using an object EngeeRF.rfantenna and add it to the RF system. This item can then be exported to the library. EngeeRF to analyze the circuit envelope.

Syntax

Creation

  • ant = EngeeRF.rfantenna() — creates a radio frequency (RF) antenna object with a gain factor 0 The dBi, whose properties are set by default.

  • ant = EngeeRF.rfantenna(Name=Value) — creates an RF antenna system object ant with properties set as a pair Name=Value, where Name — the name of the property, and Value — the appropriate value. You can specify multiple pairs «name-value» the order of the pairs does not matter. Unspecified properties retain their default values.

    Example: ant = EngeeRF.rfantenna(Gain = 10) creates an RF antenna object with a gain factor 10 DBI.

Arguments

Output arguments

# ant — RF antenna object

+ object

Details

An RF antenna object containing the following properties:

  • Gain — antenna gain;

  • Z — input impedance;

  • Type — type of antenna element;

  • TxEIRP — effective isotropically radiated power (EIRP) of the transmitting antenna to which the receiver is configured;

  • PathLoss — loss of the signal before it reaches the receiver;

  • Name — the name of the object as a string, for example "Antenna";

  • Ports — port names as a tuple of strings: ("p1",);

  • Terminals — terminal names in the form of a tuple of strings;

  • ParentNodes — nodes of the parent schema in the form of a vector of integers, displayed only after adding the child schema to the parent schema;

  • ParentPath — the full path to the parent schema as a string, displayed only after adding the child schema to the parent schema.;

  • NumPorts — number of ports;

  • Parent — the parent circuit that the chain object belongs to.

Features

# Gain — antenna gain, dBi

+ 0.0 (by default) | scalar | vector

Details

Antenna gain in dBi, set as a non-negative scalar or a two-element vector (default value — [0.0, 0.0]).

Specify the property Gain in the form of a vector of two elements, if for the property Type the value is set "TransmitReceive". To control the Effective Isotropic Radiated Power (EIRP), change the gain of the antenna element.

Типы данных

Float64

# Z — input impedance, ohms

+ 50.0 (by default) | scalar | vector

Details

The input impedance of the RF antenna element in ohms, set as a positive scalar or a vector of two elements (default value — ComplexF64[50.0 + 0.0im, 50.0 + 0.0im]).

Specify the property Z in the form of a vector of two elements, if for the property Type the value is set "TransmitReceive".

Типы данных

Float64

Support for complex numbers

Yes

# Type — type of antenna element

+ "Transmitter" (by default) | "Receiver" | "TransmitReceive"

Details

The type of antenna element specified as "Transmitter", "Receiver" or "TransmitReceive". If for the property Type the value is set "TransmitReceive" The transmitting and receiving antennas work simultaneously.

Типы данных

String

# TxEIRP is the effective isotropically radiated power of the transmitting antenna to which the receiver is tuned, dBm

+ −30.0 (by default) | scalar

Details

The value of the Effective Isotropically Radiated Power (EIRP) of the transmitting antenna to which the receiver is configured, set as a scalar in dBm.

This property must be set when designing the receiving antenna element.

Типы данных

Float64

# PathLoss — signal loss before it reaches the receiver, dB

+ 0.0 (default) | scalar

Details

The loss in dB that the signal carries before reaching the receiver, set as a non-negative scalar.

Dependencies

To use this property, set for the property Type meaning "Receiver" or "TransmitReceive".

Типы данных

Float64

# Name — the name of the RF antenna element

+ "Antenna" (by default) | line

Details

The name of the RF antenna element, set as a string.

Типы данных

String

# Terminals — names of RF antenna terminals

+ ("p1+", "p1−") (by default) | tuple of strings

Details

The names of the RF antenna terminals, set as a tuple of strings.

This property is read-only.

# NumPorts — number of input and output ports

+ 1 (by default) | scalar

Details

The number of input and output ports in the RF antenna element, set as a positive scalar.

This property is read-only.
Типы данных

Int64

Methods

sparameters: Calculation of S-parameters for radio frequency data, networks, circuits and related objects

Examples

Creating a transceiver antenna element

Details

Let’s create a radio frequency antenna element in the configuration «The transmitter and receiver». Let’s set the gain and the impedance of the transmitting antenna equal 5 dB and 45 Ohms, respectively, and the gain and impedance of the receiving antenna — 6 dB and 55 Om, respectively.

import EngeeRF: rfantenna

ant = rfantenna(Type = "TransmitReceive", Gain = [5, 6], Z = [45, 55])

println("Gain: ", ant.Gain,
        "\nZ: ", ant.Z,
        "\nType: ", ant.Type,
        "\nTxEIRP: ", ant.TxEIRP,
        "\nPathLoss: ", ant.PathLoss,
        "\nName: ", ant.Name)
Gain: [5.0, 6.0]
Z: ComplexF64[45.0 + 0.0im, 55.0 + 0.0im]
Type: TransmitReceive
TxEIRP: -30.0
PathLoss: 0.0
Name: Antenna

Calculate the S-parameters of the radio frequency element of the antenna in the configuration «The transmitter and receiver» on the frequency 1 GHz. Let’s output the properties of the S-parameter object.

import EngeeRF: sparameters

sparam = sparameters(ant, 1e9)

println("Impedance: ", sparam.Impedance,
        "\nNumPorts: ", sparam.NumPorts,
        "\nParameters: ", sparam.Parameters,
        "\nFrequencies: ", sparam.Frequencies)
Impedance: 50.0
NumPorts: 1
Parameters: ComplexF64[-0.0025062656641604013 + 0.0im;;;]
Frequencies: [1.0e9]