tuanpmt / React Native Mqtt
MQTT Client native module for react-native
Stars: ✭ 126
paho.mqtt.javascript for your application, this repository not use for production
Please useDescription
react-native mqtt client module
MQTT Features (inherit from native MQTT framework)
- Use MQTT Framework for IOS, Paho MQTT Client for Android
- Support both IOS and Android
- SSL/TLS
- Native library, support mqtt over tcp
Warning
This library in progress developing, api may change, SSL/TLS non verify
Getting started
Manual install
iOS
npm install [email protected] --save
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-mqtt
and addRCTMqtt.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRCTmqtt.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Click
RCTMqtt.xcodeproj
in the project navigator and go theBuild Settings
tab. Make sure 'All' is toggled on (instead of 'Basic'). In theSearch Paths
section, look forHeader Search Paths
and make sure it contains both$(SRCROOT)/../../react-native/React
- mark asrecursive
. - Run your project (
Cmd+R
)
Android
npm install [email protected] --save
- Modify the ReactInstanceManager.builder() calls chain in
android/app/main/java/.../MainActivity.java
to include:
import com.tuanpm.RCTMqtt.*; // import
.addPackage(new RCTMqttPackage()) //for older version
new RCTMqttPackage() // for newest version of react-native
- Append the following lines to
android/settings.gradle
beforeinclude ':app'
:
include ':react-native-mqtt'
project(':react-native-mqtt').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-mqtt/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
, don't missingapply plugin:'java'
on top:
compile project(':react-native-mqtt')
Notes:
dependencies {
compile project(':react-native-mqtt')
}
Usage
var mqtt = require('react-native-mqtt');
/* create mqtt client */
mqtt.createClient({
uri: 'mqtt://test.mosquitto.org:1883',
clientId: 'your_client_id'
}).then(function(client) {
client.on('closed', function() {
console.log('mqtt.event.closed');
});
client.on('error', function(msg) {
console.log('mqtt.event.error', msg);
});
client.on('message', function(msg) {
console.log('mqtt.event.message', msg);
});
client.on('connect', function() {
console.log('connected');
client.subscribe('/data', 0);
client.publish('/data', "test", 0, false);
});
client.connect();
}).catch(function(err){
console.log(err);
});
API
-
mqtt.createClient(options)
create new client instance withoptions
, async operation-
uri
:protocol://host:port
, protocol is [mqtt | mqtts] -
host
: ipaddress or host name (override by uri if set) -
port
: port number (override by uri if set) -
tls
: true/false (override by uri if set to mqtts or wss) -
user
: string username -
pass
: string password -
auth
: true/false - override = true ifuser
orpass
exist -
clientId
: string client id keepalive
-
-
client
-
on(event, callback)
: add event listener for- event:
connect
- client connected - event:
closed
- client disconnected - event:
error
- error - event:
message
- message object
- event:
-
connect
: begin connection -
disconnect
: disconnect subscribe(topic, qos)
publish(topic, payload, qos, retain)
-
-
message
-
retain
: booleanfalse
-
qos
: number2
-
data
: string"test message"
-
topic
: string"/data"
-
Todo
- [ ] todo
LICENSE
INHERIT FROM MQTT LIBRARY (progress)
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].