SmartUSBHub Documentation
=========================

Identify your product and complete the wiring steps in its manual, then choose
the graphical application or a Python demo for your first control operation.

.. grid:: 1 1 3 3
   :gutter: 2

   .. grid-item-card:: Identify and connect your product
      :link: products/index
      :link-type: doc
      :class-card: docs-step-card docs-home-card

      .. image:: _static/icon-product.svg
         :alt: Product manual
         :class: docs-card-icon

      Match the product image and label, then read the correct manual for connector, power and safety instructions.

   .. grid-item-card:: Control it with a desktop app
      :link: software/control-pannel
      :link-type: doc
      :class-card: docs-step-card docs-home-card

      .. image:: _static/icon-desktop-control.svg
         :alt: Desktop control
         :class: docs-card-icon

      Install Control Pannel and switch each USB port directly from a graphical interface.

   .. grid-item-card:: Run a Python demo
      :link: quickstart
      :link-type: doc
      :class-card: docs-step-card docs-home-card

      .. image:: _static/icon-python-demo.svg
         :alt: Python demo
         :class: docs-card-icon

      Install the Python SDK and run a simple demo for your first port-control operation.

Desktop applications
--------------------

.. grid:: 1 1 2 2
   :gutter: 2

   .. grid-item-card:: Control Pannel
      :link: software/control-pannel
      :link-type: doc
      :class-card: docs-home-card

      .. image:: _static/icon-control-pannel.svg
         :alt: Control Pannel
         :class: docs-card-icon

      Lightweight graphical control for port switching, status, device modes and firmware updates.

   .. grid-item-card:: Studio Pro
      :link: software/studio-pro
      :link-type: doc
      :class-card: docs-home-card

      .. image:: _static/icon-studio-pro.svg
         :alt: Studio Pro
         :class: docs-card-icon

      Advanced console for power and data switching and multiple devices, with live waveforms and data logging on measurement-capable models.

Python development and reference
--------------------------------

.. grid:: 1 1 2 2
   :gutter: 2

   .. grid-item-card:: Python SDK Guide
      :link: software/python-library
      :link-type: doc
      :class-card: docs-home-card

      .. image:: _static/icon-python-sdk.svg
         :alt: Python SDK
         :class: docs-card-icon

      Learn device discovery, power and data switching, measurement, multi-device control and other features.

   .. grid-item-card:: Examples
      :link: software/examples
      :link-type: doc
      :class-card: docs-home-card

      .. image:: _static/icon-examples.svg
         :alt: Runnable examples
         :class: docs-card-icon

      Start with runnable examples for port cycling, data switching, measurement and multi-device control.

   .. grid-item-card:: Python API Reference
      :link: api/python
      :link-type: doc
      :class-card: docs-home-card

      .. image:: _static/icon-api-reference.svg
         :alt: API reference
         :class: docs-card-icon

      Look up exact classes, methods and parameters.

   .. grid-item-card:: GitHub ↗
      :link: https://github.com/mixedsignal-labs/smartusbhub
      :link-type: url
      :class-card: docs-home-card

      .. image:: _static/github-mark.svg
         :alt: GitHub
         :class: docs-card-icon

      View the SmartUSBHub repository, SDK source, examples and current releases.

.. toctree::
   :maxdepth: 1
   :caption: Get started
   :hidden:

   self
   products/index
   software/index