.. Phoenix documentation master file, created by
   sphinx-quickstart on Tue Dec 18 17:00:49 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to Phoenix's documentation!
======================================
Below is the documentation for the CTR-Electronics Phoenix 5 software framework.
This includes...

* **Class library** for supported :ref:`Phoenix devices <Do I need to install any of this?>` for programming in C++, Java (FRC), LabVIEW (FRC), or C# (HERO).
* **Phoenix Tuner** Graphical Interface - provides configuration options, diagnostics, control and plotting.
* **Phoenix Diagnostic Server** - install on to roboRIO for Tuner, and to perform HTTP API requests for diagnostic information.

.. warning:: Newer devices are no longer supported in Phoenix 5 and should instead use the `Phoenix 6 library <https://v6.docs.ctr-electronics.com/en/stable/>`__.

Blog Entries
============
**Blog entries for 2022 and on will be posted at:** `CTR-Electronics Blog`_.


.. _CTR-Electronics Blog: https://store.ctr-electronics.com/blogs/news

.. only:: html

   .. postlist:: 
      :date: %b %d, %Y
      :list-style: circle
      :format: {date} - {title}

Follow these instructions in order!
===================================
.. toctree::
   :maxdepth: 2

   ch01_PhoeSoftRefManual
   ch02_PrimerCAN
   ch03_PrimerPhoenixSoft
   ch04_DoINeedThis
   ch05_PrepWorkstation
   ch05a_CppJava
   ch06_PrepRobot
   ch06b_PrepLinuxRobot
   ch07_InitHardTesting
   ch08_BringUpCAN
   ch08a_BringUpCANivore
   ch09_BringUpPCM
   ch10_BringUpPDP
   ch11_BringUpPigeon
   ch11a_BringUpPigeon2
   ch12_BringUpCANifier
   ch12a_BringUpCANCoder
   ch12b_BringUpCANdle
   ch13_MC
   ch14_MCSensor
   ch14a_BringUpRemoteSensors
   ch14b_BringUpDifferentialSensors
   ch15_WPIDrive
   ch15a_Simulation
   ch16_ClosedLoop
   ch17_Faults
   ch18_CommonAPI
   ch19_Support
   ch20_FAQ
   ch21_Errata
   ch22_SoftReleaseNote
   ch23_AddResource

.. toctree:: 
   :maxdepth: 1
   :caption: API Docs
   :hidden:

   Phoenix Java API Docs <https://api.ctr-electronics.com/phoenix/stable/java/>
   Phoenix C++ API Docs <https://api.ctr-electronics.com/phoenix/stable/cpp/>

