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: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 
<?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\CoordinatorParser;
use App\IqrfAppModule\Model\EmptyResponseException;
use App\IqrfAppModule\Model\InvalidOperationModeException;
use App\IqrfAppModule\Model\OsParser;
use App\Model\CommandManager;
use DateTime;
use Nette;
use Nette\Utils\Json;
use Tracy\Debugger;

/**
 * Tool for contoling iqrfapp.
 */
class IqrfAppManager {

    use Nette\SmartObject;

    /**
     * @var CommandManager Command manager
     */
    private $commandManager;

    /**
     * @var CoordinatorParser Parser for DPA Coordinator responses
     */
    private $coordinatorParser;

    /**
     * @var OsParser Parser for DPA OS responses
     */
    private $osParser;

    /**
     * Constructor
     * @param CommandManager $commandManager Command manager
     * @param CoordinatorParser $coordinatorParser Parser for DPA Coordinator responses
     * @param OsParser $osParser Parser for DPA OS responses
     */
    public function __construct(CommandManager $commandManager, CoordinatorParser $coordinatorParser, OsParser $osParser) {
        $this->commandManager = $commandManager;
        $this->coordinatorParser = $coordinatorParser;
        $this->osParser = $osParser;
    }

    /**
     * Send JSON request to iqrfapp
     * @param array $array JSON request on array
     * @return string JSON response
     */
    public function sendCommand(array $array) {
        $cmd = 'iqrfapp "' . str_replace('"', '\\"', Json::encode($array)) . '"';
        return $this->commandManager->send($cmd, true);
    }

    /**
     * Send RAW IQRF packet
     * @param string $packet RAW IQRF packet
     * @param int $timeout DPA timeout in milliseconds
     * @return array DPA request and response
     */
    public function sendRaw(string $packet, int $timeout = null) {
        $now = new DateTime();
        $array = [
            'ctype' => 'dpa',
            'type' => 'raw',
            'msgid' => (string) $now->getTimestamp(),
            'timeout' => (int) $timeout,
            'request' => $packet,
            'request_ts' => '',
            'confirmation' => '',
            'confirmation_ts' => '',
            'response' => '',
            'response_ts' => '',
        ];
        if (!isset($timeout)) {
            unset($array['timeout']);
        }
        // Workaround to fix mismatched msgid
        $this->readOnly(200);
        $commandOutput = $this->sendCommand($array);
        if (empty($commandOutput)) {
            throw new EmptyResponseException();
        }
        preg_match('/Received: {(.*?)\}/s', $commandOutput, $output);
        $response = !empty($output) ? str_replace('Received: ', '', $output[0]) : null;
        $data = [
            'request' => Json::encode($array, Json::PRETTY),
            'response' => $response,
        ];
        Debugger::barDump($data, 'iqrfapp');
        return $data;
    }

    /**
     * Read only (async) DPA packet
     * @param int $timeout DPA timeout in milliseconds
     * @return string JSON response
     */
    public function readOnly(int $timeout = null) {
        $cmd = 'iqrfapp readonly';
        $cmd .= isset($timeout) ? ' timeout ' . $timeout : '';
        return $this->commandManager->send($cmd, true);
    }

    /**
     * Change iqrf-daemon operation mode
     * @param string $mode iqrf-daemon operation mode
     * @return string Response
     * @throws InvalidOperationModeException
     */
    public function changeOperationMode(string $mode) {
        $modes = ['forwarding', 'operational', 'service'];
        if (!in_array($mode, $modes, true)) {
            throw new InvalidOperationModeException();
        }
        $array = [
            'ctype' => 'conf',
            'type' => 'mode',
            'cmd' => $mode,
        ];
        return $this->sendCommand($array);
    }

    /**
     * Validate raw IQRF packet
     * @param string $packet Raw IQRF packet
     * @return bool Status
     */
    public function validatePacket(string $packet) {
        $pattern = '/^([0-9a-fA-F]{1,2}\.){4,62}[0-9a-fA-F]{1,2}(\.|)$/';
        return (bool) preg_match($pattern, $packet);
    }

    /**
     * Parse DPA response
     * @param string $json JSON DPA response
     * @return array Parsed response in array
     * @throws EmptyResponseException
     */
    public function parseResponse(array $json) {
        $jsonResponse = $json['response'];
        if (empty($jsonResponse) || $jsonResponse === 'Timeout') {
            throw new EmptyResponseException();
        }
        $response = Json::decode($jsonResponse, Json::FORCE_ARRAY);
        $status = $response['status'];
        if ($status !== 'STATUS_NO_ERROR') {
            return null;
            // TODO: throw own exception
        }
        $packet = $response['response'];
        if (empty($packet)) {
            throw new EmptyResponseException();
        }
        $pnum = explode('.', $packet)[2];
        switch ($pnum) {
            case '00':
                return $this->coordinatorParser->parse($packet);
            case '02':
                return $this->osParser->parse($packet);
            default:
                return null;
        }
    }

}
IQRF Gateway Daemon webapp API documentation generated by ApiGen