indiclient.indilight

Module indiclient :: Class indilight

[show private | hide private]

Class indilight

 indiobject --+        
              |        
indinamedobject --+    
                  |    
        indielement --+
                      |
                     indilight

a status light

Method Summary
	`__init__(self, attrs, tag)`
BooleanType	`is_alert(self)` Return `True` if the light indicates the `Alert`state (device is responding, but at least one function does not work at the moment) `False` otherwise
BooleanType	`is_busy(self)` Return `True` if the light indicates the `Busy` state (device is currently busy doing something, and not ready to do anything else) , `False` otherwise
BooleanType	`is_idle(self)` Return `True` if the light indicates the `Idle` state (device is currently not connected or unreachable) , `False` otherwise
BooleanType	`is_ok(self)` Return `True` if the light indicates the `Ok` state (device is ready to do something), `False` otherwise
NoneType	`set_text(self, text)` Return None
NoneType	`update(self, attrs, tag)` Update this element with data received form the XML Parser.
Inherited from indielement
StringType	`get_text(self)` Return a string representation of it value
StringType	`get_xml(self, transfertype)` Returns an XML representation of the object
NoneType	`set_float(self, num)` Return None
NoneType	`tell(self)` Prints all parameters of the object
Inherited from indiobject
BooleanType	`is_valid(self)` Checks whether the object is valid.

Instance Variable Summary
Inherited from indinamedobject
StringType	`label`: label of the INDI object as given in the "label" XML attribute
StringType	`name`: name of the INDI object as given in the "name" XML attribute
Inherited from indiobject
`indixmltag`	`tag`: The XML tag of the INDI object (see `indixmltag`).

Method Details

init(self, attrs, tag)
(Constructor)

Parameters:: attrs - The attributes of the XML version of the INDI object.
(type=DictType); tag - The XML tag of the object (see indixmltag).
(type=indixmltag)

Overrides:: indiclient.indielement.__init__ (inherited documentation)

is_alert(self)

Returns:: True if the light indicates the Alertstate (device is responding, but at least one function does not work at the moment) False otherwise
(type=BooleanType)

is_busy(self)

Returns:: True if the light indicates the Busy state (device is currently busy doing something, and not ready to do anything else) , False otherwise
(type=BooleanType)

is_idle(self)

Returns:: True if the light indicates the Idle state (device is currently not connected or unreachable) , False otherwise
(type=BooleanType)

is_ok(self)

Returns:: True if the light indicates the Ok state (device is ready to do something), False otherwise
(type=BooleanType)

set_text(self, text)

Parameters:: text - A string representation of the data to be written into the object.
(type=StringType)

Returns:: None
(type=NoneType)

Overrides:: indiclient.indielement.set_text (inherited documentation)

update(self, attrs, tag)

Update this element with data received form the XML Parser.

Parameters:: attrs - The attributes of the XML version of the INDI object.
(type=DictType); tag - The XML tag of the object (see indixmltag).
(type=indixmltag)

Returns:: None
(type=NoneType)

Overrides:: indiclient.indiobject.update (inherited documentation)

Generated by Epydoc 2.1 on Sat Sep 10 10:26:05 2005

http://epydoc.sf.net

Class indilight

__init__(self, attrs, tag) (Constructor)

is_alert(self)

is_busy(self)

is_idle(self)

is_ok(self)

set_text(self, text)

update(self, attrs, tag)

init(self, attrs, tag)
(Constructor)