Constants

ALTERNATIVE_RF_CHANNEL_A

ALTERNATIVE_RF_CHANNEL_A = 06

Alternative RF channel A

ALTERNATIVE_RF_CHANNEL_B

ALTERNATIVE_RF_CHANNEL_B = 07

Alternative RF channel B

MAIN_RF_CHANNEL_A

MAIN_RF_CHANNEL_A = 11

Main RF channel A

MAIN_RF_CHANNEL_B

MAIN_RF_CHANNEL_B = 12

Main RF channel B

DATA_FORMAT_ASCII

DATA_FORMAT_ASCII = ASCII

ASCII data format

DATA_FORMAT_HEX

DATA_FORMAT_HEX = HEX

HEX data format

SECURITY_ACCESS_PASSWORD

SECURITY_ACCESS_PASSWORD = accessPassword

IQMESH Security Access password

SECURITY_USER_KEY

SECURITY_USER_KEY = userKey

IQMESH Security User key

Methods

__construct()

__construct(\App\IqrfNetModule\Models\DpaRawManager  manager) : 

Constructor

Parameters

\App\IqrfNetModule\Models\DpaRawManager manager

DPA raw request and response manager

Returns

clearAllBonds()

clearAllBonds() : mixed||string|int

The command removes all nodes from the list of bonded nodes at coordinator memory.

It actually destroys the network from the coordinator point of view.

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

bondNode()

bondNode(  address = 00) : mixed||string|int

This command bonds a new node by the coordinator.

There is a maximum approx. 12 s blocking delay when this function is called.

Parameters

address

A requested address for the bonded node. The address must not be used (bonded) yet. If this parameter equals to 0, then the 1 free address is assigned to the node.

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

discovery()

discovery(  txPower,   maxAddress = 00) : mixed||string|int

Runs IQMESH discovery process.

The time when the response is delivered depends highly on the number of network devices, the network topology, and RF mode, thus, it is not predictable. It can take from a few seconds to many minutes.

Parameters

txPower

TX Power used for discovery.

maxAddress

Nonzero value specifies maximum node address to be part of the discovery process. This feature allows splitting all node devices into two parts: [1] devices having an address from 1 to MaxAddr will be part of the discovery process thus they become routers, [2] devices having an address from MaxAddr+1 to 239 will not be routers. See IQRF OS documentation for more information. The value of this parameter is ignored at demo version. A value 5 is always used instead.

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

removeNode()

removeNode(  address) : mixed||string|int

Removes already bonded node from the list of bonded nodes at coordinator memory.

Parameters

address

Address of the node to remove the bond to

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

rebondNode()

rebondNode(  address) : mixed||string|int

Puts specified node back to the list of bonded nodes in the coordinator memory.

Parameters

address

Number of bonded network nodes

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

readHwpConfiguration()

readHwpConfiguration() : mixed||string|int

The command read HWP configuration

Throws

\App\IqrfNetModule\Exceptions\DpaErrorException
\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Exceptions\UserErrorException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

setRfChannel()

setRfChannel(  channel,   type) : mixed||string|int

Set RF channel

Parameters

channel

RF channel ID

type

RF channel type

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Exceptions\InvalidRfChannelTypeException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

writeHwpConfigurationByte()

writeHwpConfigurationByte(  address,   value,   mask = ff) : mixed||string|int

Write HWP configuration byte

Parameters

address

Address of the item at configuration memory block.

value

Value of the configuration item to write.

mask

Specifies bits of the configuration byte to be modified by the corresponding bits of the Value parameter. Only bits that are set at the Mask will be written to the configuration byte i.e. when Mask equals to 0xFF then the whole Value will be written to the configuration byte. For example, when Mask equals to 0x12 then only bit.1 and bit.4 from Value will be written to the configuration byte.

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

setRfLpTimeout()

setRfLpTimeout(  timeout) : mixed||string|int

Set RF LP timeout

Parameters

timeout

RF LP timeout

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Exceptions\InvalidRfLpTimeoutException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

setRfOutputPower()

setRfOutputPower(  power) : mixed||string|int

Set RF output power

Parameters

power

RF output power

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Exceptions\InvalidRfOutputPowerException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response

setRfSignalFilter()

setRfSignalFilter(  filter) : mixed||string|int

Set RF signal filter

Parameters

filter

RF signal filter

Throws

\App\IqrfNetModule\Exceptions\EmptyResponseException
\App\IqrfNetModule\Exceptions\InvalidRfSignalFilterException
\App\IqrfNetModule\Models\JsonException

Returns

mixed||string|int —

DPA request and response