mirror of
https://github.com/bluekitchen/btstack.git
synced 2025-01-28 00:35:42 +00:00
manual: create pdf from markdown, todo: fix references
This commit is contained in:
Milanka Ringwald
parent
715e7c01b7
commit
6f21e9a101
@ -3,3 +3,12 @@ all:
|
||||
./update_listings.py
|
||||
mkdocs build --clean
|
||||
echo "a.toctree-l4 { display: none; }" >> btstack/css/theme_extra.css
|
||||
mkdir -p latex
|
||||
cp -r docs/picts latex
|
||||
./markdown2pdf.py
|
||||
cp btstack_gettingstarted.tex latex
|
||||
cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
|
||||
mv latex/btstack_gettingstarted.pdf .
|
||||
rm -rf latex
|
||||
|
||||
|
||||
|
||||
157
docs/manual/markdown/btstack_gettingstarted.tex
Normal file
157
docs/manual/markdown/btstack_gettingstarted.tex
Normal file
@ -0,0 +1,157 @@
|
||||
\documentclass[a4paper,titlepage,oneside,12pt]{amsart} %amsart
|
||||
\usepackage{graphicx}
|
||||
\usepackage{hyperref}
|
||||
%\usepackage{geometry} % see geometry.pdf on how to lay out the page. There's lots.
|
||||
\usepackage[margin=1.3in]{geometry}
|
||||
\geometry{a4paper} % or letter or a5paper or ... etc
|
||||
% \geometry{landscape} % rotated page geometry
|
||||
\usepackage{ifthen}
|
||||
\usepackage{longtable}
|
||||
|
||||
% See the ``Article customise'' template for come common customisations
|
||||
\usepackage[usenames,dvipsnames]{color}
|
||||
|
||||
\usepackage[table]{xcolor}
|
||||
|
||||
\definecolor{lightgray}{RGB}{245, 245, 245}
|
||||
\definecolor{bkblue}{RGB}{18, 47, 76}
|
||||
\definecolor{bklightblue}{RGB}{102, 131, 158}
|
||||
\definecolor{mygreen}{rgb}{0,0.6,0}
|
||||
\definecolor{orange}{RGB}{255,153,0}
|
||||
|
||||
\usepackage{opensans}
|
||||
\usepackage{setspace}
|
||||
\usepackage{booktabs} \newcommand{\ra}[1]{\renewcommand{\arraystretch}{#1}}
|
||||
|
||||
\usepackage{color}
|
||||
|
||||
% show todos
|
||||
\newcommand{\todo}[1]{\colorbox{yellow}{#1}}
|
||||
% ignore todos
|
||||
% \newcommand{\todo}[1]{}
|
||||
|
||||
\newcommand{\toread}[1]{{\color{bklightblue} #1}}
|
||||
|
||||
\usepackage{listings}
|
||||
\lstset{ %
|
||||
float,
|
||||
language=C, % choose the language of the code
|
||||
basicstyle=\footnotesize, % the size of the fonts that are used for the code
|
||||
%numbers=left, % where to put the line-numbers
|
||||
%numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
|
||||
%stepnumber=1, % the step between two line-numbers. If it is 1 each line will be numbered
|
||||
%numbersep=5pt, % how far the line-numbers are from the code
|
||||
backgroundcolor=\color{lightgray}, % choose the background color. You must add \usepackage{color}
|
||||
showspaces=false, % show spaces adding particular underscores
|
||||
showstringspaces=false, % underline spaces within strings
|
||||
showtabs=false, % show tabs within strings adding particular underscores
|
||||
frame=single, % adds a frame around the code
|
||||
framerule=0.2pt,
|
||||
tabsize=2, % sets default tabsize to 2 spaces
|
||||
captionpos=b, % sets the caption-position to bottom
|
||||
breaklines=true, % sets automatic line breaking
|
||||
breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace
|
||||
escapeinside={\%*}{*)}, % if you want to add a comment within your code
|
||||
belowcaptionskip=5em,
|
||||
belowskip=1em,
|
||||
aboveskip=1.8em,
|
||||
commentstyle=\itshape\color{mygreen},
|
||||
keywordstyle=\bfseries\color{black},
|
||||
identifierstyle=\color{black},
|
||||
stringstyle=\color{blue},
|
||||
morekeywords={*, timer_source_t, data_source_t, uint32_t, uint16_t, uint8_t, RUN_LOOP_TYPE, le_command_status_t, gatt_client_t,
|
||||
le_characteristic_t, le_service_t, le_characteristic_descriptor_t, service_record_item_t, bd_addr_t, btstack_packet_handler_t,
|
||||
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,
|
||||
sdp_query_complete_event_t, sdp_query_rfcomm_service_event_t, sdp_parser_event_t, sdp_parser_event_type_t,
|
||||
sdp_parser_attribute_value_event_t, sdp_parser_complete_event_t, advertising_report_t, gc_state_t, le_service_event_t,
|
||||
le_characteristic_event_t}
|
||||
}
|
||||
|
||||
% Bluetopia & TI MSP430 + Stellaris
|
||||
% http://processors.wiki.ti.com/index.php/CC256x_Bluetopia_Stack#Demos
|
||||
|
||||
% Setup MSP430+PAN1315
|
||||
%
|
||||
\newcommand{\versionNr}{1.3}
|
||||
\newcommand{\authorMila}{Dr. sc. Milanka Ringwald}
|
||||
\newcommand{\authorMatthias}{Dr. sc. Matthias Ringwald}
|
||||
\newcommand{\bkContact}{\href{contact@bluekitchen-gmbh.com}{contact@bluekitchen-gmbh.com}}
|
||||
\newcommand{\barWidth}{0.3cm}
|
||||
\newcommand{\urlfoot}[2]{\href{#1}{{\color{blue} #2}}\footnote{#1}}
|
||||
|
||||
\makeatletter
|
||||
\renewcommand{\maketitle}{
|
||||
\begin{titlepage}
|
||||
\fosfamily
|
||||
\begin{center}
|
||||
\begin{minipage}[b]{\textwidth}
|
||||
\begin{minipage}[b]{.1\textwidth}
|
||||
\color{bkblue}\rule{\barWidth{}}{22cm}
|
||||
\end{minipage}
|
||||
\hfill\begin{minipage}[b]{.8\textwidth}\begin{flushright}
|
||||
{\color{bkblue}
|
||||
% VERSION \versionNr{} \\
|
||||
\today \\}
|
||||
\vspace*{7.5cm}
|
||||
\hfill\includegraphics[width=0.85\textwidth]{picts/bklogo.pdf}
|
||||
\vspace*{1.5cm}
|
||||
\begin{spacing}{2}
|
||||
{\huge \color{bkblue} \@title} \\
|
||||
{\Large \color{bklightblue} Including Quickstart Guide}
|
||||
\end{spacing}
|
||||
\vspace*{1.5cm}
|
||||
{\color{bkblue}\large \authorMila \\
|
||||
\large \authorMatthias \\
|
||||
\large \bkContact\\ }
|
||||
\end{flushright}\end{minipage}
|
||||
\vfill
|
||||
\begin{minipage}[b]{\textwidth}
|
||||
\color{bklightblue}\rule{\barWidth{}}{\barWidth{}}
|
||||
\end{minipage}
|
||||
\end{minipage}
|
||||
|
||||
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
}
|
||||
\makeatother
|
||||
|
||||
\title[BTstack Manual] {BTstack Manual}
|
||||
\author{Copyright \copyright 2012-2015 BlueKitchen GmbH}
|
||||
|
||||
%%% BEGIN DOCUMENT
|
||||
|
||||
\newcommand{\UserGuide}{\urlfoot{http://processors.wiki.ti.com/index.php/PAN1315EMK\_User\_Guide\#RF3\_Connector}{User Guide}{}}
|
||||
\newcommand{\MSPGCCWiki}{\urlfoot{http://sourceforge.net/apps/mediawiki/mspgcc/index.php?title=MSPGCC\_Wiki}{MSPGCC Wiki}}
|
||||
\newcommand{\GNUMake}{\urlfoot{http://gnuwin32.sourceforge.net/packages/make.htm}{GNU Make}}
|
||||
\newcommand{\Python}{\urlfoot{http://www.python.org/getit/}{Python}}
|
||||
\newcommand{\mspgcc}{\urlfoot{http://sourceforge.net/projects/mspgcc/files/Windows/mingw32/}{mspgcc}}
|
||||
\newcommand{\BTSfile}{\urlfoot{http://processors.wiki.ti.com/index.php/CC256x\_Downloads}{BTS file}}
|
||||
\newcommand{\MSPFlasher}{\urlfoot{http://processors.wiki.ti.com/index.php/MSP430\_Flasher\_-\_Command\_Line\_Programmer}{MSP430Flasher}}
|
||||
\newcommand{\MSPDebug}{\urlfoot{http://mspdebug.sourceforge.net/}{MSPDebug}}
|
||||
\newcommand{\BtstackGithub}{\urlfoot{https://github.com/bluekitchen/btstack/archive/master.zip}{BTstack's page}}
|
||||
\newcommand{\gccarm}{\urlfoot{https://launchpad.net/gcc-arm-embedded}{arm-gcc}}
|
||||
\newcommand{\OpenOCD}{\urlfoot{http://openocd.org}{OpenOCD}}
|
||||
\newcommand{\mplabxc}{\urlfoot{http://www.microchip.com/pagehandler/en\_us/devtools/mplabxc/}{MPLAB XC}}
|
||||
\newcommand{\PICkit}{\urlfoot{http://www.microchip.com/DevelopmentTools/ProductDetails.aspx?PartNO=pg164130}{PICkit 3}}
|
||||
\newcommand{\pkgconfig}{\urlfoot{http://www.freedesktop.org/wiki/Software/pkg-config/}{pkg-config}}
|
||||
\newcommand{\libusb}{\urlfoot{www.libusb.org}{libusb}}
|
||||
\newcommand{\Zadig}{\urlfoot{http://zadig.akeo.ie}{Zadig}}
|
||||
\newcommand{\MSYS}{\urlfoot{www.mingw.org/wiki/msys}{MSYS}}
|
||||
\newcommand{\MINGW}{\urlfoot{www.mingw.org}{MINGW32}}
|
||||
|
||||
|
||||
%level -1: part, 0: chapter, 1: section, etc.
|
||||
\setcounter{tocdepth}{3}
|
||||
|
||||
\begin{document}
|
||||
|
||||
\maketitle
|
||||
|
||||
\tableofcontents
|
||||
\pagebreak
|
||||
|
||||
|
||||
\input{btstack_final}
|
||||
|
||||
\end{document}
|
||||
@ -42,7 +42,7 @@ events. During a run loop cycle, the callback functions of all
|
||||
registered data sources are called. Then, the callback functions of
|
||||
timers that are ready are executed.
|
||||
|
||||
For adapting BTstack to multi-threaded environments check [here](integration/#sec:multithreading).
|
||||
For adapting BTstack to multi-threaded environments check [here](integration/#adapting-btstack-for-multi-threaded-environments).
|
||||
|
||||
## No blocking anywhere
|
||||
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
|
||||
In this section, we will describe a number of examples from the
|
||||
*example/embedded* folder. To allow code-reuse with different platforms
|
||||
as well as with new ports, the low-level initialization of BTstack and
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
|
||||
In this section, we will describe a number of examples from the
|
||||
*example/embedded* folder. To allow code-reuse with different platforms
|
||||
as well as with new ports, the low-level initialization of BTstack and
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user