From e643adac666aad553ef78408dada3e00cedf87d3 Mon Sep 17 00:00:00 2001 From: rainierwolfcastle Date: Tue, 19 May 2015 11:32:51 +0300 Subject: [PATCH 1/2] fix formatting bug --- Docs/GettingStarted/Intro.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Docs/GettingStarted/Intro.md b/Docs/GettingStarted/Intro.md index 650f2ed..17dfea9 100644 --- a/Docs/GettingStarted/Intro.md +++ b/Docs/GettingStarted/Intro.md @@ -60,6 +60,7 @@ Go to [connector-sample-webapp](https://github.com/ARMmbed/connector-sample-weba ### Using the website The front page contains a form with fields for your API Token and your domain. + 1. Copy your API token and your domain into the form and click the "Get My Devices" button. 2. Your devices should then appear in a new page. The button presses column should change when you press the SW2 button on your mbed. 3. Press the SW2 button on your mbed and watch the counter increase. From 97a9f556d55e9db31283a3581d3fcdc2f168a786 Mon Sep 17 00:00:00 2001 From: Irit Arkin Date: Tue, 19 May 2015 09:55:08 +0100 Subject: [PATCH 2/2] Update Intro.md Edited it a bit. Note that I added the serial port driver link for Windows users. --- Docs/GettingStarted/Intro.md | 56 ++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/Docs/GettingStarted/Intro.md b/Docs/GettingStarted/Intro.md index 17dfea9..92477fa 100644 --- a/Docs/GettingStarted/Intro.md +++ b/Docs/GettingStarted/Intro.md @@ -4,63 +4,63 @@ This document describes how to get started with the Device Connector. ## Required hardware -* A [FRDM-K64F](http://developer.mbed.org/platforms/frdm-k64f/) board -* An ethernet connection to the internet -* An ethernet cable -* A micro-USB cable +* An [FRDM-K64F](http://developer.mbed.org/platforms/frdm-k64f/) board. +* An Ethernet connection to the internet. +* An Ethernet cable. +* A micro-USB cable. -## Required Software +## Required software -* [Yotta](http://docs.yottabuild.org/#installing) - to build example programs +* [yotta](https://github.com/ARMmbed/yotta): used to programs. Please note that **yotta has its own set of dependencies**, listed in the [installation instructions](http://armmbed.github.io/yotta/#installing-on-windows). +* [ARM GCC toolchain](https://launchpad.net/gcc-arm-embedded). Refer to the yotta installation page (above) for instructions on how to install the toolchains. +* If your OS is Windows, please follow the installation instructions [for the serial port driver](https://developer.mbed.org/handbook/Windows-serial-configuration). ## Setting up the environment -There are 3 main phases to this example: +There are three main phases to this example: + - Setting up an account. -- Configure example mbed program with server address, build with yotta, load onto board, plug board into ethernet. +- Configuring an example mbed program with a server address, building with yotta, loading onto board and connecting the board using Ethernet. - Deploying a sample web app. ### Create a Device Connector account -1. Go to the [Device Connector](connector.mbed.org) and login using your mbed.org username and password. -2. After you've logged in, make a note of your domain. Your domain is printed in the top right hand side of the website. -3. Click on the API Tokens tab along the top of the screen and create a new API token. Make a note of your API token. +1. Go to the [Device Connector site](http://connector.mbed.org) and log in using your mbed.org username and password. +2. Make a note of your domain. It's printed in the top right-hand side of the website. +3. Click on the API Tokens tab at the top of the screen and create a new API token. Make a note of your API token. -### mbed Build instructions +### mbed build instructions #### Building -1. Connect the frdm-k64f to the internet using the ethernet cable -2. Connect the frdm-k64f to the computer with the micro-USB cable, being careful to use the micro-usb port labled "OpenSDA" -3. Install Yotta. See instructions from [Yotta](http://docs.yottabuild.org/#installing) -4. Install needed toolchains (arm-none-eabi-gcc). Refer to the yotta installation page (in step 1 above) for instructions on how do install the toolchains. -5. Clone **connector-mbed-client** from [connector-mbed-client](https://github.com/ARMmbed/connector-mbed-client) -6. Change to the connector-mbed-client directory e.g. `cd connector-mbed-client` -7. Open file main.cpp, edit your domain in place of `CS_DOMAIN = xxxx`. For example, if your domain is `abc123`, you would enter `abc123` -8. Set up target device, `yotta target frdm-k64f-gcc` -9. Type `yotta build` +1. Connect the FRDM-K64F to the internet using the Ethernet cable. +2. Connect the FRDM-K64F to the computer with the micro-USB cable, being careful to use the micro-USB port labeled "OpenSDA". +3. Clone **connector-mbed-client** from [connector-mbed-client](https://github.com/ARMmbed/connector-mbed-client). +4. Open the file `main.cpp` and replace `CS_DOMAIN = xxxx` with your domain. For example, if your domain is `abc123`, you would enter `CS_DOMAIN = abc123`. +5. Open a terminal and navigate to the connector-mbed-client directory (e.g. `cd connector-mbed-client`). +6. Set up the target device by entering `yotta target frdm-k64f-gcc`. +7. Enter `yotta build`. The binary file will be created in the `build/frdm-k64f-gcc/source` folder. #### Flashing to target device -1. Plug in the USB cable in J26 port on the K64F board and other end into a USB port on your computer. -2. Drag and drop the binary file to -board's usb mass storage device. This will flash the binary to target MCU after reset. You can find the binary file in `build/frdm-k64f-gcc/test/connector-mbed-client` with following name `connector-mbed-client.bin`. +1. Plug the USB cable into the J26 port on the K64F board. Plug the other end into a USB port on your computer. The board will be listed as a USB mass storage device. +2. Your binary file will be under `build/frdm-k64f-gcc/test/connector-mbed-client` and its name will be `connector-mbed-client.bin`. Drag and drop the binary file to the board. This will flash the binary to the target MCU. 3. Press the reset button to run the program. ## Deploying a sample web app -This repository contains a simple web site that demonstrates the use of the Device Connector's web API. +This repository contains a simple website that demonstrates the use of the Device Connector's web API. ### One click deploy to Heroku -Go to [connector-sample-webapp](https://github.com/ARMmbed/connector-sample-webapp) and click on the purple "Deploy to Heroku" button. Once deployed go to your newly created web site. +Go to [connector-sample-webapp](https://github.com/ARMmbed/connector-sample-webapp) and click on the purple "Deploy to Heroku" button. Once deployed go to your newly created website. ### Using the website The front page contains a form with fields for your API Token and your domain. 1. Copy your API token and your domain into the form and click the "Get My Devices" button. -2. Your devices should then appear in a new page. The button presses column should change when you press the SW2 button on your mbed. -3. Press the SW2 button on your mbed and watch the counter increase. +2. Your devices should then appear in a new page. +3. The Button Presses column shows how many times the SW2 button on your mbed has been pressed. Press the SW2 button on your mbed and watch the counter increase.