From b347428b1900fad9020f93bcac1ab5d12379cf31 Mon Sep 17 00:00:00 2001 From: Marin Karamihalev <marin.karamihalev@iopsys.eu> Date: Wed, 23 Dec 2020 10:37:05 +0100 Subject: [PATCH] Added config changes for 6.0 --- README.md | 1 + docs/assets/js/search.json | 2 +- docs/index.html | 4 +- docs/interfaces/_types_d_.addmessage.html | 20 +- docs/interfaces/_types_d_.basemessage.html | 23 +- docs/interfaces/_types_d_.connectevents.html | 12 + docs/interfaces/_types_d_.deletemessage.html | 20 +- docs/interfaces/_types_d_.device.html | 51 ++- docs/interfaces/_types_d_.deviceerror.html | 18 +- docs/interfaces/_types_d_.encodeargs.html | 36 +- docs/interfaces/_types_d_.errormessage.html | 20 +- docs/interfaces/_types_d_.getmessage.html | 20 +- docs/interfaces/_types_d_.initresult.html | 14 +- docs/interfaces/_types_d_.mqttrequest.html | 16 +- docs/interfaces/_types_d_.notifymessage.html | 316 ++++++++++++++++++ docs/interfaces/_types_d_.operatemessage.html | 20 +- docs/interfaces/_types_d_.operateoptions.html | 289 ++++++++++++++++ docs/interfaces/_types_d_.protocol.html | 20 +- docs/interfaces/_types_d_.protocolargs.html | 16 +- docs/interfaces/_types_d_.protocolevents.html | 14 +- docs/interfaces/_types_d_.setmessage.html | 20 +- docs/modules/_index_.html | 109 +++++- docs/modules/_protocol_index_.html | 56 +++- docs/modules/_types_d_.html | 98 +++++- package.json | 2 +- src/index.ts | 4 +- src/protocol/index.ts | 13 +- src/protocol/js-usp-protobuf/protoMessage.ts | 10 +- src/protocol/js-usp-protobuf/usp/pbRecord.ts | 11 +- src/types.d.ts | 9 + tests/integration/config.json | 8 +- 31 files changed, 1163 insertions(+), 109 deletions(-) create mode 100644 docs/interfaces/_types_d_.notifymessage.html create mode 100644 docs/interfaces/_types_d_.operateoptions.html diff --git a/README.md b/README.md index 558b0a0..7d33ce5 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ run(); - Connect ```javascript // options are based on https://github.com/mqttjs/MQTT.js#mqttconnecturl-options +// they additionaly require fromId and toId, more info: url.here const usp = await connect(options); ``` diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json index 41d4f8e..ec1b409 100644 --- a/docs/assets/js/search.json +++ b/docs/assets/js/search.json @@ -1 +1 @@ -{"kinds":{"1":"Module","32":"Variable","64":"Function","256":"Interface","1024":"Property","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"\"protocol/js-usp-protobuf/protoMessage\"","url":"modules/_protocol_js_usp_protobuf_protomessage_.html","classes":"tsd-kind-module"},{"id":1,"kind":32,"name":"rootRecord","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#rootrecord","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":2,"kind":32,"name":"rootMsg","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#rootmsg","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":3,"kind":32,"name":"Header","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#header","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":4,"kind":64,"name":"init","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#init","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":5,"kind":64,"name":"makeGetMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makegetmessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":6,"kind":64,"name":"makeDeleteMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makedeletemessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":7,"kind":64,"name":"makeSetMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makesetmessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":8,"kind":64,"name":"makeAddMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makeaddmessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":9,"kind":64,"name":"makeOperateMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makeoperatemessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":10,"kind":64,"name":"decode","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#decode","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":11,"kind":1,"name":"\"protocol/lib\"","url":"modules/_protocol_lib_.html","classes":"tsd-kind-module"},{"id":12,"kind":32,"name":"digitRe","url":"modules/_protocol_lib_.html#digitre","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":13,"kind":32,"name":"digitDotRe","url":"modules/_protocol_lib_.html#digitdotre","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":14,"kind":64,"name":"isDigit","url":"modules/_protocol_lib_.html#isdigit","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":15,"kind":64,"name":"firstIsIndex","url":"modules/_protocol_lib_.html#firstisindex","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":16,"kind":64,"name":"unflatten","url":"modules/_protocol_lib_.html#unflatten","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":17,"kind":64,"name":"search","url":"modules/_protocol_lib_.html#search","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":18,"kind":64,"name":"_searchAll","url":"modules/_protocol_lib_.html#_searchall","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":19,"kind":64,"name":"searchAll","url":"modules/_protocol_lib_.html#searchall","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":20,"kind":64,"name":"unwrapObject","url":"modules/_protocol_lib_.html#unwrapobject","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":21,"kind":64,"name":"unwrapArray","url":"modules/_protocol_lib_.html#unwraparray","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":22,"kind":1,"name":"\"protocol/index\"","url":"modules/_protocol_index_.html","classes":"tsd-kind-module"},{"id":23,"kind":64,"name":"encodeGet","url":"modules/_protocol_index_.html#encodeget","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":24,"kind":64,"name":"encodeSet","url":"modules/_protocol_index_.html#encodeset","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":25,"kind":64,"name":"encodeOperate","url":"modules/_protocol_index_.html#encodeoperate","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":26,"kind":64,"name":"extractType","url":"modules/_protocol_index_.html#extracttype","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":27,"kind":64,"name":"decodeGet","url":"modules/_protocol_index_.html#decodeget","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":28,"kind":64,"name":"decode","url":"modules/_protocol_index_.html#decode","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":29,"kind":64,"name":"encodeAdd","url":"modules/_protocol_index_.html#encodeadd","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":30,"kind":64,"name":"encodeDelete","url":"modules/_protocol_index_.html#encodedelete","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":31,"kind":64,"name":"encode","url":"modules/_protocol_index_.html#encode","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":32,"kind":64,"name":"connect","url":"modules/_protocol_index_.html#connect","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/index\""},{"id":33,"kind":64,"name":"mqtt","url":"modules/_protocol_index_.html#mqtt","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/index\""},{"id":34,"kind":1,"name":"\"lib\"","url":"modules/_lib_.html","classes":"tsd-kind-module"},{"id":35,"kind":64,"name":"timer","url":"modules/_lib_.html#timer","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"lib\""},{"id":36,"kind":64,"name":"loopTimer","url":"modules/_lib_.html#looptimer","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"lib\""},{"id":37,"kind":64,"name":"makeRouter","url":"modules/_lib_.html#makerouter","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"lib\""},{"id":38,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-module"},{"id":39,"kind":64,"name":"addDot","url":"modules/_index_.html#adddot","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":40,"kind":64,"name":"splitReference","url":"modules/_index_.html#splitreference","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":41,"kind":64,"name":"resolveReferences","url":"modules/_index_.html#resolvereferences","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":42,"kind":64,"name":"throwMsgError","url":"modules/_index_.html#throwmsgerror","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":43,"kind":64,"name":"throwError","url":"modules/_index_.html#throwerror","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":44,"kind":64,"name":"isReference","url":"modules/_index_.html#isreference","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":45,"kind":64,"name":"isError","url":"modules/_index_.html#iserror","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":46,"kind":64,"name":"isPromiseResult","url":"modules/_index_.html#ispromiseresult","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":47,"kind":32,"name":"commandsWithReturnValue","url":"modules/_index_.html#commandswithreturnvalue","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":48,"kind":64,"name":"decode","url":"modules/_index_.html#decode","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":49,"kind":64,"name":"handleSend","url":"modules/_index_.html#handlesend","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":50,"kind":64,"name":"makeGet","url":"modules/_index_.html#makeget","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":51,"kind":64,"name":"makeSet","url":"modules/_index_.html#makeset","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":52,"kind":64,"name":"makeAdd","url":"modules/_index_.html#makeadd","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":53,"kind":64,"name":"makeDel","url":"modules/_index_.html#makedel","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":54,"kind":64,"name":"makeOperate","url":"modules/_index_.html#makeoperate","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":55,"kind":64,"name":"connect","url":"modules/_index_.html#connect","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":56,"kind":1,"name":"\"types.d\"","url":"modules/_types_d_.html","classes":"tsd-kind-module"},{"id":57,"kind":256,"name":"ConnectEvents","url":"interfaces/_types_d_.connectevents.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":58,"kind":1024,"name":"onTimeout","url":"interfaces/_types_d_.connectevents.html#ontimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ConnectEvents"},{"id":59,"kind":256,"name":"Device","url":"interfaces/_types_d_.device.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":60,"kind":1024,"name":"get","url":"interfaces/_types_d_.device.html#get","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":61,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#get.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.get"},{"id":62,"kind":1024,"name":"set","url":"interfaces/_types_d_.device.html#set","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":63,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#set.__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.set"},{"id":64,"kind":1024,"name":"operate","url":"interfaces/_types_d_.device.html#operate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":65,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#operate.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.operate"},{"id":66,"kind":1024,"name":"add","url":"interfaces/_types_d_.device.html#add","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":67,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#add.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.add"},{"id":68,"kind":1024,"name":"del","url":"interfaces/_types_d_.device.html#del","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":69,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#del.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.del"},{"id":70,"kind":1024,"name":"resolve","url":"interfaces/_types_d_.device.html#resolve","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":71,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#resolve.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.resolve"},{"id":72,"kind":1024,"name":"disconnect","url":"interfaces/_types_d_.device.html#disconnect","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":73,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#disconnect.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.disconnect"},{"id":74,"kind":1024,"name":"id","url":"interfaces/_types_d_.device.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":75,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#id.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.id"},{"id":76,"kind":1024,"name":"roles","url":"interfaces/_types_d_.device.html#roles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":77,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#roles.__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.roles"},{"id":78,"kind":256,"name":"EncodeArgs","url":"interfaces/_types_d_.encodeargs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":79,"kind":1024,"name":"path","url":"interfaces/_types_d_.encodeargs.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":80,"kind":1024,"name":"paths","url":"interfaces/_types_d_.encodeargs.html#paths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":81,"kind":1024,"name":"value","url":"interfaces/_types_d_.encodeargs.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":82,"kind":1024,"name":"input","url":"interfaces/_types_d_.encodeargs.html#input","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":83,"kind":1024,"name":"action","url":"interfaces/_types_d_.encodeargs.html#action","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":84,"kind":256,"name":"DeviceError","url":"interfaces/_types_d_.deviceerror.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":85,"kind":1024,"name":"type","url":"interfaces/_types_d_.deviceerror.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".DeviceError"},{"id":86,"kind":1024,"name":"reason","url":"interfaces/_types_d_.deviceerror.html#reason","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".DeviceError"},{"id":87,"kind":1024,"name":"path","url":"interfaces/_types_d_.deviceerror.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".DeviceError"},{"id":88,"kind":256,"name":"BaseMessage","url":"interfaces/_types_d_.basemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":89,"kind":1024,"name":"id","url":"interfaces/_types_d_.basemessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":90,"kind":1024,"name":"type","url":"interfaces/_types_d_.basemessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":91,"kind":1024,"name":"path","url":"interfaces/_types_d_.basemessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":92,"kind":1024,"name":"data","url":"interfaces/_types_d_.basemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":93,"kind":65536,"name":"__type","url":"interfaces/_types_d_.basemessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".BaseMessage.data"},{"id":94,"kind":256,"name":"ErrorMessage","url":"interfaces/_types_d_.errormessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":95,"kind":1024,"name":"type","url":"interfaces/_types_d_.errormessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".ErrorMessage"},{"id":96,"kind":1024,"name":"data","url":"interfaces/_types_d_.errormessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".ErrorMessage"},{"id":97,"kind":65536,"name":"__type","url":"interfaces/_types_d_.errormessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ErrorMessage.data"},{"id":98,"kind":32,"name":"reason","url":"interfaces/_types_d_.errormessage.html#data.__type.reason","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".ErrorMessage.data.__type"},{"id":99,"kind":1024,"name":"id","url":"interfaces/_types_d_.errormessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".ErrorMessage"},{"id":100,"kind":1024,"name":"path","url":"interfaces/_types_d_.errormessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".ErrorMessage"},{"id":101,"kind":256,"name":"GetMessage","url":"interfaces/_types_d_.getmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":102,"kind":1024,"name":"type","url":"interfaces/_types_d_.getmessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".GetMessage"},{"id":103,"kind":1024,"name":"data","url":"interfaces/_types_d_.getmessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".GetMessage"},{"id":104,"kind":1024,"name":"id","url":"interfaces/_types_d_.getmessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".GetMessage"},{"id":105,"kind":1024,"name":"path","url":"interfaces/_types_d_.getmessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".GetMessage"},{"id":106,"kind":256,"name":"SetMessage","url":"interfaces/_types_d_.setmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":107,"kind":1024,"name":"type","url":"interfaces/_types_d_.setmessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".SetMessage"},{"id":108,"kind":1024,"name":"data","url":"interfaces/_types_d_.setmessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".SetMessage"},{"id":109,"kind":65536,"name":"__type","url":"interfaces/_types_d_.setmessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".SetMessage.data"},{"id":110,"kind":32,"name":"updated","url":"interfaces/_types_d_.setmessage.html#data.__type.updated","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".SetMessage.data.__type"},{"id":111,"kind":1024,"name":"id","url":"interfaces/_types_d_.setmessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".SetMessage"},{"id":112,"kind":1024,"name":"path","url":"interfaces/_types_d_.setmessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".SetMessage"},{"id":113,"kind":256,"name":"OperateMessage","url":"interfaces/_types_d_.operatemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":114,"kind":1024,"name":"type","url":"interfaces/_types_d_.operatemessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".OperateMessage"},{"id":115,"kind":1024,"name":"data","url":"interfaces/_types_d_.operatemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".OperateMessage"},{"id":116,"kind":1024,"name":"id","url":"interfaces/_types_d_.operatemessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".OperateMessage"},{"id":117,"kind":1024,"name":"path","url":"interfaces/_types_d_.operatemessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".OperateMessage"},{"id":118,"kind":256,"name":"AddMessage","url":"interfaces/_types_d_.addmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":119,"kind":1024,"name":"type","url":"interfaces/_types_d_.addmessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".AddMessage"},{"id":120,"kind":1024,"name":"data","url":"interfaces/_types_d_.addmessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".AddMessage"},{"id":121,"kind":1024,"name":"id","url":"interfaces/_types_d_.addmessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".AddMessage"},{"id":122,"kind":1024,"name":"path","url":"interfaces/_types_d_.addmessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".AddMessage"},{"id":123,"kind":256,"name":"DeleteMessage","url":"interfaces/_types_d_.deletemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":124,"kind":1024,"name":"type","url":"interfaces/_types_d_.deletemessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".DeleteMessage"},{"id":125,"kind":1024,"name":"data","url":"interfaces/_types_d_.deletemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".DeleteMessage"},{"id":126,"kind":65536,"name":"__type","url":"interfaces/_types_d_.deletemessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".DeleteMessage.data"},{"id":127,"kind":32,"name":"deleted","url":"interfaces/_types_d_.deletemessage.html#data.__type.deleted","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".DeleteMessage.data.__type"},{"id":128,"kind":1024,"name":"id","url":"interfaces/_types_d_.deletemessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".DeleteMessage"},{"id":129,"kind":1024,"name":"path","url":"interfaces/_types_d_.deletemessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".DeleteMessage"},{"id":130,"kind":256,"name":"ProtocolArgs","url":"interfaces/_types_d_.protocolargs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":131,"kind":1024,"name":"onMessage","url":"interfaces/_types_d_.protocolargs.html#onmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ProtocolArgs"},{"id":132,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocolargs.html#onmessage.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ProtocolArgs.onMessage"},{"id":133,"kind":1024,"name":"onError","url":"interfaces/_types_d_.protocolargs.html#onerror","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ProtocolArgs"},{"id":134,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocolargs.html#onerror.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ProtocolArgs.onError"},{"id":135,"kind":256,"name":"InitResult","url":"interfaces/_types_d_.initresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":136,"kind":1024,"name":"timeout","url":"interfaces/_types_d_.initresult.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".InitResult"},{"id":137,"kind":256,"name":"Protocol","url":"interfaces/_types_d_.protocol.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":138,"kind":1024,"name":"init","url":"interfaces/_types_d_.protocol.html#init","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":139,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#init.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.init"},{"id":140,"kind":1024,"name":"close","url":"interfaces/_types_d_.protocol.html#close","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":141,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#close.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.close"},{"id":142,"kind":1024,"name":"send","url":"interfaces/_types_d_.protocol.html#send","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":143,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#send.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.send"},{"id":144,"kind":1024,"name":"encode","url":"interfaces/_types_d_.protocol.html#encode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":145,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#encode.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.encode"},{"id":146,"kind":256,"name":"ProtocolEvents","url":"interfaces/_types_d_.protocolevents.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":147,"kind":1024,"name":"onMessage","url":"interfaces/_types_d_.protocolevents.html#onmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ProtocolEvents"},{"id":148,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocolevents.html#onmessage.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ProtocolEvents.onMessage"},{"id":149,"kind":256,"name":"MQTTRequest","url":"interfaces/_types_d_.mqttrequest.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":150,"kind":1024,"name":"id","url":"interfaces/_types_d_.mqttrequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".MQTTRequest"},{"id":151,"kind":1024,"name":"data","url":"interfaces/_types_d_.mqttrequest.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".MQTTRequest"},{"id":152,"kind":4194304,"name":"PromiseResult","url":"modules/_types_d_.html#promiseresult","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":153,"kind":65536,"name":"__type","url":"modules/_types_d_.html#promiseresult.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".PromiseResult"},{"id":154,"kind":32,"name":"resolve","url":"modules/_types_d_.html#promiseresult.__type-1.resolve","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".PromiseResult.__type"},{"id":155,"kind":32,"name":"reject","url":"modules/_types_d_.html#promiseresult.__type-1.reject","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".PromiseResult.__type"},{"id":156,"kind":4194304,"name":"Router","url":"modules/_types_d_.html#router","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":157,"kind":4194304,"name":"SendFn","url":"modules/_types_d_.html#sendfn","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":158,"kind":65536,"name":"__type","url":"modules/_types_d_.html#sendfn.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".SendFn"},{"id":159,"kind":4194304,"name":"Role","url":"modules/_types_d_.html#role","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":160,"kind":4194304,"name":"JSObject","url":"modules/_types_d_.html#jsobject","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":161,"kind":65536,"name":"__type","url":"modules/_types_d_.html#jsobject.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".JSObject"},{"id":162,"kind":4194304,"name":"CommandType","url":"modules/_types_d_.html#commandtype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":163,"kind":4194304,"name":"MessageType","url":"modules/_types_d_.html#messagetype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":164,"kind":4194304,"name":"JSType","url":"modules/_types_d_.html#jstype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":165,"kind":4194304,"name":"USPMessage","url":"modules/_types_d_.html#uspmessage","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,14.835,1,14.835,2,14.835]],["parent/0",[]],["name/1",[3,47.356]],["parent/1",[0,1.553,1,1.553,2,1.553]],["name/2",[4,47.356]],["parent/2",[0,1.553,1,1.553,2,1.553]],["name/3",[5,47.356]],["parent/3",[0,1.553,1,1.553,2,1.553]],["name/4",[6,42.223]],["parent/4",[0,1.553,1,1.553,2,1.553]],["name/5",[7,47.356]],["parent/5",[0,1.553,1,1.553,2,1.553]],["name/6",[8,47.356]],["parent/6",[0,1.553,1,1.553,2,1.553]],["name/7",[9,47.356]],["parent/7",[0,1.553,1,1.553,2,1.553]],["name/8",[10,47.356]],["parent/8",[0,1.553,1,1.553,2,1.553]],["name/9",[11,47.356]],["parent/9",[0,1.553,1,1.553,2,1.553]],["name/10",[12,38.841]],["parent/10",[0,1.553,1,1.553,2,1.553]],["name/11",[13,26.887]],["parent/11",[]],["name/12",[14,47.356]],["parent/12",[13,2.764]],["name/13",[15,47.356]],["parent/13",[13,2.764]],["name/14",[16,47.356]],["parent/14",[13,2.764]],["name/15",[17,47.356]],["parent/15",[13,2.764]],["name/16",[18,47.356]],["parent/16",[13,2.764]],["name/17",[19,47.356]],["parent/17",[13,2.764]],["name/18",[20,47.356]],["parent/18",[13,2.764]],["name/19",[21,47.356]],["parent/19",[13,2.764]],["name/20",[22,47.356]],["parent/20",[13,2.764]],["name/21",[23,47.356]],["parent/21",[13,2.764]],["name/22",[24,26.05]],["parent/22",[]],["name/23",[25,47.356]],["parent/23",[24,2.677]],["name/24",[26,47.356]],["parent/24",[24,2.677]],["name/25",[27,47.356]],["parent/25",[24,2.677]],["name/26",[28,47.356]],["parent/26",[24,2.677]],["name/27",[29,47.356]],["parent/27",[24,2.677]],["name/28",[12,38.841]],["parent/28",[24,2.677]],["name/29",[30,47.356]],["parent/29",[24,2.677]],["name/30",[31,47.356]],["parent/30",[24,2.677]],["name/31",[32,42.223]],["parent/31",[24,2.677]],["name/32",[33,42.223]],["parent/32",[24,2.677]],["name/33",[34,47.356]],["parent/33",[24,2.677]],["name/34",[35,36.316]],["parent/34",[]],["name/35",[36,47.356]],["parent/35",[35,3.733]],["name/36",[37,47.356]],["parent/36",[35,3.733]],["name/37",[38,47.356]],["parent/37",[35,3.733]],["name/38",[39,22.11]],["parent/38",[]],["name/39",[40,47.356]],["parent/39",[39,2.273]],["name/40",[41,47.356]],["parent/40",[39,2.273]],["name/41",[42,47.356]],["parent/41",[39,2.273]],["name/42",[43,47.356]],["parent/42",[39,2.273]],["name/43",[44,47.356]],["parent/43",[39,2.273]],["name/44",[45,47.356]],["parent/44",[39,2.273]],["name/45",[46,47.356]],["parent/45",[39,2.273]],["name/46",[47,47.356]],["parent/46",[39,2.273]],["name/47",[48,47.356]],["parent/47",[39,2.273]],["name/48",[12,38.841]],["parent/48",[39,2.273]],["name/49",[49,47.356]],["parent/49",[39,2.273]],["name/50",[50,47.356]],["parent/50",[39,2.273]],["name/51",[51,47.356]],["parent/51",[39,2.273]],["name/52",[52,47.356]],["parent/52",[39,2.273]],["name/53",[53,47.356]],["parent/53",[39,2.273]],["name/54",[54,47.356]],["parent/54",[39,2.273]],["name/55",[33,42.223]],["parent/55",[39,2.273]],["name/56",[55,18.499]],["parent/56",[]],["name/57",[56,47.356]],["parent/57",[55,1.901]],["name/58",[57,47.356]],["parent/58",[58,4.867]],["name/59",[59,47.356]],["parent/59",[55,1.901]],["name/60",[60,47.356]],["parent/60",[61,2.961]],["name/61",[62,19.706]],["parent/61",[63,4.867]],["name/62",[64,47.356]],["parent/62",[61,2.961]],["name/63",[62,19.706]],["parent/63",[65,4.867]],["name/64",[66,47.356]],["parent/64",[61,2.961]],["name/65",[62,19.706]],["parent/65",[67,4.867]],["name/66",[68,47.356]],["parent/66",[61,2.961]],["name/67",[62,19.706]],["parent/67",[69,4.867]],["name/68",[70,47.356]],["parent/68",[61,2.961]],["name/69",[62,19.706]],["parent/69",[71,4.867]],["name/70",[72,42.223]],["parent/70",[61,2.961]],["name/71",[62,19.706]],["parent/71",[73,4.867]],["name/72",[74,47.356]],["parent/72",[61,2.961]],["name/73",[62,19.706]],["parent/73",[75,4.867]],["name/74",[76,28.807]],["parent/74",[61,2.961]],["name/75",[62,19.706]],["parent/75",[77,4.867]],["name/76",[78,47.356]],["parent/76",[61,2.961]],["name/77",[62,19.706]],["parent/77",[79,4.867]],["name/78",[80,47.356]],["parent/78",[55,1.901]],["name/79",[81,28.807]],["parent/79",[82,3.525]],["name/80",[83,47.356]],["parent/80",[82,3.525]],["name/81",[84,47.356]],["parent/81",[82,3.525]],["name/82",[85,47.356]],["parent/82",[82,3.525]],["name/83",[86,47.356]],["parent/83",[82,3.525]],["name/84",[87,47.356]],["parent/84",[55,1.901]],["name/85",[88,29.925]],["parent/85",[89,3.992]],["name/86",[90,42.223]],["parent/86",[89,3.992]],["name/87",[81,28.807]],["parent/87",[89,3.992]],["name/88",[91,47.356]],["parent/88",[55,1.901]],["name/89",[76,28.807]],["parent/89",[92,3.733]],["name/90",[88,29.925]],["parent/90",[92,3.733]],["name/91",[81,28.807]],["parent/91",[92,3.733]],["name/92",[93,29.925]],["parent/92",[92,3.733]],["name/93",[62,19.706]],["parent/93",[94,4.867]],["name/94",[95,47.356]],["parent/94",[55,1.901]],["name/95",[88,29.925]],["parent/95",[96,3.733]],["name/96",[93,29.925]],["parent/96",[96,3.733]],["name/97",[62,19.706]],["parent/97",[97,4.867]],["name/98",[90,42.223]],["parent/98",[98,4.867]],["name/99",[76,28.807]],["parent/99",[96,3.733]],["name/100",[81,28.807]],["parent/100",[96,3.733]],["name/101",[99,47.356]],["parent/101",[55,1.901]],["name/102",[88,29.925]],["parent/102",[100,3.733]],["name/103",[93,29.925]],["parent/103",[100,3.733]],["name/104",[76,28.807]],["parent/104",[100,3.733]],["name/105",[81,28.807]],["parent/105",[100,3.733]],["name/106",[101,47.356]],["parent/106",[55,1.901]],["name/107",[88,29.925]],["parent/107",[102,3.733]],["name/108",[93,29.925]],["parent/108",[102,3.733]],["name/109",[62,19.706]],["parent/109",[103,4.867]],["name/110",[104,47.356]],["parent/110",[105,4.867]],["name/111",[76,28.807]],["parent/111",[102,3.733]],["name/112",[81,28.807]],["parent/112",[102,3.733]],["name/113",[106,47.356]],["parent/113",[55,1.901]],["name/114",[88,29.925]],["parent/114",[107,3.733]],["name/115",[93,29.925]],["parent/115",[107,3.733]],["name/116",[76,28.807]],["parent/116",[107,3.733]],["name/117",[81,28.807]],["parent/117",[107,3.733]],["name/118",[108,47.356]],["parent/118",[55,1.901]],["name/119",[88,29.925]],["parent/119",[109,3.733]],["name/120",[93,29.925]],["parent/120",[109,3.733]],["name/121",[76,28.807]],["parent/121",[109,3.733]],["name/122",[81,28.807]],["parent/122",[109,3.733]],["name/123",[110,47.356]],["parent/123",[55,1.901]],["name/124",[88,29.925]],["parent/124",[111,3.733]],["name/125",[93,29.925]],["parent/125",[111,3.733]],["name/126",[62,19.706]],["parent/126",[112,4.867]],["name/127",[113,47.356]],["parent/127",[114,4.867]],["name/128",[76,28.807]],["parent/128",[111,3.733]],["name/129",[81,28.807]],["parent/129",[111,3.733]],["name/130",[115,47.356]],["parent/130",[55,1.901]],["name/131",[116,42.223]],["parent/131",[117,4.34]],["name/132",[62,19.706]],["parent/132",[118,4.867]],["name/133",[119,47.356]],["parent/133",[117,4.34]],["name/134",[62,19.706]],["parent/134",[120,4.867]],["name/135",[121,47.356]],["parent/135",[55,1.901]],["name/136",[122,47.356]],["parent/136",[123,4.867]],["name/137",[124,47.356]],["parent/137",[55,1.901]],["name/138",[6,42.223]],["parent/138",[125,3.733]],["name/139",[62,19.706]],["parent/139",[126,4.867]],["name/140",[127,47.356]],["parent/140",[125,3.733]],["name/141",[62,19.706]],["parent/141",[128,4.867]],["name/142",[129,47.356]],["parent/142",[125,3.733]],["name/143",[62,19.706]],["parent/143",[130,4.867]],["name/144",[32,42.223]],["parent/144",[125,3.733]],["name/145",[62,19.706]],["parent/145",[131,4.867]],["name/146",[132,47.356]],["parent/146",[55,1.901]],["name/147",[116,42.223]],["parent/147",[133,4.867]],["name/148",[62,19.706]],["parent/148",[134,4.867]],["name/149",[135,47.356]],["parent/149",[55,1.901]],["name/150",[76,28.807]],["parent/150",[136,4.34]],["name/151",[93,29.925]],["parent/151",[136,4.34]],["name/152",[137,47.356]],["parent/152",[55,1.901]],["name/153",[62,19.706]],["parent/153",[138,4.867]],["name/154",[72,42.223]],["parent/154",[139,4.34]],["name/155",[140,47.356]],["parent/155",[139,4.34]],["name/156",[141,47.356]],["parent/156",[55,1.901]],["name/157",[142,47.356]],["parent/157",[55,1.901]],["name/158",[62,19.706]],["parent/158",[143,4.867]],["name/159",[144,47.356]],["parent/159",[55,1.901]],["name/160",[145,47.356]],["parent/160",[55,1.901]],["name/161",[62,19.706]],["parent/161",[146,4.867]],["name/162",[147,47.356]],["parent/162",[55,1.901]],["name/163",[148,47.356]],["parent/163",[55,1.901]],["name/164",[149,47.356]],["parent/164",[55,1.901]],["name/165",[150,47.356]],["parent/165",[55,1.901]]],"invertedIndex":[["__type",{"_index":62,"name":{"61":{},"63":{},"65":{},"67":{},"69":{},"71":{},"73":{},"75":{},"77":{},"93":{},"97":{},"109":{},"126":{},"132":{},"134":{},"139":{},"141":{},"143":{},"145":{},"148":{},"153":{},"158":{},"161":{}},"parent":{}}],["_searchall",{"_index":20,"name":{"18":{}},"parent":{}}],["action",{"_index":86,"name":{"83":{}},"parent":{}}],["add",{"_index":68,"name":{"66":{}},"parent":{}}],["adddot",{"_index":40,"name":{"39":{}},"parent":{}}],["addmessage",{"_index":108,"name":{"118":{}},"parent":{}}],["basemessage",{"_index":91,"name":{"88":{}},"parent":{}}],["close",{"_index":127,"name":{"140":{}},"parent":{}}],["commandswithreturnvalue",{"_index":48,"name":{"47":{}},"parent":{}}],["commandtype",{"_index":147,"name":{"162":{}},"parent":{}}],["connect",{"_index":33,"name":{"32":{},"55":{}},"parent":{}}],["connectevents",{"_index":56,"name":{"57":{}},"parent":{}}],["data",{"_index":93,"name":{"92":{},"96":{},"103":{},"108":{},"115":{},"120":{},"125":{},"151":{}},"parent":{}}],["decode",{"_index":12,"name":{"10":{},"28":{},"48":{}},"parent":{}}],["decodeget",{"_index":29,"name":{"27":{}},"parent":{}}],["del",{"_index":70,"name":{"68":{}},"parent":{}}],["deleted",{"_index":113,"name":{"127":{}},"parent":{}}],["deletemessage",{"_index":110,"name":{"123":{}},"parent":{}}],["device",{"_index":59,"name":{"59":{}},"parent":{}}],["deviceerror",{"_index":87,"name":{"84":{}},"parent":{}}],["digitdotre",{"_index":15,"name":{"13":{}},"parent":{}}],["digitre",{"_index":14,"name":{"12":{}},"parent":{}}],["disconnect",{"_index":74,"name":{"72":{}},"parent":{}}],["encode",{"_index":32,"name":{"31":{},"144":{}},"parent":{}}],["encodeadd",{"_index":30,"name":{"29":{}},"parent":{}}],["encodeargs",{"_index":80,"name":{"78":{}},"parent":{}}],["encodedelete",{"_index":31,"name":{"30":{}},"parent":{}}],["encodeget",{"_index":25,"name":{"23":{}},"parent":{}}],["encodeoperate",{"_index":27,"name":{"25":{}},"parent":{}}],["encodeset",{"_index":26,"name":{"24":{}},"parent":{}}],["errormessage",{"_index":95,"name":{"94":{}},"parent":{}}],["extracttype",{"_index":28,"name":{"26":{}},"parent":{}}],["firstisindex",{"_index":17,"name":{"15":{}},"parent":{}}],["get",{"_index":60,"name":{"60":{}},"parent":{}}],["getmessage",{"_index":99,"name":{"101":{}},"parent":{}}],["handlesend",{"_index":49,"name":{"49":{}},"parent":{}}],["header",{"_index":5,"name":{"3":{}},"parent":{}}],["id",{"_index":76,"name":{"74":{},"89":{},"99":{},"104":{},"111":{},"116":{},"121":{},"128":{},"150":{}},"parent":{}}],["index",{"_index":39,"name":{"38":{}},"parent":{"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{}}}],["init",{"_index":6,"name":{"4":{},"138":{}},"parent":{}}],["initresult",{"_index":121,"name":{"135":{}},"parent":{}}],["input",{"_index":85,"name":{"82":{}},"parent":{}}],["isdigit",{"_index":16,"name":{"14":{}},"parent":{}}],["iserror",{"_index":46,"name":{"45":{}},"parent":{}}],["ispromiseresult",{"_index":47,"name":{"46":{}},"parent":{}}],["isreference",{"_index":45,"name":{"44":{}},"parent":{}}],["jsobject",{"_index":145,"name":{"160":{}},"parent":{}}],["jstype",{"_index":149,"name":{"164":{}},"parent":{}}],["lib",{"_index":35,"name":{"34":{}},"parent":{"35":{},"36":{},"37":{}}}],["looptimer",{"_index":37,"name":{"36":{}},"parent":{}}],["makeadd",{"_index":52,"name":{"52":{}},"parent":{}}],["makeaddmessage",{"_index":10,"name":{"8":{}},"parent":{}}],["makedel",{"_index":53,"name":{"53":{}},"parent":{}}],["makedeletemessage",{"_index":8,"name":{"6":{}},"parent":{}}],["makeget",{"_index":50,"name":{"50":{}},"parent":{}}],["makegetmessage",{"_index":7,"name":{"5":{}},"parent":{}}],["makeoperate",{"_index":54,"name":{"54":{}},"parent":{}}],["makeoperatemessage",{"_index":11,"name":{"9":{}},"parent":{}}],["makerouter",{"_index":38,"name":{"37":{}},"parent":{}}],["makeset",{"_index":51,"name":{"51":{}},"parent":{}}],["makesetmessage",{"_index":9,"name":{"7":{}},"parent":{}}],["messagetype",{"_index":148,"name":{"163":{}},"parent":{}}],["mqtt",{"_index":34,"name":{"33":{}},"parent":{}}],["mqttrequest",{"_index":135,"name":{"149":{}},"parent":{}}],["onerror",{"_index":119,"name":{"133":{}},"parent":{}}],["onmessage",{"_index":116,"name":{"131":{},"147":{}},"parent":{}}],["ontimeout",{"_index":57,"name":{"58":{}},"parent":{}}],["operate",{"_index":66,"name":{"64":{}},"parent":{}}],["operatemessage",{"_index":106,"name":{"113":{}},"parent":{}}],["path",{"_index":81,"name":{"79":{},"87":{},"91":{},"100":{},"105":{},"112":{},"117":{},"122":{},"129":{}},"parent":{}}],["paths",{"_index":83,"name":{"80":{}},"parent":{}}],["promiseresult",{"_index":137,"name":{"152":{}},"parent":{}}],["protobuf/protomessage",{"_index":2,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["protocol",{"_index":124,"name":{"137":{}},"parent":{}}],["protocol/index",{"_index":24,"name":{"22":{}},"parent":{"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["protocol/js",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["protocol/lib",{"_index":13,"name":{"11":{}},"parent":{"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{}}}],["protocolargs",{"_index":115,"name":{"130":{}},"parent":{}}],["protocolevents",{"_index":132,"name":{"146":{}},"parent":{}}],["reason",{"_index":90,"name":{"86":{},"98":{}},"parent":{}}],["reject",{"_index":140,"name":{"155":{}},"parent":{}}],["resolve",{"_index":72,"name":{"70":{},"154":{}},"parent":{}}],["resolvereferences",{"_index":42,"name":{"41":{}},"parent":{}}],["role",{"_index":144,"name":{"159":{}},"parent":{}}],["roles",{"_index":78,"name":{"76":{}},"parent":{}}],["rootmsg",{"_index":4,"name":{"2":{}},"parent":{}}],["rootrecord",{"_index":3,"name":{"1":{}},"parent":{}}],["router",{"_index":141,"name":{"156":{}},"parent":{}}],["search",{"_index":19,"name":{"17":{}},"parent":{}}],["searchall",{"_index":21,"name":{"19":{}},"parent":{}}],["send",{"_index":129,"name":{"142":{}},"parent":{}}],["sendfn",{"_index":142,"name":{"157":{}},"parent":{}}],["set",{"_index":64,"name":{"62":{}},"parent":{}}],["setmessage",{"_index":101,"name":{"106":{}},"parent":{}}],["splitreference",{"_index":41,"name":{"40":{}},"parent":{}}],["throwerror",{"_index":44,"name":{"43":{}},"parent":{}}],["throwmsgerror",{"_index":43,"name":{"42":{}},"parent":{}}],["timeout",{"_index":122,"name":{"136":{}},"parent":{}}],["timer",{"_index":36,"name":{"35":{}},"parent":{}}],["type",{"_index":88,"name":{"85":{},"90":{},"95":{},"102":{},"107":{},"114":{},"119":{},"124":{}},"parent":{}}],["types.d",{"_index":55,"name":{"56":{}},"parent":{"57":{},"59":{},"78":{},"84":{},"88":{},"94":{},"101":{},"106":{},"113":{},"118":{},"123":{},"130":{},"135":{},"137":{},"146":{},"149":{},"152":{},"156":{},"157":{},"159":{},"160":{},"162":{},"163":{},"164":{},"165":{}}}],["types.d\".addmessage",{"_index":109,"name":{},"parent":{"119":{},"120":{},"121":{},"122":{}}}],["types.d\".basemessage",{"_index":92,"name":{},"parent":{"89":{},"90":{},"91":{},"92":{}}}],["types.d\".basemessage.data",{"_index":94,"name":{},"parent":{"93":{}}}],["types.d\".connectevents",{"_index":58,"name":{},"parent":{"58":{}}}],["types.d\".deletemessage",{"_index":111,"name":{},"parent":{"124":{},"125":{},"128":{},"129":{}}}],["types.d\".deletemessage.data",{"_index":112,"name":{},"parent":{"126":{}}}],["types.d\".deletemessage.data.__type",{"_index":114,"name":{},"parent":{"127":{}}}],["types.d\".device",{"_index":61,"name":{},"parent":{"60":{},"62":{},"64":{},"66":{},"68":{},"70":{},"72":{},"74":{},"76":{}}}],["types.d\".device.add",{"_index":69,"name":{},"parent":{"67":{}}}],["types.d\".device.del",{"_index":71,"name":{},"parent":{"69":{}}}],["types.d\".device.disconnect",{"_index":75,"name":{},"parent":{"73":{}}}],["types.d\".device.get",{"_index":63,"name":{},"parent":{"61":{}}}],["types.d\".device.id",{"_index":77,"name":{},"parent":{"75":{}}}],["types.d\".device.operate",{"_index":67,"name":{},"parent":{"65":{}}}],["types.d\".device.resolve",{"_index":73,"name":{},"parent":{"71":{}}}],["types.d\".device.roles",{"_index":79,"name":{},"parent":{"77":{}}}],["types.d\".device.set",{"_index":65,"name":{},"parent":{"63":{}}}],["types.d\".deviceerror",{"_index":89,"name":{},"parent":{"85":{},"86":{},"87":{}}}],["types.d\".encodeargs",{"_index":82,"name":{},"parent":{"79":{},"80":{},"81":{},"82":{},"83":{}}}],["types.d\".errormessage",{"_index":96,"name":{},"parent":{"95":{},"96":{},"99":{},"100":{}}}],["types.d\".errormessage.data",{"_index":97,"name":{},"parent":{"97":{}}}],["types.d\".errormessage.data.__type",{"_index":98,"name":{},"parent":{"98":{}}}],["types.d\".getmessage",{"_index":100,"name":{},"parent":{"102":{},"103":{},"104":{},"105":{}}}],["types.d\".initresult",{"_index":123,"name":{},"parent":{"136":{}}}],["types.d\".jsobject",{"_index":146,"name":{},"parent":{"161":{}}}],["types.d\".mqttrequest",{"_index":136,"name":{},"parent":{"150":{},"151":{}}}],["types.d\".operatemessage",{"_index":107,"name":{},"parent":{"114":{},"115":{},"116":{},"117":{}}}],["types.d\".promiseresult",{"_index":138,"name":{},"parent":{"153":{}}}],["types.d\".promiseresult.__type",{"_index":139,"name":{},"parent":{"154":{},"155":{}}}],["types.d\".protocol",{"_index":125,"name":{},"parent":{"138":{},"140":{},"142":{},"144":{}}}],["types.d\".protocol.close",{"_index":128,"name":{},"parent":{"141":{}}}],["types.d\".protocol.encode",{"_index":131,"name":{},"parent":{"145":{}}}],["types.d\".protocol.init",{"_index":126,"name":{},"parent":{"139":{}}}],["types.d\".protocol.send",{"_index":130,"name":{},"parent":{"143":{}}}],["types.d\".protocolargs",{"_index":117,"name":{},"parent":{"131":{},"133":{}}}],["types.d\".protocolargs.onerror",{"_index":120,"name":{},"parent":{"134":{}}}],["types.d\".protocolargs.onmessage",{"_index":118,"name":{},"parent":{"132":{}}}],["types.d\".protocolevents",{"_index":133,"name":{},"parent":{"147":{}}}],["types.d\".protocolevents.onmessage",{"_index":134,"name":{},"parent":{"148":{}}}],["types.d\".sendfn",{"_index":143,"name":{},"parent":{"158":{}}}],["types.d\".setmessage",{"_index":102,"name":{},"parent":{"107":{},"108":{},"111":{},"112":{}}}],["types.d\".setmessage.data",{"_index":103,"name":{},"parent":{"109":{}}}],["types.d\".setmessage.data.__type",{"_index":105,"name":{},"parent":{"110":{}}}],["unflatten",{"_index":18,"name":{"16":{}},"parent":{}}],["unwraparray",{"_index":23,"name":{"21":{}},"parent":{}}],["unwrapobject",{"_index":22,"name":{"20":{}},"parent":{}}],["updated",{"_index":104,"name":{"110":{}},"parent":{}}],["usp",{"_index":1,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["uspmessage",{"_index":150,"name":{"165":{}},"parent":{}}],["value",{"_index":84,"name":{"81":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file +{"kinds":{"1":"Module","32":"Variable","64":"Function","256":"Interface","1024":"Property","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"\"protocol/js-usp-protobuf/protoMessage\"","url":"modules/_protocol_js_usp_protobuf_protomessage_.html","classes":"tsd-kind-module"},{"id":1,"kind":32,"name":"rootRecord","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#rootrecord","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":2,"kind":32,"name":"rootMsg","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#rootmsg","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":3,"kind":32,"name":"Header","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#header","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":4,"kind":64,"name":"init","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#init","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":5,"kind":64,"name":"makeGetMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makegetmessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":6,"kind":64,"name":"makeDeleteMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makedeletemessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":7,"kind":64,"name":"makeSetMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makesetmessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":8,"kind":64,"name":"makeAddMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makeaddmessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":9,"kind":64,"name":"makeOperateMessage","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#makeoperatemessage","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":10,"kind":64,"name":"decode","url":"modules/_protocol_js_usp_protobuf_protomessage_.html#decode","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/js-usp-protobuf/protoMessage\""},{"id":11,"kind":1,"name":"\"protocol/lib\"","url":"modules/_protocol_lib_.html","classes":"tsd-kind-module"},{"id":12,"kind":32,"name":"digitRe","url":"modules/_protocol_lib_.html#digitre","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":13,"kind":32,"name":"digitDotRe","url":"modules/_protocol_lib_.html#digitdotre","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":14,"kind":64,"name":"isDigit","url":"modules/_protocol_lib_.html#isdigit","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":15,"kind":64,"name":"firstIsIndex","url":"modules/_protocol_lib_.html#firstisindex","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":16,"kind":64,"name":"unflatten","url":"modules/_protocol_lib_.html#unflatten","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":17,"kind":64,"name":"search","url":"modules/_protocol_lib_.html#search","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":18,"kind":64,"name":"_searchAll","url":"modules/_protocol_lib_.html#_searchall","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/lib\""},{"id":19,"kind":64,"name":"searchAll","url":"modules/_protocol_lib_.html#searchall","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":20,"kind":64,"name":"unwrapObject","url":"modules/_protocol_lib_.html#unwrapobject","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":21,"kind":64,"name":"unwrapArray","url":"modules/_protocol_lib_.html#unwraparray","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/lib\""},{"id":22,"kind":1,"name":"\"protocol/index\"","url":"modules/_protocol_index_.html","classes":"tsd-kind-module"},{"id":23,"kind":64,"name":"encodeGet","url":"modules/_protocol_index_.html#encodeget","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":24,"kind":64,"name":"encodeSet","url":"modules/_protocol_index_.html#encodeset","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":25,"kind":64,"name":"encodeOperate","url":"modules/_protocol_index_.html#encodeoperate","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":26,"kind":64,"name":"extractType","url":"modules/_protocol_index_.html#extracttype","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":27,"kind":64,"name":"decodeGet","url":"modules/_protocol_index_.html#decodeget","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":28,"kind":32,"name":"ignorableTypes","url":"modules/_protocol_index_.html#ignorabletypes","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":29,"kind":64,"name":"decode","url":"modules/_protocol_index_.html#decode","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":30,"kind":64,"name":"encodeAdd","url":"modules/_protocol_index_.html#encodeadd","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":31,"kind":64,"name":"encodeDelete","url":"modules/_protocol_index_.html#encodedelete","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":32,"kind":64,"name":"encode","url":"modules/_protocol_index_.html#encode","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"protocol/index\""},{"id":33,"kind":64,"name":"connect","url":"modules/_protocol_index_.html#connect","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/index\""},{"id":34,"kind":64,"name":"mqtt","url":"modules/_protocol_index_.html#mqtt","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"protocol/index\""},{"id":35,"kind":1,"name":"\"lib\"","url":"modules/_lib_.html","classes":"tsd-kind-module"},{"id":36,"kind":64,"name":"timer","url":"modules/_lib_.html#timer","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"lib\""},{"id":37,"kind":64,"name":"loopTimer","url":"modules/_lib_.html#looptimer","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"lib\""},{"id":38,"kind":64,"name":"makeRouter","url":"modules/_lib_.html#makerouter","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"lib\""},{"id":39,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-module"},{"id":40,"kind":64,"name":"addDot","url":"modules/_index_.html#adddot","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":41,"kind":64,"name":"splitReference","url":"modules/_index_.html#splitreference","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":42,"kind":64,"name":"resolveReferences","url":"modules/_index_.html#resolvereferences","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":43,"kind":64,"name":"throwMsgError","url":"modules/_index_.html#throwmsgerror","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":44,"kind":64,"name":"throwError","url":"modules/_index_.html#throwerror","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":45,"kind":64,"name":"isReference","url":"modules/_index_.html#isreference","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":46,"kind":64,"name":"isError","url":"modules/_index_.html#iserror","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":47,"kind":64,"name":"isPromiseResult","url":"modules/_index_.html#ispromiseresult","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":48,"kind":32,"name":"commandsWithReturnValue","url":"modules/_index_.html#commandswithreturnvalue","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":49,"kind":64,"name":"decode","url":"modules/_index_.html#decode","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":50,"kind":64,"name":"handleSend","url":"modules/_index_.html#handlesend","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":51,"kind":64,"name":"makeGet","url":"modules/_index_.html#makeget","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":52,"kind":64,"name":"makeSet","url":"modules/_index_.html#makeset","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":53,"kind":64,"name":"makeAdd","url":"modules/_index_.html#makeadd","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":54,"kind":64,"name":"makeDel","url":"modules/_index_.html#makedel","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":55,"kind":32,"name":"operateSubscriptionPath","url":"modules/_index_.html#operatesubscriptionpath","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":56,"kind":4194304,"name":"AddFn","url":"modules/_index_.html#addfn","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":57,"kind":65536,"name":"__type","url":"modules/_index_.html#addfn.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"index\".AddFn"},{"id":58,"kind":4194304,"name":"DelFn","url":"modules/_index_.html#delfn","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":59,"kind":65536,"name":"__type","url":"modules/_index_.html#delfn.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"index\".DelFn"},{"id":60,"kind":64,"name":"makeOperate","url":"modules/_index_.html#makeoperate","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":61,"kind":64,"name":"connect","url":"modules/_index_.html#connect","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"\"index\""},{"id":62,"kind":1,"name":"\"types.d\"","url":"modules/_types_d_.html","classes":"tsd-kind-module"},{"id":63,"kind":256,"name":"ConnectEvents","url":"interfaces/_types_d_.connectevents.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":64,"kind":1024,"name":"onTimeout","url":"interfaces/_types_d_.connectevents.html#ontimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ConnectEvents"},{"id":65,"kind":256,"name":"Device","url":"interfaces/_types_d_.device.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":66,"kind":1024,"name":"get","url":"interfaces/_types_d_.device.html#get","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":67,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#get.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.get"},{"id":68,"kind":1024,"name":"set","url":"interfaces/_types_d_.device.html#set","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":69,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#set.__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.set"},{"id":70,"kind":1024,"name":"operate","url":"interfaces/_types_d_.device.html#operate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":71,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#operate.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.operate"},{"id":72,"kind":1024,"name":"add","url":"interfaces/_types_d_.device.html#add","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":73,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#add.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.add"},{"id":74,"kind":1024,"name":"del","url":"interfaces/_types_d_.device.html#del","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":75,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#del.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.del"},{"id":76,"kind":1024,"name":"resolve","url":"interfaces/_types_d_.device.html#resolve","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":77,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#resolve.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.resolve"},{"id":78,"kind":1024,"name":"disconnect","url":"interfaces/_types_d_.device.html#disconnect","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":79,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#disconnect.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.disconnect"},{"id":80,"kind":1024,"name":"id","url":"interfaces/_types_d_.device.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":81,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#id.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.id"},{"id":82,"kind":1024,"name":"roles","url":"interfaces/_types_d_.device.html#roles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Device"},{"id":83,"kind":65536,"name":"__type","url":"interfaces/_types_d_.device.html#roles.__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Device.roles"},{"id":84,"kind":256,"name":"OperateOptions","url":"interfaces/_types_d_.operateoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":85,"kind":1024,"name":"ID","url":"interfaces/_types_d_.operateoptions.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".OperateOptions"},{"id":86,"kind":1024,"name":"Persistent","url":"interfaces/_types_d_.operateoptions.html#persistent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".OperateOptions"},{"id":87,"kind":256,"name":"EncodeArgs","url":"interfaces/_types_d_.encodeargs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":88,"kind":1024,"name":"path","url":"interfaces/_types_d_.encodeargs.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":89,"kind":1024,"name":"paths","url":"interfaces/_types_d_.encodeargs.html#paths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":90,"kind":1024,"name":"value","url":"interfaces/_types_d_.encodeargs.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":91,"kind":1024,"name":"input","url":"interfaces/_types_d_.encodeargs.html#input","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":92,"kind":1024,"name":"action","url":"interfaces/_types_d_.encodeargs.html#action","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":93,"kind":1024,"name":"operateID","url":"interfaces/_types_d_.encodeargs.html#operateid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".EncodeArgs"},{"id":94,"kind":256,"name":"DeviceError","url":"interfaces/_types_d_.deviceerror.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":95,"kind":1024,"name":"type","url":"interfaces/_types_d_.deviceerror.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".DeviceError"},{"id":96,"kind":1024,"name":"reason","url":"interfaces/_types_d_.deviceerror.html#reason","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".DeviceError"},{"id":97,"kind":1024,"name":"path","url":"interfaces/_types_d_.deviceerror.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".DeviceError"},{"id":98,"kind":256,"name":"BaseMessage","url":"interfaces/_types_d_.basemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":99,"kind":1024,"name":"id","url":"interfaces/_types_d_.basemessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":100,"kind":1024,"name":"type","url":"interfaces/_types_d_.basemessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":101,"kind":1024,"name":"path","url":"interfaces/_types_d_.basemessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":102,"kind":1024,"name":"data","url":"interfaces/_types_d_.basemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".BaseMessage"},{"id":103,"kind":65536,"name":"__type","url":"interfaces/_types_d_.basemessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".BaseMessage.data"},{"id":104,"kind":256,"name":"ErrorMessage","url":"interfaces/_types_d_.errormessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":105,"kind":1024,"name":"type","url":"interfaces/_types_d_.errormessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".ErrorMessage"},{"id":106,"kind":1024,"name":"data","url":"interfaces/_types_d_.errormessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".ErrorMessage"},{"id":107,"kind":65536,"name":"__type","url":"interfaces/_types_d_.errormessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ErrorMessage.data"},{"id":108,"kind":32,"name":"reason","url":"interfaces/_types_d_.errormessage.html#data.__type.reason","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".ErrorMessage.data.__type"},{"id":109,"kind":1024,"name":"id","url":"interfaces/_types_d_.errormessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".ErrorMessage"},{"id":110,"kind":1024,"name":"path","url":"interfaces/_types_d_.errormessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".ErrorMessage"},{"id":111,"kind":256,"name":"GetMessage","url":"interfaces/_types_d_.getmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":112,"kind":1024,"name":"type","url":"interfaces/_types_d_.getmessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".GetMessage"},{"id":113,"kind":1024,"name":"data","url":"interfaces/_types_d_.getmessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".GetMessage"},{"id":114,"kind":1024,"name":"id","url":"interfaces/_types_d_.getmessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".GetMessage"},{"id":115,"kind":1024,"name":"path","url":"interfaces/_types_d_.getmessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".GetMessage"},{"id":116,"kind":256,"name":"SetMessage","url":"interfaces/_types_d_.setmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":117,"kind":1024,"name":"type","url":"interfaces/_types_d_.setmessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".SetMessage"},{"id":118,"kind":1024,"name":"data","url":"interfaces/_types_d_.setmessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".SetMessage"},{"id":119,"kind":65536,"name":"__type","url":"interfaces/_types_d_.setmessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".SetMessage.data"},{"id":120,"kind":32,"name":"updated","url":"interfaces/_types_d_.setmessage.html#data.__type.updated","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".SetMessage.data.__type"},{"id":121,"kind":1024,"name":"id","url":"interfaces/_types_d_.setmessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".SetMessage"},{"id":122,"kind":1024,"name":"path","url":"interfaces/_types_d_.setmessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".SetMessage"},{"id":123,"kind":256,"name":"OperateMessage","url":"interfaces/_types_d_.operatemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":124,"kind":1024,"name":"type","url":"interfaces/_types_d_.operatemessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".OperateMessage"},{"id":125,"kind":1024,"name":"data","url":"interfaces/_types_d_.operatemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".OperateMessage"},{"id":126,"kind":1024,"name":"id","url":"interfaces/_types_d_.operatemessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".OperateMessage"},{"id":127,"kind":1024,"name":"path","url":"interfaces/_types_d_.operatemessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".OperateMessage"},{"id":128,"kind":256,"name":"NotifyMessage","url":"interfaces/_types_d_.notifymessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":129,"kind":1024,"name":"type","url":"interfaces/_types_d_.notifymessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".NotifyMessage"},{"id":130,"kind":1024,"name":"data","url":"interfaces/_types_d_.notifymessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".NotifyMessage"},{"id":131,"kind":1024,"name":"id","url":"interfaces/_types_d_.notifymessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".NotifyMessage"},{"id":132,"kind":1024,"name":"path","url":"interfaces/_types_d_.notifymessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".NotifyMessage"},{"id":133,"kind":256,"name":"AddMessage","url":"interfaces/_types_d_.addmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":134,"kind":1024,"name":"type","url":"interfaces/_types_d_.addmessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".AddMessage"},{"id":135,"kind":1024,"name":"data","url":"interfaces/_types_d_.addmessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".AddMessage"},{"id":136,"kind":1024,"name":"id","url":"interfaces/_types_d_.addmessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".AddMessage"},{"id":137,"kind":1024,"name":"path","url":"interfaces/_types_d_.addmessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".AddMessage"},{"id":138,"kind":256,"name":"DeleteMessage","url":"interfaces/_types_d_.deletemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":139,"kind":1024,"name":"type","url":"interfaces/_types_d_.deletemessage.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".DeleteMessage"},{"id":140,"kind":1024,"name":"data","url":"interfaces/_types_d_.deletemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types.d\".DeleteMessage"},{"id":141,"kind":65536,"name":"__type","url":"interfaces/_types_d_.deletemessage.html#data.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".DeleteMessage.data"},{"id":142,"kind":32,"name":"deleted","url":"interfaces/_types_d_.deletemessage.html#data.__type.deleted","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".DeleteMessage.data.__type"},{"id":143,"kind":1024,"name":"id","url":"interfaces/_types_d_.deletemessage.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".DeleteMessage"},{"id":144,"kind":1024,"name":"path","url":"interfaces/_types_d_.deletemessage.html#path","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types.d\".DeleteMessage"},{"id":145,"kind":256,"name":"ProtocolArgs","url":"interfaces/_types_d_.protocolargs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":146,"kind":1024,"name":"onMessage","url":"interfaces/_types_d_.protocolargs.html#onmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ProtocolArgs"},{"id":147,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocolargs.html#onmessage.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ProtocolArgs.onMessage"},{"id":148,"kind":1024,"name":"onError","url":"interfaces/_types_d_.protocolargs.html#onerror","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ProtocolArgs"},{"id":149,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocolargs.html#onerror.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ProtocolArgs.onError"},{"id":150,"kind":256,"name":"InitResult","url":"interfaces/_types_d_.initresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":151,"kind":1024,"name":"timeout","url":"interfaces/_types_d_.initresult.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".InitResult"},{"id":152,"kind":256,"name":"Protocol","url":"interfaces/_types_d_.protocol.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":153,"kind":1024,"name":"init","url":"interfaces/_types_d_.protocol.html#init","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":154,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#init.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.init"},{"id":155,"kind":1024,"name":"close","url":"interfaces/_types_d_.protocol.html#close","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":156,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#close.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.close"},{"id":157,"kind":1024,"name":"send","url":"interfaces/_types_d_.protocol.html#send","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":158,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#send.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.send"},{"id":159,"kind":1024,"name":"encode","url":"interfaces/_types_d_.protocol.html#encode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".Protocol"},{"id":160,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocol.html#encode.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".Protocol.encode"},{"id":161,"kind":256,"name":"ProtocolEvents","url":"interfaces/_types_d_.protocolevents.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":162,"kind":1024,"name":"onMessage","url":"interfaces/_types_d_.protocolevents.html#onmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".ProtocolEvents"},{"id":163,"kind":65536,"name":"__type","url":"interfaces/_types_d_.protocolevents.html#onmessage.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"types.d\".ProtocolEvents.onMessage"},{"id":164,"kind":256,"name":"MQTTRequest","url":"interfaces/_types_d_.mqttrequest.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"\"types.d\""},{"id":165,"kind":1024,"name":"id","url":"interfaces/_types_d_.mqttrequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".MQTTRequest"},{"id":166,"kind":1024,"name":"data","url":"interfaces/_types_d_.mqttrequest.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types.d\".MQTTRequest"},{"id":167,"kind":4194304,"name":"PromiseResult","url":"modules/_types_d_.html#promiseresult","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":168,"kind":65536,"name":"__type","url":"modules/_types_d_.html#promiseresult.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".PromiseResult"},{"id":169,"kind":32,"name":"resolve","url":"modules/_types_d_.html#promiseresult.__type-3.resolve","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".PromiseResult.__type"},{"id":170,"kind":32,"name":"reject","url":"modules/_types_d_.html#promiseresult.__type-3.reject","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"\"types.d\".PromiseResult.__type"},{"id":171,"kind":4194304,"name":"Router","url":"modules/_types_d_.html#router","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":172,"kind":4194304,"name":"SendFn","url":"modules/_types_d_.html#sendfn","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":173,"kind":65536,"name":"__type","url":"modules/_types_d_.html#sendfn.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".SendFn"},{"id":174,"kind":4194304,"name":"OperateFunction","url":"modules/_types_d_.html#operatefunction","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":175,"kind":65536,"name":"__type","url":"modules/_types_d_.html#operatefunction.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".OperateFunction"},{"id":176,"kind":4194304,"name":"OperateCleanupFunction","url":"modules/_types_d_.html#operatecleanupfunction","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":177,"kind":65536,"name":"__type","url":"modules/_types_d_.html#operatecleanupfunction.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".OperateCleanupFunction"},{"id":178,"kind":4194304,"name":"Role","url":"modules/_types_d_.html#role","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":179,"kind":4194304,"name":"JSObject","url":"modules/_types_d_.html#jsobject","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":180,"kind":65536,"name":"__type","url":"modules/_types_d_.html#jsobject.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"types.d\".JSObject"},{"id":181,"kind":4194304,"name":"CommandType","url":"modules/_types_d_.html#commandtype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":182,"kind":4194304,"name":"MessageType","url":"modules/_types_d_.html#messagetype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":183,"kind":4194304,"name":"JSType","url":"modules/_types_d_.html#jstype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""},{"id":184,"kind":4194304,"name":"USPMessage","url":"modules/_types_d_.html#uspmessage","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"\"types.d\""}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,15.42,1,15.42,2,15.42]],["parent/0",[]],["name/1",[3,48.415]],["parent/1",[0,1.607,1,1.607,2,1.607]],["name/2",[4,48.415]],["parent/2",[0,1.607,1,1.607,2,1.607]],["name/3",[5,48.415]],["parent/3",[0,1.607,1,1.607,2,1.607]],["name/4",[6,43.284]],["parent/4",[0,1.607,1,1.607,2,1.607]],["name/5",[7,48.415]],["parent/5",[0,1.607,1,1.607,2,1.607]],["name/6",[8,48.415]],["parent/6",[0,1.607,1,1.607,2,1.607]],["name/7",[9,48.415]],["parent/7",[0,1.607,1,1.607,2,1.607]],["name/8",[10,48.415]],["parent/8",[0,1.607,1,1.607,2,1.607]],["name/9",[11,48.415]],["parent/9",[0,1.607,1,1.607,2,1.607]],["name/10",[12,39.904]],["parent/10",[0,1.607,1,1.607,2,1.607]],["name/11",[13,27.956]],["parent/11",[]],["name/12",[14,48.415]],["parent/12",[13,2.866]],["name/13",[15,48.415]],["parent/13",[13,2.866]],["name/14",[16,48.415]],["parent/14",[13,2.866]],["name/15",[17,48.415]],["parent/15",[13,2.866]],["name/16",[18,48.415]],["parent/16",[13,2.866]],["name/17",[19,48.415]],["parent/17",[13,2.866]],["name/18",[20,48.415]],["parent/18",[13,2.866]],["name/19",[21,48.415]],["parent/19",[13,2.866]],["name/20",[22,48.415]],["parent/20",[13,2.866]],["name/21",[23,48.415]],["parent/21",[13,2.866]],["name/22",[24,26.346]],["parent/22",[]],["name/23",[25,48.415]],["parent/23",[24,2.701]],["name/24",[26,48.415]],["parent/24",[24,2.701]],["name/25",[27,48.415]],["parent/25",[24,2.701]],["name/26",[28,48.415]],["parent/26",[24,2.701]],["name/27",[29,48.415]],["parent/27",[24,2.701]],["name/28",[30,48.415]],["parent/28",[24,2.701]],["name/29",[12,39.904]],["parent/29",[24,2.701]],["name/30",[31,48.415]],["parent/30",[24,2.701]],["name/31",[32,48.415]],["parent/31",[24,2.701]],["name/32",[33,43.284]],["parent/32",[24,2.701]],["name/33",[34,43.284]],["parent/33",[24,2.701]],["name/34",[35,48.415]],["parent/34",[24,2.701]],["name/35",[36,37.38]],["parent/35",[]],["name/36",[37,48.415]],["parent/36",[36,3.832]],["name/37",[38,48.415]],["parent/37",[36,3.832]],["name/38",[39,48.415]],["parent/38",[36,3.832]],["name/39",[40,21.672]],["parent/39",[]],["name/40",[41,48.415]],["parent/40",[40,2.222]],["name/41",[42,48.415]],["parent/41",[40,2.222]],["name/42",[43,48.415]],["parent/42",[40,2.222]],["name/43",[44,48.415]],["parent/43",[40,2.222]],["name/44",[45,48.415]],["parent/44",[40,2.222]],["name/45",[46,48.415]],["parent/45",[40,2.222]],["name/46",[47,48.415]],["parent/46",[40,2.222]],["name/47",[48,48.415]],["parent/47",[40,2.222]],["name/48",[49,48.415]],["parent/48",[40,2.222]],["name/49",[12,39.904]],["parent/49",[40,2.222]],["name/50",[50,48.415]],["parent/50",[40,2.222]],["name/51",[51,48.415]],["parent/51",[40,2.222]],["name/52",[52,48.415]],["parent/52",[40,2.222]],["name/53",[53,48.415]],["parent/53",[40,2.222]],["name/54",[54,48.415]],["parent/54",[40,2.222]],["name/55",[55,48.415]],["parent/55",[40,2.222]],["name/56",[56,48.415]],["parent/56",[40,2.222]],["name/57",[57,19.2]],["parent/57",[58,4.963]],["name/58",[59,48.415]],["parent/58",[40,2.222]],["name/59",[57,19.2]],["parent/59",[60,4.963]],["name/60",[61,48.415]],["parent/60",[40,2.222]],["name/61",[34,43.284]],["parent/61",[40,2.222]],["name/62",[62,18.16]],["parent/62",[]],["name/63",[63,48.415]],["parent/63",[62,1.862]],["name/64",[64,48.415]],["parent/64",[65,4.963]],["name/65",[66,48.415]],["parent/65",[62,1.862]],["name/66",[67,48.415]],["parent/66",[68,3.063]],["name/67",[57,19.2]],["parent/67",[69,4.963]],["name/68",[70,48.415]],["parent/68",[68,3.063]],["name/69",[57,19.2]],["parent/69",[71,4.963]],["name/70",[72,48.415]],["parent/70",[68,3.063]],["name/71",[57,19.2]],["parent/71",[73,4.963]],["name/72",[74,48.415]],["parent/72",[68,3.063]],["name/73",[57,19.2]],["parent/73",[75,4.963]],["name/74",[76,48.415]],["parent/74",[68,3.063]],["name/75",[57,19.2]],["parent/75",[77,4.963]],["name/76",[78,43.284]],["parent/76",[68,3.063]],["name/77",[57,19.2]],["parent/77",[79,4.963]],["name/78",[80,48.415]],["parent/78",[68,3.063]],["name/79",[57,19.2]],["parent/79",[81,4.963]],["name/80",[82,27.956]],["parent/80",[68,3.063]],["name/81",[57,19.2]],["parent/81",[83,4.963]],["name/82",[84,48.415]],["parent/82",[68,3.063]],["name/83",[57,19.2]],["parent/83",[85,4.963]],["name/84",[86,48.415]],["parent/84",[62,1.862]],["name/85",[82,27.956]],["parent/85",[87,4.437]],["name/86",[88,48.415]],["parent/86",[87,4.437]],["name/87",[89,48.415]],["parent/87",[62,1.862]],["name/88",[90,28.87]],["parent/88",[91,3.453]],["name/89",[92,48.415]],["parent/89",[91,3.453]],["name/90",[93,48.415]],["parent/90",[91,3.453]],["name/91",[94,48.415]],["parent/91",[91,3.453]],["name/92",[95,48.415]],["parent/92",[91,3.453]],["name/93",[96,48.415]],["parent/93",[91,3.453]],["name/94",[97,48.415]],["parent/94",[62,1.862]],["name/95",[98,29.875]],["parent/95",[99,4.091]],["name/96",[100,43.284]],["parent/96",[99,4.091]],["name/97",[90,28.87]],["parent/97",[99,4.091]],["name/98",[101,48.415]],["parent/98",[62,1.862]],["name/99",[82,27.956]],["parent/99",[102,3.832]],["name/100",[98,29.875]],["parent/100",[102,3.832]],["name/101",[90,28.87]],["parent/101",[102,3.832]],["name/102",[103,29.875]],["parent/102",[102,3.832]],["name/103",[57,19.2]],["parent/103",[104,4.963]],["name/104",[105,48.415]],["parent/104",[62,1.862]],["name/105",[98,29.875]],["parent/105",[106,3.832]],["name/106",[103,29.875]],["parent/106",[106,3.832]],["name/107",[57,19.2]],["parent/107",[107,4.963]],["name/108",[100,43.284]],["parent/108",[108,4.963]],["name/109",[82,27.956]],["parent/109",[106,3.832]],["name/110",[90,28.87]],["parent/110",[106,3.832]],["name/111",[109,48.415]],["parent/111",[62,1.862]],["name/112",[98,29.875]],["parent/112",[110,3.832]],["name/113",[103,29.875]],["parent/113",[110,3.832]],["name/114",[82,27.956]],["parent/114",[110,3.832]],["name/115",[90,28.87]],["parent/115",[110,3.832]],["name/116",[111,48.415]],["parent/116",[62,1.862]],["name/117",[98,29.875]],["parent/117",[112,3.832]],["name/118",[103,29.875]],["parent/118",[112,3.832]],["name/119",[57,19.2]],["parent/119",[113,4.963]],["name/120",[114,48.415]],["parent/120",[115,4.963]],["name/121",[82,27.956]],["parent/121",[112,3.832]],["name/122",[90,28.87]],["parent/122",[112,3.832]],["name/123",[116,48.415]],["parent/123",[62,1.862]],["name/124",[98,29.875]],["parent/124",[117,3.832]],["name/125",[103,29.875]],["parent/125",[117,3.832]],["name/126",[82,27.956]],["parent/126",[117,3.832]],["name/127",[90,28.87]],["parent/127",[117,3.832]],["name/128",[118,48.415]],["parent/128",[62,1.862]],["name/129",[98,29.875]],["parent/129",[119,3.832]],["name/130",[103,29.875]],["parent/130",[119,3.832]],["name/131",[82,27.956]],["parent/131",[119,3.832]],["name/132",[90,28.87]],["parent/132",[119,3.832]],["name/133",[120,48.415]],["parent/133",[62,1.862]],["name/134",[98,29.875]],["parent/134",[121,3.832]],["name/135",[103,29.875]],["parent/135",[121,3.832]],["name/136",[82,27.956]],["parent/136",[121,3.832]],["name/137",[90,28.87]],["parent/137",[121,3.832]],["name/138",[122,48.415]],["parent/138",[62,1.862]],["name/139",[98,29.875]],["parent/139",[123,3.832]],["name/140",[103,29.875]],["parent/140",[123,3.832]],["name/141",[57,19.2]],["parent/141",[124,4.963]],["name/142",[125,48.415]],["parent/142",[126,4.963]],["name/143",[82,27.956]],["parent/143",[123,3.832]],["name/144",[90,28.87]],["parent/144",[123,3.832]],["name/145",[127,48.415]],["parent/145",[62,1.862]],["name/146",[128,43.284]],["parent/146",[129,4.437]],["name/147",[57,19.2]],["parent/147",[130,4.963]],["name/148",[131,48.415]],["parent/148",[129,4.437]],["name/149",[57,19.2]],["parent/149",[132,4.963]],["name/150",[133,48.415]],["parent/150",[62,1.862]],["name/151",[134,48.415]],["parent/151",[135,4.963]],["name/152",[136,48.415]],["parent/152",[62,1.862]],["name/153",[6,43.284]],["parent/153",[137,3.832]],["name/154",[57,19.2]],["parent/154",[138,4.963]],["name/155",[139,48.415]],["parent/155",[137,3.832]],["name/156",[57,19.2]],["parent/156",[140,4.963]],["name/157",[141,48.415]],["parent/157",[137,3.832]],["name/158",[57,19.2]],["parent/158",[142,4.963]],["name/159",[33,43.284]],["parent/159",[137,3.832]],["name/160",[57,19.2]],["parent/160",[143,4.963]],["name/161",[144,48.415]],["parent/161",[62,1.862]],["name/162",[128,43.284]],["parent/162",[145,4.963]],["name/163",[57,19.2]],["parent/163",[146,4.963]],["name/164",[147,48.415]],["parent/164",[62,1.862]],["name/165",[82,27.956]],["parent/165",[148,4.437]],["name/166",[103,29.875]],["parent/166",[148,4.437]],["name/167",[149,48.415]],["parent/167",[62,1.862]],["name/168",[57,19.2]],["parent/168",[150,4.963]],["name/169",[78,43.284]],["parent/169",[151,4.437]],["name/170",[152,48.415]],["parent/170",[151,4.437]],["name/171",[153,48.415]],["parent/171",[62,1.862]],["name/172",[154,48.415]],["parent/172",[62,1.862]],["name/173",[57,19.2]],["parent/173",[155,4.963]],["name/174",[156,48.415]],["parent/174",[62,1.862]],["name/175",[57,19.2]],["parent/175",[157,4.963]],["name/176",[158,48.415]],["parent/176",[62,1.862]],["name/177",[57,19.2]],["parent/177",[159,4.963]],["name/178",[160,48.415]],["parent/178",[62,1.862]],["name/179",[161,48.415]],["parent/179",[62,1.862]],["name/180",[57,19.2]],["parent/180",[162,4.963]],["name/181",[163,48.415]],["parent/181",[62,1.862]],["name/182",[164,48.415]],["parent/182",[62,1.862]],["name/183",[165,48.415]],["parent/183",[62,1.862]],["name/184",[166,48.415]],["parent/184",[62,1.862]]],"invertedIndex":[["__type",{"_index":57,"name":{"57":{},"59":{},"67":{},"69":{},"71":{},"73":{},"75":{},"77":{},"79":{},"81":{},"83":{},"103":{},"107":{},"119":{},"141":{},"147":{},"149":{},"154":{},"156":{},"158":{},"160":{},"163":{},"168":{},"173":{},"175":{},"177":{},"180":{}},"parent":{}}],["_searchall",{"_index":20,"name":{"18":{}},"parent":{}}],["action",{"_index":95,"name":{"92":{}},"parent":{}}],["add",{"_index":74,"name":{"72":{}},"parent":{}}],["adddot",{"_index":41,"name":{"40":{}},"parent":{}}],["addfn",{"_index":56,"name":{"56":{}},"parent":{}}],["addmessage",{"_index":120,"name":{"133":{}},"parent":{}}],["basemessage",{"_index":101,"name":{"98":{}},"parent":{}}],["close",{"_index":139,"name":{"155":{}},"parent":{}}],["commandswithreturnvalue",{"_index":49,"name":{"48":{}},"parent":{}}],["commandtype",{"_index":163,"name":{"181":{}},"parent":{}}],["connect",{"_index":34,"name":{"33":{},"61":{}},"parent":{}}],["connectevents",{"_index":63,"name":{"63":{}},"parent":{}}],["data",{"_index":103,"name":{"102":{},"106":{},"113":{},"118":{},"125":{},"130":{},"135":{},"140":{},"166":{}},"parent":{}}],["decode",{"_index":12,"name":{"10":{},"29":{},"49":{}},"parent":{}}],["decodeget",{"_index":29,"name":{"27":{}},"parent":{}}],["del",{"_index":76,"name":{"74":{}},"parent":{}}],["deleted",{"_index":125,"name":{"142":{}},"parent":{}}],["deletemessage",{"_index":122,"name":{"138":{}},"parent":{}}],["delfn",{"_index":59,"name":{"58":{}},"parent":{}}],["device",{"_index":66,"name":{"65":{}},"parent":{}}],["deviceerror",{"_index":97,"name":{"94":{}},"parent":{}}],["digitdotre",{"_index":15,"name":{"13":{}},"parent":{}}],["digitre",{"_index":14,"name":{"12":{}},"parent":{}}],["disconnect",{"_index":80,"name":{"78":{}},"parent":{}}],["encode",{"_index":33,"name":{"32":{},"159":{}},"parent":{}}],["encodeadd",{"_index":31,"name":{"30":{}},"parent":{}}],["encodeargs",{"_index":89,"name":{"87":{}},"parent":{}}],["encodedelete",{"_index":32,"name":{"31":{}},"parent":{}}],["encodeget",{"_index":25,"name":{"23":{}},"parent":{}}],["encodeoperate",{"_index":27,"name":{"25":{}},"parent":{}}],["encodeset",{"_index":26,"name":{"24":{}},"parent":{}}],["errormessage",{"_index":105,"name":{"104":{}},"parent":{}}],["extracttype",{"_index":28,"name":{"26":{}},"parent":{}}],["firstisindex",{"_index":17,"name":{"15":{}},"parent":{}}],["get",{"_index":67,"name":{"66":{}},"parent":{}}],["getmessage",{"_index":109,"name":{"111":{}},"parent":{}}],["handlesend",{"_index":50,"name":{"50":{}},"parent":{}}],["header",{"_index":5,"name":{"3":{}},"parent":{}}],["id",{"_index":82,"name":{"80":{},"85":{},"99":{},"109":{},"114":{},"121":{},"126":{},"131":{},"136":{},"143":{},"165":{}},"parent":{}}],["ignorabletypes",{"_index":30,"name":{"28":{}},"parent":{}}],["index",{"_index":40,"name":{"39":{}},"parent":{"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"58":{},"60":{},"61":{}}}],["index\".addfn",{"_index":58,"name":{},"parent":{"57":{}}}],["index\".delfn",{"_index":60,"name":{},"parent":{"59":{}}}],["init",{"_index":6,"name":{"4":{},"153":{}},"parent":{}}],["initresult",{"_index":133,"name":{"150":{}},"parent":{}}],["input",{"_index":94,"name":{"91":{}},"parent":{}}],["isdigit",{"_index":16,"name":{"14":{}},"parent":{}}],["iserror",{"_index":47,"name":{"46":{}},"parent":{}}],["ispromiseresult",{"_index":48,"name":{"47":{}},"parent":{}}],["isreference",{"_index":46,"name":{"45":{}},"parent":{}}],["jsobject",{"_index":161,"name":{"179":{}},"parent":{}}],["jstype",{"_index":165,"name":{"183":{}},"parent":{}}],["lib",{"_index":36,"name":{"35":{}},"parent":{"36":{},"37":{},"38":{}}}],["looptimer",{"_index":38,"name":{"37":{}},"parent":{}}],["makeadd",{"_index":53,"name":{"53":{}},"parent":{}}],["makeaddmessage",{"_index":10,"name":{"8":{}},"parent":{}}],["makedel",{"_index":54,"name":{"54":{}},"parent":{}}],["makedeletemessage",{"_index":8,"name":{"6":{}},"parent":{}}],["makeget",{"_index":51,"name":{"51":{}},"parent":{}}],["makegetmessage",{"_index":7,"name":{"5":{}},"parent":{}}],["makeoperate",{"_index":61,"name":{"60":{}},"parent":{}}],["makeoperatemessage",{"_index":11,"name":{"9":{}},"parent":{}}],["makerouter",{"_index":39,"name":{"38":{}},"parent":{}}],["makeset",{"_index":52,"name":{"52":{}},"parent":{}}],["makesetmessage",{"_index":9,"name":{"7":{}},"parent":{}}],["messagetype",{"_index":164,"name":{"182":{}},"parent":{}}],["mqtt",{"_index":35,"name":{"34":{}},"parent":{}}],["mqttrequest",{"_index":147,"name":{"164":{}},"parent":{}}],["notifymessage",{"_index":118,"name":{"128":{}},"parent":{}}],["onerror",{"_index":131,"name":{"148":{}},"parent":{}}],["onmessage",{"_index":128,"name":{"146":{},"162":{}},"parent":{}}],["ontimeout",{"_index":64,"name":{"64":{}},"parent":{}}],["operate",{"_index":72,"name":{"70":{}},"parent":{}}],["operatecleanupfunction",{"_index":158,"name":{"176":{}},"parent":{}}],["operatefunction",{"_index":156,"name":{"174":{}},"parent":{}}],["operateid",{"_index":96,"name":{"93":{}},"parent":{}}],["operatemessage",{"_index":116,"name":{"123":{}},"parent":{}}],["operateoptions",{"_index":86,"name":{"84":{}},"parent":{}}],["operatesubscriptionpath",{"_index":55,"name":{"55":{}},"parent":{}}],["path",{"_index":90,"name":{"88":{},"97":{},"101":{},"110":{},"115":{},"122":{},"127":{},"132":{},"137":{},"144":{}},"parent":{}}],["paths",{"_index":92,"name":{"89":{}},"parent":{}}],["persistent",{"_index":88,"name":{"86":{}},"parent":{}}],["promiseresult",{"_index":149,"name":{"167":{}},"parent":{}}],["protobuf/protomessage",{"_index":2,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["protocol",{"_index":136,"name":{"152":{}},"parent":{}}],["protocol/index",{"_index":24,"name":{"22":{}},"parent":{"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{}}}],["protocol/js",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["protocol/lib",{"_index":13,"name":{"11":{}},"parent":{"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{}}}],["protocolargs",{"_index":127,"name":{"145":{}},"parent":{}}],["protocolevents",{"_index":144,"name":{"161":{}},"parent":{}}],["reason",{"_index":100,"name":{"96":{},"108":{}},"parent":{}}],["reject",{"_index":152,"name":{"170":{}},"parent":{}}],["resolve",{"_index":78,"name":{"76":{},"169":{}},"parent":{}}],["resolvereferences",{"_index":43,"name":{"42":{}},"parent":{}}],["role",{"_index":160,"name":{"178":{}},"parent":{}}],["roles",{"_index":84,"name":{"82":{}},"parent":{}}],["rootmsg",{"_index":4,"name":{"2":{}},"parent":{}}],["rootrecord",{"_index":3,"name":{"1":{}},"parent":{}}],["router",{"_index":153,"name":{"171":{}},"parent":{}}],["search",{"_index":19,"name":{"17":{}},"parent":{}}],["searchall",{"_index":21,"name":{"19":{}},"parent":{}}],["send",{"_index":141,"name":{"157":{}},"parent":{}}],["sendfn",{"_index":154,"name":{"172":{}},"parent":{}}],["set",{"_index":70,"name":{"68":{}},"parent":{}}],["setmessage",{"_index":111,"name":{"116":{}},"parent":{}}],["splitreference",{"_index":42,"name":{"41":{}},"parent":{}}],["throwerror",{"_index":45,"name":{"44":{}},"parent":{}}],["throwmsgerror",{"_index":44,"name":{"43":{}},"parent":{}}],["timeout",{"_index":134,"name":{"151":{}},"parent":{}}],["timer",{"_index":37,"name":{"36":{}},"parent":{}}],["type",{"_index":98,"name":{"95":{},"100":{},"105":{},"112":{},"117":{},"124":{},"129":{},"134":{},"139":{}},"parent":{}}],["types.d",{"_index":62,"name":{"62":{}},"parent":{"63":{},"65":{},"84":{},"87":{},"94":{},"98":{},"104":{},"111":{},"116":{},"123":{},"128":{},"133":{},"138":{},"145":{},"150":{},"152":{},"161":{},"164":{},"167":{},"171":{},"172":{},"174":{},"176":{},"178":{},"179":{},"181":{},"182":{},"183":{},"184":{}}}],["types.d\".addmessage",{"_index":121,"name":{},"parent":{"134":{},"135":{},"136":{},"137":{}}}],["types.d\".basemessage",{"_index":102,"name":{},"parent":{"99":{},"100":{},"101":{},"102":{}}}],["types.d\".basemessage.data",{"_index":104,"name":{},"parent":{"103":{}}}],["types.d\".connectevents",{"_index":65,"name":{},"parent":{"64":{}}}],["types.d\".deletemessage",{"_index":123,"name":{},"parent":{"139":{},"140":{},"143":{},"144":{}}}],["types.d\".deletemessage.data",{"_index":124,"name":{},"parent":{"141":{}}}],["types.d\".deletemessage.data.__type",{"_index":126,"name":{},"parent":{"142":{}}}],["types.d\".device",{"_index":68,"name":{},"parent":{"66":{},"68":{},"70":{},"72":{},"74":{},"76":{},"78":{},"80":{},"82":{}}}],["types.d\".device.add",{"_index":75,"name":{},"parent":{"73":{}}}],["types.d\".device.del",{"_index":77,"name":{},"parent":{"75":{}}}],["types.d\".device.disconnect",{"_index":81,"name":{},"parent":{"79":{}}}],["types.d\".device.get",{"_index":69,"name":{},"parent":{"67":{}}}],["types.d\".device.id",{"_index":83,"name":{},"parent":{"81":{}}}],["types.d\".device.operate",{"_index":73,"name":{},"parent":{"71":{}}}],["types.d\".device.resolve",{"_index":79,"name":{},"parent":{"77":{}}}],["types.d\".device.roles",{"_index":85,"name":{},"parent":{"83":{}}}],["types.d\".device.set",{"_index":71,"name":{},"parent":{"69":{}}}],["types.d\".deviceerror",{"_index":99,"name":{},"parent":{"95":{},"96":{},"97":{}}}],["types.d\".encodeargs",{"_index":91,"name":{},"parent":{"88":{},"89":{},"90":{},"91":{},"92":{},"93":{}}}],["types.d\".errormessage",{"_index":106,"name":{},"parent":{"105":{},"106":{},"109":{},"110":{}}}],["types.d\".errormessage.data",{"_index":107,"name":{},"parent":{"107":{}}}],["types.d\".errormessage.data.__type",{"_index":108,"name":{},"parent":{"108":{}}}],["types.d\".getmessage",{"_index":110,"name":{},"parent":{"112":{},"113":{},"114":{},"115":{}}}],["types.d\".initresult",{"_index":135,"name":{},"parent":{"151":{}}}],["types.d\".jsobject",{"_index":162,"name":{},"parent":{"180":{}}}],["types.d\".mqttrequest",{"_index":148,"name":{},"parent":{"165":{},"166":{}}}],["types.d\".notifymessage",{"_index":119,"name":{},"parent":{"129":{},"130":{},"131":{},"132":{}}}],["types.d\".operatecleanupfunction",{"_index":159,"name":{},"parent":{"177":{}}}],["types.d\".operatefunction",{"_index":157,"name":{},"parent":{"175":{}}}],["types.d\".operatemessage",{"_index":117,"name":{},"parent":{"124":{},"125":{},"126":{},"127":{}}}],["types.d\".operateoptions",{"_index":87,"name":{},"parent":{"85":{},"86":{}}}],["types.d\".promiseresult",{"_index":150,"name":{},"parent":{"168":{}}}],["types.d\".promiseresult.__type",{"_index":151,"name":{},"parent":{"169":{},"170":{}}}],["types.d\".protocol",{"_index":137,"name":{},"parent":{"153":{},"155":{},"157":{},"159":{}}}],["types.d\".protocol.close",{"_index":140,"name":{},"parent":{"156":{}}}],["types.d\".protocol.encode",{"_index":143,"name":{},"parent":{"160":{}}}],["types.d\".protocol.init",{"_index":138,"name":{},"parent":{"154":{}}}],["types.d\".protocol.send",{"_index":142,"name":{},"parent":{"158":{}}}],["types.d\".protocolargs",{"_index":129,"name":{},"parent":{"146":{},"148":{}}}],["types.d\".protocolargs.onerror",{"_index":132,"name":{},"parent":{"149":{}}}],["types.d\".protocolargs.onmessage",{"_index":130,"name":{},"parent":{"147":{}}}],["types.d\".protocolevents",{"_index":145,"name":{},"parent":{"162":{}}}],["types.d\".protocolevents.onmessage",{"_index":146,"name":{},"parent":{"163":{}}}],["types.d\".sendfn",{"_index":155,"name":{},"parent":{"173":{}}}],["types.d\".setmessage",{"_index":112,"name":{},"parent":{"117":{},"118":{},"121":{},"122":{}}}],["types.d\".setmessage.data",{"_index":113,"name":{},"parent":{"119":{}}}],["types.d\".setmessage.data.__type",{"_index":115,"name":{},"parent":{"120":{}}}],["unflatten",{"_index":18,"name":{"16":{}},"parent":{}}],["unwraparray",{"_index":23,"name":{"21":{}},"parent":{}}],["unwrapobject",{"_index":22,"name":{"20":{}},"parent":{}}],["updated",{"_index":114,"name":{"120":{}},"parent":{}}],["usp",{"_index":1,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["uspmessage",{"_index":166,"name":{"184":{}},"parent":{}}],["value",{"_index":93,"name":{"90":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index e6ceced..b06cfb7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -150,7 +150,9 @@ run();</code></pre> <pre><code class="language-javascript"><span class="hljs-keyword">await</span> usp.operate(<span class="hljs-string">"Device.SelfTestDiagnostics()"</span>);</code></pre> </li> <li><p>operate with arguments (for required args check USP Reference)</p> - <pre><code class="language-javascript"><span class="hljs-keyword">await</span> usp.operate(<span class="hljs-string">"Device.IP.Diagnostics.IPPing()"</span>, { <span class="hljs-attr">Host</span>: <span class="hljs-string">"iopsys.eu"</span> });</code></pre> + <pre><code class="language-javascript"><span class="hljs-keyword">const</span> [ping, cleanPing] = <span class="hljs-keyword">await</span> usp.operate(<span class="hljs-string">"Device.IP.Diagnostics.IPPing()"</span>); +<span class="hljs-keyword">const</span> results = <span class="hljs-keyword">await</span> ping({ <span class="hljs-attr">Host</span>: <span class="hljs-string">"iopsys.eu"</span> }) +<span class="hljs-keyword">await</span> cleanPing() <span class="hljs-comment">// clears ping subscription (optional)</span></code></pre> </li> </ul> </li> diff --git a/docs/interfaces/_types_d_.addmessage.html b/docs/interfaces/_types_d_.addmessage.html index fb956db..2be2d3f 100644 --- a/docs/interfaces/_types_d_.addmessage.html +++ b/docs/interfaces/_types_d_.addmessage.html @@ -114,7 +114,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> <ul> - <li>Defined in types.d.ts:159</li> + <li>Defined in types.d.ts:182</li> </ul> </aside> </section> @@ -125,7 +125,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -136,7 +136,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -147,7 +147,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> <ul> - <li>Defined in types.d.ts:158</li> + <li>Defined in types.d.ts:181</li> </ul> </aside> </section> @@ -232,9 +232,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -259,6 +265,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.basemessage.html b/docs/interfaces/_types_d_.basemessage.html index 266c2d2..4a8c6fa 100644 --- a/docs/interfaces/_types_d_.basemessage.html +++ b/docs/interfaces/_types_d_.basemessage.html @@ -94,6 +94,9 @@ <li> <a href="_types_d_.operatemessage.html" class="tsd-signature-type">OperateMessage</a> </li> + <li> + <a href="_types_d_.notifymessage.html" class="tsd-signature-type">NotifyMessage</a> + </li> <li> <a href="_types_d_.addmessage.html" class="tsd-signature-type">AddMessage</a> </li> @@ -128,7 +131,7 @@ <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:130</li> + <li>Defined in types.d.ts:148</li> </ul> </aside> <div class="tsd-type-declaration"> @@ -143,7 +146,7 @@ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -153,7 +156,7 @@ <div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -163,7 +166,7 @@ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/_types_d_.html#messagetype" class="tsd-signature-type">MessageType</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:128</li> + <li>Defined in types.d.ts:146</li> </ul> </aside> </section> @@ -248,9 +251,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -275,6 +284,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.connectevents.html b/docs/interfaces/_types_d_.connectevents.html index 1a7e813..42c9369 100644 --- a/docs/interfaces/_types_d_.connectevents.html +++ b/docs/interfaces/_types_d_.connectevents.html @@ -186,9 +186,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -213,6 +219,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.deletemessage.html b/docs/interfaces/_types_d_.deletemessage.html index 66cafd6..5b6c8c8 100644 --- a/docs/interfaces/_types_d_.deletemessage.html +++ b/docs/interfaces/_types_d_.deletemessage.html @@ -114,7 +114,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> <ul> - <li>Defined in types.d.ts:164</li> + <li>Defined in types.d.ts:187</li> </ul> </aside> <div class="tsd-type-declaration"> @@ -133,7 +133,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -144,7 +144,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -155,7 +155,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> <ul> - <li>Defined in types.d.ts:163</li> + <li>Defined in types.d.ts:186</li> </ul> </aside> </section> @@ -240,9 +240,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -267,6 +273,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.device.html b/docs/interfaces/_types_d_.device.html index bf06945..a3b53c8 100644 --- a/docs/interfaces/_types_d_.device.html +++ b/docs/interfaces/_types_d_.device.html @@ -113,7 +113,7 @@ <div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, values<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:64</li> + <li>Defined in types.d.ts:68</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -164,7 +164,7 @@ <div class="tsd-signature tsd-kind-icon">del<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:73</li> + <li>Defined in types.d.ts:77</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -206,7 +206,7 @@ <div class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:91</li> + <li>Defined in types.d.ts:95</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -237,7 +237,7 @@ <div class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:30</li> + <li>Defined in types.d.ts:29</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -281,7 +281,7 @@ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:94</li> + <li>Defined in types.d.ts:98</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -308,23 +308,28 @@ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="operate" class="tsd-anchor"></a> <h3>operate</h3> - <div class="tsd-signature tsd-kind-icon">operate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></div> + <div class="tsd-signature tsd-kind-icon">operate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="_types_d_.operateoptions.html" class="tsd-signature-type">OperateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../modules/_types_d_.html#operatefunction" class="tsd-signature-type">OperateFunction</a><span class="tsd-signature-symbol">, </span><a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-signature-type">OperateCleanupFunction</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:53</li> + <li>Defined in types.d.ts:54</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> - <p>Execute a command</p> + <p>Create a command</p> </div> <dl class="tsd-comment-tags"> <dt>param</dt> - <dd><p>Full path of command (e.g. "Device.SelfTestDiagnostics()")</p> + <dd><p>Full path of command (e.g. "Device.IP.Diagnostics.IPPing()")</p> </dd> <dt>param</dt> - <dd><p>Optional input to the command</p> - <pre><code><span class="hljs-keyword">await</span> usp.operate(<span class="hljs-string">"Device.SelfTestDiagnostics()"</span>)</code></pre> + <dd><p>Subscription options (not required)</p> + </dd> + <dt>returns</dt> + <dd><p>Function that executes command</p> + <pre><code><span class="hljs-keyword">const</span> [ping, cleanPing] = <span class="hljs-keyword">await</span> usp.operate(<span class="hljs-string">"Device.IP.Diagnostics.IPPing()"</span>) +<span class="hljs-keyword">const</span> results = <span class="hljs-keyword">await</span> ping({ Host: <span class="hljs-string">"iopsys.eu"</span> }) +<span class="hljs-keyword">await</span> cleanPing()</code></pre> </dd> </dl> </div> @@ -333,7 +338,7 @@ <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property"> - <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="_types_d_.operateoptions.html" class="tsd-signature-type">OperateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../modules/_types_d_.html#operatefunction" class="tsd-signature-type">OperateFunction</a><span class="tsd-signature-symbol">, </span><a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-signature-type">OperateCleanupFunction</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> @@ -343,10 +348,10 @@ <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> input: <a href="../modules/_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="_types_d_.operateoptions.html" class="tsd-signature-type">OperateOptions</a></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../modules/_types_d_.html#operatefunction" class="tsd-signature-type">OperateFunction</a><span class="tsd-signature-symbol">, </span><a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-signature-type">OperateCleanupFunction</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -359,7 +364,7 @@ <div class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a>, level<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:83</li> + <li>Defined in types.d.ts:87</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -407,7 +412,7 @@ <div class="tsd-signature tsd-kind-icon">roles<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../modules/_types_d_.html#role" class="tsd-signature-type">Role</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:97</li> + <li>Defined in types.d.ts:101</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -437,7 +442,7 @@ <div class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:42</li> + <li>Defined in types.d.ts:41</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -577,9 +582,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -604,6 +615,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.deviceerror.html b/docs/interfaces/_types_d_.deviceerror.html index ddf14d2..effc66f 100644 --- a/docs/interfaces/_types_d_.deviceerror.html +++ b/docs/interfaces/_types_d_.deviceerror.html @@ -107,7 +107,7 @@ <div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:123</li> + <li>Defined in types.d.ts:141</li> </ul> </aside> </section> @@ -117,7 +117,7 @@ <div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:122</li> + <li>Defined in types.d.ts:140</li> </ul> </aside> </section> @@ -127,7 +127,7 @@ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"error"</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:121</li> + <li>Defined in types.d.ts:139</li> </ul> </aside> </section> @@ -209,9 +209,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -236,6 +242,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.encodeargs.html b/docs/interfaces/_types_d_.encodeargs.html index e689bdc..0327336 100644 --- a/docs/interfaces/_types_d_.encodeargs.html +++ b/docs/interfaces/_types_d_.encodeargs.html @@ -93,6 +93,7 @@ <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.encodeargs.html#action" class="tsd-kind-icon">action</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.encodeargs.html#input" class="tsd-kind-icon">input</a></li> + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.encodeargs.html#operateid" class="tsd-kind-icon">operateID</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.encodeargs.html#path" class="tsd-kind-icon">path</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.encodeargs.html#paths" class="tsd-kind-icon">paths</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.encodeargs.html#value" class="tsd-kind-icon">value</a></li> @@ -109,7 +110,7 @@ <div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:106</li> + <li>Defined in types.d.ts:123</li> </ul> </aside> </section> @@ -119,7 +120,17 @@ <div class="tsd-signature tsd-kind-icon">input<span class="tsd-signature-symbol">:</span> <a href="../modules/_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:105</li> + <li>Defined in types.d.ts:122</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> + <a name="operateid" class="tsd-anchor"></a> + <h3>operateID</h3> + <div class="tsd-signature tsd-kind-icon">operateID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in types.d.ts:124</li> </ul> </aside> </section> @@ -129,7 +140,7 @@ <div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:102</li> + <li>Defined in types.d.ts:119</li> </ul> </aside> </section> @@ -139,7 +150,7 @@ <div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:103</li> + <li>Defined in types.d.ts:120</li> </ul> </aside> </section> @@ -149,7 +160,7 @@ <div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <a href="../modules/_types_d_.html#jstype" class="tsd-signature-type">JSType</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:104</li> + <li>Defined in types.d.ts:121</li> </ul> </aside> </section> @@ -212,6 +223,9 @@ <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_types_d_.encodeargs.html#input" class="tsd-kind-icon">input</a> </li> + <li class=" tsd-kind-property tsd-parent-kind-interface"> + <a href="_types_d_.encodeargs.html#operateid" class="tsd-kind-icon">operateID</a> + </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_types_d_.encodeargs.html#path" class="tsd-kind-icon">path</a> </li> @@ -237,9 +251,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -264,6 +284,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.errormessage.html b/docs/interfaces/_types_d_.errormessage.html index f186633..45cf4f8 100644 --- a/docs/interfaces/_types_d_.errormessage.html +++ b/docs/interfaces/_types_d_.errormessage.html @@ -114,7 +114,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> <ul> - <li>Defined in types.d.ts:135</li> + <li>Defined in types.d.ts:153</li> </ul> </aside> <div class="tsd-type-declaration"> @@ -133,7 +133,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -144,7 +144,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -155,7 +155,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> <ul> - <li>Defined in types.d.ts:134</li> + <li>Defined in types.d.ts:152</li> </ul> </aside> </section> @@ -240,9 +240,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -267,6 +273,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.getmessage.html b/docs/interfaces/_types_d_.getmessage.html index 03f3dd7..3ff3546 100644 --- a/docs/interfaces/_types_d_.getmessage.html +++ b/docs/interfaces/_types_d_.getmessage.html @@ -114,7 +114,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> <ul> - <li>Defined in types.d.ts:142</li> + <li>Defined in types.d.ts:160</li> </ul> </aside> </section> @@ -125,7 +125,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -136,7 +136,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -147,7 +147,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> <ul> - <li>Defined in types.d.ts:141</li> + <li>Defined in types.d.ts:159</li> </ul> </aside> </section> @@ -232,9 +232,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -259,6 +265,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.initresult.html b/docs/interfaces/_types_d_.initresult.html index 089dccb..2d75d71 100644 --- a/docs/interfaces/_types_d_.initresult.html +++ b/docs/interfaces/_types_d_.initresult.html @@ -105,7 +105,7 @@ <div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:187</li> + <li>Defined in types.d.ts:211</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -186,9 +186,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -213,6 +219,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.mqttrequest.html b/docs/interfaces/_types_d_.mqttrequest.html index bc068ec..9c13bac 100644 --- a/docs/interfaces/_types_d_.mqttrequest.html +++ b/docs/interfaces/_types_d_.mqttrequest.html @@ -106,7 +106,7 @@ <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:216</li> + <li>Defined in types.d.ts:240</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -121,7 +121,7 @@ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:214</li> + <li>Defined in types.d.ts:238</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -205,9 +205,15 @@ </li> </ul> <ul class="after-current"> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -232,6 +238,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.notifymessage.html b/docs/interfaces/_types_d_.notifymessage.html new file mode 100644 index 0000000..bb9fc8f --- /dev/null +++ b/docs/interfaces/_types_d_.notifymessage.html @@ -0,0 +1,316 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>NotifyMessage | usp-js</title> + <meta name="description" content="Documentation for usp-js"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="stylesheet" href="../assets/css/main.css"> +</head> +<body> +<header> + <div class="tsd-page-toolbar"> + <div class="container"> + <div class="table-wrap"> + <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> + <div class="field"> + <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> + <input id="tsd-search-field" type="text" /> + </div> + <ul class="results"> + <li class="state loading">Preparing search index...</li> + <li class="state failure">The search index is not available</li> + </ul> + <a href="../index.html" class="title">usp-js</a> + </div> + <div class="table-cell" id="tsd-widgets"> + <div id="tsd-filter"> + <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> + <div class="tsd-filter-group"> + <div class="tsd-select" id="tsd-filter-visibility"> + <span class="tsd-select-label">All</span> + <ul class="tsd-select-list"> + <li data-value="public">Public</li> + <li data-value="protected">Public/Protected</li> + <li data-value="private" class="selected">All</li> + </ul> + </div> + <input type="checkbox" id="tsd-filter-inherited" checked /> + <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> + <input type="checkbox" id="tsd-filter-externals" checked /> + <label class="tsd-widget" for="tsd-filter-externals">Externals</label> + <input type="checkbox" id="tsd-filter-only-exported" /> + <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> + </div> + </div> + <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> + </div> + </div> + </div> + </div> + <div class="tsd-page-title"> + <div class="container"> + <ul class="tsd-breadcrumb"> + <li> + <a href="../globals.html">Globals</a> + </li> + <li> + <a href="../modules/_types_d_.html">"types.d"</a> + </li> + <li> + <a href="_types_d_.notifymessage.html">NotifyMessage</a> + </li> + </ul> + <h1>Interface NotifyMessage</h1> + </div> + </div> +</header> +<div class="container container-main"> + <div class="row"> + <div class="col-8 col-content"> + <section class="tsd-panel tsd-comment"> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Notify Message</p> + </div> + </div> + </section> + <section class="tsd-panel tsd-hierarchy"> + <h3>Hierarchy</h3> + <ul class="tsd-hierarchy"> + <li> + <a href="_types_d_.basemessage.html" class="tsd-signature-type">BaseMessage</a> + <ul class="tsd-hierarchy"> + <li> + <span class="target">NotifyMessage</span> + </li> + </ul> + </li> + </ul> + </section> + <section class="tsd-panel-group tsd-index-group"> + <h2>Index</h2> + <section class="tsd-panel tsd-index-panel"> + <div class="tsd-index-content"> + <section class="tsd-index-section "> + <h3>Properties</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="_types_d_.notifymessage.html#data" class="tsd-kind-icon">data</a></li> + <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_types_d_.notifymessage.html#id" class="tsd-kind-icon">id</a></li> + <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_types_d_.notifymessage.html#path" class="tsd-kind-icon">path</a></li> + <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="_types_d_.notifymessage.html#type" class="tsd-kind-icon">type</a></li> + </ul> + </section> + </div> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Properties</h2> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> + <a name="data" class="tsd-anchor"></a> + <h3>data</h3> + <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JSValue</span></div> + <aside class="tsd-sources"> + <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> + <ul> + <li>Defined in types.d.ts:177</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> + <a name="id" class="tsd-anchor"></a> + <h3>id</h3> + <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> + <ul> + <li>Defined in types.d.ts:145</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> + <a name="path" class="tsd-anchor"></a> + <h3>path</h3> + <div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> + <ul> + <li>Defined in types.d.ts:147</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> + <a name="type" class="tsd-anchor"></a> + <h3>type</h3> + <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"notify"</span></div> + <aside class="tsd-sources"> + <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> + <ul> + <li>Defined in types.d.ts:176</li> + </ul> + </aside> + </section> + </section> + </div> + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> + <nav class="tsd-navigation primary"> + <ul> + <li class="globals "> + <a href="../globals.html"><em>Globals</em></a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_index_.html">"index"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_lib_.html">"lib"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_protocol_index_.html">"protocol/index"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_protocol_js_usp_protobuf_protomessage_.html">"protocol/js-<wbr>usp-<wbr>protobuf/proto<wbr>Message"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_protocol_lib_.html">"protocol/lib"</a> + </li> + <li class="current tsd-kind-module"> + <a href="../modules/_types_d_.html">"types.d"</a> + </li> + </ul> + </nav> + <nav class="tsd-navigation secondary menu-sticky"> + <ul class="before-current"> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.addmessage.html" class="tsd-kind-icon">Add<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.basemessage.html" class="tsd-kind-icon">Base<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.connectevents.html" class="tsd-kind-icon">Connect<wbr>Events</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.deletemessage.html" class="tsd-kind-icon">Delete<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.device.html" class="tsd-kind-icon">Device</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.deviceerror.html" class="tsd-kind-icon">Device<wbr>Error</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.encodeargs.html" class="tsd-kind-icon">Encode<wbr>Args</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.errormessage.html" class="tsd-kind-icon">Error<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.getmessage.html" class="tsd-kind-icon">Get<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.initresult.html" class="tsd-kind-icon">Init<wbr>Result</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> + </li> + </ul> + <ul class="current"> + <li class="current tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + <ul> + <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> + <a href="_types_d_.notifymessage.html#data" class="tsd-kind-icon">data</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> + <a href="_types_d_.notifymessage.html#id" class="tsd-kind-icon">id</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> + <a href="_types_d_.notifymessage.html#path" class="tsd-kind-icon">path</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> + <a href="_types_d_.notifymessage.html#type" class="tsd-kind-icon">type</a> + </li> + </ul> + </li> + </ul> + <ul class="after-current"> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.protocolargs.html" class="tsd-kind-icon">Protocol<wbr>Args</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.protocolevents.html" class="tsd-kind-icon">Protocol<wbr>Events</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.setmessage.html" class="tsd-kind-icon">Set<wbr>Message</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#commandtype" class="tsd-kind-icon">Command<wbr>Type</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#jsobject" class="tsd-kind-icon">JSObject</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#jstype" class="tsd-kind-icon">JSType</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#role" class="tsd-kind-icon">Role</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#router" class="tsd-kind-icon">Router</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#sendfn" class="tsd-kind-icon">Send<wbr>Fn</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#uspmessage" class="tsd-kind-icon">USPMessage</a> + </li> + </ul> + </nav> + </div> + </div> +</div> +<footer class="with-border-bottom"> + <div class="container"> + <h2>Legend</h2> + <div class="tsd-legend-group"> + <ul class="tsd-legend"> + <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> + <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> + <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> + <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> + </ul> + </div> + </div> +</footer> +<div class="container tsd-generator"> + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> +</div> +<div class="overlay"></div> +<script src="../assets/js/main.js"></script> +</body> +</html> \ No newline at end of file diff --git a/docs/interfaces/_types_d_.operatemessage.html b/docs/interfaces/_types_d_.operatemessage.html index 7c84baf..2699965 100644 --- a/docs/interfaces/_types_d_.operatemessage.html +++ b/docs/interfaces/_types_d_.operatemessage.html @@ -114,7 +114,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> <ul> - <li>Defined in types.d.ts:154</li> + <li>Defined in types.d.ts:172</li> </ul> </aside> </section> @@ -125,7 +125,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -136,7 +136,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -147,7 +147,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> <ul> - <li>Defined in types.d.ts:153</li> + <li>Defined in types.d.ts:171</li> </ul> </aside> </section> @@ -214,6 +214,9 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> @@ -235,6 +238,9 @@ </li> </ul> <ul class="after-current"> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -259,6 +265,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.operateoptions.html b/docs/interfaces/_types_d_.operateoptions.html new file mode 100644 index 0000000..f38811c --- /dev/null +++ b/docs/interfaces/_types_d_.operateoptions.html @@ -0,0 +1,289 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>OperateOptions | usp-js</title> + <meta name="description" content="Documentation for usp-js"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="stylesheet" href="../assets/css/main.css"> +</head> +<body> +<header> + <div class="tsd-page-toolbar"> + <div class="container"> + <div class="table-wrap"> + <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> + <div class="field"> + <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> + <input id="tsd-search-field" type="text" /> + </div> + <ul class="results"> + <li class="state loading">Preparing search index...</li> + <li class="state failure">The search index is not available</li> + </ul> + <a href="../index.html" class="title">usp-js</a> + </div> + <div class="table-cell" id="tsd-widgets"> + <div id="tsd-filter"> + <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> + <div class="tsd-filter-group"> + <div class="tsd-select" id="tsd-filter-visibility"> + <span class="tsd-select-label">All</span> + <ul class="tsd-select-list"> + <li data-value="public">Public</li> + <li data-value="protected">Public/Protected</li> + <li data-value="private" class="selected">All</li> + </ul> + </div> + <input type="checkbox" id="tsd-filter-inherited" checked /> + <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> + <input type="checkbox" id="tsd-filter-externals" checked /> + <label class="tsd-widget" for="tsd-filter-externals">Externals</label> + <input type="checkbox" id="tsd-filter-only-exported" /> + <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> + </div> + </div> + <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> + </div> + </div> + </div> + </div> + <div class="tsd-page-title"> + <div class="container"> + <ul class="tsd-breadcrumb"> + <li> + <a href="../globals.html">Globals</a> + </li> + <li> + <a href="../modules/_types_d_.html">"types.d"</a> + </li> + <li> + <a href="_types_d_.operateoptions.html">OperateOptions</a> + </li> + </ul> + <h1>Interface OperateOptions</h1> + </div> + </div> +</header> +<div class="container container-main"> + <div class="row"> + <div class="col-8 col-content"> + <section class="tsd-panel tsd-comment"> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Options for Operate Subscription</p> + </div> + </div> + </section> + <section class="tsd-panel tsd-hierarchy"> + <h3>Hierarchy</h3> + <ul class="tsd-hierarchy"> + <li> + <span class="target">OperateOptions</span> + </li> + </ul> + </section> + <section class="tsd-panel-group tsd-index-group"> + <h2>Index</h2> + <section class="tsd-panel tsd-index-panel"> + <div class="tsd-index-content"> + <section class="tsd-index-section "> + <h3>Properties</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.operateoptions.html#id" class="tsd-kind-icon">ID</a></li> + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_d_.operateoptions.html#persistent" class="tsd-kind-icon">Persistent</a></li> + </ul> + </section> + </div> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Properties</h2> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> + <a name="id" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagOptional">Optional</span> ID</h3> + <div class="tsd-signature tsd-kind-icon">ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in types.d.ts:107</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Subscription ID (optional)</p> + </div> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> + <a name="persistent" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagOptional">Optional</span> Persistent</h3> + <div class="tsd-signature tsd-kind-icon">Persistent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in types.d.ts:109</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Should subscription remain through sessions (optional)</p> + </div> + </div> + </section> + </section> + </div> + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> + <nav class="tsd-navigation primary"> + <ul> + <li class="globals "> + <a href="../globals.html"><em>Globals</em></a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_index_.html">"index"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_lib_.html">"lib"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_protocol_index_.html">"protocol/index"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_protocol_js_usp_protobuf_protomessage_.html">"protocol/js-<wbr>usp-<wbr>protobuf/proto<wbr>Message"</a> + </li> + <li class=" tsd-kind-module"> + <a href="../modules/_protocol_lib_.html">"protocol/lib"</a> + </li> + <li class="current tsd-kind-module"> + <a href="../modules/_types_d_.html">"types.d"</a> + </li> + </ul> + </nav> + <nav class="tsd-navigation secondary menu-sticky"> + <ul class="before-current"> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.addmessage.html" class="tsd-kind-icon">Add<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.basemessage.html" class="tsd-kind-icon">Base<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.connectevents.html" class="tsd-kind-icon">Connect<wbr>Events</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.deletemessage.html" class="tsd-kind-icon">Delete<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.device.html" class="tsd-kind-icon">Device</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.deviceerror.html" class="tsd-kind-icon">Device<wbr>Error</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.encodeargs.html" class="tsd-kind-icon">Encode<wbr>Args</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.errormessage.html" class="tsd-kind-icon">Error<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.getmessage.html" class="tsd-kind-icon">Get<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.initresult.html" class="tsd-kind-icon">Init<wbr>Result</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> + </li> + </ul> + <ul class="current"> + <li class="current tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + <ul> + <li class=" tsd-kind-property tsd-parent-kind-interface"> + <a href="_types_d_.operateoptions.html#id" class="tsd-kind-icon">ID</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-interface"> + <a href="_types_d_.operateoptions.html#persistent" class="tsd-kind-icon">Persistent</a> + </li> + </ul> + </li> + </ul> + <ul class="after-current"> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.protocolargs.html" class="tsd-kind-icon">Protocol<wbr>Args</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.protocolevents.html" class="tsd-kind-icon">Protocol<wbr>Events</a> + </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.setmessage.html" class="tsd-kind-icon">Set<wbr>Message</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#commandtype" class="tsd-kind-icon">Command<wbr>Type</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#jsobject" class="tsd-kind-icon">JSObject</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#jstype" class="tsd-kind-icon">JSType</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#role" class="tsd-kind-icon">Role</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#router" class="tsd-kind-icon">Router</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#sendfn" class="tsd-kind-icon">Send<wbr>Fn</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#uspmessage" class="tsd-kind-icon">USPMessage</a> + </li> + </ul> + </nav> + </div> + </div> +</div> +<footer class="with-border-bottom"> + <div class="container"> + <h2>Legend</h2> + <div class="tsd-legend-group"> + <ul class="tsd-legend"> + <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> + <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> + <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> + <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> + </ul> + </div> + </div> +</footer> +<div class="container tsd-generator"> + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> +</div> +<div class="overlay"></div> +<script src="../assets/js/main.js"></script> +</body> +</html> \ No newline at end of file diff --git a/docs/interfaces/_types_d_.protocol.html b/docs/interfaces/_types_d_.protocol.html index 28018e3..178d59c 100644 --- a/docs/interfaces/_types_d_.protocol.html +++ b/docs/interfaces/_types_d_.protocol.html @@ -108,7 +108,7 @@ <div class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:195</li> + <li>Defined in types.d.ts:219</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -138,7 +138,7 @@ <div class="tsd-signature tsd-kind-icon">encode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="../modules/_types_d_.html#commandtype" class="tsd-signature-type">CommandType</a>, args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="_types_d_.encodeargs.html" class="tsd-signature-type">EncodeArgs</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:199</li> + <li>Defined in types.d.ts:223</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -185,7 +185,7 @@ <div class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_types_d_.initresult.html" class="tsd-signature-type">InitResult</a><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:193</li> + <li>Defined in types.d.ts:217</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -215,7 +215,7 @@ <div class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>any<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:197</li> + <li>Defined in types.d.ts:221</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -313,9 +313,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> @@ -358,6 +364,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.protocolargs.html b/docs/interfaces/_types_d_.protocolargs.html index 79ab668..a6769b1 100644 --- a/docs/interfaces/_types_d_.protocolargs.html +++ b/docs/interfaces/_types_d_.protocolargs.html @@ -106,7 +106,7 @@ <div class="tsd-signature tsd-kind-icon">on<wbr>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:181</li> + <li>Defined in types.d.ts:205</li> </ul> </aside> <div class="tsd-type-declaration"> @@ -137,7 +137,7 @@ <div class="tsd-signature tsd-kind-icon">on<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><a href="../modules/_types_d_.html#uspmessage" class="tsd-signature-type">USPMessage</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:180</li> + <li>Defined in types.d.ts:204</li> </ul> </aside> <div class="tsd-type-declaration"> @@ -225,9 +225,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -264,6 +270,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.protocolevents.html b/docs/interfaces/_types_d_.protocolevents.html index 02fa867..0dad171 100644 --- a/docs/interfaces/_types_d_.protocolevents.html +++ b/docs/interfaces/_types_d_.protocolevents.html @@ -105,7 +105,7 @@ <div class="tsd-signature tsd-kind-icon">on<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>resp<span class="tsd-signature-symbol">: </span><a href="../modules/_types_d_.html#uspmessage" class="tsd-signature-type">USPMessage</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:208</li> + <li>Defined in types.d.ts:232</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -198,9 +198,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -234,6 +240,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/interfaces/_types_d_.setmessage.html b/docs/interfaces/_types_d_.setmessage.html index 7c17d6b..658456f 100644 --- a/docs/interfaces/_types_d_.setmessage.html +++ b/docs/interfaces/_types_d_.setmessage.html @@ -114,7 +114,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#data">data</a></p> <ul> - <li>Defined in types.d.ts:147</li> + <li>Defined in types.d.ts:165</li> </ul> </aside> <div class="tsd-type-declaration"> @@ -133,7 +133,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#id">id</a></p> <ul> - <li>Defined in types.d.ts:127</li> + <li>Defined in types.d.ts:145</li> </ul> </aside> </section> @@ -144,7 +144,7 @@ <aside class="tsd-sources"> <p>Inherited from <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#path">path</a></p> <ul> - <li>Defined in types.d.ts:129</li> + <li>Defined in types.d.ts:147</li> </ul> </aside> </section> @@ -155,7 +155,7 @@ <aside class="tsd-sources"> <p>Overrides <a href="_types_d_.basemessage.html">BaseMessage</a>.<a href="_types_d_.basemessage.html#type">type</a></p> <ul> - <li>Defined in types.d.ts:146</li> + <li>Defined in types.d.ts:164</li> </ul> </aside> </section> @@ -222,9 +222,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -267,6 +273,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="../modules/_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/docs/modules/_index_.html b/docs/modules/_index_.html index 28578f5..11ae351 100644 --- a/docs/modules/_index_.html +++ b/docs/modules/_index_.html @@ -70,10 +70,18 @@ <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> + <section class="tsd-index-section tsd-is-not-exported"> + <h3>Type aliases</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_index_.html#addfn" class="tsd-kind-icon">Add<wbr>Fn</a></li> + <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_index_.html#delfn" class="tsd-kind-icon">Del<wbr>Fn</a></li> + </ul> + </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_index_.html#commandswithreturnvalue" class="tsd-kind-icon">commands<wbr>With<wbr>Return<wbr>Value</a></li> + <li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_index_.html#operatesubscriptionpath" class="tsd-kind-icon">operate<wbr>Subscription<wbr>Path</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> @@ -100,12 +108,80 @@ </div> </section> </section> + <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> + <h2>Type aliases</h2> + <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"> + <a name="addfn" class="tsd-anchor"></a> + <h3>Add<wbr>Fn</h3> + <div class="tsd-signature tsd-kind-icon">Add<wbr>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<span class="tsd-signature-symbol">?: </span><a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in index.ts:139</li> + </ul> + </aside> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> + <li class="tsd-parameter-signature"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<span class="tsd-signature-symbol">?: </span><a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>path: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> input: <a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"> + <a name="delfn" class="tsd-anchor"></a> + <h3>Del<wbr>Fn</h3> + <div class="tsd-signature tsd-kind-icon">Del<wbr>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in index.ts:140</li> + </ul> + </aside> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> + <li class="tsd-parameter-signature"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </div> + </section> + </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> <a name="commandswithreturnvalue" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> commands<wbr>With<wbr>Return<wbr>Value</h3> - <div class="tsd-signature tsd-kind-icon">commands<wbr>With<wbr>Return<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ["get", "operate", "add"]</span></div> + <div class="tsd-signature tsd-kind-icon">commands<wbr>With<wbr>Return<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ["get", "notify", "add"]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:87</li> @@ -117,6 +193,16 @@ </div> </div> </section> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> + <a name="operatesubscriptionpath" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> operate<wbr>Subscription<wbr>Path</h3> + <div class="tsd-signature tsd-kind-icon">operate<wbr>Subscription<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Device.LocalAgent.Subscription."</span><span class="tsd-signature-symbol"> = "Device.LocalAgent.Subscription."</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in index.ts:138</li> + </ul> + </aside> + </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Functions</h2> @@ -158,7 +244,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in index.ts:159</li> + <li>Defined in index.ts:181</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -421,13 +507,13 @@ <a name="makeoperate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Operate</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> - <li class="tsd-signature tsd-kind-icon">make<wbr>Operate<span class="tsd-signature-symbol">(</span>send<span class="tsd-signature-symbol">: </span><a href="_types_d_.html#sendfn" class="tsd-signature-type">SendFn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li> + <li class="tsd-signature tsd-kind-icon">make<wbr>Operate<span class="tsd-signature-symbol">(</span>send<span class="tsd-signature-symbol">: </span><a href="_types_d_.html#sendfn" class="tsd-signature-type">SendFn</a>, add<span class="tsd-signature-symbol">: </span><a href="_index_.html#addfn" class="tsd-signature-type">AddFn</a>, del<span class="tsd-signature-symbol">: </span><a href="_index_.html#delfn" class="tsd-signature-type">DelFn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in index.ts:141</li> + <li>Defined in index.ts:145</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -440,6 +526,12 @@ <li> <h5>send: <a href="_types_d_.html#sendfn" class="tsd-signature-type">SendFn</a></h5> </li> + <li> + <h5>add: <a href="_index_.html#addfn" class="tsd-signature-type">AddFn</a></h5> + </li> + <li> + <h5>del: <a href="_index_.html#delfn" class="tsd-signature-type">DelFn</a></h5> + </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4> </li> @@ -654,9 +746,18 @@ </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> + <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"> + <a href="_index_.html#addfn" class="tsd-kind-icon">Add<wbr>Fn</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"> + <a href="_index_.html#delfn" class="tsd-kind-icon">Del<wbr>Fn</a> + </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> <a href="_index_.html#commandswithreturnvalue" class="tsd-kind-icon">commands<wbr>With<wbr>Return<wbr>Value</a> </li> + <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> + <a href="_index_.html#operatesubscriptionpath" class="tsd-kind-icon">operate<wbr>Subscription<wbr>Path</a> + </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <a href="_index_.html#adddot" class="tsd-kind-icon">add<wbr>Dot</a> </li> diff --git a/docs/modules/_protocol_index_.html b/docs/modules/_protocol_index_.html index 6af1984..8e4926f 100644 --- a/docs/modules/_protocol_index_.html +++ b/docs/modules/_protocol_index_.html @@ -70,6 +70,12 @@ <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> + <section class="tsd-index-section tsd-is-not-exported"> + <h3>Variables</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_protocol_index_.html#ignorabletypes" class="tsd-kind-icon">ignorable<wbr>Types</a></li> + </ul> + </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> @@ -89,6 +95,19 @@ </div> </section> </section> + <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> + <h2>Variables</h2> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> + <a name="ignorabletypes" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> ignorable<wbr>Types</h3> + <div class="tsd-signature tsd-kind-icon">ignorable<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ["operate"]</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in protocol/index.ts:74</li> + </ul> + </aside> + </section> + </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> @@ -101,7 +120,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:152</li> + <li>Defined in protocol/index.ts:162</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -123,13 +142,13 @@ <a name="decode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> decode</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> - <li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>rawMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_types_d_.html#uspmessage" class="tsd-signature-type">USPMessage</a></li> + <li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><a href="_types_d_.html#messagetype" class="tsd-signature-type">MessageType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_types_d_.html#uspmessage" class="tsd-signature-type">USPMessage</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:72</li> + <li>Defined in protocol/index.ts:77</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -140,7 +159,10 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>rawMsg: <span class="tsd-signature-type">any</span></h5> + <h5>msg: <span class="tsd-signature-type">any</span></h5> + </li> + <li> + <h5>type: <a href="_types_d_.html#messagetype" class="tsd-signature-type">MessageType</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_types_d_.html#uspmessage" class="tsd-signature-type">USPMessage</a></h4> @@ -157,7 +179,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:56</li> + <li>Defined in protocol/index.ts:59</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -188,7 +210,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:133</li> + <li>Defined in protocol/index.ts:138</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -227,7 +249,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:114</li> + <li>Defined in protocol/index.ts:117</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -258,7 +280,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:124</li> + <li>Defined in protocol/index.ts:129</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -286,7 +308,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:6</li> + <li>Defined in protocol/index.ts:7</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -308,13 +330,13 @@ <a name="encodeoperate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> encode<wbr>Operate</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> - <li class="tsd-signature tsd-kind-icon">encode<wbr>Operate<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_d_.mqttrequest.html" class="tsd-signature-type">MQTTRequest</a></li> + <li class="tsd-signature tsd-kind-icon">encode<wbr>Operate<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, operateID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_d_.mqttrequest.html" class="tsd-signature-type">MQTTRequest</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:36</li> + <li>Defined in protocol/index.ts:37</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -330,6 +352,9 @@ <li> <h5>action: <span class="tsd-signature-type">string</span></h5> </li> + <li> + <h5>operateID: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> input: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5> </li> @@ -348,7 +373,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:15</li> + <li>Defined in protocol/index.ts:16</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -379,7 +404,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:49</li> + <li>Defined in protocol/index.ts:51</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -407,7 +432,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in protocol/index.ts:161</li> + <li>Defined in protocol/index.ts:171</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -458,6 +483,9 @@ </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> + <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> + <a href="_protocol_index_.html#ignorabletypes" class="tsd-kind-icon">ignorable<wbr>Types</a> + </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_protocol_index_.html#connect" class="tsd-kind-icon">connect</a> </li> diff --git a/docs/modules/_types_d_.html b/docs/modules/_types_d_.html index dab8a37..705b120 100644 --- a/docs/modules/_types_d_.html +++ b/docs/modules/_types_d_.html @@ -84,7 +84,9 @@ <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.getmessage.html" class="tsd-kind-icon">Get<wbr>Message</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.initresult.html" class="tsd-kind-icon">Init<wbr>Result</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a></li> + <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a></li> + <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.protocolargs.html" class="tsd-kind-icon">Protocol<wbr>Args</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_types_d_.protocolevents.html" class="tsd-kind-icon">Protocol<wbr>Events</a></li> @@ -98,6 +100,8 @@ <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#jsobject" class="tsd-kind-icon">JSObject</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#jstype" class="tsd-kind-icon">JSType</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a></li> + <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a></li> + <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#role" class="tsd-kind-icon">Role</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_types_d_.html#router" class="tsd-kind-icon">Router</a></li> @@ -113,10 +117,10 @@ <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="commandtype" class="tsd-anchor"></a> <h3>Command<wbr>Type</h3> - <div class="tsd-signature tsd-kind-icon">Command<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"get"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"set"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"operate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"delete"</span></div> + <div class="tsd-signature tsd-kind-icon">Command<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"get"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"set"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"operate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"delete"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"notify"</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:114</li> + <li>Defined in types.d.ts:132</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -131,7 +135,7 @@ <div class="tsd-signature tsd-kind-icon">JSObject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:112</li> + <li>Defined in types.d.ts:130</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -154,7 +158,7 @@ <div class="tsd-signature tsd-kind-icon">JSType<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:118</li> + <li>Defined in types.d.ts:136</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -169,7 +173,7 @@ <div class="tsd-signature tsd-kind-icon">Message<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="_types_d_.html#commandtype" class="tsd-signature-type">CommandType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:116</li> + <li>Defined in types.d.ts:134</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -178,6 +182,72 @@ </div> </div> </section> + <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> + <a name="operatecleanupfunction" class="tsd-anchor"></a> + <h3>Operate<wbr>Cleanup<wbr>Function</h3> + <div class="tsd-signature tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in types.d.ts:115</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Cleans up command subscription</p> + </div> + </div> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> + <li class="tsd-parameter-signature"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> + <a name="operatefunction" class="tsd-anchor"></a> + <h3>Operate<wbr>Function</h3> + <div class="tsd-signature tsd-kind-icon">Operate<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">?: </span><a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in types.d.ts:113</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Executes a command</p> + </div> + </div> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> + <li class="tsd-parameter-signature"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">?: </span><a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> input: <a href="_types_d_.html#jsobject" class="tsd-signature-type">JSObject</a></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_types_d_.html#jstype" class="tsd-signature-type">JSType</a><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </div> + </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="promiseresult" class="tsd-anchor"></a> <h3>Promise<wbr>Result</h3> @@ -210,7 +280,7 @@ <div class="tsd-signature tsd-kind-icon">Role<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"admin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:110</li> + <li>Defined in types.d.ts:128</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -276,10 +346,10 @@ <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="uspmessage" class="tsd-anchor"></a> <h3>USPMessage</h3> - <div class="tsd-signature tsd-kind-icon">USPMessage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_d_.getmessage.html" class="tsd-signature-type">GetMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.setmessage.html" class="tsd-signature-type">SetMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.operatemessage.html" class="tsd-signature-type">OperateMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.addmessage.html" class="tsd-signature-type">AddMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.deletemessage.html" class="tsd-signature-type">DeleteMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.errormessage.html" class="tsd-signature-type">ErrorMessage</a></div> + <div class="tsd-signature tsd-kind-icon">USPMessage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_d_.getmessage.html" class="tsd-signature-type">GetMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.setmessage.html" class="tsd-signature-type">SetMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.operatemessage.html" class="tsd-signature-type">OperateMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.addmessage.html" class="tsd-signature-type">AddMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.deletemessage.html" class="tsd-signature-type">DeleteMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.notifymessage.html" class="tsd-signature-type">NotifyMessage</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_types_d_.errormessage.html" class="tsd-signature-type">ErrorMessage</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in types.d.ts:170</li> + <li>Defined in types.d.ts:193</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -351,9 +421,15 @@ <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_types_d_.mqttrequest.html" class="tsd-kind-icon">MQTTRequest</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="../interfaces/_types_d_.notifymessage.html" class="tsd-kind-icon">Notify<wbr>Message</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_types_d_.operatemessage.html" class="tsd-kind-icon">Operate<wbr>Message</a> </li> + <li class=" tsd-kind-interface tsd-parent-kind-module"> + <a href="../interfaces/_types_d_.operateoptions.html" class="tsd-kind-icon">Operate<wbr>Options</a> + </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_types_d_.protocol.html" class="tsd-kind-icon">Protocol</a> </li> @@ -378,6 +454,12 @@ <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="_types_d_.html#messagetype" class="tsd-kind-icon">Message<wbr>Type</a> </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="_types_d_.html#operatecleanupfunction" class="tsd-kind-icon">Operate<wbr>Cleanup<wbr>Function</a> + </li> + <li class=" tsd-kind-type-alias tsd-parent-kind-module"> + <a href="_types_d_.html#operatefunction" class="tsd-kind-icon">Operate<wbr>Function</a> + </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="_types_d_.html#promiseresult" class="tsd-kind-icon">Promise<wbr>Result</a> </li> diff --git a/package.json b/package.json index e0ba016..b0cce74 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "usp-js", - "version": "0.0.5", + "version": "0.0.6", "description": "Helper library for easy usp communication using mqtt over tcp or ws.", "main": "build/index.js", "scripts": { diff --git a/src/index.ts b/src/index.ts index 5b398c9..c457f79 100644 --- a/src/index.ts +++ b/src/index.ts @@ -168,7 +168,7 @@ const makeOperate = (send: SendFn, add: AddFn, del: DelFn) => async ( path ) as Promise<JSType>; - const cleanup = () => del(newSubPath) + const cleanup = () => del(newSubPath); return [command, cleanup]; }; @@ -179,7 +179,7 @@ const makeOperate = (send: SendFn, add: AddFn, del: DelFn) => async ( * @returns A set of functions for interacting with the device */ const connect = async ( - opts: mqttAsync.IClientOptions, + opts: ConnectOptions, events: ConnectEvents = {} ): Promise<Device> => { // Init values diff --git a/src/protocol/index.ts b/src/protocol/index.ts index 5283a56..9cc64fe 100644 --- a/src/protocol/index.ts +++ b/src/protocol/index.ts @@ -158,8 +158,11 @@ const encode = ( } }; +const defaultPublishEndpoint = "/usp/endpoint" +const defaultSubscribeEndpoint = "/usp/controller" + /** Connect to device */ -const connect = async (opts: mqttAsync.IClientOptions) => +const connect = async (opts: ConnectOptions) => opts.protocol?.startsWith("ws") ? mqttAsync.connectAsync( `${opts.protocol}://${opts.host}:${opts.port}`, @@ -169,14 +172,14 @@ const connect = async (opts: mqttAsync.IClientOptions) => /** Generate mqtt protocol */ const mqtt = ( - opts: mqttAsync.IClientOptions, + opts: ConnectOptions, events: ProtocolEvents ): Protocol => { let client: any = null; const init = async (): Promise<InitResult> => { - await messages.init(); + await messages.init(opts.toId, opts.fromId); client = await connect(opts); - await client.subscribe("/usp/controller/#"); + await client.subscribe(opts.subscribeEndpoint || defaultSubscribeEndpoint); client.on("message", (_topic: string, message: any) => { const msg = messages.decode(message); @@ -192,7 +195,7 @@ const mqtt = ( }; const send = ({ data }: { data: any }): void => { - client.publish("/usp/endpoint/", data); + client.publish(opts.publishEndpoint || defaultPublishEndpoint, data); }; const close = async () => client.end(); diff --git a/src/protocol/js-usp-protobuf/protoMessage.ts b/src/protocol/js-usp-protobuf/protoMessage.ts index 30020e0..e49f5bf 100644 --- a/src/protocol/js-usp-protobuf/protoMessage.ts +++ b/src/protocol/js-usp-protobuf/protoMessage.ts @@ -6,20 +6,22 @@ import { createOperateRequestMessage, } from "./usp/pbRequest"; import createMsg from "./usp/pbCreateMsg"; -import createRecord from "./usp/pbRecord"; -import rootRecordJson from "./protobuf-spec/usp-record-1-1.json" -import rootMsgJson from "./protobuf-spec/usp-msg-1-1.json" +import rootRecordJson from "./protobuf-spec/usp-record-1-1.json"; +import rootMsgJson from "./protobuf-spec/usp-msg-1-1.json"; +import makeCreateRecord from "./usp/pbRecord"; let rootRecord: protobuf.Root; let rootMsg: any; let Header: any; +let createRecord: any; /** Initialize messages */ -export const init = async () => { +export const init = async (toId: string, fromId: string) => { rootRecord = protobuf.Root.fromJSON(rootRecordJson); rootMsg = protobuf.Root.fromJSON(rootMsgJson); Header = rootMsg.lookupType("usp.Header"); + createRecord = makeCreateRecord(toId, fromId); }; /** Make get message */ diff --git a/src/protocol/js-usp-protobuf/usp/pbRecord.ts b/src/protocol/js-usp-protobuf/usp/pbRecord.ts index a323861..6aef159 100644 --- a/src/protocol/js-usp-protobuf/usp/pbRecord.ts +++ b/src/protocol/js-usp-protobuf/usp/pbRecord.ts @@ -1,4 +1,7 @@ -const createRecord = (root: protobuf.Root, bufferMsg: any) => { +const makeCreateRecord = (toId: string, fromId: string) => ( + root: protobuf.Root, + bufferMsg: any +) => { const NoSessionContextRecord = root.lookupType( "usp_record.NoSessionContextRecord" ); @@ -8,8 +11,8 @@ const createRecord = (root: protobuf.Root, bufferMsg: any) => { const record: any = root.lookupType("usp_record.Record"); const recordMsg = record.create({ version: "1.0", - toId: "proto::rx_usp_agent_mqtt", - fromId: "self::usp-controller", + toId, + fromId, PayloadSecurity: record.PayloadSecurity.PLAINTEXT, noSessionContext: noSessionContextRecordMsg, }); @@ -17,4 +20,4 @@ const createRecord = (root: protobuf.Root, bufferMsg: any) => { return buffer; }; -export default createRecord; +export default makeCreateRecord; diff --git a/src/types.d.ts b/src/types.d.ts index 4549303..bd98cca 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -1,3 +1,12 @@ +// import { IClientOptions } from "async-mqtt"; +declare type IClientOptions = import("async-mqtt").IClientOptions; +interface ConnectOptions extends IClientOptions { + toId: string; + fromId: string; + publishEndpoint?: string; + subscribeEndpoint?: string; +} + /** Stores promise resolve and reject responses */ type PromiseResult = { resolve; reject }; /** Routes messages */ diff --git a/tests/integration/config.json b/tests/integration/config.json index f7b6d93..346f211 100644 --- a/tests/integration/config.json +++ b/tests/integration/config.json @@ -2,13 +2,17 @@ "mqtt": { "host": "192.168.1.1", "username": "admin", - "password": "admin" + "password": "admin", + "fromId": "self::usp-controller", + "toId": "proto::rx_usp_agent_mqtt" }, "ws": { "host": "192.168.1.1", "username": "admin", "password": "admin", "port": 9001, - "protocol": "ws" + "protocol": "ws", + "fromId": "self::usp-controller", + "toId": "proto::rx_usp_agent_mqtt" } } -- GitLab