dynamoDBChallenge

This repo contains:

• Helper functions to work progammatically with a previously created table in DynamoDB
• Scripts to run the helper functions
• An application that sets up some routes to allow a device to send data to DynamoDB (NOT FULLY DEVELOPED OR TESTED AT ALL!!)
• Tools to help generate data to load into a prevously created table.

The Data Collar

The dog collar contains a 9 DOF motion sesnor, a microphone, an ADC(audio processing), SPIflash, and a GPS IC. #####The Idea: When the motion sensor detects motion or the microphone picks up frequencies that indicate barking, the device will begin to poll the sensors and wrtie data to spiflash. Every two seconds a payload of the collected motion, audio, and gps data will be sent to DynamoDB.

Get Started with this Repo

1. Download Nodejs from https://nodejs.org/en/download/

2. Clone the dynamoDbChallenge repository

   git clone https://github.com/eckhartp/dynamoDBChallenge.git

3. cd into the directory of the cloned repo.

   cd dynamoDBChallenge

4. Install the required node modules

   npm install

   NOTE: On a Unix system, you may need to use sudo: sudo npm install.

Set Credentials

To access AWS programmatically, an access key is required to verify your identity and the identity of your applications. An access key consists of an access key ID and a secret access key. These credentials need to be stored locally on your computer. A shared credentials file can be used or environment variables can be set.

Shared Credntials file

1. In a text editor paste the following:

    [default]
    aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
    aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY
   

2. Save the file as credential with no extenstion in .aws folder that you create using the following command:

   Windows:

   mkdir "%UserProfile%\.aws
   

   Linux:

   mkdir ~/.aws
   

Environment Variables

If you would prefer to set temporary environment variables, run the following commands from the terminal. The credentials will only be set for the current termainal session. They will not persist to a new terminal or restart.

$env:AWS_SECRET_ACCESS_KEY=<YOUR AWS SECRET ACCESS KEY> $env:AWS_ACCESS_KEY_ID=<YOUR AWS KEY ID>

Your AWS_SECRET_ACCESS_KEY and AWS_ACCESS_KEY_ID can be obtained by logging into your AWS account and choosing sercurity credentials from the drop down menu with your username.

Set Congiuration

1. In a text editor paste the following:

    module.exports = {
        aws_table_name: 'Your table name',
        aws_local_config: {
            region: 'aws region',
            endpoint: 'https://dynamodb.<awsregion>.amazonaws.com'
        }
    };
   

2. Create a folder named config.

3. Save the file as ./config/config

Ready to Run

Scripts

The src/scripts folder contains node scripts to demonstrate how to use the helper functions found in lib/dynamoDB.js. Below is a brief description of each script.

Run node scriptName.js to execute the script.

Script	Description
batchGetItem.js	Gets a batch of items with the specified partition keys and sort keys. Requires an array of objects. Each object must contain a partition key and a sort key
batchPutItem.js	Writes a batch of items to DynamoDB. Requires an array of objects
conditionalDeleteItem.js	Deletes an item from the table if it meets the specifed condition. Requires partiton key, sort key, and condtional expression
deleteItem.js	Deletes the time with the specified parition key and sort key
getItem.js	Gets an item with the specified partition key and sort key
incrementCounter.js	Increments the specified counter. These counters are indented to track different types of activity
putItem.js	Adds the defined item to the table
query.js	retrieves items
queryTable.js	retrieves items with the specified attributes
scanTable.js	reads every item in the table and returns all the data
updateItem.js	updates the specified item with the specified attributes
app.js	This is an untested script that contains some routes to implement further

-: **The scripts default to using the table named 'code-challenge-203'. To change the name of the table, redefine the const TABLE_NAME found in lib/dynamoDB.js