KiiGatewayAgent

KiiGatewayAgent

new KiiGatewayAgent()

Source:

KiiGatewayAgent

Methods

activateEndnodeOnlineDetecting(active)

Source:

activate endnode connectivity detecting

Parameters:
Name Type Description
active boolean

getEndnode(endNodeVendorThingID) → {promise}

Source:

retrieve endnode onboarding status

Parameters:
Name Type Description
endNodeVendorThingID string
Returns:
Type
promise

isGatewayOnboarding() → {boolean}

Source:

return if the gateway is onboarding or not (by gateway thingID)

Returns:
Type
boolean

loadGatewaySetting() → {Promise}

Source:

load gateway setting from db.json

Returns:
Type
Promise

onboardEndnodeByOwner(endNodeVendorThingID, propertiesopt) → {promise}

Source:

onboard endnode with gateway by owner

Parameters:
Name Type Attributes Description
endNodeVendorThingID string
properties any <optional>
Returns:
Type
promise

onboardGatewayByOwner(propertiesopt) → {promise}

Source:

onboard gateway by owner

Parameters:
Name Type Attributes Description
properties any <optional>

properties
Returns:
Type
promise

setApp(_appID, _appKey, _site)

Source:

set app info

Parameters:
Name Type Description
_appID string

appID
_appKey string

appKey
_site string

site

setTemporaryApp(_appID, _appKey, _site)

Source:

set app info without overwriting the configuration

Parameters:
Name Type Description
_appID string

appID
_appKey string

appKey
_site string

site

setTemporaryUser(ownerToken, userID)

Source:

set user without overwriting the configuration

Parameters:
Name Type Description
ownerToken string

ownerToken
userID string

userID

setUser(ownerToken, userID)

Source:

set user info

Parameters:
Name Type Description
ownerToken string

ownerToken
userID string

userID

updateEndnodeConnectivityByVendorThingID(endNodeVendorThingID, online) → {promise}

Source:

update endnode connectivity by vendorThingID

Parameters:
Name Type Description
endNodeVendorThingID string
online boolean
Returns:
Type
promise

updateEndnodeOnline() → {EndNode}

Source:

update endnode connectivity

Returns:
Type
EndNode

updateEndnodeState(endNodeVendorThingID, statesopt) → {promise}

Source:

update endnode state

Parameters:
Name Type Attributes Description
endNodeVendorThingID string
states any <optional>
Returns:
Type
promise