npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

carwings2

v4.0.0

Published

A Node.js client library for the Nissan Leaf "Carwings" API

Downloads

4

Readme

carwings2

A Node.js client library for the Nissan Leaf "Carwings" API.

This library makes use of version "2" of the Carwings API.

Installation

> npm install carwings2 --save

Use

var carwings = require('carwings2');

var secrets = {
    email: <email>,
    password: <password>
};

// Create an instance of the client...
var client = new carwings.Client();

// Login using a user's Carwings (i.e. Nissan Connect) credentials...
client.login(secrets.email, secrets.password, (err, vehicle) => {
    if (err) {
        console.error(err);
        
        return err;
    }
    
    //
    // Logging in returns information about the user's vehicle, including its VIN.
    //
    
    // Request status about the user's vehicle...
    client.requestStatus(vehicle.vin, (statusErr, statusResponse) => {
        if (statusErr) {
            console.error(statusErr);
            
            return statusErr;
        }
        
        //
        // The response contains (raw) properties related to the status of the vehicle (e.g. charging or not).
        //
        
        console.log(statusResponse);
    });
});

API

Client

Client(options)

  • options (object, optional): An options object you can use to configure the client's settings.

You can set the following fields on the options parameter:

  • regionCode (string, optional): The region in which the user resides. Defaults to 'NNA' (United States). Use 'NE' to connect to the European endpoint.
  • locale (string, optional): The locale (language) of the user. Defaults to 'en-US' (English (United States)).
  • baseEndpoint (string, optional): The API endpoint to connect to. If baseEndpoint isn't specified the default API endpoint for the specified regionCode will be used.

login(email, password, callback)

  • email (string): The email address associated with the user's Carwings account.
  • password (string): The password associated with the user's Carwings account.
  • callback (function): Invoked on completion of the request.

requestStatus(vin, callback)

  • vin (string): The VIN of the user's vehicle (e.g. provided to the login() callback).
  • callback (function): Invoked on completion of the request.

Note: This call can take upwards of several minutes to complete.

getCachedStatus(vin, callback)

  • vin (string): The VIN of the user's vehicle (e.g. provided to the login() callback).
  • callback (function): Invoked on completion of the request.

getClimateControlStatus(vin, callback)

  • vin (string): The VIN of the user's vehicle (e.g. provided to the login() callback).
  • callback (function): Invoked on completion of the request.

requestClimateControlTurnOn(vin, callback)

  • vin (string): The VIN of the user's vehicle (e.g. provided to the login() callback).
  • callback (function): Invoked on completion of the request.

requestClimateControlTurnOff(vin, callback)

  • vin (string): The VIN of the user's vehicle (e.g. provided to the login() callback).
  • callback (function): Invoked on completion of the request.

requestChargingStart(vin, callback)

  • vin (string): The VIN of the user's vehicle (e.g. provided to the login() callback).
  • callback (function): Invoked on completion of the request.

Acknowledgements

This library was inspired by Jason Horne's pywings2 Carwings library for Python.

License

MIT