Skip to content

These are the supporting files needed to set up the GWearCloud system. Use of this system requires a free-tier AWS account at minimum.

License

Notifications You must be signed in to change notification settings

gwulilab/GWearCloud

Repository files navigation

GWearCloud

These are the supporting files needed to set up the GWearCloud system. Use of this system requires a free-tier AWS account at minimum.

Documentation for the system can be found here.

What is Included

The releases on this repo contain every file that is needed to set up GWearCloud. A description of each included file can be found below.

GWearCF.json

CloudFormation template to set up the entire system. This file should be run on your account.

GWearCloud-GET.zip

Lambda function code for the REST API GET request. This archive should be uploaded to an Amazon S3 bucket on your account.

GWearCloud-POST.zip

Lambda function code for the REST API POST request. This archive should be uploaded to an Amazon S3 bucket on your account.

Source code (.zip and .tar.gz)

Every file in the repository in archive form.

Installation

Full installation instructions can be found in the wiki.

Example REST API Data Body

{
    "metric" : "test_measurement",
    "sensor" : "test_sensor",
    "id" : 1,
    "value" : 12.5,
    "mac" : "abc123",
    "timestamp" : 1566364870
}

Compiling Documentation

If you would like to compile the documentation for this project yourself, you can install all software dependecies by running pip install -r requirements.txt. From there, run make html or make github. This will compile the documentation as web pages.

Contributing

We welcome any contributions to the project that you feel would be beneficial. Please read this first though.

About

These are the supporting files needed to set up the GWearCloud system. Use of this system requires a free-tier AWS account at minimum.

Resources

License

Stars

Watchers

Forks

Packages

No packages published