Code Monkey home page Code Monkey logo

airvd's Introduction

Airvd

Basic CRUD REST demo using Django REST Framework.

Used:

  • Python
    • Django + SQLite
    • Django REST Framework

Run:

  • Create virtualenv using requirements.txt
  • Run python manage.py runserver in commandline.
  • By default, server runs on port 5000.

Models/Classes:

Device

  • An IoT device with properties:

    • uid : unique id of device
    • name : name of device
  • A device measures humidity and temperature:

    • HumidityReading : one-to-many
    • TemperatureReading : one-to-many

HumidityReading

  • device : owner device
  • humidity : reading
  • timestamp : timestamp when reading was stored in db

TemperatureReading

  • device : owner device
  • temperature : reading
  • timestamp : timestamp when reading was stored in db

APIs

API to create a device

  • Endpoint: POST /api/devices/
  • Content-Type: application/json
  • Request Payload
    • uid
    • name

API to delete a device

  • Endpoint: DELETE /api/devices/{device-uid}
    • device-uid : uid of device to be deleted

API to retrieve a device

  • Endpoint: GET /api/devices/{device-uid}
    • device-uid : uid of device

API to list all devices

  • Endpoint: GET /api/devices/
  • Response: json

API to return readings for a device in given period

  • Endpoint: GET /api/devices/{device-uid}/readings/{parameter}/?start_on=yyyy-mmddTHH:MM:SS&end_on=yyyy-mm-ddTHH:MM:SS

    • device-uid : uid of device
    • parameter : temperature or humidity
    • start_on and end_on : query parameters which are compulsary and should be used to filter the result to only include data between start_on and end_on.
      • yyyy-mm-ddTHH:MM:SS : year-monthdateThour:minute:second
  • Response: json


To Improve

App can be improved on following:

  • Payload cleaning.
  • Date range matching using timezones.

Commit History Graph

Commit History Graph

airvd's People

Contributors

alpha74 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.