hmkit

    13.0.2 • Public • Published

    HMKit Node.js SDK

    NPM version | Build Status

    Auto API

    The HMKit Node.js SDK makes it easy to work with car data using HIGH MOBILITY's Auto API. The SDK implements a strong security layer between your Node.js app and the platform, and offers a straightforward native interface to read from – and write to – connected cars.

    The library is designed to give Node.js developers simple access to High Mobility's systems, by handling the communication protocols, authentication flows and other security related components in their entirety.

    Table of contents

    Requirements

    HMKit Node.js SDK requires Node v10.0.0 or higher.

    Installation

    Use the npm package manager for Node.js. Simply type the following into a terminal window:

    $ npm install hmkit
    

    Getting started

    Get started by reading High Mobility's Node.js SDK guide.
    Check out the code references for additional information.

    Examples

    Two sample apps are available on Github.com, and showcase different use-cases for HMKit:

    • Scaffold
      • Demonstrates the most basic implementation of HMKit.
    • AutoAPI Explorer
      • This project implements High Mobility's OAuth and the HMKit Node.js SDK for working with car data. It consists of two pages: a login page to start the authentication flow, and a dashboard which displays the car's diagnostics state and which can lock and unlock the doors via the Auto API.

    Contributing

    We will happily accept patches and contributions to this project. Before getting to work, please first discuss the changes that you wish to make with us via GitHub Issues, Spectrum or Slack.

    See more in CONTRIBUTING.md

    Licence

    This repository is released under the MIT licence. See more in LICENCE

    Keywords

    none

    Install

    npm i hmkit

    DownloadsWeekly Downloads

    42

    Version

    13.0.2

    License

    MIT

    Unpacked Size

    3.86 MB

    Total Files

    137

    Last publish

    Collaborators

    • unemati
    • kevinvaldek
    • allan.tatter
    • milad-hm