zigbee_info
============

Presentation
-------------
**zigbee_info** gets informations on a given Zigbee interface. It can also show the different capabilities of the interface (*SHOW_CAPABILITIES* parameter).

Compatible devices
------------------

 * `RZUSBStick Device <devices.html#rzusbstick-device>`_
 * `PCAP Files <devices.html#zigbee-pcap-files>`_

Input parameters
-----------------

+----------------------------------------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------+
| Name                                   | Default value                         | Possible values                                                         | Description                                                          |
+========================================+=======================================+=========================================================================+======================================================================+
| INTERFACE                              | rzusbstick0                           | rzusbstickX\|<filename>.pcap                                            | Interface to analyse                                                 |
+----------------------------------------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------+
| SHOW_CAPABILITIES                      | yes                                   | yes\|no                                                                 | Indicates if the capabilities of the interface should be displayed   |
+----------------------------------------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------+

Output parameters
-----------------

	* If the interface provided is ``rzusbstickX``:

	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| Name                                   | Possible values                                             | Description                                                          |
	+========================================+=============================================================+======================================================================+
	| INTERFACE                              | rzusbstickX                                                 | Selected interface                                                   |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| MODE                                   | NORMAL \| JAMMING                                           | Mode currently in use in the selected interface                      |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| SERIAL                                 | <hexadecimal>                                               | Device's serial number                                               |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| FIRMWARE_VERSION                       | <string>                                                    | Device's firmware version                                            |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| INDEX                                  | #X                                                          | Device's index number                                                |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+


	* If the interface provided is ``<filename>.pcap``:

	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| Name                                   | Possible values                                             | Description                                                          |
	+========================================+=============================================================+======================================================================+
	| INTERFACE                              | <filename>.pcap                                             | Selected interface                                                   |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+
	| MODE                                   | read \| write                                               | Mode in use                                                          |
	+----------------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------+

Usage
------

To get complete information about an interface, use the following command:
::

	$ mirage zigbee_info
	[INFO] Module zigbee_info loaded !
	[INFO] RZUSBStick: Killerbee firmware in use.
	┌─────────────┬──────────────┬───────────────┬──────────────────┬────────┐
	│ Interface   │ Device Index │ Serial number │ Firmware Version │ Mode   │
	├─────────────┼──────────────┼───────────────┼──────────────────┼────────┤
	│ rzusbstick0 │ #0           │ FFFFFFFFFFFF  │ KILLERB001       │ NORMAL │
	└─────────────┴──────────────┴───────────────┴──────────────────┴────────┘
	[INFO] Mirage process terminated !