:py:mod:`pycasx.connectors.adsb`
================================

.. py:module:: pycasx.connectors.adsb

.. autoapi-nested-parse::

   ADS-B Sensor Connector.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pycasx.connectors.adsb.ADSB




.. py:class:: ADSB


   ADS-B Sensor Connector.

   :param host: The http host of the FlightGear instance.
   :type host: str
   :param port: The http port of the FlightGear instance.
   :type port: int

   .. attribute:: host

      The http host of the FlightGear instance.

      :type: str

   .. attribute:: port

      The http port of the FlightGear instance.

      :type: int

   .. attribute:: conn

      The connection to the FlightGear instance.

      :type: HTTPConnection

   .. py:attribute:: host
      :type: str

      

   .. py:attribute:: port
      :type: int

      

   .. py:attribute:: conn
      :type: flightgear_python.fg_if.HTTPConnection

      

   .. py:method:: __post_init__()

      Run post init steps required to finalize the initialization.


   .. py:method:: get_prop(prop_str)

      Get a property from FlightGear.

      :param prop_str: location of the property, should always be
                       relative to the root (``/``)
      :type prop_str: str

      :returns:

                the value of the property. If FG tells us what the type
                    is we will pre-convert it (i.e. make an int from a string)
      :rtype: Any


   .. py:method:: set_prop(prop_str, value)

      Set a property in FlightGear.

      :param prop_str: location of the property, should always be
                       relative to the root (``/``)
      :type prop_str: str
      :param value: value to set the property to. Must be convertible
                    to ``str``
      :type value: Any


   .. py:method:: list_props(path = '/', recurse_limit = 0)

      List properties in the FlightGear property tree.

      :param path: directory to list from, should always be
                   relative to the root (``/``)
      :type path: str
      :param recurse_limit: how many times to recurse into
                            subdirectories. 1 (default) is no recursion, 2 is 1
                            level deep, etc. Passing in ``None`` disables the
                            recursion limit. Be warned that enabling any kind of
                            recursion will take a long time!
      :type recurse_limit: int | None

      :returns: dictionary with keys:

                * ``directories``: List of directories, absolute path
                * ``properties``: Dictionary with property name as the key
                    (absolute path), value as their value.
      :rtype: PropsDict

      Example for ``list_props('/position', recurse_limit=0)``:

      .. code-block:: python

          {
              'directories': [
                  '/position/model'
              ],
              'properties': {
                  '/position/altitude-agl-ft': 3.148566963,
                  '/position/altitude-agl-m': 0.9596832103,
                  '/position/altitude-ft': 3491.986254,
                  '/position/ground-elev-ft': 3488.469757,
                  '/position/ground-elev-m': 1063.285582,
                  '/position/latitude-deg': 0.104476136,
                  '/position/latitude-string': '0*06\\'16.1"N',
                  '/position/longitude-deg': 100.023135,
                  '/position/longitude-string': '100*01\\'23.3"E',
                  '/position/sea-level-radius-ft': 20925646.09
              }
          }