WirelessEndpoint Class Reference

A WirelessEndpoint is a handle to a wireless device-under-test. More...

Methods
	App.Version.Get
	Returns the App version. More...
	Capability.GetByName
	Returns a Capability object by its name. More...
	Capability.IsSupported
	Checks whether a capability is supported. More...
	Capability.List.Get
	Returns a list of Capability objects. More...
	Description.Get
	Returns a textual description of the object.
	Device.Identifier.Get
	Returns device identifier. More...
	Device.Info.Get
	Returns an object with the Wireless Endpoint DeviceInfo. More...
	Heartbeat.Count.Get
	Returns the number of heartbeats performed by the device. More...
	Heartbeat.Interval.Get
	Returns the heartbeat interval. More...
	Heartbeat.Interval.Set
	Sets the heartbeat interval. More...
	Heartbeat.MaxFailcount.Get
	Returns the maximum number of heartbeats that may fail before the Wireless Endpoint considers the communication broken. More...
	Heartbeat.MaxFailcount.Set
	Sets the maximum number of heartbeats that may fail before the Wireless Endpoint considers the communication broken. More...
	Heartbeat.Timestamp.Last.Get
	Returns the timestamp of the last received heartbeat. More...
	Lock.Get
	Indicates whether or not the device is locked. More...
	Lock.IsOwner
	Indicates whether or not we are the current owner of the lock. More...
	Lock.Owner.Get
	Returns the name of the current lock owner. More...
	Lock.Try Lock ExpectedCurrentState
	Tries to lock the Wireless Endpoint. More...
	Lock
	Locks or unlocks the device for exclusive access. More...
	Log.Clear
	Clears the log messages on the device. More...
	Log.Get
	Returns a string containing the device log messages. More...
	Log.Level.Get
	Gets the log level on the Wireless Endpoint. More...
	Log.Level.Set
	Sets the log level on the Wireless Endpoint. More...
	Parent.Get
	Returns the parent object.
	Prepare.Async
	PrepareAsync. More...
	Prepare
	Prepare. More...
	Protocol.Http.Client.Add
	Adds a httpClient to this mobile device. More...
	Protocol.Http.Client.Get
	Returns the list of HTTP clients created on this mobile device. More...
	Result.Async.Get
	Request the results without waiting for the reply. More...
	Result.Clear
	Clear the result list. More...
	Result.Get
	Request the results. More...
	Rx.Latency.Basic.Add
	Adding a RxLatency to this mobile device. More...
	Rx.Latency.Basic.Get
	Returns the list of latency triggers created on this mobile device. More...
	Rx.Latency.Distribution.Add
	Creates a latency calculator, which computes latency measurements based on timestamps in received frames (possibly restricted by a filter). More...
	Rx.Latency.Distribution.Get
	Returns the list of latency calculators created on this port. More...
	Rx.Trigger.Basic.Add
	Adding a RxTrigger to this mobile device. More...
	Rx.Trigger.Basic.Get
	Returns the list of receive triggers created on this mobile device. More...
	Scenario.Duration.Get
	Gets the duration of a scenario.
	Scenario.Duration.Set
	Sets the duration of a scenario in nanoseconds.
	Scenario.Heartbeat.Interval.Get
	Returns the heartbeat interval while running a scenario. More...
	Scenario.Heartbeat.Interval.Set
	Sets the heartbeat interval used when running a scenario. More...
	Start.Async
	Start without waiting for confirmation. More...
	Start
	Start the Scenario on the given Wireless Endpoint. More...
	Status.Get
	Returns the device status. More...
	Stop.Async
	Stop without waiting for confirmation. More...
	Stop
	Stop the Scenario on the given Wireless Endpoint. More...
	Tx.Stream.Add
	Adding a TxStream to this mobile device. More...
	Tx.Stream.Get
	Returns the list of streams created on this mobile device. More...

Class overview

A WirelessEndpoint is a handle to a wireless device-under-test.

Since

2.6.0

Example

This example shows how to obtain a WirelessEndpoint object from a MeetingPoint and configure a simple trigger.

set device [ $meeting_point Device.Get $uuid ] ;# we got a WirelessEndpoint 
 $device Lock 1 ;# lock the device so we have exclusive access  
 set trigger [ $device Rx.Trigger.Basic.Add ] ;# add a trigger 
 $trigger Filter.SourceAddress.Set $src_ip 
 $trigger Filter.UdpSourcePort.Set $src_port 
 $trigger Filter.UdpDestinationPort.Set $dst_port 
 $device Prepare ;# prepare device 
 $device Start ;# start listening 
 ... 
 $device Lock 0 ;# unlock the device 

Definition at line 25456 of file api.tcl.

Method documentation

WirelessEndpoint::App.Version.Get

Returns the App version.

Example

$wirelessEndpoint App.Version.Get

Returns:

1.0 

Definition at line 25466 of file api.tcl.

WirelessEndpoint::Capability.GetByName

Returns a Capability object by its name.

Since

2.6.0

Returns

A Capability OID

Exceptions

ByteBlower.Exception.API.ConfigError

UnsupportedConfig error message when the Capability is not supported

Example

$wirelessEndpoint Capability.GetByName "Tx.Latency"

Returns:

<Capability object> 

Definition at line 25482 of file api.tcl.

WirelessEndpoint::Capability.IsSupported

Checks whether a capability is supported.

Since

2.6.0

Returns

1 if it is supported, 0 if not

Example

$wirelessEndpoint Capability.IsSupported "Tx.Latency"

Returns:

0 

Definition at line 25496 of file api.tcl.

WirelessEndpoint::Capability.List.Get

Returns a list of Capability objects.

Since

2.6.0

Returns

A list of all Capability objects

Example

$wirelessEndpoint Capability.List.Get

Returns:

[ <Capability object> ... ] 

Definition at line 25510 of file api.tcl.

WirelessEndpoint::Device.Identifier.Get

Returns device identifier.

Example

$wirelessEndpoint Device.Identifier.Get

Returns:

65661629-5599-4f06-94c8-461353ecc563 

Definition at line 25525 of file api.tcl.

WirelessEndpoint::Device.Info.Get

Returns an object with the Wireless Endpoint DeviceInfo.

Since

2.6.0

Returns

<WirelessEndpoint.DeviceInfo object>

Example

$wirelessEndpoint Device.Info.Get

Returns:

<WirelessEndpoint.DeviceInfo object> 

Definition at line 25539 of file api.tcl.

WirelessEndpoint::Heartbeat.Count.Get

Returns the number of heartbeats performed by the device.

Example

$wirelessEndpoint Heartbeat.Count.Get

Returns:

42 

Definition at line 25549 of file api.tcl.

WirelessEndpoint::Heartbeat.Interval.Get

Returns the heartbeat interval.

1 second

Example

$wirelessEndpoint Heartbeat.Interval.Get

Returns:

1000000000 

Definition at line 25561 of file api.tcl.

WirelessEndpoint::Heartbeat.Interval.Set

Sets the heartbeat interval.

Note

Default value is 1 second.

When set to a value below the minimum value supported by the Wireless Endpoint device, the lowest supported value will be used.

Example

$wirelessEndpoint Heartbeat.Interval.Set 1s

Definition at line 25575 of file api.tcl.

WirelessEndpoint::Heartbeat.MaxFailcount.Get

Returns the maximum number of heartbeats that may fail before the Wireless Endpoint considers the communication broken.

Example

$wirelessEndpoint Heartbeat.MaxFailcount.Get

Returns:

2 

Definition at line 25585 of file api.tcl.

WirelessEndpoint::Heartbeat.MaxFailcount.Set

Sets the maximum number of heartbeats that may fail before the Wireless Endpoint considers the communication broken.

Example

$wirelessEndpoint Heartbeat.MaxFailcount.Set 2

Definition at line 25595 of file api.tcl.

WirelessEndpoint::Heartbeat.Timestamp.Last.Get

Returns the timestamp of the last received heartbeat.

Example

$wirelessEndpoint Heartbeat.Timestamp.Last.Get

Returns:

1479805234354895320 

Definition at line 25605 of file api.tcl.

WirelessEndpoint::Lock

Locks or unlocks the device for exclusive access.

Example

$wirelessEndpoint Lock 1 ;# lock the device 

$wirelessEndpoint Lock 0 ;# unlock the device 

Definition at line 25655 of file api.tcl.

WirelessEndpoint::Lock.Get

Indicates whether or not the device is locked.

Example

$wirelessEndpoint Lock.Get

Definition at line 25615 of file api.tcl.

WirelessEndpoint::Lock.IsOwner

Indicates whether or not we are the current owner of the lock.

Example

$wirelessEndpoint Lock.Owner.Get

Definition at line 25625 of file api.tcl.

WirelessEndpoint::Lock.Owner.Get

Returns the name of the current lock owner.

Example

$wirelessEndpoint Lock.Owner.Get

Definition at line 25635 of file api.tcl.

WirelessEndpoint::Lock.Try			Lock ExpectedCurrentState

Tries to lock the Wireless Endpoint.

Parameters

Lock
ExpectedCurrentState

Returns

1 if the operation succeeded, 0 if the operation failed

Example

$wirelessEndpoint Lock.Try 1 0

Returns:

1 

Definition at line 25645 of file api.tcl.

WirelessEndpoint::Log.Clear

Clears the log messages on the device.

Example

$wirelessEndpoint Log.Clear

Definition at line 25665 of file api.tcl.

WirelessEndpoint::Log.Get

Returns a string containing the device log messages.

Example

$wirelessEndpoint Log.Get

Definition at line 25675 of file api.tcl.

WirelessEndpoint::Log.Level.Get

Gets the log level on the Wireless Endpoint.

Example

$wirelessEndpoint Log.Level.Get

Returns:

INFO 

Definition at line 25685 of file api.tcl.

WirelessEndpoint::Log.Level.Set

Sets the log level on the Wireless Endpoint.

Accepted log levels are DEBUG, INFO, WARNING, ERROR, CRITICAL

Example

$wirelessEndpoint Log.Level.Set INFO

Definition at line 25697 of file api.tcl.

WirelessEndpoint::Prepare

Prepare.

Example

$wirelessEndpoint Prepare

Definition at line 25722 of file api.tcl.

WirelessEndpoint::Prepare.Async

PrepareAsync.

Example

$wirelessEndpoint Prepare.Async

Definition at line 25712 of file api.tcl.

WirelessEndpoint::Protocol.Http.Client.Add

Adds a httpClient to this mobile device.

Returns

<Layer5.Http.Client.Mobile object>

Example

$wirelessEndpoint Protocol.Http.Client.Add

Returns:

<Layer5.Http.Client.Mobile object> 

Definition at line 25734 of file api.tcl.

WirelessEndpoint::Protocol.Http.Client.Get

Returns the list of HTTP clients created on this mobile device.

Returns

List of <Layer5.Http.Client.Mobile object>

Example

$wirelessEndpoint Protocol.HTTP.Client.Get

Returns:

[ <Layer5.Http.Client.Mobile object> ... ] 

Definition at line 25746 of file api.tcl.

WirelessEndpoint::Result.Async.Get

Request the results without waiting for the reply.

Example

$wirelessEndpoint Result.Async.Get

Definition at line 25756 of file api.tcl.

WirelessEndpoint::Result.Clear

Clear the result list.

Example

$wirelessEndpoint Result.Clear

Definition at line 25766 of file api.tcl.

WirelessEndpoint::Result.Get

Request the results.

Requests the result and waits for the reply. If a previous call to Request.Async was made then this call does not trigger a new request and instead waits for the async result.

Example

$wirelessEndpoint Result.Get

Definition at line 25778 of file api.tcl.

WirelessEndpoint::Rx.Latency.Basic.Add

Adding a RxLatency to this mobile device.

Returns

Rx.Latency.Basic.Mobile

Example

$wirelessEndpoint Rx.Latency.Basic.Add

Definition at line 25790 of file api.tcl.

WirelessEndpoint::Rx.Latency.Basic.Get

Returns the list of latency triggers created on this mobile device.

Returns

List of Rx.Latency.Basic.Mobile

Example

$wirelessEndpoint Rx.Latency.Basic.Get

Returns:

[ <Rx.Latency.Basic.Mobile object> ... ] 

Definition at line 25802 of file api.tcl.

WirelessEndpoint::Rx.Latency.Distribution.Add

Creates a latency calculator, which computes latency measurements based on timestamps in received frames (possibly restricted by a filter).

Since

2.12.16

Like all incoming packet processors (or 'Rx' objects), this object listens to incoming traffic matching a configurable BPF filter and performs some action when it arrives.

Typically, the filter should limit the matching traffic to the Tx.Stream.Mobile whose transmitted frames actually contain the required timestamps!

The latency calculator is activated as soon as it is created, so don't forget to reset its counters after setting the filter and initializing your test.

See the class documentation of the returned types for more information. See Frame.Mobile for information on timestamping.

Returns

Created latency calculator object. Its object type is Rx.Latency.Distribution.Mobile

Example

$port Rx.Latency.Distribution.Add

Returns:

<Rx.Latency.Distribution.Mobile object> 

Definition at line 25824 of file api.tcl.

WirelessEndpoint::Rx.Latency.Distribution.Get

Returns the list of latency calculators created on this port.

Since

2.12.16

See Rx.Latency.Distribution.Add for more information.

Returns

List of all latency calculators created on this port. Possibly empty.

Example

$port Rx.Latency.Distribution.Get

Returns:

[ <Rx.Latency.Distribution.Mobile object> ... ] 

Definition at line 25840 of file api.tcl.

WirelessEndpoint::Rx.Trigger.Basic.Add

Adding a RxTrigger to this mobile device.

Returns

Rx.Trigger.Basic.Mobile

Example

$wirelessEndpoint Rx.Trigger.Basic.Add

Definition at line 25852 of file api.tcl.

WirelessEndpoint::Rx.Trigger.Basic.Get

Returns the list of receive triggers created on this mobile device.

Returns

List of Rx.Trigger.Basic.Mobile

Example

$wirelessEndpoint Rx.Trigger.Basic.Get

Returns:

[ <Rx.Trigger.Basic.Mobile object> ... ] 

Definition at line 25864 of file api.tcl.

WirelessEndpoint::Scenario.Heartbeat.Interval.Get

Returns the heartbeat interval while running a scenario.

0 seconds (disabled)

Example

$wirelessEndpoint Scenario.Heartbeat.Interval.Get

Returns:

1000000000 

Definition at line 25888 of file api.tcl.

WirelessEndpoint::Scenario.Heartbeat.Interval.Set

Sets the heartbeat interval used when running a scenario.

The allowed value range is 0 (disabled, default) and maximum 86400000000000 (1 day).

When a value is below the minimum value supported by a specific Endpoint device, the supported value is taken. When a value is above the upper threshold of 1 day, 1 day will be used.

Note

A value of max int64 (9223372036854775807) will disable heartbeating during scenarios. From 2.22.0 on, this value will be a normal valid value.

Example

$wirelessEndpoint Scenario.Heartbeat.Interval.Set 1s

Definition at line 25904 of file api.tcl.

WirelessEndpoint::Start

Start the Scenario on the given Wireless Endpoint.

Example

$wirelessEndpoint Start

Definition at line 25924 of file api.tcl.

WirelessEndpoint::Start.Async

Start without waiting for confirmation.

Example

$wirelessEndpoint Start.Async

Definition at line 25914 of file api.tcl.

WirelessEndpoint::Status.Get

Returns the device status.

Possible states are:

Unavailable

Wireless endpoint not available/registered

Available

Wireless endpoint is registered

Reserved

Wireless endpoint is locked/used by an other user

Starting

Wireless endpoint will start any second now with a test

Running

Wireless endpoint is currently running a test

Example

$wirelessEndpoint State.Get

Definition at line 25936 of file api.tcl.

WirelessEndpoint::Stop

Stop the Scenario on the given Wireless Endpoint.

Example

$wirelessEndpoint Stop

Definition at line 25956 of file api.tcl.

WirelessEndpoint::Stop.Async

Stop without waiting for confirmation.

Example

$wirelessEndpoint Stop.Async

Definition at line 25946 of file api.tcl.

WirelessEndpoint::Tx.Stream.Add

Adding a TxStream to this mobile device.

Returns

Tx.Stream.Mobile

Example

$wirelessEndpoint Tx.Stream.Add

Definition at line 25968 of file api.tcl.

WirelessEndpoint::Tx.Stream.Get

Returns the list of streams created on this mobile device.

Returns

list of Tx.Stream.Mobile

Example

$wirelessEndpoint Tx.Stream.Get

Returns:

[ <Tx.Stream.Mobile object> ... ] 

Definition at line 25980 of file api.tcl.