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