Nutritious Pumpkin Mash

    @openhps/rest
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.3 • Public • Published

    OpenHPS
    @openhps/rest

    Build Status Maintainability npm version

    @openhps/coreAPI


    This repository contains the REST API component for OpenHPS (Open Source Hybrid Positioning System). It includes nodes for handling remote connections.

    OpenHPS is a data processing positioning framework. It is designed to support many different use cases ranging from simple positioning such as detecting the position of a pawn on a chessboard using RFID, to indoor positioning methods using multiple cameras.

    Features

    Getting Started

    If you have npm installed, start using @openhps/rest with the following command.

    npm install @openhps/rest --save

    Usage

    Server (Push-based)

    import * as express from 'express';
    import * as bodyParser from 'body-parser';
    
    const app = express();
    app.use(bodyParser.json()); // Body parser is required
    server = app.listen(1555, () => {
        ModelBuilder.create()
            .from(new RESTServerSource({
                express: app,
                path: '/api/v1'
            }))
            .to(/* ... */)
            .build().then(model => {
                // Server listening on port 1555
                // endpoint: 127.0.0.1:1555/api/v1
            });
    });

    Client (Push-based)

    ModelBuilder.create()
        .from(/* ... */)
        .to(new RESTClientSink({
            url: 'http://localhost:1555/api/v1',
        }))
        .build().then(model => {
    
        });

    Middleware

    The server supports the addition of middleware for the push and pull actions.

    import * as express from 'express';
    import * as bodyParser from 'body-parser';
    
    const app = express();
    app.use(bodyParser.json()); // Body parser is required
    server = app.listen(1555, () => {
        ModelBuilder.create()
            .from(new RESTServerSource({
                express: app,
                path: '/api/v1',
                middleware: [(req, res, next) => {
                    if (req.body.token === "abc") {
                        next();
                    } else {
                        next(new Error('Unauthorized!'));
                    }
                }]
            }))
            .to(/* ... */)
            .build().then(model => {
                // Server listening on port 1555
                // endpoint: 127.0.0.1:1555/api/v1
            });
    });

    Client Authentication

    Client authentication can be achieved by providing it in the configuration options. More information about available options can be found here.

    ModelBuilder.create()
        .from(/* ... */)
        .to(new RESTClientSink({
            url: 'http://localhost:1555/api/v1',
            config: {
                auth: {
                    username: "test",
                    password: "123"
                }
            }
        }))
        .build().then(model => {
    
        });

    Contributors

    The framework is open source and is mainly developed by PhD Student Maxim Van de Wynckel as part of his research towards Hybrid Positioning and Implicit Human-Computer Interaction under the supervision of Prof. Dr. Beat Signer.

    Contributing

    Use of OpenHPS, contributions and feedback is highly appreciated. Please read our contributing guidelines for more information.

    License

    Copyright (C) 2019-2022 Maxim Van de Wynckel & Vrije Universiteit Brussel

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Keywords

    none

    Install

    npm i @openhps/rest

    Homepage

    openhps.org

    DownloadsWeekly Downloads

    3

    Version

    0.1.3

    License

    Apache-2.0

    Unpacked Size

    752 kB

    Total Files

    164

    Last publish

    Collaborators

    • maximvdw