JSDoc: Global

Members

(readonly) CtrlOp :string

Control message operations.

Type:

string

Source:

mq/constants.js, line 4

(readonly) Errors :string

Errors.

Type:

string

Source:

mq/constants.js, line 19

(readonly) MgrStatus :Symbol

ApplicationMgr/NetworkMgr status.

Type:

Symbol

Source:

mq/constants.js, line 31

Methods

authMiddleware(authUri) → {function}

Generate the Express authentication middleware.

Parameters:

Name	Type	Description
`authUri`	string	The authentication endpoint. For example `http://localhost:1080/auth/api/v1/auth/tokeninfo`.

Source:

middlewares/auth.js, line 28

Returns:

The Express middleware.

Type: function

get(client, callback)

`GET /coremgr/api/v1/user`.

Parameters:

Name Type Description

client Client

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>
`data`	GetResData

Source:

api/user.js, line 35

Throws:

Wrong arguments.
Type Error

update(client, data, callback)

`PATCH /coremgr/api/v1/user`

Parameters:

Name Type Description

client Client

data PatchReqData

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

api/user.js, line 67

Throws:

Wrong arguments.
Type Error

Type Definitions

AppDlData

Downlink data from application to broker.

Type:

Object

Properties:

Name	Type	Attributes
`correlationId`	string
`deviceId`	string	<optional>
`networkCode`	string	<optional>
`networkAddr`	string	<optional>
`data`	Buffer
`extension`	Object	<optional>

Source:

mq/application.js, line 37

AppDlDataResp

Downlink data response for `AppDlData`.

Type:

Object

Properties:

Name	Type	Attributes
`correlationId`	string
`dataId`	string	<optional>
`error`	string	<optional>
`message`	string	<optional>

Source:

mq/application.js, line 49

AppDlDataResult

Downlink data result when processing or completing data transfer to the device.

Type:

Object

Properties:

Name	Type	Attributes
`dataId`	string
`status`	number
`message`	string	<optional>

Source:

mq/application.js, line 59

AppMgrMsgHandlers

Type:

Object

Properties:

Name	Type	Description
`onUlData`	OnAppUlData
`onDlDataResp`	OnAppDlDataResp
`onDlDataResult`	OnAppDlDataResult

Source:

mq/application.js, line 75

AppUlData

Uplink data from broker to application.

Type:

Object

Properties:

Name	Type	Attributes
`dataId`	string
`time`	Date
`pub`	Date
`deviceId`	string
`networkId`	string
`networkCode`	string
`networkAddr`	string
`isPublic`	boolean
`data`	Buffer
`extension`	Object	<optional>

Source:

mq/application.js, line 21

ClientOptions

Options of the HTTP client `Client` that contains OAuth2 information.

Type:

Object

Properties:

Name	Type	Description
`authBase`	string	`sylvia-iot-auth` base path with scheme. For example `http://localhost:1080/auth`.
`coremgrBase`	string	`sylvia-iot-coremgr` base path with scheme. For example `http://localhost:1080/coremgr`.
`clientId`	string	Client ID.
`clientSecret`	string	Client secret.

Source:

api/http.js, line 11

CtrlAddDevice

Type:

Object

Properties:

Name	Type	Description
`networkAddr`	string

Source:

mq/lib.js, line 40

CtrlAddDeviceBulk

Type:

Object

Properties:

Name	Type	Description
`networkAddrs`	Array.<string>

Source:

mq/lib.js, line 45

CtrlAddDeviceRange

Type:

Object

Properties:

Name	Type	Description
`startAddr`	string
`endAddr`	string

Source:

mq/lib.js, line 50

CtrlDelDevice

Type:

Object

Properties:

Name	Type	Description
`networkAddr`	string

Source:

mq/lib.js, line 56

CtrlDelDeviceBulk

Type:

Object

Properties:

Name	Type	Description
`networkAddrs`	Array.<string>

Source:

mq/lib.js, line 61

CtrlDelDeviceRange

Type:

Object

Properties:

Name	Type	Description
`startAddr`	string
`endAddr`	string

Source:

mq/lib.js, line 66

DataMqStatus

Detail queue connection status.

Type:

Object

Properties:

Name	Type	Description
`uldata`	Status
`dldata`	Status
`dldataResp`	Status
`dldataResult`	Status
`ctrl`	Status

Source:

mq/lib.js, line 14

FullTokenInfo

Type:

Object

Properties:

Name Type Description

token string The access token.

info

Object

Properties

Name	Type	Description
`userId`	string
`account`	string
`roles`	Object	pairs.
`name`	string
`clientId`	string
`scopes`	Array.<string>

Source:

middlewares/auth.js, line 9

GetResData

Type:

Object

Properties:

Name	Type	Attributes	Description
`userId`	string	<optional>
`account`	string
`createdAt`	Date
`modifiedAt`	Date
`verifiedAt`	Date	<optional>
`roles`	Object		pairs.
`name`	string
`info`	Object

Source:

api/user.js, line 7

NetCtrlMsg

Network control message from broker to network.

Type:

Object

Properties:

Name	Type	Description
`operation`	string
`time`	Date
`new`	CtrlAddDevice \| CtrlAddDeviceBulk \| CtrlAddDeviceRange \| CtrlDelDevice \| CtrlDelDeviceBulk \| CtrlDelDeviceRange

Source:

mq/network.js, line 58

NetDlData

Downlink data from broker to network.

Type:

Object

Properties:

Name	Type	Attributes
`dataId`	string
`pub`	Date
`expiresIn`	number
`networkAddr`	string
`data`	Buffer
`extension`	Object	<optional>

Source:

mq/network.js, line 37

NetDlDataResult

Downlink data result when processing or completing data transfer to the device.

Type:

Object

Properties:

Name	Type	Attributes
`dataId`	string
`status`	number
`message`	string	<optional>

Source:

mq/network.js, line 49

NetMgrMsgHandlers

Type:

Object

Properties:

Name	Type	Description
`onDlData`	OnNetDlData
`onCtrl`	OnNetCtrl

Source:

mq/network.js, line 74

NetUlData

Uplink data from network to broker.

Type:

Object

Properties:

Name	Type	Attributes
`time`	Date
`networkAddr`	string
`data`	Buffer
`extension`	Object	<optional>

Source:

mq/network.js, line 27

OnAppDlDataResp(mgr, data, callback)

Parameters:

Name Type Description

mgr ApplicationMgr

data AppDlDataResp

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>	Use error to NACK the message.

Source:

mq/application.js, line 90

OnAppDlDataResult(mgr, data, callback)

Parameters:

Name Type Description

mgr ApplicationMgr

data AppDlDataResult

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>	Use error to NACK the message.

Source:

mq/application.js, line 98

OnAppUlData(mgr, data, callback)

Parameters:

Name Type Description

mgr ApplicationMgr

data AppUlData

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>	Use error to NACK the message.

Source:

mq/application.js, line 82

OnNetCtrl(mgr, data, callback)

Parameters:

Name Type Description

mgr NetworkMgr

data NetCtrlMsg

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>	Use error to NACK the message.

Source:

mq/network.js, line 88

OnNetDlData(mgr, data, callback)

Parameters:

Name Type Description

mgr NetworkMgr

data NetDlData

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>	Use error to NACK the message.

Source:

mq/network.js, line 80

Options

The options of the application/network manager.

Type:

Object

Properties:

Name	Type	Attributes	Default	Description
`unitId`	string	<optional>		The associated unit ID of the application/network. Empty or undefined for public network.
`unitCode`	string	<optional>		The associated unit code of the application/network. Empty or undefined for public network.
`id`	string			The associated application/network ID.
`name`	string			The associated application/network code.
`prefetch`	number	<optional>	100	AMQP prefetch option.
`persistent`	boolean	<optional>	false	AMQP persistent option.
`sharedPrefix`	string	<optional>		MQTT shared queue prefix option.

Source:

mq/lib.js, line 25

PatchReqData

Type:

Object

Properties:

Name	Type	Attributes
`password`	string	<optional>
`name`	string	<optional>
`info`	Object	<optional>

Source:

api/user.js, line 19