https://github.com/pranaydutta89/bolt-iot-wrapper

Simple Bolt IoT Api communication channel
https://github.com/pranaydutta89/bolt-iot-wrapper

api-wrapper bolt boltiot iot nodejs npm typescript umd

Last synced: 5 months ago
JSON representation

Simple Bolt IoT Api communication channel

• Host: GitHub
• URL: https://github.com/pranaydutta89/bolt-iot-wrapper
• Owner: pranaydutta89
• License: mit
• Created: 2019-03-18T16:05:45.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T03:23:26.000Z (over 3 years ago)
• Last Synced: 2025-09-26T06:37:07.612Z (9 months ago)
• Topics: api-wrapper, bolt, boltiot, iot, nodejs, npm, typescript, umd
• Language: TypeScript
• Homepage:
• Size: 1.86 MB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Bolt-IoT-Wrapper

## Simple Bolt IoT Api wrapper which also takes care of api call restrictions

[![Build Status](https://travis-ci.org/pranaydutta89/bolt-iot-wrapper.svg?branch=master)](https://travis-ci.org/pranaydutta89/bolt-iot-wrapper)

[![npm version](https://badge.fury.io/js/bolt-iot-wrapper.svg)](https://badge.fury.io/js/bolt-iot-wrapper)

[![NPM](https://nodei.co/npm/bolt-iot-wrapper.png?downloads=true)](https://nodei.co/npm/bolt-iot-wrapper/)

### Usage:-

##### Nodejs:

 ```

 npm i bolt-iot-wrapper

 ```

 ```javascript

 // import module

 import {Devices,Enums,PubSub} from 'bolt-iot-wrapper';

 ```

##### Browser

```html

```

###### Browser Compatibility

1) IE 9 and above

2) Any other browser

##### API

```javascript

  // 1) Register devices

  Devices.add({deviceName},{deviceKey});

  // 2) Read Device

  const instance =Devices.read({deviceName},{deviceKey});

  // A) Analog

  instance.Analog.read()// reads analog pin data return a promise

  instance.Analog.loopRead({milliseconds},{callback}) // reads analog pin continously in paritcular interval

  //B) Digital

  instance.Digital.read({pin |pins[]}) // read Digital signals of single of multiple pins returns a promise

  instance.Digital.write({IDigitalparams | IDigitlparams[]}) // write digital singals 

  instance.Digital.loopRead({pin | pins[]},{milleseconds},{callback}) // read digital singals in particular interval

  //C) UART

  instance.UART.begin({baudRate}) //sets the baud rate

  instance.UART.read({till})

  instance.UART.write({data})

  instance.UART.readWrite({data},{till})

  

  //D) utils

  instance.Utility.isOnline()// returns a promise with resolved valueas true/false

  instance.Utility.restart()

  instance.Utility.version()

  //E) Api Callback 

  

  PubSub.api({cb}) // the callback will get fired with phases of api calls

  PubSub.message({cb}) // the callback will get fired when libary would send some message to client

```

```javascript

 //same api follows for browser just it is inside window object as 

 boltApi.Devices.add({deviceName},{deviceKey})

```

##### Module is built over typescript so you will get all the necessary intellisense ,for detailed information visit below url

https://pranaydutta89.github.io/bolt-iot-wrapper/