Kai Ren / client

Files at this revision

API Documentation at this revision

Comitter:
krenbluetoothsig
Date:
Wed May 02 13:09:22 2018 +0000
Parent:
3:608b3e14dd31
Child:
5:ac22dae133d2
Commit message:
client; 1. CHG: README is ready. ; 2. still wait for EULA.

Changed in this revision

README.txt Show annotated file Show diff for this revision Revisions of this file
--- a/README.txt	Wed May 02 10:46:46 2018 +0000
+++ b/README.txt	Wed May 02 13:09:22 2018 +0000
@@ -27,48 +27,30 @@
 
 2. copy zip file into './zephyr/sample/' in the Zephyr tree. 
 
-3. unzip the file and perform "exact here"
+3. unzip the file by "Extract Here". 
+
+3. access into the extracted folder and rename prj_bbc_microbit.txt to prj_bbc_microbit.conf
 
-3. type following commands on your Zephyr console if using Windows Command Prompt
-"
-     cd %ZEPHYR_BASE%\samples\
+4. if adopting Windows Command Prompt, use it to access into the unzip folder and
+   type following commands on the console:
+
      mkdir build & cd build
      cmake -GNinja -DBOARD=bbc_microbit ..
      ninja
-"
-
-or type following commands on your Zephyr console if using MSYS2
-cd %ZEPHYR_BASE%\samples\hello_world
-mkdir build & cd build
-
-# Use cmake to configure a Ninja-based build system:
-cmake -GNinja -DBOARD=nrf52_pca10040 ..
-
-# Now run ninja on the generated build system:
-ninja
-
-.. _ble_mesh:
-
-Bluetooth: Mesh
-
-
 
 
-* A board with Bluetooth LE support, or
-* QEMU with BlueZ running on the host
-
+   if adopting MSYS2, use it to access into the unzip folder and type following commands
+   on the console:
 
-
-See :ref:`bluetooth setup section <bluetooth_setup>` for details on how
-to run the sample inside QEMU.
+     mkdir build & cd build
+     cmake -GNinja -DBOARD=bbc_microbit ..
+     ninja
 
-For other boards, build and flash the application as follows:
+5. connect micro:bit with your computer by USB cable, the board will be enumerated as a massive
+   storage device;
 
-.. zephyr-app-commands::
-   :zephyr-app: samples/bluetooth/mesh
-   :board: <board>
-   :goals: flash
-   :compact:
+6. drag the hex file (which is in './zephyr/sample/[unzip folder]/build/zephyr/zephyr.hex') into 
+   Microbit massive storage device to flash the firmware;
+   
+7. micro:bit is ready to work as a GenericOnOff client. 
 
-Refer to your :ref:`board's documentation <boards>` for alternative
-flash instructions if your board doesn't support the ``flash`` target.