Bladeren bron

Add the design specifications document files.

Refers #1

removed symbolic link to preamble.tex
master
Wouter Horlings 5 jaren geleden
bovenliggende
commit
ecb78fd97b
6 gewijzigde bestanden met toevoegingen van 100 en 0 verwijderingen
  1. +2
    -0
      .gitignore
  2. +24
    -0
      .gitlab-ci.yml
  3. +8
    -0
      specifications/system/content/description.tex
  4. +8
    -0
      specifications/system/content/introduction.tex
  5. +39
    -0
      specifications/system/content/specifications.tex
  6. +19
    -0
      specifications/system/document.tex

+ 2
- 0
.gitignore Bestand weergeven

@@ -0,0 +1,2 @@
specifications/system/document.pdf
specifications/system/preamble.tex

+ 24
- 0
.gitlab-ci.yml Bestand weergeven

@@ -0,0 +1,24 @@

---
stages:
- typeset

design_specifications:
stage: typeset
image: registry.gitlab.com/silkeh/latex:latest
script:
- cp misc/preamble.tex specifications/system/preamble.tex
- cd specifications/system/
- latexmk -xelatex document.tex
- mv document.pdf ../../design_specifications.pdf
artifacts:
paths:
- design_specifications.pdf
only:
refs:
- web
- branches
- tags
changes:
- specifications/system/*
- misc/preamble.tex

+ 8
- 0
specifications/system/content/description.tex Bestand weergeven

@@ -0,0 +1,8 @@
\section{description}
Our Tweet writer for a whiteboard will be able to write a tweet on a whiteboard.
The tweet has to be updated.
Therefore, the current content of the whiteboard has to be wiped.
Followed by a total of 140 characters added on the whiteboard.
As it is a whiteboard, we want the text to be readable at a 10 meter distance.
We like some color aswell. So up to three colors is required.


+ 8
- 0
specifications/system/content/introduction.tex Bestand weergeven

@@ -0,0 +1,8 @@
\chapter{Introduction}

This document is part of a Master's Thesis.
The goal is to test a Design Methodology for hardware based CPS.
This document self is the design specification of the hardware and therefore part of the design method.
The hardware for this design will be a Tweet writer for a white board.
It is specifically chosen to cover the different aspects of the design method.


+ 39
- 0
specifications/system/content/specifications.tex Bestand weergeven

@@ -0,0 +1,39 @@
\chapter{Specifications}

\section{Format}
To be able to show a tweet:
\begin{itemize}
\item The Writer shall be able to write at least 50 characters per line.
\item The Writer shall be able to write at least 5 lines of text.
\item The Writer shall display the author, time, content, and number of retweets, favorites and replies in plain-text.
\item The Writer shall plot characters with a size that is readable from 4 meters for a person with good eyesight.
\item The Writer shall plot in a regular used font with corresponding character spacing.
\item When a new tweet is send to the Writer, the Writer, shall wipe the existing tweet and write down a new tweet.
\item If the Writer is not wiping or writing then the Writer shall not obstruct the view of the whiteboard.
\item While writing, the Writer shall have a writing speed of at least 1 character per second.
\item If the Writer is tasked to wipe the tweet, the Writer shall wipe the tweet within 60 seconds
\item When a reset-signal is send to the Writer, the Writer shall recalibrate its position on the board.
\item When a wipe-signel is send to the Writer, the Writer shall wipe the board clean.
\item The Writer shall not damage itself.
\end{itemize}

\section{Construction}
The following limitations are based on the limited tools to that are available to me, the designer and developer.
The lab of the university is closed for everybody including technical staff as a reaction to the anti-CoViD-19 measures.
As a result I am bounded to my own tools and materials that I can afford.
\begin{itemize}
\item The Writer shall not exceed a total cost in materials and/or tools of €200.
\item The Writer shall be constructed with simple tools in the following list:
\begin{itemize}
\item Screwdrivers (Hex/Inbus, Torx, Philips, etc) in a, although limited, wide variation of size.
\item Drill
\item Screwtap set
\item Jigsaw
\item Wrenches
\item Soldering iron
\item Various Pliers
\item PLA 3D printer
\end{itemize}
\item The Writer shall not contain elements that can harm anyone during construction or operation.
\end{itemize}


+ 19
- 0
specifications/system/document.tex Bestand weergeven

@@ -0,0 +1,19 @@
\documentclass[final,english,titlepage,nomath]{siltex-report}
\include{preamble}

\title{Design Specifications}
\subtitle{}
\course{}
\faculty{\large Electrical Engineering, Mathematics and Computer Science}
\author{%
Wouter Horlings
}

\begin{document}
\maketitle
\input{introduction}
\input{description}
\input{specifications}


\end{document}

Laden…
Annuleren
Opslaan