Imperiogps NPM

ImperioGPS

Imperio provides developers with an SDK that creates a bridge between native mobile inputs and sensor data with desktop interaction, requiring minimal code and knowledge of the underlying technologies. This version includes the GPS capability

Features

Capturing Mobile inputs

Touch Gestures
Accelerometer
Gyroscope
GPS location

Phone to Desktop Connections

Sockets

Various Forms of Authenticating Mobile to Desktop Sessions

URL + shortcode
Alphanumeric Client Password
Cookie/ Token Sessions

Installation

npm install imperiogps

Getting Started

Client Side Implementation

The client side implementation of Imperio represents the use of the mobile functionality to influence browser interaction. Client-side functionality can be accessed by:

<script src = 'https://cdn.socket.io/socket-io-1.4.5.js'></script>
<script src = './client/lib/imperiogps/imperio.js'></script>

This above code needs to be included on the mobile browser and desktop browser.

Server Side Implementation

Imperio's server functions are currently Express middleware. Implementing Imperio will require Express to be installed and required.

Imperio's server-side functionality can be enable with just a couple lines of javascrips: Just require the module and pass it the server object of your app

const imperio = require('imperio')(server);

Then have your app use the returned object as middleware

app.use(imperio.init());

Imperio will handle the mobile-to-desktop connections for you!

A Simple Example

In this example, we'll include a button in the mobile browser, which on "tap", will alter the Dom of the desktop browser.

mobile.html :

<body>
  <button type="button" name="button" class="tap" onclick="frontEndEcho.mobileTapShare()">Tap Here</button>
  <h2>Hello World</h2
</body>
<script src="https://cdn.socket.io/socket.io-1.4.5.js"></script>
<!-- <script src="./lib/cookies-js/dist/cookies.js"></script> -->
<script src="./lib/imperiogps/imperio.js"></script>
</body>

mobile.js:

desktopBrowser.html:

<body class='class1'>
  <h1> Welcome, Imperio User!</h1>
  <div id= "nonceContainer"></div>
</body>

desktopBrowser.js

function changeBodyClass() {
  // console.log(`let's change body`);
  if (bodyElement.classList.contains('class1')) {
    bodyElement.classList.remove('class1');
    bodyElement.classList.add('class2');
  } else {
    bodyElement.classList.remove('class2');
    bodyElement.classList.add('class1');
  }
}

In server.js:

const express = require('express');
const app = express();
const server = require('http').Server(app); // get the server object from the app instance
const path = require('path');
const bodyParser = require('body-parser');
const cookieParser = require('cookie-parser');
const useragent = require('express-useragent');
// *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-
const imperio = require('imperio')(server);
// *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-

app.use(express.static(path.join(`${__dirname}/../client`)));
app.use(useragent.express()); // TODO tie this into our library somehow?
app.use(bodyParser.urlencoded({ extended: true }));
app.use(cookieParser());
app.set('view engine', 'ejs');
// *-*-*-*-*-*-*-*-*-
app.use(imperio.init());
// *-*-*-*-*-*-*-*-*-

// Handle Routes
app.get('/', (req, res) => {
  if (req.useragent && req.useragent.isDesktop) {
    res.sendFile(path.join(`${__dirname}/path/to/desktop/page`));
  } else if (req.useragent && req.useragent.isMobile) {
    res.sendFile(path.join(`${__dirname}/path/to/mobile/page`));
  }
});

server.listen(3000, () => {
  console.log('Listening on port 3000');
});

Available Functions

All of the Functions

License

To Kill

body-parser cookie-parser express-useragent jsonwebtoken node-uuid socket.io webrtc-adapter

@infinitebrahmanuniverse/nolb-imp @everything-registry/sub-chunk-1908

0.4.0

7 years ago

0.0.1

7 years ago