:mod:`cloudmesh-common.cloudmesh.common.wifi`
=============================================

.. py:module:: cloudmesh-common.cloudmesh.common.wifi

.. autoapi-nested-parse::

   Implementation of a function the set the WIFI configuration.
   This function is primarily developed for a Raspberry PI



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

Classes
~~~~~~~

.. autoapisummary::

   cloudmesh-common.cloudmesh.common.wifi.Wifi



.. class:: Wifi

   The class is used to group a number of useful variables and functions so
   it is easier to program and manage Wifi configurations.

   The default location for the configuration file is

   /etc/wpa_supplicant/wpa_supplicant.conf

   .. attribute:: location
      :annotation: = /etc/wpa_supplicant/wpa_supplicant.conf

      

   .. attribute:: template_key
      

      

   .. attribute:: template_psk
      

      

   .. attribute:: template
      

      

   .. method:: set(ssid=None, password=None, country='US', psk=True, location=location, sudo=False)
      :staticmethod:

      Sets the wifi. Only works for psk based wifi

      :param ssid: The ssid
      :type ssid: str
      :param password: The password
      :type password: str
      :param country: Two digit country code
      :type country: str
      :param psk: If true uses psk authentication
      :type psk: bool
      :param location: The file where the configuration file should be written to
      :type location: str
      :param sudo: If tru the write will be done with sudo
      :type sudo: bool
      :return: True if success
      :rtype: bool