SmartMeshSDK
 All Classes Namespaces Functions Variables Groups
SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector Class Reference

Public class for the HART Manager connector using the XML API. More...

+ Inheritance diagram for SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector:

Public Member Functions

def dn_activateAdvertising
 Activate advertisement frame. More...
 
def dn_activateFastPipe
 Activate the fast network pipe to the specified mote. More...
 
def dn_cancelOtap
 This command cancels the OTAP (Over-The-Air-Programming) process to upgrade software on motes and the access point. More...
 
def dn_cli
 This command tunnels a given command through to the manager's Command Line Interface (CLI). More...
 
def dn_deactivateFastPipe
 Deactivate the fast network pipe to the specified mote. More...
 
def dn_deleteAcl
 Remove a device from the ACL. More...
 
def dn_deleteMote
 Remove a mote from the manager configuration. More...
 
def dn_deleteUser
 Remove a user. More...
 
def dn_exchangeJoinKey
 Exchange the common join key. More...
 
def dn_exchangeMoteJoinKey
 Exchange a mote's join key. More...
 
def dn_exchangeMoteNetworkId
 Exchange the network ID for a mote. More...
 
def dn_exchangeNetworkKey
 Exchange the network key. More...
 
def dn_exchangeNetworkId
 Exchange the network ID. More...
 
def dn_exchangeSessionKey
 Exchange a mote's session key. More...
 
def dn_decommissionDevice
 Decommission a device in the network. More...
 
def dn_getAcl
 Check whether a device is part of the ACL. More...
 
def dn_getAcls
 Get the list of devices on the ACL. More...
 
def dn_getBlacklist
 Get the channel blacklist. More...
 
def dn_getMote
 
def dn_setMote
 Set mote configuration. More...
 
def dn_getMotes
 Get the list of Motes. More...
 
def dn_getMoteStatistics
 Get the Mote Statistics. More...
 
def dn_getNetwork
 Retrieves network configuration parameters. More...
 
def dn_getNetworkStatistics
 Get the Network Statistics. More...
 
def dn_getOpenAlarms
 Retrieves a list of the open alarms on the Manager. More...
 
def dn_getPaths
 Get the list of Paths to the mote's neighbors. More...
 
def dn_getPathStatistics
 Get Statistics for a specific Path. More...
 
def dn_getRedundancy
 Get the redundancy state. More...
 
def dn_getSecurity
 Get the Security configuration. More...
 
def dn_getSla
 Get the Service Level Agreement (SLA) configuration. More...
 
def dn_getSystem
 Retrieves system-level information. More...
 
def dn_getUser
 Get the description of a user. More...
 
def dn_getUsers
 Get the list of users. More...
 
def dn_getSourceRoute
 Get the Source Route for a specific Mote. More...
 
def dn_getLatency
 Get estimated latency for a mote. More...
 
def dn_getLicense
 Get the software license key. More...
 
def dn_getTime
 Get the current time. More...
 
def dn_pingMote
 Ping the specified mote. More...
 
def dn_promoteToOperational
 Promote a quarantined device to operational. More...
 
def dn_reset
 Reset the system or network. More...
 
def dn_resetWithId
 Reset mote by ID. More...
 
def dn_resetWithMac
 Reset mote by MAC address. More...
 
def dn_sendRequest
 Send downstream (request) data. More...
 
def dn_sendResponse
 Send downstream data as a response. More...
 
def dn_setAcl
 Add or update a device in the ACL. More...
 
def dn_setBlacklist
 Update the channel blacklist. More...
 
def dn_setNetwork
 Set network configuration. More...
 
def dn_setSecurity
 Set security configuration. More...
 
def dn_setSla
 Set SLA configuration. More...
 
def dn_setSystem
 Set system-level configuration. More...
 
def dn_setUser
 Add or update user configuration. More...
 
def dn_setLicense
 Set the software license key. More...
 
def dn_startOtap
 This command initiates the OTAP (Over-The-Air-Programming) process to upgrade software on motes and the Access Point. More...
 
def dn_startOtapWithRetries
 This command initiates the OTAP (Over-The-Air-Programming) process to upgrade software for motes and the Access Point, using the specified number of retries. More...
 
def dn_subscribe
 Subscribe to notifications. More...
 
def dn_unsubscribe
 Unsubscribe from notifications. More...
 
def getNotification
 Get a notification from the notification queue, and returns it properly formatted. More...
 

Static Public Attributes

tuple Tuple_dn_activateAdvertising = collections.namedtuple("Tuple_dn_activateAdvertising", ['result'])
 The named tuple returned by the dn_activateAdvertising() function. More...
 
tuple Tuple_dn_activateFastPipe = collections.namedtuple("Tuple_dn_activateFastPipe", ['result'])
 The named tuple returned by the dn_activateFastPipe() function. More...
 
tuple Tuple_dn_cancelOtap = collections.namedtuple("Tuple_dn_cancelOtap", ['result'])
 The named tuple returned by the dn_cancelOtap() function. More...
 
tuple Tuple_dn_cli = collections.namedtuple("Tuple_dn_cli", ['result'])
 The named tuple returned by the dn_cli() function. More...
 
tuple Tuple_dn_deactivateFastPipe = collections.namedtuple("Tuple_dn_deactivateFastPipe", ['result'])
 The named tuple returned by the dn_deactivateFastPipe() function. More...
 
tuple Tuple_dn_exchangeJoinKey = collections.namedtuple("Tuple_dn_exchangeJoinKey", ['callbackId'])
 The named tuple returned by the dn_exchangeJoinKey() function. More...
 
tuple Tuple_dn_exchangeMoteJoinKey = collections.namedtuple("Tuple_dn_exchangeMoteJoinKey", ['callbackId'])
 The named tuple returned by the dn_exchangeMoteJoinKey() function. More...
 
tuple Tuple_dn_exchangeMoteNetworkId = collections.namedtuple("Tuple_dn_exchangeMoteNetworkId", ['callbackId'])
 The named tuple returned by the dn_exchangeMoteNetworkId() function. More...
 
tuple Tuple_dn_exchangeNetworkKey = collections.namedtuple("Tuple_dn_exchangeNetworkKey", ['callbackId'])
 The named tuple returned by the dn_exchangeNetworkKey() function. More...
 
tuple Tuple_dn_exchangeNetworkId = collections.namedtuple("Tuple_dn_exchangeNetworkId", ['callbackId'])
 The named tuple returned by the dn_exchangeNetworkId() function. More...
 
tuple Tuple_dn_exchangeSessionKey = collections.namedtuple("Tuple_dn_exchangeSessionKey", ['callbackId'])
 The named tuple returned by the dn_exchangeSessionKey() function. More...
 
tuple Tuple_dn_decommissionDevice = collections.namedtuple("Tuple_dn_decommissionDevice", ['result'])
 The named tuple returned by the dn_decommissionDevice() function. More...
 
tuple Tuple_dn_getAcl = collections.namedtuple("Tuple_dn_getAcl", ['macAddr'])
 The named tuple returned by the dn_getAcl() function. More...
 
tuple Tuple_dn_getAcls = collections.namedtuple("Tuple_dn_getAcls", ['macAddr'])
 The named tuple returned by the dn_getAcls() function. More...
 
tuple Tuple_dn_getBlacklist = collections.namedtuple("Tuple_dn_getBlacklist", ['frequency'])
 The named tuple returned by the dn_getBlacklist() function. More...
 
tuple Tuple_dn_getMote = collections.namedtuple("Tuple_dn_getMote", ['moteId', 'macAddr', 'name', 'state', 'numJoins', 'joinTime', 'reason', 'isAccessPoint', 'powerSource', 'dischargeCurrent', 'dischargeTime', 'recoveryTime', 'enableRouting', 'productName', 'hwModel', 'hwRev', 'swRev', 'voltage', 'numNeighbors', 'needNeighbor', 'goodNeighbors', 'allocatedPkPeriod', 'allocatedPipePkPeriod', 'pipeStatus', 'advertisingStatus', 'locationTag'])
 The named tuple returned by the dn_getMote() function. More...
 
tuple Tuple_dn_setMote = collections.namedtuple("Tuple_dn_setMote", ['moteId', 'macAddr', 'name', 'state', 'numJoins', 'joinTime', 'reason', 'isAccessPoint', 'powerSource', 'dischargeCurrent', 'dischargeTime', 'recoveryTime', 'enableRouting', 'productName', 'hwModel', 'hwRev', 'swRev', 'voltage', 'numNeighbors', 'needNeighbor', 'goodNeighbors', 'allocatedPkPeriod', 'allocatedPipePkPeriod', 'pipeStatus', 'advertisingStatus', 'locationTag'])
 The named tuple returned by the dn_setMote() function. More...
 
tuple Tuple_dn_getMotes = collections.namedtuple("Tuple_dn_getMotes", ['moteId', 'macAddr', 'name', 'state', 'numJoins', 'joinTime', 'reason', 'isAccessPoint', 'powerSource', 'dischargeCurrent', 'dischargeTime', 'recoveryTime', 'enableRouting', 'productName', 'hwModel', 'hwRev', 'swRev', 'voltage', 'numNeighbors', 'needNeighbor', 'goodNeighbors', 'allocatedPkPeriod', 'allocatedPipePkPeriod', 'pipeStatus', 'advertisingStatus', 'locationTag'])
 The named tuple returned by the dn_getMotes() function. More...
 
tuple Tuple_dn_getMoteStatistics = collections.namedtuple("Tuple_dn_getMoteStatistics", ['index', 'startTime', 'avgLatency', 'reliability', 'numJoins', 'voltage', 'chargeConsumption', 'temperature', 'numLostPackets', 'latencyToMote'])
 The named tuple returned by the dn_getMoteStatistics() function. More...
 
tuple Tuple_dn_getNetwork = collections.namedtuple("Tuple_dn_getNetwork", ['netName', 'networkId', 'maxMotes', 'numMotes', 'optimizationEnable', 'accessPointPA', 'ccaEnabled', 'requestedBasePkPeriod', 'minServicesPkPeriod', 'minPipePkPeriod', 'bandwidthProfile', 'manualUSFrameSize', 'manualDSFrameSize', 'manualAdvFrameSize', 'netQueueSize', 'userQueueSize', 'locationMode', 'backboneEnabled', 'backboneSize'])
 The named tuple returned by the dn_getNetwork() function. More...
 
tuple Tuple_dn_getNetworkStatistics = collections.namedtuple("Tuple_dn_getNetworkStatistics", ['index', 'startTime', 'netLatency', 'netReliability', 'netPathStability', 'lostUpstreamPackets'])
 The named tuple returned by the dn_getNetworkStatistics() function. More...
 
tuple Tuple_dn_getOpenAlarms = collections.namedtuple("Tuple_dn_getOpenAlarms", ['timeStamp', 'eventId', 'alarmType', 'macAddr'])
 The named tuple returned by the dn_getOpenAlarms() function. More...
 
tuple Tuple_dn_getPaths = collections.namedtuple("Tuple_dn_getPaths", ['pathId', 'moteAMac', 'moteBMac', 'numLinks', 'pathDirection', 'pathQuality'])
 The named tuple returned by the dn_getPaths() function. More...
 
tuple Tuple_dn_getPathStatistics = collections.namedtuple("Tuple_dn_getPathStatistics", ['index', 'startTime', 'baPwr', 'abPwr', 'stability'])
 The named tuple returned by the dn_getPathStatistics() function. More...
 
tuple Tuple_dn_getRedundancy = collections.namedtuple("Tuple_dn_getRedundancy", ['localMode', 'peerStatus', 'peerControllerSwRev'])
 The named tuple returned by the dn_getRedundancy() function. More...
 
tuple Tuple_dn_getSecurity = collections.namedtuple("Tuple_dn_getSecurity", ['securityMode', 'acceptHARTDevicesOnly'])
 The named tuple returned by the dn_getSecurity() function. More...
 
tuple Tuple_dn_getSla = collections.namedtuple("Tuple_dn_getSla", ['minNetReliability', 'maxNetLatency', 'minNetPathStability', 'apRdntCoverageThreshold'])
 The named tuple returned by the dn_getSla() function. More...
 
tuple Tuple_dn_getSystem = collections.namedtuple("Tuple_dn_getSystem", ['systemName', 'location', 'swRev', 'hwModel', 'hwRev', 'serialNumber', 'time', 'startTime', 'cliTimeout', 'controllerSwRev'])
 The named tuple returned by the dn_getSystem() function. More...
 
tuple Tuple_dn_getUser = collections.namedtuple("Tuple_dn_getUser", ['userName', 'privilege'])
 The named tuple returned by the dn_getUser() function. More...
 
tuple Tuple_dn_getUsers = collections.namedtuple("Tuple_dn_getUsers", ['userName', 'privilege'])
 The named tuple returned by the dn_getUsers() function. More...
 
tuple Tuple_dn_getSourceRoute = collections.namedtuple("Tuple_dn_getSourceRoute", ['destMacAddr', 'primaryPath', 'secondaryPath'])
 The named tuple returned by the dn_getSourceRoute() function. More...
 
tuple Tuple_dn_getLatency = collections.namedtuple("Tuple_dn_getLatency", ['downstream', 'upstream'])
 The named tuple returned by the dn_getLatency() function. More...
 
tuple Tuple_dn_getLicense = collections.namedtuple("Tuple_dn_getLicense", ['license'])
 The named tuple returned by the dn_getLicense() function. More...
 
tuple Tuple_dn_getTime = collections.namedtuple("Tuple_dn_getTime", ['utc_time', 'asn_time'])
 The named tuple returned by the dn_getTime() function. More...
 
tuple Tuple_dn_pingMote = collections.namedtuple("Tuple_dn_pingMote", ['callbackId'])
 The named tuple returned by the dn_pingMote() function. More...
 
tuple Tuple_dn_promoteToOperational = collections.namedtuple("Tuple_dn_promoteToOperational", ['result'])
 The named tuple returned by the dn_promoteToOperational() function. More...
 
tuple Tuple_dn_reset = collections.namedtuple("Tuple_dn_reset", ['result'])
 The named tuple returned by the dn_reset() function. More...
 
tuple Tuple_dn_resetWithId = collections.namedtuple("Tuple_dn_resetWithId", ['result'])
 The named tuple returned by the dn_resetWithId() function. More...
 
tuple Tuple_dn_resetWithMac = collections.namedtuple("Tuple_dn_resetWithMac", ['result'])
 The named tuple returned by the dn_resetWithMac() function. More...
 
tuple Tuple_dn_sendRequest = collections.namedtuple("Tuple_dn_sendRequest", ['callbackId'])
 The named tuple returned by the dn_sendRequest() function. More...
 
tuple Tuple_dn_sendResponse = collections.namedtuple("Tuple_dn_sendResponse", ['callbackId'])
 The named tuple returned by the dn_sendResponse() function. More...
 
tuple Tuple_dn_setAcl = collections.namedtuple("Tuple_dn_setAcl", ['macAddr'])
 The named tuple returned by the dn_setAcl() function. More...
 
tuple Tuple_dn_setBlacklist = collections.namedtuple("Tuple_dn_setBlacklist", ['frequency'])
 The named tuple returned by the dn_setBlacklist() function. More...
 
tuple Tuple_dn_setNetwork = collections.namedtuple("Tuple_dn_setNetwork", ['netName', 'networkId', 'maxMotes', 'optimizationEnable', 'accessPointPA', 'ccaEnabled', 'requestedBasePkPeriod', 'minServicesPkPeriod', 'minPipePkPeriod', 'bandwidthProfile', 'manualUSFrameSize', 'manualDSFrameSize', 'manualAdvFrameSize', 'locationMode', 'backboneEnabled', 'backboneSize'])
 The named tuple returned by the dn_setNetwork() function. More...
 
tuple Tuple_dn_setSecurity = collections.namedtuple("Tuple_dn_setSecurity", ['securityMode', 'acceptHARTDevicesOnly'])
 The named tuple returned by the dn_setSecurity() function. More...
 
tuple Tuple_dn_setSla = collections.namedtuple("Tuple_dn_setSla", ['minNetReliability', 'maxNetLatency', 'minNetPathStability', 'apRdntCoverageThreshold'])
 The named tuple returned by the dn_setSla() function. More...
 
tuple Tuple_dn_setSystem = collections.namedtuple("Tuple_dn_setSystem", ['systemName', 'location', 'cliTimeout'])
 The named tuple returned by the dn_setSystem() function. More...
 
tuple Tuple_dn_setUser = collections.namedtuple("Tuple_dn_setUser", ['userName', 'privilege'])
 The named tuple returned by the dn_setUser() function. More...
 
tuple Tuple_dn_setLicense = collections.namedtuple("Tuple_dn_setLicense", ['result'])
 The named tuple returned by the dn_setLicense() function. More...
 
tuple Tuple_dn_startOtap = collections.namedtuple("Tuple_dn_startOtap", ['result'])
 The named tuple returned by the dn_startOtap() function. More...
 
tuple Tuple_dn_startOtapWithRetries = collections.namedtuple("Tuple_dn_startOtapWithRetries", ['result'])
 The named tuple returned by the dn_startOtapWithRetries() function. More...
 
tuple Tuple_dn_subscribe = collections.namedtuple("Tuple_dn_subscribe", ['notif_token'])
 The named tuple returned by the dn_subscribe() function. More...
 
tuple Tuple_dn_unsubscribe = collections.namedtuple("Tuple_dn_unsubscribe", ['result'])
 The named tuple returned by the dn_unsubscribe() function. More...
 
dictionary notifTupleTable = {}
 Dictionary of all notification tuples. More...
 
string USERCONNECT = "UserConnect"
 USERCONNECT notification. More...
 
string USERDISCONNECT = "UserDisconnect"
 USERDISCONNECT notification. More...
 
string MANUALMOTERESET = "ManualMoteReset"
 MANUALMOTERESET notification. More...
 
string MANUALMOTEDELETE = "ManualMoteDelete"
 MANUALMOTEDELETE notification. More...
 
string MANUALMOTEDECOMMISSION = "ManualMoteDecommission"
 MANUALMOTEDECOMMISSION notification. More...
 
string MANUALNETRESET = "ManualNetReset"
 MANUALNETRESET notification. More...
 
string MANUALDCCRESET = "ManualDccReset"
 MANUALDCCRESET notification. More...
 
string MANUALSTATRESET = "ManualStatReset"
 MANUALSTATRESET notification. More...
 
string CONFIGCHANGE = "ConfigChange"
 CONFIGCHANGE notification. More...
 
string BOOTUP = "BootUp"
 BOOTUP notification. More...
 
string NETWORKRESET = "NetworkReset"
 NETWORKRESET notification. More...
 
string COMMANDFINISHED = "CommandFinished"
 COMMANDFINISHED notification. More...
 
string PACKETSENT = "PacketSent"
 PACKETSENT notification. More...
 
string MOTEJOIN = "MoteJoin"
 MOTEJOIN notification. More...
 
string MOTELIVE = "MoteLive"
 MOTELIVE notification. More...
 
string MOTEQUARANTINE = "MoteQuarantine"
 MOTEQUARANTINE notification. More...
 
string MOTEJOINQUARANTINE = "MoteJoinQuarantine"
 MOTEJOINQUARANTINE notification. More...
 
string MOTEUNKNOWN = "MoteUnknown"
 MOTEUNKNOWN notification. More...
 
string MOTEDISCONNECT = "MoteDisconnect"
 MOTEDISCONNECT notification. More...
 
string MOTEJOINFAILURE = "MoteJoinFailure"
 MOTEJOINFAILURE notification. More...
 
string INVALIDMIC = "InvalidMIC"
 INVALIDMIC notification. More...
 
string PATHCREATE = "PathCreate"
 PATHCREATE notification. More...
 
string PATHDELETE = "PathDelete"
 PATHDELETE notification. More...
 
string PATHACTIVATE = "PathActivate"
 PATHACTIVATE notification. More...
 
string PATHDEACTIVATE = "PathDeactivate"
 PATHDEACTIVATE notification. More...
 
string PATHALERT = "PathAlert"
 PATHALERT notification. More...
 
string PIPEON = "PipeOn"
 PIPEON notification. More...
 
string PIPEOFF = "PipeOff"
 PIPEOFF notification. More...
 
string SERVICEDENIED = "ServiceDenied"
 SERVICEDENIED notification. More...
 
string PINGREPLY = "PingReply"
 PINGREPLY notification. More...
 
string TRANSPORTTIMEOUT = "TransportTimeout"
 TRANSPORTTIMEOUT notification. More...
 
string DATA = "data"
 DATA notification. More...
 
string LOCATION = "Location"
 LOCATION notification. More...
 
string CLI = "cli"
 CLI notification. More...
 
string LOG = "log"
 LOG notification. More...
 
string STDMOTEREPORT = "stdMoteReport"
 STDMOTEREPORT notification. More...
 
string VENDORMOTEREPORT = "vendorMoteReport"
 VENDORMOTEREPORT notification. More...
 

Detailed Description

Public class for the HART Manager connector using the XML API.

Member Function Documentation

def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_activateAdvertising (   self,
  macAddr,
  timeout 
)

Activate advertisement frame.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
timeout4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_activateAdvertising named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_activateFastPipe (   self,
  macAddr,
  pipeDirection 
)

Activate the fast network pipe to the specified mote.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
pipeDirection25-byte field formatted as a string.
This field can only take one of the following values:
  • UniUp: upstream
  • UniDown: downstream
  • Bi: bidirectional
Returns
The response to the command, formatted as a Tuple_dn_activateFastPipe named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_cancelOtap (   self)

This command cancels the OTAP (Over-The-Air-Programming) process to upgrade software on motes and the access point.

Returns
The response to the command, formatted as a Tuple_dn_cancelOtap named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_cli (   self,
  command 
)

This command tunnels a given command through to the manager's Command Line Interface (CLI).

The CLI command can be called by only one XML API client at a time. The response to the given CLI command is tunneled back to the client via the notifications channel. To receive the CLI notification, the client must be subscribed to CLI notifications (see Notification Channel)

Parameters
command128-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_cli named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deactivateFastPipe (   self,
  macAddr 
)

Deactivate the fast network pipe to the specified mote.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_deactivateFastPipe named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_decommissionDevice (   self,
  macAddr 
)

Decommission a device in the network.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_decommissionDevice named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deleteAcl (   self,
  macAddr 
)

Remove a device from the ACL.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deleteMote (   self,
  macAddr 
)

Remove a mote from the manager configuration.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deleteUser (   self,
  userName 
)

Remove a user.

Parameters
userName16-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeJoinKey (   self,
  newKey 
)

Exchange the common join key.

Parameters
newKey16-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_exchangeJoinKey named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeMoteJoinKey (   self,
  macAddr,
  newKey 
)

Exchange a mote's join key.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
newKey16-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_exchangeMoteJoinKey named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeMoteNetworkId (   self,
  macAddr,
  newId 
)

Exchange the network ID for a mote.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
newId4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_exchangeMoteNetworkId named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeNetworkId (   self,
  newId 
)

Exchange the network ID.

Parameters
newId4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_exchangeNetworkId named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeNetworkKey (   self)

Exchange the network key.

Returns
The response to the command, formatted as a Tuple_dn_exchangeNetworkKey named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeSessionKey (   self,
  macAddrA,
  macAddrB 
)

Exchange a mote's session key.

Parameters
macAddrA25-byte field formatted as a string.
There is no restriction on the value of this field.
macAddrB25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_exchangeSessionKey named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getAcl (   self,
  macAddr 
)

Check whether a device is part of the ACL.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getAcl named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getAcls (   self)

Get the list of devices on the ACL.

Returns
The response to the command, formatted as a list of Tuple_dn_getAcls named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getBlacklist (   self)

Get the channel blacklist.

Returns
The response to the command, formatted as a list of Tuple_dn_getBlacklist named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getLatency (   self,
  macAddr 
)

Get estimated latency for a mote.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getLatency named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getLicense (   self)

Get the software license key.

Returns
The response to the command, formatted as a Tuple_dn_getLicense named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getMote (   self,
  macAddr 
)
Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getMote named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getMotes (   self)

Get the list of Motes.

Returns
The response to the command, formatted as a list of Tuple_dn_getMotes named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getMoteStatistics (   self,
  macAddr,
  period,
  index 
)

Get the Mote Statistics.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
period32-byte field formatted as a string.
This field can only take one of the following values:
  • current: current
  • lifetime: lifetime
  • short: short
  • long: long
index4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getMoteStatistics named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getNetwork (   self)

Retrieves network configuration parameters.

Returns
The response to the command, formatted as a Tuple_dn_getNetwork named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getNetworkStatistics (   self,
  period,
  index 
)

Get the Network Statistics.

Parameters
period32-byte field formatted as a string.
This field can only take one of the following values:
  • current: current
  • lifetime: lifetime
  • short: short
  • long: long
index4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getNetworkStatistics named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getOpenAlarms (   self)

Retrieves a list of the open alarms on the Manager.

Returns
The response to the command, formatted as a list of Tuple_dn_getOpenAlarms named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getPaths (   self,
  moteMac 
)

Get the list of Paths to the mote's neighbors.

Parameters
moteMac25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a list of Tuple_dn_getPaths named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getPathStatistics (   self,
  pathId,
  period,
  index 
)

Get Statistics for a specific Path.

Parameters
pathId4-byte field formatted as a int.
There is no restriction on the value of this field.
period16-byte field formatted as a string.
This field can only take one of the following values:
  • current: current
  • lifetime: lifetime
  • short: short
  • long: long
index4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getPathStatistics named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getRedundancy (   self)

Get the redundancy state.

Returns
The response to the command, formatted as a Tuple_dn_getRedundancy named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSecurity (   self)

Get the Security configuration.

Returns
The response to the command, formatted as a Tuple_dn_getSecurity named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSla (   self)

Get the Service Level Agreement (SLA) configuration.

Returns
The response to the command, formatted as a Tuple_dn_getSla named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSourceRoute (   self,
  destMacAddr 
)

Get the Source Route for a specific Mote.

Parameters
destMacAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getSourceRoute named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSystem (   self)

Retrieves system-level information.

Returns
The response to the command, formatted as a Tuple_dn_getSystem named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getTime (   self)

Get the current time.

Returns
The response to the command, formatted as a Tuple_dn_getTime named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getUser (   self,
  userName 
)

Get the description of a user.

Parameters
userName16-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_getUser named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getUsers (   self)

Get the list of users.

Returns
The response to the command, formatted as a list of Tuple_dn_getUsers named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_pingMote (   self,
  macAddr 
)

Ping the specified mote.

A Net Ping Reply event notification will contain the mote's response.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_pingMote named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_promoteToOperational (   self,
  macAddr 
)

Promote a quarantined device to operational.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_promoteToOperational named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_reset (   self,
  object 
)

Reset the system or network.

Parameters
object25-byte field formatted as a string.
This field can only take one of the following values:
  • network: network
  • system: system
  • stat: statistics
  • eventLog: eventLog
Returns
The response to the command, formatted as a Tuple_dn_reset named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_resetWithId (   self,
  object,
  moteId 
)

Reset mote by ID.

Parameters
object25-byte field formatted as a string.
This field can only take one of the following values:
  • mote: mote
moteId4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_resetWithId named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_resetWithMac (   self,
  object,
  macAddr 
)

Reset mote by MAC address.

Parameters
object25-byte field formatted as a string.
This field can only take one of the following values:
  • mote: mote
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_resetWithMac named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_sendRequest (   self,
  macAddr,
  domain,
  priority,
  reliable,
  data 
)

Send downstream (request) data.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
domain16-byte field formatted as a string.
This field can only take one of the following values:
  • maintenance: maintenance
priority16-byte field formatted as a string.
This field can only take one of the following values:
  • low: low
  • high: high
reliable0-byte field formatted as a bool.
There is no restriction on the value of this field.
dataNone-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_sendRequest named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_sendResponse (   self,
  macAddr,
  domain,
  priority,
  reliable,
  callbackId,
  data 
)

Send downstream data as a response.

sendResponse should only be used in special cases.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
domain16-byte field formatted as a string.
This field can only take one of the following values:
  • maintenance: maintenance
priority16-byte field formatted as a string.
This field can only take one of the following values:
  • low: low
  • high: high
reliable0-byte field formatted as a bool.
There is no restriction on the value of this field.
callbackId4-byte field formatted as a int.
There is no restriction on the value of this field.
dataNone-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_sendResponse named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setAcl (   self,
  macAddr,
  joinKey 
)

Add or update a device in the ACL.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
joinKey16-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setAcl named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setBlacklist (   self,
  frequency 
)

Update the channel blacklist.

Parameters
frequency4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setBlacklist named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setLicense (   self,
  license 
)

Set the software license key.

Parameters
license40-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setLicense named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setMote (   self,
  macAddr,
  name,
  enableRouting 
)

Set mote configuration.

Parameters
macAddr25-byte field formatted as a string.
There is no restriction on the value of this field.
name16-byte field formatted as a string.
There is no restriction on the value of this field.
enableRouting1-byte field formatted as a bool.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setMote named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setNetwork (   self,
  netName,
  networkId,
  maxMotes,
  optimizationEnable,
  accessPointPA,
  ccaEnabled,
  requestedBasePkPeriod,
  minServicesPkPeriod,
  minPipePkPeriod,
  bandwidthProfile,
  manualUSFrameSize,
  manualDSFrameSize,
  manualAdvFrameSize,
  locationMode 
)

Set network configuration.

Parameters
netName16-byte field formatted as a string.
There is no restriction on the value of this field.
networkId4-byte field formatted as a int.
There is no restriction on the value of this field.
maxMotes4-byte field formatted as a int.
There is no restriction on the value of this field.
optimizationEnable1-byte field formatted as a bool.
There is no restriction on the value of this field.
accessPointPA1-byte field formatted as a bool.
There is no restriction on the value of this field.
ccaEnabled1-byte field formatted as a bool.
There is no restriction on the value of this field.
requestedBasePkPeriod4-byte field formatted as a int.
There is no restriction on the value of this field.
minServicesPkPeriod4-byte field formatted as a int.
There is no restriction on the value of this field.
minPipePkPeriod4-byte field formatted as a int.
There is no restriction on the value of this field.
bandwidthProfile16-byte field formatted as a string.
This field can only take one of the following values:
  • Manual: manual profile
  • P1: normal profile
  • P2: low-power profile
manualUSFrameSize4-byte field formatted as a int.
There is no restriction on the value of this field.
manualDSFrameSize4-byte field formatted as a int.
There is no restriction on the value of this field.
manualAdvFrameSize4-byte field formatted as a int.
There is no restriction on the value of this field.
locationMode8-byte field formatted as a string.
This field can only take one of the following values:
  • on: on
  • off: off
Returns
The response to the command, formatted as a Tuple_dn_setNetwork named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setSecurity (   self,
  securityMode,
  commonJoinKey,
  acceptHARTDevicesOnly 
)

Set security configuration.

Parameters
securityMode20-byte field formatted as a string.
This field can only take one of the following values:
  • acceptACL: Accept ACL
  • acceptCommonJoinKey: Accept common join key
commonJoinKey16-byte field formatted as a hex.
There is no restriction on the value of this field.
acceptHARTDevicesOnly1-byte field formatted as a bool.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setSecurity named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setSla (   self,
  minNetReliability,
  maxNetLatency,
  minNetPathStability,
  apRdntCoverageThreshold 
)

Set SLA configuration.

Parameters
minNetReliability8-byte field formatted as a float.
There is no restriction on the value of this field.
maxNetLatency4-byte field formatted as a int.
There is no restriction on the value of this field.
minNetPathStability8-byte field formatted as a float.
There is no restriction on the value of this field.
apRdntCoverageThreshold8-byte field formatted as a float.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setSla named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setSystem (   self,
  systemName,
  location,
  cliTimeout 
)

Set system-level configuration.

Parameters
systemName16-byte field formatted as a string.
There is no restriction on the value of this field.
location16-byte field formatted as a string.
There is no restriction on the value of this field.
cliTimeout4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setSystem named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setUser (   self,
  userName,
  password,
  privilege 
)

Add or update user configuration.

Parameters
userName16-byte field formatted as a string.
There is no restriction on the value of this field.
password16-byte field formatted as a string.
There is no restriction on the value of this field.
privilege16-byte field formatted as a string.
This field can only take one of the following values:
  • viewer: viewer
  • user: user
  • superuser: superuser
Returns
The response to the command, formatted as a Tuple_dn_setUser named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_startOtap (   self)

This command initiates the OTAP (Over-The-Air-Programming) process to upgrade software on motes and the Access Point.

By default, the process will retry the OTAP file transmission 100 times.

Returns
The response to the command, formatted as a Tuple_dn_startOtap named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_startOtapWithRetries (   self,
  retries 
)

This command initiates the OTAP (Over-The-Air-Programming) process to upgrade software for motes and the Access Point, using the specified number of retries.

Parameters
retries1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_startOtapWithRetries named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_subscribe (   self,
  filter 
)

Subscribe to notifications.

This function adds or updates the subscribed notifications to match 'filter'. The filter is a space-separated list of notification types. Valid types include 'data' and 'events'.

Parameters
filter128-byte field formatted as a string.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_subscribe named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_unsubscribe (   self)

Unsubscribe from notifications.

This function clears the existing notification subscription of the client and stops the notification thread.

Returns
The response to the command, formatted as a Tuple_dn_unsubscribe named tuple.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.getNotification (   self,
  timeoutSec = -1 
)

Get a notification from the notification queue, and returns it properly formatted.

Exceptions
NotificationErrorif unknown notification.

Member Data Documentation

string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.BOOTUP = "BootUp"
static

BOOTUP notification.

Formatted as a Tuple_BootUp named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.CLI = "cli"
static

CLI notification.

Formatted as a Tuple_cli named tuple. It contains the following fields:

  • time 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • message 128-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.COMMANDFINISHED = "CommandFinished"
static

COMMANDFINISHED notification.

Formatted as a Tuple_CommandFinished named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • callbackId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • objectType 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • resultCode 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.CONFIGCHANGE = "ConfigChange"
static

CONFIGCHANGE notification.

Formatted as a Tuple_ConfigChange named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • objectType 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • objectId 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.DATA = "data"
static

DATA notification.

Formatted as a Tuple_data named tuple. It contains the following fields:

  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • time 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • payload None-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • payloadType 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • isReliable 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • isRequest 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • isBroadcast 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • callbackId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • counter 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.INVALIDMIC = "InvalidMIC"
static

INVALIDMIC notification.

Formatted as a Tuple_InvalidMIC named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.LOCATION = "Location"
static

LOCATION notification.

Formatted as a Tuple_Location named tuple. It contains the following fields:

  • ver 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • asn 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • src 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • dest 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • payload None-byte field formatted as a hex.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.LOG = "log"
static

LOG notification.

Formatted as a Tuple_log named tuple. It contains the following fields:

  • time 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • severity 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • message 128-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MANUALDCCRESET = "ManualDccReset"
static

MANUALDCCRESET notification.

Formatted as a Tuple_ManualDccReset named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MANUALMOTEDECOMMISSION = "ManualMoteDecommission"
static

MANUALMOTEDECOMMISSION notification.

Formatted as a Tuple_ManualMoteDecommission named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MANUALMOTEDELETE = "ManualMoteDelete"
static

MANUALMOTEDELETE notification.

Formatted as a Tuple_ManualMoteDelete named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MANUALMOTERESET = "ManualMoteReset"
static

MANUALMOTERESET notification.

Formatted as a Tuple_ManualMoteReset named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MANUALNETRESET = "ManualNetReset"
static

MANUALNETRESET notification.

Formatted as a Tuple_ManualNetReset named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MANUALSTATRESET = "ManualStatReset"
static

MANUALSTATRESET notification.

Formatted as a Tuple_ManualStatReset named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTEDISCONNECT = "MoteDisconnect"
static

MOTEDISCONNECT notification.

Formatted as a Tuple_MoteDisconnect named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTEJOIN = "MoteJoin"
static

MOTEJOIN notification.

Formatted as a Tuple_MoteJoin named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
  • userData 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTEJOINFAILURE = "MoteJoinFailure"
static

MOTEJOINFAILURE notification.

Formatted as a Tuple_MoteJoinFailure named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTEJOINQUARANTINE = "MoteJoinQuarantine"
static

MOTEJOINQUARANTINE notification.

Formatted as a Tuple_MoteJoinQuarantine named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
  • userData 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTELIVE = "MoteLive"
static

MOTELIVE notification.

Formatted as a Tuple_MoteLive named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTEQUARANTINE = "MoteQuarantine"
static

MOTEQUARANTINE notification.

Formatted as a Tuple_MoteQuarantine named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.MOTEUNKNOWN = "MoteUnknown"
static

MOTEUNKNOWN notification.

Formatted as a Tuple_MoteUnknown named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • reason 64-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.NETWORKRESET = "NetworkReset"
static

NETWORKRESET notification.

Formatted as a Tuple_NetworkReset named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
dictionary SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.notifTupleTable = {}
static

Dictionary of all notification tuples.

string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PACKETSENT = "PacketSent"
static

PACKETSENT notification.

Formatted as a Tuple_PacketSent named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • callbackId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PATHACTIVATE = "PathActivate"
static

PATHACTIVATE notification.

Formatted as a Tuple_PathActivate named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pathId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteAMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteBMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PATHALERT = "PathAlert"
static

PATHALERT notification.

Formatted as a Tuple_PathAlert named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pathId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteAMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteBMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PATHCREATE = "PathCreate"
static

PATHCREATE notification.

Formatted as a Tuple_PathCreate named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pathId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteAMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteBMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PATHDEACTIVATE = "PathDeactivate"
static

PATHDEACTIVATE notification.

Formatted as a Tuple_PathDeactivate named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pathId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteAMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteBMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PATHDELETE = "PathDelete"
static

PATHDELETE notification.

Formatted as a Tuple_PathDelete named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pathId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteAMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteBMac 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PINGREPLY = "PingReply"
static

PINGREPLY notification.

Formatted as a Tuple_PingReply named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • callbackId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • latency 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • temperature 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • voltage 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • hopCount 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PIPEOFF = "PipeOff"
static

PIPEOFF notification.

Formatted as a Tuple_PipeOff named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.PIPEON = "PipeOn"
static

PIPEON notification.

Formatted as a Tuple_PipeOn named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • allocatedPipePkPeriod 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.SERVICEDENIED = "ServiceDenied"
static

SERVICEDENIED notification.

Formatted as a Tuple_ServiceDenied named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • serviceId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • requestingMacAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • peerMacAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • appDomain 32-byte field formatted as a string.
    This field can only take one of the following values:
    • maintenance: maintenance
  • isSource 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • isSink 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • isIntermittent 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • period 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.STDMOTEREPORT = "stdMoteReport"
static

STDMOTEREPORT notification.

Formatted as a Tuple_stdMoteReport named tuple. It contains the following fields:

  • time 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • payload None-byte field formatted as a hex.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.TRANSPORTTIMEOUT = "TransportTimeout"
static

TRANSPORTTIMEOUT notification.

Formatted as a Tuple_TransportTimeout named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • srcMacAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • destMacAddr 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • timeoutType 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • callbackId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_activateAdvertising = collections.namedtuple("Tuple_dn_activateAdvertising", ['result'])
static

The named tuple returned by the dn_activateAdvertising() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_activateFastPipe = collections.namedtuple("Tuple_dn_activateFastPipe", ['result'])
static

The named tuple returned by the dn_activateFastPipe() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_cancelOtap = collections.namedtuple("Tuple_dn_cancelOtap", ['result'])
static

The named tuple returned by the dn_cancelOtap() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_cli = collections.namedtuple("Tuple_dn_cli", ['result'])
static

The named tuple returned by the dn_cli() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_deactivateFastPipe = collections.namedtuple("Tuple_dn_deactivateFastPipe", ['result'])
static

The named tuple returned by the dn_deactivateFastPipe() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_decommissionDevice = collections.namedtuple("Tuple_dn_decommissionDevice", ['result'])
static

The named tuple returned by the dn_decommissionDevice() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_exchangeJoinKey = collections.namedtuple("Tuple_dn_exchangeJoinKey", ['callbackId'])
static

The named tuple returned by the dn_exchangeJoinKey() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_exchangeMoteJoinKey = collections.namedtuple("Tuple_dn_exchangeMoteJoinKey", ['callbackId'])
static

The named tuple returned by the dn_exchangeMoteJoinKey() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_exchangeMoteNetworkId = collections.namedtuple("Tuple_dn_exchangeMoteNetworkId", ['callbackId'])
static

The named tuple returned by the dn_exchangeMoteNetworkId() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_exchangeNetworkId = collections.namedtuple("Tuple_dn_exchangeNetworkId", ['callbackId'])
static

The named tuple returned by the dn_exchangeNetworkId() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_exchangeNetworkKey = collections.namedtuple("Tuple_dn_exchangeNetworkKey", ['callbackId'])
static

The named tuple returned by the dn_exchangeNetworkKey() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_exchangeSessionKey = collections.namedtuple("Tuple_dn_exchangeSessionKey", ['callbackId'])
static

The named tuple returned by the dn_exchangeSessionKey() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getAcl = collections.namedtuple("Tuple_dn_getAcl", ['macAddr'])
static

The named tuple returned by the dn_getAcl() function.

  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getAcls = collections.namedtuple("Tuple_dn_getAcls", ['macAddr'])
static

The named tuple returned by the dn_getAcls() function.

  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getBlacklist = collections.namedtuple("Tuple_dn_getBlacklist", ['frequency'])
static

The named tuple returned by the dn_getBlacklist() function.

  • frequency: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getLatency = collections.namedtuple("Tuple_dn_getLatency", ['downstream', 'upstream'])
static

The named tuple returned by the dn_getLatency() function.

  • downstream: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • upstream: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getLicense = collections.namedtuple("Tuple_dn_getLicense", ['license'])
static

The named tuple returned by the dn_getLicense() function.

  • license: 40-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getMote = collections.namedtuple("Tuple_dn_getMote", ['moteId', 'macAddr', 'name', 'state', 'numJoins', 'joinTime', 'reason', 'isAccessPoint', 'powerSource', 'dischargeCurrent', 'dischargeTime', 'recoveryTime', 'enableRouting', 'productName', 'hwModel', 'hwRev', 'swRev', 'voltage', 'numNeighbors', 'needNeighbor', 'goodNeighbors', 'allocatedPkPeriod', 'allocatedPipePkPeriod', 'pipeStatus', 'advertisingStatus', 'locationTag'])
static

The named tuple returned by the dn_getMote() function.

  • moteId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
  • name: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • state: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • Idle: idle
    • Lost: lost
    • Joining: joining
    • Operational: operational
    • Disconnecting: disconnecting
  • numJoins: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • joinTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • reason: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • isAccessPoint: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • powerSource: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • dischargeCurrent: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • dischargeTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • recoveryTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • enableRouting: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • productName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • hwModel: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • hwRev: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swRev: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • voltage: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • numNeighbors: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • needNeighbor: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • goodNeighbors: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • allocatedPkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • allocatedPipePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pipeStatus: 4-byte field formatted as a string.
    This field can only take one of the following values:
    • off: off
    • pending: Pipe activation pending
    • on_bi: Bidirection pipe on
    • on_up: Upstream pipe on
    • on_down: Downstream pipe on
  • advertisingStatus: 4-byte field formatted as a string.
    This field can only take one of the following values:
    • on: on
    • off: off
    • pending: pending
  • locationTag: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • supported: supported
    • not supported: not supported
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getMotes = collections.namedtuple("Tuple_dn_getMotes", ['moteId', 'macAddr', 'name', 'state', 'numJoins', 'joinTime', 'reason', 'isAccessPoint', 'powerSource', 'dischargeCurrent', 'dischargeTime', 'recoveryTime', 'enableRouting', 'productName', 'hwModel', 'hwRev', 'swRev', 'voltage', 'numNeighbors', 'needNeighbor', 'goodNeighbors', 'allocatedPkPeriod', 'allocatedPipePkPeriod', 'pipeStatus', 'advertisingStatus', 'locationTag'])
static

The named tuple returned by the dn_getMotes() function.

  • moteId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
  • name: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • state: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • Idle: idle
    • Lost: lost
    • Joining: joining
    • Operational: operational
    • Disconnecting: disconnecting
  • numJoins: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • joinTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • reason: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • isAccessPoint: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • powerSource: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • dischargeCurrent: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • dischargeTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • recoveryTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • enableRouting: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • productName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • hwModel: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • hwRev: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swRev: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • voltage: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • numNeighbors: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • needNeighbor: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • goodNeighbors: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • allocatedPkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • allocatedPipePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pipeStatus: 4-byte field formatted as a string.
    This field can only take one of the following values:
    • off: off
    • pending: Pipe activation pending
    • on_bi: Bidirection pipe on
    • on_up: Upstream pipe on
    • on_down: Downstream pipe on
  • advertisingStatus: 4-byte field formatted as a string.
    This field can only take one of the following values:
    • on: on
    • off: off
    • pending: pending
  • locationTag: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • supported: supported
    • not supported: not supported
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getMoteStatistics = collections.namedtuple("Tuple_dn_getMoteStatistics", ['index', 'startTime', 'avgLatency', 'reliability', 'numJoins', 'voltage', 'chargeConsumption', 'temperature', 'numLostPackets', 'latencyToMote'])
static

The named tuple returned by the dn_getMoteStatistics() function.

  • index: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • startTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • avgLatency: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • reliability: 0-byte field formatted as a float.
    There is no restriction on the value of this field.
  • numJoins: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • voltage: 4-byte field formatted as a float.
    There is no restriction on the value of this field.
  • chargeConsumption: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • temperature: 4-byte field formatted as a float.
    There is no restriction on the value of this field.
  • numLostPackets: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • latencyToMote: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getNetwork = collections.namedtuple("Tuple_dn_getNetwork", ['netName', 'networkId', 'maxMotes', 'numMotes', 'optimizationEnable', 'accessPointPA', 'ccaEnabled', 'requestedBasePkPeriod', 'minServicesPkPeriod', 'minPipePkPeriod', 'bandwidthProfile', 'manualUSFrameSize', 'manualDSFrameSize', 'manualAdvFrameSize', 'netQueueSize', 'userQueueSize', 'locationMode', 'backboneEnabled', 'backboneSize'])
static

The named tuple returned by the dn_getNetwork() function.

  • netName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • networkId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • maxMotes: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • numMotes: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • optimizationEnable: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • accessPointPA: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • ccaEnabled: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • requestedBasePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minServicesPkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minPipePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • bandwidthProfile: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • Manual: manual profile
    • P1: normal profile
    • P2: low-power profile
  • manualUSFrameSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • manualDSFrameSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • manualAdvFrameSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • netQueueSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • userQueueSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • locationMode: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • on: on
    • off: off
  • backboneEnabled: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • backboneSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getNetworkStatistics = collections.namedtuple("Tuple_dn_getNetworkStatistics", ['index', 'startTime', 'netLatency', 'netReliability', 'netPathStability', 'lostUpstreamPackets'])
static

The named tuple returned by the dn_getNetworkStatistics() function.

  • index: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • startTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • netLatency: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • netReliability: 0-byte field formatted as a float.
    There is no restriction on the value of this field.
  • netPathStability: 0-byte field formatted as a float.
    There is no restriction on the value of this field.
  • lostUpstreamPackets: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getOpenAlarms = collections.namedtuple("Tuple_dn_getOpenAlarms", ['timeStamp', 'eventId', 'alarmType', 'macAddr'])
static

The named tuple returned by the dn_getOpenAlarms() function.

  • timeStamp: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • alarmType: 32-byte field formatted as a string.
    This field can only take one of the following values:
    • moteDown: Mote down alarm
    • slaReliability: SLA Reliability
    • slaLatency: SLA Latency
    • slaStability: SLA Stability
    • maxMotesReached: Maximum number of motes reached
    • bbLatencyWarn: Backbone latency warning
  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getPaths = collections.namedtuple("Tuple_dn_getPaths", ['pathId', 'moteAMac', 'moteBMac', 'numLinks', 'pathDirection', 'pathQuality'])
static

The named tuple returned by the dn_getPaths() function.

  • pathId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteAMac: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
  • moteBMac: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
  • numLinks: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pathDirection: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • all: all
    • upstream: upstream
    • downstream: downstream
    • unused: unused
  • pathQuality: 0-byte field formatted as a float.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getPathStatistics = collections.namedtuple("Tuple_dn_getPathStatistics", ['index', 'startTime', 'baPwr', 'abPwr', 'stability'])
static

The named tuple returned by the dn_getPathStatistics() function.

  • index: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • startTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • baPwr: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • abPwr: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • stability: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getRedundancy = collections.namedtuple("Tuple_dn_getRedundancy", ['localMode', 'peerStatus', 'peerControllerSwRev'])
static

The named tuple returned by the dn_getRedundancy() function.

  • localMode: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • standalone: standalone
    • transToMaster: Transitioning to master
    • transToSlave: Transitioning to slave
    • master: master
    • slave: slave
    • failed: Manager failed
  • peerStatus: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • unknown: unknown
    • connected: connected
    • synchronized: synchronized
  • peerControllerSwRev: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getSecurity = collections.namedtuple("Tuple_dn_getSecurity", ['securityMode', 'acceptHARTDevicesOnly'])
static

The named tuple returned by the dn_getSecurity() function.

  • securityMode: 20-byte field formatted as a string.
    This field can only take one of the following values:
    • acceptACL: Accept ACL
    • acceptCommonJoinKey: Accept common join key
  • acceptHARTDevicesOnly: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getSla = collections.namedtuple("Tuple_dn_getSla", ['minNetReliability', 'maxNetLatency', 'minNetPathStability', 'apRdntCoverageThreshold'])
static

The named tuple returned by the dn_getSla() function.

  • minNetReliability: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • maxNetLatency: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minNetPathStability: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • apRdntCoverageThreshold: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getSourceRoute = collections.namedtuple("Tuple_dn_getSourceRoute", ['destMacAddr', 'primaryPath', 'secondaryPath'])
static

The named tuple returned by the dn_getSourceRoute() function.

  • destMacAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
  • primaryPath: 16-byte field formatted as a list.
    There is no restriction on the value of this field.
  • secondaryPath: 16-byte field formatted as a list.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getSystem = collections.namedtuple("Tuple_dn_getSystem", ['systemName', 'location', 'swRev', 'hwModel', 'hwRev', 'serialNumber', 'time', 'startTime', 'cliTimeout', 'controllerSwRev'])
static

The named tuple returned by the dn_getSystem() function.

  • systemName: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • location: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • swRev: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • hwModel: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • hwRev: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • serialNumber: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
  • time: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • startTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • cliTimeout: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • controllerSwRev: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getTime = collections.namedtuple("Tuple_dn_getTime", ['utc_time', 'asn_time'])
static

The named tuple returned by the dn_getTime() function.

  • utc_time: 0-byte field formatted as a float.
    There is no restriction on the value of this field.
  • asn_time: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getUser = collections.namedtuple("Tuple_dn_getUser", ['userName', 'privilege'])
static

The named tuple returned by the dn_getUser() function.

  • userName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • privilege: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • viewer: viewer
    • user: user
    • superuser: superuser
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_getUsers = collections.namedtuple("Tuple_dn_getUsers", ['userName', 'privilege'])
static

The named tuple returned by the dn_getUsers() function.

  • userName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • privilege: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • viewer: viewer
    • user: user
    • superuser: superuser
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_pingMote = collections.namedtuple("Tuple_dn_pingMote", ['callbackId'])
static

The named tuple returned by the dn_pingMote() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_promoteToOperational = collections.namedtuple("Tuple_dn_promoteToOperational", ['result'])
static

The named tuple returned by the dn_promoteToOperational() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_reset = collections.namedtuple("Tuple_dn_reset", ['result'])
static

The named tuple returned by the dn_reset() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_resetWithId = collections.namedtuple("Tuple_dn_resetWithId", ['result'])
static

The named tuple returned by the dn_resetWithId() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_resetWithMac = collections.namedtuple("Tuple_dn_resetWithMac", ['result'])
static

The named tuple returned by the dn_resetWithMac() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_sendRequest = collections.namedtuple("Tuple_dn_sendRequest", ['callbackId'])
static

The named tuple returned by the dn_sendRequest() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_sendResponse = collections.namedtuple("Tuple_dn_sendResponse", ['callbackId'])
static

The named tuple returned by the dn_sendResponse() function.

  • callbackId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setAcl = collections.namedtuple("Tuple_dn_setAcl", ['macAddr'])
static

The named tuple returned by the dn_setAcl() function.

  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setBlacklist = collections.namedtuple("Tuple_dn_setBlacklist", ['frequency'])
static

The named tuple returned by the dn_setBlacklist() function.

  • frequency: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setLicense = collections.namedtuple("Tuple_dn_setLicense", ['result'])
static

The named tuple returned by the dn_setLicense() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setMote = collections.namedtuple("Tuple_dn_setMote", ['moteId', 'macAddr', 'name', 'state', 'numJoins', 'joinTime', 'reason', 'isAccessPoint', 'powerSource', 'dischargeCurrent', 'dischargeTime', 'recoveryTime', 'enableRouting', 'productName', 'hwModel', 'hwRev', 'swRev', 'voltage', 'numNeighbors', 'needNeighbor', 'goodNeighbors', 'allocatedPkPeriod', 'allocatedPipePkPeriod', 'pipeStatus', 'advertisingStatus', 'locationTag'])
static

The named tuple returned by the dn_setMote() function.

  • moteId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr: 25-byte field formatted as a string.
    There is no restriction on the value of this field.
  • name: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • state: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • Idle: idle
    • Lost: lost
    • Joining: joining
    • Operational: operational
    • Disconnecting: disconnecting
  • numJoins: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • joinTime: 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • reason: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • isAccessPoint: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • powerSource: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • dischargeCurrent: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • dischargeTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • recoveryTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • enableRouting: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • productName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • hwModel: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • hwRev: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swRev: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • voltage: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • numNeighbors: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • needNeighbor: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • goodNeighbors: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • allocatedPkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • allocatedPipePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • pipeStatus: 4-byte field formatted as a string.
    This field can only take one of the following values:
    • off: off
    • pending: Pipe activation pending
    • on_bi: Bidirection pipe on
    • on_up: Upstream pipe on
    • on_down: Downstream pipe on
  • advertisingStatus: 4-byte field formatted as a string.
    This field can only take one of the following values:
    • on: on
    • off: off
    • pending: pending
  • locationTag: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • supported: supported
    • not supported: not supported
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setNetwork = collections.namedtuple("Tuple_dn_setNetwork", ['netName', 'networkId', 'maxMotes', 'optimizationEnable', 'accessPointPA', 'ccaEnabled', 'requestedBasePkPeriod', 'minServicesPkPeriod', 'minPipePkPeriod', 'bandwidthProfile', 'manualUSFrameSize', 'manualDSFrameSize', 'manualAdvFrameSize', 'locationMode', 'backboneEnabled', 'backboneSize'])
static

The named tuple returned by the dn_setNetwork() function.

  • netName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • networkId: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • maxMotes: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • optimizationEnable: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • accessPointPA: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • ccaEnabled: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • requestedBasePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minServicesPkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minPipePkPeriod: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • bandwidthProfile: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • Manual: manual profile
    • P1: normal profile
    • P2: low-power profile
  • manualUSFrameSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • manualDSFrameSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • manualAdvFrameSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • locationMode: 8-byte field formatted as a string.
    This field can only take one of the following values:
    • on: on
    • off: off
  • backboneEnabled: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
  • backboneSize: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setSecurity = collections.namedtuple("Tuple_dn_setSecurity", ['securityMode', 'acceptHARTDevicesOnly'])
static

The named tuple returned by the dn_setSecurity() function.

  • securityMode: 20-byte field formatted as a string.
    This field can only take one of the following values:
    • acceptACL: Accept ACL
    • acceptCommonJoinKey: Accept common join key
  • acceptHARTDevicesOnly: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setSla = collections.namedtuple("Tuple_dn_setSla", ['minNetReliability', 'maxNetLatency', 'minNetPathStability', 'apRdntCoverageThreshold'])
static

The named tuple returned by the dn_setSla() function.

  • minNetReliability: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • maxNetLatency: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minNetPathStability: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
  • apRdntCoverageThreshold: 8-byte field formatted as a float.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setSystem = collections.namedtuple("Tuple_dn_setSystem", ['systemName', 'location', 'cliTimeout'])
static

The named tuple returned by the dn_setSystem() function.

  • systemName: 50-byte field formatted as a string.
    There is no restriction on the value of this field.
  • location: 50-byte field formatted as a string.
    There is no restriction on the value of this field.
  • cliTimeout: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_setUser = collections.namedtuple("Tuple_dn_setUser", ['userName', 'privilege'])
static

The named tuple returned by the dn_setUser() function.

  • userName: 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • privilege: 16-byte field formatted as a string.
    This field can only take one of the following values:
    • viewer: viewer
    • user: user
    • superuser: superuser
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_startOtap = collections.namedtuple("Tuple_dn_startOtap", ['result'])
static

The named tuple returned by the dn_startOtap() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_startOtapWithRetries = collections.namedtuple("Tuple_dn_startOtapWithRetries", ['result'])
static

The named tuple returned by the dn_startOtapWithRetries() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_subscribe = collections.namedtuple("Tuple_dn_subscribe", ['notif_token'])
static

The named tuple returned by the dn_subscribe() function.

  • notif_token: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.Tuple_dn_unsubscribe = collections.namedtuple("Tuple_dn_unsubscribe", ['result'])
static

The named tuple returned by the dn_unsubscribe() function.

  • result: 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.USERCONNECT = "UserConnect"
static

USERCONNECT notification.

Formatted as a Tuple_UserConnect named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • channel 16-byte field formatted as a string.
    This field can only take one of the following values:
    • cli: Manager CLI
    • config: API control
    • notif: API notifications
  • ipAddr 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.USERDISCONNECT = "UserDisconnect"
static

USERDISCONNECT notification.

Formatted as a Tuple_UserDisconnect named tuple. It contains the following fields:

  • timeStamp 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • eventId 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • channel 16-byte field formatted as a string.
    This field can only take one of the following values:
    • cli: Manager CLI
    • config: API control
    • notif: API notifications
  • ipAddr 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • userName 32-byte field formatted as a string.
    There is no restriction on the value of this field.
string SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.VENDORMOTEREPORT = "vendorMoteReport"
static

VENDORMOTEREPORT notification.

Formatted as a Tuple_vendorMoteReport named tuple. It contains the following fields:

  • time 8-byte field formatted as a int.
    There is no restriction on the value of this field.
  • macAddr 16-byte field formatted as a string.
    There is no restriction on the value of this field.
  • payload None-byte field formatted as a hex.
    There is no restriction on the value of this field.