xref: /btstack/doc/manual/btstack_gettingstarted.tex (revision 0db2ac53f3d7e240172208833838512c74dc591e)
1\UseRawInputEncoding
2\documentclass[a4paper,titlepage,oneside,12pt]{amsart} %amsart
3\usepackage{graphicx}
4\usepackage[colorlinks=true]{hyperref}
5%\usepackage{geometry} % see geometry.pdf on how to lay out the page. There's lots.
6\usepackage[margin=1.3in]{geometry}
7\geometry{a4paper} % or letter or a5paper or ... etc
8% \geometry{landscape} % rotated page geometry
9\usepackage{ifthen}
10\usepackage{longtable}
11
12% See the ``Article customise'' template for come common customisations
13\usepackage[usenames,dvipsnames]{color}
14
15\usepackage[table]{xcolor}
16
17\definecolor{lightgray}{RGB}{245, 245, 245}
18\definecolor{bkblue}{RGB}{18, 47, 76}
19\definecolor{bklightblue}{RGB}{102, 131, 158}
20\definecolor{mygreen}{rgb}{0,0.6,0}
21\definecolor{orange}{RGB}{255,153,0}
22
23\usepackage{opensans}
24\usepackage{setspace}
25\usepackage{booktabs} \newcommand{\ra}[1]{\renewcommand{\arraystretch}{#1}}
26
27\usepackage{color}
28
29% show todos
30\newcommand{\todo}[1]{\colorbox{yellow}{#1}}
31% ignore todos
32% \newcommand{\todo}[1]{}
33
34\newcommand{\toread}[1]{{\color{bklightblue} #1}}
35
36\usepackage{listings}
37\lstset{ %
38float,
39language=C,                % choose the language of the code
40basicstyle=\footnotesize,       % the size of the fonts that are used for the code
41%numbers=left,                   % where to put the line-numbers
42%numberstyle=\footnotesize,      % the size of the fonts that are used for the line-numbers
43%stepnumber=1,                   % the step between two line-numbers. If it is 1 each line will be numbered
44%numbersep=5pt,                  % how far the line-numbers are from the code
45backgroundcolor=\color{lightgray},  % choose the background color. You must add \usepackage{color}
46showspaces=false,               % show spaces adding particular underscores
47showstringspaces=false,         % underline spaces within strings
48showtabs=false,                 % show tabs within strings adding particular underscores
49frame=single,           % adds a frame around the code
50framerule=0.2pt,
51tabsize=2,          % sets default tabsize to 2 spaces
52captionpos=b,           % sets the caption-position to bottom
53breaklines=true,        % sets automatic line breaking
54breakatwhitespace=false,    % sets if automatic breaks should only happen at whitespace
55escapeinside={\%*}{*)},          % if you want to add a comment within your code
56belowcaptionskip=5em,
57aboveskip=\baselineskip,
58belowskip=\baselineskip,
59commentstyle=\itshape\color{mygreen},
60keywordstyle=\bfseries\color{black},
61identifierstyle=\color{black},
62stringstyle=\color{blue},
63morekeywords={*, btstack_timer_source_t, btstack_data_source_t, uint32_t, uint16_t, uint8_t, btstack_run_loop_TYPE, le_command_status_t, gatt_client_t,
64 							gatt_client_characteristic_t, gatt_client_service_t, gatt_client_characteristic_descriptor_t, service_record_item_t, bd_addr_t, btstack_packet_handler_t,
65							hci_cmd_t, btstack_control_t, btstack_link_key_db_t, link_key_t, device_name_t, hci_transport_t, hci_uart_config_t, sdp_query_event_t,
66							sdp_query_complete_event_t, sdp_client_query_rfcomm_service_event_t, sdp_parser_event_t, sdp_parser_event_type_t,
67							sdp_parser_attribute_value_event_t, sdp_parser_complete_event_t, advertising_report_t, gc_state_t, le_service_event_t,
68							le_characteristic_event_t}
69}
70
71\newcommand{\versionNr}{1.0}
72\newcommand{\authorMila}{Dr. sc. Milanka Ringwald}
73\newcommand{\authorMatthias}{Dr. sc. Matthias Ringwald}
74\newcommand{\bkContact}{\href{[email protected]}{[email protected]}}
75\newcommand{\barWidth}{0.3cm}
76\newcommand{\urlfoot}[2]{\href{#1}{{\color{blue} #2}}\footnote{#1}}
77
78\makeatletter
79\renewcommand{\maketitle}{
80  \begin{titlepage}
81    \fosfamily
82    \begin{center}
83    \begin{minipage}[b]{\textwidth}
84        \begin{minipage}[b]{.1\textwidth}
85            \color{bkblue}\rule{\barWidth{}}{22cm}
86        \end{minipage}
87        \hfill\begin{minipage}[b]{.8\textwidth}\begin{flushright}
88            {\color{bkblue}
89            VERSION \versionNr{} \\
90            \today \\}
91            \vspace*{7.5cm}
92            \hfill\includegraphics[width=0.85\textwidth]{picts/bklogo.pdf}
93            \vspace*{1.5cm}
94            \begin{spacing}{2}
95                {\huge \color{bkblue} \@title} \\
96                {\Large \color{bklightblue} Including Quickstart Guide}
97            \end{spacing}
98            \vspace*{1.5cm}
99            {\color{bkblue}\large \authorMila \\
100            \large \authorMatthias \\
101            \large \bkContact\\ }
102        \end{flushright}\end{minipage}
103        \vfill
104        \begin{minipage}[b]{\textwidth}
105            \color{bklightblue}\rule{\barWidth{}}{\barWidth{}}
106        \end{minipage}
107    \end{minipage}
108
109
110    \end{center}
111  \end{titlepage}
112}
113\makeatother
114
115\title[BTstack Manual] {BTstack Manual}
116\author{Copyright \copyright 2012-2015 BlueKitchen GmbH}
117
118%%% BEGIN DOCUMENT
119
120\newcommand{\UserGuide}{\urlfoot{http://processors.wiki.ti.com/index.php/PAN1315EMK\_User\_Guide\#RF3\_Connector}{User Guide}{}}
121\newcommand{\MSPGCCWiki}{\urlfoot{http://sourceforge.net/apps/mediawiki/mspgcc/index.php?title=MSPGCC\_Wiki}{MSPGCC Wiki}}
122\newcommand{\GNUMake}{\urlfoot{http://gnuwin32.sourceforge.net/packages/make.htm}{GNU Make}}
123\newcommand{\Python}{\urlfoot{http://www.python.org/getit/}{Python}}
124\newcommand{\mspgcc}{\urlfoot{http://sourceforge.net/projects/mspgcc/files/Windows/mingw32/}{mspgcc}}
125\newcommand{\BTSfile}{\urlfoot{http://processors.wiki.ti.com/index.php/CC256x\_Downloads}{BTS file}}
126\newcommand{\MSPFlasher}{\urlfoot{http://processors.wiki.ti.com/index.php/MSP430\_Flasher\_-\_Command\_Line\_Programmer}{MSP430Flasher}}
127\newcommand{\MSPDebug}{\urlfoot{http://mspdebug.sourceforge.net/}{MSPDebug}}
128\newcommand{\BtstackGithub}{\urlfoot{https://github.com/bluekitchen/btstack/archive/master.zip}{BTstack's page}}
129\newcommand{\gccarm}{\urlfoot{https://launchpad.net/gcc-arm-embedded}{arm-gcc}}
130\newcommand{\OpenOCD}{\urlfoot{http://openocd.org}{OpenOCD}}
131\newcommand{\mplabxc}{\urlfoot{http://www.microchip.com/pagehandler/en\_us/devtools/mplabxc/}{MPLAB XC}}
132\newcommand{\PICkit}{\urlfoot{http://www.microchip.com/DevelopmentTools/ProductDetails.aspx?PartNO=pg164130}{PICkit 3}}
133\newcommand{\pkgconfig}{\urlfoot{http://www.freedesktop.org/wiki/Software/pkg-config/}{pkg-config}}
134\newcommand{\libusb}{\urlfoot{www.libusb.org}{libusb}}
135\newcommand{\Zadig}{\urlfoot{http://zadig.akeo.ie}{Zadig}}
136\newcommand{\MSYS}{\urlfoot{www.mingw.org/wiki/msys}{MSYS}}
137\newcommand{\MINGW}{\urlfoot{www.mingw.org}{MINGW32}}
138
139%% pandoc-tablenos: required package
140\usepackage{caption}
141
142%% pandoc-tablenos: environment to disable table caption prefixes
143\makeatletter
144\newcounter{tableno}
145\newenvironment{tablenos:no-prefix-table-caption}{
146  \caption@ifcompatibility{}{
147    \let\oldthetable\thetable
148    \let\oldtheHtable\theHtable
149    \renewcommand{\thetable}{tableno:\thetableno}
150    \renewcommand{\theHtable}{tableno:\thetableno}
151    \stepcounter{tableno}
152    \captionsetup{labelformat=empty}
153  }
154}{
155  \caption@ifcompatibility{}{
156    \captionsetup{labelformat=default}
157    \let\thetable\oldthetable
158    \let\theHtable\oldtheHtable
159    \addtocounter{table}{-1}
160  }
161}
162\makeatother
163
164
165%level -1: part, 0: chapter, 1: section, etc.
166\setcounter{tocdepth}{3}
167
168\begin{document}
169
170\maketitle
171\hypersetup{linkcolor=blue}
172\hypersetup{urlcolor=blue}
173\hypersetup{citecolor=blue}
174
175\tableofcontents
176\pagebreak
177
178
179\input{btstack_final}
180
181\end{document}