Giter Club home page Giter Club logo

rars-api's Introduction

Rars API

This repo houses the REST API for communication with the Rars storage and retrieval system, as well as websocket support in order to communicate with the SCARA robot or event-driven scheduling system. This API will be the only external interface, and will communicate with the task scheduler and SCARA/Gantry system; relaying status updates to clients.

Currently this API does not interface with the SCARA robot directly as the communication system in the robot has not yet been defined; websocket support was added to facilitate future integrations.

Endpoints

  • store_slide (POST)
{
    "timestamp": 1221445323,            # unix number
    "payload": "KL20-12031_B_2.35.1"    # String
    "storage_box": "box_1",             # String optional (?)
}
  • store_slides (POST)
{
    "timestamp": 1221445323,                                    # unix number
    "payload": ["KL20-12031_B_2.35.1", "KL20-11898_A_3.3.1"]    # [String]
    "storage_box": "box_1",                                     # String optional (?)
}
  • get_slide (POST)
{
    "timestamp": 1221445323,            # unix number
    "payload": "KL20-12031_B_2.35.1"    # String
}

Mulitple slides can be retrieved by a number of different fields in the database, some of these are yet to be defined.

  • get_slides (POST)
by ids
{
    "timestamp": 1221445323,
    'type': 'ids'
    "payload": ["KL20-12031_B_2.35.1", "KL20-11898_A_3.3.1"]
}

by casetype
{
    "timestamp": 12412354325,
    "type": "casetype",
    "payload": "case-type-string"
}

rars-api's People

Contributors

elvenoutcome avatar

Watchers

Drew avatar Gavin Strunk avatar J 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.