summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamuli Piippo <samuli.piippo@digia.com>2013-10-11 11:46:45 +0300
committerSamuli Piippo <samuli.piippo@digia.com>2013-10-14 08:39:29 +0300
commit7281b8851573c325a72da008245d54e06516e2d2 (patch)
tree63481f2e0ca69ebfe8fa4a4df453eb582f4a9299
parent8b72d8990033af83b7b44871d5af3e61c965fc72 (diff)
Doc: Add documentation for raspberry Pi
Change-Id: If57154ba74595a1f52802d81908d333924319e7d Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com> Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
-rw-r--r--src/doc/src/b2qt-post-install-setup.qdocinc24
-rw-r--r--src/doc/src/b2qt.qdoc69
2 files changed, 93 insertions, 0 deletions
diff --git a/src/doc/src/b2qt-post-install-setup.qdocinc b/src/doc/src/b2qt-post-install-setup.qdocinc
index 4733aa8..8d1a58c 100644
--- a/src/doc/src/b2qt-post-install-setup.qdocinc
+++ b/src/doc/src/b2qt-post-install-setup.qdocinc
@@ -41,6 +41,7 @@
To do so, connect your device to your computer via USB and launch
Qt Creator (\B2Q IDE). Then,
+//! [steps for device kit]
\list 1
\li Go to \b{Tools > Options > Build & Run > Kits}
\li Select one of the predefined Kits starting with \e{Boot2Qt...}
@@ -48,5 +49,28 @@
\li Select the correct device in the \b{Device} combobox.
\li Click \b{Ok}.
\endlist
+//! [steps for device kit]
//! [configuring device kit]
+
+//! [configuring network device]
+ After the hardware has been prepared, there are final steps required
+ to set up the development tools in Qt Creator for your device.
+
+ To do so, connect your device to network via ethernet cable and launch
+ Qt Creator (\B2Q IDE). Then,
+
+ \list 1
+ \li Go to \b{Tools > Options > Devices}
+ \li Click \b{Add...}
+ \li Select \b{Boot2Qt Device} and Click \b{Start Wizart}
+ \li Fill in name of the device and network address. Device address can be seen from
+ \e{Launcher Settings} when device is running \B2Q demo
+ \li Click \b{Finish}.
+ \endlist
+
+ You also have to configure the right device to be used for each \b{Kit}.
+
+ \include b2qt-post-install-setup.qdocinc steps for device kit
+
+//! [configuring network device]
*/
diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc
index 341dfac..2489a54 100644
--- a/src/doc/src/b2qt.qdoc
+++ b/src/doc/src/b2qt.qdoc
@@ -33,6 +33,7 @@
\li \l{Preparing Nexus 7}{Nexus 7 (embedded Android)}
\li \l{Preparing Sabre Lite i.MX 6}{Sabre Lite i.MX 6 (embedded Android)}
\li \l{Preparing BeagleBoard-xM}{BeagleBoard-xM (embedded Android and Linux)}
+ \li \l{Preparing Raspberry Pi}{Raspberry Pi (embedded Linux)}
\endlist
\li \b {\l{Building and Running an Example}}
\li \b {\l{Customization}}
@@ -232,6 +233,7 @@
\li \l{Nexus 7 (embedded Android)}
\li \l{Sabre Lite i.MX 6 (embedded Android)}
\li \l{BeagleBoard-xM (embedded Android and Linux)}
+ \li \l{Raspberry Pi (embedded Linux)}
\endlist
If you are only using the emulator, you can skip this step
@@ -542,6 +544,73 @@
*/
/*!
+ \target Raspberry Pi (embedded Linux)
+ \page b2qt-preparing-hardware-rasberrypi.html
+ \title Preparing Raspberry Pi
+ \previouspage b2qt-installation-guide.html
+ \nextpage b2qt-building-and-running.html
+
+ When using a \l{http://www.raspberrypi.org/}{Raspberry Pi} as a
+ development device, following steps are required to prepare it for
+ \B2Q.
+
+ \note \b{It is important that the steps in this section are repeated
+ every time after updating the \B2Q SDK.}
+
+ The images containing \B2Q stack for Raspberry Pi is included in the SDK,
+ ready to be copied to a micro-SD card.
+
+ \section1 Preparing a Micro-SD Card
+
+ For \B2QL, a card of at least 512MB capacity is sufficient.
+
+ Plug the micro-SD card/reader into the development host PC and use
+ the following command to find out its device path
+ (i.e. \c{/dev/XXX}, where \c{XXX} typically is \c{sdb}):
+
+ \code
+ df -h
+ \endcode
+
+ Alternatively, if the micro-SD card is unformatted, run the following
+ command immediately after inserting the card to see its device
+ path:
+
+ \code
+ dmesg | tail
+ \endcode
+
+ Now make sure the micro-SD card is not mounted:
+
+ \code
+ umount /dev/XXX
+ \endcode
+
+ \section1 Installing the \B2Q Image
+
+ Write the image to the micro-SD card:
+
+ \code
+ cd <SDK_INSTALL_DIR>
+ Boot2Qt-1.0/raspberrypi-eLinux/images/deploy.sh /dev/XXX
+ \endcode
+
+ \warning \b{Make very sure you select the right device. Selecting the wrong
+ one can result in a wiped hard drive}.
+
+ After the image has been deployed, power up the device and confirm that it shows
+ a \B2Q welcome screen and/or demo.
+
+ \section1 Configuring a Device Kit in Qt Creator
+
+ \include b2qt-post-install-setup.qdocinc configuring network device
+
+ \b {You are now ready to start developing for your device!}
+
+ See \l{Building and Running an Example}
+*/
+
+/*!
\page b2qt-building-and-running.html
\title Building and Running an Example
\previouspage b2qt-installation-guide.html