Code Documentation

class stdcom.Subscription

Class Passed Around by data coming from Multiverse, Note most of the time will be in its own thread, so copy the data before use

Data()

Returns a list of the data Return self._data

Name()

returns the name of the subscription

SetData(name, data)

Sets the class full of information

name

the name of the subscription

data

a list of the data

class stdcom.stdcom(ipaddress, port, connectedFunction=None, Callback=None, NCallback=None, ECallback=None)

Threaded communication class to Multiverse, Standard Communication Class. This is a stand alone class that does not retuire PyQt5

Host

Name, or IP address where the Nextstep plugin is running

Port

ServicePort where the NextStep plugin is listening

Connected

Callback arg(Bool)

Data

Callback, where all the subscription comes in where it changes Callback(Subscription)

Names

Call Back, where all possible names come in Callabck(str)

Error

Callback Callback()

AddSubscriptions(subs)

Adds a list of subscriptions

subs

A list of str of subscriber names desired subs : list[str]

GetAcks()

Gets the number of Acks, used to see if the system is alive based on Pings or other actions, resets after it has been called

Returns

Number of Acks to messages, including pings, since the last time read.

GetErrors()

Returns the status of the socket

return

False is connection is ok

GetNames()

Gets the names all possible names possible to subscribe to

returns

List of possible names that are available at this time to subscribe to.

GetNotifications()

If callback are not used, user can call this and it returns changed subsriptions, Use callbacks it makes more sense

return

list of subs that should be read if call backs are not used

NamesOn()

Turns the names on in the Multiverse Plugin, allowing all possible names to come from Multiverse platform

Ping()

Pings the host, will except if socket in error or not open

ReadData(who)

Reads data of a subscription directly from Multiverse

who

The name of the subscription

ReadValues(name)

Reads data for a given name, returns a list of data, the data that is cached from normal running operation to subscription changes.

name

The subscriber name

return

RemoveSub(who: str)

Remove a Subscription previously made

who

the name of the subscrition

SetCallbacks(callback=None, namecallback=None)

SetCallbacks sets the Data and

callback

Data Callback( Subscription)

namecallback

Name Callback(str)

Start()

Start used interally when constructed starts the thread

UpDateMap(name, data)

Internal Use for stuffing data

name

Subscription name

data

Date coming from Multiverse

UpdateAsBool(who, what, index)

Updates Data as Bool, to Multiverse no need for caller to recast to Bool.. ~/name will assume internal subscription does not participate with Multiverse

who

Name of the subscription

what

list[Bool]

where

to begin to change into the array,

UpdateAsFloat(who, what, index)

Updates Data as Float, to Multiverse no need for caller to recast to Float.. ~/name will assume internal subscription does not participate with Multiverse

who

Name of the subscription

what

list[Float]

where

to begin to change into the array,

UpdateAsInt(who, what, index=0)

Updates Data as int, to Multiverse no need for caller to recast to int.. ~/name will assume internal subscription does not participate with Multiverse

who

Name of the subscription

what

list[int]

where

to begin to change into the array,

UpdateRaw(who, what, index)

Updates Data as when is passed, to Multiverse user should recast to desired type() ~/name will assume internal subscription does not participate with Multiverse

who

Name of the subscription

what

list[type()]

where

to begin to change into the array,

isConnected()

Returns the status of the socket, same as getErrors()

return

False is connection is ok

run()

Internal use, thread running

terminate()

Stops the thread,

class stdcomqt5.multiverse(uiparent: Optional[PyQt5.QtCore.QObject] = None)

The multiverse class is a PyQt5 version that sits on top of stdcom, can has signals, slots, and auto restart capabilities build into it.

uiparent

QObject = None default, or the parent QObject

AddNames(values)

Internal use tell when a new name is found, with emit

: sigNames.emit: list[str] of new names entering the picture that can be subscribed to

AddValues(sub)

Internal use, updates makes and notfies by signal data has changed for a subcription

sigNewData.emit

Name, Data

ConnectSocket(v)

Socket connection call back, for internal use

sigConnect.emit

emits the signal if connection happens

ConnectionError()

Socket error connection call back, for internal use

sigNoConnect.emit

emits the signal if connection error or close happens

LoadcBridge()

User calls this to start the ball rolling to the connection to multiverse providing the destination and port are set correctly.

getPossibleSubscribesr()

All the possible subscription names possible

return

list of names of all possible subscritions

getSubscribers()

All the stuff subscribed to

return

A list of all the subscription names we have subscribed to

readValues(Name: str)

Reads values cached for a single subscription name that is given and has been subscribed to.

Name

Name of the subscription

return

list of data for a given subscrition, or None if not available

setDestination(dest, port)

Sets a new Destination and port, the user must terminate amd loadbridge again after changing is connected.

setWatchDogIntervalSec(seconds: int = 5)

Sets the watchdog timer in seconds. This can be adjusted if the Multiverse in on the internet and thousands of miles away.

seconds

Default is 5 seconds, make this longer if huge internet delay

subscribe(Name: str)

Subscribe to a give Name

Name

The subscription name

terminate()

Cridical the user called this function when leaving .. I closes down the thread connected to multiverse

unsubscribe(Name)

UnSubscribe to something previously subscribed to.

Name

The name of the Subscription to delete

writeValues(Name: str, Data: list)

WritesValues to multiverse if subcription is made, or local data is ~/ is the prefix

Name

The name of the subscription, if ~/ is the prefix, then data is local.

Data

Is a list[] of data