NCTU Programming Marathon / Program5_mbedConnectorQuickstart

mbed connector webapp quickstart

README.md@0:3ffbcdb3b8cd, 2017-03-13 (annotated)

Committer:
group-NCTU-Programming-Maratho
Date:
Mon Mar 13 02:43:00 2017 +0000
Revision:
0:3ffbcdb3b8cd
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 1 # mbed-connector-python-quickstart
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 2 This is a quickstart application for the [mbed-connector-api-python](https://github.com/armmbed/mbed-connector-api-python) package.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 3 The goal of this application is to get the user up and running, using the mbed-connector-python package and talking to devices through mbed Device Connector in under 5 min, 5 steps or less.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 4 The quickstart webapp is meant to be paired with the [quickstart embedded app](https://github.com/ARMmbed/mbed-client-quickstart). The quickstart web app will allow the user to visualize quickstart embedded devices and interact with them.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 5
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 6 ### Pre-requisites
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 7 - A [mbed connector](https://connector.mbed.com) account and have generated an [API token](https://connector.mbed.com/#accesskeys)
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 8 - A endpoint running the [mbed client quickstart example](https://github.com/ARMmbed/mbed-client-quickstart)
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 9 - Install the required packages `pip install -r requirements.txt`
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 10
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 11 ### Use
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 12 1. Put your [API key](https://connector.mbed.com/#accesskeys) into the app.py file, replace the following text
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 13 ```python
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 14 token = "Change Me" # replace with your API token
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 15 ```
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 16 or set an evironment variable called `ACCESS_KEY` with the value of your API key
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 17 2. Run the `app.py` file
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 18 ```python
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 19 python ./app.py
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 20 ```
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 21 3. Open a web page to the web.py server. Usually [//localhost:8080](//localhost:8080) will work.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 22 4. Interact with the web page, blink the LED's, subscribe to the resources, click the button on the board and see the numbers tick up on the web app.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 23 {{TODO: insert gif's here}}
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 24 5. Modify : go checkout the API for the [mbed-connector-api-python library](https://docs.mbed.com/docs/mbed-connector-api-python/en/latest/) and make your own applications!
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 25
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 26
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 27 ## Troubleshooting
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 28 Here are some common problems and their solutions.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 29
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 30 ##### Cannot establish a secure connection
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 31 This is most likely caused by not having the `requests[security]` package installed. If you are using Ubuntu 14.4 LTS you may need to update pip first `pip install -U pip` and then install the requests security package `pip install -U requests[security]`.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 32
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 33 ##### WebSocket transport not available
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 34 Dont worry about that warning message, it is not applicable to this demo, but likewise the warning message cannot be disabled.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 35
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 36 ##### ERROR 500 on trying to run the app.py file
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 37 Make sure you added your [Access Key](https://connector.mbed.com/#accesskeys) to the app. You can do this by either changing the value of the `token` variable in the app.py file or by setting the `ACCESS_KEY` environment variable to your access key.
group-NCTU-Programming-Maratho 0:3ffbcdb3b8cd 38