https://github.com/blueandi/niu-cloud-cli
NIU cloud command line interface for easy scripting.
https://github.com/blueandi/niu-cloud-cli
cloud e-scooter niu nodejs
Last synced: about 1 year ago
JSON representation
NIU cloud command line interface for easy scripting.
- Host: GitHub
- URL: https://github.com/blueandi/niu-cloud-cli
- Owner: BlueAndi
- License: mit
- Created: 2019-05-20T18:54:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T16:58:50.000Z (over 2 years ago)
- Last Synced: 2025-03-29T08:43:34.621Z (about 1 year ago)
- Topics: cloud, e-scooter, niu, nodejs
- Language: JavaScript
- Size: 177 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# niu-cloud-cli
Access the NIU cloud via command line interface. It is based on the [niu-cloud-connector](https://github.com/BlueAndi/niu-cloud-connector).
[](http://choosealicense.com/licenses/mit/)
[](https://www.repostatus.org/#active)
[](https://github.com/BlueAndi/niu-cloud-cli/releases)
A project originated from an [article in the Elektroroller-Forum](https://www.elektroroller-forum.de/viewtopic.php?f=63&t=6227) [German].
1. [Installation](https://github.com/BlueAndi/niu-cloud-cli#installation)
2. [Show all commands and parameters](https://github.com/BlueAndi/niu-cloud-cli#show-all-commands-and-parameters)
3. [Example](https://github.com/BlueAndi/niu-cloud-cli#example)
4. [Token](https://github.com/BlueAndi/niu-cloud-cli#token)
5. [KML output for google earth or google maps](https://github.com/BlueAndi/niu-cloud-cli#kml-output-for-google-earth-or-google-maps)
6. [Filter output](https://github.com/BlueAndi/niu-cloud-cli#filter-output)
7. [Issues, Ideas and bugs](https://github.com/BlueAndi/niu-cloud-cli#issues-ideas-and-bugs)
8. [License](https://github.com/BlueAndi/niu-cloud-cli#license)
## Installation
The niu-cloud-connector libray is included as git submodule. Therefore the "--recursive" option is important, because otherwise the niu-cloud-connector is not included.
```
$ git clone --recursive https://github.com/BlueAndi/niu-cloud-cli.git
$ cd niu-cloud-cli
$ npm install
```
## Show all commands and parameters
```
$ node niu-cloud-cli.js --help
```
## Example
First create a session token with your NIU cloud account. This token is necessary for all further requests.
You need your user account/password and additional your contry code, like e.g. 49 for germany.
```
$ node niu-cloud-cli.js create-token
```
Get a list of your vehicles. Each vehicle has a serial number, which is necessary to get vehicle specific informations.
```
$ node niu-cloud-cli.js get-vehicles --token
```
## Token
Note, a token can be stored in a file in JSON format:
```json
{
"token": "..."
}
```
Use the option ```--tokenFile ``` to save (create-token command) and load (all other commands) the token.
## KML output for google earth or google maps
### Last known position
Generate a KML file including the last known position of your NIU e-scooter with the following call:
```
$ node niu-cloud-cli.js get-vehicle-pos --token --sn --kml > pos.kml
```
Load the generated pos.kml file in google earth or google map.
### Track detail
First get e.g. the last recorded track.
```
$ node niu-cloud-cli.js get-tracks --token --sn --num 1
```
```
Track #1
Track id : 1558023845684dBO79fv:1
Track date : 20190516
Track start time: 2019-5-16 18:24:05
Track end time : 2019-5-16 18:38:04
Distance : 13147 m
Average speed : 57.1 km/h
Riding time : 838 min.
Start point :
Latitude : xx.xxxxxx
Longitude: xx.xxxxxx
End point :
Latitude : xx.xxxxxx
Longitude: xx.xxxxxx
```
There you will find the track id and the track date, which are necessay to retrieve the full detail.
Now generate a KML file from a complete recorded track of your NIU e-scooter with the following call:
```
node niu-cloud-cli.js get-track-detail --token --sn --trackId --trackDate --kml > track.kml
```
Load the generated track.kml file in google earth or google map and voila!
## Filter output
For further processing of data on the command line or via CSV, you can filter data to get a dedicated output.
First check what kind of data is available by takeing a look to the documentation or just output all data in JSON format.
```
node niu-cloud-cli.js get-battery-info --token --sn --json
```
Next step is to filter for some data, e.g. the estimatedMileage.
```
node niu-cloud-cli.js get-battery-info --token --sn --filter estimatedMileage
```
This will output only the estimatedMileage value! Add more filters and the output will be value by value, separated with a ";".
## Issues, Ideas and bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/niu-cloud-cli/issues) or if
you are able and willing to fix it by yourself, clone the repository and create a pull request.
## License
The whole source code is published under the [MIT license](http://choosealicense.com/licenses/mit/).