Nyx protocol

Collaboration diagram for Nyx protocol:

Topics
	Nyx Number Message
	Nyx Text Message
	Nyx Light Message
	Nyx Switch Message
	Nyx BLOB Message
	Nyx Stream Message
	Other Nyx Messages

Classes
struct	nyx_opts_t
	Struct describing the options for INDI / Nyx vectors. More...

Macros
#define	NYX_INDI_VERSION   "1.7"
	INDI backward compatibility version.

Enumerations
enum	nyx_state_t {   NYX_STATE_IDLE = 400 ,   NYX_STATE_OK = 401 ,   NYX_STATE_BUSY = 402 ,   NYX_STATE_ALERT = 403 }
	Vector state hint. More...
enum	nyx_perm_t {   NYX_PERM_RO = 500 ,   NYX_PERM_WO = 501 ,   NYX_PERM_RW = 502 }
	Vector permission hint. More...
enum	nyx_rule_t {   NYX_RULE_ONE_OF_MANY = 600 ,   NYX_RULE_AT_MOST_ONE = 601 ,   NYX_RULE_ANY_OF_MANY = 602 }
	Switch vector rule hint. More...
enum	nyx_onoff_t {   NYX_ONOFF_ON = 700 ,   NYX_ONOFF_OFF = 701 }
	Switch state. More...

Detailed Description

Nyx protocol.

---

Class Documentation

nyx_opts_t

struct nyx_opts_t

Struct describing the options for INDI / Nyx vectors.

Definition at line 2048 of file nyx_node.h.

Public Attributes
__NYX_NULLABLE__ STR_t	group
	GUI group membership, if NULL, replaced by "Main".
__NYX_NULLABLE__ STR_t	label
	GUI label, if NULL, replaced by the device name.
__NYX_NULLABLE__ STR_t	hints
	GUI Markdown description.
__NYX_NULLABLE__ STR_t	message
	Free comment.
__NYX_ZEROABLE__ double	timeout
	Worst-case time [sec] to apply, 0 by default, N/A for RO.

Enumeration Type Documentation

nyx_state_t

enum nyx_state_t

Vector state hint.

Enumerator
NYX_STATE_IDLE	State is idle.
NYX_STATE_OK	State is ok.
NYX_STATE_BUSY	State is busy.
NYX_STATE_ALERT	State is alert.

Definition at line 1912 of file nyx_node.h.

nyx_perm_t

enum nyx_perm_t

Vector permission hint.

Enumerator
NYX_PERM_RO	Read only.
NYX_PERM_WO	Write only.
NYX_PERM_RW	Read & write.

Definition at line 1947 of file nyx_node.h.

nyx_rule_t

enum nyx_rule_t

Switch vector rule hint.

Enumerator
NYX_RULE_ONE_OF_MANY	Only one switch of many can be ON (e.g., radio buttons).
NYX_RULE_AT_MOST_ONE	At most one switch can be ON, but all switches can be OFF.
NYX_RULE_ANY_OF_MANY	Any number of switches can be ON (e.g., check boxes).

Definition at line 1981 of file nyx_node.h.

nyx_onoff_t

enum nyx_onoff_t

Switch state.

Enumerator
NYX_ONOFF_ON	Switch is ON.
NYX_ONOFF_OFF	Switch is OFF.

Definition at line 2015 of file nyx_node.h.