node-red-contrib-niu-cloud/README.md

A Node-RED library for connect to NIU Cloud for your electric scooter

# node-red-contrib-niu-cloud
![Information Panel](./docs/img/node-red-niu-cloud.png)

A [Node-RED](https://nodered.org/) library for connect to NIU Cloud for your electric scooter

[![npm version](https://img.shields.io/npm/v/node-red-contrib-niu-cloud.svg)](https://www.npmjs.com/package/node-red-contrib-niu-cloud)
[![Npm download](https://img.shields.io/npm/dm/node-red-contrib-niu-cloud.svg)](https://www.npmjs.com/package/node-red-contrib-niu-cloud)
[![GitHub stars](https://img.shields.io/github/stars/gablau/node-red-contrib-niu-cloud.svg)](https://github.com/gablau/node-red-contrib-niu-cloud/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/gablau/node-red-contrib-niu-cloud.svg)](https://github.com/gablau/node-red-contrib-niu-cloud/issues)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/gablau/node-red-contrib-niu-cloud/blob/master/LICENSE)

[![NPM](https://nodei.co/npm/node-red-contrib-niu-cloud.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/node-red-contrib-niu-cloud)

__________

## NIU Cloud connector for Node-RED
This library allows you to request information about your vehicle from the NIU Cloud. It handles many actions that can be performed on multiple vehicles. 

To install this library please search for "niu" in the node palette 

### Supported actions

**Vehicles** Get a list of vehicles.\
**Motor info** Get motor info of vehicle.\
**Overall Tally** Get overall tally of vehicle.\
**Battery info** Get battery info of vehicle.\
**Battery health** Get battery health of vehicle.\
**FW Version** Get firmware version.\
**Vehicle position** Get current position of a vehicle.\
**Update info** Get update information.\
**Tracks** Get recorded tracks.

For information on the data that all actions return, see the API description [here](https://github.com/BlueAndi/niu-cloud-connector/blob/master/doc/API.md)

### Changelog

See the [changelog](CHANGELOG.md) for all the details of each releases

### Node-RED palette

![Available Nodes](./docs/img/niu-cloud-palette.png)

### How to use

Set your Niu Cloud Account credential and click on "refresh token", then select a vehicle and save the config note.

![Information Panel](./docs/img/readme-config-niu.png)

On the node, select the desired action and inject any payload to retrieve information from the Niu cloud 

![Information Panel](./docs/img/readme-node-niu.png)

### Debug

Use the verbose `-v` flag when starting Node-RED to get more information
or use `node-red-log` and enable "Debug Logs" on Configuration Node as needed

__________


## Attributions

The **node-red-contrib-niu-cloud** using nodejs library [**niu-cloud-connector**](https://github.com/BlueAndi/niu-cloud-connector) for all features.

## License
This project is released under The MIT License (MIT)