# rodo-sdk-node

> Node JS SDK for Rodo

Latest version **2.0.2** (published 2019-06-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install rodo-sdk-node
pnpm add rodo-sdk-node
yarn add rodo-sdk-node
bun add rodo-sdk-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2019-06-10 |
| First published | 2019-02-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Shane Romel |
| Maintainers | rodo |

## Links

- npm: https://www.npmjs.com/package/rodo-sdk-node
- npm.io page: https://npm.io/package/rodo-sdk-node

## Dependencies (1)

- [socket.io](https://npm.io/package/socket.io.md) ^2.2.0

## Recent versions

- 2.0.2 (latest) — 2019-06-10
- 2.0.1 — 2019-06-09
- 2.0.0 — 2019-05-12
- 1.0.5 — 2019-03-12
- 1.0.4 — 2019-02-15
- 1.0.3 — 2019-02-15
- 1.0.2 — 2019-02-04
- 1.0.1 — 2019-02-04
- 1.0.0 — 2019-02-04

## README

# RODO merchant SDK
Rodo SDK is a client library for the MERCHANTS USING RODO’S LOCK SERVICES TO KEEP A TRACK OF THEIR LOCKS. THIS LIBRARY IS WRITTEN IN NODE JS.

## Installation
```console
npm install rodo-sdk-node
```
## Example

```javascript
var Rodo=require("rodo-sdk-node");
var rodo=new Rodo("<merchant_id>");

rodo.location("<imei>", data=>{
    console.log(data);
})
```

## API

* [rodo.location()](#rodolocationimei-callback)
* [rodo.locations()](#rodolocationscallback)
* [rodo.nfc()](#rodonfccallback)
* [rodo.status()](#rodostatusimei-callback)
* [rodo.statuses()](#rodostatusescallback)
* [rodo.individualStatus()](#rodoindividualstatuscallback)

### rodo.location(imei, [callback])

Fetches the realtime location of the lock with a particular IMEI number.

* __imei__ is the IMEI number of the lock you want to track.
* __callback - function(data)__ gives you the location on a realtime basis.

### rodo.locations([callback])

Fetches the realtime location of all locks under your merchant ID.

* __callback - function(data)__ fires an array of realtime locations of all locks belonging to the particular merchant.

### rodo.nfc([callback])

* __callback - function(data)__ fires whenever a lock is intended to be unlocked using an NFC card.
`   
### rodo.status(imei, [callback])

Listens for changes in a particular lock's status(locked/unlocked);

* __imei__ is the IMEI number of the lock.
* __callback - function(data)__ fires when the particular lock gets locked or unlocked. 

### rodo.statuses([callback])

Listens for changes in all lock statuses and returns status of all locks.(locked/unlocked);

* __callback - function(data)__ fires whenenver a lock gets locked or unlocked.

### rodo.individualStatus([callback])

Listens for changes in all lock statuses and returns the status of the lock which was affected individually.(locked/unlocked);

* __callback - function(data)__ fires whenenver a lock gets locked or unlocked.

---
_Source: https://npm.io/package/rodo-sdk-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._