.. _AraRAN_Experiment_Skylark_UE_Measurement:


Measurement and Configuration of AraMIMO UE
-----------------------------------------------------------------------

**Platform:** Skylark Wireless

**Resources needed:** Customer Premises Equipment (CPE)/User Equipment (UE)

**Short Description:** The experiment is designed to monitor wireless
 link parameters of the AraMIMO UE.

**Detailed Description:** AraMIMO consists of multiple CPEs connected to 
the Base Station (BS) which is a Skylark Wireless Faros V2 equipment. With
this experiment, we can launch a container equipped with APIs to
interact with Skylark CPE and measure real-time metrics such as received power
or to configure the gain of the Skylark CPE. 

**Detailed Steps**

#. Login to the portal ``portal.arawireless.org`` with your username
   and password. Please go through the :ref:`Hello World
   <ARA_Hello_World>` example on how to login to portal, create a
   lease, launch a container, assign a floating IP address and
   accessing the container (or make sure you have already run that
   experiment successfully and are familiar with using the experiment
   portal).

   .. note:: If you are a first time user, it is highly recommended to
	     run the :ref:`Hello World <ARA_Hello_World>` experiment
	     first to get familiarized with the interface and portal.


#. Create a reservation using the *Project -> Reservations ->
   Leases* tab from the dashboard. 
   
#. Click on ``create Lease`` and write the Lease Name e.g. `skylark_mimo_1`
   and click ``Next``.

#. Select the resource attributes e.g.:

      * *Site*: Curtiss Farm  
      * *Resource Type*: AraRAN 
      * *Device Type*: User Equipment  
      * *Device ID*: 000

   .. note:: Some UEs have no Skylark CPE. 
        Check the `ARA Resources Overview`_ on the portal to see 
        which UE sites have the 
        Skylark Experiment available and then select The
        above attributes according to the sites. 

        .. _ARA Resources Overview: https://portal.arawireless.org/project/

#. Launch a container equipped with APIs using the container image
   ``arawirelesshub/aramimo:v1.1``

#. Once the container is launched, take a note of the floating IP if
   you want to access the container from your PC via ARA jumpbox. 

#. The containers can be accessed via the ``Console`` tab of the
   respective containers in the *Project -> Containers* tab. 

#. To SSH to the container using floating IP, ssh needs to enabled
   in the container. In ``Console``, run the following command ::

	# service ssh start

   .. image:: images/Start_SSH.png
       :align: center

#. Set the password for root by typing the following command and then set the password ::

	# passwd

#. Now the container can be accessed both from the dashboard Console or using ssh from the jumpbox server.

#. To ssh to the container, use the floating IP that is reserved for
   the container with root as username and password that is set in
   previous step. Visit :ref:`ARA_Jumpbox` for more information on
   accessing containers via jumpbox.

#. In the container, Run the following command to launch the CLI.  ::

    # cd aramimo
    # ./cpe_api_client.py

   .. image:: images/cpe_api_client.png
       :align: center

#. Run the following command to check if the CPE is connected to BS.  ::

    > get_connection_status 

   .. image:: images/get_connection_status.png
       :align: center

#. If the UE is not connected, it can be connected to the BS, provided the 
   BS is working and transmitting already. Each UE has a configuration script
   that can be used to configure and start the radio. The configuration file is 
   not visible to the users and is automatically handled by the wrapper APIs. 
   Run the following command to configure and start the radio to be able to connect
   to the BS. It takes about a minute for the CPE to get connected to the BS. ::

    > set_configure_radio

   .. image:: images/set_configure_radio.png
       :align: center

#. Run the following command to check the received power values. ::

    > get_rx_power

   .. image:: images/get_rx_power.png
       :align: center

#. Type ```help -v``` to show all the commands that can be run. 
   Here are the list of commands that can be run.  ::
   
      get_phy_stats             Return detailed PHY statistics of the radio
      get_rx_gain               Return Rx Gain in dB
      get_rx_power              Return Rx Power in dBFs and dBm along with current Rx Gains
      get_tx_gain               Return Tx Gain in dB
      set_close_radio           Disable the Radio PHY
      set_configure_radio       Configure the Radio to start transmission
      set_rx_gain               Set Rx Gain in dB
      set_tx_gain               Set Tx Gain in dB

#. UE wrapper APIs also enable configuration of the UE parameters, such as 
   setting the transmit gain, disconnecting the radio (`set_close_radio`) or 
   reconnecting it (`set_configure_radio`) to the the BS. 

#. This container contains the `AraMIMO Repo`_ on Gitlab which
   contains other useful scripts along with documentation.  The
   :ref:`ARA_MIMO_APIs` is documented in the user manual.

   .. _AraMIMO API: https://arawireless.readthedocs.io/en/latest/ara_technical_manual/sklk_wrapper.html

   .. _AraMIMO Repo: https://gitlab.com/aralab/arasoft/aramimo/aramimo

#. If you need to collect data, there are multiple example scripts in the aramimo repo. 
   e.g. to capture capacity, SNR, MCS, for each UE, run the ``kpi_data_script`` by providing the 
   number of iterations. Note that those scripts are for getting the data from the BS 
   so they have to be modified to get the data from the UE. For getting the data from the BS,
   container has to be launched on the BS.

.. tip:: If you want to perform weather measurements along with the
	  RAN experiments, refer to :ref:`ARA Weather APIs
	  <ARA_Weather_APIs>`.