use socket and promise

Author: ggottwald

README.md

@@ -3,20 +3,17 @@ With this package you can control Xiaomi Mi Home devices that implement the miIO
 Mi Robot Vacuum and other Smart Home devices.
 These devices are commonly part of what Xiaomi calls the Mi Ecosystem which is branded as MiJia.
 
-# Example
+# Example for Laravel
 Get device info, status and start cleaning of mi robot vacuum
 
-    $device = new Device();
+    $miio = app(MiIO::class);
 
-    $device
-        ->setDeviceName('mirobot_vacuum')
-        ->setToken('00112233445566778899aabbccddeeff');
-        
-    $miio = new MiIO();
+    $device = $miio->createDevice('mirobot_vacuum', '00112233445566778899aabbccddeeff');
 
-    $deviceInfoResult = $miio->getInfo($device);
-    
-    $statusResult = $miio->send($device, 'get_status');
+    $miio->send($device, 'get_status');
+    $miio->read($device)->done(function($response) {
+        $response->getResult();
+    });
 
     $miio->send($device, 'app_start'); // start cleaning
 

composer.json

@@ -1,20 +1,22 @@
 {
-    "name": "ggottwald/miio",
-    "description": "Control Xiaomi Mi Home devices",
-    "type": "library",
-    "require": {
-        "php": ">=7.0"
-    },
-    "license": "GNU AFFERO GENERAL PUBLIC LICENSE",
-    "authors": [
-        {
-            "name": "Götz Gottwald",
-            "email": "goetz.gottwald@gmx.net"
-        }
-    ],
-    "autoload": {
-        "psr-4": {
-            "MiIO\\": "src/"
-        }
+  "name": "ggottwald/miio",
+  "description": "Control Xiaomi Mi Home devices",
+  "type": "library",
+  "require": {
+    "php": ">=7.0",
+    "clue/socket-raw": "~1.2",
+    "react/promise": "^2.5"
+  },
+  "license": "GNU AFFERO GENERAL PUBLIC LICENSE",
+  "authors": [
+    {
+      "name": "Götz Gottwald",
+      "email": "goetz.gottwald@gmx.net"
     }
+  ],
+  "autoload": {
+    "psr-4": {
+      "MiIO\\": "src/"
+    }
+  }
 }

src/Exceptions/DeviceCommandException.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace MiIO\Exceptions;
+
+class DeviceCommandException extends Exception
+{
+    /**
+     * @var int
+     */
+    private $deviceId;
+
+    /**
+     * DeviceCommandException constructor.
+     *
+     * @param string $message
+     * @param int    $code
+     * @param int    $deviceId
+     */
+    public function __construct(string $message, int $code, int $deviceId)
+    {
+        parent::__construct($message, $code);
+        $this->deviceId = $deviceId;
+    }
+
+    /**
+     * @return int
+     */
+    public function getDeviceId(): int
+    {
+        return $this->deviceId;
+    }
+}

src/Exceptions/Exception.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MiIO\Exceptions;
+
+class Exception extends \Exception
+{
+
+}

src/MiIO.php

@@ -5,6 +5,9 @@
 use MiIO\Models\Device;
 use MiIO\Models\Packet;
 use MiIO\Models\Request;
+use MiIO\Models\Response;
+use React\Promise\Promise;
+use Socket\Raw\Factory;
 
 /**
  * Class MiIO
@@ -15,19 +18,37 @@ class MiIO
 {
     const CACHE_KEY = 'MiIO';
 
-    const PORT = 54321;
+    const INFO = 'miIO.info';
 
-    const TIMEOUT = 5;
+    /**
+     * @var Factory
+     */
+    protected $socketFactory;
 
-    const INFO = 'miIO.info';
+    public function __construct(Factory $socketFactory)
+    {
+        $this->socketFactory = $socketFactory;
+    }
+
+    /**
+     * @param string $deviceName
+     * @param string $token
+     * @return Device
+     */
+    public function createDevice(string $deviceName, string $token)
+    {
+        return new Device($this->socketFactory->createUdp4(), $deviceName, $token);
+    }
 
     /**
      * @param Device $device
-     * @return array
+     * @return Promise
      */
     public function getInfo(Device $device)
     {
-        return $this->send($device, static::INFO);
+        $this->send($device, static::INFO);
+
+        return $this->read($device);
     }
 
     /**
@@ -36,77 +57,51 @@ public function getInfo(Device $device)
      */
     private function init(Device &$device)
     {
-        if (strlen($device->getIpAddress())) {
-            $packet = new Packet();
-            $helo = $packet->getHelo();
-
-            $start = time();
-            $socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
-
-            while (time() < ($start + 10)) {
-                $response = $this->getSocketResponse($device->getIpAddress(), $socket, $helo);
-
-                if (!empty($response)) {
-                    $response = bin2hex($response);
-                }
-
-                if (!empty($response)) {
-                    $packet = new Packet($response);
-                    if ($packet->getDeviceType()
-                        && $packet->getSerial()) {
-                        $device->setDeviceType($packet->getDeviceType());
-                        $device->setSerial($packet->getSerial());
-                        $device->setTimeDelta(hexdec($packet->getTimestamp()) - time());
-                        socket_close($socket);
-
-                        return $device;
-                    }
-                }
-            }
-            if ($socket) {
-                socket_close($socket);
+        $packet = new Packet();
+        $helo = $packet->getHelo();
+
+        $device->send($helo);
+        $response = $device->read();
+
+        if (!empty($response)) {
+            $response = bin2hex($response);
+        }
+
+        if (!empty($response)) {
+
+            $packet = new Packet($response);
+
+            if ($packet->getDeviceType()
+                && $packet->getSerial()) {
+
+                $device->setDeviceType($packet->getDeviceType());
+                $device->setSerial($packet->getSerial());
+                $device->setTimeDelta(hexdec($packet->getTimestamp()) - time());
             }
         }
 
-        return null;
+        return $device;
     }
 
     /**
      * @param Device $device
      * @param string $command
      * @param array  $params
-     * @return array
      */
     public function send(Device $device, $command, $params = [])
     {
         if (!$device->isInitialized()) {
             $this->init($device);
         }
 
-        if (!$device->isInitialized()) {
-            return [];
-        }
+        $cacheKey = static::CACHE_KEY . $device->getIpAddress();
+        $requestId = \Cache::increment($cacheKey);
 
         $request = new Request();
         $request
             ->setMethod($command)
-            ->setParams($params);
-
-        return $this->getResponse($device, $request);
-    }
-
-    /**
-     * @param Device  $device
-     * @param Request $request
-     * @return array
-     */
-    public function getResponse(Device $device, Request $request)
-    {
-        $cacheKey = static::CACHE_KEY . $device->getIpAddress();
-        $requestId = (int)\Cache::get($cacheKey);
-        \Cache::forever($cacheKey, $requestId + 1);
-
-        $request->setId($requestId);
+            ->setParams($params)
+            ->setId($requestId);
 
         $data = $device->encrypt($request);
 
@@ -115,73 +110,35 @@ public function getResponse(Device $device, Request $request)
             ->setData($data)
             ->setDevice($device);
 
-        $start = time();
-        $socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
-
-        while (time() < ($start + 10)) {
-            $packet->setTimestamp($device->getTimeDelta() + time());
-            $response = $this->getSocketResponse($device->getIpAddress(), $socket, (string)$packet);
-
-            if (!empty($response)) {
-                $response = bin2hex($response);
-            }
-
-            $result = $this->decrypt($device, $response);
-
-            if (strlen($result)) {
-                $response = json_decode(preg_replace('/[\x00-\x1F\x7F]/', '', $result), true);
-
-                if (!empty($response['id']) && $response['id'] === $requestId) {
-                    socket_close($socket);
-
-                    return $response;
-                }
-            }
-        }
-
-        return [];
+        $device->send((string)$packet);
     }
 
     /**
-     * @param string    $ip
-     * @param \Resource $socket
-     * @param string    $data
-     * @return string|null
+     * @param Device $device
+     * @return Promise
      */
-    private function getSocketResponse($ip, $socket, $data)
+    public function read(Device $device)
     {
-        if (ctype_xdigit($data)) {
-            $data = hex2bin($data);
-        }
-
-        $buf = null;
+        return new Promise(function (callable $resolve, callable $reject) use ($device) {
+            $buf = $device->read();
 
-        try {
-            socket_set_option($socket, SOL_SOCKET, SO_BROADCAST, 1);
-            socket_set_option($socket, SOL_SOCKET, SO_RCVTIMEO, ['sec' => 5, 'usec' => 0]);
+            if (!empty($buf)) {
+                $buf = bin2hex($buf);
+            }
 
-            socket_sendto($socket, $data, strlen($data), 0, $ip, static::PORT);
+            $packet = new Packet($buf);
+            $result = $device->decrypt($packet->getData());
 
-            socket_recvfrom($socket, $buf, 1024, 0, $name, $port);
-        } catch (\Throwable $e) {
-        }
+            $response = new Response(
+                json_decode(preg_replace('/[\x00-\x1F\x7F]/', '', $result), true)
+            );
 
-        return $buf;
-    }
+            if ($response->isSuccess()) {
+                $resolve($response);
 
-    /**
-     * @param Device $device
-     * @param string $response
-     * @return string
-     */
-    private function decrypt(Device $device, $response)
-    {
-        if (!empty($response)) {
-            $packet = new Packet($response);
-
-            return $device->decrypt($packet->getData());
-        }
-
-        return '';
+                return;
+            }
+            $reject($response->getException());
+        });
     }
 }