Nyx Stream Message

Nyx Stream Message. More...

Classes
class	nyx.indi.indi_stream.NyxStreamProp
	Nyx Stream property. More...
class	nyx.indi.indi_stream.NyxStreamVector
	Nyx Stream vector. More...

Detailed Description

Nyx Stream Message.

---

Class Documentation

nyx::indi::indi_stream::NyxStreamProp

class nyx::indi::indi_stream::NyxStreamProp

Nyx Stream property.

Definition at line 34 of file indi_stream.py.

Inheritance diagram for nyx.indi.indi_stream.NyxStreamProp:

Collaboration diagram for nyx.indi.indi_stream.NyxStreamProp:

Public Member Functions
	__init__ (self, str name, str|None label=None)
	Allocates a new Nyx Stream property.
Public Member Functions inherited from nyx.json.json_dict.NyxDict
	__init__ (self, int|None ptr=None)
	Allocates a new JSON dict object or wraps one.
None	clear (self)
	Clears the content of this JSON dict object.
None	__delitem__ (self, str key)
	Deletes the entry of the provided key.
obj.NyxObject	__getitem__ (self, str key)
	Gets the JSON object of the provided key.
bool	__setitem__ (self, str key, obj.NyxObject value)
	Sets a JSON object in this JSON dict object.
int	__len__ (self)
	Gets the number of items in this JSON dict object.
typing.Iterator[str]	keys (self)
	Iterates over the keys of this JSON dict object.
typing.Iterator[obj.NyxObject]	values (self)
	Iterates over the values of this JSON dict object.
typing.Iterator[typing.Tuple[str, obj.NyxObject]]	items (self)
	Iterates over the key/value pairs of this JSON dict object.
Public Member Functions inherited from nyx.obj.NyxObject
	__init__ (self, int ptr)
	Wraps a C JSON object pointer.
typing.Callable	on (self, typing.Callable callback)
	Registers a callback triggered when clients modify this object.
bool	notify (self)
	Notifies this Nyx / INDI object to the clients.
str	to_string (self, bool json_string=True)
	Returns a string representing this JSON object.
NyxXMLDoc	to_xmldoc (self)
	Converts this JSON Nyx / INDI command to the XML one.
Public Attributes
	name = property()
	Gets or sets the name property of this object (type: str).
	label = property()
	Gets or sets the label property of this object (type: str).

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_stream.NyxStreamProp.__init__	(		self,
		str	name,
		str | None	label = None )

Allocates a new Nyx Stream property.

Parameters

name	Property name.
label	Property label.

Note

If the property name ends with .b, the payload is automatically Base64-encoded.

If the property name ends with .z, the payload is automatically ZLib-compressed.

Definition at line 42 of file indi_stream.py.

nyx::indi::indi_stream::NyxStreamVector

class nyx::indi::indi_stream::NyxStreamVector

Nyx Stream vector.

Definition at line 81 of file indi_stream.py.

Inheritance diagram for nyx.indi.indi_stream.NyxStreamVector:

Collaboration diagram for nyx.indi.indi_stream.NyxStreamVector:

Public Member Functions
	__init__ (self, str device, str name, enums.NyxState|int|str state, typing.Iterable[NyxStreamProp] props, **typing.Any opts)
	Allocates a new Nyx Stream vector.
bool	stream_pub (self, typing.Sequence[bytes] field_values)
	If Nyx Stream is enabled, publishes an entry to a stream.
Public Member Functions inherited from nyx.json.json_dict.NyxDict
	__init__ (self, int|None ptr=None)
	Allocates a new JSON dict object or wraps one.
None	clear (self)
	Clears the content of this JSON dict object.
None	__delitem__ (self, str key)
	Deletes the entry of the provided key.
obj.NyxObject	__getitem__ (self, str key)
	Gets the JSON object of the provided key.
bool	__setitem__ (self, str key, obj.NyxObject value)
	Sets a JSON object in this JSON dict object.
int	__len__ (self)
	Gets the number of items in this JSON dict object.
typing.Iterator[str]	keys (self)
	Iterates over the keys of this JSON dict object.
typing.Iterator[obj.NyxObject]	values (self)
	Iterates over the values of this JSON dict object.
typing.Iterator[typing.Tuple[str, obj.NyxObject]]	items (self)
	Iterates over the key/value pairs of this JSON dict object.
Public Member Functions inherited from nyx.obj.NyxObject
	__init__ (self, int ptr)
	Wraps a C JSON object pointer.
typing.Callable	on (self, typing.Callable callback)
	Registers a callback triggered when clients modify this object.
bool	notify (self)
	Notifies this Nyx / INDI object to the clients.
str	to_string (self, bool json_string=True)
	Returns a string representing this JSON object.
NyxXMLDoc	to_xmldoc (self)
	Converts this JSON Nyx / INDI command to the XML one.
Public Attributes
	device = property()
	Gets or sets the device property of this object (type: str).
	name = property()
	Gets or sets the name property of this object (type: str).
	state = property()
	Gets or sets the state property of this object (type: NyxState).

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_stream.NyxStreamVector.__init__	(		self,
		str	device,
		str	name,
		enums.NyxState | int | str	state,
		typing.Iterable[NyxStreamProp]	props,
		**typing.Any	opts )

Allocates a new Nyx Stream vector.

Parameters

device	Device name.
name	Vector name.
state	Vector state.
props	Properties.
opts	Options (group, label, hints, timeout, message).

Definition at line 89 of file indi_stream.py.

Member Function Documentation

stream_pub()

bool nyx.indi.indi_stream.NyxStreamVector.stream_pub	(		self,
		typing.Sequence[bytes]	field_values )

If Nyx Stream is enabled, publishes an entry to a stream.

Parameters

field_values

Field payloads, one per field.

Returns

True if the provided fields match the vector content, False otherwise.

Note

Field payloads may contain arbitrary binary data.

Definition at line 134 of file indi_stream.py.