Overview

Namespaces

  • App
    • CloudModule
      • Forms
      • Model
      • Presenters
    • ConfigModule
      • Forms
      • Model
      • Presenters
    • Forms
    • GatewayModule
      • Model
      • Presenters
    • IqrfAppModule
      • Forms
      • Model
      • Presenters
    • Model
    • Presenters
    • Router
    • ServiceModule
      • Model
      • Presenters
  • PHP
  • Test
    • ConfigModule
      • Model
    • IqrfAppModule
      • Model
    • Model
    • Router
    • ServiceModule
      • Model

Classes

  • App\CloudModule\Forms\CloudAwsMqttFormFactory
  • App\CloudModule\Forms\CloudAzureMqttFormFactory
  • App\CloudModule\Forms\CloudBluemixMqttFormFactory
  • App\CloudModule\Forms\CloudInteliGlueMqttFormFactory
  • App\CloudModule\Model\AwsManager
  • App\CloudModule\Model\AzureManager
  • App\CloudModule\Model\BluemixManager
  • App\CloudModule\Model\InteliGlueManager
  • App\CloudModule\Presenters\AwsPresenter
  • App\CloudModule\Presenters\AzurePresenter
  • App\CloudModule\Presenters\BluemixPresenter
  • App\CloudModule\Presenters\HomepagePresenter
  • App\CloudModule\Presenters\InteliGluePresenter
  • App\ConfigModule\Forms\ConfigBaseServiceFormFactory
  • App\ConfigModule\Forms\ConfigComponentsFormFactory
  • App\ConfigModule\Forms\ConfigIqrfAppFormFactory
  • App\ConfigModule\Forms\ConfigIqrfFormFactory
  • App\ConfigModule\Forms\ConfigMainFormFactory
  • App\ConfigModule\Forms\ConfigMqFormFactory
  • App\ConfigModule\Forms\ConfigMqttFormFactory
  • App\ConfigModule\Forms\ConfigSchedulerFormFactory
  • App\ConfigModule\Forms\ConfigTracerFormFactory
  • App\ConfigModule\Forms\ConfigUdpFormFactory
  • App\ConfigModule\Model\BaseServiceManager
  • App\ConfigModule\Model\ComponentManager
  • App\ConfigModule\Model\GenericManager
  • App\ConfigModule\Model\InstanceManager
  • App\ConfigModule\Model\IqrfManager
  • App\ConfigModule\Model\MainManager
  • App\ConfigModule\Model\SchedulerManager
  • App\ConfigModule\Presenters\BaseServicePresenter
  • App\ConfigModule\Presenters\HomepagePresenter
  • App\ConfigModule\Presenters\IqrfAppPresenter
  • App\ConfigModule\Presenters\IqrfPresenter
  • App\ConfigModule\Presenters\MainPresenter
  • App\ConfigModule\Presenters\MqPresenter
  • App\ConfigModule\Presenters\MqttPresenter
  • App\ConfigModule\Presenters\SchedulerPresenter
  • App\ConfigModule\Presenters\TracerPresenter
  • App\ConfigModule\Presenters\UdpPresenter
  • App\Forms\FormFactory
  • App\Forms\SignInFormFactory
  • App\GatewayModule\Model\InfoManager
  • App\GatewayModule\Model\LogManager
  • App\GatewayModule\Presenters\ChangeModePresenter
  • App\GatewayModule\Presenters\HomepagePresenter
  • App\GatewayModule\Presenters\InfoPresenter
  • App\GatewayModule\Presenters\LogPresenter
  • App\IqrfAppModule\Forms\IqrfAppSendRawFormFactory
  • App\IqrfAppModule\Forms\IqrfNetBondingFormFactory
  • App\IqrfAppModule\Forms\IqrfNetDiscoveryFormFactory
  • App\IqrfAppModule\Model\CoordinatorParser
  • App\IqrfAppModule\Model\IqrfAppManager
  • App\IqrfAppModule\Model\IqrfMacroManager
  • App\IqrfAppModule\Model\IqrfNetManager
  • App\IqrfAppModule\Model\OsParser
  • App\IqrfAppModule\Presenters\HomepagePresenter
  • App\IqrfAppModule\Presenters\NetworkPresenter
  • App\IqrfAppModule\Presenters\SendRawPresenter
  • App\Model\CommandManager
  • App\Model\FileManager
  • App\Model\JsonFileManager
  • App\Presenters\BasePresenter
  • App\Presenters\Error4xxPresenter
  • App\Presenters\ErrorPresenter
  • App\Presenters\HomepagePresenter
  • App\Presenters\SignPresenter
  • App\Router\RouterFactory
  • App\ServiceModule\Model\ServiceManager
  • App\ServiceModule\Presenters\ControlPresenter
  • App\ServiceModule\Presenters\StatusPresenter
  • Test\ConfigModule\Model\BaseServiceManagerTest
  • Test\ConfigModule\Model\ComponentManagerTest
  • Test\ConfigModule\Model\GenericManagerTest
  • Test\ConfigModule\Model\InstanceManagerTest
  • Test\ConfigModule\Model\IqrfManagerTest
  • Test\ConfigModule\Model\MainManagerTest
  • Test\ConfigModule\Model\SchedulerManagerTest
  • Test\IqrfAppModule\Model\CoordinatorParserTest
  • Test\IqrfAppModule\Model\IqrfAppManagerTest
  • Test\IqrfAppModule\Model\IqrfMacroManagerTest
  • Test\IqrfAppModule\Model\OsParserTest
  • Test\Model\CommandManagerTest
  • Test\Model\InfoManagerTest
  • Test\Model\JsonFileManagerTest
  • Test\Router\RouterFactoryTest
  • Test\ServiceModule\Model\ServiceManagerTest

Interfaces

  • Throwable

Exceptions

  • App\CloudModule\Model\InvalidConnectionString
  • App\IqrfAppModule\Model\EmptyResponseException
  • App\IqrfAppModule\Model\InvalidOperationModeException
  • App\ServiceModule\Model\NotSupportedInitSystemException
  • Exception
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 
<?php

/**
 * Copyright 2017 MICRORISC s.r.o.
 * Copyright 2017 IQRF Tech s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

declare(strict_types=1);

namespace App\IqrfAppModule\Model;

use App\IqrfAppModule\Model\IqrfAppManager;
use Nette;
use Nette\Utils\Strings;

/**
 * Tool for managing IQMESH network.
 */
class IqrfNetManager {

    use Nette\SmartObject;

    /**
     * @var IqrfAppManager
     */
    private $iqrfAppManager;

    /**
     * Constructor
     * @param IqrfAppManager $iqrfAppManager
     */
    public function __construct(IqrfAppManager $iqrfAppManager) {
        $this->iqrfAppManager = $iqrfAppManager;
    }

    /**
     * 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.
     * @return array DPA request and response
     */
    public function clearAllBonds() {
        $packet = '00.00.00.03.ff.ff';
        return $this->iqrfAppManager->sendRaw($packet);
    }

    /**
     * This command bonds a new node by the coordinator.
     * There is a maximum approx. 12 s blocking delay when this function is called.
     * @param string $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.
     * @return array DPA request and response
     */
    public function bondNode(string $address = '00') {
        $packet = '00.00.00.04.ff.ff.' . $address . '.00';
        $timeout = 12000;
        return $this->iqrfAppManager->sendRaw($packet, $timeout);
    }

    /**
     * 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.
     * @param string $txPower TX Power used for discovery.
     * @param string $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.
     * @return array DPA request and response
     */
    public function discovery(string $txPower = '00', string $maxAddress = '00') {
        $packet = '00.00.00.07.ff.ff.' . Strings::padLeft($txPower, 2, '0')
                . '.' . dechex($maxAddress);
        $timeout = 0;
        return $this->iqrfAppManager->sendRaw($packet, $timeout);
    }

    /**
     * Removes already bonded node from the list of bonded nodes at coordinator memory.
     * @param string $address Address of the node to remove the bond to
     * @return array DPA request and response
     */
    public function removeNode(string $address) {
        $packet = '00.00.00.05.ff.ff.' . $address;
        return $this->iqrfAppManager->sendRaw($packet);
    }

    /**
     * Puts specified node back to the list of bonded nodes in the coordinator memory.
     * @param string $address Number of bonded network nodes
     * @return array DPA request and response
     */
    public function rebondNode(string $address) {
        $packet = '00.00.00.06.ff.ff.' . $address;
        return $this->iqrfAppManager->sendRaw($packet);
    }

}
IQRF Gateway Daemon webapp API documentation generated by ApiGen