open-index/open-npm huggingface dataset:
npm package: @iotize/device-com-mqtt.js
Description: IoTize Device Communication protocol for MQTT
Author: IoTize
Latest version: 2.3.0

# IoTize Device Com MQTT

## Installation

### Browser

Download [latest version](https://cdn.jsdelivr.net/npm/@iotize/device-com-mqtt.js@latest/dist/iotize-device-com-mqtt.min.js) or use this link to load from [jsdeliver](jsdeliver.com).

```html
<script src="https://cdn.jsdelivr.net/npm/@iotize/device-com-mqtt.js@latest/dist/iotize-device-com-mqtt.min.js" />
```

### npm

```bash
npm install @iotize/device-com-mqtt.js
```

## Usage

```javascript
// Library name: IoTizeDeviceComMqtt
// Simple mqtt protocol
import { connect as mqttConnect, IClientOptions, MqttClient } from "mqtt";

let mqttProtocol = IoTizeDeviceComMqtt.MqttProtocol();

// Mqtt protocol for IoTize relay
let mqttRelayProtocol = IoTizeDeviceComMqtt.createClientMQTTRelayProtocol({
  connect: (brokerUrl?: string | any, options?: IClientOptions): MqttClient => {
    return mqttConnect(brokerUrl, options);
  },
  serialNumber: "your serial number",
  netkey: "testnetkey",
  broker: {
    username: "broker username",
    password: "broker password",
    url: "ws://user.cloud.iotize.com:9001",
  },
});
```

For more informations, read the [documentation](http://developer.iotize.com).
npm package: @iotize/device-com-socket.node
Description: Socket communication protocol to communicate with an iotize
Author: IoTize
Latest version: 2.0.3

# IoTize Device Com Socket

## Installation

### Browser

Download [latest version](https://cdn.jsdelivr.net/npm/@iotize/device-com-socket.js@latest/dist/iotize-device-com-socket.min.js) or use this link to load from [jsdeliver](jsdeliver.com).

```html
<script src="https://cdn.jsdelivr.net/npm/@iotize/device-com-socket.js@latest/dist/iotize-device-com-socket.min.js" />
```

### npm

```bash
npm install @iotize/device-com-socket.js
```

## Usage

```javascript
// Library name: IoTizeDeviceComSocket
let socketProtocol = IoTizeDeviceComSocket.SocketProtocol({
    host: 'localhost',
    port: 2000
});

// ...
```

For more informations, read the [documentation](http://developer.iotize.com).
npm package: @iotize/device-com-uart.node
Description: Serial communication protocol to communicate with a TapNLink
Author: IoTize
Latest version: 3.0.0

# IoTize Device Com UART

## Installation

### npm

```bash
npm install @iotize/device-com-uart.node
```

## Usage

```javascript
let protocol = new UartProtocol({
    port: 'COM12'
});
```

For more informations, read the [documentation](http://developer.iotize.com).
npm package: @iotize/device-com-web-bluetooth.js
Description: IoTize Device Communication protocol over web bluetooth
Author: IoTize
Latest version: 2.3.1

# IoTize Device Com BLE on Chrome

## Installation

### Browser

Download [latest version](https://cdn.jsdelivr.net/npm/@iotize-private/iotize-device-com-web-bluetooth.js@latest/dist/iotize-device-com-web-bluetooth.js.min.js) or use this link to load from [jsdeliver](jsdeliver.com).

```html
<script src="https://cdn.jsdelivr.net/npm/@iotize-private/iotize-device-com-web-bluetooth.js@latest/dist/iotize-device-com-web-bluetooth.js.min.js" />
```

### npm

```bash
npm install @iotize-private/iotize-device-com-web-bluetooth.js
```

## Usage

```javascript
// TODO
```

### Typings

Typings are provided with the library.

```typescript
// TODO
```

For more informations, read the [documentation](http://developer.iotize.com).
npm package: @iotize/device-com-websocket.js
Description: IoTize Device Communication protocol for Web Socket
Author: IoTize
Latest version: 2.1.0

# IoTize Device Com WebSocket

## Installation

### Browser

Download [latest version](https://cdn.jsdelivr.net/npm/@iotize/device-com-websocket.js@latest/dist/iotize-device-com-websocket.min.js) or use this link to load from [jsdeliver](jsdeliver.com).

```html
<script src="https://cdn.jsdelivr.net/npm/@iotize/device-com-websocket.js@latest/dist/iotize-device-com-websocket.min.js" />
```

### npm

```bash
npm install @iotize/device-com-websocket.js
```

## Usage

```javascript
// Library name: IoTizeDeviceComWebsocket
let websocketProtocol = IoTizeDeviceComWebsocket.WebSocketProtocol({
    url: 'tcp://localhost:2000' // Server url
});

// ...
```

### Typings

Typings are provided with the library.

```typescript
import { WebSocketProtocol } from '@iotize/device-com-websocket.js';

// ...
```

For more informations, read the [documentation](http://developer.iotize.com).
npm package: @iotize/device-com-webview.js
Description: IoTize Device Communication protocol for Web views
Author: IoTize
Latest version: 2.1.0

# IoTize Device Com Webview

IoTize communication protocol that proxy commmunication between your javascript app running inside a webview and the native application.

## Installation

### Browser

Download [latest version](https://cdn.jsdelivr.net/npm/@iotize/device-com-webview.js@latest/dist/iotize-device-com-webview.min.js) to your website directory or or use the `http` link directly in your page.

```html
<script src="https://cdn.jsdelivr.net/npm/@iotize/device-com-webview.js@latest/dist/iotize-device-com-webview.min.js"></script>
```

### npm

```bash
npm install @iotize/device-com-webview.js
```

## API

### IoTizeDeviceComWebview::isIoTizeWebView()

Return `true` if your app script is running in a webview where the IoTize com protocol has been injected.

**Usage**

```javascript
let result = IoTizeDeviceComWebview.isIoTizeWebView();
```

### IoTizeDeviceComWebview::getInjectedIoTizeDevice()

Build `IoTizeDevice` object if it's running inside an IoTize webview. Throw an error otherwise

**Usage**

```javascript
let iotizeDevice = IoTizeDeviceComWebview.getInjectedIoTizeDevice();
// ...
```

### IoTizeDeviceComWebview::getInjectedIoTizeDevice()

Manually instantiate the communication protocol object.

**Usage**

```javascript
let protocol = IoTizeDeviceComWebview.WebViewComProtocol();
// Use it to connect with an IoTizeDevice for example
```

For more informations, read the [documentation](http://developer.iotize.com).
npm package: @iotize/device-ext-tapnpass.js
Description: Extras features for TapNPass device
Author: IoTize
Latest version: 2.1.2

# ADP extension for IoTize device client

## Installation

### Browser

Download [latest version](https://cdn.jsdelivr.net/npm/@iotize/device-ext-tapnpass.js@latest/dist/iotize-device-ext-tapnpass.min.js) to your website directory or or use the `http` link directly in your page.

```html
<script src="https://cdn.jsdelivr.net/npm/@iotize/device-ext-tapnpass.js@latest/dist/iotize-device-ext-tapnpass.min.js" />
```

### npm

```bash
npm install @iotize/device-ext-tapnpass.js
```

## API

For more informations, read the [documentation](http://developer.iotize.com/content/tapnpass-api/).