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

Public class for IP mote connector, over Serial. More...

+ Inheritance diagram for SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector:

Public Member Functions

def dn_setParameter_macAddress
 This command allows user to overwrite the manufacturer-assigned MAC address of the mote. More...
 
def dn_setParameter_joinKey
 The setParameter<joinKey> command may be used to set the join key in mote's persistent storage. More...
 
def dn_setParameter_networkId
 This command may be used to set the Network ID of the mote. More...
 
def dn_setParameter_txPower
 The setParameter<txPower> command sets the mote output power. More...
 
def dn_setParameter_joinDutyCycle
 The setParameter<joinDutyCycle> command allows the microprocessor to control the ratio of active listen time to doze time (a low-power radio state) during the period when the mote is searching for the network. More...
 
def dn_setParameter_eventMask
 The setParameter<eventMask> command allows the microprocessor to selectively subscribe to event notifications. More...
 
def dn_setParameter_OTAPLockout
 This command allows the microprocessor to control whether Over-The-Air Programming (OTAP) of motes is allowed. More...
 
def dn_setParameter_routingMode
 This command allows the microprocessor to control whether the mote will become a router once joined the network. More...
 
def dn_setParameter_powerSrcInfo
 This command allows the microprocessor to configure power source information on the device. More...
 
def dn_setParameter_advKey
 Sets the Advertisement MIC key - this key is used to authenticate advertisements, and can be set per vendor/installation to prevent unauthorized devices from being able to respond to advertisements. More...
 
def dn_setParameter_autoJoin
 This command allows the microprocessor to change between automatic and manual joining by the mote's networking stack. More...
 
def dn_setParameter_antGain
 The setParameter<antGain> command sets the antenna gain of the system (to properly calculate radiated power). More...
 
def dn_setParameter_euCompliantMode
 The setParameter<euCompliantMode> commandmay be used to set the EN 300 328 compliance mode that is used by the device. More...
 
def dn_getParameter_macAddress
 This command returns the MAC address of the device. More...
 
def dn_getParameter_networkId
 This command returns the network id stored in mote's persistent storage. More...
 
def dn_getParameter_txPower
 Get the radio output power in dBm, excluding any antenna gain. More...
 
def dn_getParameter_joinDutyCycle
 This command allows user to retrieve current value of joinDutyCycle parameter. More...
 
def dn_getParameter_eventMask
 getParameter<eventMask> allows the microprocessor to read the currently subscribed-to event types. More...
 
def dn_getParameter_moteInfo
 The getParameter<moteInfo> command returns static information about the moteshardware and network stack software. More...
 
def dn_getParameter_netInfo
 The getParameter<networkInfo> command may be used to retrieve the mote's network-related parameters. More...
 
def dn_getParameter_moteStatus
 The getParameter<moteStatus> command is used to retrieve current mote state andother dynamic information. More...
 
def dn_getParameter_time
 The getParameter<time> command may be used to request the current time on the mote. More...
 
def dn_getParameter_charge
 The getParameter<charge> command retrieves the charge consumption of the motesince the last reset. More...
 
def dn_getParameter_testRadioRxStats
 The getParameter<testRadioRxStats> command retrieves statistics for the latest radio test performed using the testRadioRx command. More...
 
def dn_getParameter_OTAPLockout
 This command reads the current state of OTAP lockout, i.e. More...
 
def dn_getParameter_moteId
 This command retrieves the mote's Mote ID. More...
 
def dn_getParameter_ipv6Address
 This command allows the microprocessor to read IPV6 address assigned to the mote. More...
 
def dn_getParameter_routingMode
 This command allows the microprocessor to retrieve the current routing mode of the mote. More...
 
def dn_getParameter_appInfo
 Get the application (as opposed to the network stack) version information. More...
 
def dn_getParameter_powerSrcInfo
 This command allows the microprocessor to read a mote's power source settings. More...
 
def dn_getParameter_autoJoin
 This command allows the microprocessor to retrieve the current autoJoin setting. More...
 
def dn_getParameter_antGain
 The getParameter<antGain> command retrieves the antenna gain used by the system (to properly calculate radiated power). More...
 
def dn_getParameter_euCompliantMode
 The getParameter<euCompliantMode> commandmay be used to retrieve the EN 300 328 compliance mode that is used by the device. More...
 
def dn_join
 The join command requests that mote start searching for the network and attempt to join.The mote must be in the Idle state or the Promiscuous Listen state(see search) for this command to be valid. More...
 
def dn_disconnect
 The disconnect command requests that the mote initiate disconnection from the network. More...
 
def dn_reset
 The reset command initiates a soft-reset of the device. More...
 
def dn_lowPowerSleep
 The lowPowerSleep command shuts down all peripherals and places the mote into deep sleep mode. More...
 
def dn_testRadioRx
 The testRadioRx command clears all previously collected statistics and initiates a test of radio reception for the specified channel and duration. More...
 
def dn_clearNV
 The clearNV command resets the motes non-volatile memory (NV) to its factory-default state. More...
 
def dn_requestService
 The requestService command may be used to request a new or changed service level to a destination device in the mesh. More...
 
def dn_getServiceInfo
 The getServiceInfo command returns information about the service currently allocated to the mote. More...
 
def dn_openSocket
 The openSocket command creates an endpoint for IP communication and returns an ID for the socket. More...
 
def dn_closeSocket
 Close the previously open socket. More...
 
def dn_bindSocket
 Bind a previously opened socket to a port. More...
 
def dn_sendTo
 Send a packet into the network. More...
 
def dn_search
 The search command requests that mote start listening for advertisements and report those heard from any network withoutattempting to join. More...
 
def dn_testRadioTxExt
 The testRadioTxExt command allows the microprocessor to initiate a radio transmission test. More...
 
def dn_zeroize
 Zeroize (zeroise) command erases flash area that is used to store configuration parameters, such as join keys. More...
 
def dn_socketInfo
 Retrieve information about a socket. More...
 
def getNotification
 Get a notification from the notification queue, and returns it properly formatted. More...
 

Static Public Attributes

tuple Tuple_dn_setParameter_macAddress = collections.namedtuple("Tuple_dn_setParameter_macAddress", ['RC'])
 The named tuple returned by the dn_setParameter_macAddress() function. More...
 
tuple Tuple_dn_setParameter_joinKey = collections.namedtuple("Tuple_dn_setParameter_joinKey", ['RC'])
 The named tuple returned by the dn_setParameter_joinKey() function. More...
 
tuple Tuple_dn_setParameter_networkId = collections.namedtuple("Tuple_dn_setParameter_networkId", ['RC'])
 The named tuple returned by the dn_setParameter_networkId() function. More...
 
tuple Tuple_dn_setParameter_txPower = collections.namedtuple("Tuple_dn_setParameter_txPower", ['RC'])
 The named tuple returned by the dn_setParameter_txPower() function. More...
 
tuple Tuple_dn_setParameter_joinDutyCycle = collections.namedtuple("Tuple_dn_setParameter_joinDutyCycle", ['RC'])
 The named tuple returned by the dn_setParameter_joinDutyCycle() function. More...
 
tuple Tuple_dn_setParameter_eventMask = collections.namedtuple("Tuple_dn_setParameter_eventMask", ['RC'])
 The named tuple returned by the dn_setParameter_eventMask() function. More...
 
tuple Tuple_dn_setParameter_OTAPLockout = collections.namedtuple("Tuple_dn_setParameter_OTAPLockout", ['RC'])
 The named tuple returned by the dn_setParameter_OTAPLockout() function. More...
 
tuple Tuple_dn_setParameter_routingMode = collections.namedtuple("Tuple_dn_setParameter_routingMode", ['RC'])
 The named tuple returned by the dn_setParameter_routingMode() function. More...
 
tuple Tuple_dn_setParameter_powerSrcInfo = collections.namedtuple("Tuple_dn_setParameter_powerSrcInfo", ['RC'])
 The named tuple returned by the dn_setParameter_powerSrcInfo() function. More...
 
tuple Tuple_dn_setParameter_advKey = collections.namedtuple("Tuple_dn_setParameter_advKey", ['RC'])
 The named tuple returned by the dn_setParameter_advKey() function. More...
 
tuple Tuple_dn_setParameter_autoJoin = collections.namedtuple("Tuple_dn_setParameter_autoJoin", ['RC'])
 The named tuple returned by the dn_setParameter_autoJoin() function. More...
 
tuple Tuple_dn_setParameter_antGain = collections.namedtuple("Tuple_dn_setParameter_antGain", ['RC'])
 The named tuple returned by the dn_setParameter_antGain() function. More...
 
tuple Tuple_dn_setParameter_euCompliantMode = collections.namedtuple("Tuple_dn_setParameter_euCompliantMode", ['RC'])
 The named tuple returned by the dn_setParameter_euCompliantMode() function. More...
 
tuple Tuple_dn_getParameter_macAddress = collections.namedtuple("Tuple_dn_getParameter_macAddress", ['RC', 'macAddress'])
 The named tuple returned by the dn_getParameter_macAddress() function. More...
 
tuple Tuple_dn_getParameter_networkId = collections.namedtuple("Tuple_dn_getParameter_networkId", ['RC', 'networkId'])
 The named tuple returned by the dn_getParameter_networkId() function. More...
 
tuple Tuple_dn_getParameter_txPower = collections.namedtuple("Tuple_dn_getParameter_txPower", ['RC', 'txPower'])
 The named tuple returned by the dn_getParameter_txPower() function. More...
 
tuple Tuple_dn_getParameter_joinDutyCycle = collections.namedtuple("Tuple_dn_getParameter_joinDutyCycle", ['RC', 'joinDutyCycle'])
 The named tuple returned by the dn_getParameter_joinDutyCycle() function. More...
 
tuple Tuple_dn_getParameter_eventMask = collections.namedtuple("Tuple_dn_getParameter_eventMask", ['RC', 'eventMask'])
 The named tuple returned by the dn_getParameter_eventMask() function. More...
 
tuple Tuple_dn_getParameter_moteInfo = collections.namedtuple("Tuple_dn_getParameter_moteInfo", ['RC', 'apiVersion', 'serialNumber', 'hwModel', 'hwRev', 'swVerMajor', 'swVerMinor', 'swVerPatch', 'swVerBuild', 'bootSwVer'])
 The named tuple returned by the dn_getParameter_moteInfo() function. More...
 
tuple Tuple_dn_getParameter_netInfo = collections.namedtuple("Tuple_dn_getParameter_netInfo", ['RC', 'macAddress', 'moteId', 'networkId', 'slotSize'])
 The named tuple returned by the dn_getParameter_netInfo() function. More...
 
tuple Tuple_dn_getParameter_moteStatus = collections.namedtuple("Tuple_dn_getParameter_moteStatus", ['RC', 'state', 'reserved_0', 'reserved_1', 'numParents', 'alarms', 'reserved_2'])
 The named tuple returned by the dn_getParameter_moteStatus() function. More...
 
tuple Tuple_dn_getParameter_time = collections.namedtuple("Tuple_dn_getParameter_time", ['RC', 'upTime', 'utcSecs', 'utcUsecs', 'asn', 'asnOffset'])
 The named tuple returned by the dn_getParameter_time() function. More...
 
tuple Tuple_dn_getParameter_charge = collections.namedtuple("Tuple_dn_getParameter_charge", ['RC', 'qTotal', 'upTime', 'tempInt', 'tempFrac'])
 The named tuple returned by the dn_getParameter_charge() function. More...
 
tuple Tuple_dn_getParameter_testRadioRxStats = collections.namedtuple("Tuple_dn_getParameter_testRadioRxStats", ['RC', 'rxOk', 'rxFailed'])
 The named tuple returned by the dn_getParameter_testRadioRxStats() function. More...
 
tuple Tuple_dn_getParameter_OTAPLockout = collections.namedtuple("Tuple_dn_getParameter_OTAPLockout", ['RC', 'mode'])
 The named tuple returned by the dn_getParameter_OTAPLockout() function. More...
 
tuple Tuple_dn_getParameter_moteId = collections.namedtuple("Tuple_dn_getParameter_moteId", ['RC', 'moteId'])
 The named tuple returned by the dn_getParameter_moteId() function. More...
 
tuple Tuple_dn_getParameter_ipv6Address = collections.namedtuple("Tuple_dn_getParameter_ipv6Address", ['RC', 'ipv6Address'])
 The named tuple returned by the dn_getParameter_ipv6Address() function. More...
 
tuple Tuple_dn_getParameter_routingMode = collections.namedtuple("Tuple_dn_getParameter_routingMode", ['RC', 'routingMode'])
 The named tuple returned by the dn_getParameter_routingMode() function. More...
 
tuple Tuple_dn_getParameter_appInfo = collections.namedtuple("Tuple_dn_getParameter_appInfo", ['RC', 'vendorId', 'appId', 'appVer'])
 The named tuple returned by the dn_getParameter_appInfo() function. More...
 
tuple Tuple_dn_getParameter_powerSrcInfo = collections.namedtuple("Tuple_dn_getParameter_powerSrcInfo", ['RC', 'maxStCurrent', 'minLifetime', 'currentLimit_0', 'dischargePeriod_0', 'rechargePeriod_0', 'currentLimit_1', 'dischargePeriod_1', 'rechargePeriod_1', 'currentLimit_2', 'dischargePeriod_2', 'rechargePeriod_2'])
 The named tuple returned by the dn_getParameter_powerSrcInfo() function. More...
 
tuple Tuple_dn_getParameter_autoJoin = collections.namedtuple("Tuple_dn_getParameter_autoJoin", ['RC', 'autoJoin'])
 The named tuple returned by the dn_getParameter_autoJoin() function. More...
 
tuple Tuple_dn_getParameter_antGain = collections.namedtuple("Tuple_dn_getParameter_antGain", ['RC', 'antGain'])
 The named tuple returned by the dn_getParameter_antGain() function. More...
 
tuple Tuple_dn_getParameter_euCompliantMode = collections.namedtuple("Tuple_dn_getParameter_euCompliantMode", ['RC', 'compMode'])
 The named tuple returned by the dn_getParameter_euCompliantMode() function. More...
 
tuple Tuple_dn_join = collections.namedtuple("Tuple_dn_join", ['RC'])
 The named tuple returned by the dn_join() function. More...
 
tuple Tuple_dn_disconnect = collections.namedtuple("Tuple_dn_disconnect", ['RC'])
 The named tuple returned by the dn_disconnect() function. More...
 
tuple Tuple_dn_reset = collections.namedtuple("Tuple_dn_reset", ['RC'])
 The named tuple returned by the dn_reset() function. More...
 
tuple Tuple_dn_lowPowerSleep = collections.namedtuple("Tuple_dn_lowPowerSleep", ['RC'])
 The named tuple returned by the dn_lowPowerSleep() function. More...
 
tuple Tuple_dn_testRadioRx = collections.namedtuple("Tuple_dn_testRadioRx", ['RC'])
 The named tuple returned by the dn_testRadioRx() function. More...
 
tuple Tuple_dn_clearNV = collections.namedtuple("Tuple_dn_clearNV", ['RC'])
 The named tuple returned by the dn_clearNV() function. More...
 
tuple Tuple_dn_requestService = collections.namedtuple("Tuple_dn_requestService", ['RC'])
 The named tuple returned by the dn_requestService() function. More...
 
tuple Tuple_dn_getServiceInfo = collections.namedtuple("Tuple_dn_getServiceInfo", ['RC', 'destAddr', 'type', 'state', 'value'])
 The named tuple returned by the dn_getServiceInfo() function. More...
 
tuple Tuple_dn_openSocket = collections.namedtuple("Tuple_dn_openSocket", ['RC', 'socketId'])
 The named tuple returned by the dn_openSocket() function. More...
 
tuple Tuple_dn_closeSocket = collections.namedtuple("Tuple_dn_closeSocket", ['RC'])
 The named tuple returned by the dn_closeSocket() function. More...
 
tuple Tuple_dn_bindSocket = collections.namedtuple("Tuple_dn_bindSocket", ['RC'])
 The named tuple returned by the dn_bindSocket() function. More...
 
tuple Tuple_dn_sendTo = collections.namedtuple("Tuple_dn_sendTo", ['RC'])
 The named tuple returned by the dn_sendTo() function. More...
 
tuple Tuple_dn_search = collections.namedtuple("Tuple_dn_search", ['RC'])
 The named tuple returned by the dn_search() function. More...
 
tuple Tuple_dn_testRadioTxExt = collections.namedtuple("Tuple_dn_testRadioTxExt", ['RC'])
 The named tuple returned by the dn_testRadioTxExt() function. More...
 
tuple Tuple_dn_zeroize = collections.namedtuple("Tuple_dn_zeroize", ['RC'])
 The named tuple returned by the dn_zeroize() function. More...
 
tuple Tuple_dn_socketInfo = collections.namedtuple("Tuple_dn_socketInfo", ['RC', 'index', 'socketId', 'protocol', 'bindState', 'port'])
 The named tuple returned by the dn_socketInfo() function. More...
 
dictionary notifTupleTable = {}
 Dictionary of all notification tuples. More...
 
string TIMEINDICATION = "timeIndication"
 TIMEINDICATION notification. More...
 
string EVENTS = "events"
 EVENTS notification. More...
 
string RECEIVE = "receive"
 RECEIVE notification. More...
 
string MACRX = "macRx"
 MACRX notification. More...
 
string TXDONE = "txDone"
 TXDONE notification. More...
 
string ADVRECEIVED = "advReceived"
 ADVRECEIVED notification. More...
 

Detailed Description

Public class for IP mote connector, over Serial.

Member Function Documentation

def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_bindSocket (   self,
  socketId,
  port 
)

Bind a previously opened socket to a port.

When a socket is created, it is only given a protocol family, but not assigned a port. This association must be performed before the socket can accept connections from other hosts.

Parameters
socketId1-byte field formatted as a int.
There is no restriction on the value of this field.
port2-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_bindSocket named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_clearNV (   self)

The clearNV command resets the motes non-volatile memory (NV) to its factory-default state.

See User Guide for detailed information about the default values. Since many parameters are read by the mote only at power-up, this command should be followed up by mote reset.

Returns
The response to the command, formatted as a Tuple_dn_clearNV named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_closeSocket (   self,
  socketId 
)

Close the previously open socket.

Parameters
socketId1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_closeSocket named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_disconnect (   self)

The disconnect command requests that the mote initiate disconnection from the network.

After disconnection completes, the mote will generate a disconnected event, and proceed to reset. If the mote is not in the network, the disconnected event will be generated immediately. This command may be issued at any time.

Returns
The response to the command, formatted as a Tuple_dn_disconnect named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_antGain (   self)

The getParameter<antGain> command retrieves the antenna gain used by the system (to properly calculate radiated power).

Defaults to 2 dBi.

Note: This parameter is available indevices running mote software>=1.4.x

Returns
The response to the command, formatted as a Tuple_dn_getParameter_antGain named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_appInfo (   self)

Get the application (as opposed to the network stack) version information.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_appInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_autoJoin (   self)

This command allows the microprocessor to retrieve the current autoJoin setting.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_autoJoin named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_charge (   self)

The getParameter<charge> command retrieves the charge consumption of the motesince the last reset.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_charge named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_euCompliantMode (   self)

The getParameter<euCompliantMode> commandmay be used to retrieve the EN 300 328 compliance mode that is used by the device.

When enabled, the mote may skip some transmit opportunities to remain within average power limits. Motes below +10 dBm radiated power do not need to duty cycle to meet EN 300 328 requirements.

Note: This parameter is available indevices running mote software>=1.4.x

Returns
The response to the command, formatted as a Tuple_dn_getParameter_euCompliantMode named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_eventMask (   self)

getParameter<eventMask> allows the microprocessor to read the currently subscribed-to event types.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_eventMask named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_ipv6Address (   self)

This command allows the microprocessor to read IPV6 address assigned to the mote.

Before the mote has an assigned address it will return all 0s.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_ipv6Address named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_joinDutyCycle (   self)

This command allows user to retrieve current value of joinDutyCycle parameter.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_joinDutyCycle named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_macAddress (   self)

This command returns the MAC address of the device.

By default, the MAC address returned is the EUI64 address of the device assigned by mote manufacturer, but it may be overwritten using the setParameter<macAddress> command.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_macAddress named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_moteId (   self)

This command retrieves the mote's Mote ID.

If the mote is not in the network, value of 0 is returned.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_moteId named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_moteInfo (   self)

The getParameter<moteInfo> command returns static information about the moteshardware and network stack software.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_moteInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_moteStatus (   self)

The getParameter<moteStatus> command is used to retrieve current mote state andother dynamic information.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_moteStatus named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_netInfo (   self)

The getParameter<networkInfo> command may be used to retrieve the mote's network-related parameters.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_netInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_networkId (   self)

This command returns the network id stored in mote's persistent storage.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_networkId named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_OTAPLockout (   self)

This command reads the current state of OTAP lockout, i.e.

whether over-the-air upgrades of software are permitted on this mote.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_OTAPLockout named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_powerSrcInfo (   self)

This command allows the microprocessor to read a mote's power source settings.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_powerSrcInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_routingMode (   self)

This command allows the microprocessor to retrieve the current routing mode of the mote.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_routingMode named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_testRadioRxStats (   self)

The getParameter<testRadioRxStats> command retrieves statistics for the latest radio test performed using the testRadioRx command.

The statistics show the number of good and bad packets (CRC failures) received during the test

Returns
The response to the command, formatted as a Tuple_dn_getParameter_testRadioRxStats named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_time (   self)

The getParameter<time> command may be used to request the current time on the mote.

The mote reports time at the moment it is processing the command, so the information includes variable delay. For more precise time information consider using TIMEn pin (see timeIndication).

Returns
The response to the command, formatted as a Tuple_dn_getParameter_time named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getParameter_txPower (   self)

Get the radio output power in dBm, excluding any antenna gain.

Returns
The response to the command, formatted as a Tuple_dn_getParameter_txPower named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_getServiceInfo (   self,
  destAddr,
  type 
)

The getServiceInfo command returns information about the service currently allocated to the mote.

Parameters
destAddr2-byte field formatted as a int.
There is no restriction on the value of this field.
type1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: bandwidth
Returns
The response to the command, formatted as a Tuple_dn_getServiceInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_join (   self)

The join command requests that mote start searching for the network and attempt to join.The mote must be in the Idle state or the Promiscuous Listen state(see search) for this command to be valid.

Note that the join time will be affected by the maximum current setting.

Returns
The response to the command, formatted as a Tuple_dn_join named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_lowPowerSleep (   self)

The lowPowerSleep command shuts down all peripherals and places the mote into deep sleep mode.

The command executes after the mote sends its response. The mote enters deep sleep within two seconds after the command executes. The command may be issued at any time and will cause the mote to interrupt all in-progress network operation. To achieve a graceful disconnect, use the disconnect command before using the lowPowerSleep command. A hardware reset is required to bring a mote out of deep sleep mode.

Returns
The response to the command, formatted as a Tuple_dn_lowPowerSleep named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_openSocket (   self,
  protocol 
)

The openSocket command creates an endpoint for IP communication and returns an ID for the socket.

Parameters
protocol1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: udp
Returns
The response to the command, formatted as a Tuple_dn_openSocket named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_requestService (   self,
  destAddr,
  serviceType,
  value 
)

The requestService command may be used to request a new or changed service level to a destination device in the mesh.

This command may only be used to update the service to a device with an existing connection (session).

Whenever a change in bandwidth assignment occurs, the application receives a serviceChanged event that it can use as a trigger to read the new service allocation.

Parameters
destAddr2-byte field formatted as a int.
There is no restriction on the value of this field.
serviceType1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: bandwidth
value4-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_requestService named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_reset (   self)

The reset command initiates a soft-reset of the device.

The device will initiate the reset sequence shortly after sending out the response to this command. Resetting a mote directly can adversely impact its descendants; to disconnect gracefully from the network, use the disconnect command

Returns
The response to the command, formatted as a Tuple_dn_reset named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_search (   self)

The search command requests that mote start listening for advertisements and report those heard from any network withoutattempting to join.

This is called the Promiscuous Listen state. The mote must be in the Idle state for this command to be valid. The search state can be exited by issuing the join command or the reset command.

Returns
The response to the command, formatted as a Tuple_dn_search named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_sendTo (   self,
  socketId,
  destIP,
  destPort,
  serviceType,
  priority,
  packetId,
  payload 
)

Send a packet into the network.

If the command returns RC_OK, the mote has accepted the packet and hasqueuedit up for transmission. A txDone notification will be issued when the packet has been sent, if and only if the packet ID passed in this command is different from 0xffff. You can set the packet ID to any value. The notification will contain the packet ID of the packet just sent, allowing association of the notification with a particular packet. The destination port should be in the range 0xF0B8-F0BF (61624-61631) to maximize payload.

Parameters
socketId1-byte field formatted as a int.
There is no restriction on the value of this field.
destIP16-byte field formatted as a hex.
There is no restriction on the value of this field.
destPort2-byte field formatted as a int.
There is no restriction on the value of this field.
serviceType1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: bandwidth
priority1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: low
  • 1: medium
  • 2: high
packetId2-byte field formatted as a int.
There is no restriction on the value of this field.
payloadNone-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_sendTo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_advKey (   self,
  advKey 
)

Sets the Advertisement MIC key - this key is used to authenticate advertisements, and can be set per vendor/installation to prevent unauthorized devices from being able to respond to advertisements.

If changed, it must match that set on the corresponding AP (using mset on the manager CLI) in order for the mote to join. It can be reset to default via the clearNV command.

Parameters
advKey16-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_advKey named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_antGain (   self,
  antGain 
)

The setParameter<antGain> command sets the antenna gain of the system (to properly calculate radiated power).

Defaults to 2 dBi if not set.

Note: This parameter is available indevices running mote software>=1.4.x

Parameters
antGain1-byte field formatted as a ints.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_antGain named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_autoJoin (   self,
  mode 
)

This command allows the microprocessor to change between automatic and manual joining by the mote's networking stack.

In manual mode, an explicit join command from the application is required to initiate joining. This setting is persistent and takes effect after mote reset.

Note that auto join mode must not be set if the application is also configured to join (e.g combining 'auto join' with 'master' mode will result in mote not joining).

Parameters
mode1-byte field formatted as a bool.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_autoJoin named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_euCompliantMode (   self,
  euCompliantMode 
)

The setParameter<euCompliantMode> commandmay be used to set the EN 300 328 compliance mode that is used by the device.

When enabled, the mote may skip some transmit opportunities to remain within average power limits. Motes below +10 dBm radiated power do not need to duty cycle to meet EN 300 328 requirements.

Note: This parameter is available indevices running mote software>=1.4.x

Parameters
euCompliantMode1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_euCompliantMode named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_eventMask (   self,
  eventMask 
)

The setParameter<eventMask> command allows the microprocessor to selectively subscribe to event notifications.

The default value of eventMask at mote reset is all 1s - all events are enabled. This setting is not persistent.

New event type may be added in future revisions of mote software. It is recommended that the client code only subscribe to known events and gracefully ignore all unknown events.

Parameters
eventMask4-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_eventMask named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_joinDutyCycle (   self,
  dutyCycle 
)

The setParameter<joinDutyCycle> command allows the microprocessor to control the ratio of active listen time to doze time (a low-power radio state) during the period when the mote is searching for the network.

If you desire a faster join time at the risk of higher power consumption, use the setParameter<joinDutyCycle> command to increase the join duty cycle up to 100%. This setting is persistent and takes effect immediately if the device is searching for network.

Parameters
dutyCycle1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_joinDutyCycle named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_joinKey (   self,
  joinKey 
)

The setParameter<joinKey> command may be used to set the join key in mote's persistent storage.

Join keys are used by motes to establish secure connection with the network. The join key is used at next join.

Reading the joinKey parameter is prohibited for security reasons.

Parameters
joinKey16-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_joinKey named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_macAddress (   self,
  macAddress 
)

This command allows user to overwrite the manufacturer-assigned MAC address of the mote.

The new value takes effect after the mote resets.

Parameters
macAddress8-byte field formatted as a hex.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_macAddress named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_networkId (   self,
  networkId 
)

This command may be used to set the Network ID of the mote.

This setting is persistent and is used on next join attempt.

As of version 1.4.x, a network ID of 0xFFFF can be used to indicate that the mote should join the first network heard.

0xFFFF is never used over the air as a valid network ID - you should not set the Manager's network ID to 0xFFFF.

Parameters
networkId2-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_networkId named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_OTAPLockout (   self,
  mode 
)

This command allows the microprocessor to control whether Over-The-Air Programming (OTAP) of motes is allowed.

This setting is persistent and takes effect immediately.

Parameters
mode1-byte field formatted as a bool.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_OTAPLockout named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_powerSrcInfo (   self,
  maxStCurrent,
  minLifetime,
  currentLimit_0,
  dischargePeriod_0,
  rechargePeriod_0,
  currentLimit_1,
  dischargePeriod_1,
  rechargePeriod_1,
  currentLimit_2,
  dischargePeriod_2,
  rechargePeriod_2 
)

This command allows the microprocessor to configure power source information on the device.

This setting is persistent and is used at network join time.

Parameters
maxStCurrent2-byte field formatted as a int.
There is no restriction on the value of this field.
minLifetime1-byte field formatted as a int.
There is no restriction on the value of this field.
currentLimit_02-byte field formatted as a int.
There is no restriction on the value of this field.
dischargePeriod_02-byte field formatted as a int.
There is no restriction on the value of this field.
rechargePeriod_02-byte field formatted as a int.
There is no restriction on the value of this field.
currentLimit_12-byte field formatted as a int.
There is no restriction on the value of this field.
dischargePeriod_12-byte field formatted as a int.
There is no restriction on the value of this field.
rechargePeriod_12-byte field formatted as a int.
There is no restriction on the value of this field.
currentLimit_22-byte field formatted as a int.
There is no restriction on the value of this field.
dischargePeriod_22-byte field formatted as a int.
There is no restriction on the value of this field.
rechargePeriod_22-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_powerSrcInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_routingMode (   self,
  mode 
)

This command allows the microprocessor to control whether the mote will become a router once joined the network.

If disabled, the manager will keep the mote a leaf node.

Parameters
mode1-byte field formatted as a bool.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_routingMode named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_setParameter_txPower (   self,
  txPower 
)

The setParameter<txPower> command sets the mote output power.

This setting is persistent. The command may be issued at any time and takes effect on next transmission. Refer to product datasheets for supported RF output power values. For example, if the mote has a typical RF output power of +8 dBm when the power amplifier (PA) is enabled, then set the txPower parameter to 8 to enable the PA. Similarly, if the mote has a typical RF output power of 0 dBm when the PA is disabled, then set the txPower parameter to 0 to turn off the PA.

Parameters
txPower1-byte field formatted as a ints.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_setParameter_txPower named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_socketInfo (   self,
  index 
)

Retrieve information about a socket.

(Available in IP Mote >= 1.4.0)

Parameters
index1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_socketInfo named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_testRadioRx (   self,
  channelMask,
  time,
  stationId 
)

The testRadioRx command clears all previously collected statistics and initiates a test of radio reception for the specified channel and duration.

During the test, the mote keeps statistics about the number of packets received (with and without error). The test results may be retrieved using the getParameter<testRadioRxStats> command. The testRadioRx command may only be issued in Idle mode. The mote must be reset (either hardware or software reset) after radio tests are complete and prior to joining.

Station ID is available in IP mote >= 1.4, and WirelessHART mote >= 1.1.2. The station ID is a user selectable value used to isolate traffic if multiple tests are running in the same radio space. It must be set to match the station ID used by the transmitter.

Channel numbering is 0-15, corresponding to IEEE 2.4 GHz channels 11-26.

Parameters
channelMask2-byte field formatted as a hex.
There is no restriction on the value of this field.
time2-byte field formatted as a int.
There is no restriction on the value of this field.
stationId1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_testRadioRx named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_testRadioTxExt (   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 testRadioTxExt command allows the microprocessor to initiate a radio transmission test.

This command may only be issued prior to the mote joining the network. Three types of transmission tests are supported:

  • Packet transmission
  • Continuous modulation
  • Continuous wave (unmodulated signal)

In a packet transmission test, the mote 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-3) 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 mote generates continuous pseudo-random modulated signal, centered at the specified channel. The test is stopped by resetting the mote.

In a continuous wave test, the mote generates an unmodulated tone, centered at the specified channel. The test tone is stopped by resetting the mote.

The testRadioTxExt command may only be issued when the mote is in Idle mode, prior to its joining the network. The mote must be reset (either hardware or software reset) after radio tests are complete and prior to joining.

The station ID is a user selectable value. It is used in packet tests so that a receiver 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. See testRadioRX (SmartMesh IP) or testRadioRxExt (SmartMesh WirelessHART).

Channel numbering is 0-15, corresponding to IEEE 2.4 GHz channels 11-26.

Parameters
testType1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: packet
  • 1: cm
  • 2: cw
  • 3: pkcca
chanMask2-byte field formatted as a hex.
There is no restriction on the value of this field.
repeatCnt2-byte field formatted as a int.
There is no restriction on the value of this field.
txPower1-byte field formatted as a ints.
There is no restriction on the value of this field.
seqSize1-byte field formatted as a int.
This field can only take one of the following values:
  • 0: 0
  • 1: 1
  • 2: 2
  • 3: 3
  • 4: 4
  • 5: 5
  • 6: 6
  • 7: 7
  • 8: 8
  • 9: 9
  • 10: 10
pkLen_11-byte field formatted as a int.
There is no restriction on the value of this field.
delay_12-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_21-byte field formatted as a int.
There is no restriction on the value of this field.
delay_22-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_31-byte field formatted as a int.
There is no restriction on the value of this field.
delay_32-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_41-byte field formatted as a int.
There is no restriction on the value of this field.
delay_42-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_51-byte field formatted as a int.
There is no restriction on the value of this field.
delay_52-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_61-byte field formatted as a int.
There is no restriction on the value of this field.
delay_62-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_71-byte field formatted as a int.
There is no restriction on the value of this field.
delay_72-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_81-byte field formatted as a int.
There is no restriction on the value of this field.
delay_82-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_91-byte field formatted as a int.
There is no restriction on the value of this field.
delay_92-byte field formatted as a int.
There is no restriction on the value of this field.
pkLen_101-byte field formatted as a int.
There is no restriction on the value of this field.
delay_102-byte field formatted as a int.
There is no restriction on the value of this field.
stationId1-byte field formatted as a int.
There is no restriction on the value of this field.
Returns
The response to the command, formatted as a Tuple_dn_testRadioTxExt named tuple.
def SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.dn_zeroize (   self)

Zeroize (zeroise) command erases flash area that is used to store configuration parameters, such as join keys.

This command is intended to satisfy zeroization requirement of FIPS-140 standard. After the command executes, the mote should be reset. Available in mote >= 1.4.x

The zeroize command will render the mote inoperable. It must be re-programmed via SPI or JTAG in order to be useable.

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

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

Exceptions
NotificationErrorif unknown notification.

Member Data Documentation

string SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.ADVRECEIVED = "advReceived"
static

ADVRECEIVED notification.

The advReceived notification is generated by the mote w hen it is in Promiscuous Listen state (see the Mote States table) and it receives an advertisement.

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

  • netId 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • moteId 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • rssi 1-byte field formatted as a ints.
    There is no restriction on the value of this field.
  • joinPri 1-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.EVENTS = "events"
static

EVENTS notification.

The mote sends an events notification to inform the application of new events that occurred since the previous events notification. The notification also contains up-to-date information about current mote state and any pending alarms.

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

  • events 4-byte field formatted as a int.
    This field can only take one of the following values:
    • 1: boot
    • 2: alarmChange
    • 4: timeChange
    • 8: joinFail
    • 16: disconnected
    • 32: operational
    • 128: svcChange
    • 256: joinStarted
  • state 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: init
    • 1: idle
    • 2: searching
    • 3: negotiating
    • 4: connected
    • 5: operational
    • 6: disconnected
    • 7: radiotest
    • 8: promiscuous listen
  • alarmsList 4-byte field formatted as a int.
    There is no restriction on the value of this field.
string SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.MACRX = "macRx"
static

MACRX notification.

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

  • payload None-byte field formatted as a hex.
    There is no restriction on the value of this field.
dictionary SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.notifTupleTable = {}
static

Dictionary of all notification tuples.

string SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.RECEIVE = "receive"
static

RECEIVE notification.

Informs the application that a packet was received.

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

  • socketId 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • srcAddr 16-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • srcPort 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • payload None-byte field formatted as a hex.
    There is no restriction on the value of this field.
string SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.TIMEINDICATION = "timeIndication"
static

TIMEINDICATION notification.

The timeIndication notification applies to mote products that support a time interrupt into the mote. The time packet includes the network time and the current UTC time relative to the manager.

For LTC5800-IPM based products, driving the TIMEn pin low (assert) wakes the processor. The pin must asserted for a minimum of t strobe s. De-asserting the pin latches the time, and a timeIndication will be generated within t response ms.Refer to the LTC5800-IPM Datasheet for additional information about TIME pin usage. The processor will remain awake and drawing current while the TIMEn pin is asserted. To avoid drawing excess current, take care to minimize the duration of the TIMEn pin being asserted past t strobe minimum.

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

  • uptime 4-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.
  • asn 5-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • asnOffset 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_bindSocket = collections.namedtuple("Tuple_dn_bindSocket", ['RC'])
static

The named tuple returned by the dn_bindSocket() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_clearNV = collections.namedtuple("Tuple_dn_clearNV", ['RC'])
static

The named tuple returned by the dn_clearNV() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_closeSocket = collections.namedtuple("Tuple_dn_closeSocket", ['RC'])
static

The named tuple returned by the dn_closeSocket() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_disconnect = collections.namedtuple("Tuple_dn_disconnect", ['RC'])
static

The named tuple returned by the dn_disconnect() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_antGain = collections.namedtuple("Tuple_dn_getParameter_antGain", ['RC', 'antGain'])
static

The named tuple returned by the dn_getParameter_antGain() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • antGain: 1-byte field formatted as a ints.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_appInfo = collections.namedtuple("Tuple_dn_getParameter_appInfo", ['RC', 'vendorId', 'appId', 'appVer'])
static

The named tuple returned by the dn_getParameter_appInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • vendorId: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • appId: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • appVer: 5-byte field formatted as a hex.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_autoJoin = collections.namedtuple("Tuple_dn_getParameter_autoJoin", ['RC', 'autoJoin'])
static

The named tuple returned by the dn_getParameter_autoJoin() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • autoJoin: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_charge = collections.namedtuple("Tuple_dn_getParameter_charge", ['RC', 'qTotal', 'upTime', 'tempInt', 'tempFrac'])
static

The named tuple returned by the dn_getParameter_charge() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • qTotal: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • upTime: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • tempInt: 1-byte field formatted as a ints.
    There is no restriction on the value of this field.
  • tempFrac: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_euCompliantMode = collections.namedtuple("Tuple_dn_getParameter_euCompliantMode", ['RC', 'compMode'])
static

The named tuple returned by the dn_getParameter_euCompliantMode() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • compMode: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_eventMask = collections.namedtuple("Tuple_dn_getParameter_eventMask", ['RC', 'eventMask'])
static

The named tuple returned by the dn_getParameter_eventMask() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • eventMask: 4-byte field formatted as a hex.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_ipv6Address = collections.namedtuple("Tuple_dn_getParameter_ipv6Address", ['RC', 'ipv6Address'])
static

The named tuple returned by the dn_getParameter_ipv6Address() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • ipv6Address: 16-byte field formatted as a hex.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_joinDutyCycle = collections.namedtuple("Tuple_dn_getParameter_joinDutyCycle", ['RC', 'joinDutyCycle'])
static

The named tuple returned by the dn_getParameter_joinDutyCycle() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • joinDutyCycle: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_macAddress = collections.namedtuple("Tuple_dn_getParameter_macAddress", ['RC', 'macAddress'])
static

The named tuple returned by the dn_getParameter_macAddress() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • macAddress: 8-byte field formatted as a hex.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_moteId = collections.namedtuple("Tuple_dn_getParameter_moteId", ['RC', 'moteId'])
static

The named tuple returned by the dn_getParameter_moteId() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • moteId: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_moteInfo = collections.namedtuple("Tuple_dn_getParameter_moteInfo", ['RC', 'apiVersion', 'serialNumber', 'hwModel', 'hwRev', 'swVerMajor', 'swVerMinor', 'swVerPatch', 'swVerBuild', 'bootSwVer'])
static

The named tuple returned by the dn_getParameter_moteInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • apiVersion: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • serialNumber: 8-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • hwModel: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • hwRev: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swVerMajor: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swVerMinor: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swVerPatch: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • swVerBuild: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • bootSwVer: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_moteStatus = collections.namedtuple("Tuple_dn_getParameter_moteStatus", ['RC', 'state', 'reserved_0', 'reserved_1', 'numParents', 'alarms', 'reserved_2'])
static

The named tuple returned by the dn_getParameter_moteStatus() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • state: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: init
    • 1: idle
    • 2: searching
    • 3: negotiating
    • 4: connected
    • 5: operational
    • 6: disconnected
    • 7: radiotest
    • 8: promiscuous listen
  • reserved_0: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • reserved_1: 2-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.
  • alarms: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
  • reserved_2: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_netInfo = collections.namedtuple("Tuple_dn_getParameter_netInfo", ['RC', 'macAddress', 'moteId', 'networkId', 'slotSize'])
static

The named tuple returned by the dn_getParameter_netInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • macAddress: 8-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • moteId: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • networkId: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • slotSize: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_networkId = collections.namedtuple("Tuple_dn_getParameter_networkId", ['RC', 'networkId'])
static

The named tuple returned by the dn_getParameter_networkId() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • networkId: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_OTAPLockout = collections.namedtuple("Tuple_dn_getParameter_OTAPLockout", ['RC', 'mode'])
static

The named tuple returned by the dn_getParameter_OTAPLockout() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • mode: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_powerSrcInfo = collections.namedtuple("Tuple_dn_getParameter_powerSrcInfo", ['RC', 'maxStCurrent', 'minLifetime', 'currentLimit_0', 'dischargePeriod_0', 'rechargePeriod_0', 'currentLimit_1', 'dischargePeriod_1', 'rechargePeriod_1', 'currentLimit_2', 'dischargePeriod_2', 'rechargePeriod_2'])
static

The named tuple returned by the dn_getParameter_powerSrcInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • maxStCurrent: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • minLifetime: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • currentLimit_0: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • dischargePeriod_0: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • rechargePeriod_0: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • currentLimit_1: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • dischargePeriod_1: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • rechargePeriod_1: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • currentLimit_2: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • dischargePeriod_2: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • rechargePeriod_2: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_routingMode = collections.namedtuple("Tuple_dn_getParameter_routingMode", ['RC', 'routingMode'])
static

The named tuple returned by the dn_getParameter_routingMode() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • routingMode: 1-byte field formatted as a bool.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_testRadioRxStats = collections.namedtuple("Tuple_dn_getParameter_testRadioRxStats", ['RC', 'rxOk', 'rxFailed'])
static

The named tuple returned by the dn_getParameter_testRadioRxStats() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • rxOk: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • rxFailed: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_time = collections.namedtuple("Tuple_dn_getParameter_time", ['RC', 'upTime', 'utcSecs', 'utcUsecs', 'asn', 'asnOffset'])
static

The named tuple returned by the dn_getParameter_time() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • upTime: 4-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.
  • asn: 5-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • asnOffset: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getParameter_txPower = collections.namedtuple("Tuple_dn_getParameter_txPower", ['RC', 'txPower'])
static

The named tuple returned by the dn_getParameter_txPower() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • txPower: 1-byte field formatted as a ints.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_getServiceInfo = collections.namedtuple("Tuple_dn_getServiceInfo", ['RC', 'destAddr', 'type', 'state', 'value'])
static

The named tuple returned by the dn_getServiceInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • destAddr: 2-byte field formatted as a hex.
    There is no restriction on the value of this field.
  • type: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: bandwidth
  • state: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: completed
    • 1: pending
  • value: 4-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_join = collections.namedtuple("Tuple_dn_join", ['RC'])
static

The named tuple returned by the dn_join() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_lowPowerSleep = collections.namedtuple("Tuple_dn_lowPowerSleep", ['RC'])
static

The named tuple returned by the dn_lowPowerSleep() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_openSocket = collections.namedtuple("Tuple_dn_openSocket", ['RC', 'socketId'])
static

The named tuple returned by the dn_openSocket() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • socketId: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_requestService = collections.namedtuple("Tuple_dn_requestService", ['RC'])
static

The named tuple returned by the dn_requestService() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_reset = collections.namedtuple("Tuple_dn_reset", ['RC'])
static

The named tuple returned by the dn_reset() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_search = collections.namedtuple("Tuple_dn_search", ['RC'])
static

The named tuple returned by the dn_search() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_sendTo = collections.namedtuple("Tuple_dn_sendTo", ['RC'])
static

The named tuple returned by the dn_sendTo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_advKey = collections.namedtuple("Tuple_dn_setParameter_advKey", ['RC'])
static

The named tuple returned by the dn_setParameter_advKey() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_antGain = collections.namedtuple("Tuple_dn_setParameter_antGain", ['RC'])
static

The named tuple returned by the dn_setParameter_antGain() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_autoJoin = collections.namedtuple("Tuple_dn_setParameter_autoJoin", ['RC'])
static

The named tuple returned by the dn_setParameter_autoJoin() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_euCompliantMode = collections.namedtuple("Tuple_dn_setParameter_euCompliantMode", ['RC'])
static

The named tuple returned by the dn_setParameter_euCompliantMode() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_eventMask = collections.namedtuple("Tuple_dn_setParameter_eventMask", ['RC'])
static

The named tuple returned by the dn_setParameter_eventMask() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_joinDutyCycle = collections.namedtuple("Tuple_dn_setParameter_joinDutyCycle", ['RC'])
static

The named tuple returned by the dn_setParameter_joinDutyCycle() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_joinKey = collections.namedtuple("Tuple_dn_setParameter_joinKey", ['RC'])
static

The named tuple returned by the dn_setParameter_joinKey() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_macAddress = collections.namedtuple("Tuple_dn_setParameter_macAddress", ['RC'])
static

The named tuple returned by the dn_setParameter_macAddress() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_networkId = collections.namedtuple("Tuple_dn_setParameter_networkId", ['RC'])
static

The named tuple returned by the dn_setParameter_networkId() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_OTAPLockout = collections.namedtuple("Tuple_dn_setParameter_OTAPLockout", ['RC'])
static

The named tuple returned by the dn_setParameter_OTAPLockout() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_powerSrcInfo = collections.namedtuple("Tuple_dn_setParameter_powerSrcInfo", ['RC'])
static

The named tuple returned by the dn_setParameter_powerSrcInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_routingMode = collections.namedtuple("Tuple_dn_setParameter_routingMode", ['RC'])
static

The named tuple returned by the dn_setParameter_routingMode() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_setParameter_txPower = collections.namedtuple("Tuple_dn_setParameter_txPower", ['RC'])
static

The named tuple returned by the dn_setParameter_txPower() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_socketInfo = collections.namedtuple("Tuple_dn_socketInfo", ['RC', 'index', 'socketId', 'protocol', 'bindState', 'port'])
static

The named tuple returned by the dn_socketInfo() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
  • index: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • socketId: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • protocol: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • bindState: 1-byte field formatted as a int.
    There is no restriction on the value of this field.
  • port: 2-byte field formatted as a int.
    There is no restriction on the value of this field.
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_testRadioRx = collections.namedtuple("Tuple_dn_testRadioRx", ['RC'])
static

The named tuple returned by the dn_testRadioRx() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_testRadioTxExt = collections.namedtuple("Tuple_dn_testRadioTxExt", ['RC'])
static

The named tuple returned by the dn_testRadioTxExt() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
tuple SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.Tuple_dn_zeroize = collections.namedtuple("Tuple_dn_zeroize", ['RC'])
static

The named tuple returned by the dn_zeroize() function.

  • RC: 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: RC_OK
    • 1: RC_ERROR
    • 3: RC_BUSY
    • 4: RC_INVALID_LEN
    • 5: RC_INVALID_STATE
    • 6: RC_UNSUPPORTED
    • 7: RC_UNKNOWN_PARAM
    • 8: RC_UNKNOWN_CMD
    • 9: RC_WRITE_FAIL
    • 10: RC_READ_FAIL
    • 11: RC_LOW_VOLTAGE
    • 12: RC_NO_RESOURCES
    • 13: RC_INCOMPLETE_JOIN_INFO
    • 14: RC_NOT_FOUND
    • 15: RC_INVALID_VALUE
    • 16: RC_ACCESS_DENIED
    • 18: RC_ERASE_FAIL
string SmartMeshSDK.IpMoteConnector.IpMoteConnector.IpMoteConnector.TXDONE = "txDone"
static

TXDONE notification.

The txDone notification informs the application that the mote has finished sending a packet. This notification will only be generated if the user has provided a valid (0x0000-0xFFFE) packetID when calling the sendTo command.

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

  • packetId 2-byte field formatted as a int.
    There is no restriction on the value of this field.
  • status 1-byte field formatted as a int.
    This field can only take one of the following values:
    • 0: ok
    • 1: fail