Skip to content

Commit 71e186c

Browse files
author
Jinesh Varia
committed
updated Readme to add Edison and new folder structure
1 parent b0bfe4f commit 71e186c

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
# Version 1 of the Experimental AWS SDK for Arduino
22

3-
An experimental SDK for contacting AWS Services on Arduino-compatible devices. Currently with DynamoDB support and potential Kinesis support.
3+
An experimental SDK for contacting AWS Services on Arduino-compatible devices. Currently it supports Amazon DynamoDB, Amazon Kinesis and Amazon SNS. More services coming soon.
44

5-
All DynamoDB operations are supported. The code for creating, serializing, and deserializing Kinesis input and output objects is included, but the devices that the experimental SDK has been tested on do not have readily available HTTPS support. This code has been included so it can be used by those who want to do further experimenting with Kinesis and HTTPS.
5+
All Amazon DynamoDB operations are supported. The code for creating, serializing, and deserializing Kinesis input and output objects is included, but the devices that the experimental SDK has been tested on do not have readily available HTTPS support. This code has been included so it can be used by those who want to do further experimenting with Kinesis and HTTPS.
66

77
The SDK is extensible to non-Arduino-compatible devices by implementing the interfaces in `DeviceIndependentInterfaces.cpp`/`.h`. See `SparkAWSImplementations.cpp`/`.h` and `GalileoAWSImplementations.cpp`/`.h` for examples of this.
88

9+
## Folder
10+
11+
/common contains all the common source code
12+
/sparkcore contains Spark IO Core device-specific implementations
13+
/edison contains Intel Edison device-specfic implementations
14+
/galileo contains Intel Galileo device-specific implementations
15+
16+
Simply copy the device-specific implementations based on the device that you are working on in the Common directory so you can test out your samples using Arduino IDE.
17+
918
Happy experimenting!
1019

1120
## Getting Started with the Samples
@@ -52,18 +61,18 @@ You can follow the steps below to get the tables set up with the right values, c
5261

5362
This step is different for the Spark Core and Intel Galileo.
5463

55-
#### Intel Galileo
64+
#### Intel Galileo/Edison
5665

57-
With Galileo you should be using the Arduino IDE for Galileo available [here](https://communities.intel.com/docs/DOC-22226).
66+
With Galileo or Edison, you should be using the Arduino IDE from Intel as it includes Galileo and Edison libraries. [Link to Intel-Arduino IDE](https://communities.intel.com/docs/DOC-22226).
5867

5968
Make an `AWSArduinoSDK` directory in the Arduino IDE's `libraries` directory (e.g. `~/Arduino/libraries/AWSArduinoSDK`).
6069

61-
Move all of the files from the SDK's `src/` directory into the `AWSArduinoSDK` directory, except the `SparkAWSImplementations` and `AmazonKinesisClient` files.
70+
Move all of the files from the SDK's `src/common` directory into the `AWSArduinoSDK` directory. Import the library.
6271

6372
Create a new sketch with the Arduino IDE and copy and paste the sample code into it.
6473

6574

66-
#### Spark Core
75+
#### Spark IO Core
6776

6877
This assumes you already have your Spark set up and are able to program it with Spark Build. If you do not, head over to [Spark's website](http://docs.spark.io/).
6978

@@ -124,7 +133,7 @@ Buttons:
124133
* Button for changing green color value should be connected to pin 8
125134
* Button for changing blue color value should be connected to pin 12
126135

127-
For Galileo, after the wiring is finished, you should be able to connect it to power, connect it to your computer via usb, and compile and upload the code with the Arduino IDE. Be sure to refer to the comments in the samples for help.
136+
For Galileo/Edison, after the wiring is finished, you should be able to connect it to power, connect it to your computer via usb, and compile and upload the code with the Arduino IDE. Be sure to refer to the comments in the samples for help.
128137

129138
For Spark, after the wiring is finished, you should be able to connect it to your computer via USB, and *Flash* the code. Be sure to refer to the comments in the samples for help.
130139

0 commit comments

Comments
 (0)