indiclient.indiclient Class Reference

Inheritance diagram for indiclient.indiclient:

Collaboration diagram for indiclient.indiclient:

Public Member Functions
def	__init__ (self, host, port)
def	set_and_send_text (self, devicename, vectorname, elementname, text)
def	set_and_send_bool (self, devicename, vectorname, elementname, state)
def	set_and_send_float (self, devicename, vectorname, elementname, number)
def	set_and_send_switchvector_by_elementlabel (self, devicename, vectorname, elementlabel)
def	get_float (self, devicename, vectorname, elementname)
def	get_text (self, devicename, vectorname, elementname)
def	get_bool (self, devicename, vectorname, elementname)
Public Member Functions inherited from indiclient.bigindiclient
def	__init__ (self, host, port)
def	reset_connection (self)
def	quit (self)
def	tell (self)
def	send_vector (self, vector)
def	wait_until_vector_available (self, devicename, vectorname)
def	process_receive_vector_queue (self)
def	get_vector (self, devicename, vectorname)
def	get_element (self, devicename, vectorname, elementname)
def	add_mini_element_handler (self, devicename, vectorname, elementname, handlermethod)
def	add_custom_element_handler (self, handler)
def	add_custom_vector_handler (self, handler)
def	set_timeout_handler (self, handler)
def	set_def_handlers (self, blob_def_handler, number_def_handler, switch_def_handler, text_def_handler, light_def_handler)
def	set_message_handler (self, handler)
def	process_events (self)
def	enable_blob (self)

Additional Inherited Members
Public Attributes inherited from indiclient.bigindiclient
	indivectors
	custom_element_handler_list
	custom_vector_handler_list
	defvectorlist
	currentVector
	currentElement
	currentMessage
	currentData
	verbose
	expat
	socket
	host
	port
	receive_event_queue
	running_queue
	receive_vector_queue
	timeout
	blob_def_handler
	number_def_handler
	switch_def_handler
	text_def_handler
	light_def_handler
	message_handler
	timeout_handler
	receivetimer
	first
	running
	output_block
	data

Detailed Description

providing a simplified interface to L{bigindiclient}

Constructor & Destructor Documentation

__init__()

def indiclient.indiclient.__init__	(		self,
			host,
			port
	)

Member Function Documentation

get_bool()

def indiclient.indiclient.get_bool	(		self,
			devicename,
			vectorname,
			elementname
	)

Returns Boolean representing the value of the element requested.
The element must be an L{indiswitch}
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementname:  The name of the element
@type elementname: StringType
@return: the value of the element
@rtype: BooleanType

get_float()

def indiclient.indiclient.get_float	(		self,
			devicename,
			vectorname,
			elementname
	)

Returns a floating point number representing the value of the element requested.
The element must be an L{indinumber}.
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementname:  The name of the element
@type elementname: StringType
@return: the value of the element
@rtype: FloatType

get_text()

def indiclient.indiclient.get_text	(		self,
			devicename,
			vectorname,
			elementname
	)

Returns a text representing the value of the element requested.
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementname:  The name of the element
@type elementname: StringType
@return: the value of the element
@rtype: StringType

set_and_send_bool()

def indiclient.indiclient.set_and_send_bool	(		self,
			devicename,
			vectorname,
			elementname,
			state
	)

Sets the value of of an indi element by a boolean, and sends it to the server
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementname:  The name of the element
@type elementname: StringType
@param state:  The state to be set.
@type state: BooleanType
@return: The vector containing the element that was just sent.
@rtype: L{indivector}

set_and_send_float()

def indiclient.indiclient.set_and_send_float	(		self,
			devicename,
			vectorname,
			elementname,
			number
	)

Sets the value of an indi element by a floating point number, and sends it to the server
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementname:  The name of the element
@type elementname: StringType
@param number: The number to be set.
@type number: FloatType
@return: The vector containing the element that was just sent.
@rtype: L{indivector}

set_and_send_switchvector_by_elementlabel()

def indiclient.indiclient.set_and_send_switchvector_by_elementlabel	(		self,
			devicename,
			vectorname,
			elementlabel
	)

Sets all L{indiswitch} elements in this vector to C{Off}. And sets the one matching the given L{elementlabel}
to C{On}  
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementlabel: The INDI Label of the Switch to be set to C{On}
@type elementlabel: StringType
@return: The vector that that was just sent.
@rtype: L{indivector}

set_and_send_text()

def indiclient.indiclient.set_and_send_text	(		self,
			devicename,
			vectorname,
			elementname,
			text
	)

Sets the value of an element by a text, and sends it to the server
@param devicename:  The name of the device
@type devicename: StringType
@param vectorname:  The name of the vector
@type vectorname: StringType
@param elementname:  The name of the element
@type elementname: StringType
@param text:  The value to be set.
@type text: StringType
@return: The vector containing the element that was just sent.
@rtype: L{indivector}       

---

The documentation for this class was generated from the following file:

• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/indi-duino/add-on/meteostationWEB/indiclient.py