.. _web-serial-console:

Web Serial Console
==================

The **SiMa.ai Web Serial Console** is a browser-based tool for connecting to SiMa.ai DevKits directly from a Chromium-based browser via the `Web Serial API <https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API>`_. No installation is required — open the tool in a compatible browser, plug in your DevKit via USB, and connect.

`Launch Web Serial Console </_static/tools/serial/index.html>`_

Requirements
------------

The Web Serial API is only available in Chromium-based browsers:

* **Google Chrome** (recommended)
* **Microsoft Edge**

.. note::

   Firefox and Safari do not support the Web Serial API and cannot be used with this tool.

Getting Started
---------------

1. Connect your SiMa.ai DevKit to your computer using a USB to Serial cable.
2. Open the `Web Serial Console </_static/tools/serial/index.html>`_ in a supported browser.
3. Click **[+] New Connection** in the command palette.
4. Select the serial port corresponding to your DevKit from the browser pop-up and click **Connect**.
5. The console will automatically detect a login prompt and log in using the default credentials (``sima``/``edgeai``).

Interface
---------

Terminal
~~~~~~~~

Type commands directly into the terminal window and press **Enter** to execute them on the connected DevKit.

Command Palette
~~~~~~~~~~~~~~~

The command palette at the bottom of the page provides quick access to common actions:

.. list-table::
   :widths: 25 75
   :header-rows: 1

   * - Button
     - Action
   * - **[+] New Connection**
     - Open a new connection tab for an additional DevKit
   * - **Settings**
     - Configure baud rate and flow control before connecting
   * - **Login**
     - Send the default credentials (``sima``/``edgeai``)
   * - **Networking**
     - Run ``ifconfig`` on the active DevKit
   * - **Disk Space**
     - Run ``df -h`` on the active DevKit
   * - **Build**
     - Display ``/etc/buildinfo`` from the active DevKit
   * - **Logout**
     - Send the ``logout`` command to the active DevKit
   * - **Clear**
     - Clear the terminal output
   * - **Light/Dark Mode**
     - Toggle the UI theme
   * - **Fullscreen**
     - Enter fullscreen mode
   * - **[Hide]**
     - Collapse the command palette for a larger terminal view

Multiple Connections
~~~~~~~~~~~~~~~~~~~~

The console supports connecting to multiple DevKits simultaneously. Each connection opens as a separate tab at the top of the terminal area. Click a tab to switch between active connections, or click **×** on a tab to disconnect and close that session.

Disconnecting
-------------

Click the **×** button on a connection tab to disconnect. The console will automatically send a ``logout`` command to the DevKit before closing the connection.