\App\IqrfNetModule\ModelsBondingManager

Tool for managing bonds in an IQMESH network

Summary

Methods
Properties
Constants
__construct()
bondLocal()
bondSmartConnect()
clearAll()
rebond()
remove()
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

bondLocal()

bondLocal(  address) : mixed||string|int

Bonds a node locally

Parameters

address

A requested address for the bonded node. If this parameter equals to 0, then the first free address is assigned to the node.

Throws

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

Returns

mixed||string|int —

API request and response

bondSmartConnect()

bondSmartConnect(  address,   code,   testRetries = 1) : mixed||string|int

Bonds a node via IQRF Smart Connect

Parameters

address

Address to bond the device to

code

Smart connect code of the device

testRetries

Maximum number of FRCs used to test whether the Node was successfully bonded.

Throws

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

Returns

mixed||string|int —

API request and response

clearAll()

clearAll() : mixed||string|int

Clears all bonds

Throws

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

Returns

mixed||string|int —

API request and response

rebond()

rebond(  address) : mixed||string|int

Re-bonds a node

Parameters

address

Address of the node to be re-bonded

Throws

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

Returns

mixed||string|int —

API request and response

remove()

remove(  address) : mixed||string|int

Removes a bond

Parameters

address

Address of the node to be removed

Throws

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

Returns

mixed||string|int —

API request and response