.. |br| raw:: html

      <br>

.. _xbee:

XBEE
====

The ``Xbee`` class manages the XBEE sockets as if they were serial ports.

Methods
-------

.. automodule:: xbee
   :members:

.. note:: 
    Since the ``get_uart_id()`` method of the ``Xbee`` class returns a microPython UART object, it has all its methods. |br|
    To do not duplicate the documentation, we suggest to take a look at the `official microPython project documentation <https://docs.micropython.org/en/latest/library/machine.UART.html?highlight=uart#methods>`_ to see what methods you can additionaly use.
    
    Example of additional methods:
        >>> import sbc
        >>> xbeeA = sbc.Xbee( 115200, "XBEE_A" )
        >>> print('There are: ',xbeeA.any(),' characters to be read')
        There are:  1580  characters to be read
        >>> print(xbeeA.get_uart_id().readline())
        b'$GNGGA,142222.00,4136.52091,N,00036.70322,E,2,10,1.27,203.6,M,49.8,M,,0000*4D\r\n'