Platform
========

``client.platform`` is the SDK surface for durable artifacts including navigation configs, maps, rosbags, and navigation deployment lifecycle.

Navigation config and map listing appear in :doc:`../examples/navigation-simple`.
Cloud archive catalog listing appears in :doc:`../examples/archive-catalog`.

.. tab-set::
   :sync-group: sdk-language

   .. tab-item:: Python
      :sync: python

      .. automodule:: olo.platform
         :no-members:

      **Client interfaces**

      .. autoclass:: olo.platform.Platform
         :members:

      .. autoclass:: olo.platform.PlatformNavigation
         :members:

      .. autoclass:: olo.platform.PlatformArchive
         :members:

      **Catalog types**

      .. autoclass:: olo.platform.NavConfigInfo
         :members:

      .. autoclass:: olo.platform.MapInfo
         :members:

      .. autoclass:: olo.platform.BagInfo
         :members:

      **Navigation deployment types**

      .. autoclass:: olo.platform.NavigationDeploymentInfo
         :members:

      .. autoclass:: olo.platform.NavigationDesiredSpec
         :members:

      .. autoclass:: olo.platform.NavigationObservedStatus
         :members:

      .. autoclass:: olo.platform.Pose2D
         :members:

      **Enums**

      .. autoclass:: olo.platform.NavConfigSource
         :members:

      .. autoclass:: olo.platform.CatalogLocation
         :members:

      .. autoclass:: olo.platform.NavigationMode
         :members:

      .. autoclass:: olo.platform.NavigationDesiredState
         :members:

      .. autoclass:: olo.platform.NavigationObservedState
         :members:

   .. tab-item:: TypeScript
      :sync: typescript

      ``client.platform`` on :doc:`Client </typescript/api/generated/olo/classes/Client>`:

      **Client interfaces**

      - :doc:`Platform </typescript/api/generated/olo/platform/classes/Platform>`
        — server-direct catalog surface.
      - :doc:`PlatformNavigation </typescript/api/generated/olo/platform/classes/PlatformNavigation>`
        — ``getConfigs(mode)``, ``listMaps()``, ``saveMap(name)``, ``start()``, ``stop()``, ``deployment()``.
      - :doc:`PlatformArchive </typescript/api/generated/olo/platform/classes/PlatformArchive>`
        — ``listBags()``, ``listVideos()``, ``listImages()``.
      - :doc:`resolveRobotId </typescript/api/generated/olo/platform/functions/resolveRobotId>`
        — resolve ``OLO_SDK_ROBOT_ID`` / an explicit robot UUID.

      **Catalog types**

      - :doc:`NavConfigInfo </typescript/api/generated/olo/platform/interfaces/NavConfigInfo>`
      - :doc:`MapInfo </typescript/api/generated/olo/platform/interfaces/MapInfo>`
      - :doc:`BagInfo </typescript/api/generated/olo/platform/interfaces/BagInfo>`
      - :doc:`NavConfigSource </typescript/api/generated/olo/platform/type-aliases/NavConfigSource>`
      - :doc:`CatalogLocation </typescript/api/generated/olo/platform/type-aliases/CatalogLocation>`

      **Navigation deployment types**

      - :doc:`NavigationDeploymentInfo </typescript/api/generated/olo/platform/interfaces/NavigationDeploymentInfo>`
      - :doc:`NavigationDesiredSpec </typescript/api/generated/olo/platform/interfaces/NavigationDesiredSpec>`
      - :doc:`NavigationObservedStatus </typescript/api/generated/olo/platform/interfaces/NavigationObservedStatus>`
      - :doc:`StartNavigationDeploymentOptions </typescript/api/generated/olo/platform/interfaces/StartNavigationDeploymentOptions>`
      - :doc:`Pose2D </typescript/api/generated/olo/platform/interfaces/Pose2D>`
      - :doc:`NavigationMode </typescript/api/generated/olo/platform/type-aliases/NavigationMode>`
      - :doc:`NavigationDesiredState </typescript/api/generated/olo/platform/type-aliases/NavigationDesiredState>`
      - :doc:`NavigationObservedState </typescript/api/generated/olo/platform/type-aliases/NavigationObservedState>`