device
======

Documentation for the ``device`` command and its subcommands.


.. raw:: html

    <!-- spacer -->

.. dropdown:: ``device`` — Discover and manage device(s) for MPK deployment and app lifecycle management purposes, compatible with both PCIe and Ethernet deployment models. Host side only.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS] COMMAND [ARGS]...
        
          Discover and manage device(s) for MPK deployment and app lifecycle
          management purposes, compatible with both PCIe and Ethernet deployment
          models. Host side only.
        
        Options:
          --help  Show this message and exit.
        
        Commands:
          connect           Connect to a device over Ethernet or PCIe
          disconnect        Disconnects from a device
          discover          Discover nearby SiMa.ai DevKits via ARP or multicast.
          firmware-upgrade  Upgrade firmware for PCIe device
          list              List the connected devices
          reboot            Reboot a specific device

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS] COMMAND [ARGS]...


.. dropdown:: ``device connect`` — Connect to a device over Ethernet or PCIe
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Connect to a device over Ethernet or PCIe
        
        Options:
          -t, --target TEXT    Ethernet device IP or FQDN.
          -u, --user TEXT      Username (defaults to 'sima').
          -p, --password TEXT  Password (defaults to 'edgeai').
          -s, --slot TEXT      PCIe slot number e.g. 1
          --help               Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``device disconnect`` — Disconnects from a device
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Disconnects from a device
        
        Options:
          -t, --target TEXT  IP address or the FQDN of the device to disconnect
                             (Ethernet).
          -u, --user TEXT    Username of the device to disconnect.  [default: sima]
          -s, --slot TEXT    Slot number of the PCIe SoC to disconnect.
          --help             Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``device discover`` — Discover nearby SiMa.ai DevKits via ARP or multicast.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Discover nearby SiMa.ai DevKits via ARP or multicast.
        
        Options:
          --help  Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``device firmware-upgrade`` — Upgrade firmware for PCIe device
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Upgrade firmware for PCIe device
        
        Options:
          -f, --file FILE         Software Update file.  [required]
          -t, --target TEXT       FQDN or IP address of the DevKit to upgrade.
          -s, --slot-number TEXT  Slot number of the PCIe SoC to upgrade.
          --reboot-on-upgrade     Reboot the device automatically after upgrade.
          --help                  Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``device list`` — List the connected devices
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          List the connected devices
        
        Options:
          --help  Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``device reboot`` — Reboot a specific device
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Reboot a specific device
        
        Options:
          -t, --target TEXT  Ethernet device IP or FQDN.
          -s, --slot TEXT    PCIe slot number, e.g. 1
          --help             Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


Options
-------

No options available.