Git Product home page Git Product logo

ruptela's Introduction

GPS tracking protocol

Communication protocol between Ruptela's GPS tracking devices and TCP server in Node.js. This protocol supports only command IDs 1 and 68 for now.

Usage

const server = require('net').createServer();
const process = require('ruptela');

server.on('connection', (conn) => {
    const addr = conn.remoteAddress + ':' + conn.remotePort;
    console.log('New connection from %s', addr);

    conn.on('data', (data) => {
        console.log('New data from connection %s: %j', addr, data);
        const res = process(data);
        if (!res.error) {
            //do something with res.data

            //return acknowledgement
            conn.write(res.ack);
        } else {
            //do something with res.error
        }
    });
    conn.once('close', () => {
        console.log('Connection from %s closed', addr);
    });
    conn.on('error', (error) => {
        console.log('Error from connection %s: %s', addr, error.message);
    });
});
//configure server to listen on PORT
server.listen(PORT, () => {
    console.log('Server started on port %s at %s', server.address().port, server.address().address);
});

Response Object

This protocol processes the given input (buffer), and returns an object, containing the extracted data from the buffer, along with an acknowledgement. You should receive the response object in the following format:

//{
//    data: {
//        packet_length: 69,
//        imei: 123451234512345,
//        command_id: 68,
//        payload: {
//            records_left: 0,
//            records_total: 1,
//            records: [{
//                timestamp: 1509710400,
//                timestamp_extension: 0,
//                record_extension: 0,
//                priority: 0,
//                longitude: -739949834,
//                latitude: 407517058,
//                altitude: 2345,
//                angle: 18010,
//                satellites: 9,
//                speed: 0,
//                hdop: 12,
//                event_id: 7,
//                io: {
//                    '5': 0,
//                    '29': 14860,
//                    '30': 4080,
//                    '65': 1199,
//                    '137': 0,
//                    '402': 0,
//                    '403': 0
//                }
//            }]
//        },
//        crc: 19907
//    },
//    ack: < Buffer 00 02 64 01 13 bc >
//}

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

$ npm i --save ruptela

See the package source for more details.

ruptela's People

Contributors

dimitrievski avatar

Watchers

Anar Jafarov avatar James Cloos 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.