Skip to content

Commit

Permalink
1.28.27
Browse files Browse the repository at this point in the history 
- added getDeviceIdByIdentifier to allow use either device name or deviceID as a parameter for each function
- updated README
  • Loading branch information
@PJanisio
PJanisio committed Jun 24, 2024
1 parent 9503e05 commit 961ee63
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 19 deletions.
1 change: 0 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,5 @@ Index.php works as a gateway to API and also as a debug for all available method

- main branch when commited used to be operative.
- enable DEBUG = 1; in Constants to log every get and postRequest with output and parameters to **debug.log**
- with next stable release methods and invoking functions structure can be changed (keep this in mind)
- branch **websockets** will be not maintened anymore
- index.php is a quasi-test file which helps me to check all methods and it is also a great example
80 changes: 62 additions & 18 deletions src/Devices.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,32 @@ public function getDevicesList() {
return $devicesList;
}

/**
* Helper method to get device ID by name or return the ID if already provided.
*
* @param string $identifier The device name or ID.
* @return string|null The device ID or null if not found.
*/
private function getDeviceIdByIdentifier($identifier) {
if (isset($this->devicesData['thingList'])) {
foreach ($this->devicesData['thingList'] as $device) {
if ($device['itemData']['deviceid'] === $identifier || $device['itemData']['name'] === $identifier) {
return $device['itemData']['deviceid'];
}
}
}
return null;
}

/**
* Check if a device supports multiple channels.
*
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @return bool True if the device supports multiple channels, false otherwise.
*/
public function isMultiChannel($deviceId) {
if ($this->devicesData && isset($this->devicesData['thingList'])) {
public function isMultiChannel($identifier) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if ($deviceId && isset($this->devicesData['thingList'])) {
foreach ($this->devicesData['thingList'] as $device) {
if ($device['itemData']['deviceid'] === $deviceId && isset($device['itemData']['isSupportChannelSplit'])) {
return $device['itemData']['isSupportChannelSplit'] == 1;
Expand All @@ -141,11 +159,12 @@ public function isMultiChannel($deviceId) {
* Search for a specific parameter in the device data.
*
* @param string $searchKey The parameter key to search for.
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @return mixed|null The parameter value if found, null otherwise.
*/
public function searchDeviceParam($searchKey, $deviceId) {
if ($this->devicesData && isset($this->devicesData['thingList'])) {
public function searchDeviceParam($searchKey, $identifier) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if ($deviceId && isset($this->devicesData['thingList'])) {
foreach ($this->devicesData['thingList'] as $device) {
if ($device['itemData']['deviceid'] === $deviceId) {
if (isset($device['itemData'][$searchKey])) {
Expand All @@ -166,13 +185,17 @@ public function searchDeviceParam($searchKey, $deviceId) {
/**
* Get live parameters of a device.
*
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @param string|array $param The parameter(s) to get.
* @param int $type The type of the request (default is 1).
* @return mixed The live parameter(s) value(s).
* @throws Exception If there is an error in the response.
*/
public function getDeviceParamLive($deviceId, $param, $type = 1) {
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);
Expand Down Expand Up @@ -216,12 +239,16 @@ public function getDeviceParamLive($deviceId, $param, $type = 1) {
/**
* Get all live parameters of a device.
*
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @param int $type The type of the request (default is 1).
* @return array|null The live parameters or null if not found.
* @throws Exception If there is an error in the response.
*/
public function getAllDeviceParamLive($deviceId, $type = 1) {
public function getAllDeviceParamLive($identifier, $type = 1) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$endpoint = '/v2/device/thing/status';
$queryParams = [
'id' => $deviceId,
Expand All @@ -246,12 +273,16 @@ public function getAllDeviceParamLive($deviceId, $type = 1) {
/**
* Set the status of a device.
*
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @param array $params The parameters to set.
* @return string The result of the status update.
* @throws Exception If there is an error in the response or if a parameter does not exist.
*/
public function setDeviceStatus($deviceId, $params) {
public function setDeviceStatus($identifier, $params) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$device = $this->getDeviceById($deviceId);
$currentParams = $this->getAllDeviceParamLive($deviceId) ?? null;

Expand Down Expand Up @@ -364,11 +395,15 @@ public function isOnline($identifier) {
/**
* Get the history of a device.
*
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @return array The device history.
* @throws Exception If there is an error in the response.
*/
public function getDeviceHistory($deviceId) {
public function getDeviceHistory($identifier) {
$deviceId = $this->getDeviceIdByIdentifier($identifier);
if (!$deviceId) {
throw new Exception("Device not found.");
}
$endpoint = '/v2/device/history';
$queryParams = ['deviceid' => $deviceId];

Expand All @@ -386,12 +421,16 @@ public function getDeviceHistory($deviceId) {
/**
* Force get data of a device using WebSocket.
*
* @param string $deviceId The device ID.
* @param string $identifier The device name or ID.
* @param array|string $params The parameters to query.
* @return array The response data.
* @throws Exception If there is an error during the process.
*/
public function forceGetData($deviceId, $params) {
public function forceGetData($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
Expand Down Expand Up @@ -426,13 +465,17 @@ public function forceGetData($deviceId, $params) {
/**
* Force update the status of a device using WebSocket.
*
* @param string $deviceId The device ID.
* @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).
* @return array The response data.
* @throws Exception If there is an error during the process.
*/
public function forceUpdateDevice($deviceId, $params, $sleepSec = 3) {
public function forceUpdateDevice($identifier, $params, $sleepSec = 3) {
$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
Expand Down Expand Up @@ -471,3 +514,4 @@ public function forceUpdateDevice($deviceId, $params, $sleepSec = 3) {
return $updatedParams;
}
}
?>

0 comments on commit 961ee63

Please sign in to comment.