Request

Requests

hachi.request.FRAME_ID_DEFAULT = 1

Frame id used by default. It is non-zero to trigger a status response

hachi.request.TRANSMIT_OPTION_DEFAULT = 0

Transmit option used by default.

class hachi.request.XBeeRequest

Base class for all XBee requests

The XBeeRequest provides helpers to access to the raw API frame. Unless specified, the type of attributes is int.

api_id = None

API ID

Subclasses must implement this and return the corresponding API ID

length

Computed length

id_data

API ID-specific raw data, bytes between the api_id and the checksum

Subclasses must implement this

Type :bytearray
checksum

Computed checksum

frame

Computed frame

class hachi.request.Tx64Request(data, destination_address=0, options=0, frame_id=1)

Tx Request using 64-bit addressing

frame_id = None

Frame id

destination_address = None

64-bit destination address

options = None

Options

data = None

Data

Type :bytearray or bytes
class hachi.request.Tx16Request(data, destination_address, options=0, frame_id=1)

Tx Request using 16-bit addressing

frame_id = None

Frame id

destination_address = None

16-bit destination address

options = None

Options

data = None

Data

Type :bytearray or bytes
class hachi.request.AtRequest(command, parameter=None, frame_id=1)

At Request

frame_id = None

Frame id

command = None

Command

Type :bytes
parameter = None

Parameter value

Set to None to query the register

Type :None or bytearray or bytes
class hachi.request.AtQueueRequest(command, parameter=None, frame_id=1)

At Queue Request

frame_id = None

Frame id

command = None

Command

Type :bytes
parameter = None

Parameter value

Set to None to query the register

Type :None or bytearray or bytes
class hachi.request.ZBTxRequest(data, destination_address_64=0, destination_address_16=65534, broadcast_radius=0, options=0, frame_id=1)

ZB Tx Request

frame_id = None

Frame id

destination_address_64 = None

64-bit destination address

destination_address_16 = None

16-bit destination address

broadcast_radius = None

Broadcast radius

options = None

Options

data = None

Data

Type :bytearray or bytes
class hachi.request.ZBExplicitTxRequest(data, destination_address_64, source_endpoint, destination_endpoint, cluster_id, profile_id, destination_address_16=65534, broadcast_radius=0, options=0, frame_id=1)

ZB Explicit Tx Request

frame_id = None

Frame id

destination_address_64 = None

64-bit destination address

destination_address_16 = None

16-bit destination address

source_endpoint = None

Source endpoint

destination_endpoint = None

Destination endpoint

cluster_id = None

Cluster id

profile_id = None

Profile id

broadcast_radius = None

Broadcast radius

options = None

Options

data = None

Data

Type :bytearray or bytes
class hachi.request.RemoteAtRequest(command, destination_address_64, parameter=None, destination_address_16=65534, options=2, frame_id=1)

Remote At Request

frame_id = None

Frame id

destination_address_64 = None

64-bit destination address

destination_address_16 = None

16-bit destination address

options = None

Options

command = None

Command

Type :bytes
parameter = None

Parameter value

Set to None to query the register

Type :None or bytearray or bytes

Map

hachi.request.REQUEST_MAP

Mapping from Request API IDs to XBeeRequest

Hachi

Hachi is a Python library to interact with XBees.

PyPI downloads

Donate

If you like hachi, please consider making a donation

Table Of Contents

Related Topics

This Page

Fork me on GitHub