Kubos
~~~~~

The Kubos platform provides small satellite developers the tools and
libraries necessary to quickly bring up space ready software. We
leverage multiple existing open source projects like FreeRTOS and CSP,
along with our own custom framework and SDK.

Looking to build an application on Kubos? Check out our :doc:`KubOS RT 
quick start guide <first-rt-project>` or our :doc:`KubOS Linux quick 
start guide <first-linux-project>`

Having issues? Want a new feature? `Come talk to
us! <https://slack.kubos.co/>`__

If for some reason Slack won't work for you, feel free to email us at
info@kubos.co.

Quick Start Tutorial
--------------------

.. raw:: html

    <iframe width="640" height="480" allowfullscreen
    src="https://www.youtube.com/embed/WYthDHETmBU">
    </iframe>

This video is intended to help you set up your Kubos SDK development
environment and get your first project built and running on an end-point
device.
It covers the following tutorial documents:

  - :doc:`Installing the Kubos SDK <sdk-installing>`
  - :doc:`Creating Your First KubOS RT Project <first-rt-project>`
  
.. note::

    This video is intended for 100% from scratch users and covers KubOS RT only.

.. toctree::
   :caption: Docs
   :hidden:

    Changelog <changelog>
    Kubos Architecture <kubos-architecture>
    FAQs and Troubleshooting Tips <faq-troubleshooting>

.. toctree::
   :caption: Kubos SDK
   :hidden:

    Installing Kubos SDK <sdk-installing>
    Creating Your First KubOS RT Project <first-rt-project>
    Creating Your First KubOS Linux Project <first-linux-project>
    Kubos SDK Example Applications <sdk-examples>
    Kubos SDK Cheat Sheet <sdk-cheatsheet>
    Kubos CLI Command Reference <sdk-reference>
    Kubos Project Configuration <sdk-project-config>
    Upgrading Kubos SDK <sdk-upgrading>

.. toctree::
   :caption: Kubos RT
   :hidden:

    MSP430 Launchpad Guide <msp430-launchpad-guide>
    STM32F4 Discovery Board Guide <stm32f4-discovery-board-guide>

.. toctree::
   :caption: Kubos Linux
   :hidden:

    Working with the iOBC <working-with-the-iobc>
    Command and Control <command-and-control>

.. toctree::
   :caption: Developer and SysAdmin Docs
   :hidden:

    Contributing to the Kubos Project <contribution-process>
    Kubos Naming and Coding Standards <kubos-standards>
    Kubos Module Development <kubos-development>
    KubOS Linux Overview <kubos-linux-overview>
    KubOS Linux on iOBC <kubos-linux-on-iobc>
    KubOS Linux Upgrades <kubos-linux-upgrade>
    KubOS Linux Recovery <kubos-linux-recovery>
    Command and Control Internal Protcol <c2-daemon>

.. toctree::
   :caption: Kubos APIs
   :hidden:
   
    Kubos Core <kubos-core/index>
    Kubos HAL <kubos-hal/index>
    Kubos IPC <ipc/index>
    Kubos Telemetry <telemetry/index>
    
  
.. toctree::
   :caption: Third-Party APIs
   :hidden:
   
    CSP <libcsp/index>
    FreeRTOS <freertos/index>

.. todo::
    Telemetry <@ref%20telemetry-main>
    Telemetry Aggregator <@ref%20telemetry-aggregator-main>
    Telemetry Storage <@ref%20telemetry-storage-main>


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`