Giter VIP home page Giter VIP logo

cloud-specification's Introduction

cloud-specification

The device always connects to the cloud.

WebSocket Protocol

The data serialization/deserialization is bson.

Connect to the server.

wss://api.cloud-domain.com/v1

{
  headers: {
    'Device-Build-Version': 'V200_2018_03_20_643_Advan_debug',
    'Device-OS-Version': 'Android 5.1.1',
    'Device-Kernel-Version': '3.10.73-ga1a3c0c-00098-ged2cd52',
    'Device-HW-Version': 'EVT2',
    'Device-Mac-Address': '00-13-E2-FA-0C-1E',
    'Device-Serial-Number': '000017164994'
  }
}

Send the request to the device or cloud.

{
  type: 'request',
  id: 'random string',
  method: 'get',    // Follow http request method.
  uri: '/me?q=xx',  // Follow RESTful API path naming.
  body: {           // There is no body member when the method is get or delete.
    xx: '...'
  }
}

Send the response to the device or cloud.

{
  type: 'response',
  id: 'request id',
  status: 200,  // Follow http response status code.
  body: {
    xx: '...'
  }
}

Send the notification to the device.

{
  type: 'notification',
  event: 'ENROLL.RECORD.ADDED',
  body: {
    xx: '...'
  }
}

cloud-specification's People

Contributors

kelpandrovideo avatar

Watchers

 avatar  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.