Skip to content

Commit eab6a53

Browse files
author
Microchip Technology
committed
Fix Invalid arguments in stage deploy of Jenkins pipeline;
1 parent b46aff9 commit eab6a53

File tree

2 files changed

+38
-16
lines changed

2 files changed

+38
-16
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,47 @@
22

33
![AVR-IoT and PIC-IoT board splash art](./figures/header.png)
44

5-
**Microchip IoT Developer Guides for AWS** is a set of tutorials tailored to get started with your IoT Design, from embedded to cloud. Starting with the [sandbox](./access-the-sandbox), you can play around with sending and receiving data to the cloud with almost no setup. When you are ready, securely [connect the node to your own AWS account](./connect-the-board-to-your-aws-account) and explore an [example application](./your-first-application-sending-and-receiving-data). All the tutorials, and the recommended reading path, can be seen in the [Map of Resources](#map-of-resources).
5+
## The Survival Guide for Your Embedded to Cloud Journey
66

7-
These tutorials use the [AVR-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev15r70a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro
8-
) and [PIC-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev54y39a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro
9-
) Boards, although the discussed concept are applicable to most IoT Designs.
7+
Connecting an embedded design to the cloud can bring a wealth of benefits, such as advanced data insights and remote monitoring. But all too often, embedded designers who start off on their journey to the cloud don't make it. They fall into time sinks, succumb to skirmishes with pythons, or worst of all, *they forget about security*.
108

11-
**If you have an [AVR-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164160?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro
12-
) or [PIC-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164164?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro
13-
) board, convert it to the AWS variant (WA) by following the instructions in [this video](https://www.youtube.com/watch?v=nwP8obSRaaE)**
9+
Your embedded to cloud journey shouldn’t be stressful. It should be *an adventure* – you should enjoy it, learn a lot, end up in the right place, and you should be done before lunch.
1410

15-
[![See it in action button](figures/action-button.svg)](./access-the-sandbox)
11+
In the **Microchip IoT Developer Guides for AWS**, we have mapped out an ideal embedded to cloud journey so that you can quickly learn the basics and start designing your own deployable cloud-connected IoT application.
12+
13+
Let the adventure begin.
14+
15+
## Technical Journey
16+
17+
### Overview
18+
19+
Microchip IoT Developer Guides for AWS is a set of hands-on tutorials and technical articles curated to help you get started with integrated IoT design. You will start at the [sandbox](./access-the-sandbox), where you can explore sending and receiving data to the cloud with almost no setup. When you are ready, you will securely [connect the node to your own AWS account](./connect-the-board-to-your-aws-account) and build an [example application](./your-first-application-sending-and-receiving-data). All of the tutorials, as well as the recommended reading path, can be seen in the [Map of Resources](#map-of-resources). A short description of each tutorial can also be found in the [List of Tutorials](#list-of-tutorials) section.
20+
21+
### Hardware Requirements
22+
23+
These tutorials use the [AVR-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev15r70a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) and [PIC-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev54y39a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) Boards, although the discussed concepts are applicable to most IoT Designs.
24+
25+
*Pro Tip*: if you have an [AVR-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164160?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) or [PIC-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164164?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) board, you can convert it to the AWS variant (WA) by following the instructions in [this video](https://www.youtube.com/watch?v=nwP8obSRaaE).
26+
27+
### Software Requirements
28+
29+
Embedded projects use [MPLAB® X IDE](https://www.microchip.com/mplab/mplab-x-ide?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) and the [XC8](https://www.microchip.com/mplab/compilers?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) (AVR-IoT) or [XC16](https://www.microchip.com/mplab/compilers?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-intro) (PIC-IoT) compiler.
30+
31+
The AWS Command Line Interface is required for the [Connect the Board to your AWS Account](./connect-the-board-to-your-aws-account) tutorial.
1632

1733
## Map of Resources
1834

1935
[![Map of resources](figures/flowchart_path_legend.svg)](https://microchip-pic-avr-solutions.github.io/microchip-iot-developer-guides-for-aws-interactive-flowchart/)
2036

21-
## Tutorial List
37+
## List of Tutorials
38+
39+
### [Access the Sandbox](./access-the-sandbox)
40+
41+
An introductory tutorial that demonstrates how to connect the IoT boards to the internet in 30 seconds flat, provides real-time plotting of the board's sensor data and guides you through your first encounter with the board's firmware.
2242

2343
### [Connect the Board to your AWS Account](./connect-the-board-to-your-aws-account)
2444

25-
An introductory tutorial explaining how to securely connect either a [AVR-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev15r70a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-tutorial-list) or [PIC-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev54y39a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-tutorial-list) to Amazon Web Services® (AWS) through the AWS IoT Core Module. Introduces the [*IoT Provisioning Tool*](http://www.microchip.com/mymicrochip/filehandler.aspx?ddocname=en1001525), a tool to *provision* the board without the need to know complex cryptography.
45+
An introductory tutorial explaining how to securely connect either an [AVR-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev15r70a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-tutorial-list) or [PIC-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev54y39a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-main-tutorial-list) to Amazon Web Services® (AWS) through the AWS IoT Core Module. Introduces the [*IoT Provisioning Tool*](http://www.microchip.com/mymicrochip/filehandler.aspx?ddocname=en1001525), a tool to *provision* the board without the need to know complex cryptography.
2646

2747
### [Your First Application - Sending and Receiving Data](./your-first-application-sending-and-receiving-data)
2848

access-the-sandbox/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ The IoT Boards comes bundled with a pre-provisioned demo with a couple of tutori
55
1. Connect a [AVR-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev15r70a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox), [AVR-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164160?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox), [PIC-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev54y39a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox), or [PIC-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164164?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox) through USB
66

77
- If you have a [AVR-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164160?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox) or [PIC-IoT WG](https://www.microchip.com/DevelopmentTools/ProductDetails/ac164164?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox) board, convert it to the AWS variant (WA) by following [this video](https://www.youtube.com/watch?v=nwP8obSRaaE).
8-
9-
2. Open the `CURIOSITY` drive
10-
3. Open `CLICK-ME.htm`
11-
4. Enter your Wi-Fi Credentials and download a `WIFI.CFG` file
12-
5. Drag & Drop the `WIFI.CFG` File to the `CURIOSITY` Drive
13-
6. Wait for the board to connect. A blinking yellow light indicates that the board has connected successfully.
8+
2. Download the newest firmware and follow the instructions to install
9+
- [AVR-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev15r70a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox): https://github.com/microchip-pic-avr-solutions/avr-iot-aws-sensor-node-mplab/releases
10+
- [PIC-IoT WA](https://www.microchip.com/DevelopmentTools/ProductDetails/ev54y39a?utm_campaign=IoT-WA-DevBoards&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=microchip-iot-developer-guide-for-aws-access-the-sandbox): https://github.com/microchip-pic-avr-solutions/pic-iot-aws-sensor-node/releases
11+
4. Open the `CURIOSITY` drive
12+
5. Open `CLICK-ME.htm`
13+
6. Enter your Wi-Fi Credentials and download a `WIFI.CFG` file
14+
7. Drag & Drop the `WIFI.CFG` File to the `CURIOSITY` Drive
15+
8. Wait for the board to connect. A blinking yellow light indicates that the board has connected successfully.
1416

1517
![How to open the sandbox](figures/sandbox.gif)
1618

0 commit comments

Comments
 (0)