Type aliases
AddLookupCreateObject
AddLookupCreateObject: "Add.CreateObject"
AddLookupCreateParamSetting
AddLookupCreateParamSetting: "Add.CreateParamSetting"
AddRawResponse
AddRawResponse: { body: { response: { addResp: { createdObjResults: { operStatus: { operSuccess: { instantiatedPath: string; uniqueKeys: Record<string, string> } }; requestedPath: string }[] } } }; header: { msgId: string; msgType: "ADD_RESP" } }
Type declaration
-
body: { response: { addResp: { createdObjResults: { operStatus: { operSuccess: { instantiatedPath: string; uniqueKeys: Record<string, string> } }; requestedPath: string }[] } } }
-
response: { addResp: { createdObjResults: { operStatus: { operSuccess: { instantiatedPath: string; uniqueKeys: Record<string, string> } }; requestedPath: string }[] } }
-
addResp: { createdObjResults: { operStatus: { operSuccess: { instantiatedPath: string; uniqueKeys: Record<string, string> } }; requestedPath: string }[] }
-
createdObjResults: { operStatus: { operSuccess: { instantiatedPath: string; uniqueKeys: Record<string, string> } }; requestedPath: string }[]
-
header: { msgId: string; msgType: "ADD_RESP" }
-
msgId: string
-
msgType: "ADD_RESP"
AddResponse
AddResponse: string[]
BaseRecord
Base
Record: { disconnect?: string; fromId: string; noSessionContext?: { payload: string }; sessionContext?: { payload: string[] }; toId: string; version: USPVersion }
Type declaration
-
Optional disconnect?: string
-
fromId: string
-
Optional noSessionContext?: { payload: string }
-
Optional sessionContext?: { payload: string[] }
-
toId: string
-
CallArgs
CallArgs: Record<string, any>
CallFn
Type declaration
-
-
Parameters
-
-
args: Record<string, any>
-
Returns Promise<any>
CallbackOptions
CallbackOptions: { sendResp: boolean }
CertType
CertType: string | string[] | Buffer | Buffer[]
ClearFn
ClearFn: () => void
CommandTrigger
CommandTrigger: { decode: string | ((msg: Record<string, string>) => boolean); encode: string }
Type declaration
-
decode: string | ((msg: Record<string, string>) => boolean)
-
encode: string
CommandType
CommandType: "GET" | "SET" | "ADD" | "DELETE" | "OPERATE" | "NOTIFY" | "NOTIFY_RESP" | "GET_SUPPORTED_DM" | "GET_INSTANCES" | "GET_SUPPORTED_PROTO"
Connect
Type declaration
-
-
Parameters
Returns Promise<USP>
ConnectionClient
ConnectionClient: { end: () => void; on: (key: string, responseFn: (topic: string, data: any) => void) => void; publish: (endpoint: string, msg: any) => void; subscribe: (to: string) => void; unsubscribe: (from: string) => void }
Type declaration
-
end: () => void
-
on: (key: string, responseFn: (topic: string, data: any) => void) => void
-
- (key: string, responseFn: (topic: string, data: any) => void): void
-
Parameters
-
key: string
-
responseFn: (topic: string, data: any) => void
-
- (topic: string, data: any): void
Returns void
-
publish: (endpoint: string, msg: any) => void
-
- (endpoint: string, msg: any): void
-
Parameters
-
endpoint: string
-
msg: any
Returns void
-
subscribe: (to: string) => void
-
unsubscribe: (from: string) => void
DecodeIDFn
DecodeIDFn: (data: any) => string
Type declaration
-
-
Parameters
Returns string
DecodeOptions
DecodeOptions: { raw?: boolean; retainPath?: boolean }
Type declaration
-
Optional raw?: boolean
-
Optional retainPath?: boolean
DelCommand
DelCommand: (path: string | string[], allowPartial?: boolean) => Promise<string[]>
Type declaration
-
- (path: string | string[], allowPartial?: boolean): Promise<string[]>
-
Parameters
-
path: string | string[]
-
Optional allowPartial: boolean
Returns Promise<string[]>
EncodeArgs
EncodeArgs: { args: Record<string, any>; header: any; options: Record<string, string>; rootMsg: any; rootRecord: any }
Type declaration
-
args: Record<string, any>
-
header: any
-
options: Record<string, string>
-
rootMsg: any
-
rootRecord: any
EncodeFn
Type declaration
-
-
Parameters
-
args: Record<string, any>
GetCommandGeneralOptions
GetCommandGeneralOptions: { max_depth?: number }
Type declaration
-
Optional max_depth?: number
GetReturn
GetReturn: string | Record<string, any> | Record<string, any>[]
HostConnectionOptions
Host
ConnectionOptions: { host: string; hostname?: string; path?: string; port: number; protocol: "wss" | "ws" | "mqtt" | "mqtts" | "tcp" | "ssl" | "wx" | "wxs" } & MainConnectionOptions
InputRecord
InputRecord: {} & { allowPartial?: boolean }
InstancesCommand
InstancesCommand: (paths: string | string[], opts?: { firstLevelOnly?: boolean }) => Promise<Record<string, any>>
Type declaration
-
- (paths: string | string[], opts?: { firstLevelOnly?: boolean }): Promise<Record<string, any>>
-
Parameters
-
paths: string | string[]
-
Optional opts: { firstLevelOnly?: boolean }
-
Optional firstLevelOnly?: boolean
Returns Promise<Record<string, any>>
JSValue
JSValue: string | number | boolean
LoadProtobufFn
Type declaration
-
-
Parameters
Returns Promise<Proto>
MqttOptions
MqttOptions: { reconnectPeriod?: number }
Type declaration
-
Optional reconnectPeriod?: number
OnCallback
Type declaration
-
-
Parameters
-
-
Optional fullMsg: Record<string, any>
-
Returns void
OnIdent
OnIdent: string | RegExp
OperateClearFn
OperateClearFn: () => Promise<void>
OperateCommand
OperateCommand: (path: string, id: string, resp: boolean, input?: Record<string, any>) => Promise<any>
Type declaration
-
- (path: string, id: string, resp: boolean, input?: Record<string, any>): Promise<any>
-
Parameters
-
path: string
-
id: string
-
resp: boolean
-
Optional input: Record<string, any>
Returns Promise<any>
OperateFn
Operate
Fn: { subscribe: (cb: (msg: any) => void, opts?: OperateSubscribeOptions) => { trigger: (input?: Record<string, any>) => Promise<any> } }
Type declaration
-
- (input?: Record<string, string>): Promise<any>
-
Parameters
-
Optional input: Record<string, string>
Returns Promise<any>
-
subscribe: (cb: (msg: any) => void, opts?: OperateSubscribeOptions) => { trigger: (input?: Record<string, any>) => Promise<any> }
-
- (cb: (msg: any) => void, opts?: OperateSubscribeOptions): { trigger: (input?: Record<string, any>) => Promise<any> }
-
Parameters
Returns { trigger: (input?: Record<string, any>) => Promise<any> }
-
trigger: (input?: Record<string, any>) => Promise<any>
-
- (input?: Record<string, any>): Promise<any>
-
Parameters
-
Optional input: Record<string, any>
Returns Promise<any>
OperateSubscribeOptions
OperateSubscribeOptions: { skipOperateResponse?: boolean }
Type declaration
-
Optional skipOperateResponse?: boolean
Options
Type declaration
-
Optional get?: { max_depth?: number; retainPath?: boolean }
-
Optional max_depth?: number
-
Optional retainPath?: boolean
-
-
-
Optional timeout?: number
PbRequestCommandDel
PbRequestCommandDel: { delete: { allowPartial: boolean; objPaths: string[] } }
Type declaration
-
delete: { allowPartial: boolean; objPaths: string[] }
-
allowPartial: boolean
-
objPaths: string[]
PbRequestCommandGet
PbRequestCommandGet: { get: { paramPaths: string[] } }
Type declaration
-
get: { paramPaths: string[] }
PbRequestCommandInstance
PbRequestCommandInstance: { getInstances: { firstLevelOnly: boolean; objPaths: string[] } }
Type declaration
-
getInstances: { firstLevelOnly: boolean; objPaths: string[] }
-
firstLevelOnly: boolean
-
objPaths: string[]
PbRequestCommandNotify
PbRequestCommandNotify: { notify: { sendResp: boolean; subscriptionId: string } }
Type declaration
-
notify: { sendResp: boolean; subscriptionId: string }
-
[key: string]: unknown
-
sendResp: boolean
-
subscriptionId: string
PbRequestCommandNotifyResp
PbRequestCommandNotifyResp: { notifyResp: { subscriptionId: string } }
Type declaration
-
notifyResp: { subscriptionId: string }
PbRequestCommandOperate
PbRequestCommandOperate: { operate: { command: string; commandKey: string; inputArgs: Record<string, any>; sendResp: boolean } }
Type declaration
-
operate: { command: string; commandKey: string; inputArgs: Record<string, any>; sendResp: boolean }
-
command: string
-
commandKey: string
-
inputArgs: Record<string, any>
-
sendResp: boolean
PbRequestCommandSupport
PbRequestCommandSupport: { getSupportedDm: { firstLevelOnly: boolean; objPaths: string[]; returnCommands: boolean; returnEvents: boolean; returnParams: boolean } }
Type declaration
-
getSupportedDm: { firstLevelOnly: boolean; objPaths: string[]; returnCommands: boolean; returnEvents: boolean; returnParams: boolean }
-
firstLevelOnly: boolean
-
objPaths: string[]
-
returnCommands: boolean
-
returnEvents: boolean
-
returnParams: boolean
PbRequestCommandSupportProto
PbRequestCommandSupportProto: { getSupportedProtocol: { controllerSupportedProtocolVersions: string } }
Type declaration
-
getSupportedProtocol: { controllerSupportedProtocolVersions: string }
-
controllerSupportedProtocolVersions: string
PostCallCallback
PostCallCallback: (name: string, args: any[], result: any) => void
Type declaration
-
- (name: string, args: any[], result: any): void
-
Parameters
-
name: string
-
args: any[]
-
result: any
Returns void
PreCallCallback
PreCallCallback: (name: string, args: any[]) => void
Type declaration
-
- (name: string, args: any[]): void
PromiseClearFn
PromiseClearFn: () => Promise<void>
Proto
Proto: { header: any; rootMsg: any; rootRecord: any }
Type declaration
-
header: any
-
rootMsg: any
-
rootRecord: any
Response
Response: string | Record<string, any>
ResponseID
ResponseID: "ignore" | "error" | string
SessionInitMsg
Session
InitMsg: { fromId: string; sessionContext: { expectedId: string; sequenceId: string; sessionId: string }; toId: string; version: USPVersion }
Type declaration
-
fromId: string
-
sessionContext: { expectedId: string; sequenceId: string; sessionId: string }
-
expectedId: string
-
sequenceId: string
-
sessionId: string
-
toId: string
-
SetCommandOptions
SetCommandOptions: { raw?: boolean }
SetLookupUpdateObject
SetLookupUpdateObject: "Set.UpdateObject"
SetLookupUpdateParamSetting
SetLookupUpdateParamSetting: "Set.UpdateParamSetting"
SetRawResponse
SetRawResponse: { body: { response: { setResp: { updatedObjResults: { operStatus: { operSuccess: { updatedInstResults: [{ affectedPath: string; updatedParams: Record<string, string> }] } }; requestedPath: string }[] } } }; header: { msgId: string; msgType: "SET_RESP" } }
Type declaration
-
body: { response: { setResp: { updatedObjResults: { operStatus: { operSuccess: { updatedInstResults: [{ affectedPath: string; updatedParams: Record<string, string> }] } }; requestedPath: string }[] } } }
-
response: { setResp: { updatedObjResults: { operStatus: { operSuccess: { updatedInstResults: [{ affectedPath: string; updatedParams: Record<string, string> }] } }; requestedPath: string }[] } }
-
setResp: { updatedObjResults: { operStatus: { operSuccess: { updatedInstResults: [{ affectedPath: string; updatedParams: Record<string, string> }] } }; requestedPath: string }[] }
-
updatedObjResults: { operStatus: { operSuccess: { updatedInstResults: [{ affectedPath: string; updatedParams: Record<string, string> }] } }; requestedPath: string }[]
-
header: { msgId: string; msgType: "SET_RESP" }
-
msgId: string
-
msgType: "SET_RESP"
SetResponse
SetResponse: { affectedPath: string; updatedParams: Record<string, string> }[]
SubscriptionCallback
Subscription
Callback: (msg: Response, fullMsg?: Record<string, any>) => void
Type declaration
-
- (msg: Response, fullMsg?: Record<string, any>): void
-
Parameters
-
-
Optional fullMsg: Record<string, any>
Returns void
SupportedDMCommand
SupportedDMCommand
: (paths
: string | string[], opts
?: SuportedCommandOpts) => Promise<Record<string, any>>
Type declaration
-
-
Parameters
Returns Promise<Record<string, any>>
SupportedProtoCommand
Supported
ProtoCommand: (version?: USPVersion) => Promise<string[]>
Type declaration
-
-
Parameters
Returns Promise<string[]>
USPSession
USPSession: { expectedId?: number; payloadSarState?: 0 | 1 | 2 | 3; payloadrecSarState?: 0 | 1 | 2 | 3; retransmitId?: number; sequenceId: number; sessionId: number }
Type declaration
-
Optional expectedId?: number
-
Optional payloadSarState?: 0 | 1 | 2 | 3
-
Optional payloadrecSarState?: 0 | 1 | 2 | 3
-
Optional retransmitId?: number
-
sequenceId: number
-
sessionId: number
UspObject
UspObject: { __query__: string; result: { __query__: string } }
Type declaration
-
__query__: string
-
result: { __query__: string }
-
[key: string]: ReturnValue
-
__query__: string
UspObjectList
UspObjectList: { __query__: string; result: { __query__: string }[] }
Type declaration
-
__query__: string
-
result: { __query__: string }[]
UspProperty
UspProperty: { __query__: string; result: string }
Type declaration
-
__query__: string
-
result: string
UspPropertyList
UspPropertyList: { __query__: string; result: { __query__: string; result: string }[] }
Type declaration
-
__query__: string
-
result: { __query__: string; result: string }[]
VerifierFunc
Type declaration
-
-
Parameters
-
args: Record<string, any>
Connect to device
Connection options
Optional event handlers
A set of functions for interacting with the device