![]() |
SmartMeshSDK
|
Public class for the HART Manager connector using the XML API. More...
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... | |
Public class for the HART Manager connector using the XML API.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_activateAdvertising | ( | self, | |
macAddr, | |||
timeout | |||
) |
Activate advertisement frame.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
timeout | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_activateFastPipe | ( | self, | |
macAddr, | |||
pipeDirection | |||
) |
Activate the fast network pipe to the specified mote.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
pipeDirection | 25-byte field formatted as a string. This field can only take one of the following values:
|
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.
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)
command | 128-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deactivateFastPipe | ( | self, | |
macAddr | |||
) |
Deactivate the fast network pipe to the specified mote.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_decommissionDevice | ( | self, | |
macAddr | |||
) |
Decommission a device in the network.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deleteAcl | ( | self, | |
macAddr | |||
) |
Remove a device from the ACL.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deleteMote | ( | self, | |
macAddr | |||
) |
Remove a mote from the manager configuration.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_deleteUser | ( | self, | |
userName | |||
) |
Remove a user.
userName | 16-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeJoinKey | ( | self, | |
newKey | |||
) |
Exchange the common join key.
newKey | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeMoteJoinKey | ( | self, | |
macAddr, | |||
newKey | |||
) |
Exchange a mote's join key.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
newKey | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeMoteNetworkId | ( | self, | |
macAddr, | |||
newId | |||
) |
Exchange the network ID for a mote.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
newId | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeNetworkId | ( | self, | |
newId | |||
) |
Exchange the network ID.
newId | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeNetworkKey | ( | self | ) |
Exchange the network key.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_exchangeSessionKey | ( | self, | |
macAddrA, | |||
macAddrB | |||
) |
Exchange a mote's session key.
macAddrA | 25-byte field formatted as a string. There is no restriction on the value of this field. |
macAddrB | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getAcl | ( | self, | |
macAddr | |||
) |
Check whether a device is part of the ACL.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getAcls | ( | self | ) |
Get the list of devices on the ACL.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getBlacklist | ( | self | ) |
Get the channel blacklist.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getLatency | ( | self, | |
macAddr | |||
) |
Get estimated latency for a mote.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getLicense | ( | self | ) |
Get the software license key.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getMote | ( | self, | |
macAddr | |||
) |
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getMotes | ( | self | ) |
Get the list of Motes.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getMoteStatistics | ( | self, | |
macAddr, | |||
period, | |||
index | |||
) |
Get the Mote Statistics.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
period | 32-byte field formatted as a string. This field can only take one of the following values:
|
index | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getNetwork | ( | self | ) |
Retrieves network configuration parameters.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getNetworkStatistics | ( | self, | |
period, | |||
index | |||
) |
Get the Network Statistics.
period | 32-byte field formatted as a string. This field can only take one of the following values:
|
index | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getOpenAlarms | ( | self | ) |
Retrieves a list of the open alarms on the Manager.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getPaths | ( | self, | |
moteMac | |||
) |
Get the list of Paths to the mote's neighbors.
moteMac | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getPathStatistics | ( | self, | |
pathId, | |||
period, | |||
index | |||
) |
Get Statistics for a specific Path.
pathId | 4-byte field formatted as a int. There is no restriction on the value of this field. |
period | 16-byte field formatted as a string. This field can only take one of the following values:
|
index | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getRedundancy | ( | self | ) |
Get the redundancy state.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSecurity | ( | self | ) |
Get the Security configuration.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSla | ( | self | ) |
Get the Service Level Agreement (SLA) configuration.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSourceRoute | ( | self, | |
destMacAddr | |||
) |
Get the Source Route for a specific Mote.
destMacAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getSystem | ( | self | ) |
Retrieves system-level information.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getTime | ( | self | ) |
Get the current time.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getUser | ( | self, | |
userName | |||
) |
Get the description of a user.
userName | 16-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_getUsers | ( | self | ) |
Get the list of users.
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.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_promoteToOperational | ( | self, | |
macAddr | |||
) |
Promote a quarantined device to operational.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_reset | ( | self, | |
object | |||
) |
Reset the system or network.
object | 25-byte field formatted as a string. This field can only take one of the following values:
|
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_resetWithId | ( | self, | |
object, | |||
moteId | |||
) |
Reset mote by ID.
object | 25-byte field formatted as a string. This field can only take one of the following values:
|
moteId | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_resetWithMac | ( | self, | |
object, | |||
macAddr | |||
) |
Reset mote by MAC address.
object | 25-byte field formatted as a string. This field can only take one of the following values:
|
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_sendRequest | ( | self, | |
macAddr, | |||
domain, | |||
priority, | |||
reliable, | |||
data | |||
) |
Send downstream (request) data.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
domain | 16-byte field formatted as a string. This field can only take one of the following values:
|
priority | 16-byte field formatted as a string. This field can only take one of the following values:
|
reliable | 0-byte field formatted as a bool. There is no restriction on the value of this field. |
data | None-byte field formatted as a hex. There is no restriction on the value of this field. |
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.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
domain | 16-byte field formatted as a string. This field can only take one of the following values:
|
priority | 16-byte field formatted as a string. This field can only take one of the following values:
|
reliable | 0-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. |
data | None-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setAcl | ( | self, | |
macAddr, | |||
joinKey | |||
) |
Add or update a device in the ACL.
macAddr | 25-byte field formatted as a string. There is no restriction on the value of this field. |
joinKey | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setBlacklist | ( | self, | |
frequency | |||
) |
Update the channel blacklist.
frequency | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setLicense | ( | self, | |
license | |||
) |
Set the software license key.
license | 40-byte field formatted as a string. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setMote | ( | self, | |
macAddr, | |||
name, | |||
enableRouting | |||
) |
Set mote configuration.
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. |
enableRouting | 1-byte field formatted as a bool. There is no restriction on the value of this field. |
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.
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:
|
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:
|
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setSecurity | ( | self, | |
securityMode, | |||
commonJoinKey, | |||
acceptHARTDevicesOnly | |||
) |
Set security configuration.
securityMode | 20-byte field formatted as a string. This field can only take one of the following values:
|
commonJoinKey | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
acceptHARTDevicesOnly | 1-byte field formatted as a bool. There is no restriction on the value of this field. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setSla | ( | self, | |
minNetReliability, | |||
maxNetLatency, | |||
minNetPathStability, | |||
apRdntCoverageThreshold | |||
) |
Set SLA configuration.
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. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setSystem | ( | self, | |
systemName, | |||
location, | |||
cliTimeout | |||
) |
Set system-level configuration.
systemName | 16-byte field formatted as a string. There is no restriction on the value of this field. |
location | 16-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. |
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.dn_setUser | ( | self, | |
userName, | |||
password, | |||
privilege | |||
) |
Add or update user configuration.
userName | 16-byte field formatted as a string. There is no restriction on the value of this field. |
password | 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:
|
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.
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.
retries | 1-byte field formatted as a int. There is no restriction on the value of this field. |
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'.
filter | 128-byte field formatted as a string. There is no restriction on the value of this field. |
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.
def SmartMeshSDK.HartMgrConnector.HartMgrConnector.HartMgrConnector.getNotification | ( | self, | |
timeoutSec = -1 |
|||
) |
Get a notification from the notification queue, and returns it properly formatted.
NotificationError | if unknown notification. |
|
static |
BOOTUP notification.
Formatted as a Tuple_BootUp named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.
|
static |
CLI notification.
Formatted as a Tuple_cli named tuple. It contains the following fields:
time
8-byte field formatted as a int.message
128-byte field formatted as a string.
|
static |
COMMANDFINISHED notification.
Formatted as a Tuple_CommandFinished named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.callbackId
4-byte field formatted as a int.objectType
32-byte field formatted as a string.macAddr
32-byte field formatted as a string.resultCode
4-byte field formatted as a int.
|
static |
CONFIGCHANGE notification.
Formatted as a Tuple_ConfigChange named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.objectType
32-byte field formatted as a string.objectId
32-byte field formatted as a string.
|
static |
DATA notification.
Formatted as a Tuple_data named tuple. It contains the following fields:
moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.time
8-byte field formatted as a int.payload
None-byte field formatted as a hex.payloadType
1-byte field formatted as a int.isReliable
1-byte field formatted as a bool.isRequest
1-byte field formatted as a bool.isBroadcast
1-byte field formatted as a bool.callbackId
4-byte field formatted as a int.counter
4-byte field formatted as a int.
|
static |
INVALIDMIC notification.
Formatted as a Tuple_InvalidMIC named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.
|
static |
LOCATION notification.
Formatted as a Tuple_Location named tuple. It contains the following fields:
ver
1-byte field formatted as a int.asn
8-byte field formatted as a int.src
32-byte field formatted as a string.dest
32-byte field formatted as a string.payload
None-byte field formatted as a hex.
|
static |
LOG notification.
Formatted as a Tuple_log named tuple. It contains the following fields:
time
8-byte field formatted as a int.severity
16-byte field formatted as a string.message
128-byte field formatted as a string.
|
static |
MANUALDCCRESET notification.
Formatted as a Tuple_ManualDccReset named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.
|
static |
MANUALMOTEDECOMMISSION notification.
Formatted as a Tuple_ManualMoteDecommission named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.
|
static |
MANUALMOTEDELETE notification.
Formatted as a Tuple_ManualMoteDelete named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.
|
static |
MANUALMOTERESET notification.
Formatted as a Tuple_ManualMoteReset named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.
|
static |
MANUALNETRESET notification.
Formatted as a Tuple_ManualNetReset named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.
|
static |
MANUALSTATRESET notification.
Formatted as a Tuple_ManualStatReset named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.userName
32-byte field formatted as a string.
|
static |
MOTEDISCONNECT notification.
Formatted as a Tuple_MoteDisconnect named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.
|
static |
MOTEJOIN notification.
Formatted as a Tuple_MoteJoin named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.userData
64-byte field formatted as a string.
|
static |
MOTEJOINFAILURE notification.
Formatted as a Tuple_MoteJoinFailure named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.
|
static |
MOTEJOINQUARANTINE notification.
Formatted as a Tuple_MoteJoinQuarantine named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.userData
64-byte field formatted as a string.
|
static |
MOTELIVE notification.
Formatted as a Tuple_MoteLive named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.
|
static |
MOTEQUARANTINE notification.
Formatted as a Tuple_MoteQuarantine named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.
|
static |
MOTEUNKNOWN notification.
Formatted as a Tuple_MoteUnknown named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.moteId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.reason
64-byte field formatted as a string.
|
static |
NETWORKRESET notification.
Formatted as a Tuple_NetworkReset named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.
|
static |
Dictionary of all notification tuples.
|
static |
PACKETSENT notification.
Formatted as a Tuple_PacketSent named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.callbackId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.
|
static |
PATHACTIVATE notification.
Formatted as a Tuple_PathActivate named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.pathId
4-byte field formatted as a int.moteAMac
32-byte field formatted as a string.moteBMac
32-byte field formatted as a string.
|
static |
PATHALERT notification.
Formatted as a Tuple_PathAlert named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.pathId
4-byte field formatted as a int.moteAMac
32-byte field formatted as a string.moteBMac
32-byte field formatted as a string.
|
static |
PATHCREATE notification.
Formatted as a Tuple_PathCreate named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.pathId
4-byte field formatted as a int.moteAMac
32-byte field formatted as a string.moteBMac
32-byte field formatted as a string.
|
static |
PATHDEACTIVATE notification.
Formatted as a Tuple_PathDeactivate named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.pathId
4-byte field formatted as a int.moteAMac
32-byte field formatted as a string.moteBMac
32-byte field formatted as a string.
|
static |
PATHDELETE notification.
Formatted as a Tuple_PathDelete named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.pathId
4-byte field formatted as a int.moteAMac
32-byte field formatted as a string.moteBMac
32-byte field formatted as a string.
|
static |
PINGREPLY notification.
Formatted as a Tuple_PingReply named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.callbackId
4-byte field formatted as a int.latency
4-byte field formatted as a int.temperature
8-byte field formatted as a float.voltage
8-byte field formatted as a float.hopCount
4-byte field formatted as a int.
|
static |
PIPEOFF notification.
Formatted as a Tuple_PipeOff named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.
|
static |
PIPEON notification.
Formatted as a Tuple_PipeOn named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.macAddr
32-byte field formatted as a string.allocatedPipePkPeriod
4-byte field formatted as a int.
|
static |
SERVICEDENIED notification.
Formatted as a Tuple_ServiceDenied named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.serviceId
4-byte field formatted as a int.requestingMacAddr
32-byte field formatted as a string.peerMacAddr
32-byte field formatted as a string.appDomain
32-byte field formatted as a string.isSource
1-byte field formatted as a bool.isSink
1-byte field formatted as a bool.isIntermittent
1-byte field formatted as a bool.period
4-byte field formatted as a int.
|
static |
STDMOTEREPORT notification.
Formatted as a Tuple_stdMoteReport named tuple. It contains the following fields:
time
8-byte field formatted as a int.macAddr
16-byte field formatted as a string.payload
None-byte field formatted as a hex.
|
static |
TRANSPORTTIMEOUT notification.
Formatted as a Tuple_TransportTimeout named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.srcMacAddr
32-byte field formatted as a string.destMacAddr
32-byte field formatted as a string.timeoutType
32-byte field formatted as a string.callbackId
4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_activateAdvertising() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_activateFastPipe() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_cancelOtap() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_cli() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_deactivateFastPipe() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_decommissionDevice() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_exchangeJoinKey() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeMoteJoinKey() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeMoteNetworkId() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeNetworkId() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeNetworkKey() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeSessionKey() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getAcl() function.
macAddr
: 25-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getAcls() function.
macAddr
: 25-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getBlacklist() function.
frequency
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getLatency() function.
downstream
: 4-byte field formatted as a int.upstream
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getLicense() function.
license
: 40-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getMote() function.
moteId
: 4-byte field formatted as a int.macAddr
: 25-byte field formatted as a string.name
: 16-byte field formatted as a string.state
: 16-byte field formatted as a string.numJoins
: 4-byte field formatted as a int.joinTime
: 8-byte field formatted as a int.reason
: 16-byte field formatted as a string.isAccessPoint
: 1-byte field formatted as a bool.powerSource
: 16-byte field formatted as a string.dischargeCurrent
: 4-byte field formatted as a int.dischargeTime
: 4-byte field formatted as a int.recoveryTime
: 4-byte field formatted as a int.enableRouting
: 1-byte field formatted as a bool.productName
: 16-byte field formatted as a string.hwModel
: 1-byte field formatted as a int.hwRev
: 1-byte field formatted as a int.swRev
: 16-byte field formatted as a string.voltage
: 8-byte field formatted as a float.numNeighbors
: 4-byte field formatted as a int.needNeighbor
: 1-byte field formatted as a bool.goodNeighbors
: 4-byte field formatted as a int.allocatedPkPeriod
: 4-byte field formatted as a int.allocatedPipePkPeriod
: 4-byte field formatted as a int.pipeStatus
: 4-byte field formatted as a string.advertisingStatus
: 4-byte field formatted as a string.locationTag
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getMotes() function.
moteId
: 4-byte field formatted as a int.macAddr
: 25-byte field formatted as a string.name
: 16-byte field formatted as a string.state
: 16-byte field formatted as a string.numJoins
: 4-byte field formatted as a int.joinTime
: 8-byte field formatted as a int.reason
: 16-byte field formatted as a string.isAccessPoint
: 1-byte field formatted as a bool.powerSource
: 16-byte field formatted as a string.dischargeCurrent
: 4-byte field formatted as a int.dischargeTime
: 4-byte field formatted as a int.recoveryTime
: 4-byte field formatted as a int.enableRouting
: 1-byte field formatted as a bool.productName
: 16-byte field formatted as a string.hwModel
: 1-byte field formatted as a int.hwRev
: 1-byte field formatted as a int.swRev
: 16-byte field formatted as a string.voltage
: 8-byte field formatted as a float.numNeighbors
: 4-byte field formatted as a int.needNeighbor
: 1-byte field formatted as a bool.goodNeighbors
: 4-byte field formatted as a int.allocatedPkPeriod
: 4-byte field formatted as a int.allocatedPipePkPeriod
: 4-byte field formatted as a int.pipeStatus
: 4-byte field formatted as a string.advertisingStatus
: 4-byte field formatted as a string.locationTag
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getMoteStatistics() function.
index
: 4-byte field formatted as a int.startTime
: 8-byte field formatted as a int.avgLatency
: 4-byte field formatted as a int.reliability
: 0-byte field formatted as a float.numJoins
: 4-byte field formatted as a int.voltage
: 4-byte field formatted as a float.chargeConsumption
: 4-byte field formatted as a int.temperature
: 4-byte field formatted as a float.numLostPackets
: 4-byte field formatted as a int.latencyToMote
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getNetwork() function.
netName
: 16-byte field formatted as a string.networkId
: 4-byte field formatted as a int.maxMotes
: 4-byte field formatted as a int.numMotes
: 4-byte field formatted as a int.optimizationEnable
: 1-byte field formatted as a bool.accessPointPA
: 1-byte field formatted as a bool.ccaEnabled
: 1-byte field formatted as a bool.requestedBasePkPeriod
: 4-byte field formatted as a int.minServicesPkPeriod
: 4-byte field formatted as a int.minPipePkPeriod
: 4-byte field formatted as a int.bandwidthProfile
: 16-byte field formatted as a string.manualUSFrameSize
: 4-byte field formatted as a int.manualDSFrameSize
: 4-byte field formatted as a int.manualAdvFrameSize
: 4-byte field formatted as a int.netQueueSize
: 4-byte field formatted as a int.userQueueSize
: 4-byte field formatted as a int.locationMode
: 16-byte field formatted as a string.backboneEnabled
: 1-byte field formatted as a bool.backboneSize
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getNetworkStatistics() function.
index
: 4-byte field formatted as a int.startTime
: 8-byte field formatted as a int.netLatency
: 4-byte field formatted as a int.netReliability
: 0-byte field formatted as a float.netPathStability
: 0-byte field formatted as a float.lostUpstreamPackets
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getOpenAlarms() function.
timeStamp
: 4-byte field formatted as a int.eventId
: 4-byte field formatted as a int.alarmType
: 32-byte field formatted as a string.macAddr
: 25-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getPaths() function.
pathId
: 4-byte field formatted as a int.moteAMac
: 25-byte field formatted as a string.moteBMac
: 25-byte field formatted as a string.numLinks
: 4-byte field formatted as a int.pathDirection
: 16-byte field formatted as a string.pathQuality
: 0-byte field formatted as a float.
|
static |
The named tuple returned by the dn_getPathStatistics() function.
index
: 4-byte field formatted as a int.startTime
: 8-byte field formatted as a int.baPwr
: 1-byte field formatted as a int.abPwr
: 1-byte field formatted as a int.stability
: 8-byte field formatted as a float.
|
static |
The named tuple returned by the dn_getRedundancy() function.
localMode
: 16-byte field formatted as a string.peerStatus
: 16-byte field formatted as a string.peerControllerSwRev
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getSecurity() function.
securityMode
: 20-byte field formatted as a string.acceptHARTDevicesOnly
: 1-byte field formatted as a bool.
|
static |
The named tuple returned by the dn_getSla() function.
minNetReliability
: 8-byte field formatted as a float.maxNetLatency
: 4-byte field formatted as a int.minNetPathStability
: 8-byte field formatted as a float.apRdntCoverageThreshold
: 8-byte field formatted as a float.
|
static |
The named tuple returned by the dn_getSourceRoute() function.
destMacAddr
: 25-byte field formatted as a string.primaryPath
: 16-byte field formatted as a list.secondaryPath
: 16-byte field formatted as a list.
|
static |
The named tuple returned by the dn_getSystem() function.
systemName
: 32-byte field formatted as a string.location
: 32-byte field formatted as a string.swRev
: 32-byte field formatted as a string.hwModel
: 32-byte field formatted as a string.hwRev
: 32-byte field formatted as a string.serialNumber
: 32-byte field formatted as a string.time
: 8-byte field formatted as a int.startTime
: 8-byte field formatted as a int.cliTimeout
: 4-byte field formatted as a int.controllerSwRev
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getTime() function.
utc_time
: 0-byte field formatted as a float.asn_time
: 8-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getUser() function.
userName
: 16-byte field formatted as a string.privilege
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_getUsers() function.
userName
: 16-byte field formatted as a string.privilege
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_pingMote() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_promoteToOperational() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_reset() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_resetWithId() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_resetWithMac() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_sendRequest() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_sendResponse() function.
callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setAcl() function.
macAddr
: 25-byte field formatted as a string.
|
static |
The named tuple returned by the dn_setBlacklist() function.
frequency
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setLicense() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_setMote() function.
moteId
: 4-byte field formatted as a int.macAddr
: 25-byte field formatted as a string.name
: 16-byte field formatted as a string.state
: 16-byte field formatted as a string.numJoins
: 4-byte field formatted as a int.joinTime
: 8-byte field formatted as a int.reason
: 16-byte field formatted as a string.isAccessPoint
: 1-byte field formatted as a bool.powerSource
: 16-byte field formatted as a string.dischargeCurrent
: 4-byte field formatted as a int.dischargeTime
: 4-byte field formatted as a int.recoveryTime
: 4-byte field formatted as a int.enableRouting
: 1-byte field formatted as a bool.productName
: 16-byte field formatted as a string.hwModel
: 1-byte field formatted as a int.hwRev
: 1-byte field formatted as a int.swRev
: 16-byte field formatted as a string.voltage
: 8-byte field formatted as a float.numNeighbors
: 4-byte field formatted as a int.needNeighbor
: 1-byte field formatted as a bool.goodNeighbors
: 4-byte field formatted as a int.allocatedPkPeriod
: 4-byte field formatted as a int.allocatedPipePkPeriod
: 4-byte field formatted as a int.pipeStatus
: 4-byte field formatted as a string.advertisingStatus
: 4-byte field formatted as a string.locationTag
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_setNetwork() function.
netName
: 16-byte field formatted as a string.networkId
: 4-byte field formatted as a int.maxMotes
: 4-byte field formatted as a int.optimizationEnable
: 1-byte field formatted as a bool.accessPointPA
: 1-byte field formatted as a bool.ccaEnabled
: 1-byte field formatted as a bool.requestedBasePkPeriod
: 4-byte field formatted as a int.minServicesPkPeriod
: 4-byte field formatted as a int.minPipePkPeriod
: 4-byte field formatted as a int.bandwidthProfile
: 16-byte field formatted as a string.manualUSFrameSize
: 4-byte field formatted as a int.manualDSFrameSize
: 4-byte field formatted as a int.manualAdvFrameSize
: 4-byte field formatted as a int.locationMode
: 8-byte field formatted as a string.backboneEnabled
: 1-byte field formatted as a bool.backboneSize
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setSecurity() function.
securityMode
: 20-byte field formatted as a string.acceptHARTDevicesOnly
: 1-byte field formatted as a bool.
|
static |
The named tuple returned by the dn_setSla() function.
minNetReliability
: 8-byte field formatted as a float.maxNetLatency
: 4-byte field formatted as a int.minNetPathStability
: 8-byte field formatted as a float.apRdntCoverageThreshold
: 8-byte field formatted as a float.
|
static |
The named tuple returned by the dn_setSystem() function.
systemName
: 50-byte field formatted as a string.location
: 50-byte field formatted as a string.cliTimeout
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setUser() function.
userName
: 16-byte field formatted as a string.privilege
: 16-byte field formatted as a string.
|
static |
The named tuple returned by the dn_startOtap() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_startOtapWithRetries() function.
result
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_subscribe() function.
notif_token
: 32-byte field formatted as a string.
|
static |
The named tuple returned by the dn_unsubscribe() function.
result
: 32-byte field formatted as a string.
|
static |
USERCONNECT notification.
Formatted as a Tuple_UserConnect named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.channel
16-byte field formatted as a string.ipAddr
16-byte field formatted as a string.userName
32-byte field formatted as a string.
|
static |
USERDISCONNECT notification.
Formatted as a Tuple_UserDisconnect named tuple. It contains the following fields:
timeStamp
8-byte field formatted as a int.eventId
4-byte field formatted as a int.channel
16-byte field formatted as a string.ipAddr
16-byte field formatted as a string.userName
32-byte field formatted as a string.
|
static |
VENDORMOTEREPORT notification.
Formatted as a Tuple_vendorMoteReport named tuple. It contains the following fields:
time
8-byte field formatted as a int.macAddr
16-byte field formatted as a string.payload
None-byte field formatted as a hex.