@iotize/tap
Version:
IoTize Device client for Javascript
820 lines (808 loc) • 19.3 kB
JavaScript
import { AbstractService, extendServiceContainer } from '@iotize/tap';
import { TapRequestFrame } from '@iotize/tap/client/api';
import { converters } from '@iotize/tap/service/core';
/**
* Generated file. Do not edit
*/
var serviceConverters = /*#__PURE__*/Object.freeze({
__proto__: null
});
/**
* Generated file. Do not edit
*/
const allConverters = Object.assign(Object.assign({}, converters), serviceConverters);
const SERVICE_CALLS = {
getClientId: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/client-id',
path: '/1024//52',
responseBodyDecoder: allConverters.ascii,
},
putClientId: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/client-id',
path: '/1024//52',
bodyEncoder: allConverters.ascii,
},
getUsername: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/username',
path: '/1024//53',
responseBodyDecoder: allConverters.ascii,
},
putUsername: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/username',
path: '/1024//53',
bodyEncoder: allConverters.ascii,
},
getBrokerHostname: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/broker-hostname',
path: '/1024//50',
responseBodyDecoder: allConverters.ascii,
},
putBrokerHostname: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/broker-hostname',
path: '/1024//50',
bodyEncoder: allConverters.ascii,
},
getBrokerPort: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/broker-port',
path: '/1024//51',
responseBodyDecoder: allConverters.ascii,
},
putBrokerPort: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/broker-port',
path: '/1024//51',
bodyEncoder: allConverters.ascii,
},
getPassword: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/password',
path: '/1024//54',
responseBodyDecoder: allConverters.ascii,
},
putPassword: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/password',
path: '/1024//54',
bodyEncoder: allConverters.ascii,
},
getRelayNetKey: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/relay-net-key',
path: '/1024//55',
responseBodyDecoder: allConverters.ascii,
},
putRelayNetKey: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/relay-net-key',
path: '/1024//55',
bodyEncoder: allConverters.ascii,
},
putBrokerCertificate: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/broker-certificate',
append: true,
path: '/1024//57',
},
getTopicPrefix: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/topic-prefix',
path: '/1024//58',
responseBodyDecoder: allConverters.ascii,
},
putTopicPrefix: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/topic-prefix',
path: '/1024//58',
bodyEncoder: allConverters.ascii,
},
getRequestTopic: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/request-topic',
path: '/1024//58',
responseBodyDecoder: allConverters.ascii,
},
putRequestTopic: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/request-topic',
path: '/1024//58',
bodyEncoder: allConverters.ascii,
},
getResponseTopic: {
method: TapRequestFrame.MethodType.GET,
pathAlias: '/mqtt/response-topic',
path: '/1024//59',
responseBodyDecoder: allConverters.ascii,
},
putResponseTopic: {
method: TapRequestFrame.MethodType.PUT,
pathAlias: '/mqtt/response-topic',
path: '/1024//59',
bodyEncoder: allConverters.ascii,
},
};
class MqttService extends AbstractService {
constructor() {
super(...arguments);
this.resources = SERVICE_CALLS;
}
/**
* Get mqtt relay client id
*
* LWM2M path: /1024//52
*
* @tapVersion(">=1.86")
* @return
*/
getClientId() {
return this.serviceCallRunner.execute(this.getClientIdCall());
}
/**
*
*
* LWM2M path: /1024//52
*
* @tapVersion(">=1.86")
* @return call options
*/
getClientIdCall() {
const callOptions = Object.assign({}, this.resources.getClientId);
return callOptions;
}
/**
* Set mqtt relay client id
*
* LWM2M path: /1024//52
*
* @tapVersion(">=1.86")
* @param url input
* @return
*/
putClientId(
/*
*
*/
url) {
return this.serviceCallRunner.execute(this.putClientIdCall(url));
}
/**
*
*
* LWM2M path: /1024//52
*
* @tapVersion(">=1.86")
* @param url input
* @return call options
*/
putClientIdCall(
/*
*
*/
url) {
const callOptions = Object.assign({}, this.resources.putClientId);
callOptions.body = url;
return callOptions;
}
/**
* Get mqtt relay login. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//53
*
* @deprecated
* @tapVersion(">=1.86")
* @return
*/
getUsername() {
return this.serviceCallRunner.execute(this.getUsernameCall());
}
/**
*
*
* LWM2M path: /1024//53
*
* @deprecated
* @tapVersion(">=1.86")
* @return call options
*/
getUsernameCall() {
const callOptions = Object.assign({}, this.resources.getUsername);
return callOptions;
}
/**
* Write mqtt relay password id. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//53
*
* @tapVersion(">=1.86")
* @param url input
* @return
*/
putUsername(
/*
*
*/
url) {
return this.serviceCallRunner.execute(this.putUsernameCall(url));
}
/**
*
*
* LWM2M path: /1024//53
*
* @tapVersion(">=1.86")
* @param url input
* @return call options
*/
putUsernameCall(
/*
*
*/
url) {
const callOptions = Object.assign({}, this.resources.putUsername);
callOptions.body = url;
return callOptions;
}
/**
* Get mqtt broker hostname
*
* LWM2M path: /1024//50
*
* @tapVersion(">=1.0")
* @return
*/
getBrokerHostname() {
return this.serviceCallRunner.execute(this.getBrokerHostnameCall());
}
/**
*
*
* LWM2M path: /1024//50
*
* @tapVersion(">=1.0")
* @return call options
*/
getBrokerHostnameCall() {
const callOptions = Object.assign({}, this.resources.getBrokerHostname);
return callOptions;
}
/**
* Write mqtt relay host
*
* LWM2M path: /1024//50
*
* @tapVersion(">=1.0")
* @param url input
* @return
*/
putBrokerHostname(
/*
*
*/
url) {
return this.serviceCallRunner.execute(this.putBrokerHostnameCall(url));
}
/**
*
*
* LWM2M path: /1024//50
*
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putBrokerHostnameCall(
/*
*
*/
url) {
const callOptions = Object.assign({}, this.resources.putBrokerHostname);
callOptions.body = url;
return callOptions;
}
/**
* Get port of the mqtt broker
*
* LWM2M path: /1024//51
*
* @tapVersion(">=1.0")
* @return
*/
getBrokerPort() {
return this.serviceCallRunner.execute(this.getBrokerPortCall());
}
/**
*
*
* LWM2M path: /1024//51
*
* @tapVersion(">=1.0")
* @return call options
*/
getBrokerPortCall() {
const callOptions = Object.assign({}, this.resources.getBrokerPort);
return callOptions;
}
/**
* Write service name of the mqtt broker
*
* LWM2M path: /1024//51
*
* @tapVersion(">=1.0")
* @param url input
* @return
*/
putBrokerPort(
/*
*
*/
url) {
return this.serviceCallRunner.execute(this.putBrokerPortCall(url));
}
/**
*
*
* LWM2M path: /1024//51
*
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putBrokerPortCall(
/*
*
*/
url) {
const callOptions = Object.assign({}, this.resources.putBrokerPort);
callOptions.body = url;
return callOptions;
}
/**
* Get the mqtt broker password
*
* LWM2M path: /1024//54
*
* @tapVersion(">=1.0")
* @return
*/
getPassword() {
return this.serviceCallRunner.execute(this.getPasswordCall());
}
/**
*
*
* LWM2M path: /1024//54
*
* @tapVersion(">=1.0")
* @return call options
*/
getPasswordCall() {
const callOptions = Object.assign({}, this.resources.getPassword);
return callOptions;
}
/**
* Write mqtt broker password
*
* LWM2M path: /1024//54
*
* @tapVersion(">=1.0")
* @param url input
* @return
*/
putPassword(
/*
*
*/
url) {
return this.serviceCallRunner.execute(this.putPasswordCall(url));
}
/**
*
*
* LWM2M path: /1024//54
*
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putPasswordCall(
/*
*
*/
url) {
const callOptions = Object.assign({}, this.resources.putPassword);
callOptions.body = url;
return callOptions;
}
/**
* Get the mqtt relay net key
*
* LWM2M path: /1024//55
*
* @tapVersion(">=1.0")
* @return
*/
getRelayNetKey() {
return this.serviceCallRunner.execute(this.getRelayNetKeyCall());
}
/**
*
*
* LWM2M path: /1024//55
*
* @tapVersion(">=1.0")
* @return call options
*/
getRelayNetKeyCall() {
const callOptions = Object.assign({}, this.resources.getRelayNetKey);
return callOptions;
}
/**
* Write mqtt relay net key
*
* LWM2M path: /1024//55
*
* @tapVersion(">=1.0")
* @param netkey input
* @return
*/
putRelayNetKey(
/*
*
*/
netkey) {
return this.serviceCallRunner.execute(this.putRelayNetKeyCall(netkey));
}
/**
*
*
* LWM2M path: /1024//55
*
* @tapVersion(">=1.0")
* @param netkey input
* @return call options
*/
putRelayNetKeyCall(
/*
*
*/
netkey) {
const callOptions = Object.assign({}, this.resources.putRelayNetKey);
callOptions.body = netkey;
return callOptions;
}
/**
* Set MQTT broker certificate data
*
* LWM2M path: /1024//57
*
* @tapVersion(">=1.86")
* @param value input
* @return
*/
putBrokerCertificate(
/*
* Up to 16kB
*/
value) {
return this.serviceCallRunner.execute(this.putBrokerCertificateCall(value));
}
putBrokerCertificateAppendCalls(
/*
* Up to 16kB
*/
value, chunkSize) {
return this.serviceCallRunner.createAppendCalls(this.putBrokerCertificateCall(value), chunkSize);
}
/**
*
*
* LWM2M path: /1024//57
*
* @tapVersion(">=1.86")
* @param value input
* @return call options
*/
putBrokerCertificateCall(
/*
* Up to 16kB
*/
value) {
const callOptions = Object.assign({}, this.resources.putBrokerCertificate);
callOptions.body = value;
return callOptions;
}
/**
* Get MQTT relay topic prefix
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @return
*/
getTopicPrefix() {
return this.serviceCallRunner.execute(this.getTopicPrefixCall());
}
/**
*
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @return call options
*/
getTopicPrefixCall() {
const callOptions = Object.assign({}, this.resources.getTopicPrefix);
return callOptions;
}
/**
* Put MQTT relay topic prefix
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @param topicPrefix input
* @return
*/
putTopicPrefix(
/*
*
*/
topicPrefix) {
return this.serviceCallRunner.execute(this.putTopicPrefixCall(topicPrefix));
}
/**
*
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @param topicPrefix input
* @return call options
*/
putTopicPrefixCall(
/*
*
*/
topicPrefix) {
const callOptions = Object.assign({}, this.resources.putTopicPrefix);
callOptions.body = topicPrefix;
return callOptions;
}
/**
* Get mqtt request topic
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @return
*/
getRequestTopic() {
return this.serviceCallRunner.execute(this.getRequestTopicCall());
}
/**
*
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @return call options
*/
getRequestTopicCall() {
const callOptions = Object.assign({}, this.resources.getRequestTopic);
return callOptions;
}
/**
* Put mqtt request topic
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @param topic input
* @return
*/
putRequestTopic(
/*
*
*/
topic) {
return this.serviceCallRunner.execute(this.putRequestTopicCall(topic));
}
/**
*
*
* LWM2M path: /1024//58
*
* @tapVersion(">=1.86")
* @param topic input
* @return call options
*/
putRequestTopicCall(
/*
*
*/
topic) {
const callOptions = Object.assign({}, this.resources.putRequestTopic);
callOptions.body = topic;
return callOptions;
}
/**
* Get MQTT response topic
*
* LWM2M path: /1024//59
*
* @tapVersion(">=1.107")
* @return
*/
getResponseTopic() {
return this.serviceCallRunner.execute(this.getResponseTopicCall());
}
/**
*
*
* LWM2M path: /1024//59
*
* @tapVersion(">=1.107")
* @return call options
*/
getResponseTopicCall() {
const callOptions = Object.assign({}, this.resources.getResponseTopic);
return callOptions;
}
/**
* Put MQTT response topic
*
* LWM2M path: /1024//59
*
* @tapVersion(">=1.107")
* @param topic input
* @return
*/
putResponseTopic(
/*
*
*/
topic) {
return this.serviceCallRunner.execute(this.putResponseTopicCall(topic));
}
/**
*
*
* LWM2M path: /1024//59
*
* @tapVersion(">=1.107")
* @param topic input
* @return call options
*/
putResponseTopicCall(
/*
*
*/
topic) {
const callOptions = Object.assign({}, this.resources.putResponseTopic);
callOptions.body = topic;
return callOptions;
}
}
const _TAP_SERVICE_EXTENSION_MQTT_ = extendServiceContainer('mqtt', MqttService);
/**
* Generated file. Do not edit
*/
/**
* Generated file. Do not edit
*/
/**
* Generated file. Do not edit
*/
const ResourceMetaData = {
'/mqtt/client-id': {
put: {
minApiVersion: 1.86,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 32,
},
},
},
'/mqtt/username': {
put: {
minApiVersion: 1.86,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 32,
},
},
},
'/mqtt/broker-hostname': {
put: {
minApiVersion: 1.0,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 64,
},
},
},
'/mqtt/broker-port': {
put: {
minApiVersion: 1.0,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 32,
},
},
},
'/mqtt/password': {
put: {
minApiVersion: 1.0,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 32,
},
},
},
'/mqtt/relay-net-key': {
put: {
minApiVersion: 1.0,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 32,
},
},
},
'/mqtt/broker-certificate': {
put: {
minApiVersion: 1.86,
configModeRequired: false,
schema: {
$ref: './definitions.yaml#/Bytes',
},
},
},
'/mqtt/topic-prefix': {
put: {
minApiVersion: 1.86,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 100,
},
},
},
'/mqtt/request-topic': {
put: {
minApiVersion: 1.86,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 100,
},
},
},
'/mqtt/response-topic': {
put: {
minApiVersion: 1.107,
configModeRequired: false,
schema: {
type: 'string',
maxLength: 100,
},
},
},
};
// import './lib/custom/extension';
/**
* Generated bundle index. Do not edit.
*/
export { SERVICE_CALLS as MQTT_SERVICE_CALLS, ResourceMetaData as MqttResourceMetaData, MqttService, _TAP_SERVICE_EXTENSION_MQTT_, serviceConverters as mqttConverters };
//# sourceMappingURL=iotize-tap-service-impl-mqtt.js.map