# node-visionlink

> Node.js wrapper for Caterpillar's VisionLink APIs.

Latest version **0.5.1** (published 2017-09-07) · 0 weekly downloads

## Install

```sh
npm install node-visionlink
pnpm add node-visionlink
yarn add node-visionlink
bun add node-visionlink
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2017-09-07 |
| First published | 2016-02-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | aknorw |
| Maintainers | aknorw |
| Keywords | caterpillar, visionlink, telematics |

## Links

- npm: https://www.npmjs.com/package/node-visionlink
- Repository: https://github.com/aknorw/node-visionlink
- Homepage: https://github.com/aknorw/node-visionlink#readme
- Issues: https://github.com/aknorw/node-visionlink/issues
- npm.io page: https://npm.io/package/node-visionlink

## Dependencies (2)

- [xml2js](https://npm.io/package/xml2js.md) ^0.4.16
- [request](https://npm.io/package/request.md) ^2.69.0

## Recent versions

- 0.5.1 (latest) — 2017-09-07
- 0.5.0 — 2017-07-10
- 0.4.0 — 2016-04-13
- 0.3.0 — 2016-02-05
- 0.2.1 — 2016-02-04
- 0.2.0 — 2016-02-04
- 0.1.0 — 2016-02-04

## README

Node-VisionLink
===============

Node.js wrapper for [Caterpillar's VisionLink APIs](https://APIDocumentation.myvisionlink.com).

:warning: **0.5.0 version brings some breaking changes. Please read carefully before updating!**

See `examples` folder for some basic examples. Please refer to VisionLink API documentation for additional information.

## Installation

    npm install node-visionlink --save

## Usage

First of all, be sure to have access to the VisionLink API services. You'll need your API credentials when requiring this module.

    const wrapper = require('node-visionlink')({
      username: 'your_API_username',
      password: 'your_API_password'
    });

`wrapper` allows you to access both *VL Ready* and *VisionLink* APIs.

#### VL Ready APIs

    wrapper.Ready.TOPIC({ page, options })
      .then(data => {
        // Do what you want with data
      })
      .catch(error => {
        // Handle error
      });

##### Available topics

* Assets (`Ready.Assets`)
* Asset Operation (`Ready.AssetOperation`)
* Asset Utilization (`Ready.AssetUtilization`)
* Fuel Utilization (`Ready.FuelUtilization`)
* LoadCounts (`Ready.LoadCounts`)

##### Param

Key | `typeof` value | Required | ?
--- | --- | --- | ---
`page` | Number | *false* | Relative to pagination of data (falls back to `1`)
`options` | Object | *false* | Same parameter you would use with [request](https://github.com/request/request)

---

#### VisionLink APIs

    wrapper.VisionLink.TOPIC({ queue_name, queue_position, options })
      .then(data => {
        // Do what you want with data
      })
      .catch(error => {
        // Handle error
      });

##### Available topics

* Diagnostic Data (`VisionLink.Diagnostic`)
* Digital Switch Status (`VisionLink.DigitalSwitchStatus`)
* Engine Parameters (`VisionLink.EngineParameters`)
* Engine Start/Stop Time (`VisionLink.StartStop`)
* Event Data (`VisionLink.EventData`)
* Fleet Summary (`VisionLink.AEMP`)
* Fuel Information (`VisionLink.FuelInformation`)
* Geo fence Alert (`VisionLink.GeoFence`)
* SMU Location (`VisionLink.SMULocation`)

##### Param

Key | `typeof` value | Required | ?
--- | --- | --- | ---
`queue_name` | String | *false* | Relative to the data queue (falls back to `testqueue`)
`queue_position` | Number | *false* | Relative to the position in the data queue. Use zero (0) to retrieve data from the top of the queue (falls back to `0`)
`options` | Object | *false* | Same parameter you would use with [request](https://github.com/request/request)

## Release History

* **0.5.1** Fixed blank object issue
* **0.5.0**
  * Every function now uses an object as param :warning:
  * No more callback hell: functions now return promises :warning:
  * Fixed *legacy* URI
  * Updated VL topics to the latest versions
* **0.4.0** Module rewritten with ES6 syntax
* **0.3.0** VisionLink APIs added
* **0.2.0** Support for VisionLink-Ready APIs navigation
* **0.1.0** Initial release

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