.. include:: /keyword.rst

===========
Genio Tools
===========

.. contents:: Sections
    :local:
    :depth: 2

Overview
********

Genio tools are a set of tools to configure or interact with MediaTek Genio boards.
MediaTek and community developers write the Genio tools in `Python`_.
Ensure you have Python 3.9 or later installed on your system.
MediaTek tested Genio Tools v1.5 with Python 3.9.

.. note::

        Some known issues affect Python 3.10 on the Windows platform.
        If you use Windows, we recommend you install Python 3.9.

.. _Python: https://www.python.org/


The Genio tools consist of 4 tools:

        * ``genio-config``: a tool to setup your host system in order to be able to communicate with MediaTek Genio boards
        * ``genio-flash``: a tool to flash a board with a Android image


Setup Tool Environment (Linux)
==============================

Please refer to :ref:`sw/android/get-started/env-setup/flash-env-linux:Setup Tool Environment (Linux)`.

Setup Tool Environment (Windows)
================================

Please refer to :ref:`sw/android/get-started/env-setup/flash-env-windows:Setup Tool Environment (Windows)`.

Genio Tools Usage
*****************

This section will describe how to use each Genio tool.

`genio-config`
==============

.. note::

        The `genio-config` tool is supported on both Linux and Windows.
        The **udev rules** information is only supported on Linux environment.

Developers use this tool to check the configuration of the host environment.

Run the following command to check that your environment is correctly configured:

.. prompt:: bash $ auto

         $ genio-config
         fastboot: OK
         udev rules: OK

In case your environment is not setup correctly, the tool will give you some
instructions on how to correctly configure it.

Run the following commands or reboot the Linux system for the **udev rules** to take effect:

.. prompt:: bash $

        sudo udevadm control --reload-rules
        sudo udevadm trigger

`genio-flash`
=============

.. note::

        The `genio-flash` tool is supported on both Linux and Windows.

This tool allows you to flash your board. `genio-flash` supports flashing Android images.

You can flash an image by running the following command:

.. prompt:: bash $

        genio-flash

The tool tries to find an image to flash in your current working directory.
If you want to flash an image in a different path, use the `--path` parameter:

.. prompt:: bash $

        genio-flash --path /path/to/image



Installation
------------

Only the preview installation package is available from Genio's GitLab repository.
Please install the specific ``1.5`` and later version to try this feature.

.. prompt:: bash >

        pip install genio-tools==1.6a3


.. note::

        After successfully installing the Genio-Tool, you can verify the installed version by using the following command.
		
		
.. code-block:: bash

   $ genio-flash --version
   1.6a3