stream

List of supported commands:

class nardascripting.base.scpi.stream.ScpiStream(com: nardascripting.base.comm.CommBase)

SignalShark STReam SCPI subsystem class.

add(stype: nardascripting.base.scpi.enums.StrTypes)

Adds a new stream to the active stream task

Parameters

stype (StrTypes) – Stream type e.g. ‘VITA49_IQ’

Returns

Index of the new stream added

Return type

int

connection_close()

Closes connection for selected stream

connection_open()

Opens connection for selected stream

delete(index: int)

Deletes a stream from the active stream task

Parameters

index (int) – Index of the stream to delete

get_connection_address()

Queries the stream IP address

Returns

Stream IP or Multicast Address for the socket connection

Return type

str

get_connection_idn()

Queries the stream identifier of the stream connection

Returns

Id of the stream

Return type

int

get_connection_port()

Queries the connection portnumber for selected stream

Returns

Portnumber for the socket connection

Return type

int

get_connection_state()

Queries connection state for selected stream

Returns

Connection state (OPENED, CLOSED, CONNECTED)

Return type

StrConStates

get_connection_type()

Queries the connection type for selected stream

Returns

Connection type

Return type

StrConTypes

get_list()

Queries a list of streams from the active stream task

Returns

List of all streams (Type, Index)

Return type

list [strm_string, strm_index]

get_select()

Queries the selected stream of the active stream task

Returns

Index of the selected stream

Return type

int

set_connection_address(value: str)

Sets the connection IP or multicast address for selected stream

Parameters

value (str) – Stream IP or Multicast Address for the socket connection

set_connection_idn(cid: int)

Stream identifier for the selected stream connection

Parameters

cid (int) – Id of the stream

set_connection_port(value: int)

Connection portnumber for selected stream

Parameters

value (int) – Portnumber for the socket connection

set_connection_type(value: nardascripting.base.scpi.enums.StrConTypes)

Sets the connection type TCP or UDP for selected stream

Parameters

value (StrConTypes) – Connection type (TCP_SERVER, TCP_CLIENT, UDP_SINGLECAST, UDP_MULTICAST)

set_select(index: int)

Selects a stream of the active stream task for configuration of the connection

Parameters

index (int) – Index of the stream to select