Nyx Switch Message

Nyx / INDI Switch Message. More...

Classes
class	nyx.indi.indi_switch.NyxSwitchProp
	INDI / Nyx switch property. More...
class	nyx.indi.indi_switch.NyxSwitchVector
	INDI / Nyx switch vector. More...

Detailed Description

Nyx / INDI Switch Message.

---

Class Documentation

nyx::indi::indi_switch::NyxSwitchProp

class nyx::indi::indi_switch::NyxSwitchProp

INDI / Nyx switch property.

Definition at line 41 of file indi_switch.py.

Inheritance diagram for nyx.indi.indi_switch.NyxSwitchProp:

Collaboration diagram for nyx.indi.indi_switch.NyxSwitchProp:

Public Member Functions
	__init__ (self, str name, str|None label=None, enums.NyxOnOff|int|str|bool value=enums.NyxOnOff.OFF)
	Allocates a new INDI / Nyx switch 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).
	value = property()
	Gets or sets the value property of this object (type: NyxOnOff).

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_switch.NyxSwitchProp.__init__	(		self,
		str	name,
		str | None	label = None,
		enums.NyxOnOff | int | str | bool	value = enums.NyxOnOff.OFF )

Allocates a new INDI / Nyx switch property.

Parameters

name	Property name.
label	Property label.
value	Initial value.

Definition at line 49 of file indi_switch.py.

nyx::indi::indi_switch::NyxSwitchVector

class nyx::indi::indi_switch::NyxSwitchVector

INDI / Nyx switch vector.

Definition at line 114 of file indi_switch.py.

Inheritance diagram for nyx.indi.indi_switch.NyxSwitchVector:

Collaboration diagram for nyx.indi.indi_switch.NyxSwitchVector:

Public Member Functions
	__init__ (self, str device, str name, enums.NyxState|int|str state, enums.NyxPerm|int|str perm, enums.NyxRule|int|str rule, typing.Iterable[NyxSwitchProp] props, **typing.Any opts)
	Allocates a new INDI / Nyx switch vector.
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).
	perm = property()
	Gets or sets the perm property of this object (type: NyxPerm).
	rule = property()
	Gets or sets the rule property of this object (type: NyxRule).

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_switch.NyxSwitchVector.__init__	(		self,
		str	device,
		str	name,
		enums.NyxState | int | str	state,
		enums.NyxPerm | int | str	perm,
		enums.NyxRule | int | str	rule,
		typing.Iterable[NyxSwitchProp]	props,
		**typing.Any	opts )

Allocates a new INDI / Nyx switch vector.

Parameters

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

Definition at line 122 of file indi_switch.py.