NetworkInterface information of the wireless endpoint. More...

Methods
	Description.Get
	Returns a textual description of the object.

	DisplayName.Get
	Returns the display name of the interface. More...

	IPv4.Get
	Returns a list of IPv4 addresses of this interface. More...

	IPv6.Global.Get
	Returns a list of the Global IPv6 addresses of this interface. More...

	IPv6.LinkLocal.Get
	Returns a list of the LinkLocal addresses of this interface. More...

	Mac.Get
	Returns the mac-address of the interface. More...

	Name.Get
	Returns the name of the interface. More...

	Parent.Get
	Returns the parent object.

	Speed.Get
	Returns the link speed of the interface. More...

	Type.Get
	Returns the type of the network interface. More...

	WiFi.Bssid.Get
	Returns the BSSID with which the WiFi interface is connected. More...

	WiFi.Channel.Get
	Returns the channel of the Wireless interface. More...

	WiFi.Rssi.Get
	Returns the Received Signal Strength Indication (RSSI) of the Wireless interface. More...

	WiFi.RxRate.Get
	Returns the Receive rate in bps of the Wireless interface. More...

	WiFi.Ssid.Get
	Returns the SSID with which the Wi-Fi interface is connected. i. More...

	WiFi.TxRate.Get
	Returns the Transmit rate in bps of the Wireless interface. More...

Class overview

NetworkInterface information of the wireless endpoint.

Represents a network interface of a wireless endpoint.

Since: 2.6.0

Example

 set device [ $meeting_point Device.Get $uuid ] ;# we got a WirelessEndpoint 
  set deviceInfo [ $device Device.Info.Get ] 
  set networkInfo [ $deviceInfo Network.Info.Get ] 
  set interface_1 [ lindex [ $networkInfo Interface.Get ] 0 ] 
  printing MAC address of the first network interface 
  puts "MAC address: [ $interface_1 Mac.Get ]"

Definition at line 25238 of file api.tcl.

Method documentation

WirelessEndpoint.NetworkInterface::DisplayName.Get

Returns the display name of the interface.

Example

1 $interface DisplayName.Get

Returns:

enp0s3

Definition at line 25253 of file api.tcl.

WirelessEndpoint.NetworkInterface::IPv4.Get

Returns a list of IPv4 addresses of this interface.

Example

1 $interface IPv4.Get

Returns:

192.168.10.11

Definition at line 25263 of file api.tcl.

WirelessEndpoint.NetworkInterface::IPv6.Global.Get

Returns a list of the Global IPv6 addresses of this interface.

Example

1 $interface IPv6.Global.Get

Returns:

fdec:5ef9:84b5:1000:a00:27ff:fe5f:b447/64

Definition at line 25273 of file api.tcl.

WirelessEndpoint.NetworkInterface::IPv6.LinkLocal.Get

Returns a list of the LinkLocal addresses of this interface.

Example

1 $interface IPv6.LinkLocal.Get

Returns:

fe80::a00:27ff:fe5f:b447/64

Definition at line 25283 of file api.tcl.

WirelessEndpoint.NetworkInterface::Mac.Get

Returns the mac-address of the interface.

On some platforms (e.g. iOS) this isn't allowed so a fake address will be returned.

Example

1 $interface Mac.Get

Returns:

00:ff:1c:00:00:01

Definition at line 25295 of file api.tcl.

WirelessEndpoint.NetworkInterface::Name.Get

Returns the name of the interface.

Example

1 $interface Name.Get

Returns:

enp0s3

Definition at line 25305 of file api.tcl.

WirelessEndpoint.NetworkInterface::Speed.Get

Returns the link speed of the interface.

This method returns -1 when it's not possible to retrieve link speed. This can happen due to OS restrictions on the WEP or due to the interface not being connected to any network.

When the interface is a WiFi interface, the Transmit Speed is returned.

Since: 2.14.2

Example

1 $interface Speed.Get

Returns:

1000000000

Definition at line 25326 of file api.tcl.

WirelessEndpoint.NetworkInterface::Type.Get

Returns the type of the network interface.

possible values are

Unknown} {Loopback} {Ethernet} {WiFi}

Returns: the type of the interface

Since: 2.11.0

Example

1 $interface Type.Get

Returns:

WiFi

Definition at line 25342 of file api.tcl.

WirelessEndpoint.NetworkInterface::WiFi.Bssid.Get

Returns the BSSID with which the WiFi interface is connected.

Returns "00:00:00:00:00:00" string when the BSSID isn't available, either due to OS restrictions or due to no netwerk being connected.

Returns: BSSID string

Since: 2.11.0

Example

1 $interface WiFi.Bssid.Get

Returns:

00:bb:1f:00:12:34

Definition at line 25358 of file api.tcl.

WirelessEndpoint.NetworkInterface::WiFi.Channel.Get

Returns the channel of the Wireless interface.

We return this value as a number. For most devices, channels 1 to 14 are in in the 2.4 GHz band, higher values are used for the 5 GHz range.

This method returns -1 when the Wi-Fi channel isn't available. This can be either due to OS restrictions or simply the Wi-Fi not being connected.

Since: 2.11.0

Example

1 $interface WiFi.Channel.Get

Returns:

Definition at line 25374 of file api.tcl.

WirelessEndpoint.NetworkInterface::WiFi.Rssi.Get

Returns the Received Signal Strength Indication (RSSI) of the Wireless interface.

The value is numeric and represents the signal strength in dBm.

When no RSSI value is available (not connected or not allowed by the OS), this method returns -1.

Since: 2.11.0

Example

1 $interface WiFi.Rssi.Get

Returns:

-70

Definition at line 25390 of file api.tcl.

WirelessEndpoint.NetworkInterface::WiFi.RxRate.Get

Returns the Receive rate in bps of the Wireless interface.

This method returns -1 when it's not possible to retrieve the RxRate. This can happen due to OS restrictions on the WEP or due to the Wireless Endpoint not being connected to any Wi-Fi network

Since: 2.14.2

Example

1 $interface WiFi.RxRate.Get

Returns:

54000000

Definition at line 25404 of file api.tcl.

WirelessEndpoint.NetworkInterface::WiFi.Ssid.Get

Returns the SSID with which the Wi-Fi interface is connected. i.

Returns an empty string when the SSID isn't available, either due to OS restrictions or due to no netwerk being connected.

Since: 2.11.0

Example

1 $interface WiFi.Ssid.Get

Returns:

OfficeWireless

Definition at line 25418 of file api.tcl.

WirelessEndpoint.NetworkInterface::WiFi.TxRate.Get

Returns the Transmit rate in bps of the Wireless interface.

This method returns -127 when it's not possible to retrieve the TxRate. This can happen due to OS restrictions on the WEP or due to the Wireless Endpoint not being connected to any Wi-Fi network

Since: 2.11.0

Example

1 $interface WiFi.TxRate.Get

Returns:

54000000

Definition at line 25432 of file api.tcl.

Methods

Class overview

Method documentation