Skip to content

Commit

Permalink
Updated added rubrics database description
Browse files Browse the repository at this point in the history
  • Loading branch information
Ralf Wilke committed Oct 25, 2018
1 parent 8535725 commit 5d75b43
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions 6_Protocol_Definitions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1400,7 +1400,11 @@ \subsubsection{PUT /transmitters - Add new transmitter}
& \verb|type :| \ref{protocoldef:inputvalidation:antennatype} \\
& \verb|gain :| \ref{protocoldef:inputvalidation:antennagain}\\
& \verb|direction :| \ref{protocoldef:inputvalidation:antennadirection}\\
& \verb|agl :| \ref{protocoldef:inputvalidation:antennaagl}\\ \hline
& \verb|agl :| \ref{protocoldef:inputvalidation:antennaagl}\\
& \verb|transmit_rubrics_format :| Array with possible content "SKYPER" and "PLAIN"\\
& \verb|direction :| \ref{protocoldef:inputvalidation:antennadirection}\\ \hline


\end{tabular}
\end{table}
\FloatBarrier
Expand Down Expand Up @@ -3192,9 +3196,10 @@ \subsection{Users}
role & string & "admin"|"support"|"user"|"thirdparty.[aprs|brandmeister]" & true \\
enabled & boolean & & true \\
created\_on & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
created\_by & string & valid user name & dh3wr \\
changed\_on & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
changed\_by & string & valid user name & dh3wr \\
email\_valid & boolean & & true \\
email\_lastchecked & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
avatar\_picture & couchdb\_attachment & & \\ \hline
\end{tabular}
\label{tab:couchdb:users}
Expand All @@ -3211,12 +3216,11 @@ \subsection{Users}
"created_by": "dh3wr",
"changed_on": "2018-07-03T08:00:52.786458Z",
"changed_by":"dh3wr",
"email_valid": true
"email_lastchecked": "2018-07-03T08:00:52.786458Z",
"avatar_picture": <couchdb attachment>
}
\end{lstlisting}

\todo{Wofür genau braucht man email\_valid? - Um ab und zu mal eine Testmail an die User zu schicken, ob sie unter der Email noch erreichbar sind und sonst sie zu löschen.}

\subsection{Nodes}
\begin{table}[h]
Expand All @@ -3229,7 +3233,7 @@ \subsection{Nodes}
description & string & whatever & Aachen, Germany\\
hamcloud & boolean & true/false & true \\
created\_on & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
changed\_by & string & valid user name & dh3wr \\
created\_by & string & valid user name & dh3wr \\
changed\_on & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
changed\_by & string & valid user name & dh3wr \\
owners & [string] & N/A & ["dl1abc","dh3wr","dl2ic"] \\
Expand Down Expand Up @@ -3268,7 +3272,7 @@ \subsection{Transmitters}
coordinates & [number; 2] & [lat, lon] & [34.123456, 6.23144] \\
power & number & 0.001 ... & 12.3 \\
created\_on & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
changed\_by & string & valid user name & dh3wr \\
created\_by & string & valid user name & dh3wr \\
changed\_on & string & ISO8601 & 2018-07-08T11:50:02.168325Z \\
changed\_by & string & valid user name & dh3wr \\
owners & ARRAY of STRING & N/A & ["dl1abc","dh3wr","dl2ic"] \\
Expand Down Expand Up @@ -3304,8 +3308,16 @@ \subsection{Transmitters}
"changed_on": "2018-07-03T08:00:52.786458Z",
"changed_by": "dh3wr",
"aprs_broadcast": false,
"transmit_rubrics_format": ["SKYPER","PLAIN"],
"antenna_pattern" : <couchDB attachment>,
"avatar_picture" : <couchDB attachment>
"avatar_picture" : <couchDB attachment>,
"simplified_coverage_polygon": [34.1, -23.3, 34.1 -23.2, 34.3, -23.3],
"coverage_edges": [
[lat1, long1],
[lat2, long2],
[lat3, long3],
[lat4, long4]
]
}
\end{lstlisting}

Expand Down Expand Up @@ -3344,26 +3356,16 @@ \subsection{Rubrics}
"number": 14,
"description": "Wetter DL-HH",
"label": "WX DL-HH",
"transmitter_groups": ["dl-hh","dl-ns"],
"transmitter_groups": ["dl-hh", "dl-ns"],
"transmitters": ["db0abc"],
"cyclic_transmit": true,
"cyclic_transmit_interval": 3600, // seconds
"owner" : ["dh3wr", "dl1abc"]
}
\end{lstlisting}

\subsection{Rubric's content}
<UUID> of rubric (as defined in \ref{rubric_list})

\begin{lstlisting}
{
"_id" : "<UUID>",
"rubric": "wx-dl-hh",
"owner" : ["dh3wr", "dl1abc"],
"content": [
"message1",
..,
"message10"
],
"message1",
...,
"message10"
]
}
\end{lstlisting}

Expand Down

0 comments on commit 5d75b43

Please sign in to comment.