xbee.zigbee.ZigBee Class Reference

Inheritance diagram for xbee.zigbee.ZigBee:

Public Member Functions
def	__init__ (self, args, kwargs)
Public Member Functions inherited from xbee.base.XBeeBase
def	__getattr__ (self, name)
def	__init__ (self, ser, shorthand=True, callback=None, escaped=False)
def	halt (self)
def	run (self)
def	send (self, cmd, kwargs)
def	wait_read_frame (self)

Static Public Attributes
dictionary	api_commands
dictionary	api_responses

Private Member Functions
def	_parse_samples_header (self, io_bytes)

Additional Inherited Members
Public Attributes inherited from xbee.base.XBeeBase
	serial
	shorthand

Detailed Description

Provides an implementation of the XBee API for XBee ZB (ZigBee) modules
with recent firmware.

Commands may be sent to a device by instantiating this class with
a serial port object (see PySerial) and then calling the send
method with the proper information specified by the API. Data may
be read from a device synchronously by calling wait_read_frame.
For asynchronous reads, see the defintion of XBeeBase.

Definition at line 14 of file zigbee.py.

Constructor & Destructor Documentation

def xbee.zigbee.ZigBee.__init__	(		self,
			args,
			kwargs
	)

Definition at line 159 of file zigbee.py.

Member Function Documentation

def xbee.zigbee.ZigBee._parse_samples_header (   self,   io_bytes  )

private

_parse_samples_header: binary data in XBee ZB IO data format ->
        (int, [int ...], [int ...], int, int)
        
_parse_samples_header will read the first three bytes of the 
binary data given and will return the number of samples which
follow, a list of enabled digital inputs, a list of enabled
analog inputs, the dio_mask, and the size of the header in bytes

_parse_samples_header is overloaded here to support the additional
IO lines offered by the XBee ZB

Definition at line 163 of file zigbee.py.

Member Data Documentation

dictionary xbee.zigbee.ZigBee.api_commands

static

Definition at line 34 of file zigbee.py.

dictionary xbee.zigbee.ZigBee.api_responses

static

Definition at line 89 of file zigbee.py.

---

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

• zigbee.py