:py:mod:`expliot.core.protocols.radio.dot154`
=============================================

.. py:module:: expliot.core.protocols.radio.dot154

.. autoapi-nested-parse::

   Support for IEEE802.15.4 Protocol Plugins



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   dot154_utils/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   expliot.core.protocols.radio.dot154.PcapDumper
   expliot.core.protocols.radio.dot154.PcapFrame
   expliot.core.protocols.radio.dot154.Timer
   expliot.core.protocols.radio.dot154.ZbAuditor
   expliot.core.protocols.radio.dot154.Dot154Radio




.. py:class:: PcapDumper(datalink, filename)

   Helper class to create and write data to the pcap file.

   .. py:method:: write_to_pcapfile(pcapframe)

      Write packet header and packet to pcap file.

      :param pcapframe: pcap frame including packet header and packet



.. py:class:: PcapFrame(packet, ts32=None)

   Helper class to create pcap frame to write in pcap file.

   .. py:method:: __build_packet_pcap_hdr()

      Build the packet header string with timestamp and length info.

      :return: Packet header string


   .. py:method:: get_pcap_frame()

      Return packet header string and packet string.

      :return: Packet header + packet string



.. py:class:: Timer(timeout=1)

   Timer class to support time out.

   .. py:attribute:: timeout
      

      

   .. py:method:: __get_timeout()

      Return Timeout.


   .. py:method:: __set_timeout(timeout=1)

      Set current time, and timeout.


   .. py:method:: is_timeout()

      Return true if time out.



.. py:class:: ZbAuditor

   Zigbee Auditor Class.

   .. py:method:: get_interface_info()

      Return Device information in dictionary format.

      :return: Dictionary of Device Name, FW Revision, Services


   .. py:method:: set_channel(channel, page=0)

      Validate and Set Channel to Device.


   .. py:method:: get_channel()

      Return Channel from Device.


   .. py:method:: get_radio_on_flag()

      Return status of radio_on flag.


   .. py:method:: set_radio_on_flag(flag)

      Set radio_on flag.


   .. py:method:: get_sniffer_on_flag()

      Return status of sniffer_on flag.


   .. py:method:: set_sniffer_on_flag(flag)

      Set sniffer_on flag.


   .. py:method:: radio_on()

      Turn on device radio.


   .. py:method:: sniffer_on(channel, page=0)

      Turn on device sniffer service.


   .. py:method:: packet_read(timeout=100)

      Read data from device.


   .. py:method:: radio_off()

      Turn off device radio.


   .. py:method:: sniffer_off()

      Turn off device sniffer service.


   .. py:method:: inject_packet(packet)

      Inject packet to Device.


   .. py:method:: scan_zb_network(mask)

      Set Device in network scan mode.

      Additionally it return network scan result as dictionary.


   .. py:method:: get_rxcount()

      Return packet receive count from driver.

      :return: rx count


   .. py:method:: get_txcount()

      Return packet transmit count from driver.

      :return: tx count


   .. py:method:: __del__()

      Close the driver.



.. py:class:: Dot154Radio

   Radio Class for IEEE 802.15.4 Protocol.

   .. py:method:: get_device_info()

      Returns basic information of Radio attached.


   .. py:method:: radio_on()

      Turn ON Radio.


   .. py:method:: set_channel(channel, page=0)

      Set Channel and Page.


   .. py:method:: sniffer_on(channel, page=0)

      Turn ON Sniffer.

      :param channel: zigbee channel
      :param page: zigbee frequecy page


   .. py:method:: read_raw_packet()

      Read single packet from radio driver.

      :return: dict with packet as element


   .. py:method:: sniffer_off()

      Turn OFF Sniffer.


   .. py:method:: radio_off()

      Turn OFF Radio.


   .. py:method:: inject_raw_packet(packet)

      Send raw packet to radio driver.


   .. py:method:: get_received_packets()

      Returns total number of packet received.


   .. py:method:: get_transmitted_packets()

      returns total number of packet transmitted.


   .. py:method:: __del__()