\App\IqrfNetModule\ModelsDiscoveryManager

Tool for running discovery process in an IQMESH network

Summary

Methods
Properties
Constants
__construct()
run()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(\App\IqrfNetModule\Models\ApiRequest  request, \App\IqrfNetModule\Models\WebSocketClient  wsClient) : 

Constructor

Parameters

\App\IqrfNetModule\Models\ApiRequest request

JSON API request

\App\IqrfNetModule\Models\WebSocketClient wsClient

WebSocket client

Returns

run()

run(  txPower = 6,   maxAddress) : 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\Models\DpaErrorException
\App\IqrfNetModule\Models\EmptyResponseException
\App\IqrfNetModule\Models\JsonException
\App\IqrfNetModule\Models\UserErrorException

Returns

mixed||string|int —

API request and response