From f8edae68d9d937cc6a5c4946787f7dfb14e507c4 Mon Sep 17 00:00:00 2001 From: William Miceli Date: Fri, 29 Jan 2021 19:14:41 -0500 Subject: [PATCH] Documentation mostly working as desired. Good enough for now. Added some topics. --- Documentation/html/_9_hardware_8markdown.html | 98 +++++++++ Documentation/html/_9_software_8markdown.html | 98 +++++++++ .../_device_01_specifications_8markdown.html | 6 +- ...ice_01_specifications_test3_8markdown.html | 98 +++++++++ .../_documentation_01_guide_8markdown.html | 98 +++++++++ .../html/_layout_01_planning_8markdown.html | 6 +- .../html/_r_e_a_d_m_e_8markdown.html | 6 +- Documentation/html/device_specifications.html | 206 +++++++++++++++++ .../dir_4e9c05acfa2c3671b8618fcb95d57d96.html | 6 +- .../dir_6cc751a9e685a986d41d35de353de328.html | 6 +- .../dir_6cc751a9e685a986d41d35de353de328.js | 14 ++ .../dir_70428d3c5958c16802133545478a5cfb.html | 6 +- .../dir_7795a02a4813dcd036f04e5f7854f185.html | 98 +++++++++ .../dir_ef94255a62432ae865475b379d8bd501.html | 6 +- Documentation/html/documentation_guide.html | 120 ++++++++++ Documentation/html/documentation_guide1.html | 100 +++++++++ Documentation/html/files.html | 15 +- Documentation/html/files_dup.js | 3 +- Documentation/html/globals.html | 6 +- Documentation/html/globals_func.html | 6 +- Documentation/html/hardware.html | 105 +++++++++ Documentation/html/hardware.js | 5 + Documentation/html/index.html | 22 +- Documentation/html/layout_planning.html | 101 +++++++++ Documentation/html/main_8c.html | 6 +- Documentation/html/main_8c_source.html | 6 +- .../md__hardware__device__specifications.html | 43 ++-- ...ardware__device__specifications_test3.html | 208 ++++++++++++++++++ .../html/md__hardware__layout__planning.html | 6 +- Documentation/html/navtreedata.js | 35 ++- Documentation/html/navtreeindex0.js | 64 +++--- Documentation/html/pages.html | 9 +- Documentation/html/search/all_0.js | 4 +- Documentation/html/search/all_1.js | 5 +- Documentation/html/search/all_2.js | 3 +- Documentation/html/search/all_3.js | 4 +- Documentation/html/search/all_4.js | 3 +- Documentation/html/search/all_5.html | 37 ++++ Documentation/html/search/all_5.js | 4 + Documentation/html/search/all_6.html | 37 ++++ Documentation/html/search/all_6.js | 4 + Documentation/html/search/files_0.js | 3 +- Documentation/html/search/files_1.js | 3 +- Documentation/html/search/files_2.js | 2 +- Documentation/html/search/files_3.js | 2 +- Documentation/html/search/files_4.html | 37 ++++ Documentation/html/search/files_4.js | 4 + Documentation/html/search/functions_0.js | 2 +- Documentation/html/search/pages_0.js | 3 +- Documentation/html/search/pages_1.js | 2 +- Documentation/html/search/pages_2.js | 2 +- Documentation/html/search/pages_3.html | 37 ++++ Documentation/html/search/pages_3.js | 4 + Documentation/html/search/searchdata.js | 6 +- Documentation/html/software.html | 99 +++++++++ Documentation/latex/_9_hardware_8markdown.tex | 2 + Documentation/latex/_9_software_8markdown.tex | 2 + ...vice_01_specifications_test3_8markdown.tex | 2 + .../_documentation_01_guide_8markdown.tex | 2 + .../dir_7795a02a4813dcd036f04e5f7854f185.tex | 2 + Documentation/latex/documentation_guide.tex | 19 ++ Documentation/latex/documentation_guide1.tex | 1 + Documentation/latex/hardware.tex | 109 +++++++++ Documentation/latex/index.tex | 21 +- Documentation/latex/layout_planning.tex | 1 + .../md__hardware__device__specifications.tex | 21 +- ...hardware__device__specifications_test3.tex | 99 +++++++++ .../latex/md__hardware__layout__planning.tex | 2 +- Documentation/latex/refman.tex | 27 ++- Documentation/latex/software.tex | 0 Doxyfile | 9 +- Hardware/!Hardware.markdown | 10 + Hardware/Device Specifications.markdown | 2 +- Hardware/Layout Planning.markdown | 2 +- Meta/Documentation Guide.markdown | 34 +++ README.markdown | 21 +- Software/!Software.markdown | 4 + 77 files changed, 2135 insertions(+), 176 deletions(-) create mode 100644 Documentation/html/_9_hardware_8markdown.html create mode 100644 Documentation/html/_9_software_8markdown.html create mode 100644 Documentation/html/_device_01_specifications_test3_8markdown.html create mode 100644 Documentation/html/_documentation_01_guide_8markdown.html create mode 100644 Documentation/html/device_specifications.html create mode 100644 Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js create mode 100644 Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html create mode 100644 Documentation/html/documentation_guide.html create mode 100644 Documentation/html/documentation_guide1.html create mode 100644 Documentation/html/hardware.html create mode 100644 Documentation/html/hardware.js create mode 100644 Documentation/html/layout_planning.html create mode 100644 Documentation/html/md__hardware__device__specifications_test3.html create mode 100644 Documentation/html/search/all_5.html create mode 100644 Documentation/html/search/all_5.js create mode 100644 Documentation/html/search/all_6.html create mode 100644 Documentation/html/search/all_6.js create mode 100644 Documentation/html/search/files_4.html create mode 100644 Documentation/html/search/files_4.js create mode 100644 Documentation/html/search/pages_3.html create mode 100644 Documentation/html/search/pages_3.js create mode 100644 Documentation/html/software.html create mode 100644 Documentation/latex/_9_hardware_8markdown.tex create mode 100644 Documentation/latex/_9_software_8markdown.tex create mode 100644 Documentation/latex/_device_01_specifications_test3_8markdown.tex create mode 100644 Documentation/latex/_documentation_01_guide_8markdown.tex create mode 100644 Documentation/latex/dir_7795a02a4813dcd036f04e5f7854f185.tex create mode 100644 Documentation/latex/documentation_guide.tex create mode 100644 Documentation/latex/documentation_guide1.tex create mode 100644 Documentation/latex/hardware.tex create mode 100644 Documentation/latex/layout_planning.tex create mode 100644 Documentation/latex/md__hardware__device__specifications_test3.tex create mode 100644 Documentation/latex/software.tex create mode 100644 Hardware/!Hardware.markdown create mode 100644 Meta/Documentation Guide.markdown create mode 100644 Software/!Software.markdown diff --git a/Documentation/html/_9_hardware_8markdown.html b/Documentation/html/_9_hardware_8markdown.html new file mode 100644 index 0000000..ed876f4 --- /dev/null +++ b/Documentation/html/_9_hardware_8markdown.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Hardware/!Hardware.markdown File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Hardware/!Hardware.markdown File Reference
+
+
+
+
+ + + + diff --git a/Documentation/html/_9_software_8markdown.html b/Documentation/html/_9_software_8markdown.html new file mode 100644 index 0000000..0beb8a2 --- /dev/null +++ b/Documentation/html/_9_software_8markdown.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Software/!Software.markdown File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Software/!Software.markdown File Reference
+
+
+
+
+ + + + diff --git a/Documentation/html/_device_01_specifications_8markdown.html b/Documentation/html/_device_01_specifications_8markdown.html index c7873cf..df64c6c 100644 --- a/Documentation/html/_device_01_specifications_8markdown.html +++ b/Documentation/html/_device_01_specifications_8markdown.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Hardware/Device Specifications.markdown File Reference +2020-2021 Sunseeker Telemetry and Lighting System: Hardware/Device Specifications.markdown File Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_device_01_specifications_8markdown.ht diff --git a/Documentation/html/_device_01_specifications_test3_8markdown.html b/Documentation/html/_device_01_specifications_test3_8markdown.html new file mode 100644 index 0000000..0a3b1c2 --- /dev/null +++ b/Documentation/html/_device_01_specifications_test3_8markdown.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Hardware/Device SpecificationsTest3.markdown File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Hardware/Device SpecificationsTest3.markdown File Reference
+
+
+
+
+ + + + diff --git a/Documentation/html/_documentation_01_guide_8markdown.html b/Documentation/html/_documentation_01_guide_8markdown.html new file mode 100644 index 0000000..518f1f1 --- /dev/null +++ b/Documentation/html/_documentation_01_guide_8markdown.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Meta/Documentation Guide.markdown File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Meta/Documentation Guide.markdown File Reference
+
+
+
+
+ + + + diff --git a/Documentation/html/_layout_01_planning_8markdown.html b/Documentation/html/_layout_01_planning_8markdown.html index 9b8dfdc..9ba69c7 100644 --- a/Documentation/html/_layout_01_planning_8markdown.html +++ b/Documentation/html/_layout_01_planning_8markdown.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Hardware/Layout Planning.markdown File Reference +2020-2021 Sunseeker Telemetry and Lighting System: Hardware/Layout Planning.markdown File Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_layout_01_planning_8markdown.html','' diff --git a/Documentation/html/_r_e_a_d_m_e_8markdown.html b/Documentation/html/_r_e_a_d_m_e_8markdown.html index 2335737..300cdc9 100644 --- a/Documentation/html/_r_e_a_d_m_e_8markdown.html +++ b/Documentation/html/_r_e_a_d_m_e_8markdown.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: README.markdown File Reference +2020-2021 Sunseeker Telemetry and Lighting System: README.markdown File Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_r_e_a_d_m_e_8markdown.html',''); init diff --git a/Documentation/html/device_specifications.html b/Documentation/html/device_specifications.html new file mode 100644 index 0000000..3c6cb49 --- /dev/null +++ b/Documentation/html/device_specifications.html @@ -0,0 +1,206 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Device Specifications + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Device Specifications
+
+
+

+Microcontroller: Texas Instruments MSP430F5438AIPZR

+
    +
  • 1.8 V to 3.6 V Supply Voltage
    • +
  • Capabilities:
      +
    • 16-bit architecture
      • +
    • 25 MHz System Clock
      • +
    +
    • +
  • Notable Peripherals:
      +
    • Up to 4 of:
        +
      • UART/SPI
        • +
      +
      • +
    • Up to 4 of:
        +
      • I2C/SPI
        • +
      +
      • +
    • 12-bit ADC
        +
      • 14 external channels
        • +
      +
      • +
    +
    • +
+

+Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN

+
    +
  • 1.8 V to 5.5 V Supply Voltage
    • +
  • Notable Peripherals:
      +
    • I2C
        +
      • Clock rate up to 400 kHz
        • +
      +
      • +
    +
    • +
+

+Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)

+
    +
  • 3.0 V to 3.6 V Supply Voltage
    • +
  • Notable Peripherals:
      +
    • I2C
      • +
    • SPI
      • +
    • UART
      • +
    +
    • +
+

+GPS Receiver: Maxim Integrated ‎MAX2771ETI+T

+
    +
  • 2.7 V to 3.3 V Supply Voltage
    • +
  • Notable Peripherals:
      +
    • SPI
      • +
    +
    • +
+

+CANbus Controller: Microchip Technology MCP2515T-I/SO

+
    +
  • 2.7 V to 5.5 V Supply Voltage
    • +
  • Notable Peripherals:
      +
    • SPI
        +
      • 10 MHz
        • +
      +
      • +
    +
    • +
+

+CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN

+
    +
  • 4.5 V to 5.5 V Supply Voltage
    • +
  • Used directly with CANbus Controller
    • +
+

+SD Card (Generic)

+
    +
  • 2.7 V to 3.6 V Supply Voltage
    • +
  • Notable Peripherals:
      +
    • SPI
      • +
    +
    • +
+

+USB to UART Bridge: FTDI ‎‎FT260Q-T

+
    +
  • We will use a "Bus-Powered Configuration", requiring the host device to supply power, that way we don't have to.
    • +
+

+RS-232 Transceiver: Texas Instruments GD75232PWR

+

+Inertial Measurement Unit: TDK InvenSense ICM-20600

+
    +
  • 1.71 V to 3.45 V Supply Voltage
    • +
  • Notable Peripherals:
      +
    • I2C
        +
      • 400 kHz
        • +
      +
      • +
    • SPI
        +
      • 10 MHz
        • +
      +
      • +
    +
    • +
+
+
+
+ + + + diff --git a/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html b/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html index c8fde05..1206dfc 100644 --- a/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html +++ b/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Software Directory Reference +2020-2021 Sunseeker Telemetry and Lighting System: Software Directory Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -97,7 +97,7 @@ Directories diff --git a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html index 72401e9..f60e0e2 100644 --- a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html +++ b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Hardware Directory Reference +2020-2021 Sunseeker Telemetry and Lighting System: Hardware Directory Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('dir_6cc751a9e685a986d41d35de353de328.h diff --git a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js new file mode 100644 index 0000000..9112569 --- /dev/null +++ b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js @@ -0,0 +1,14 @@ +var dir_6cc751a9e685a986d41d35de353de328 = +[ + [ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "device_specifications.html#autotoc_md1", null ], + [ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "device_specifications.html#autotoc_md2", null ], + [ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "device_specifications.html#autotoc_md3", null ], + [ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "device_specifications.html#autotoc_md4", null ], + [ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "device_specifications.html#autotoc_md5", null ], + [ "CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "device_specifications.html#autotoc_md6", null ], + [ "SD Card (Generic)", "device_specifications.html#autotoc_md7", null ], + [ "USB to UART Bridge: FTDI ‎‎FT260Q-T", "device_specifications.html#autotoc_md8", null ], + [ "RS-232 Transceiver: Texas Instruments GD75232PWR", "device_specifications.html#autotoc_md9", null ], + [ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "device_specifications.html#autotoc_md10", null ], + [ "Microcontroller", "layout_planning.html#autotoc_md11", null ] +]; \ No newline at end of file diff --git a/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html b/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html index 676f29a..abd62ba 100644 --- a/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html +++ b/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace Directory Reference +2020-2021 Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace Directory Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -97,7 +97,7 @@ Directories diff --git a/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html b/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html new file mode 100644 index 0000000..26474ef --- /dev/null +++ b/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Meta Directory Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Meta Directory Reference
+
+
+
+
+ + + + diff --git a/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html b/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html index ca1adc6..9fb02f6 100644 --- a/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html +++ b/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem Directory Reference +2020-2021 Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem Directory Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -97,7 +97,7 @@ Files diff --git a/Documentation/html/documentation_guide.html b/Documentation/html/documentation_guide.html new file mode 100644 index 0000000..fdf04a0 --- /dev/null +++ b/Documentation/html/documentation_guide.html @@ -0,0 +1,120 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Documentation Guide + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Documentation Guide
+
+
+

+Doxygen

+

The program called "doxygen" (GitHub Page and Website) is what we're using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we've done.

+

It simply uses a small configuration file at the root of the project /Doxyfile to store some settings, and the rest is through mainly Markdown files (.md or .markdown) and source code files.

+

It is setup (as of writing this) that someone can simply open the /Doxyfile in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it.

+

+Updating Documentation

+

You need to have installed the program from either the GitHub page or website, then simply open the /Doxyfile within the GUI frontend or "Wizard".

+

+Important Notes

+
    +
  • Make sure that the /Doxyfile stays where it's at! It should be kept at the root directory (just to keep things simple)
    • +
  • Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the /Doxyfile, they'll have to re-do all of them in order for it to start functioning again.
    • +
+

+For Consistency

+
    +
  • Please make sure the internal names of files are using "camelCase"
      +
    • Example: for "@page documentationGuide Documentation Guide" "documentationGuide" is the name used internally by doxygen. "Documentation Guide" is what shows up on the output documentation.
      • +
    +
    • +
+
+
+
+ + + + diff --git a/Documentation/html/documentation_guide1.html b/Documentation/html/documentation_guide1.html new file mode 100644 index 0000000..1af1b83 --- /dev/null +++ b/Documentation/html/documentation_guide1.html @@ -0,0 +1,100 @@ + + + + + + + +Sunseeker Telemetry and Lighting System: Documentation Guide2 + + + + + + + + + + + + + +
+
+ + + + + + +
+
Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Documentation Guide2
+
+
+

+Test

+
+
+
+ + + + diff --git a/Documentation/html/files.html b/Documentation/html/files.html index a552e25..d91516c 100644 --- a/Documentation/html/files.html +++ b/Documentation/html/files.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: File List +2020-2021 Sunseeker Telemetry and Lighting System: File List @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -88,10 +88,11 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
Here is a list of all files with brief descriptions:
[detail level 1234]
- - - - + + + + +
 Hardware
 ▼ Software
 ▼ Code Composer Studio Workspace
 ▼ SunseekerTelemetryAndLightingSystem
 main.c
 Meta
 ▼ Software
 ▼ Code Composer Studio Workspace
 ▼ SunseekerTelemetryAndLightingSystem
 main.c
@@ -99,7 +100,7 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); }); diff --git a/Documentation/html/files_dup.js b/Documentation/html/files_dup.js index 097703e..5b0d271 100644 --- a/Documentation/html/files_dup.js +++ b/Documentation/html/files_dup.js @@ -1,5 +1,6 @@ var files_dup = [ - [ "Hardware", "dir_6cc751a9e685a986d41d35de353de328.html", null ], + [ "Hardware", "dir_6cc751a9e685a986d41d35de353de328.html", "dir_6cc751a9e685a986d41d35de353de328" ], + [ "Meta", "dir_7795a02a4813dcd036f04e5f7854f185.html", null ], [ "Software", "dir_4e9c05acfa2c3671b8618fcb95d57d96.html", "dir_4e9c05acfa2c3671b8618fcb95d57d96" ] ]; \ No newline at end of file diff --git a/Documentation/html/globals.html b/Documentation/html/globals.html index b049baf..4021bd4 100644 --- a/Documentation/html/globals.html +++ b/Documentation/html/globals.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Globals +2020-2021 Sunseeker Telemetry and Lighting System: Globals @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('globals.html',''); initResizable(); }) diff --git a/Documentation/html/globals_func.html b/Documentation/html/globals_func.html index 82142b3..bb77d7d 100644 --- a/Documentation/html/globals_func.html +++ b/Documentation/html/globals_func.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Globals +2020-2021 Sunseeker Telemetry and Lighting System: Globals @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable( diff --git a/Documentation/html/hardware.html b/Documentation/html/hardware.html new file mode 100644 index 0000000..fe29278 --- /dev/null +++ b/Documentation/html/hardware.html @@ -0,0 +1,105 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Hardware + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Hardware
+
+
+

Subpages

+ +
+
+
+
+ + + + diff --git a/Documentation/html/hardware.js b/Documentation/html/hardware.js new file mode 100644 index 0000000..34784ab --- /dev/null +++ b/Documentation/html/hardware.js @@ -0,0 +1,5 @@ +var hardware = +[ + [ "Device Specifications", "device_specifications.html", null ], + [ "Layout Planning", "layout_planning.html", null ] +]; \ No newline at end of file diff --git a/Documentation/html/index.html b/Documentation/html/index.html index 94ee8b3..5bb2783 100644 --- a/Documentation/html/index.html +++ b/Documentation/html/index.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: ECE4810-Fall2020-SunseekerTelemetry +2020-2021 Sunseeker Telemetry and Lighting System: Main Page @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -82,13 +82,22 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
-
ECE4810-Fall2020-SunseekerTelemetry
+
2020-2021 Sunseeker Telemetry and Lighting System Documentation
-

+

Subpages

+ +
+

+About

+

What this project is about (TODO)

Documentation

For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.

+

More information here: Documentation Guide

Tips from Dr. Bazuin

    @@ -111,7 +120,8 @@ Tips from Dr. Bazuin Tips from Dr. Gomez
    • Our requirements/specifications should be made to be more measurable
      • -
    • Need to design to safety standards, which need to be researched online
      • +
    • Need to design to safety standards, which need to be researched online
      • +
    • He said that he is available himself for anything power-related to help out with if needed
@@ -119,7 +129,7 @@ Tips from Dr. Gomez diff --git a/Documentation/html/layout_planning.html b/Documentation/html/layout_planning.html new file mode 100644 index 0000000..0330889 --- /dev/null +++ b/Documentation/html/layout_planning.html @@ -0,0 +1,101 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Layout Planning + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Layout Planning
+
+
+

+Microcontroller

+
+
+
+ + + + diff --git a/Documentation/html/main_8c.html b/Documentation/html/main_8c.html index f7815ee..9c0cf28 100644 --- a/Documentation/html/main_8c.html +++ b/Documentation/html/main_8c.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem/main.c File Reference +2020-2021 Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem/main.c File Reference @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -124,7 +124,7 @@ Functions diff --git a/Documentation/html/main_8c_source.html b/Documentation/html/main_8c_source.html index b48c1a4..ffccdf4 100644 --- a/Documentation/html/main_8c_source.html +++ b/Documentation/html/main_8c_source.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem/main.c Source File +2020-2021 Sunseeker Telemetry and Lighting System: Software/Code Composer Studio Workspace/SunseekerTelemetryAndLightingSystem/main.c Source File @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -101,7 +101,7 @@ $(document).ready(function(){initNavTree('main_8c_source.html',''); initResizabl diff --git a/Documentation/html/md__hardware__device__specifications.html b/Documentation/html/md__hardware__device__specifications.html index acda7b0..bdf34f1 100644 --- a/Documentation/html/md__hardware__device__specifications.html +++ b/Documentation/html/md__hardware__device__specifications.html @@ -85,8 +85,11 @@ $(document).ready(function(){initNavTree('md__hardware__device__specifications.h
Device Specifications
-

-Microcontroller: Texas Instruments MSP430F5438AIPZR

+

deviceSpecifications Device SpecificationsTest1

+

+Device SpecificationsTest2

+

+Microcontroller: Texas Instruments MSP430F5438AIPZR

  • 1.8 V to 3.6 V Supply Voltage
  • Capabilities:
      @@ -110,8 +113,8 @@ Microcontroller: Texas Instruments MSP430F5438AIPZR
-

-Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN

+

+Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN

  • 1.8 V to 5.5 V Supply Voltage
  • Notable Peripherals:
      @@ -122,8 +125,8 @@ Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN
-

-Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)

+

+Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)

  • 3.0 V to 3.6 V Supply Voltage
  • Notable Peripherals:
      @@ -133,8 +136,8 @@ Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)
-

-GPS Receiver: Maxim Integrated ‎MAX2771ETI+T

+

+GPS Receiver: Maxim Integrated ‎MAX2771ETI+T

  • 2.7 V to 3.3 V Supply Voltage
  • Notable Peripherals:
      @@ -142,8 +145,8 @@ GPS Receiver: Maxim Integrated ‎MAX2771ETI+T
-

-CANbus Controller: Microchip Technology MCP2515T-I/SO

+

+CANbus Controller: Microchip Technology MCP2515T-I/SO

  • 2.7 V to 5.5 V Supply Voltage
  • Notable Peripherals:
      @@ -154,14 +157,14 @@ CANbus Controller: Microchip Technology MCP2515T-I/SO
-

-CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN

+

+CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN

  • 4.5 V to 5.5 V Supply Voltage
  • Used directly with CANbus Controller
-

-SD Card (Generic)

+

+SD Card (Generic)

  • 2.7 V to 3.6 V Supply Voltage
  • Notable Peripherals:
      @@ -169,15 +172,15 @@ SD Card (Generic)
-

-USB to UART Bridge: FTDI ‎‎FT260Q-T

+

+USB to UART Bridge: FTDI ‎‎FT260Q-T

  • We will use a "Bus-Powered Configuration", requiring the host device to supply power, that way we don't have to.
-

-RS-232 Transceiver: Texas Instruments GD75232PWR

-

-Inertial Measurement Unit: TDK InvenSense ICM-20600

+

+RS-232 Transceiver: Texas Instruments GD75232PWR

+

+Inertial Measurement Unit: TDK InvenSense ICM-20600

  • 1.71 V to 3.45 V Supply Voltage
  • Notable Peripherals:
      diff --git a/Documentation/html/md__hardware__device__specifications_test3.html b/Documentation/html/md__hardware__device__specifications_test3.html new file mode 100644 index 0000000..f27320e --- /dev/null +++ b/Documentation/html/md__hardware__device__specifications_test3.html @@ -0,0 +1,208 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Device SpecificationsTest3 + + + + + + + + + + + + + +
      +
      + + + + + + +
      +
      2020-2021 Sunseeker Telemetry and Lighting System +
      +
      +
      + + + + + + + +
      +
      + +
      +
      +
      + +
      + +
      +
      + + +
      + +
      + +
      +
      +
      Device SpecificationsTest3
      +
      +
      +

      deviceSpecifications Device SpecificationsTest1

      +

      +Device SpecificationsTest2

      +

      +Microcontroller: Texas Instruments MSP430F5438AIPZR

      +
        +
      • 1.8 V to 3.6 V Supply Voltage
        • +
      • Capabilities:
          +
        • 16-bit architecture
          • +
        • 25 MHz System Clock
          • +
        +
        • +
      • Notable Peripherals:
          +
        • Up to 4 of:
            +
          • UART/SPI
            • +
          +
          • +
        • Up to 4 of:
            +
          • I2C/SPI
            • +
          +
          • +
        • 12-bit ADC
            +
          • 14 external channels
            • +
          +
          • +
        +
        • +
      +

      +Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN

      +
        +
      • 1.8 V to 5.5 V Supply Voltage
        • +
      • Notable Peripherals:
          +
        • I2C
            +
          • Clock rate up to 400 kHz
            • +
          +
          • +
        +
        • +
      +

      +Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)

      +
        +
      • 3.0 V to 3.6 V Supply Voltage
        • +
      • Notable Peripherals:
          +
        • I2C
          • +
        • SPI
          • +
        • UART
          • +
        +
        • +
      +

      +GPS Receiver: Maxim Integrated ‎MAX2771ETI+T

      +
        +
      • 2.7 V to 3.3 V Supply Voltage
        • +
      • Notable Peripherals:
          +
        • SPI
          • +
        +
        • +
      +

      +CANbus Controller: Microchip Technology MCP2515T-I/SO

      +
        +
      • 2.7 V to 5.5 V Supply Voltage
        • +
      • Notable Peripherals:
          +
        • SPI
            +
          • 10 MHz
            • +
          +
          • +
        +
        • +
      +

      +CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN

      +
        +
      • 4.5 V to 5.5 V Supply Voltage
        • +
      • Used directly with CANbus Controller
        • +
      +

      +SD Card (Generic)

      +
        +
      • 2.7 V to 3.6 V Supply Voltage
        • +
      • Notable Peripherals:
          +
        • SPI
          • +
        +
        • +
      +

      +USB to UART Bridge: FTDI ‎‎FT260Q-T

      +
        +
      • We will use a "Bus-Powered Configuration", requiring the host device to supply power, that way we don't have to.
        • +
      +

      +RS-232 Transceiver: Texas Instruments GD75232PWR

      +

      +Inertial Measurement Unit: TDK InvenSense ICM-20600

      +
        +
      • 1.71 V to 3.45 V Supply Voltage
        • +
      • Notable Peripherals:
          +
        • I2C
            +
          • 400 kHz
            • +
          +
          • +
        • SPI
            +
          • 10 MHz
            • +
          +
          • +
        +
        • +
      +
      +
      +
      + + + + diff --git a/Documentation/html/md__hardware__layout__planning.html b/Documentation/html/md__hardware__layout__planning.html index b71ab25..bcdc1c9 100644 --- a/Documentation/html/md__hardware__layout__planning.html +++ b/Documentation/html/md__hardware__layout__planning.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Layout Planning +2020-2021 Sunseeker Telemetry and Lighting System: Layout Planning @@ -25,7 +25,7 @@ -
      Sunseeker Telemetry and Lighting System +
      2020-2021 Sunseeker Telemetry and Lighting System
      @@ -85,7 +85,7 @@ $(document).ready(function(){initNavTree('md__hardware__layout__planning.html','
      Layout Planning
-

+

Microcontroller

diff --git a/Documentation/html/navtreedata.js b/Documentation/html/navtreedata.js index d15819a..b314121 100644 --- a/Documentation/html/navtreedata.js +++ b/Documentation/html/navtreedata.js @@ -24,28 +24,21 @@ */ var NAVTREE = [ - [ "Sunseeker Telemetry and Lighting System", "index.html", [ - [ "ECE4810-Fall2020-SunseekerTelemetry", "index.html", [ - [ "Documentation", "index.html#autotoc_md14", [ - [ "Tips from Dr. Bazuin", "index.html#autotoc_md15", null ], - [ "Tips from Dr. Gomez", "index.html#autotoc_md16", null ] + [ "2020-2021 Sunseeker Telemetry and Lighting System", "index.html", [ + [ "About", "index.html#autotoc_md13", null ], + [ "Documentation", "index.html#autotoc_md14", [ + [ "Tips from Dr. Bazuin", "index.html#autotoc_md15", null ], + [ "Tips from Dr. Gomez", "index.html#autotoc_md16", null ] + ] ], + [ "Hardware", "hardware.html", "hardware" ], + [ "Software", "software.html", null ], + [ "Documentation Guide", "documentation_guide.html", [ + [ "Doxygen", "documentation_guide.html#autotoc_md17", null ], + [ "Updating Documentation", "documentation_guide.html#autotoc_md18", null ], + [ "Important Notes", "documentation_guide.html#autotoc_md19", [ + [ "For Consistency", "documentation_guide.html#autotoc_md20", null ] ] ] ] ], - [ "Device Specifications", "md__hardware__device__specifications.html", [ - [ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "md__hardware__device__specifications.html#autotoc_md1", null ], - [ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "md__hardware__device__specifications.html#autotoc_md2", null ], - [ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "md__hardware__device__specifications.html#autotoc_md3", null ], - [ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "md__hardware__device__specifications.html#autotoc_md4", null ], - [ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "md__hardware__device__specifications.html#autotoc_md5", null ], - [ "CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "md__hardware__device__specifications.html#autotoc_md6", null ], - [ "SD Card (Generic)", "md__hardware__device__specifications.html#autotoc_md7", null ], - [ "USB to UART Bridge: FTDI ‎‎FT260Q-T", "md__hardware__device__specifications.html#autotoc_md8", null ], - [ "RS-232 Transceiver: Texas Instruments GD75232PWR", "md__hardware__device__specifications.html#autotoc_md9", null ], - [ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "md__hardware__device__specifications.html#autotoc_md10", null ] - ] ], - [ "Layout Planning", "md__hardware__layout__planning.html", [ - [ "Microcontroller", "md__hardware__layout__planning.html#autotoc_md12", null ] - ] ], [ "Files", "files.html", [ [ "File List", "files.html", "files_dup" ], [ "Globals", "globals.html", [ @@ -58,7 +51,7 @@ var NAVTREE = var NAVTREEINDEX = [ -"dir_4e9c05acfa2c3671b8618fcb95d57d96.html" +"device_specifications.html" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/Documentation/html/navtreeindex0.js b/Documentation/html/navtreeindex0.js index fea1c6a..277883d 100644 --- a/Documentation/html/navtreeindex0.js +++ b/Documentation/html/navtreeindex0.js @@ -1,32 +1,40 @@ var NAVTREEINDEX0 = { -"dir_4e9c05acfa2c3671b8618fcb95d57d96.html":[3,0,1], -"dir_6cc751a9e685a986d41d35de353de328.html":[3,0,0], -"dir_70428d3c5958c16802133545478a5cfb.html":[3,0,1,0], -"dir_ef94255a62432ae865475b379d8bd501.html":[3,0,1,0,0], -"files.html":[3,0], -"globals.html":[3,1,0], -"globals_func.html":[3,1,1], +"device_specifications.html":[2,0], +"device_specifications.html#autotoc_md1":[0], +"device_specifications.html#autotoc_md10":[9], +"device_specifications.html#autotoc_md2":[1], +"device_specifications.html#autotoc_md3":[2], +"device_specifications.html#autotoc_md4":[3], +"device_specifications.html#autotoc_md5":[4], +"device_specifications.html#autotoc_md6":[5], +"device_specifications.html#autotoc_md7":[6], +"device_specifications.html#autotoc_md8":[7], +"device_specifications.html#autotoc_md9":[8], +"dir_4e9c05acfa2c3671b8618fcb95d57d96.html":[5,0,2], +"dir_6cc751a9e685a986d41d35de353de328.html":[5,0,0], +"dir_70428d3c5958c16802133545478a5cfb.html":[5,0,2,0], +"dir_7795a02a4813dcd036f04e5f7854f185.html":[5,0,1], +"dir_ef94255a62432ae865475b379d8bd501.html":[5,0,2,0,0], +"documentation_guide.html":[4], +"documentation_guide.html#autotoc_md17":[4,0], +"documentation_guide.html#autotoc_md18":[4,1], +"documentation_guide.html#autotoc_md19":[4,2], +"documentation_guide.html#autotoc_md20":[4,2,0], +"files.html":[5,0], +"globals.html":[5,1,0], +"globals_func.html":[5,1,1], +"hardware.html":[2], "index.html":[], -"index.html":[0], -"index.html#autotoc_md14":[0,0], -"index.html#autotoc_md15":[0,0,0], -"index.html#autotoc_md16":[0,0,1], -"main_8c.html":[3,0,1,0,0,0], -"main_8c.html#a840291bc02cba5474a4cb46a9b9566fe":[3,0,1,0,0,0,0], -"main_8c_source.html":[3,0,1,0,0,0], -"md__hardware__device__specifications.html":[1], -"md__hardware__device__specifications.html#autotoc_md1":[1,0], -"md__hardware__device__specifications.html#autotoc_md10":[1,9], -"md__hardware__device__specifications.html#autotoc_md2":[1,1], -"md__hardware__device__specifications.html#autotoc_md3":[1,2], -"md__hardware__device__specifications.html#autotoc_md4":[1,3], -"md__hardware__device__specifications.html#autotoc_md5":[1,4], -"md__hardware__device__specifications.html#autotoc_md6":[1,5], -"md__hardware__device__specifications.html#autotoc_md7":[1,6], -"md__hardware__device__specifications.html#autotoc_md8":[1,7], -"md__hardware__device__specifications.html#autotoc_md9":[1,8], -"md__hardware__layout__planning.html":[2], -"md__hardware__layout__planning.html#autotoc_md12":[2,0], -"pages.html":[] +"index.html#autotoc_md13":[0], +"index.html#autotoc_md14":[1], +"index.html#autotoc_md15":[1,0], +"index.html#autotoc_md16":[1,1], +"layout_planning.html":[2,1], +"layout_planning.html#autotoc_md11":[10], +"main_8c.html":[5,0,2,0,0,0], +"main_8c.html#a840291bc02cba5474a4cb46a9b9566fe":[5,0,2,0,0,0,0], +"main_8c_source.html":[5,0,2,0,0,0], +"pages.html":[], +"software.html":[3] }; diff --git a/Documentation/html/pages.html b/Documentation/html/pages.html index c7c1738..807337d 100644 --- a/Documentation/html/pages.html +++ b/Documentation/html/pages.html @@ -5,7 +5,7 @@ -Sunseeker Telemetry and Lighting System: Related Pages +2020-2021 Sunseeker Telemetry and Lighting System: Related Pages @@ -25,7 +25,7 @@ -
Sunseeker Telemetry and Lighting System +
2020-2021 Sunseeker Telemetry and Lighting System
@@ -87,8 +87,7 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); });
Here is a list of all related documentation pages:
- - +
 Device Specifications
 Layout Planning
 Documentation Guide
@@ -96,7 +95,7 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); }); diff --git a/Documentation/html/search/all_0.js b/Documentation/html/search/all_0.js index 0c8bb64..1aa5745 100644 --- a/Documentation/html/search/all_0.js +++ b/Documentation/html/search/all_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['device_20specifications_0',['Device Specifications',['../md__hardware__device__specifications.html',1,'']]], - ['device_20specifications_2emarkdown_1',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]] + ['_21hardware_2emarkdown_0',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]], + ['_21software_2emarkdown_1',['!Software.markdown',['../_9_software_8markdown.html',1,'']]] ]; diff --git a/Documentation/html/search/all_1.js b/Documentation/html/search/all_1.js index 33ac2fc..1c0973f 100644 --- a/Documentation/html/search/all_1.js +++ b/Documentation/html/search/all_1.js @@ -1,4 +1,7 @@ var searchData= [ - ['ece4810_2dfall2020_2dsunseekertelemetry_2',['ECE4810-Fall2020-SunseekerTelemetry',['../index.html',1,'']]] + ['device_20specifications_2',['Device Specifications',['../device_specifications.html',1,'hardware']]], + ['device_20specifications_2emarkdown_3',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]], + ['documentation_20guide_4',['Documentation Guide',['../documentation_guide.html',1,'']]], + ['documentation_20guide_2emarkdown_5',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]] ]; diff --git a/Documentation/html/search/all_2.js b/Documentation/html/search/all_2.js index 9fd5e36..2564047 100644 --- a/Documentation/html/search/all_2.js +++ b/Documentation/html/search/all_2.js @@ -1,5 +1,4 @@ var searchData= [ - ['layout_20planning_3',['Layout Planning',['../md__hardware__layout__planning.html',1,'']]], - ['layout_20planning_2emarkdown_4',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]] + ['hardware_6',['Hardware',['../hardware.html',1,'index']]] ]; diff --git a/Documentation/html/search/all_3.js b/Documentation/html/search/all_3.js index 92db157..92a7afc 100644 --- a/Documentation/html/search/all_3.js +++ b/Documentation/html/search/all_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['main_5',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]], - ['main_2ec_6',['main.c',['../main_8c.html',1,'']]] + ['layout_20planning_7',['Layout Planning',['../layout_planning.html',1,'hardware']]], + ['layout_20planning_2emarkdown_8',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]] ]; diff --git a/Documentation/html/search/all_4.js b/Documentation/html/search/all_4.js index d8f9dcc..b9d9c92 100644 --- a/Documentation/html/search/all_4.js +++ b/Documentation/html/search/all_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['readme_2emarkdown_7',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]] + ['main_9',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]], + ['main_2ec_10',['main.c',['../main_8c.html',1,'']]] ]; diff --git a/Documentation/html/search/all_5.html b/Documentation/html/search/all_5.html new file mode 100644 index 0000000..9dd9344 --- /dev/null +++ b/Documentation/html/search/all_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/Documentation/html/search/all_5.js b/Documentation/html/search/all_5.js new file mode 100644 index 0000000..0229da8 --- /dev/null +++ b/Documentation/html/search/all_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['readme_2emarkdown_11',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]] +]; diff --git a/Documentation/html/search/all_6.html b/Documentation/html/search/all_6.html new file mode 100644 index 0000000..f1e516d --- /dev/null +++ b/Documentation/html/search/all_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/Documentation/html/search/all_6.js b/Documentation/html/search/all_6.js new file mode 100644 index 0000000..f27e33a --- /dev/null +++ b/Documentation/html/search/all_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['software_12',['Software',['../software.html',1,'index']]] +]; diff --git a/Documentation/html/search/files_0.js b/Documentation/html/search/files_0.js index 5f85a32..bff961c 100644 --- a/Documentation/html/search/files_0.js +++ b/Documentation/html/search/files_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['device_20specifications_2emarkdown_8',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]] + ['_21hardware_2emarkdown_13',['!Hardware.markdown',['../_9_hardware_8markdown.html',1,'']]], + ['_21software_2emarkdown_14',['!Software.markdown',['../_9_software_8markdown.html',1,'']]] ]; diff --git a/Documentation/html/search/files_1.js b/Documentation/html/search/files_1.js index 4c944bf..48dad03 100644 --- a/Documentation/html/search/files_1.js +++ b/Documentation/html/search/files_1.js @@ -1,4 +1,5 @@ var searchData= [ - ['layout_20planning_2emarkdown_9',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]] + ['device_20specifications_2emarkdown_15',['Device Specifications.markdown',['../_device_01_specifications_8markdown.html',1,'']]], + ['documentation_20guide_2emarkdown_16',['Documentation Guide.markdown',['../_documentation_01_guide_8markdown.html',1,'']]] ]; diff --git a/Documentation/html/search/files_2.js b/Documentation/html/search/files_2.js index cc31c48..3162697 100644 --- a/Documentation/html/search/files_2.js +++ b/Documentation/html/search/files_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['main_2ec_10',['main.c',['../main_8c.html',1,'']]] + ['layout_20planning_2emarkdown_17',['Layout Planning.markdown',['../_layout_01_planning_8markdown.html',1,'']]] ]; diff --git a/Documentation/html/search/files_3.js b/Documentation/html/search/files_3.js index 0229da8..0c253be 100644 --- a/Documentation/html/search/files_3.js +++ b/Documentation/html/search/files_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['readme_2emarkdown_11',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]] + ['main_2ec_18',['main.c',['../main_8c.html',1,'']]] ]; diff --git a/Documentation/html/search/files_4.html b/Documentation/html/search/files_4.html new file mode 100644 index 0000000..753b7b1 --- /dev/null +++ b/Documentation/html/search/files_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/Documentation/html/search/files_4.js b/Documentation/html/search/files_4.js new file mode 100644 index 0000000..d15775a --- /dev/null +++ b/Documentation/html/search/files_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['readme_2emarkdown_19',['README.markdown',['../_r_e_a_d_m_e_8markdown.html',1,'']]] +]; diff --git a/Documentation/html/search/functions_0.js b/Documentation/html/search/functions_0.js index 5dc14ed..59b3bad 100644 --- a/Documentation/html/search/functions_0.js +++ b/Documentation/html/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['main_12',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]] + ['main_20',['main',['../main_8c.html#a840291bc02cba5474a4cb46a9b9566fe',1,'main.c']]] ]; diff --git a/Documentation/html/search/pages_0.js b/Documentation/html/search/pages_0.js index 3654bb1..1687e01 100644 --- a/Documentation/html/search/pages_0.js +++ b/Documentation/html/search/pages_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['device_20specifications_13',['Device Specifications',['../md__hardware__device__specifications.html',1,'']]] + ['device_20specifications_21',['Device Specifications',['../device_specifications.html',1,'hardware']]], + ['documentation_20guide_22',['Documentation Guide',['../documentation_guide.html',1,'']]] ]; diff --git a/Documentation/html/search/pages_1.js b/Documentation/html/search/pages_1.js index 291f662..01203fc 100644 --- a/Documentation/html/search/pages_1.js +++ b/Documentation/html/search/pages_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['ece4810_2dfall2020_2dsunseekertelemetry_14',['ECE4810-Fall2020-SunseekerTelemetry',['../index.html',1,'']]] + ['hardware_23',['Hardware',['../hardware.html',1,'index']]] ]; diff --git a/Documentation/html/search/pages_2.js b/Documentation/html/search/pages_2.js index 17698d0..5773bb7 100644 --- a/Documentation/html/search/pages_2.js +++ b/Documentation/html/search/pages_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['layout_20planning_15',['Layout Planning',['../md__hardware__layout__planning.html',1,'']]] + ['layout_20planning_24',['Layout Planning',['../layout_planning.html',1,'hardware']]] ]; diff --git a/Documentation/html/search/pages_3.html b/Documentation/html/search/pages_3.html new file mode 100644 index 0000000..c0b45b0 --- /dev/null +++ b/Documentation/html/search/pages_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/Documentation/html/search/pages_3.js b/Documentation/html/search/pages_3.js new file mode 100644 index 0000000..778dfad --- /dev/null +++ b/Documentation/html/search/pages_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['software_25',['Software',['../software.html',1,'index']]] +]; diff --git a/Documentation/html/search/searchdata.js b/Documentation/html/search/searchdata.js index 113f17d..1d4442a 100644 --- a/Documentation/html/search/searchdata.js +++ b/Documentation/html/search/searchdata.js @@ -1,9 +1,9 @@ var indexSectionsWithContent = { - 0: "delmr", - 1: "dlmr", + 0: "!dhlmrs", + 1: "!dlmr", 2: "m", - 3: "del" + 3: "dhls" }; var indexSectionNames = diff --git a/Documentation/html/software.html b/Documentation/html/software.html new file mode 100644 index 0000000..a308202 --- /dev/null +++ b/Documentation/html/software.html @@ -0,0 +1,99 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: Software + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Software
+
+
+
+
+
+ + + + diff --git a/Documentation/latex/_9_hardware_8markdown.tex b/Documentation/latex/_9_hardware_8markdown.tex new file mode 100644 index 0000000..aebb2c9 --- /dev/null +++ b/Documentation/latex/_9_hardware_8markdown.tex @@ -0,0 +1,2 @@ +\hypertarget{_9_hardware_8markdown}{}\doxysection{Hardware/!\+Hardware.markdown File Reference} +\label{_9_hardware_8markdown}\index{Hardware/"!Hardware.markdown@{Hardware/"!Hardware.markdown}} diff --git a/Documentation/latex/_9_software_8markdown.tex b/Documentation/latex/_9_software_8markdown.tex new file mode 100644 index 0000000..74da3d8 --- /dev/null +++ b/Documentation/latex/_9_software_8markdown.tex @@ -0,0 +1,2 @@ +\hypertarget{_9_software_8markdown}{}\doxysection{Software/!\+Software.markdown File Reference} +\label{_9_software_8markdown}\index{Software/"!Software.markdown@{Software/"!Software.markdown}} diff --git a/Documentation/latex/_device_01_specifications_test3_8markdown.tex b/Documentation/latex/_device_01_specifications_test3_8markdown.tex new file mode 100644 index 0000000..6e5fcad --- /dev/null +++ b/Documentation/latex/_device_01_specifications_test3_8markdown.tex @@ -0,0 +1,2 @@ +\hypertarget{_device_01_specifications_test3_8markdown}{}\doxysection{Hardware/\+Device Specifications\+Test3.\+markdown File Reference} +\label{_device_01_specifications_test3_8markdown}\index{Hardware/Device SpecificationsTest3.markdown@{Hardware/Device SpecificationsTest3.markdown}} diff --git a/Documentation/latex/_documentation_01_guide_8markdown.tex b/Documentation/latex/_documentation_01_guide_8markdown.tex new file mode 100644 index 0000000..a6c801c --- /dev/null +++ b/Documentation/latex/_documentation_01_guide_8markdown.tex @@ -0,0 +1,2 @@ +\hypertarget{_documentation_01_guide_8markdown}{}\doxysection{Meta/\+Documentation Guide.\+markdown File Reference} +\label{_documentation_01_guide_8markdown}\index{Meta/Documentation Guide.markdown@{Meta/Documentation Guide.markdown}} diff --git a/Documentation/latex/dir_7795a02a4813dcd036f04e5f7854f185.tex b/Documentation/latex/dir_7795a02a4813dcd036f04e5f7854f185.tex new file mode 100644 index 0000000..294034d --- /dev/null +++ b/Documentation/latex/dir_7795a02a4813dcd036f04e5f7854f185.tex @@ -0,0 +1,2 @@ +\hypertarget{dir_7795a02a4813dcd036f04e5f7854f185}{}\doxysection{Meta Directory Reference} +\label{dir_7795a02a4813dcd036f04e5f7854f185}\index{Meta Directory Reference@{Meta Directory Reference}} diff --git a/Documentation/latex/documentation_guide.tex b/Documentation/latex/documentation_guide.tex new file mode 100644 index 0000000..21a649f --- /dev/null +++ b/Documentation/latex/documentation_guide.tex @@ -0,0 +1,19 @@ +\hypertarget{documentation_guide_autotoc_md17}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md17} +The program called \char`\"{}doxygen\char`\"{} (\href{https://github.com/doxygen/doxygen}{\texttt{ Git\+Hub Page}} and \href{https://www.doxygen.nl/}{\texttt{ Website}}) is what we\textquotesingle{}re using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we\textquotesingle{}ve done. + +It simply uses a small configuration file at the root of the project {\ttfamily /\+Doxyfile} to store some settings, and the rest is through mainly Markdown files ({\ttfamily .md} or {\ttfamily .markdown}) and source code files. + +It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md18}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md18} +You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md19}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md19} + +\begin{DoxyItemize} +\item Make sure that the {\ttfamily /\+Doxyfile} stays where it\textquotesingle{}s at! It should be kept at the root directory (just to keep things simple) +\item Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the {\ttfamily /\+Doxyfile}, they\textquotesingle{}ll have to re-\/do all of them in order for it to start functioning again. +\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md20}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md20} + +\begin{DoxyItemize} +\item Please make sure the internal names of files are using \char`\"{}camel\+Case\char`\"{} +\begin{DoxyItemize} +\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation. +\end{DoxyItemize} +\end{DoxyItemize} \ No newline at end of file diff --git a/Documentation/latex/documentation_guide1.tex b/Documentation/latex/documentation_guide1.tex new file mode 100644 index 0000000..30a9f5e --- /dev/null +++ b/Documentation/latex/documentation_guide1.tex @@ -0,0 +1 @@ +\hypertarget{documentation_guide1_autotoc_md17}{}\doxysection{Test}\label{documentation_guide1_autotoc_md17} diff --git a/Documentation/latex/hardware.tex b/Documentation/latex/hardware.tex new file mode 100644 index 0000000..5bc1785 --- /dev/null +++ b/Documentation/latex/hardware.tex @@ -0,0 +1,109 @@ +{\bfseries{Subpages}} + + +\begin{DoxyItemize} +\item \mbox{\hyperlink{deviceSpecifications}{Device Specifications}} +\item \mbox{\hyperlink{layoutPlanning}{Layout Planning}} +\end{DoxyItemize} + +\DoxyHorRuler{0} + \hypertarget{deviceSpecifications}{}\doxysection{Device Specifications}\label{deviceSpecifications} +\hypertarget{device_specifications_autotoc_md1}{}\doxysubsubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{device_specifications_autotoc_md1} + +\begin{DoxyItemize} +\item 1.\+8 V to 3.\+6 V Supply Voltage +\item Capabilities\+: +\begin{DoxyItemize} +\item 16-\/bit architecture +\item 25 MHz System Clock +\end{DoxyItemize} +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item Up to 4 of\+: +\begin{DoxyItemize} +\item UART/\+SPI +\end{DoxyItemize} +\item Up to 4 of\+: +\begin{DoxyItemize} +\item I2\+C/\+SPI +\end{DoxyItemize} +\item 12-\/bit ADC +\begin{DoxyItemize} +\item 14 external channels +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md2}{}\doxysubsubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{device_specifications_autotoc_md2} + +\begin{DoxyItemize} +\item 1.\+8 V to 5.\+5 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item I2C +\begin{DoxyItemize} +\item Clock rate up to 400 k\+Hz +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md3}{}\doxysubsubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{device_specifications_autotoc_md3} + +\begin{DoxyItemize} +\item 3.\+0 V to 3.\+6 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item I2C +\item SPI +\item UART +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md4}{}\doxysubsubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{device_specifications_autotoc_md4} + +\begin{DoxyItemize} +\item 2.\+7 V to 3.\+3 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item SPI +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md5}{}\doxysubsubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{device_specifications_autotoc_md5} + +\begin{DoxyItemize} +\item 2.\+7 V to 5.\+5 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item SPI +\begin{DoxyItemize} +\item 10 MHz +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md6}{}\doxysubsubsection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{device_specifications_autotoc_md6} + +\begin{DoxyItemize} +\item 4.\+5 V to 5.\+5 V Supply Voltage +\item Used directly with CANbus Controller +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md7}{}\doxysubsubsection{SD Card (\+Generic)}\label{device_specifications_autotoc_md7} + +\begin{DoxyItemize} +\item 2.\+7 V to 3.\+6 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item SPI +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md8}{}\doxysubsubsection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{device_specifications_autotoc_md8} + +\begin{DoxyItemize} +\item We will use a \char`\"{}\+Bus-\/\+Powered Configuration\char`\"{}, requiring the host device to supply power, that way we don\textquotesingle{}t have to. +\end{DoxyItemize}\hypertarget{device_specifications_autotoc_md9}{}\doxysubsubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{device_specifications_autotoc_md9} +\hypertarget{device_specifications_autotoc_md10}{}\doxysubsubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{device_specifications_autotoc_md10} + +\begin{DoxyItemize} +\item 1.\+71 V to 3.\+45 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item I2C +\begin{DoxyItemize} +\item 400 k\+Hz +\end{DoxyItemize} +\item SPI +\begin{DoxyItemize} +\item 10 MHz +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{layoutPlanning}{}\doxysection{Layout Planning}\label{layoutPlanning} +\hypertarget{layout_planning_autotoc_md11}{}\doxysubsubsection{Microcontroller}\label{layout_planning_autotoc_md11} diff --git a/Documentation/latex/index.tex b/Documentation/latex/index.tex index a6bbc49..e5b3240 100644 --- a/Documentation/latex/index.tex +++ b/Documentation/latex/index.tex @@ -1,7 +1,17 @@ -\label{index_md_README}% -\Hypertarget{index_md_README}% -\hypertarget{index_autotoc_md14}{}\doxysection{Documentation}\label{index_autotoc_md14} -For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.\hypertarget{index_autotoc_md15}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md15} +{\bfseries{Subpages}} + + +\begin{DoxyItemize} +\item \mbox{\hyperlink{hardware}{Hardware}} +\item \mbox{\hyperlink{software}{Software}} +\end{DoxyItemize} + +\DoxyHorRuler{0} +\hypertarget{index_autotoc_md13}{}\doxysection{About}\label{index_autotoc_md13} +What this project is about (TODO)\hypertarget{index_autotoc_md14}{}\doxysection{Documentation}\label{index_autotoc_md14} +For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project. + +More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md15}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md15} \begin{DoxyItemize} \item Make sub-\/circuits/sub-\/designs for schematics to keep things organized and modular/copy-\/able @@ -22,5 +32,6 @@ For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create docu \begin{DoxyItemize} \item Our requirements/specifications should be made to be more measurable -\item Need to design to safety standards, which need to be researched online +\item Need to design to safety standards, which need to be researched online +\item He said that he is available himself for anything power-\/related to help out with if needed \end{DoxyItemize} \ No newline at end of file diff --git a/Documentation/latex/layout_planning.tex b/Documentation/latex/layout_planning.tex new file mode 100644 index 0000000..d28005a --- /dev/null +++ b/Documentation/latex/layout_planning.tex @@ -0,0 +1 @@ +\hypertarget{layout_planning_autotoc_md10}{}\doxysubsection{Microcontroller}\label{layout_planning_autotoc_md10} diff --git a/Documentation/latex/md__hardware__device__specifications.tex b/Documentation/latex/md__hardware__device__specifications.tex index 22c43d2..4a67fbe 100644 --- a/Documentation/latex/md__hardware__device__specifications.tex +++ b/Documentation/latex/md__hardware__device__specifications.tex @@ -1,4 +1,5 @@ -\hypertarget{md__hardware__device__specifications_autotoc_md1}{}\doxysection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{md__hardware__device__specifications_autotoc_md1} +device\+Specifications Device Specifications\+Test1 \hypertarget{md__hardware__device__specifications_autotoc_md0}{}\doxysection{Device Specifications\+Test2}\label{md__hardware__device__specifications_autotoc_md0} +\hypertarget{md__hardware__device__specifications_autotoc_md1}{}\doxysubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{md__hardware__device__specifications_autotoc_md1} \begin{DoxyItemize} \item 1.\+8 V to 3.\+6 V Supply Voltage @@ -22,7 +23,7 @@ \item 14 external channels \end{DoxyItemize} \end{DoxyItemize} -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md2}{}\doxysection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{md__hardware__device__specifications_autotoc_md2} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md2}{}\doxysubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{md__hardware__device__specifications_autotoc_md2} \begin{DoxyItemize} \item 1.\+8 V to 5.\+5 V Supply Voltage @@ -33,7 +34,7 @@ \item Clock rate up to 400 k\+Hz \end{DoxyItemize} \end{DoxyItemize} -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md3}{}\doxysection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{md__hardware__device__specifications_autotoc_md3} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md3}{}\doxysubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{md__hardware__device__specifications_autotoc_md3} \begin{DoxyItemize} \item 3.\+0 V to 3.\+6 V Supply Voltage @@ -43,7 +44,7 @@ \item SPI \item UART \end{DoxyItemize} -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md4}{}\doxysection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{md__hardware__device__specifications_autotoc_md4} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md4}{}\doxysubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{md__hardware__device__specifications_autotoc_md4} \begin{DoxyItemize} \item 2.\+7 V to 3.\+3 V Supply Voltage @@ -51,7 +52,7 @@ \begin{DoxyItemize} \item SPI \end{DoxyItemize} -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md5}{}\doxysection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{md__hardware__device__specifications_autotoc_md5} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md5}{}\doxysubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{md__hardware__device__specifications_autotoc_md5} \begin{DoxyItemize} \item 2.\+7 V to 5.\+5 V Supply Voltage @@ -62,12 +63,12 @@ \item 10 MHz \end{DoxyItemize} \end{DoxyItemize} -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md6}{}\doxysection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{md__hardware__device__specifications_autotoc_md6} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md6}{}\doxysubsection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{md__hardware__device__specifications_autotoc_md6} \begin{DoxyItemize} \item 4.\+5 V to 5.\+5 V Supply Voltage \item Used directly with CANbus Controller -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md7}{}\doxysection{SD Card (\+Generic)}\label{md__hardware__device__specifications_autotoc_md7} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md7}{}\doxysubsection{SD Card (\+Generic)}\label{md__hardware__device__specifications_autotoc_md7} \begin{DoxyItemize} \item 2.\+7 V to 3.\+6 V Supply Voltage @@ -75,12 +76,12 @@ \begin{DoxyItemize} \item SPI \end{DoxyItemize} -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md8}{}\doxysection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{md__hardware__device__specifications_autotoc_md8} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md8}{}\doxysubsection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{md__hardware__device__specifications_autotoc_md8} \begin{DoxyItemize} \item We will use a \char`\"{}\+Bus-\/\+Powered Configuration\char`\"{}, requiring the host device to supply power, that way we don\textquotesingle{}t have to. -\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md9}{}\doxysection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{md__hardware__device__specifications_autotoc_md9} -\hypertarget{md__hardware__device__specifications_autotoc_md10}{}\doxysection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{md__hardware__device__specifications_autotoc_md10} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_autotoc_md9}{}\doxysubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{md__hardware__device__specifications_autotoc_md9} +\hypertarget{md__hardware__device__specifications_autotoc_md10}{}\doxysubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{md__hardware__device__specifications_autotoc_md10} \begin{DoxyItemize} \item 1.\+71 V to 3.\+45 V Supply Voltage diff --git a/Documentation/latex/md__hardware__device__specifications_test3.tex b/Documentation/latex/md__hardware__device__specifications_test3.tex new file mode 100644 index 0000000..8d1cec9 --- /dev/null +++ b/Documentation/latex/md__hardware__device__specifications_test3.tex @@ -0,0 +1,99 @@ +device\+Specifications Device Specifications\+Test1 \hypertarget{md__hardware__device__specifications_test3_autotoc_md0}{}\doxysection{Device Specifications\+Test2}\label{md__hardware__device__specifications_test3_autotoc_md0} +\hypertarget{md__hardware__device__specifications_test3_autotoc_md1}{}\doxysubsection{Microcontroller\+: Texas Instruments MSP430\+F5438\+AIPZR}\label{md__hardware__device__specifications_test3_autotoc_md1} + +\begin{DoxyItemize} +\item 1.\+8 V to 3.\+6 V Supply Voltage +\item Capabilities\+: +\begin{DoxyItemize} +\item 16-\/bit architecture +\item 25 MHz System Clock +\end{DoxyItemize} +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item Up to 4 of\+: +\begin{DoxyItemize} +\item UART/\+SPI +\end{DoxyItemize} +\item Up to 4 of\+: +\begin{DoxyItemize} +\item I2\+C/\+SPI +\end{DoxyItemize} +\item 12-\/bit ADC +\begin{DoxyItemize} +\item 14 external channels +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md2}{}\doxysubsection{Real-\/\+Time Clock/\+Calendar\+: Microchip Technology ‎\+MCP7940\+MT-\/\+I/\+SN}\label{md__hardware__device__specifications_test3_autotoc_md2} + +\begin{DoxyItemize} +\item 1.\+8 V to 5.\+5 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item I2C +\begin{DoxyItemize} +\item Clock rate up to 400 k\+Hz +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md3}{}\doxysubsection{Bluetooth/\+Wi-\/\+Fi\+: Espressif Systems ESP32-\/\+WROVER-\/\+IE (8\+MB)}\label{md__hardware__device__specifications_test3_autotoc_md3} + +\begin{DoxyItemize} +\item 3.\+0 V to 3.\+6 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item I2C +\item SPI +\item UART +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md4}{}\doxysubsection{GPS Receiver\+: Maxim Integrated ‎\+MAX2771\+ETI+T}\label{md__hardware__device__specifications_test3_autotoc_md4} + +\begin{DoxyItemize} +\item 2.\+7 V to 3.\+3 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item SPI +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md5}{}\doxysubsection{CANbus Controller\+: Microchip Technology MCP2515\+T-\/\+I/\+SO}\label{md__hardware__device__specifications_test3_autotoc_md5} + +\begin{DoxyItemize} +\item 2.\+7 V to 5.\+5 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item SPI +\begin{DoxyItemize} +\item 10 MHz +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md6}{}\doxysubsection{CAN Bus Transceiver\+: ‎\+Microchip Technology MCP2542\+FD-\/\+H/\+SN}\label{md__hardware__device__specifications_test3_autotoc_md6} + +\begin{DoxyItemize} +\item 4.\+5 V to 5.\+5 V Supply Voltage +\item Used directly with CANbus Controller +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md7}{}\doxysubsection{SD Card (\+Generic)}\label{md__hardware__device__specifications_test3_autotoc_md7} + +\begin{DoxyItemize} +\item 2.\+7 V to 3.\+6 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item SPI +\end{DoxyItemize} +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md8}{}\doxysubsection{USB to UART Bridge\+: FTDI ‎‎\+FT260\+Q-\/T}\label{md__hardware__device__specifications_test3_autotoc_md8} + +\begin{DoxyItemize} +\item We will use a \char`\"{}\+Bus-\/\+Powered Configuration\char`\"{}, requiring the host device to supply power, that way we don\textquotesingle{}t have to. +\end{DoxyItemize}\hypertarget{md__hardware__device__specifications_test3_autotoc_md9}{}\doxysubsection{RS-\/232 Transceiver\+: Texas Instruments GD75232\+PWR}\label{md__hardware__device__specifications_test3_autotoc_md9} +\hypertarget{md__hardware__device__specifications_test3_autotoc_md10}{}\doxysubsection{Inertial Measurement Unit\+: TDK Inven\+Sense ICM-\/20600}\label{md__hardware__device__specifications_test3_autotoc_md10} + +\begin{DoxyItemize} +\item 1.\+71 V to 3.\+45 V Supply Voltage +\item Notable Peripherals\+: +\begin{DoxyItemize} +\item I2C +\begin{DoxyItemize} +\item 400 k\+Hz +\end{DoxyItemize} +\item SPI +\begin{DoxyItemize} +\item 10 MHz +\end{DoxyItemize} +\end{DoxyItemize} +\end{DoxyItemize} \ No newline at end of file diff --git a/Documentation/latex/md__hardware__layout__planning.tex b/Documentation/latex/md__hardware__layout__planning.tex index 33728ef..a253b09 100644 --- a/Documentation/latex/md__hardware__layout__planning.tex +++ b/Documentation/latex/md__hardware__layout__planning.tex @@ -1 +1 @@ -\hypertarget{md__hardware__layout__planning_autotoc_md12}{}\doxysection{Microcontroller}\label{md__hardware__layout__planning_autotoc_md12} +\hypertarget{md__hardware__layout__planning_autotoc_md11}{}\doxysection{Microcontroller}\label{md__hardware__layout__planning_autotoc_md11} diff --git a/Documentation/latex/refman.tex b/Documentation/latex/refman.tex index a499394..f81d26d 100644 --- a/Documentation/latex/refman.tex +++ b/Documentation/latex/refman.tex @@ -158,7 +158,7 @@ \begin{titlepage} \vspace*{7cm} \begin{center}% -{\Large Sunseeker Telemetry and Lighting System }\\ +{\Large 2020-\/2021 Sunseeker Telemetry and Lighting System }\\ \vspace*{1cm} {\large Generated by Doxygen 1.9.1}\\ \end{center} @@ -171,22 +171,29 @@ \hypersetup{pageanchor=true} %--- Begin generated contents --- -\chapter{ECE4810-\/\+Fall2020-\/\+Sunseeker\+Telemetry} +\chapter{Main Page} \label{index}\hypertarget{index}{}\input{index} -\chapter{Device Specifications} -\label{md__hardware__device__specifications} -\Hypertarget{md__hardware__device__specifications} -\input{md__hardware__device__specifications} -\chapter{Layout Planning} -\label{md__hardware__layout__planning} -\Hypertarget{md__hardware__layout__planning} -\input{md__hardware__layout__planning} +\chapter{Hardware} +\label{hardware} +\Hypertarget{hardware} +\input{hardware} +\chapter{Software} +\label{software} +\Hypertarget{software} +\input{software} +\chapter{Documentation Guide} +\label{documentation_guide} +\Hypertarget{documentation_guide} +\input{documentation_guide} \chapter{File Index} \input{files} \chapter{File Documentation} +\input{_9_hardware_8markdown} \input{_device_01_specifications_8markdown} \input{_layout_01_planning_8markdown} +\input{_documentation_01_guide_8markdown} \input{_r_e_a_d_m_e_8markdown} +\input{_9_software_8markdown} \input{main_8c} %--- End generated contents --- diff --git a/Documentation/latex/software.tex b/Documentation/latex/software.tex new file mode 100644 index 0000000..e69de29 diff --git a/Doxyfile b/Doxyfile index 1f13d42..54b370e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Sunseeker Telemetry and Lighting System" +PROJECT_NAME = "2020-2021 Sunseeker Telemetry and Lighting System" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -347,7 +347,7 @@ MARKDOWN_SUPPORT = YES # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. -TOC_INCLUDE_HEADINGS = 5 +TOC_INCLUDE_HEADINGS = 4 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can @@ -866,7 +866,8 @@ WARN_LOGFILE = INPUT = Hardware \ Software \ - README.markdown + README.markdown \ + Meta # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1334,7 +1335,7 @@ HTML_COLORSTYLE_GAMMA = 73 # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_TIMESTAMP = NO +HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that diff --git a/Hardware/!Hardware.markdown b/Hardware/!Hardware.markdown new file mode 100644 index 0000000..ea04eeb --- /dev/null +++ b/Hardware/!Hardware.markdown @@ -0,0 +1,10 @@ +@page hardware Hardware + +@b Subpages + +- @subpage deviceSpecifications + +- @subpage layoutPlanning + +--- + diff --git a/Hardware/Device Specifications.markdown b/Hardware/Device Specifications.markdown index 948fbaf..1463624 100644 --- a/Hardware/Device Specifications.markdown +++ b/Hardware/Device Specifications.markdown @@ -1,4 +1,4 @@ -# Device Specifications +@page deviceSpecifications Device Specifications diff --git a/Hardware/Layout Planning.markdown b/Hardware/Layout Planning.markdown index ac46056..83ba0ea 100644 --- a/Hardware/Layout Planning.markdown +++ b/Hardware/Layout Planning.markdown @@ -1,4 +1,4 @@ -# Layout Planning +@page layoutPlanning Layout Planning diff --git a/Meta/Documentation Guide.markdown b/Meta/Documentation Guide.markdown new file mode 100644 index 0000000..a8a3a38 --- /dev/null +++ b/Meta/Documentation Guide.markdown @@ -0,0 +1,34 @@ +@page documentationGuide Documentation Guide + + + +# Doxygen + +The program called "doxygen" ([GitHub Page](https://github.com/doxygen/doxygen) and [Website](https://www.doxygen.nl/)) is what we're using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we've done. + +It simply uses a small configuration file at the root of the project `/Doxyfile` to store some settings, and the rest is through mainly Markdown files (`.md` or `.markdown`) and source code files. + +It is setup (as of writing this) that someone can simply open the `/Doxyfile` in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it. + + + +# Updating Documentation + +You need to have installed the program from either the GitHub page or website, then simply open the `/Doxyfile` within the GUI frontend or "Wizard". + + + +# Important Notes + +- Make sure that the `/Doxyfile` stays where it's at! It should be kept at the root directory (just to keep things simple) +- Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the `/Doxyfile`, they'll have to re-do all of them in order for it to start functioning again. + + + +## For Consistency + +- Please make sure the internal names of files are using "camelCase" + - Example: for "@page documentationGuide Documentation Guide" + "documentationGuide" is the name used internally by doxygen. + "Documentation Guide" is what shows up on the output documentation. + diff --git a/README.markdown b/README.markdown index dbc7dc1..e5b0886 100644 --- a/README.markdown +++ b/README.markdown @@ -1,4 +1,18 @@ -# ECE4810-Fall2020-SunseekerTelemetry +@mainpage + +@b Subpages + +- @subpage hardware + +- @subpage software + +--- + + + +# About + +What this project is about (TODO) @@ -6,6 +20,10 @@ For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project. +More information here: @ref documentationGuide "Documentation Guide" + + + ## Tips from Dr. Bazuin - Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able @@ -29,5 +47,6 @@ For Documentation, we will use "doxygen" to easily create documentation pages fo - Our requirements/specifications should be made to be more measurable - Need to design to safety standards, which need to be researched online + - He said that he is available himself for anything power-related to help out with if needed diff --git a/Software/!Software.markdown b/Software/!Software.markdown new file mode 100644 index 0000000..99dad45 --- /dev/null +++ b/Software/!Software.markdown @@ -0,0 +1,4 @@ +@page software Software + + +