![]() |
SmartMeshSDK
|
Public class for IP manager connector, over SerialMux. More...
Public Member Functions | |
def | dn_mux_hello |
Sent by the manager to initiate a new session with a client. More... | |
def | dn_hello |
def | dn_hello_response |
def | dn_reset |
The reset command is used to reset various objects. More... | |
def | dn_subscribe |
The subscribe command indicates that the manager should send the external application the specified notifications. More... | |
def | dn_getTime |
The getTime command returns the current manager UTC time and current absolute slot number (ASN). More... | |
def | dn_setNetworkConfig |
The setNetworkConfig command changes network configuration parameters. More... | |
def | dn_clearStatistics |
The clearStatistics command clears the accumulated network statistics. More... | |
def | dn_exchangeMoteJoinKey |
The exchangeMoteJoinKey command triggers the manager to send a new join key to the specified mote and update the manager's ACL entry for the mote. More... | |
def | dn_exchangeNetworkId |
The exchangeNetworkId command triggers the manager to distribute a new network ID to all the motes in the network. More... | |
def | dn_radiotestTx |
The radiotestTx command allows the user to initiate a radio transmission test. More... | |
def | dn_radiotestRx |
The radiotestRx command clears all previously collected statistics and initiates radio reception on the specified channel. More... | |
def | dn_getRadiotestStatistics |
This command retrieves statistics from a previously run radiotestRx command.It may only be executed if the manager has been booted up in radiotest mode (see setNetworkConfig command). More... | |
def | dn_setACLEntry |
The setACLEntry command adds a new entry or updates an existing entry in the Access Control List (ACL).This change is persistent. More... | |
def | dn_getNextACLEntry |
The getNextACLEntry command returns information about next mote entry in the access control list (ACL). More... | |
def | dn_deleteACLEntry |
The deleteACLEntry command deletes the specified mote from the access control list (ACL). More... | |
def | dn_pingMote |
The pingMote command sends a ping (echo request) to the mote specified by MAC address. More... | |
def | dn_getLog |
The getLog command retrieves diagnostic logs from the manager or a mote specified by MAC address. More... | |
def | dn_sendData |
The sendData command sends a packet to a mote in the network. More... | |
def | dn_startNetwork |
The startNetwork command tells the manager to allow the network to start forming (begin accepting join requests from devices). More... | |
def | dn_getSystemInfo |
The getSystemInfo command returns system-level information about the hardware and software versions. More... | |
def | dn_getMoteConfig |
The getMoteConfig command returns a single mote description as the response. More... | |
def | dn_getPathInfo |
The getPathInfo command returns parameters of requested path. More... | |
def | dn_getNextPathInfo |
The getNextPathInfo command allows iteration across paths connected to a particular mote. More... | |
def | dn_setAdvertising |
The setAdvertising command tells the manager to activate or deactivate advertising. More... | |
def | dn_setDownstreamFrameMode |
The setDownstreamFrameMode command tells the manager to shorten or extend the downstream slotframe. More... | |
def | dn_getManagerStatistics |
The getManagerStatistics command returns dynamic information and statistics about the manager API. More... | |
def | dn_setTime |
This command has been deprecated, and should not be used in new designs. More... | |
def | dn_getLicense |
The getLicense command has been deprecated in Manager >= 1.3.0.There is no need to use a license to enable > 32 mote networks. More... | |
def | dn_setLicense |
The setLicense command has been deprecated in Manager >= 1.3.0. More... | |
def | dn_setCLIUser |
The setCLIUser command sets the password that must be used to log into the command line for a particular user role. More... | |
def | dn_sendIP |
The sendIP command sends a 6LoWPAN packet to a mote in the network. More... | |
def | dn_restoreFactoryDefaults |
The restoreFactoryDefaults command restores the default configuration and clears the ACL. More... | |
def | dn_getMoteInfo |
The getMoteInfo command returns dynamic information for the specified mote. More... | |
def | dn_getNetworkConfig |
The getNetworkConfig command returns general network configuration parameters, including the Network ID, bandwidth parameters and number of motes. More... | |
def | dn_getNetworkInfo |
The getNetworkInfo command returns dynamic network information and statistics. More... | |
def | dn_getMoteConfigById |
The getMoteConfigById command returns a single mote description as the response. More... | |
def | dn_setCommonJoinKey |
The setCommonJoinKey command will set a new value for the common join key. More... | |
def | dn_getIPConfig |
The getIPConfig command returns the manager's IP configuration parameters, including the IPv6 address and mask. More... | |
def | dn_setIPConfig |
The setIPConfig command sets the IPv6 prefix of the mesh network. More... | |
def | dn_deleteMote |
The deleteMote command deletes a mote from the manager's list. More... | |
def | dn_getMoteLinks |
The getMoteLinks command returns information about links assigned to the mote. More... | |
def | getNotification |
Get a notification from the notification queue, and returns it properly formatted. More... | |
Static Public Attributes | |
tuple | Tuple_dn_mux_hello = collections.namedtuple("Tuple_dn_mux_hello", ['RC', 'version']) |
The named tuple returned by the dn_mux_hello() function. More... | |
tuple | Tuple_dn_hello_response = collections.namedtuple("Tuple_dn_hello_response", ['successCode', 'version', 'mgrSeqNo', 'cliSeqNo', 'mode']) |
The named tuple returned by the dn_hello_response() function. More... | |
tuple | Tuple_dn_reset = collections.namedtuple("Tuple_dn_reset", ['RC', 'macAddress']) |
The named tuple returned by the dn_reset() function. More... | |
tuple | Tuple_dn_subscribe = collections.namedtuple("Tuple_dn_subscribe", ['RC']) |
The named tuple returned by the dn_subscribe() function. More... | |
tuple | Tuple_dn_getTime = collections.namedtuple("Tuple_dn_getTime", ['RC', 'uptime', 'utcSecs', 'utcUsecs', 'asn', 'asnOffset']) |
The named tuple returned by the dn_getTime() function. More... | |
tuple | Tuple_dn_setNetworkConfig = collections.namedtuple("Tuple_dn_setNetworkConfig", ['RC']) |
The named tuple returned by the dn_setNetworkConfig() function. More... | |
tuple | Tuple_dn_clearStatistics = collections.namedtuple("Tuple_dn_clearStatistics", ['RC']) |
The named tuple returned by the dn_clearStatistics() function. More... | |
tuple | Tuple_dn_exchangeMoteJoinKey = collections.namedtuple("Tuple_dn_exchangeMoteJoinKey", ['RC', 'callbackId']) |
The named tuple returned by the dn_exchangeMoteJoinKey() function. More... | |
tuple | Tuple_dn_exchangeNetworkId = collections.namedtuple("Tuple_dn_exchangeNetworkId", ['RC', 'callbackId']) |
The named tuple returned by the dn_exchangeNetworkId() function. More... | |
tuple | Tuple_dn_radiotestTx = collections.namedtuple("Tuple_dn_radiotestTx", ['RC']) |
The named tuple returned by the dn_radiotestTx() function. More... | |
tuple | Tuple_dn_radiotestRx = collections.namedtuple("Tuple_dn_radiotestRx", ['RC']) |
The named tuple returned by the dn_radiotestRx() function. More... | |
tuple | Tuple_dn_getRadiotestStatistics = collections.namedtuple("Tuple_dn_getRadiotestStatistics", ['RC', 'rxOk', 'rxFail']) |
The named tuple returned by the dn_getRadiotestStatistics() function. More... | |
tuple | Tuple_dn_setACLEntry = collections.namedtuple("Tuple_dn_setACLEntry", ['RC']) |
The named tuple returned by the dn_setACLEntry() function. More... | |
tuple | Tuple_dn_getNextACLEntry = collections.namedtuple("Tuple_dn_getNextACLEntry", ['RC', 'macAddress', 'joinKey']) |
The named tuple returned by the dn_getNextACLEntry() function. More... | |
tuple | Tuple_dn_deleteACLEntry = collections.namedtuple("Tuple_dn_deleteACLEntry", ['RC']) |
The named tuple returned by the dn_deleteACLEntry() function. More... | |
tuple | Tuple_dn_pingMote = collections.namedtuple("Tuple_dn_pingMote", ['RC', 'callbackId']) |
The named tuple returned by the dn_pingMote() function. More... | |
tuple | Tuple_dn_getLog = collections.namedtuple("Tuple_dn_getLog", ['RC']) |
The named tuple returned by the dn_getLog() function. More... | |
tuple | Tuple_dn_sendData = collections.namedtuple("Tuple_dn_sendData", ['RC', 'callbackId']) |
The named tuple returned by the dn_sendData() function. More... | |
tuple | Tuple_dn_startNetwork = collections.namedtuple("Tuple_dn_startNetwork", ['RC']) |
The named tuple returned by the dn_startNetwork() function. More... | |
tuple | Tuple_dn_getSystemInfo = collections.namedtuple("Tuple_dn_getSystemInfo", ['RC', 'macAddress', 'hwModel', 'hwRev', 'swMajor', 'swMinor', 'swPatch', 'swBuild']) |
The named tuple returned by the dn_getSystemInfo() function. More... | |
tuple | Tuple_dn_getMoteConfig = collections.namedtuple("Tuple_dn_getMoteConfig", ['RC', 'macAddress', 'moteId', 'isAP', 'state', 'reserved', 'isRouting']) |
The named tuple returned by the dn_getMoteConfig() function. More... | |
tuple | Tuple_dn_getPathInfo = collections.namedtuple("Tuple_dn_getPathInfo", ['RC', 'source', 'dest', 'direction', 'numLinks', 'quality', 'rssiSrcDest', 'rssiDestSrc']) |
The named tuple returned by the dn_getPathInfo() function. More... | |
tuple | Tuple_dn_getNextPathInfo = collections.namedtuple("Tuple_dn_getNextPathInfo", ['RC', 'pathId', 'source', 'dest', 'direction', 'numLinks', 'quality', 'rssiSrcDest', 'rssiDestSrc']) |
The named tuple returned by the dn_getNextPathInfo() function. More... | |
tuple | Tuple_dn_setAdvertising = collections.namedtuple("Tuple_dn_setAdvertising", ['RC', 'callbackId']) |
The named tuple returned by the dn_setAdvertising() function. More... | |
tuple | Tuple_dn_setDownstreamFrameMode = collections.namedtuple("Tuple_dn_setDownstreamFrameMode", ['RC', 'callbackId']) |
The named tuple returned by the dn_setDownstreamFrameMode() function. More... | |
tuple | Tuple_dn_getManagerStatistics = collections.namedtuple("Tuple_dn_getManagerStatistics", ['RC', 'serTxCnt', 'serRxCnt', 'serRxCRCErr', 'serRxOverruns', 'apiEstabConn', 'apiDroppedConn', 'apiTxOk', 'apiTxErr', 'apiTxFail', 'apiRxOk', 'apiRxProtErr']) |
The named tuple returned by the dn_getManagerStatistics() function. More... | |
tuple | Tuple_dn_setTime = collections.namedtuple("Tuple_dn_setTime", ['RC']) |
The named tuple returned by the dn_setTime() function. More... | |
tuple | Tuple_dn_getLicense = collections.namedtuple("Tuple_dn_getLicense", ['RC', 'license']) |
The named tuple returned by the dn_getLicense() function. More... | |
tuple | Tuple_dn_setLicense = collections.namedtuple("Tuple_dn_setLicense", ['RC']) |
The named tuple returned by the dn_setLicense() function. More... | |
tuple | Tuple_dn_setCLIUser = collections.namedtuple("Tuple_dn_setCLIUser", ['RC']) |
The named tuple returned by the dn_setCLIUser() function. More... | |
tuple | Tuple_dn_sendIP = collections.namedtuple("Tuple_dn_sendIP", ['RC', 'callbackId']) |
The named tuple returned by the dn_sendIP() function. More... | |
tuple | Tuple_dn_restoreFactoryDefaults = collections.namedtuple("Tuple_dn_restoreFactoryDefaults", ['RC']) |
The named tuple returned by the dn_restoreFactoryDefaults() function. More... | |
tuple | Tuple_dn_getMoteInfo = collections.namedtuple("Tuple_dn_getMoteInfo", ['RC', 'macAddress', 'state', 'numNbrs', 'numGoodNbrs', 'requestedBw', 'totalNeededBw', 'assignedBw', 'packetsReceived', 'packetsLost', 'avgLatency']) |
The named tuple returned by the dn_getMoteInfo() function. More... | |
tuple | Tuple_dn_getNetworkConfig = collections.namedtuple("Tuple_dn_getNetworkConfig", ['RC', 'networkId', 'apTxPower', 'frameProfile', 'maxMotes', 'baseBandwidth', 'downFrameMultVal', 'numParents', 'ccaMode', 'channelList', 'autoStartNetwork', 'locMode', 'bbMode', 'bbSize', 'isRadioTest', 'bwMult', 'oneChannel']) |
The named tuple returned by the dn_getNetworkConfig() function. More... | |
tuple | Tuple_dn_getNetworkInfo = collections.namedtuple("Tuple_dn_getNetworkInfo", ['RC', 'numMotes', 'asnSize', 'advertisementState', 'downFrameState', 'netReliability', 'netPathStability', 'netLatency', 'netState', 'ipv6Address', 'numLostPackets', 'numArrivedPackets', 'maxNumbHops']) |
The named tuple returned by the dn_getNetworkInfo() function. More... | |
tuple | Tuple_dn_getMoteConfigById = collections.namedtuple("Tuple_dn_getMoteConfigById", ['RC', 'macAddress', 'moteId', 'isAP', 'state', 'reserved', 'isRouting']) |
The named tuple returned by the dn_getMoteConfigById() function. More... | |
tuple | Tuple_dn_setCommonJoinKey = collections.namedtuple("Tuple_dn_setCommonJoinKey", ['RC']) |
The named tuple returned by the dn_setCommonJoinKey() function. More... | |
tuple | Tuple_dn_getIPConfig = collections.namedtuple("Tuple_dn_getIPConfig", ['RC', 'ipv6Address', 'mask']) |
The named tuple returned by the dn_getIPConfig() function. More... | |
tuple | Tuple_dn_setIPConfig = collections.namedtuple("Tuple_dn_setIPConfig", ['RC']) |
The named tuple returned by the dn_setIPConfig() function. More... | |
tuple | Tuple_dn_deleteMote = collections.namedtuple("Tuple_dn_deleteMote", ['RC']) |
The named tuple returned by the dn_deleteMote() function. More... | |
tuple | Tuple_dn_getMoteLinks = collections.namedtuple("Tuple_dn_getMoteLinks", ['RC', 'idx', 'utilization', 'numLinks', 'frameId_1', 'slot_1', 'channelOffset_1', 'moteId_1', 'flags_1', 'frameId_2', 'slot_2', 'channelOffset_2', 'moteId_2', 'flags_2', 'frameId_3', 'slot_3', 'channelOffset_3', 'moteId_3', 'flags_3', 'frameId_4', 'slot_4', 'channelOffset_4', 'moteId_4', 'flags_4', 'frameId_5', 'slot_5', 'channelOffset_5', 'moteId_5', 'flags_5', 'frameId_6', 'slot_6', 'channelOffset_6', 'moteId_6', 'flags_6', 'frameId_7', 'slot_7', 'channelOffset_7', 'moteId_7', 'flags_7', 'frameId_8', 'slot_8', 'channelOffset_8', 'moteId_8', 'flags_8', 'frameId_9', 'slot_9', 'channelOffset_9', 'moteId_9', 'flags_9', 'frameId_10', 'slot_10', 'channelOffset_10', 'moteId_10', 'flags_10']) |
The named tuple returned by the dn_getMoteLinks() function. More... | |
dictionary | notifTupleTable = {} |
Dictionary of all notification tuples. More... | |
string | MANAGER_HELLO = "manager_hello" |
MANAGER_HELLO notification. More... | |
string | EVENTMOTERESET = "eventMoteReset" |
EVENTMOTERESET notification. More... | |
string | EVENTNETWORKRESET = "eventNetworkReset" |
EVENTNETWORKRESET notification. More... | |
string | EVENTCOMMANDFINISHED = "eventCommandFinished" |
EVENTCOMMANDFINISHED notification. More... | |
string | EVENTMOTEJOIN = "eventMoteJoin" |
EVENTMOTEJOIN notification. More... | |
string | EVENTMOTEOPERATIONAL = "eventMoteOperational" |
EVENTMOTEOPERATIONAL notification. More... | |
string | EVENTMOTELOST = "eventMoteLost" |
EVENTMOTELOST notification. More... | |
string | EVENTNETWORKTIME = "eventNetworkTime" |
EVENTNETWORKTIME notification. More... | |
string | EVENTPINGRESPONSE = "eventPingResponse" |
EVENTPINGRESPONSE notification. More... | |
string | EVENTPATHCREATE = "eventPathCreate" |
EVENTPATHCREATE notification. More... | |
string | EVENTPATHDELETE = "eventPathDelete" |
EVENTPATHDELETE notification. More... | |
string | EVENTPACKETSENT = "eventPacketSent" |
EVENTPACKETSENT notification. More... | |
string | EVENTMOTECREATE = "eventMoteCreate" |
EVENTMOTECREATE notification. More... | |
string | EVENTMOTEDELETE = "eventMoteDelete" |
EVENTMOTEDELETE notification. More... | |
string | NOTIFLOG = "notifLog" |
NOTIFLOG notification. More... | |
string | NOTIFDATA = "notifData" |
NOTIFDATA notification. More... | |
string | NOTIFIPDATA = "notifIpData" |
NOTIFIPDATA notification. More... | |
string | NOTIFHEALTHREPORT = "notifHealthReport" |
NOTIFHEALTHREPORT notification. More... | |
Public class for IP manager connector, over SerialMux.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_clearStatistics | ( | self | ) |
The clearStatistics command clears the accumulated network statistics.
The command does not clear path quality or mote statistics.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_deleteACLEntry | ( | self, | |
macAddress | |||
) |
The deleteACLEntry command deletes the specified mote from the access control list (ACL).
If the macAddress parameter is set to all 0xFFs or all 0x00s, the entire ACL is cleared. This change is persistent.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_deleteMote | ( | self, | |
macAddress | |||
) |
The deleteMote command deletes a mote from the manager's list.
A mote can only be deleted if it in the Lost or Unknown states. This change is persistent.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_exchangeMoteJoinKey | ( | self, | |
macAddress, | |||
key | |||
) |
The exchangeMoteJoinKey command triggers the manager to send a new join key to the specified mote and update the manager's ACL entry for the mote.
The response contains a callbackId. A commandFinished event notification with this callbackId will be sent when the operation is complete. This change is persistent.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
key | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_exchangeNetworkId | ( | self, | |
id | |||
) |
The exchangeNetworkId command triggers the manager to distribute a new network ID to all the motes in the network.
A callbackId is returned in the response. A commandFinished notification with this callbackId will be sent when the operation is complete.This change is persistent.
id | 2-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getIPConfig | ( | self | ) |
The getIPConfig command returns the manager's IP configuration parameters, including the IPv6 address and mask.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getLicense | ( | self | ) |
The getLicense command has been deprecated in Manager >= 1.3.0.There is no need to use a license to enable > 32 mote networks.
The getLicense command returns the current license key.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getLog | ( | self, | |
macAddress | |||
) |
The getLog command retrieves diagnostic logs from the manager or a mote specified by MAC address.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getManagerStatistics | ( | self | ) |
The getManagerStatistics command returns dynamic information and statistics about the manager API.
The statistics counts are cleared together with all current statistics using clearStatistics.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getMoteConfig | ( | self, | |
macAddress, | |||
next | |||
) |
The getMoteConfig command returns a single mote description as the response.
The command takes two arguments, a MAC Address and a flag indicating whether the MAC Address refers to the requested mote or to the next mote in managers memory. This command may be used to iterate through all motes known by the manager by starting with the macAddress parameter set to 0 and next set to true, and then using the MAC Address of that response as the input to the next call.
The mote MAC address is used in all query commands, but space constraints require the neighbor health reports to use the Mote ID for identification. Therefore, both identifiers are present in the mote structure.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
next | 1-byte field formatted as a bool. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getMoteConfigById | ( | self, | |
moteId | |||
) |
The getMoteConfigById command returns a single mote description as the response.
The command takes one argument, the short address of a mote (Mote ID). The command returns the same response structure as the getMoteConfig command.
moteId | 2-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getMoteInfo | ( | self, | |
macAddress | |||
) |
The getMoteInfo command returns dynamic information for the specified mote.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getMoteLinks | ( | self, | |
macAddress, | |||
idx | |||
) |
The getMoteLinks command returns information about links assigned to the mote.
The response contains a list of links starting with Nth link on the mote, where N is supplied as the idx parameter in the request. To retrieve all links on the device the user can call this command with idx that increments by number of links returned with priorresponse, until the command returns RC_END_OF_LIST response code. Note that links assigned to a mote may change between API calls.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
idx | 2-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getNetworkConfig | ( | self | ) |
The getNetworkConfig command returns general network configuration parameters, including the Network ID, bandwidth parameters and number of motes.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getNetworkInfo | ( | self | ) |
The getNetworkInfo command returns dynamic network information and statistics.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getNextACLEntry | ( | self, | |
macAddress | |||
) |
The getNextACLEntry command returns information about next mote entry in the access control list (ACL).
To begin a search (find the first mote in ACL), a zero MAC address (0000000000000000) should be sent. There is no mechanism for reading the ACL entry of a specific mote. This call is an iterator. If you call getNextACLEntry with mote A as the argument, your response is the ACL entry for mote B, where B is the next mote in the ACL.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getNextPathInfo | ( | self, | |
macAddress, | |||
filter, | |||
pathId | |||
) |
The getNextPathInfo command allows iteration across paths connected to a particular mote.
The pathId parameter indicates the previous value in the iteration. Setting pathId to 0 returns the first path. A pathId can not be used as a unique identifier for a path. It is only valid when associated with a particular mote.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
filter | 1-byte field formatted as a int. This field can only take one of the following values:
|
pathId | 2-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getPathInfo | ( | self, | |
source, | |||
dest | |||
) |
The getPathInfo command returns parameters of requested path.
source | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
dest | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getRadiotestStatistics | ( | self | ) |
This command retrieves statistics from a previously run radiotestRx command.It may only be executed if the manager has been booted up in radiotest mode (see setNetworkConfig command).
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getSystemInfo | ( | self | ) |
The getSystemInfo command returns system-level information about the hardware and software versions.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_getTime | ( | self | ) |
The getTime command returns the current manager UTC time and current absolute slot number (ASN).
The time values returned by this command are delayed by queuing and transfer time over the serial connection. For additional precision, an external application should trigger the networkTime notification using the Time Pin.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_hello | ( | self, | |
version, | |||
cliSeqNo, | |||
mode | |||
) |
version | 1-byte field formatted as a int. There is no restriction on the value of this field. |
cliSeqNo | 1-byte field formatted as a int. There is no restriction on the value of this field. |
mode | 1-byte field formatted as a int. This field can only take one of the following values:
|
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_hello_response | ( | self | ) |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_mux_hello | ( | self, | |
version, | |||
secret | |||
) |
Sent by the manager to initiate a new session with a client.
version | 1-byte field formatted as a int. There is no restriction on the value of this field. |
secret | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_pingMote | ( | self, | |
macAddress | |||
) |
The pingMote command sends a ping (echo request) to the mote specified by MAC address.
A unique callbackId is generated and returned with the response. When the response is received from the mote, the manager generates a pingResponse notification with the measured round trip delay and several other parameters. The request is sent using unacknowledged transport, so the mote is not guaranteed to receive the request.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_radiotestRx | ( | self, | |
mask, | |||
duration, | |||
stationId | |||
) |
The radiotestRx command clears all previously collected statistics and initiates radio reception on the specified channel.
It may only be executed if the manager has been booted up in radiotest mode (see setNetworkConfig command). During the test, the device keeps statistics about the number of packets received (with and without error). The test results may be retrieved using the getRadiotestStatistics command.
The station ID is a user selectable value. It must be set to match the station ID used by the transmitter. Station ID is used to isolate traffic if multiple tests are running in the same radio space.
Channel numbering is 0-15, corresponding to IEEE 2.4 GHz channels 11-26.
mask | 2-byte field formatted as a hex. There is no restriction on the value of this field. |
duration | 2-byte field formatted as a int. There is no restriction on the value of this field. |
stationId | 1-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_radiotestTx | ( | self, | |
testType, | |||
chanMask, | |||
repeatCnt, | |||
txPower, | |||
seqSize, | |||
pkLen_1, | |||
delay_1, | |||
pkLen_2, | |||
delay_2, | |||
pkLen_3, | |||
delay_3, | |||
pkLen_4, | |||
delay_4, | |||
pkLen_5, | |||
delay_5, | |||
pkLen_6, | |||
delay_6, | |||
pkLen_7, | |||
delay_7, | |||
pkLen_8, | |||
delay_8, | |||
pkLen_9, | |||
delay_9, | |||
pkLen_10, | |||
delay_10, | |||
stationId | |||
) |
The radiotestTx command allows the user to initiate a radio transmission test.
It may only be executed if the manager has been booted up in radiotest mode (see setNetworkConfig command). Three types of transmission tests are supported:
In a packet transmission test, the device generates a repeatCnt number of packet sequences. Each sequence consists of up to 10 packets with configurable size and delays. Each packet starts with a PHY preamble (5 bytes), followed by a PHY length field (1 byte), followed by data payload of up to 125 bytes, and finally a 2-byte 802.15.4 CRC at the end. Byte 0 of the payload contains stationId of the sender. Bytes 1 and 2 contain the packet number (in big-endian format) that increments with every packet transmitted. Bytes 3..N contain a counter (from 0..N-2) that increments with every byte inside payload. Transmissions occur on the set of channels defined by chanMask , selected inpseudo-randomorder.
In a continuous modulation test, the device generates continuous pseudo-random modulated signal, centered at the specified channel. The test is stopped by resetting the device.
In a continuous wave test, the device generates an unmodulated tone, centered at the specified channel. The test tone is stopped by resetting the device.
Channel numbering is 0-15, corresponding to IEEE 2.4 GHz channels 11-26.
The station ID is a user selectable value. It is used in packet tests so that a receiver (see radiotestRx) can identify packets from this device in cases where there may be multiple tests running in the same radio space. This field is not used for CM or CW tests.
testType | 1-byte field formatted as a int. This field can only take one of the following values:
|
chanMask | 2-byte field formatted as a hex. There is no restriction on the value of this field. |
repeatCnt | 2-byte field formatted as a int. There is no restriction on the value of this field. |
txPower | 1-byte field formatted as a ints. There is no restriction on the value of this field. |
seqSize | 1-byte field formatted as a int. This field can only take one of the following values:
|
pkLen_1 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_1 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_2 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_2 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_3 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_3 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_4 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_4 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_5 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_5 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_6 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_6 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_7 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_7 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_8 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_8 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_9 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_9 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
pkLen_10 | 1-byte field formatted as a int. There is no restriction on the value of this field. |
delay_10 | 2-byte field formatted as a int. There is no restriction on the value of this field. |
stationId | 1-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_reset | ( | self, | |
type, | |||
macAddress | |||
) |
The reset command is used to reset various objects.
The command argument is an object type, and if the object is a mote the MAC address must be specified (otherwise that argument is ignored).
type | 1-byte field formatted as a int. This field can only take one of the following values:
|
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_restoreFactoryDefaults | ( | self | ) |
The restoreFactoryDefaults command restores the default configuration and clears the ACL.
This change is persistent.
For Manager versions <1.3.0 that required a license, the license used to enable optional features is preserved during a restore.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_sendData | ( | self, | |
macAddress, | |||
priority, | |||
srcPort, | |||
dstPort, | |||
options, | |||
data | |||
) |
The sendData command sends a packet to a mote in the network.
The response contains a callbackId. When the manager injects the packet into the network, it will generate a packetSent notification. It is the responsibility of the customer'sapplication layer at the mote to send a response. It is also the responsibility of thecustomer's application layer to timeout if no response is received at the manager if one is expected.
The sendData command should be used by applications that communicate directly with the manager. If end-to-end (application to mote) IP connectivity is required, the application should use the sendIP command. For a more comprehensive discussion of the distinction, see the SmartMesh IPNetwork User Guide.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
priority | 1-byte field formatted as a int. This field can only take one of the following values:
|
srcPort | 2-byte field formatted as a int. There is no restriction on the value of this field. |
dstPort | 2-byte field formatted as a int. There is no restriction on the value of this field. |
options | 1-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.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_sendIP | ( | self, | |
macAddress, | |||
priority, | |||
options, | |||
encryptedOffset, | |||
data | |||
) |
The sendIP command sends a 6LoWPAN packet to a mote in the network.
The response contains a callback Id. When the manager injects the packet into the network, it will generate a packetSent notification with the calllbackId. The application is responsible for constructing a valid 6LoWPAN packet. The packet is sent to the mote best-effort, so the application should deal with responses and timeouts, if any.
The sendIP command should be used by applications that require end-to-end IP connectivity. For applications that do not require end-to-end IP connectivity, the sendData command provides a simpler interface without requiring the application to understand 6LoWPAN encapsulation. For a more comprehensive discussion of the distinction, see the SmartMesh IP Network User Guide.
macAddress | 8-byte field formatted as a hex. There is no restriction on the value of this field. |
priority | 1-byte field formatted as a int. This field can only take one of the following values:
|
options | 1-byte field formatted as a int. There is no restriction on the value of this field. |
encryptedOffset | 1-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.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setACLEntry | ( | self, | |
macAddress, | |||
joinKey | |||
) |
The setACLEntry command adds a new entry or updates an existing entry in the Access Control List (ACL).This change is persistent.
macAddress | 8-byte field formatted as a hex. 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.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setAdvertising | ( | self, | |
activate | |||
) |
The setAdvertising command tells the manager to activate or deactivate advertising.
The response is a callbackId. A commandFinished notification with the callbackId is generated when the command propagation is complete.
activate | 1-byte field formatted as a int. This field can only take one of the following values:
|
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setCLIUser | ( | self, | |
role, | |||
password | |||
) |
The setCLIUser command sets the password that must be used to log into the command line for a particular user role.
The user roles are:
role | 1-byte field formatted as a int. This field can only take one of the following values:
|
password | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setCommonJoinKey | ( | self, | |
key | |||
) |
The setCommonJoinKey command will set a new value for the common join key.
The common join key is used to decrypt join messages only if the ACL is empty.
key | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setDownstreamFrameMode | ( | self, | |
frameMode | |||
) |
The setDownstreamFrameMode command tells the manager to shorten or extend the downstream slotframe.
The base slotframe length will be multiplied by the downFrameMultVal for "normal" speed. For "fast" speed the downstream slotframe is the base length.Once this command is executed, the manager switches to manual mode and no longer changes slotframesize automatically. The response is a callbackId. A commandFinished notification with the callbackId is generated when the command propagation is complete.
frameMode | 1-byte field formatted as a int. This field can only take one of the following values:
|
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setIPConfig | ( | self, | |
ipv6Address, | |||
mask | |||
) |
The setIPConfig command sets the IPv6 prefix of the mesh network.
Only the upper 8 bytes of the IPv6 address are relevant: the lower 8 bytes of the IPv6 address are ignored, and lower 8 bytes of the mask field are reserved and should be set to 0.This change is persistent.
ipv6Address | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
mask | 16-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setLicense | ( | self, | |
license | |||
) |
The setLicense command has been deprecated in Manager >= 1.3.0.
There is no longer a need to use a license to enable > 32 mote networks.
The setLicense command validates and updates the software license key stored in flash. Features enabled or disabled by the license key change will take effect after the device is restarted.If the license parameter is set to all 0x0s, the manager restores the default license. This change is persistent.
license | 13-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setNetworkConfig | ( | self, | |
networkId, | |||
apTxPower, | |||
frameProfile, | |||
maxMotes, | |||
baseBandwidth, | |||
downFrameMultVal, | |||
numParents, | |||
ccaMode, | |||
channelList, | |||
autoStartNetwork, | |||
locMode, | |||
bbMode, | |||
bbSize, | |||
isRadioTest, | |||
bwMult, | |||
oneChannel | |||
) |
The setNetworkConfig command changes network configuration parameters.
The response code indicates whether the changes were successfully applied. This change is persistent.
Generally, changes to network configuration will take effect when the manager reboots. Exceptions are detailed below:
networkId | 2-byte field formatted as a int. There is no restriction on the value of this field. |
apTxPower | 1-byte field formatted as a ints. There is no restriction on the value of this field. |
frameProfile | 1-byte field formatted as a int. This field can only take one of the following values:
|
maxMotes | 2-byte field formatted as a int. There is no restriction on the value of this field. |
baseBandwidth | 2-byte field formatted as a int. There is no restriction on the value of this field. |
downFrameMultVal | 1-byte field formatted as a int. There is no restriction on the value of this field. |
numParents | 1-byte field formatted as a int. There is no restriction on the value of this field. |
ccaMode | 1-byte field formatted as a int. This field can only take one of the following values:
|
channelList | 2-byte field formatted as a int. There is no restriction on the value of this field. |
autoStartNetwork | 1-byte field formatted as a bool. There is no restriction on the value of this field. |
locMode | 1-byte field formatted as a int. There is no restriction on the value of this field. |
bbMode | 1-byte field formatted as a int. This field can only take one of the following values:
|
bbSize | 1-byte field formatted as a int. There is no restriction on the value of this field. |
isRadioTest | 1-byte field formatted as a int. There is no restriction on the value of this field. |
bwMult | 2-byte field formatted as a int. There is no restriction on the value of this field. |
oneChannel | 1-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_setTime | ( | self, | |
trigger, | |||
utcSecs, | |||
utcUsecs | |||
) |
This command has been deprecated, and should not be used in new designs.
When the Manager restarts, it will start counting from 20:00:00 UTC July 2, 2002.
The setTime command sets the UTC time on the manager. This command may only be executed when the network is not running. If the trigger flag is false, the manager sets the specified time as soon as it receives the setTime command. When the manager receives a Time Pin trigger, it temporarily stores the current time. If a setTime request is received within a short period of time following the trigger, the manager calculates the delay since the trigger and adjust the time such that the trigger was received at the specified time value.
trigger | 1-byte field formatted as a int. There is no restriction on the value of this field. |
utcSecs | 8-byte field formatted as a int. There is no restriction on the value of this field. |
utcUsecs | 4-byte field formatted as a int. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_startNetwork | ( | self | ) |
The startNetwork command tells the manager to allow the network to start forming (begin accepting join requests from devices).
The external application must issue the startNetwork command if the autoStartNetwork flag is not set (see setNetworkConfig).
This command has been deprecated and should not be used in new designs.
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.dn_subscribe | ( | self, | |
filter, | |||
unackFilter | |||
) |
The subscribe command indicates that the manager should send the external application the specified notifications.
It contains two filter fields:
Each subscription request overwrites the previous one. If an application is subscribed to data and then decides he also wants events he should send a subscribe command with both the data and event flags set. To clear all subscriptions, the client should send a subscribe command with the filter set to zero. When a session is initiated between the manager and a client, the subscription filter is initialized to zero.
The subscribe bitmap uses the values of the notification type enumeration. Some values are unused to provide backwards compatibility with earlier APIs.
filter | 4-byte field formatted as a hex. There is no restriction on the value of this field. |
unackFilter | 4-byte field formatted as a hex. There is no restriction on the value of this field. |
def SmartMeshSDK.IpMgrConnectorMux.IpMgrConnectorMux.IpMgrConnectorMux.getNotification | ( | self, | |
timeoutSec = -1 |
|||
) |
Get a notification from the notification queue, and returns it properly formatted.
NotificationError | if unknown notification. |
|
static |
EVENTCOMMANDFINISHED notification.
The commandFinished notification is sent when a command associated with the provided callback id finishes executing.
Formatted as a Tuple_eventCommandFinished named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.callbackId
4-byte field formatted as a hex.rc
1-byte field formatted as a int.
|
static |
EVENTMOTECREATE notification.
This event is sent when a mote joins the manager for the first time.
Formatted as a Tuple_eventMoteCreate named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.moteId
2-byte field formatted as a int.
|
static |
EVENTMOTEDELETE notification.
This notification is sent when a mote is deleted as a result of moteDelete command.
Formatted as a Tuple_eventMoteDelete named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.moteId
2-byte field formatted as a int.
|
static |
EVENTMOTEJOIN notification.
This notification is sent when a mote joins the network.
Formatted as a Tuple_eventMoteJoin named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.
|
static |
EVENTMOTELOST notification.
This notification is sent when a mote's state changes to Lost , which indicates that the mote is not responding to downstream messages.
Formatted as a Tuple_eventMoteLost named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.
|
static |
EVENTMOTEOPERATIONAL notification.
This notification is sent when a mote that joins the network becomes operational.
Formatted as a Tuple_eventMoteOperational named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.
|
static |
EVENTMOTERESET notification.
This notification is sent when a user-initiated reset is executed by the manager.
Formatted as a Tuple_eventMoteReset named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.
|
static |
EVENTNETWORKRESET notification.
This notification is sent when the manager starts the network. This event has no eventData fields.
Formatted as a Tuple_eventNetworkReset named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.
|
static |
EVENTNETWORKTIME notification.
The time notification is triggered by the client asserting the TIME pin or by calling the getTime command. This notification contains the time when the TIME pin was asserted (or the getTime command was processed) expressed as:
Formatted as a Tuple_eventNetworkTime named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.uptime
4-byte field formatted as a int.utcSecs
8-byte field formatted as a int.utcUsecs
4-byte field formatted as a int.asn
5-byte field formatted as a hex.asnOffset
2-byte field formatted as a int.
|
static |
EVENTPACKETSENT notification.
The packetSent notification is generated when client's packet is removed from manager's queue and sent into the wireless network.
Formatted as a Tuple_eventPacketSent named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.callbackId
4-byte field formatted as a int.rc
1-byte field formatted as a int.
|
static |
EVENTPATHCREATE notification.
This notification is sent when the manager creates a connection (path) between two motes.
Formatted as a Tuple_eventPathCreate named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.source
8-byte field formatted as a hex.dest
8-byte field formatted as a hex.direction
1-byte field formatted as a int.
|
static |
EVENTPATHDELETE notification.
This notification is sent when the manager removes a connection (path) between two motes.
Formatted as a Tuple_eventPathDelete named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.source
8-byte field formatted as a hex.dest
8-byte field formatted as a hex.direction
1-byte field formatted as a int.
|
static |
EVENTPINGRESPONSE notification.
This notification is sent when a reply is received from a mote ping.
Formatted as a Tuple_eventPingResponse named tuple. It contains the following fields:
eventId
4-byte field formatted as a int.callbackId
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.delay
4-byte field formatted as a int.voltage
2-byte field formatted as a int.temperature
1-byte field formatted as a ints.
|
static |
MANAGER_HELLO notification.
Sent by the manager to a initiate new session with a client.
Formatted as a Tuple_manager_hello named tuple. It contains the following fields:
version
1-byte field formatted as a int.mode
1-byte field formatted as a int.
|
static |
NOTIFDATA notification.
The data notification contains a header and a variable length array of binary data. The length of the data is determined based on the length of the notification.
The manager forwards all packets received on its IP address and non-manager ports as data notifications.
Formatted as a Tuple_notifData named tuple. It contains the following fields:
utcSecs
8-byte field formatted as a int.utcUsecs
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.srcPort
2-byte field formatted as a int.dstPort
2-byte field formatted as a int.data
None-byte field formatted as a hex.
|
static |
NOTIFHEALTHREPORT notification.
The healthReport notifications include the raw payload of health reports received from devices. The payload contains one or more specific health report messages. Each message contains an identifier, length and variable-sized data. The individual healthReport message structures are defined below.
Formatted as a Tuple_notifHealthReport named tuple. It contains the following fields:
macAddress
8-byte field formatted as a hex.payload
None-byte field formatted as a hex.
|
static |
NOTIFIPDATA notification.
The ipData notification contains full IP packet sent by the mote, including 6LoWPAN header, UDP header, and the UDP payload. Manager generates this notification when it receives packet from a mote with destination other than manager's own IP address. The size of the data field can be calculated by subtracting the fixed header size (up to macAddress) from the size of overall notification packet.
Formatted as a Tuple_notifIpData named tuple. It contains the following fields:
utcSecs
8-byte field formatted as a int.utcUsecs
4-byte field formatted as a int.macAddress
8-byte field formatted as a hex.data
None-byte field formatted as a hex.
|
static |
NOTIFLOG notification.
A log notifications is generated in response to the getLog command. Each log notification contains a message from the mote's log.
Formatted as a Tuple_notifLog named tuple. It contains the following fields:
macAddress
8-byte field formatted as a hex.logMsg
None-byte field formatted as a hex.
|
static |
Dictionary of all notification tuples.
|
static |
The named tuple returned by the dn_clearStatistics() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_deleteACLEntry() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_deleteMote() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeMoteJoinKey() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_exchangeNetworkId() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getIPConfig() function.
RC
: 1-byte field formatted as a int.ipv6Address
: 16-byte field formatted as a hex.mask
: 16-byte field formatted as a hex.
|
static |
The named tuple returned by the dn_getLicense() function.
RC
: 1-byte field formatted as a int.license
: 13-byte field formatted as a hex.
|
static |
The named tuple returned by the dn_getLog() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getManagerStatistics() function.
RC
: 1-byte field formatted as a int.serTxCnt
: 2-byte field formatted as a int.serRxCnt
: 2-byte field formatted as a int.serRxCRCErr
: 2-byte field formatted as a int.serRxOverruns
: 2-byte field formatted as a int.apiEstabConn
: 2-byte field formatted as a int.apiDroppedConn
: 2-byte field formatted as a int.apiTxOk
: 2-byte field formatted as a int.apiTxErr
: 2-byte field formatted as a int.apiTxFail
: 2-byte field formatted as a int.apiRxOk
: 2-byte field formatted as a int.apiRxProtErr
: 2-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getMoteConfig() function.
RC
: 1-byte field formatted as a int.macAddress
: 8-byte field formatted as a hex.moteId
: 2-byte field formatted as a int.isAP
: 1-byte field formatted as a bool.state
: 1-byte field formatted as a int.reserved
: 1-byte field formatted as a int.isRouting
: 1-byte field formatted as a bool.
|
static |
The named tuple returned by the dn_getMoteConfigById() function.
RC
: 1-byte field formatted as a int.macAddress
: 8-byte field formatted as a hex.moteId
: 2-byte field formatted as a int.isAP
: 1-byte field formatted as a bool.state
: 1-byte field formatted as a int.reserved
: 1-byte field formatted as a int.isRouting
: 1-byte field formatted as a bool.
|
static |
The named tuple returned by the dn_getMoteInfo() function.
RC
: 1-byte field formatted as a int.macAddress
: 8-byte field formatted as a hex.state
: 1-byte field formatted as a int.numNbrs
: 1-byte field formatted as a int.numGoodNbrs
: 1-byte field formatted as a int.requestedBw
: 4-byte field formatted as a int.totalNeededBw
: 4-byte field formatted as a int.assignedBw
: 4-byte field formatted as a int.packetsReceived
: 4-byte field formatted as a int.packetsLost
: 4-byte field formatted as a int.avgLatency
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getMoteLinks() function.
RC
: 1-byte field formatted as a int.idx
: 2-byte field formatted as a int.utilization
: 1-byte field formatted as a int.numLinks
: 1-byte field formatted as a int.frameId_1
: 1-byte field formatted as a int.slot_1
: 4-byte field formatted as a int.channelOffset_1
: 1-byte field formatted as a int.moteId_1
: 2-byte field formatted as a int.flags_1
: 1-byte field formatted as a int.frameId_2
: 1-byte field formatted as a int.slot_2
: 4-byte field formatted as a int.channelOffset_2
: 1-byte field formatted as a int.moteId_2
: 2-byte field formatted as a int.flags_2
: 1-byte field formatted as a int.frameId_3
: 1-byte field formatted as a int.slot_3
: 4-byte field formatted as a int.channelOffset_3
: 1-byte field formatted as a int.moteId_3
: 2-byte field formatted as a int.flags_3
: 1-byte field formatted as a int.frameId_4
: 1-byte field formatted as a int.slot_4
: 4-byte field formatted as a int.channelOffset_4
: 1-byte field formatted as a int.moteId_4
: 2-byte field formatted as a int.flags_4
: 1-byte field formatted as a int.frameId_5
: 1-byte field formatted as a int.slot_5
: 4-byte field formatted as a int.channelOffset_5
: 1-byte field formatted as a int.moteId_5
: 2-byte field formatted as a int.flags_5
: 1-byte field formatted as a int.frameId_6
: 1-byte field formatted as a int.slot_6
: 4-byte field formatted as a int.channelOffset_6
: 1-byte field formatted as a int.moteId_6
: 2-byte field formatted as a int.flags_6
: 1-byte field formatted as a int.frameId_7
: 1-byte field formatted as a int.slot_7
: 4-byte field formatted as a int.channelOffset_7
: 1-byte field formatted as a int.moteId_7
: 2-byte field formatted as a int.flags_7
: 1-byte field formatted as a int.frameId_8
: 1-byte field formatted as a int.slot_8
: 4-byte field formatted as a int.channelOffset_8
: 1-byte field formatted as a int.moteId_8
: 2-byte field formatted as a int.flags_8
: 1-byte field formatted as a int.frameId_9
: 1-byte field formatted as a int.slot_9
: 4-byte field formatted as a int.channelOffset_9
: 1-byte field formatted as a int.moteId_9
: 2-byte field formatted as a int.flags_9
: 1-byte field formatted as a int.frameId_10
: 1-byte field formatted as a int.slot_10
: 4-byte field formatted as a int.channelOffset_10
: 1-byte field formatted as a int.moteId_10
: 2-byte field formatted as a int.flags_10
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getNetworkConfig() function.
RC
: 1-byte field formatted as a int.networkId
: 2-byte field formatted as a int.apTxPower
: 1-byte field formatted as a ints.frameProfile
: 1-byte field formatted as a int.maxMotes
: 2-byte field formatted as a int.baseBandwidth
: 2-byte field formatted as a int.downFrameMultVal
: 1-byte field formatted as a int.numParents
: 1-byte field formatted as a int.ccaMode
: 1-byte field formatted as a int.channelList
: 2-byte field formatted as a int.autoStartNetwork
: 1-byte field formatted as a bool.locMode
: 1-byte field formatted as a int.bbMode
: 1-byte field formatted as a int.bbSize
: 1-byte field formatted as a int.isRadioTest
: 1-byte field formatted as a int.bwMult
: 2-byte field formatted as a int.oneChannel
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getNetworkInfo() function.
RC
: 1-byte field formatted as a int.numMotes
: 2-byte field formatted as a int.asnSize
: 2-byte field formatted as a int.advertisementState
: 1-byte field formatted as a int.downFrameState
: 1-byte field formatted as a int.netReliability
: 1-byte field formatted as a int.netPathStability
: 1-byte field formatted as a int.netLatency
: 4-byte field formatted as a int.netState
: 1-byte field formatted as a int.ipv6Address
: 16-byte field formatted as a hex.numLostPackets
: 4-byte field formatted as a int.numArrivedPackets
: 8-byte field formatted as a int.maxNumbHops
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getNextACLEntry() function.
RC
: 1-byte field formatted as a int.macAddress
: 8-byte field formatted as a hex.joinKey
: 16-byte field formatted as a hex.
|
static |
The named tuple returned by the dn_getNextPathInfo() function.
RC
: 1-byte field formatted as a int.pathId
: 2-byte field formatted as a int.source
: 8-byte field formatted as a hex.dest
: 8-byte field formatted as a hex.direction
: 1-byte field formatted as a int.numLinks
: 1-byte field formatted as a int.quality
: 1-byte field formatted as a int.rssiSrcDest
: 1-byte field formatted as a ints.rssiDestSrc
: 1-byte field formatted as a ints.
|
static |
The named tuple returned by the dn_getPathInfo() function.
RC
: 1-byte field formatted as a int.source
: 8-byte field formatted as a hex.dest
: 8-byte field formatted as a hex.direction
: 1-byte field formatted as a int.numLinks
: 1-byte field formatted as a int.quality
: 1-byte field formatted as a int.rssiSrcDest
: 1-byte field formatted as a ints.rssiDestSrc
: 1-byte field formatted as a ints.
|
static |
The named tuple returned by the dn_getRadiotestStatistics() function.
RC
: 1-byte field formatted as a int.rxOk
: 2-byte field formatted as a int.rxFail
: 2-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getSystemInfo() function.
RC
: 1-byte field formatted as a int.macAddress
: 8-byte field formatted as a hex.hwModel
: 1-byte field formatted as a int.hwRev
: 1-byte field formatted as a int.swMajor
: 1-byte field formatted as a int.swMinor
: 1-byte field formatted as a int.swPatch
: 1-byte field formatted as a int.swBuild
: 2-byte field formatted as a int.
|
static |
The named tuple returned by the dn_getTime() function.
RC
: 1-byte field formatted as a int.uptime
: 4-byte field formatted as a int.utcSecs
: 8-byte field formatted as a int.utcUsecs
: 4-byte field formatted as a int.asn
: 5-byte field formatted as a hex.asnOffset
: 2-byte field formatted as a int.
|
static |
The named tuple returned by the dn_hello_response() function.
successCode
: 1-byte field formatted as a int.version
: 1-byte field formatted as a int.mgrSeqNo
: 1-byte field formatted as a int.cliSeqNo
: 1-byte field formatted as a int.mode
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_mux_hello() function.
RC
: 1-byte field formatted as a int.version
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_pingMote() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_radiotestRx() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_radiotestTx() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_reset() function.
RC
: 1-byte field formatted as a int.macAddress
: 8-byte field formatted as a hex.
|
static |
The named tuple returned by the dn_restoreFactoryDefaults() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_sendData() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_sendIP() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setACLEntry() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setAdvertising() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setCLIUser() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setCommonJoinKey() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setDownstreamFrameMode() function.
RC
: 1-byte field formatted as a int.callbackId
: 4-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setIPConfig() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setLicense() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setNetworkConfig() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_setTime() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_startNetwork() function.
RC
: 1-byte field formatted as a int.
|
static |
The named tuple returned by the dn_subscribe() function.
RC
: 1-byte field formatted as a int.