Skip to content

Commit

Permalink
2.5.3
Browse files Browse the repository at this point in the history 
- updated Devices class to newest version from https://github.com/PJanisio/ewelinkApiPhp
- updated websocket.php with implementation of new method setDataWebsocket
- code formating
  • Loading branch information
@PJanisio
PJanisio committed Jul 3, 2024
1 parent e990754 commit 42c302c
Show file tree
Hide file tree
Showing 2 changed files with 142 additions and 87 deletions.
40 changes: 20 additions & 20 deletions php/websocket.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,28 @@
echo json_encode(['success' => true, 'data' => $response]);
break;
case 'updateDeviceState':
$newState = $_GET['newState'] ?? null;
$outlet = $_GET['outlet'] ?? null; // Add outlet parameter
if ($newState === null) {
echo json_encode(['success' => false, 'error' => 'New state not provided']);
break;
}
if ($outlet !== null) {
$params = [
'switch' => $newState,
'outlet' => (int)$outlet
];
} else {
$params = [
'switch' => $newState
];
}
$response = $devices->forceUpdateDevice($deviceIdentifier, $params);
echo json_encode(['success' => true, 'data' => $response]);
break;
$newState = $_GET['newState'] ?? null;
$outlet = $_GET['outlet'] ?? null; // Add outlet parameter
if ($newState === null) {
echo json_encode(['success' => false, 'error' => 'New state not provided']);
break;
}
if ($outlet !== null) {
$params = [
'switch' => $newState,
'outlet' => (int)$outlet
];
} else {
$params = [
'switch' => $newState
];
}
$response = $devices->setDataWebSocket($deviceIdentifier, $params);
echo json_encode(['success' => true, 'data' => $response]);
break;
case 'forceUpdateDevice':
$params = json_decode($params, true);
$response = $devices->forceUpdateDevice($deviceIdentifier, $params);
$response = $devices->setDataWebSocket($deviceIdentifier, $params);
echo json_encode(['success' => true, 'data' => $response]);
break;
default:
Expand Down
189 changes: 122 additions & 67 deletions src/Devices.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* Dependencies: PHP 7.4+
* Description: API connector for Sonoff / ewelink devices
*/


require_once __DIR__ . '/WebSocketClient.php';
require_once __DIR__ . '/Utils.php';
Expand Down Expand Up @@ -193,42 +194,42 @@ public function searchDeviceParam($searchKey, $identifier) {
* @throws Exception If there is an error in the response.
*/
public function getDeviceParamLive($identifier, $param, $type = 1) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$endpoint = '/v2/device/thing/status';
if (is_array($param)) {
$paramString = implode('|', $param);
} else {
$paramString = $param;
}
$queryParams = [
'id' => $deviceId,
'type' => $type,
'params' => $paramString
];

$response = $this->httpClient->getRequest($endpoint, $queryParams);

if (isset($response['error']) && $response['error'] != 0) {
$errorCode = $response['error'];
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception("Error: $errorMsg");
}
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$endpoint = '/v2/device/thing/status';
if (is_array($param)) {
$paramString = implode('|', $param);
} else {
$paramString = $param;
}
$queryParams = [
'id' => $deviceId,
'type' => $type,
'params' => $paramString
];

$responseParams = $response['params'] ?? [];
$response = $this->httpClient->getRequest($endpoint, $queryParams);

if (is_array($param)) {
$result = [];
foreach ($param as $p) {
$result[$p] = $responseParams[$p] ?? 0; // Default to 0 if the parameter is missing
if (isset($response['error']) && $response['error'] != 0) {
$errorCode = $response['error'];
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception("Error: $errorMsg");
}

$responseParams = $response['params'] ?? [];

if (is_array($param)) {
$result = [];
foreach ($param as $p) {
$result[$p] = $responseParams[$p] ?? 0; // Default to 0 if the parameter is missing
}
return $result;
} else {
return $responseParams[$param] ?? 0; // Default to 0 if the parameter is missing
}
return $result;
} else {
return $responseParams[$param] ?? 0; // Default to 0 if the parameter is missing
}
}


/**
Expand Down Expand Up @@ -270,10 +271,11 @@ public function getAllDeviceParamLive($identifier, $type = 1) {
*
* @param string $identifier The device name or ID.
* @param array $params The parameters to set.
* @return string The result of the status update.
* @param int $returnText The flag to determine the return type (1 for detailed report, 0 for boolean).
* @return mixed The result of the status update, either a string or a boolean.
* @throws Exception If there is an error in the response or if a parameter does not exist.
*/
public function setDeviceStatus($identifier, $params) {
public function setDeviceStatus($identifier, $params, $returnText = 1) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
Expand All @@ -282,7 +284,7 @@ public function setDeviceStatus($identifier, $params) {
$currentParams = $this->getAllDeviceParamLive($deviceId) ?? null;

if ($currentParams === null) {
return "Device $deviceId does not have any parameters to update.";
return $returnText ? "Device $deviceId does not have any parameters to update." : false;
}

$isMultiChannel = $this->isMultiChannel($deviceId);
Expand Down Expand Up @@ -320,14 +322,14 @@ public function setDeviceStatus($identifier, $params) {
}
}
if (!$found) {
return "Outlet $outlet does not exist for device $deviceId.";
return $returnText ? "Outlet $outlet does not exist for device $deviceId." : false;
}
}
}
} else {
foreach ($param as $key => $value) {
if (!array_key_exists($key, $currentParams)) {
return "Parameter $key does not exist for device $deviceId.";
return $returnText ? "Parameter $key does not exist for device $deviceId." : false;
}

if (is_numeric($value) && is_string($value)) {
Expand All @@ -347,7 +349,7 @@ public function setDeviceStatus($identifier, $params) {
}

if ($allSet) {
return implode("\n", $messages);
return $returnText ? implode("\n", $messages) : true;
}

$data = [
Expand All @@ -361,11 +363,15 @@ public function setDeviceStatus($identifier, $params) {
foreach ($updatedParams as $key => $value) {
$updatedValue = $this->getDeviceParamLive($deviceId, [$key]);
if ($updatedValue[$key] != $value) {
return "Failed to update parameter $key to $value for device $deviceId. Current value is $updatedValue[$key].";
return $returnText ? "Failed to update parameter $key to $value for device $deviceId. Current value is $updatedValue[$key]." : false;
}
}

return "Parameters successfully updated for device $deviceId.\n" . implode("\n", $changes) . "\n" . implode("\n", $messages);
if ($returnText) {
return "Parameters successfully updated for device $deviceId.\n" . implode("\n", $changes) . "\n" . implode("\n", $messages);
} else {
return true;
}
}

/**
Expand Down Expand Up @@ -415,7 +421,6 @@ public function getDeviceHistory($identifier) {
return $response;
}


/**
* Initialize WebSocket connection and perform handshake.
*
Expand Down Expand Up @@ -455,34 +460,72 @@ public function initializeWebSocketConnection($identifier) {
* @throws Exception If there is an error during the process.
*/
public function getDataWebSocket($identifier, $params) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$device = $this->getDeviceById($deviceId);
if (!$device) {
$errorCode = 'DEVICE_NOT_FOUND'; // Example error code
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception($errorMsg);
}
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$device = $this->getDeviceById($deviceId);
if (!$device) {
$errorCode = 'DEVICE_NOT_FOUND'; // Example error code
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception($errorMsg);
}

// Ensure WebSocket connection is initialized
if (!isset($this->wsClient)) {
$this->wsClient = $this->initializeWebSocketConnection($identifier);
}
// Ensure WebSocket connection is initialized
if (!isset($this->wsClient)) {
$this->wsClient = $this->initializeWebSocketConnection($identifier);
}

$data = $this->wsClient->createQueryData($device, $params);
$this->wsClient->send(json_encode($data));
$response = json_decode($this->wsClient->receive(), true);
$data = $this->wsClient->createQueryData($device, $params);
$this->wsClient->send(json_encode($data));
$response = json_decode($this->wsClient->receive(), true);

if (isset($response['error']) && $response['error'] != 0) {
$errorCode = $response['error'];
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception("Error: $errorMsg");
if (isset($response['error']) && $response['error'] != 0) {
$errorCode = $response['error'];
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception("Error: $errorMsg");
}

return $response['params'];
}

/**
* Set data of a device using WebSocket.
*
* @param string $identifier The device name or ID.
* @param array $params The parameters to set.
* @return array The response data.
* @throws Exception If there is an error during the process.
*/
public function setDataWebSocket($identifier, $params) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$device = $this->getDeviceById($deviceId);
if (!$device) {
$errorCode = 'DEVICE_NOT_FOUND'; // Example error code
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception($errorMsg);
}

return $response['params'];
}
// Ensure WebSocket connection is initialized
if (!isset($this->wsClient)) {
$this->wsClient = $this->initializeWebSocketConnection($identifier);
}

$data = $this->wsClient->createUpdateData($device, $params, $device['apikey']);
$this->wsClient->send(json_encode($data));
$response = json_decode($this->wsClient->receive(), true);

if (isset($response['error']) && $response['error'] != 0) {
$errorCode = $response['error'];
$errorMsg = Constants::ERROR_CODES[$errorCode] ?? 'Unknown error';
throw new Exception("Error: $errorMsg");
}

return $response['params'];
}

/**
* Force get data of a device using WebSocket.
Expand All @@ -504,6 +547,17 @@ public function forceGetData($identifier, $params) {
throw new Exception($errorMsg);
}

// Check if the device has energy parameters
$energyParams = ['power', 'current', 'voltage'];
$deviceParams = array_keys($this->getAllDeviceParamLive($identifier) ?? []);
$hasEnergyParams = !empty(array_intersect($energyParams, $deviceParams));

// If the device has energy parameters, update 'current' to 0.50 before fetching data
if ($hasEnergyParams) {
$updateParams = ['current' => 0.50];
$this->forceUpdateDevice($identifier, $updateParams, 5);
}

$wsClient = new WebSocketClient($this->httpClient);
$handshakeResponse = $wsClient->handshake($device);

Expand Down Expand Up @@ -533,11 +587,11 @@ public function forceGetData($identifier, $params) {
*
* @param string $identifier The device name or ID.
* @param array $params The parameters to update.
* @param int $sleepSec The number of seconds to wait before verifying the update (default is 3 seconds).
* @param int $sleepSec The number of seconds to wait before verifying the update (default is 10 seconds).
* @return array The response data.
* @throws Exception If there is an error during the process.
*/
public function forceUpdateDevice($identifier, $params, $sleepSec = 3) {
public function forceUpdateDevice($identifier, $params, $sleepSec = 5) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
Expand Down Expand Up @@ -579,4 +633,5 @@ public function forceUpdateDevice($identifier, $params, $sleepSec = 3) {

return $updatedParams;
}
}
}
?>

0 comments on commit 42c302c

Please sign in to comment.