https://github.com/jamesjara/react-native-aws-iot-device-shadows

React Native Component for connecting to AWS IoT Shadows from a device using SDK JavaScript bundle
https://github.com/jamesjara/react-native-aws-iot-device-shadows

aws aws-iot aws-iot-python component iot mqtt react react-native shadows

Last synced: 26 days ago
JSON representation

React Native Component for connecting to AWS IoT Shadows from a device using SDK JavaScript bundle

• Host: GitHub
• URL: https://github.com/jamesjara/react-native-aws-iot-device-shadows
• Owner: jamesjara
• Created: 2017-09-05T21:29:14.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-19T05:55:16.000Z (over 6 years ago)
• Last Synced: 2024-10-02T09:15:28.975Z (about 1 month ago)
• Topics: aws, aws-iot, aws-iot-python, component, iot, mqtt, react, react-native, shadows
• Language: JavaScript
• Homepage:
• Size: 325 KB
• Stars: 37
• Watchers: 4
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# aws-iot-device-sdk-js-react-native

React Native Component wrapper for connecting to AWS IoT from a device using SDK JavaScript bundle

 

Allows developers to use the AWS IOT shadow support from a React Native component.  

* [Overview](#overview)

* [Installation](#install)

* [Examples](#examples)

* [API Documentation](#api)

* [Connection Types](#connections) 

* [AWS bundle](#bundle)

* [Debugging mode](#debug)

* [Unit Tests](#unittests)

* [License](#license)

* [Support](#support)



## Overview

This document provides instructions on how to install and configure the AWS 

IoT device/Shadow in React Native.

### AWS SDK Dependency

This package is built on top of the AWS SDK [aws-sdk.js](https://github.com/aws/aws-iot-device-sdk-js) which provides two classes: 'device'

and 'thingShadow'. 

 

#### Thing Shadows

The 'thingShadow' class implements additional functionality for accessing Thing Shadows via the AWS IoT

API; the thingShadow class allows devices to update, be notified of changes to,

get the current state of, or delete Thing Shadows from AWS IoT.  Thing

Shadows allow applications and devices to synchronize their state on the AWS IoT platform. 

#### Device

The 'device' class wraps [mqtt.js](https://github.com/mqttjs/MQTT.js/blob/master/README.md) to provide a

secure connection to the AWS IoT platform and expose the [mqtt.js](https://github.com/mqttjs/MQTT.js/blob/master/README.md) interfaces upward.  It provides features to simplify handling of intermittent connections, including progressive backoff retries, automatic re-subscription upon connection, and queued offline publishing with configurable drain rate.



## Installation

Installing with npm:

```sh

npm install react-native-aws-iot-device-shadows

```



## Examples

### MQTT React Native IoT Shadow Class

```js

 { this.AWSIoTMQTT = ref; }}

    type="shadow"

    region="us-west-2"

    host="asdasd.iot.aws.com"

    onReconnect={() => this.onConnect()}

    onConnect={() => this.onConnect()}

    onDelta={(thingId, stateObject) => this.onDelta(thingId, stateObject)}

    onStatus={(thingId, statusType, clientToken, stateObject) =>

        this.onStatus(thingId, statusType, clientToken, stateObject)}

    onThingConnected={(thingId) => { this.onThingConnected(thingId); }}

/>

```

### MQTT React Native IoT device Class

```js

 { this.AWSIoTMQTT = ref; }}

    type="device"

    region="us-west-2"

    host="asdasd.iot.aws.com"

    onReconnect={() => this.onConnect()}

    onConnect={() => this.onConnect()} 

/>

```

    



## AWSIoTMQTT

Returns a React Native component whichs wraps xxxxxxxx



## API Documentation

  * `type`: use 'device' for device type and 'shadows' for ShadowThing

  * `host`: the AWS IoT endpoint you will use to connect

  * `region`: the AWS IoT region you will use to connect

  * `config`: extra configuration for the thingShadow

  * `onConnect`: callback for when the websockets connects

  * `onReconnect`: callback for when the websockets reconnects

  * `onDelta`: callback for delta msg

  * `onStatus`: callback for status msg

  * `onThingConnected`: callback for each registered thing



## Connection Types

This react native component only supports one type of connections to the AWS IoT platform:

* MQTT over WebSocket/TLS with SigV4 authentication using port 443



## Debug

The enable debug mode for display logging information just pass a object with debug:true

```js

```



## Re-Creating the bundle with webpack

This IOT JS SDK is packaged with[webpack](https://webpack.js.org/), because currently there is not official support for AWS IOT react native. This  is already bundle it for you using the last version.

```sh

npm run build

```



## Unit Tests

This package includes unit tests which can be run as follows:

```sh

npm test

```

Running the unit tests will also generate code coverage data in the 'reports'

directory.



## License

This react native component is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE.txt and NOTICE.txt for more information.



## Support

feel free to open any ticket in github issues