Constants

Special bytes

hachi.const.FRAME_DELIMITER = 126

Frame delimiter byte

hachi.const.ESCAPE = 125

Escape byte

hachi.const.XON = 17

XON byte

hachi.const.XOFF = 19

XOFF byte

API IDs

Request API IDs

hachi.const.TX_64_REQUEST = 0

API ID for Tx64Request

hachi.const.TX_16_REQUEST = 1

API ID for Tx16Request

hachi.const.AT_REQUEST = 8

API ID for AtRequest

hachi.const.AT_QUEUE_REQUEST = 9

API ID for AtQueueRequest

hachi.const.ZB_TX_REQUEST = 16

API ID for ZBTxRequest

hachi.const.ZB_EXPLICIT_TX_REQUEST = 17

API ID for ZBExplicitTxRequest

hachi.const.REMOTE_AT_REQUEST = 23

API ID for RemoteAtRequest

Response API IDs

hachi.const.RX_64_RESPONSE = 128

API ID for Rx64Response

hachi.const.RX_16_RESPONSE = 129

API ID for Rx16Response

hachi.const.RX_64_IO_RESPONSE = 130

API ID for Rx64IoSampleResponse

hachi.const.RX_16_IO_RESPONSE = 131

API ID for Rx16IoSampleResponse

hachi.const.AT_RESPONSE = 136

API ID for AtResponse

hachi.const.TX_STATUS_RESPONSE = 137

API ID for TxStatusResponse

hachi.const.MODEM_STATUS_RESPONSE = 138

API ID for ModemStatusResponse

hachi.const.ZB_TX_STATUS_RESPONSE = 139

API ID for ZBTxStatusResponse

hachi.const.ZB_RX_RESPONSE = 144

API ID for ZBRxResponse

hachi.const.ZB_EXPLICIT_RX_RESPONSE = 145

API ID for ZBExplicitRxResponse

hachi.const.ZB_IO_SAMPLE_RESPONSE = 146

API ID for ZBIoSampleResponse

hachi.const.REMOTE_AT_RESPONSE = 151

API ID for RemoteAtResponse

Special frame ids

hachi.const.FRAME_ID_NO_RESPONSE = 0

Frame id that disables status responses

Special addresses

hachi.const.ADDRESS_16_USE_64_BIT_ADDRESSING = 65534

Use 64-bit addressing 16-bit address. Applies to Tx16Request

hachi.const.ADDRESS_16_BROADCAST = 65535

Broadcast 16-bit address

hachi.const.ADDRESS_64_COORDINATOR = 0

Coordinator 64-bit address

hachi.const.ADDRESS_64_BROADCAST = 65535

Broadcast 64-bit address

hachi.const.ADDRESS_64_UNKNOWN = 18446744073709551615L

Unknown 64-bit address

Special broadcast radius

hachi.const.BROADCAST_RADIUS_MAX_HOPS = 0

Maximum hops

Transmit options

hachi.const.TRANSMIT_OPTION_DISABLE_ACKNOWLEDGEMENT = 1

Disable acknowledgement. Applies to Tx64Request and Tx16Request

hachi.const.TRANSMIT_OPTION_BROADCAST_PACKET = 4

Send packet with broadcast pan id. Applies to Tx64Request and Tx16Request

hachi.const.TRANSMIT_OPTION_APPLY_CHANGES = 2

Apply changes. Applies to RemoteAtRequest

hachi.const.TRANSMIT_OPTION_DISABLE_RETRIES_AND_ROUTE_REPAIR = 1

Disable retries and route repair. Applies to ZBTxRequest and ZBExplicitTxRequest

hachi.const.TRANSMIT_OPTION_ENABLE_APS_ENCRYPTION = 32

Enable APS encryption. Applies to ZBTxRequest and ZBExplicitTxRequest

hachi.const.TRANSMIT_OPTION_USE_EXTENDED_TRANSMISSION_TIMEOUT = 64

Use extended transmission timeout. Applies to ZBTxRequest and ZBExplicitTxRequest

Receive options

hachi.const.RECEIVE_OPTION_ADDRESS_BROADCAST = 1

Address broadcast. Applies to Rx64Response and Rx16Response

hachi.const.RECEIVE_OPTION_PAN_BROADCAST = 2

PAN broadcast. Applies to Rx64Response and Rx16Response

hachi.const.RECEIVE_OPTION_PACKET_ACKNOWLEDGED = 1

Packet acknowledged. Applies to ZBRxResponse and ZBExplicitRxResponse

hachi.const.RECEIVE_OPTION_PACKET_BROADCAST = 2

Packet was a broadcast packet. Applies to ZBRxResponse and ZBExplicitRxResponse

hachi.const.RECEIVE_OPTION_PACKET_ENCRYPTED_WITH_APS = 32

Packet encrypted with APS encryption. Applies to ZBRxResponse and ZBExplicitRxResponse

hachi.const.RECEIVE_OPTION_PACKET_FROM_END_DEVICE = 64

Packet was sent from an end device (if known). Applies to ZBRxResponse and ZBExplicitRxResponse

Transmit statuses

hachi.const.STATUS_SUCCESS = 0

Success. Applies to TxStatusResponse and ZBTxStatusResponse

hachi.const.STATUS_MAC_ACK_FAILURE = 1

MAC ACK failure. Applies to TxStatusResponse and ZBTxStatusResponse

hachi.const.STATUS_CCA_FAILURE = 2

CCA failure. Applies to TxStatusResponse and ZBTxStatusResponse

hachi.const.STATUS_PURGED = 3

Purged. Applies to TxStatusResponse

hachi.const.STATUS_INVALID_DESTINATION_ENDPOINT = 21

Invalid destination endpoint. Applies to ZBTxStatusResponse

hachi.const.STATUS_NETWORK_ACK_FAILURE = 33

Network ACK failure. Applies to ZBTxStatusResponse

hachi.const.STATUS_NOT_JOINED_TO_NETWORK = 34

Not joined to network. Applies to ZBTxStatusResponse

hachi.const.STATUS_SELF_ADDRESSED = 35

Self-addressed. Applies to ZBTxStatusResponse

hachi.const.STATUS_ADDRESS_NOT_FOUND = 36

Address not found. Applies to ZBTxStatusResponse

hachi.const.STATUS_ROUTE_NOT_FOUND = 37

Route not found. Applies to ZBTxStatusResponse

hachi.const.STATUS_NEIGHBOR_FAILURE = 38

Broadcast source failed to hear a neighbor relay relay the message. Applies to ZBTxStatusResponse

hachi.const.STATUS_INVALID_BINDING_TABLE_INDEX = 43

Invalid binding table index. Applies to ZBTxStatusResponse

hachi.const.STATUS_RESOURCE_ERROR = 44

Resource error lack of free buffers, timers, etc. Applies to ZBTxStatusResponse

hachi.const.STATUS_ATTEMPTED_BROADCAST_WITH_APS = 45

Attempted broadcast with APS transmission. Applies to ZBTxStatusResponse

hachi.const.STATUS_ATTEMPTED_UNICAST_APS = 46

Attempted unicast with APS transmission but EE=0. Applies to ZBTxStatusResponse

hachi.const.STATUS_RESOURCE_ERROR_2 = 50

Resource error lack of free buffers, timers, etc. Applies to ZBTxStatusResponse

hachi.const.STATUS_DATA_PAYLOAD_TOO_LARGE = 116

Data payload too large. Applies to ZBTxStatusResponse

hachi.const.STATUS_INDIRECT_MESSAGE_UNREQUESTED = 117

Indirect message unrequested. Applies to ZBTxStatusResponse

Discovery statuses

hachi.const.DISCOVERY_STATUS_NO_OVERHEAD = 0

No overhead discovery. Applies to ZBTxStatusResponse

hachi.const.DISCOVERY_STATUS_ADDRESS = 1

Address discovery. Applies to ZBTxStatusResponse

hachi.const.DISCOVERY_STATUS_ROUTE = 2

Route discovery. Applies to ZBTxStatusResponse

hachi.const.DISCOVERY_STATUS_ADDRESS_AND_ROUTE = 3

Address and route discovery. Applies to ZBTxStatusResponse

hachi.const.DISCOVERY_STATUS_EXTENDED_TIMEOUT = 64

Extended timeout discovery. Applies to ZBTxStatusResponse

Command statuses

hachi.const.COMMAND_STATUS_OK = 0

OK. Applies to AtResponse and RemoteAtResponse

hachi.const.COMMAND_STATUS_ERROR = 1

Error. Applies to AtResponse and RemoteAtResponse

hachi.const.COMMAND_STATUS_INVALID_COMMAND = 2

Invalid command. Applies to AtResponse and RemoteAtResponse

hachi.const.COMMAND_STATUS_INVALID_PARAMETER = 3

Invalid parameter. Applies to AtResponse and RemoteAtResponse

hachi.const.COMMAND_STATUS_NO_RESPONSE = 4

No response. Applies to RemoteAtResponse

Modem statuses

hachi.const.MODEM_STATUS_HARDWARE_RESET = 0

Hardware reset

hachi.const.MODEM_STATUS_WATCHDOG_TIMER_RESET = 1

Watchdog timer reset

hachi.const.MODEM_STATUS_ASSOCIATED = 2

Associated

hachi.const.MODEM_STATUS_DISASSOCIATED = 3

Disassociated

hachi.const.MODEM_STATUS_SYNCHRONIZATION_LOST = 4

Synchronization lost

hachi.const.MODEM_STATUS_COORDINATOR_REALIGNMENT = 5

Coordinator realignment

hachi.const.MODEM_STATUS_COORDINATOR_STARTED = 6

Coordinator started

hachi.const.MODEM_STATUS_NETWORK_SECURITY_KEY_UPDATED = 7

Network security key updated

hachi.const.MODEM_STATUS_VOLTAGE_SUPPLY_LIMIT_EXCEEDED = 13

Voltage supply limit exceeded

hachi.const.MODEM_STATUS_MODEM_CONFIGURATION_CHANGED_WHILE_JOINING = 17

Modem configuration changed while join in progress

hachi.const.MODEM_STATUS_STACK_ERROR_MIN = 128

Stack error minimum