Skip to content

Fix Issue #45 DigiMesh Python 3 Support #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattdodge merged 1 commit into from
Apr 25, 2017
Merged

Fix Issue #45 DigiMesh Python 3 Support #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
226 changes: 122 additions & 104 deletions xbee/digimesh.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,124 +14,142 @@

class DigiMesh(XBeeBase):
"""
Provides an implementation of the XBee API for Digimesh modules
Provides an implementation of the XBee API for DigiMesh modules
with recent firmware.

Commands may be sent to a device by instansiating this class with
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 syncronously by calling wait_read_frame. For
be read from a device synchronously by calling wait_read_frame. For
asynchronous reads, see the definition of XBeeBase.
"""
# Packets which can be sent to an XBee

# Format:
# {name of command:
# [{name:field name, len:field length, default: default value sent}
# ...
# ]
# ...
# }
api_commands = {"at":
[{'name':'id', 'len':1, 'default':'\x08'},
{'name':'frame_id', 'len':1, 'default':'\x00'},
{'name':'command', 'len':2, 'default':None},
{'name':'parameter', 'len':None, 'default':None}],
"queued_at":
[{'name':'id', 'len':1, 'default':'\x09'},
{'name':'frame_id', 'len':1, 'default':'\x00'},
{'name':'command', 'len':2, 'default':None},
{'name':'parameter', 'len':None, 'default':None}],
# todo: Explicit Adrresing Command Frame
"remote_at":
[{'name':'id', 'len':1, 'default':'\x17'},
{'name':'frame_id', 'len':1, 'default':'\x00'},
{'name':'dest_addr_long', 'len':8, 'default':None},
{'name':'reserved', 'len':2, 'default':'\xFF\xFE'},
{'name':'options', 'len':1, 'default':'\x02'},
{'name':'command', 'len':2, 'default':None},
{'name':'parameter', 'len':None, 'default':None}],
"tx":
[{'name':'id', 'len':1, 'default':'\x10'},
{'name':'frame_id', 'len':1, 'default':'\x00'},
{'name':'dest_addr', 'len':8, 'default':None},
{'name':'reserved', 'len':2, 'default':'\xFF\xFE'},
{'name':'broadcast_radius', 'len':1, 'default':'\x00'},
{'name':'options', 'len':1, 'default':'\x00'},
{'name':'data', 'len':None, 'default':None}],

}
# {
# name of command: [
# {name: field name, len: field length, default: default value sent}
# ...
# ]
# ...
# }
api_commands = {
"at": [
{'name': 'id', 'len': 1, 'default': b'\x08'},
{'name': 'frame_id', 'len': 1, 'default': b'\x00'},
{'name': 'command', 'len': 2, 'default': None},
{'name': 'parameter', 'len': None, 'default': None}
],
"queued_at": [
{'name': 'id', 'len': 1, 'default': b'\x09'},
{'name': 'frame_id', 'len': 1, 'default': b'\x00'},
{'name': 'command', 'len': 2, 'default': None},
{'name': 'parameter', 'len': None, 'default': None}
],
# todo: Explicit Adrresing Command Frame
"remote_at": [
{'name': 'id', 'len': 1, 'default': b'\x17'},
{'name': 'frame_id', 'len': 1, 'default': b'\x00'},
{'name': 'dest_addr_long', 'len': 8, 'default': None},
{'name': 'reserved', 'len': 2, 'default': b'\xFF\xFE'},
{'name': 'options', 'len': 1, 'default': b'\x02'},
{'name': 'command', 'len': 2, 'default': None},
{'name': 'parameter', 'len': None, 'default': None}
],
"tx": [
{'name': 'id', 'len': 1, 'default': b'\x10'},
{'name': 'frame_id', 'len': 1, 'default': b'\x00'},
{'name': 'dest_addr' , 'len': 8, 'default': None},
{'name': 'reserved', 'len': 2, 'default': b'\xFF\xFE'},
{'name': 'broadcast_radius', 'len': 1, 'default': b'\x00'},
{'name': 'options', 'len': 1, 'default': b'\x00'},
{'name': 'data', 'len': None, 'default': None}
]
}

# Packets which can be received from an XBee

# Format:
# {id byte received from XBee:
# {name: name of response
# structure:
# [ {'name': name of field, 'len':length of field}
# ...
# ]
# parse_as_io_samples:name of field to parse as io
# }
# ...
# }
#
api_responses = {b"\x88":
{'name':'at_response',
'structure':
[{'name':'frame_id', 'len':1},
{'name':'command', 'len':2},
{'name':'status', 'len':1},
{'name':'parameter', 'len':None}]},
b"\x8a":
{'name':'status',
'structure':
[{'name':'status', 'len':1}]},
b"\x8b":
{'name':'tx_status',
'structure':
[{'name':'frame_id', 'len':1},
{'name':'reserved', 'len':2, 'default':'\xFF\xFE'},
{'name':'retries', 'len':1},
{'name':'deliver_status', 'len':1},
{'name':'discover_status', 'len':1}]},
b"\x90":
{'name':'rx',
'structure':
[{'name':'source_addr', 'len':8},
{'name':'reserved', 'len':2},
{'name':'options', 'len':1},
{'name':'data', 'len':None}]},
# todo: Explicit RX Indicator
# b"\x91":
# {'name':'explicit_rx_indicator',
# 'structure':
# [{'name':'source_addr', 'len':2},
# {'name':'rssi', 'len':1},
# {'name':'options', 'len':1},
# {'name':'rf_data', 'len':None}]},
b"\x95":
{'name':'node_id',
'structure':
[{'name':'source_addr_long', 'len':8},
{'name':'network_addr', 'len':2},
{'name':'options', 'len':1},
{'name':'source_addr', 'len':2},
{'name':'network_addr_long', 'len':8},
{'name':'node_id', 'len':'null_terminated'},
{'name':'parent', 'len':2},
{'name':'unknown', 'len':None}]},
# {
# id byte received from XBee: {
# name: name of response
# structure: [
# {'name': name of field, 'len': length of field}
# ...
# ]
# parse_as_io_samples: name of field to parse as io
# }
# ...
# }
api_responses = {
b'\x88': {
'name': 'at_response',
'structure': [
{'name': 'frame_id', 'len': 1},
{'name': 'command', 'len': 2},
{'name': 'status', 'len': 1},
{'name': 'parameter', 'len': None}
]
},
b'\x8a': {
'name': 'status',
'structure': [
{'name': 'status', 'len': 1}
]
},
b'\x8b': {
'name': 'tx_status',
'structure': [
{'name': 'frame_id', 'len': 1},
{'name': 'reserved', 'len': 2, 'default': b'\xFF\xFE'},
{'name': 'retries', 'len': 1},
{'name': 'deliver_status', 'len': 1},
{'name': 'discover_status', 'len': 1}
]
},
b'\x90': {
'name': 'rx',
'structure': [
{'name': 'source_addr', 'len': 8},
{'name': 'reserved', 'len': 2},
{'name': 'options', 'len': 1},
{'name': 'data', 'len': None}
]
},
# todo: Explicit RX Indicator
# b'\x91': {
# 'name': 'explicit_rx_indicator',
# 'structure': [
# {'name': 'source_addr', 'len': 2},
# {'name': 'rssi', 'len': 1},
# {'name': 'options', 'len': 1},
# {'name': 'rf_data', 'len': None}
# ]
# },
b'\x95': {
'name':'node_id',
'structure': [
{'name': 'source_addr_long', 'len': 8},
{'name': 'network_addr', 'len': 2},
{'name': 'options', 'len': 1},
{'name': 'source_addr', 'len': 2},
{'name': 'network_addr_long', 'len': 8},
{'name': 'node_id', 'len': 'null_terminated'},
{'name': 'parent', 'len': 2},
{'name': 'unknown', 'len': None}]},

b"\x97":
{'name':'remote_at_response',
'structure':
[{'name':'frame_id', 'len':1},
{'name':'source_addr', 'len':8},
{'name':'reserved', 'len':2},
{'name':'command', 'len':2},
{'name':'status', 'len':1},
{'name':'parameter', 'len':None}]}
}
b'\x97': {
'name':'remote_at_response',
'structure': [
{'name': 'frame_id', 'len': 1},
{'name': 'source_addr', 'len': 8},
{'name': 'reserved', 'len': 2},
{'name': 'command', 'len': 2},
{'name': 'status', 'len': 1},
{'name': 'parameter', 'len': None}
]
}
}

def __init__(self, *args, **kwargs):
# Call the super class constructor to save the serial port
Expand Down