Class: EndDevice

Constructor

new EndDevice(applicationID, config)

The constructor function is a special function that is called when an object is created from a class.

Parameters:

Name	Type	Description
`applicationID`	string	The ID of the application you want to use.
`config`	Config	This is the configuration object that is passed to the constructor of the base class.

Source: modules/endDevice/index.js, line 13

Extends

SetConfig

Methods

createEndDeviceIS(payload) → {Output-CreateEndDeviceIS}

It creates an end device for the application.

Parameters:

Name	Type	Description
`payload`	Input-CreateEndDeviceIS	CreateEndDeviceIS

Source: modules/endDevice/index.js, line 32

Returns:

The response from the API. ----> CreateEndDeviceIS

Type:: Output-CreateEndDeviceIS

deleteEndDeviceAS(payload) → {Output-EmptyPayload}

It deletes the end device in the application server.

Parameters:

Name	Type	Description
`payload`	Input-DeleteEndDeviceAS	DeleteEndDeviceAS

Source: modules/endDevice/index.js, line 490

Returns:

The response from the API.

Type:: Output-EmptyPayload

deleteEndDeviceIS(payload) → {Output-EmptyPayload}

It deletes the end device in the identity server.

Parameters:

Name	Type	Description
`payload`	Input-DeleteEndDeviceIS	DeleteEndDeviceIS

Source: modules/endDevice/index.js, line 448

Returns:

The response from the API.

Type:: Output-EmptyPayload

deleteEndDeviceJS(payload) → {Output-EmptyPayload}

It deletes the end device in the join server.

Parameters:

Name	Type	Description
`payload`	Input-DeleteEndDeviceJS	DeleteEndDeviceJS

Source: modules/endDevice/index.js, line 462

Returns:

The response from the API.

Type:: Output-EmptyPayload

deleteEndDeviceNS(payload) → {Output-EmptyPayload}

It deletes the end device in the network server.

Parameters:

Name	Type	Description
`payload`	Input-DeleteEndDeviceNS	DeleteEndDeviceNS

Source: modules/endDevice/index.js, line 476

Returns:

The response from the API.

Type:: Output-EmptyPayload

downlinkQueue(payload)

It push or replace the downlink queue in the application server.

Parameters:

Name	Type	Description
`payload`	Input-DownlinkQueue	Input-DownlinkQueue

Source: modules/endDevice/index.js, line 515

getEndDeviceInfoAS(payload) → {Output-GetEndDeviceInfo}

It returns the end device information for the application in the Application Server.

Parameters:

Name	Type	Description
`payload`	Input-GetEndDeviceInfo	GetEndDeviceInfo

Source: modules/endDevice/index.js, line 282

Returns:

The response from the API. ----> GetEndDeviceInfo

Type:: Output-GetEndDeviceInfo

getEndDeviceInfoIS(payload) → {Output-GetEndDeviceInfo}

It returns the end device information for the application in the Identity Server.

Parameters:

Name	Type	Description
`payload`	Input-GetEndDeviceInfo	GetEndDeviceInfo

Source: modules/endDevice/index.js, line 240

Returns:

The response from the API. ----> GetEndDeviceInfo

Type:: Output-GetEndDeviceInfo

getEndDeviceInfoJS(payload) → {Output-GetEndDeviceInfo}

It returns the end device information for the application in the Join Server.

Parameters:

Name	Type	Description
`payload`	Input-GetEndDeviceInfo	GetEndDeviceInfo

Source: modules/endDevice/index.js, line 254

Returns:

The response from the API. ----> GetEndDeviceInfo

Type:: Output-GetEndDeviceInfo

getEndDeviceInfoNS(payload) → {Output-GetEndDeviceInfo}

It returns the end device information for the application in the Network Server.

Parameters:

Name	Type	Description
`payload`	Input-GetEndDeviceInfo	GetEndDeviceInfo

Source: modules/endDevice/index.js, line 268

Returns:

The response from the API. ----> GetEndDeviceInfo

Type:: Output-GetEndDeviceInfo

getEndDeviceList(payloadopt) → {Output-GetEndDeviceList}

It returns the list of end devices for the application in the Identity Server.

Parameters:

Name	Type	Attributes	Description
`payload`	Input-GetEndDeviceList	<optional>	Input-GetCollabortorList

Source: modules/endDevice/index.js, line 296

Returns:

The response from the API. ----> GetEndDeviceList

Type:: Output-GetEndDeviceList

issueDevEUI() → {Output-IssueDevEUI}

It returns DevEUIs that are available for use.

Source: modules/endDevice/index.js, line 503

Returns:

The response from the API.

Type:: Output-IssueDevEUI

setEndDeviceAS(payload) → {Output-SetEndDeviceAS}

It sets an end device for the application in the Application Server.

Parameters:

Name	Type	Description
`payload`	Input-SetEndDeviceAS	SetEndDeviceAS

Source: modules/endDevice/index.js, line 186

Returns:

The response from the API. ----> SetEndDeviceAS

Type:: Output-SetEndDeviceAS

setEndDeviceJS(payload) → {Output-SetEndDeviceJS}

It sets an end device for the application in the Join Server.

Parameters:

Name	Type	Description
`payload`	Input-SetEndDeviceJS	SetEndDeviceJS

Source: modules/endDevice/index.js, line 75

Returns:

The response from the API. ----> SetEndDeviceJS

Type:: Output-SetEndDeviceJS

setEndDeviceNS(payload) → {Output-SetEndDeviceNS}

It sets an end device for the application in the Network Server.

Parameters:

Name	Type	Description
`payload`	Input-SetEndDeviceNS	SetEndDeviceNS

Source: modules/endDevice/index.js, line 113

Returns:

The response from the API. ----> SetEndDeviceNS

Type:: Output-SetEndDeviceNS

subscribeDownLinkEvent(payload) → {Output-SubscribeDownLinkEvent}

It subscribes downlink event topic.

Parameters:

Name	Type	Description
`payload`	Input-SubscribeDownLinkEvent	Input-SubscribeDownLinkEvent

Source: modules/endDevice/index.js, line 576

Returns:

It returns client object and topic.

Type:: Output-SubscribeDownLinkEvent

subscribeUpLinkEvent(payload) → {Output-SubscribeUpLinkEvent}

It subscribes uplink event topic.

Parameters:

Name	Type	Description
`payload`	Input-SubscribeUpLinkEvent	Input-SubscribeUpLinkEvent

Source: modules/endDevice/index.js, line 622

Returns:

It returns client object and topic.

Type:: Output-SubscribeUpLinkEvent

unsubscribeEvent(payload)

It unsubscribes event topic.

Parameters:

Name	Type	Description
`payload`	mqtt_connection_object	MQTT Connection Object

Source: modules/endDevice/index.js, line 667

updateEndDevice(payload) → {Output-UpdateEndDevice}

It updates the end device information for the application.

Parameters:

Name	Type	Description
`payload`	Input-UpdateEndDevice	UpdateEndDevice

Source: modules/endDevice/index.js, line 316

Returns:

The response from the API. ----> UpdateEndDevice

Type:: Output-UpdateEndDevice