Giter Club home page Giter Club logo

babybox-panel-backend's Introduction

Babybox Panel Backend Build Status Coverage Status

This repository contains a backend server in Node.js for the Babybox Panel Frontend. This project solves several problems:

  • Dealing with CORS issues when requesting data from Babybox
  • TODO: Accessing camera feed

API

The API starts with http://IP:PORT/api/v1/; and then there are 3 main endpoints:

  • units/ - for communicating with both engine and thermal unit

    • actions/ - these endpoints don't follow the standard RESTful practices; they execute some action when GET request comes
      • open/ - opens the front doors
      • openServiceDoors/ - opens the service doors (mainly for reseting the babybox state)
    • settings/ - to PUT settings data (as JSON [{ index: string, value: string, unit: "engine"|"thermal"}]; it has to be an array)
  • engine/ - for communicating with the engine unit

    • data/ - to GET all the data from the unit
    • watchdog/ - when PUT is received it will refresh the watchdog timer (babybox won't get blocked)
  • thermal/ - for communicating with the thermal unit

    • data/ - to GET all the data from the unit
  • TODO: camera/ - for communicating with the camera

There is an example request for each of these done in Postman - the exported collection is in /src/routes/__postman__/babybox-panel.postman_collection.json. The postman tests need both working units to work.

babybox-panel-backend's People

Contributors

zbyju avatar

Stargazers

 avatar

Watchers

 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.