]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
Improved report documentation and fixed non-centered title in CVUT logo.
authorCarlos Jenkins <carlos@jenkins.co.cr>
Fri, 14 Jun 2013 00:48:11 +0000 (02:48 +0200)
committerCarlos Jenkins <carlos@jenkins.co.cr>
Fri, 14 Jun 2013 00:48:11 +0000 (02:48 +0200)
doc/reports/report/header.tex
doc/reports/report/images/logos.png
doc/reports/report/images/logos.svg
doc/reports/report/report.t2t

index d66b13eb07a7a4c08b9416c8affd060952b7d076..1e535697a6e5335aa71207d388ec61d613ff908b 100644 (file)
@@ -1,5 +1,4 @@
 \usepackage[top=3cm, bottom=3cm, left=3cm, right=3cm]{geometry}
-%\usepackage[spanish]{babel}
 \usepackage{float} % To fix images position
 
 % Prettify code documentation
@@ -38,5 +37,3 @@
 \setlength{\plitemsep}{0.5\baselineskip} % List items spacing
 \definecolor{deepblue}{RGB}{0,0,61}
 \hypersetup{linkcolor=deepblue,}
-
-\DeclareUnicodeCharacter{00A0}{~}
index 95b3a5f511c1e5490e9a2506725f321d8b247ead..4da03d417d19b6ba8dcd92c72cebfbfd583f0379 100644 (file)
Binary files a/doc/reports/report/images/logos.png and b/doc/reports/report/images/logos.png differ
index f09ebaf9ecc5d7201fdce20d11326496aaa5bf6a..3fb06381f90fadfb48b409cfd58915053162524f 100644 (file)
@@ -55,7 +55,7 @@
         <dc:format>image/svg+xml</dc:format>
         <dc:type
            rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
+        <dc:title />
       </cc:Work>
     </rdf:RDF>
   </metadata>
          sodipodi:linespacing="125%"
          id="text3048"
          y="724.11914"
-         x="25.501986"
-         style="font-size:10.63101578px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#1576c3;fill-opacity:1;stroke:none;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans"
+         x="177.5217"
+         style="font-size:10.63101578000000025px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#1576c3;fill-opacity:1;stroke:none;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans;text-anchor:middle;text-align:center"
          xml:space="preserve"><tspan
-           style="font-size:24.80570412px;font-weight:bold;fill:#1576c3;fill-opacity:1;-inkscape-font-specification:DejaVu Sans Bold"
+           style="font-size:24.80570412000000147px;font-weight:bold;fill:#1576c3;fill-opacity:1;-inkscape-font-specification:DejaVu Sans Bold;text-anchor:middle;text-align:center"
            y="724.11914"
            x="25.501986"
            id="tspan3050"
            sodipodi:role="line">ČESKÉ VYSOKÉ UČENÍ </tspan><tspan
-           style="font-size:24.80570412px;font-weight:bold;fill:#1576c3;fill-opacity:1;-inkscape-font-specification:DejaVu Sans Bold"
+           style="font-size:24.80570412000000147px;font-weight:bold;fill:#1576c3;fill-opacity:1;-inkscape-font-specification:DejaVu Sans Bold;text-anchor:middle;text-align:center"
            id="tspan3052"
            y="755.12628"
            x="25.501986"
index fe3cc85d360f75a9b6737a1ea43f04d079b03c93..5adbcabe6afdf57dc6f8b4e756bc3340350ec5ee 100644 (file)
@@ -19,76 +19,80 @@ Code generation for automotive rapid prototyping platform using Matlab/Simulink
 
 
 
-= Environment configuration =[environment_configuration]
+= Project setup =[project_setup]
 
 
 
-== Operating system ==[operating_system]
+== Environment configuration ==[environment_configuration]
 
 
 
-== Utilities ==[utilities]
+=== Operating system ===[operating_system]
 
 
 
-=== git version control system ===[git_version_control_system]
+=== Utilities ===[utilities]
 
 
 
-=== GtkTerm or minicom ===[gtkterm_or_minicom]
+==== git version control system ====[git_version_control_system]
 
 
 
-=== Matlab/Simulink ===[matlabsimulink]
+==== GtkTerm or minicom ====[gtkterm_or_minicom]
 
 
 
-=== TI Code Composer Studio ===[ti_code_composer_studio]
+==== Matlab/Simulink ====[matlabsimulink]
 
 
 
-= Hardware =[hardware]
+==== TI Code Composer Studio ====[ti_code_composer_studio]
+
+
+
+== Hardware ==[hardware]
 
 Photo of the board
 
-== Wiring ==[wiring]
+=== Wiring ===[wiring]
 
 How to wire the board for testing.
 
-== Modules ==[modules]
+=== Modules ===[modules]
 
 Image of hardware modules.
 
-=== Logic IO ===[logic_io]
+==== Logic IO ====[logic_io]
 
 
 
-==== 16x digital input (DIN) ====[16x_digital_input_din]
+===== 16x digital input (DIN) =====[16x_digital_input_din]
 
 - Read status via GPIO pin (configurable threshold).
 - Read status via SPI pin (fixed threshold).
 - Setting pin programmable via SPI.
 
 
-==== 8x digital outputs for loads up to 100 mA (LOUT) ====[8x_digital_outputs_for_loads_up_to_100_ma_lout]
+===== 8x digital outputs for loads up to 100 mA (LOUT) =====[8x_digital_outputs_for_loads_up_to_100_ma_lout]
 
 - Set pin ON.
 - Set pin OFF.
 - Reading the SPI status excitation.
 
-==== 12x analog-to-digital converter ====[12x_analog_to_digital_converter]
+===== 12x analog-to-digital converter =====[12x_analog_to_digital_converter]
 
 - Reading values on all channels.
 
-==== 4x digital-to-analog converter ====[4x_digital_to_analog_converter]
+===== 4x digital-to-analog converter =====[4x_digital_to_analog_converter]
 
 - Set the required voltage on all channels.
 
-=== Power Output ===[power_output]
+==== Power Output ====[power_output]
 
 
 
-==== 1x H-Bridge ====[1x_h_bridge]
+===== 1x H-Bridge =====[1x_h_bridge]
 
 - Setting the direction.
 - Switch on, off.
@@ -96,13 +100,13 @@ Image of hardware modules.
 - Enable PWM.
 
 
-==== 6x outputs for loads up to 2 A (MOUT) ====[6x_outputs_for_loads_up_to_2_a_mout]
+===== 6x outputs for loads up to 2 A (MOUT) =====[6x_outputs_for_loads_up_to_2_a_mout]
 
 - Set pin ON.
 - Set pin OFF.
 - Reading diagnostics values (DIAG).
 
-==== 6x output up to 10 A with PWM (HOUT) ====[6x_output_up_to_10_a_with_pwm_hout]
+===== 6x output up to 10 A with PWM (HOUT) =====[6x_output_up_to_10_a_with_pwm_hout]
 
 - Set pin ON.
 - Set pin OFF.
@@ -111,65 +115,189 @@ Image of hardware modules.
 - Detection of a fault condition.
 - Turn on the PWM pin.
 
-=== Communication ===[communication]
+==== Communication ====[communication]
 
 
 
-==== 3x CAN High speed ====[3x_can_high_speed]
+===== 3x CAN High speed =====[3x_can_high_speed]
 
 - Sending and receiving messages between the CAN bus interfaces.
 - Recover from error.
 - Detection of network errors.
 
-==== 2x LIN ====[2x_lin]
+===== 2x LIN =====[2x_lin]
 
 - Testing least one LIN using a loop. The second connector is shared with serial interface, which is tested alone communicate with the computer. Detailed testing makes sense to be no support for access to diagnostics unit via Ethernet or other interface.
 
-==== 1x FlexRay ====[1x_flexray]
+===== 1x FlexRay =====[1x_flexray]
 
 - Sending and receiving messages between two plates JRVA.
 
 
-==== 1x Serial Comm. Interface ====[1x_serial_comm_interface]
+===== 1x Serial Comm. Interface =====[1x_serial_comm_interface]
 
 
 
-==== 1x Ethernet ====[1x_ethernet]
+===== 1x Ethernet =====[1x_ethernet]
 
 - To send a packet.
 - Code for testing Ethernet is the result of this thesis and is therefore not analyzed.
 
-=== Data storage/logging ===[data_storagelogging]
+==== Data storage/logging ====[data_storagelogging]
 
 
 
-==== External Memory SDRAM ====[external_memory_sdram]
+===== External Memory SDRAM =====[external_memory_sdram]
 
 - Determine the total capacity of the module fitted.
 - Performing a memory test module using the entire address range.
 
 
-==== SD Card ====[sd_card]
+===== SD Card =====[sd_card]
 
 
 
-= Software =[software]
+== Software ==[software]
 
 
 
-== Repository ==[repository]
+=== Repository ===[repository]
 
 
 
-== Programming standards ==[programming_standards]
+=== Programming standards ===[programming_standards]
 
 - Programming standards.
  - Functions names.
  - Variables.
  - Includes.......
 
-= Untitled section =[untitled_section]
+= Project repository =[project_repository]
+
+
+
+= RPP Library =[rpp_library]
+
+
+
+== Modules ==[modules]
+
+
+
+== Test Suite ==[test_suite]
+
+
+
+= Simulink target =[simulink_target]
+
+
+
+== Code generation system ==[code_generation_system]
+
+
+
+== Block library ==[block_library]
+
+
+
+== Demos ==[demos]
+
+%tex% ''' \newpage{}
+
+= Glossary =[glossary]
+
+: ADC
+  //Analog to Digital Converter.//
+  Hardware circuitry that converts a continuous physical quantity (usually voltage) to a 
+  digital number that represents the quantity's amplitude.
+
+: AIN
+  //Analog Input.//
+  Mnemonic to refer to or something related to the analog input (ADC) hardware module.
+
+: AOUT
+  //Analog Output.//
+  Mnemonic to refer to or something related to the analog output (DAC) hardware module.
+
+: CAN
+  //Controller Area Network.//
+  The CAN Bus is a vehicle bus standard designed to allow microcontrollers and devices to 
+  communicate with each other within a vehicle without a host computer.
+  In this project it is also used as mnemonic to refer to or something related to the CAN 
+  hardware module.
+
+: DAC
+  //Digital to Analog Converter.//
+  Hardware circuitry that converts a digital (usually binary) code to an analog signal 
+  (current, voltage, or electric charge).
+
+: DIN
+  //Digital Input.//
+  Mnemonic to refer to or something related to the digital input hardware module.
+
+: ETH
+  //Ethernet.//
+  Mnemonic to refer to or something related to the Ethernet hardware module.
+
+: FR
+  //FlexRay.//
+  FlexRay is an automotive network communications protocol developed to govern on-board automotive 
+  computing.
+  In this project it is also used as mnemonic to refer to or something related to the FlexRay 
+  hardware module.
+
+: HBR
+  //H-Bridge.//
+  Mnemonic to refer to or something related to the H-Bridge hardware module. A H-Bridge is 
+  an electronic circuit that enables a voltage to be applied across a load in either direction.
+
+: HOUT
+  //High-Power Output.//
+  Mnemonic to refer to or something related to the 10A, PWM, with current sensing, high-power 
+  output hardware module.
+
+: LIN
+  //Local Interconnect Network.//
+  The LIN is a serial network protocol used for communication between components in vehicles.
+  In this project it is also used as mnemonic to refer to or something related to the LIN 
+  hardware module.
+
+: LOUT
+  //Logic Output.//
+  Mnemonic to refer to or something related to the digital output hardware module. 
+  It is logic output (100mA), as opposed to power outputs (2A, 10A).
+
+: MOUT
+  //(Motor) Power Output.//
+  Mnemonic to refer to or something related to the 2A push/pull power output hardware module.
+
+
+: RPP
+  //Rapid Prototyping Platform//.
+  Name of the automotive hardware board. Also generic term to define something related 
+  to the board, like the RPP Library, RPP Layer, RPP API, etc.
+
+: SCI
+  //Serial Communication Interface.//
+  Serial Interface for communication through hardware's UART using communication standard RS-232.
+  In this project it is also used as mnemonic to refer to or something related to the Serial 
+  Communication Interface hardware module.
+
+: SDC
+  //SD-Card.//
+  Mnemonic to refer to or something related to the SD-Card hardware module.
+
+: SDR
+  //SD-RAM.//
+  Mnemonic to refer to or something related to the SD-RAM hardware module for logging.
+
+: UART
+  //Universal Asynchronous Receiver/Transmitter.//
+  Hardware circuitry that translates data between parallel and serial forms.
+
+
 
+%tex% ''' \newpage{}
 
 
 = References =[references]