def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.TXStatusPacket`.
Raises:
InvalidPacketException: if the bytearray length is less than 7. (start delim. + length (2 bytes) + frame
type + frame id + transmit status + checksum = 7 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if the frame type is different than :attr:`.ApiFrameType.TX_16`.
InvalidOperatingModeException: if ``operating_mode`` is not supported.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name +
" is not supported.")
raw = XBeeAPIPacket._unescape_data(
raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(
raw, min_length=TXStatusPacket.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.TX_STATUS.code:
raise InvalidPacketException(
"This packet is not a TX status packet.")
return TXStatusPacket(raw[4], TransmitStatus.get(raw[5]))
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.RX16Packet`.
Raises:
InvalidPacketException: if the bytearray length is less than 9. (start delim. + length (2 bytes) + frame
type + 16bit addr. + rssi + receive options + checksum = 9 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if the frame type is different than :attr:`.ApiFrameType.RX_16`.
InvalidOperatingModeException: if ``operating_mode`` is not supported.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name +
" is not supported.")
raw = XBeeAPIPacket._unescape_data(
raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(
raw, min_length=RX16Packet.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.RX_16.code:
raise InvalidPacketException("This packet is not an RX 16 Packet")
return RX16Packet(XBee16BitAddress(raw[4:6]), raw[6], raw[7],
raw[8:-1])
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.IODataSampleRxIndicatorWifiPacket`.
Raises:
InvalidPacketException: if the bytearray length is less than 16. (start delim. + length (2 bytes) + frame
type + source addr. (4 bytes) + rssi + receive options + rf data (5 bytes) + checksum = 16 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if operating_mode mode is not supported.
InvalidPacketException: if the frame type is not :attr:`.ApiFrameType.IO_DATA_SAMPLE_RX_INDICATOR_WIFI`.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name + " is not supported.")
raw = XBeeAPIPacket._unescape_data(raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(raw, min_length=IODataSampleRxIndicatorWifiPacket.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.IO_DATA_SAMPLE_RX_INDICATOR_WIFI.code:
raise InvalidPacketException("This packet is not an IO data sample RX indicator Wi-Fi packet.")
return IODataSampleRxIndicatorWifiPacket(IPv4Address(bytes(raw[4:8])), raw[7], raw[8], raw[9:-1])
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
RXIPv4Packet.
Raises:
InvalidPacketException: if the bytearray length is less than 15. (start delim + length (2 bytes) + frame
type + source address (4 bytes) + dest port (2 bytes) + source port (2 bytes) + network protocol +
status + checksum = 15 bytes)
InvalidPacketException: if the length field of ``raw`` is different than its real length. (length field:
bytes 2 and 3)
InvalidPacketException: if the first byte of ``raw`` is not the header byte. See :class:`.SPECIAL_BYTE`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if the frame type is not :attr:`ApiFrameType.RX_IPV4`.
InvalidOperatingModeException: if ``operating_mode`` is not supported.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name + " is not supported.")
_raw = XBeeAPIPacket._unescape_data(raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(_raw, min_length=RXIPv4Packet.__MIN_PACKET_LENGTH)
if _raw[3] != ApiFrameType.RX_IPV4.code:
raise InvalidPacketException("This packet is not an RXIPv4Packet.")
return RXIPv4Packet(IPv4Address(bytes(_raw[4:8])), utils.bytes_to_int(_raw[8:10]),
utils.bytes_to_int(_raw[10:12]), IPProtocol.get(_raw[12]),
_raw[14:-1])
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.RXSMSPacket`
Raises:
InvalidPacketException: if the bytearray length is less than 25. (start delim + length (2 bytes) +
frame type + phone number (20 bytes) + checksum = 25 bytes)
InvalidPacketException: if the length field of ``raw`` is different than its real length. (length field:
bytes 2 and 3)
InvalidPacketException: if the first byte of ``raw`` is not the header byte. See :class:`.SPECIAL_BYTE`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if the frame type is different than :py:attr:`.ApiFrameType.RX_SMS`.
InvalidOperatingModeException: if ``operating_mode`` is not supported.
.. seealso::
| :meth:`.XBeePacket.create_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name +
" is not supported.")
_raw = XBeeAPIPacket._unescape_data(
raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(
_raw, min_length=RXSMSPacket.__MIN_PACKET_LENGTH)
if _raw[3] != ApiFrameType.RX_SMS.code:
raise InvalidPacketException("This packet is not an RXSMSPacket")
return RXSMSPacket(_raw[4:23].decode("utf8").replace("\0", ""),
_raw[24:-1].decode("utf8"))
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.DeviceResponsePacket`
Raises:
InvalidPacketException: if the bytearray length is less than 8. (start delim. + length (2 bytes) + frame
type + frame id + request id + reserved + checksum = 8 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if the frame type is different than :attr:`.ApiFrameType.DEVICE_RESPONSE`.
InvalidOperatingModeException: if ``operating_mode`` is not supported.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name +
" is not supported.")
raw = XBeeAPIPacket._unescape_data(
raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(
raw, min_length=DeviceResponsePacket.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.DEVICE_RESPONSE.code:
raise InvalidPacketException(
"This packet is not a device response packet.")
return DeviceResponsePacket(raw[4], raw[5], raw[7:-1])
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.FrameErrorPacket`
Raises:
InvalidPacketException: if the bytearray length is less than 6. (start delim. + length (2 bytes) + frame
type + frame error + checksum = 6 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if operating_mode mode is not supported.
InvalidPacketException: if the frame type is different than :attr:`.ApiFrameType.FRAME_ERROR`
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name + " is not supported.")
raw = XBeeAPIPacket._unescape_data(raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(raw, min_length=FrameErrorPacket.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.FRAME_ERROR.code:
raise InvalidPacketException("This packet is not a frame error packet.")
return FrameErrorPacket(FrameError.get(raw[4]))
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.SendDataRequestPacket`
Raises:
InvalidPacketException: if the bytearray length is less than 10. (start delim. + length (2 bytes) + frame
type + frame id + path length + content type length + transport + options + checksum = 10 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if the frame type is different than :attr:`.ApiFrameType.SEND_DATA_REQUEST`.
InvalidOperatingModeException: if ``operating_mode`` is not supported.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name +
" is not supported.")
raw = XBeeAPIPacket._unescape_data(
raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(
raw, min_length=SendDataRequestPacket.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.SEND_DATA_REQUEST.code:
raise InvalidPacketException(
"This packet is not a send data request packet.")
path_length = raw[5]
content_type_length = raw[6 + path_length]
return SendDataRequestPacket(
raw[4], str(raw[6:6 + path_length]),
str(raw[6 + path_length + 1:6 + path_length + 1 +
content_type_length]),
SendDataRequestOptions.get(raw[6 + path_length + 2 +
content_type_length]),
raw[6 + path_length + 3 + content_type_length:-1])
def create_packet(raw, operating_mode):
"""
Override method.
Returns:
:class:`.RemoteATCommandWifiPacket`
Raises:
InvalidPacketException: if the Bytearray length is less than 17. (start delim. + length (2 bytes) + frame
type + frame id + dest. addr. (8 bytes) + transmit options + command (2 bytes) + checksum = 17 bytes).
InvalidPacketException: if the length field of 'raw' is different than its real length. (length field: bytes
2 and 3)
InvalidPacketException: if the first byte of 'raw' is not the header byte. See :class:`.SpecialByte`.
InvalidPacketException: if the calculated checksum is different than the checksum field value (last byte).
InvalidPacketException: if operating_mode mode is not supported.
InvalidPacketException: if the frame type is not :attr:`.ApiFrameType.REMOTE_AT_COMMAND_REQUEST_WIFI`.
.. seealso::
| :meth:`.XBeePacket.create_packet`
| :meth:`.XBeeAPIPacket._check_api_packet`
"""
if operating_mode != OperatingMode.ESCAPED_API_MODE and operating_mode != OperatingMode.API_MODE:
raise InvalidOperatingModeException(operating_mode.name + " is not supported.")
raw = XBeeAPIPacket._unescape_data(raw) if operating_mode == OperatingMode.ESCAPED_API_MODE else raw
XBeeAPIPacket._check_api_packet(raw, min_length=RemoteATCommandWifiPacket.__MIN_PACKET_LENGTH)
if raw[3] != ApiFrameType.REMOTE_AT_COMMAND_REQUEST_WIFI.code:
raise InvalidPacketException("This packet is not a remote AT command request Wi-Fi packet.")
return RemoteATCommandWifiPacket(
raw[4],
IPv4Address(bytes(raw[9:13])),
raw[13],
raw[14:16].decode("utf8"),
raw[16:-1]
)
