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

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

.. autoapi-nested-parse::

   Support for Zigbee protocol plugins.



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

   zigbee_utils/index.rst


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

Classes
~~~~~~~

.. autoapisummary::

   expliot.core.protocols.radio.zigbee.ZbAuditor
   expliot.core.protocols.radio.zigbee.ZigbeeNetworkScan




.. 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:: ZigbeeNetworkScan

   Scan Zigbee network for available device.

   .. py:method:: get_device_info()

      Return device basic information


   .. py:method:: scan(mask=134215680)

      Scan network for channel mask and return result as dictionary.