BatteryBroadcasterAPI🚀

BatteryBroadcaster is a Restful API which is built on core-javascript routers to fetch and collect devices battery informations as a streams. The coremodules, inspired by native battery packages ,to providing detailed information about the device battery (level, health, charging status, etc.). Now supports both IOS and Android 📱.

Table of contents

1. Introduction
2. Install
3. Usage
   • Defining an API
   • Authentication
   • Lifecycle hooks
     • check lifecycle
     • preProcess lifecycle
     • execution lifecycle
     • postProcess lifecycle
     • postServe lifecycle
   • Procedures
4. License

Introduction

This specification defines an API that provides information about the battery status of the hosting device.

The Battery State API gives a method for web developers to determine the battery status of the hosting device programmatically.A web developer must create a web application based on the assumption that the device's battery is sufficient for the work at hand even if they don't know the device's battery state.Because this standard leverages the Web IDL specification [WEBIDL], implementations that utilize ECMAScript to implement the APIs provided in this standard must do so in a way that is compatible with the ECMAScript Bindings provided in that specification.

• Database is exposed to the client, unless some explicit security mechanism is in place; one can see the innards of the database by View page source
• There is no one server to rule them all, queries are strings, scattered around different clients (web, mobile, etc.)
• Third-party developers might not be familiar with Cypher

In addition, it comes with goodies:

• Hassle-free authentication and non-opinionated user management, you describe how your users and roles are stored, the framework provides authentication and role-based access management
• Lifecycle hooks, enabling one to tweak incoming and outgoing data based on one's needs, allowing utilisation of the full power of nodejs and javascript ecosystem in the process
• Procedures as a means for creating reusable blocks of backend code

Install

npm install batterystatusapi --save

Usage

To get started quickly you can clone koa-neo4j-starter-kit

var batterystatusapi = require('batterystatusapi');

    // Authentication config object, optional
    // authentication: {...} // explained below

    // APIs config object, optional (same effect could be achieved later by app.defineAPI)
    apis: [
        {
            method: 'POST',
            route: '/register',
            cypherQueryFile: './cypher/register.cyp'
        },
        {
            method: 'POST',
            route: '/login',
            cypherQueryFile: './cypher/login.cyp'
        }
    ],

    // express middlewares could be injected and will be loaded before api invoked,e.g:a koa static file serving middleware as following
    middleware:[convert(staticFile('./public'))]
});

app.listen(3000, function() {
    console.log('App listening on port 3000.');
});

Defining an API 👨‍🏫

An API is defined by at least three keys:

method, specifies the request type (GET|POST|PUT|DEL)

route, the path to this API (e.g. the first API defined in apis above becomes http://localhost:3000/register [login])

cypherQueryFile, path to the corresponding .cyp file

Optionally you can specify roles whom can access this route with allowedRoles and also lifecycle hooks.

As an example:

app.defineAPI({
    // allowedRoles: ['admin', 'author']    // roles are case insensitive
    method: 'POST',
    route: '/register',
    cypherQueryFile: './cypher/register.cyp'
});

And then in ./cypher/create_article.cyp:

CREATE (a:UserModel {
    username: $username,
    password: $password,
    created_at: timestapm()
})
RETURN a

Authentication 🔐

Authentication is facilitated through JSON web token, all it takes to have authentication in your app is to supplement Authentication config object either with authentication key when initiating the app instance or in configureAuthentication method:

When authentication is configured, you can access it by sending a POST request to the route you specified. Pass a JSON object to e.g. /login or /register in the following form:

{
  "username": "<user_name>",
  "password": "<user_password_or_hash>",
  "remember": true
}

Note that if you don't set "remember": true, the generated token expires in an hour.

Returned object contains a token which should be supplemented as Authorization header in subsequent calls to routes that have allowedRoles protection.

CoreBatteryAPI Definitions🚀

The battery info stats were mainly built on native javascript stack to handle multiple request and response without blocking application runtime. The API framework mainly implemented on asynchronus database accessing protocols.

CoreBatteryAPI Request has following major definitions

definition	descriptive information	api_key	dataype
batteryLevel	Indicates the current battery percentage. default decleration based on %	batteryLevel	int
chargeTimeRemaining	Indicates the remaining milliseconds to batteryLevel == 100	chargeTimeRemaining	String
chargingStatus	Define the current charging mode. chargingStatus.charging, chargingStatus.discharging, chargingStatus.unknown	chargingStatus	String
currentAverage	Current electro-flow intake average	currentAverage	Double
currentNow	Electro-flow which inbounds to battery	currentElectroFlow	Double
health	Battery Health parameter status 🩺👨‍⚕️	battery_health	String
pluggledStatus	Defines the boolean True for 🔌plugged	pluggedStatus	boolean
remainingEnergy	Defines the remaining capacity	remainingEnergy	String
scale	Battery scale based on battery Level (default :100)	scale	int
technology	Used technology for designing battery by manufacutres.	technology	String
temperature	Current battery internal temperature 🌡🤒	temperature	int
voltage	Charging voltage ⚡️	voltage	String

API Requests [battery_info] 🔋

The battery post requests were exposed for authenticated users.(for authentication read chapter #authentication). Once the user properly authenticated, user has a uid with long random unique charset. for post a request. client should provide details on POST body

https://batterybroadcaster.herokuapp.com/batteryinfo/[uid] --POST

{
        "uid": "60adc87c1ccc1e055979ff25",
        "technology": "Li-ion",
        "chargingStatus": "ChargingStatus.Charging",
        "currentFlowNow": "253753",
        "batteryTemperature": "30",
        "batteryLevel": "100",
        "chargingTimeRemaining": "0",
        "batteryHealth": "heath_good",
        "pluggedStatus": "AC",
        "reamainingEnergy": "-2147483648",
        "volatage": "4423",
}

License

Anti-996 License