NetworkAssets

This article explains how Network Assets are separated into distinct groups by Conductor. Conductor identifies groups of modules and groups of gateways using a token scheme. The system relies on two types of tokens: Application Tokens and Network Tokens. Further separation of Nodes can be achieved using AssetGroups. These concepts are discussed in this section.

Modules

A module is associated with one Application Token, which is assigned to it by its user. Users can generate Application Tokens within their Conductor accounts by using the Conductor UI. Application Tokens can also be generated via the REST API by users with proper granted authorities.

Before a module can communicate with a Conductor account, it must register with the account by informing Conductor of its Application Token. This registration process only needs to occur at the beginning of the module’s life, but may occur as frequently as desired. Registration of the module is executed by transmitting the Application Token over the air using the ll_config_set function of the ll_ifc_symphony library. For more information, refer to the applicable Symphony Link Module user guide.

Gateways

Every gateway is registered to one Conductor account and is associated with one Network Token.  Initial registration of a gateway is completed locally at the Gateway Admin Webpage (the gateway’s local webpage), which is pictured below. Once a gateway is registered to an account, a user with proper granted authorities may change the Network Token associated with the gateway using the Conductor UI.

For more information regarding initial registration of a gateway, refer to the applicable Symphony Link Gateway user guide.

Application Tokens

An Application Token is an 80-bit unique identifier, used to identify a class of modules. Application Tokens provide users a method to segregate data-flows logically. The intent is for all modules doing the same type of job -- for example, reporting water flow-rate data -- to use the same Application Token.

Application Tokens are generated by users within a Conductor account.  Navigate to the Application tab on the left ribbon then click the "Add Application" button in the upper right hand corner. Modules use the Application Token to register with the account (see the Modules section, above).

Network Tokens

A Network Token is a 32-bit unique identifier, used to separate distinct Symphony Link networks. With the exception of the OPEN Network Token (which is the default assigned to all factory-fresh gateways and modules), Network Tokens are generated within a Conductor account using the Conductor UI.

All modules and gateways advertize a Network Token. A module and a gateway can communicate only if they both advertize the same Network Token. The one exception to this rule is that any module can communicate with a gateway that advertizes the OPEN Network Token.

The Network Token assigned to a gateway can be changed using the Conductor UI or by using the Client Edge API. The Network Token assigned to a module is changed by using the ll_config_set function of the ll_ifc_symphony library. For more information, refer to the applicable Symphony Link Module user guide.

To create an Network Token using the Conductor UI

Navigate to the Network tab on the left ribbon then click the "Add Network" button in the upper right hand corner. Add a Network name and select the devices that belong to this AssetGroup.

AssetGroups

An AssetGroup is a logical grouping of Network Assets. AssetGroups provide a method to separate data-flows beyond the capabilities afforded by Network and Application Tokens.

Consider the following example. An account-holder owns 10 modules, which are all being used to report water flow-rate data. He therefore assigns the same “flow meter” Application Token to all 10 modules. However, 5 of the modules are physically located at one facility (call it Facility A) and the remainder are located at another (Facility B). He might therefore want to place the Facility A modules in one AssetGroup and the Facility B modules in another, to separate the two data flows, even though all 10 modules share the same Application Token.

To create an AssetGroup using the Conductor UI

Navigate to the Asset tab on the left ribbon then click the "Add AssetGroup" button in the upper right corner. Add an AssetGroup name and select the devices that belong to this AssetGroup.

To create an AssetGroup using the Conductor API

POST <NetworkAssetBase>/assetGroups
body application/json:
{
  "account": {
    "desc": "",
    "href": "SecurityAccessBase/account/{}accountId}"
  },
  "assetGroupName": "FriendlyName}"
}

To query the AssetGroups owned by an Account

GET <NetworkAssetBase>/assetGroups?accountid={accountId}

To add/remove a Node to/from an AssetGroup

PATCH/DELETE <NetworkAssetBase>/assetGroup/{assetGroupId}/nodes
body application/json:
{
  "href": "<NetworkAssetBase>/module/{module_nodeAddress}",
  "desc": ""
}

To query all members of an AssetGroup

GET <NetworkAssetBase>/assetGroup/{assetGroupId}

0 Comments

Add your comment

E-Mail me when someone replies to this comment