]> rtime.felk.cvut.cz Git - jenkicar/testing.git/commitdiff
Added base documentation and project charter.
authorCarlos Jenkins <carlos@work.(none)>
Thu, 28 Feb 2013 17:56:36 +0000 (18:56 +0100)
committerCarlos Jenkins <carlos@work.(none)>
Thu, 28 Feb 2013 17:56:36 +0000 (18:56 +0100)
12 files changed:
Documentation/chronogram.planner [new file with mode: 0644]
Documentation/reports/charter/.gitignore [new file with mode: 0644]
Documentation/reports/charter/charter.t2t [new file with mode: 0644]
Documentation/reports/charter/header.tex [new file with mode: 0644]
Documentation/reports/charter/images/board.jpg [new file with mode: 0644]
Documentation/reports/charter/images/logo.png [new file with mode: 0644]
Documentation/reports/charter/title.tex [new file with mode: 0644]
Documentation/reports/first/.gitignore [new file with mode: 0644]
Documentation/reports/first/first.t2t [new file with mode: 0644]
Documentation/reports/first/header.tex [new file with mode: 0644]
Documentation/reports/first/images/logo.png [new file with mode: 0644]
Documentation/reports/first/title.tex [new file with mode: 0644]

diff --git a/Documentation/chronogram.planner b/Documentation/chronogram.planner
new file mode 100644 (file)
index 0000000..8b41d83
--- /dev/null
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<project name="Code generation for automotive rapid prototyping platform using Matlab/Simulink" company="" manager="Carlos Jenkins" phase="" project-start="20130211T000000Z" mrproject-version="2" calendar="1">
+  <properties/>
+  <phases/>
+  <calendars>
+    <day-types>
+      <day-type id="0" name="Working" description="A default working day"/>
+      <day-type id="1" name="Nonworking" description="A default non working day"/>
+      <day-type id="2" name="Use base" description="Use day from base calendar"/>
+    </day-types>
+    <calendar id="1" name="Default">
+      <default-week mon="0" tue="0" wed="0" thu="0" fri="0" sat="1" sun="1"/>
+      <overridden-day-types>
+        <overridden-day-type id="0">
+          <interval start="0800" end="1200"/>
+          <interval start="1300" end="1700"/>
+        </overridden-day-type>
+      </overridden-day-types>
+      <days/>
+    </calendar>
+  </calendars>
+  <tasks>
+    <task id="1" name="Project Charter" note="" work="28800" start="20130211T000000Z" end="20130211T170000Z" work-start="20130211T080000Z" percent-complete="0" priority="0" type="normal" scheduling="fixed-work"/>
+  </tasks>
+  <resource-groups/>
+  <resources>
+    <resource id="1" name="Carlos Jenkins" short-name="" type="1" units="0" email="" note="" std-rate="0"/>
+  </resources>
+  <allocations/>
+</project>
diff --git a/Documentation/reports/charter/.gitignore b/Documentation/reports/charter/.gitignore
new file mode 100644 (file)
index 0000000..488516b
--- /dev/null
@@ -0,0 +1,2 @@
+.backup*
+publish
diff --git a/Documentation/reports/charter/charter.t2t b/Documentation/reports/charter/charter.t2t
new file mode 100644 (file)
index 0000000..1f62582
--- /dev/null
@@ -0,0 +1,85 @@
+Project Charter
+Carlos Jenkins
+%%date(%B, %Y)
+
+%!target: tex
+%!style(xhtmls): media/themes/Clean/style.css
+%!options(tex): --enum-title --toc --toc-level 5
+%!nested(tex): --docclass {article} --pdf
+
+%S = Table of contents =[table_of_contents]
+
+%Table of contents
+%%toc
+
+%tex% ''\newpage''
+
+= Project name =[project_name]
+
+Official name of the project is:
+
+%tex% ''' \begin{center}
+Code generation for automotive rapid prototyping platform using Matlab/Simulink.
+
+%tex% ''' \end{center}
+
+= Background =[background]
+
+TODO: Write history of the project.
+
++ How, why, when.
++ Hardware implementation. 
++ Current Software implementation.
+
+
+= Objectives =[objectives]
+
+Main objectives of this project are:
+
++ Allow code generation of Matlab/Simulink model to custom made hardware platform.
++ Implement model blocks for each of the peripheral units of the board for use in Simulink programming.
+
+
+= Expected benefits =[expected_benefits]
+
+Expected benefits after conclusion of the project includes:
+
++ Enabling faster implementation and rapid-prototyping of Software components through the use of model-based programming.
++ Enabling better and clearer visualization of Software implementations for the hardware board through models.
++ Improve auditability of Software system for automotive applications.
+
+
+= Expected final outcome =[expected_final_outcome]
+
+Current expected outcome includes:
+
++ Implementation of a template system / new target for code generation for the custom hardware device.
++ Implementation of a Simulink model block for each peripherals of the board.
++ Implementation of basic test model for each model block.
+
+
+= Technologies involved =[technologies_involved]
+
+Technologies expected in this project includes:
+
++ Matlab/Simulink data flow graphical programming language tool for modeling, simulating and analyzing multidomain dynamic systems.
++ Standard ANSI C programming.
++ FreeRTOS real-time operating system.
++ Texas Instruments TI Code Generation Tools (CGT) C compiler.
++ RPP in-house automotive hardware board using Texas Instruments TMS570LS3137:
+
+[300-board.jpg]
+
+= Preliminary chronogram =[preliminary_chronogram]
+
+
+||   Date   |   Deliverable                                                 |
+ | 0.0.2013 | Target Language Compiler (TLC) files for hardware system.     |
+ | 0.0.2013 | Implemented block: Digital inputs and test.                   |
+ | 0.0.2013 | Implemented block: H-bridge outputs and test.                 |
+ | 0.0.2013 | Implemented block: Motor driver outputs and test.             |
+ | 0.0.2013 | Implemented block: Analog-to-digital converter and test.      |
+ | 0.0.2013 | Implemented block: Serial Communication Interface and test.   |
+ | 0.0.2013 | Implemented block: CAN Bus Communication and test.            |
+ | 0.0.2013 | Implemented block: SDRAM and test.                            |
+
diff --git a/Documentation/reports/charter/header.tex b/Documentation/reports/charter/header.tex
new file mode 100644 (file)
index 0000000..481f4df
--- /dev/null
@@ -0,0 +1,40 @@
+\usepackage[top=3cm, bottom=3cm, left=3cm, right=3cm]{geometry}
+%\usepackage[spanish]{babel}
+\usepackage{float} % To fix images position
+
+% Prettify code documentation
+\usepackage{color}
+\definecolor{gray97}{gray}{.97}
+\definecolor{gray75}{gray}{.75}
+\definecolor{gray45}{gray}{.45}
+\lstset{ frame=Ltb,
+     framerule=0pt,
+     aboveskip=0.5cm,
+     framextopmargin=3pt,
+     framexbottommargin=3pt,
+     framexleftmargin=0.4cm,
+     framesep=0pt,
+     rulesep=.4pt,
+     backgroundcolor=\color{gray97},
+     rulesepcolor=\color{black},
+     %
+     stringstyle=\ttfamily,
+     showstringspaces = false,
+     basicstyle=\small\ttfamily,
+     commentstyle=\color{gray45},
+     keywordstyle=\bfseries,
+     %
+     numbers=left,
+     numbersep=15pt,
+     numberstyle=\tiny,
+     numberfirstline = false,
+     breaklines=true,
+     xleftmargin=20px,
+   }
+
+% Spacing
+\addtolength{\parskip}{\baselineskip} % Paragraph spacing
+\linespread{1.15} % Lines spacing
+\setlength{\plitemsep}{0.5\baselineskip} % List items spacing
+\definecolor{deepblue}{RGB}{0,0,61}
+\hypersetup{linkcolor=deepblue,}
diff --git a/Documentation/reports/charter/images/board.jpg b/Documentation/reports/charter/images/board.jpg
new file mode 100644 (file)
index 0000000..fa9c10d
Binary files /dev/null and b/Documentation/reports/charter/images/board.jpg differ
diff --git a/Documentation/reports/charter/images/logo.png b/Documentation/reports/charter/images/logo.png
new file mode 100644 (file)
index 0000000..46b5890
Binary files /dev/null and b/Documentation/reports/charter/images/logo.png differ
diff --git a/Documentation/reports/charter/title.tex b/Documentation/reports/charter/title.tex
new file mode 100644 (file)
index 0000000..529faeb
--- /dev/null
@@ -0,0 +1,30 @@
+\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
+
+\begin{titlepage}
+\begin{center}
+
+% Upper part of the page
+\includegraphics[width=0.30\textwidth]{media/images/logo.png}\\[1cm]
+\textsc{\LARGE Costa Rica Institute Of Technology}\\[1.5cm]
+\textsc{\Large IC-8841 - Specialty Practice}\\[0.5cm]
+
+
+% Document itle
+\HRule \\[0.4cm]
+{ \huge \bfseries Project Charter}\\[0.4cm]
+\HRule \\[1.5cm]
+
+
+% Author
+\emph{Author:}\\
+Carlos \textsc{Jenkins}\\
+
+\vfill
+
+% Bottom of the page
+{\large \today}
+
+\end{center}
+\end{titlepage}
+
+
diff --git a/Documentation/reports/first/.gitignore b/Documentation/reports/first/.gitignore
new file mode 100644 (file)
index 0000000..488516b
--- /dev/null
@@ -0,0 +1,2 @@
+.backup*
+publish
diff --git a/Documentation/reports/first/first.t2t b/Documentation/reports/first/first.t2t
new file mode 100644 (file)
index 0000000..f222aa7
--- /dev/null
@@ -0,0 +1,41 @@
+Document title
+Authors
+%%date(%B, %Y)
+
+%!target: tex
+%!style(xhtmls): media/themes/Clean/style.css
+%!options(tex): --enum-title --toc --toc-level 5
+%!nested(tex): --docclass {article} --pdf
+
+%S = Table of contents =[table_of_contents]
+
+%Table of contents
+%%toc
+
+%tex% ''\newpage''
+Code generation for automotive rapid prototyping platform using Matlab/Simulink
+
+= Introduction =[introduction]
+
+
+
+= Development =[development]
+
+
+
+== First subject ==[first_subject]
+
+
+
+== Second subject ==[second_subject]
+
+
+
+= Conclusions =[conclusions]
+
+
+
+= References =[references]
+
+
+
diff --git a/Documentation/reports/first/header.tex b/Documentation/reports/first/header.tex
new file mode 100644 (file)
index 0000000..481f4df
--- /dev/null
@@ -0,0 +1,40 @@
+\usepackage[top=3cm, bottom=3cm, left=3cm, right=3cm]{geometry}
+%\usepackage[spanish]{babel}
+\usepackage{float} % To fix images position
+
+% Prettify code documentation
+\usepackage{color}
+\definecolor{gray97}{gray}{.97}
+\definecolor{gray75}{gray}{.75}
+\definecolor{gray45}{gray}{.45}
+\lstset{ frame=Ltb,
+     framerule=0pt,
+     aboveskip=0.5cm,
+     framextopmargin=3pt,
+     framexbottommargin=3pt,
+     framexleftmargin=0.4cm,
+     framesep=0pt,
+     rulesep=.4pt,
+     backgroundcolor=\color{gray97},
+     rulesepcolor=\color{black},
+     %
+     stringstyle=\ttfamily,
+     showstringspaces = false,
+     basicstyle=\small\ttfamily,
+     commentstyle=\color{gray45},
+     keywordstyle=\bfseries,
+     %
+     numbers=left,
+     numbersep=15pt,
+     numberstyle=\tiny,
+     numberfirstline = false,
+     breaklines=true,
+     xleftmargin=20px,
+   }
+
+% Spacing
+\addtolength{\parskip}{\baselineskip} % Paragraph spacing
+\linespread{1.15} % Lines spacing
+\setlength{\plitemsep}{0.5\baselineskip} % List items spacing
+\definecolor{deepblue}{RGB}{0,0,61}
+\hypersetup{linkcolor=deepblue,}
diff --git a/Documentation/reports/first/images/logo.png b/Documentation/reports/first/images/logo.png
new file mode 100644 (file)
index 0000000..46b5890
Binary files /dev/null and b/Documentation/reports/first/images/logo.png differ
diff --git a/Documentation/reports/first/title.tex b/Documentation/reports/first/title.tex
new file mode 100644 (file)
index 0000000..50b1840
--- /dev/null
@@ -0,0 +1,32 @@
+\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
+
+\begin{titlepage}
+\begin{center}
+
+% Upper part of the page
+\includegraphics[width=0.30\textwidth]{media/images/logo.png}\\[1cm]
+\textsc{\LARGE Name of your institution}\\[1.5cm]
+\textsc{\Large Name of your class}\\[0.5cm]
+
+
+% Document itle
+\HRule \\[0.4cm]
+{ \huge \bfseries Document title}\\[0.4cm]
+\HRule \\[1.5cm]
+
+
+% Author
+\emph{Authors:}\\
+Author1 \textsc{Lastname}\\
+Author2 \textsc{Lastname}\\
+Author3 \textsc{Lastname}\\
+
+\vfill
+
+% Bottom of the page
+{\large \today}
+
+\end{center}
+\end{titlepage}
+
+