Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding graphical instructions to the docs showing how to do the cloud steps to get the demo working #14

Open
wants to merge 4 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'type: bug'
assignees: ''

---

<!--

************************************** WARNING **************************************

The ciarcom bot parses this header automatically. Any deviation from the
template may cause the bot to automatically correct this header or may result in a
warning message, requesting updates.

PLEASE ENSURE ALL SECTIONS OF THIS TEMPLATE ARE FILLED IN AND THAT THERE ARE
NO OTHER CHANGES TO THE TEMPLATE.

Only bugs should be raised here as issues. Questions or enhancements should instead be raised on
our forums:
https://forums.mbed.com/ .

*************************************************************************************

-->

### Description of defect

<!--
Add detailed description of what you are reporting.
Good example: https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html
-->


#### Target(s) affected by this defect ?


#### Toolchain(s) (name and version) displaying this defect ?


#### What version of Mbed-os are you using (tag or sha) ?
<!--
For a released version please provide the release tag (this can be found as per the instructions below)

mbed-os version can be found in:
https://github.com/ARMmbed/mbed-os/blob/master/platform/include/platform/mbed_version.h
The tag can be reconstructed as follows:
mbed-os-MBED_MAJOR_VERSION.MBED_MINOR_VERSION.MBED_PATCH_VERSION

-->


#### What version(s) of tools are you using. List all that apply (E.g. mbed-cli)


#### How is this defect reproduced ?
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,37 @@ It has been tested on K64F with Ethernet and DISCO_L475VG_IOT01A with WiFi, but

## Setting up an Azure IoT Hub account

Follow Azure IoT Hub's official documentation to

1. Create a new hub on the Azure portal ([documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal#create-an-iot-hub)). You will need a [_Standard_ tier](https://azure.microsoft.com/en-gb/pricing/details/iot-hub/) hub to enable cloud-to-device messages for this example, and a free option is available in this tier.
1. Register a new device to the hub you have created ([documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal#register-a-new-device-in-the-iot-hub)). Make a copy of the "Primary Connection String" of the device.
<!--Follow Azure IoT Hub's official documentation to -->

<!--1. Create a new hub on the Azure portal ([documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal#create-an-iot-hub)). You will need a [_Standard_ tier](https://azure.microsoft.com/en-gb/pricing/details/iot-hub/) hub to enable cloud-to-device messages for this example, and a free option is available in this tier.
1. Register a new device to the hub you have created ([documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal#register-a-new-device-in-the-iot-hub)). Make a copy of the "Primary Connection String" of the device.-->
1. Create an [Azure account](https://azure.microsoft.com/en-gb/free/)
1. Log in to your Azure account and you should see the console below. Click on "Create a resource"
![step1](./resources/Step1.jpg)
1. Click on "IoT Hub" by searching in the bar as shown below
![step2](./resources/Step2.jpg)
1. Click on "Create"
![step3](./resources/Step3.jpg)
1. Fill in the details ensuring the subscription is set to "Free Trial". Choose a resource group, region, and hub name of your choosing
![step4](./resources/Step4.jpg)
1. Ensure "Public endpoint (all networks)" is selected then click on "Next: Size and scale"
![step5](./resources/Step5.jpg)
1. Ensure price is set to "Free tier"
![step6](./resources/Step6.jpg)
1. Add a description of your device as shown below then click "Next: Review and create"
![step7](./resources/Step7.jpg)
1. Click "Create"
![step8](./resources/Step8.jpg)
1. Click "Add and configure IoT Devices"
![step9](./resources/Step9.jpg)
1. Click "New"
![step10](./resources/Step10.jpg)
1. Give an ID name to your device then click "Save"
![step11](./resources/Step11.jpg)
1. Click on the device you have just created
![step12](./resources/Step12.jpg)
1. Copy the Primary Connection String
![step13](./resources/Step13.jpg)
Comment on lines +18 to +44
Copy link
Contributor

@LDong-Arm LDong-Arm Nov 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the detailed step-by-step guide. But as an external service it may change over time, a guide (especially one based on screenshots) puts extra maintenance on us - especially one that's based on screenshots. Links may also change, but they are a lot easier to update.
I personally find the official guides (that we linked) from Microsoft fairly easy to follow. @ARMmbed/mbed-os-core Any thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed with @LDong-Arm; the instructions should not be repeated from the external website, it is a non necessary maintenance overhead for the configuration of a third-party SDK.
It would make sense to add more details if several configuration options are provided in the external guide but I don't think it is really applicable here.


Now the IoT Hub is ready for use in this example.

Expand Down
Binary file added resources/Step1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step10.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step11.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step12.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step13.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step4.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step5.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step6.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step7.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step8.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Step9.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.