mic-sdk-js
TypeScript icon, indicating that this package has built-in type declarations

4.0.5 • Public • Published

Managed IoT Cloud JavaScript SDK

Get up and running in no time with Telenor Start IoT and the Managed IoT Cloud (MIC) platform with this JavaScript SDK!

Disclaimer

This is an internal tool for simplifying communication with MIC, we do not reccomend using this in production code. Review the REST calls and make your own engineering decisions, consult the API documentation at https://docs.telenorconnexion.com/mic/

Installing

npm install mic-sdk-js

// or yarn
yarn add mic-sdk-js

A standalone distribution can also be used directly in the web browser:

<html>
  <head></head>
  <body>
    <script src="https://unpkg.com/mic-sdk-js@latest/dist/mic-sdk-js.min.js"></script>
  </body>
</html>

Usage

import MIC from 'mic-sdk-js'

MIC.init({
  username: '<MIC username>',
  password: '<MIC password>'
})
.then(() => {
  // Done
})
.catch(err => console.log('Error: ', err))

API

MIC.init(config: object)

Available config options:

{
  // The MIC username
  username: '<MIC username>',

  // The MIC password
  password: '<MIC password>',

  // The MIC stack
  // This is optional and the default value
  // is 'demonorway.mic.telenorconnexion.com'
  stack: 'demonorway.mic.telenorconnexion.com'
}

This method must be called before any other methods are used.

Return: promise


MIC.elasticsearch(query: object)

  • query: an Elasticsearch query

Do an Elasticsearch query using the Elasticsearch API.

Return: response promise


MIC.graphql(payload: object)

  • payload: GraphQL HTTP endpoint payload

Do a GraphQL query using the GraphQL API.

Return: response promise


MIC.mqtt()

Initializes a wrapper for the mqtt.Client() configured for a TLS connection with the Managed IoT Cloud platform.

Return: response promise


MIC.post(endpoint: string, body: object)

  • endpoint: the REST API endpoint
  • body: the REST API payload body

Call a REST API with the HTTP POST method.

Return: response promise


MIC.get(endpoint: string, queryParams: object)

  • endpoint: the REST API endpoint
  • queryParams: the REST API query parameters

Call a REST API with the HTTP GET method.

Return: response promise


MIC.update(endpoint: string, body: object)

  • endpoint: the REST API endpoint
  • body: the REST API payload body

Call a REST API with the HTTP UPDATE method.

Return: response promise


MIC.remove(endpoint: string, queryParams: object)

  • endpoint: the REST API endpoint
  • queryParams: the REST API query parameters

Call a REST API with the HTTP REMOVE method.

Return: response promise

Package Sidebar

Install

npm i mic-sdk-js

Weekly Downloads

3

Version

4.0.5

License

MIT

Unpacked Size

1.67 MB

Total Files

20

Last publish

Collaborators

  • steffennilsen
  • pwntus
  • clubmanplus850