ASCEND_API

README

Please refer to Documentation.pdf for more complete documentation

Installation

pip install -r requirements.txt

Main API code: app.py

Tests: test.py

Database: ascend.db

Endpoint 1

/device/user_name

GET returns basic info on all devices owned by <user_name>

Example: http://54.172.7.149:8080/device/andrew_merrin

Endpoint 2

/device/full/id

GET returns full information about a device with

Example: http://54.172.7.149:8080/device/full/1

Endpoint 3

device/control/id #GET

device/control/id {updated_parameters: updated values} #PATCH

GET returns controlable infomration associated with

PATCH updates and then returns updated controlable infomration associated with

Example http://54.172.7.149:8080/device/control/2

Endpoint 4

device/control/id,timeframe,attribute,data_points

GET returns timeseries information about for device with

timeframe -> month, week, day, hour, minute

attribute -> temp, operating_hours, analogue_in, spool_position, pressure, flow_torque, uptime, cycles, issues

Example http://54.172.7.149:8080/device/history/1,month,temp,10

Overview of Documentation