[homekit-connector] Create device cmd (#74)

FastyBird · Mar 24, 2023 · b8f5948 · b8f5948
1 parent 73942df
commit b8f5948
Show file tree

Hide file tree

Showing 25 changed files with 250 additions and 105 deletions.
diff --git a/composer.json b/composer.json
@@ -41,6 +41,7 @@
     "ext-bcmath": "*",
     "ext-pcntl": "*",
     "cweagans/composer-patches": "^1.7",
+    "evenement/evenement": "^3.0",
     "fastybird/bootstrap-library": "dev-main",
     "fastybird/exchange-library": "dev-main",
     "fastybird/json-api": "^0.13",

diff --git a/src/Constants.php b/src/Constants.php
@@ -152,4 +152,10 @@ final class Constants
 
 	public const DATA_STORAGE_CHANNELS_KEY = 'channels';
 
+	public const EVENT_ENTITY_CREATED = 'entity_created';
+
+	public const EVENT_ENTITY_UPDATED = 'entity_updated';
+
+	public const EVENT_ENTITY_DELETED = 'entity_deleted';
+
 }
diff --git a/src/Consumers/State.php b/src/Consumers/State.php
@@ -257,6 +257,7 @@ public function consume(
 	}
 
 	/**
+	 * @throws Exceptions\InvalidState
 	 * @throws MetadataExceptions\InvalidArgument
 	 * @throws MetadataExceptions\InvalidState
 	 */

diff --git a/src/Entities/Channels/Properties/Property.php b/src/Entities/Channels/Properties/Property.php
@@ -155,8 +155,7 @@ public function getChannel(): Entities\Channels\Channel
 	public function isSettable(): bool
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->isSettable();
 		}
@@ -171,8 +170,7 @@ public function isSettable(): bool
 	public function setSettable(bool $settable): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Settable setter is allowed only for parent');
 		}
@@ -183,8 +181,7 @@ public function setSettable(bool $settable): void
 	public function isQueryable(): bool
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->isQueryable();
 		}
@@ -199,8 +196,7 @@ public function isQueryable(): bool
 	public function setQueryable(bool $queryable): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Queryable setter is allowed only for parent');
 		}
@@ -211,8 +207,7 @@ public function setQueryable(bool $queryable): void
 	public function getDataType(): MetadataTypes\DataType
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getDataType();
 		}
@@ -226,8 +221,7 @@ public function getDataType(): MetadataTypes\DataType
 	public function setDataType(MetadataTypes\DataType $dataType): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Data type setter is allowed only for parent');
 		}
@@ -238,8 +232,7 @@ public function setDataType(MetadataTypes\DataType $dataType): void
 	public function getUnit(): string|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getUnit();
 		}
@@ -253,8 +246,7 @@ public function getUnit(): string|null
 	public function setUnit(string|null $unit): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Value unit setter is allowed only for parent');
 		}
@@ -281,8 +273,7 @@ public function getFormat(): MetadataValueObjects\StringEnumFormat|MetadataValue
 	public function setFormat(array|string|null $format): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Value format setter is allowed only for parent');
 		}
@@ -293,8 +284,7 @@ public function setFormat(array|string|null $format): void
 	public function getInvalid(): float|int|string|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getInvalid();
 		}
@@ -308,8 +298,7 @@ public function getInvalid(): float|int|string|null
 	public function setInvalid(string|null $invalid): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Invalid value setter is allowed only for parent');
 		}
@@ -320,8 +309,7 @@ public function setInvalid(string|null $invalid): void
 	public function getNumberOfDecimals(): int|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getNumberOfDecimals();
 		}
@@ -335,20 +323,18 @@ public function getNumberOfDecimals(): int|null
 	public function setNumberOfDecimals(int|null $numberOfDecimals): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Number of decimals setter is allowed only for parent');
 		}
 
 		parent::setNumberOfDecimals($numberOfDecimals);
 	}
 
-	public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|null
+	public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|MetadataTypes\CoverPayload|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getDefault();
 		}
@@ -362,8 +348,7 @@ public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTy
 	public function setDefault(string|null $default): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Default value setter is allowed only for parent');
 		}

diff --git a/src/Entities/Channels/Properties/Variable.php b/src/Entities/Channels/Properties/Variable.php
@@ -30,8 +30,8 @@ public function getType(): MetadataTypes\PropertyType
 	{
 		return MetadataTypes\PropertyType::get(MetadataTypes\PropertyType::TYPE_VARIABLE);
 	}
-
-	public function getValue(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|null
+	// phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
+	public function getValue(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|MetadataTypes\CoverPayload|null
 	{
 		if ($this->getParent() !== null) {
 			return $this->getParent()->getValue();

diff --git a/src/Entities/Devices/Properties/Property.php b/src/Entities/Devices/Properties/Property.php
@@ -156,8 +156,7 @@ public function getDevice(): Entities\Devices\Device
 	public function isSettable(): bool
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->isSettable();
 		}
@@ -183,8 +182,7 @@ public function setSettable(bool $settable): void
 	public function isQueryable(): bool
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->isQueryable();
 		}
@@ -199,8 +197,7 @@ public function isQueryable(): bool
 	public function setQueryable(bool $queryable): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Queryable setter is allowed only for parent');
 		}
@@ -211,8 +208,7 @@ public function setQueryable(bool $queryable): void
 	public function getDataType(): MetadataTypes\DataType
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getDataType();
 		}
@@ -226,8 +222,7 @@ public function getDataType(): MetadataTypes\DataType
 	public function setDataType(MetadataTypes\DataType $dataType): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Data type setter is allowed only for parent');
 		}
@@ -238,8 +233,7 @@ public function setDataType(MetadataTypes\DataType $dataType): void
 	public function getUnit(): string|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getUnit();
 		}
@@ -253,8 +247,7 @@ public function getUnit(): string|null
 	public function setUnit(string|null $unit): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Value unit setter is allowed only for parent');
 		}
@@ -265,8 +258,7 @@ public function setUnit(string|null $unit): void
 	public function getFormat(): MetadataValueObjects\StringEnumFormat|MetadataValueObjects\NumberRangeFormat|MetadataValueObjects\CombinedEnumFormat|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getFormat();
 		}
@@ -282,8 +274,7 @@ public function getFormat(): MetadataValueObjects\StringEnumFormat|MetadataValue
 	public function setFormat(array|string|null $format): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Value format setter is allowed only for parent');
 		}
@@ -294,8 +285,7 @@ public function setFormat(array|string|null $format): void
 	public function getInvalid(): float|int|string|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getInvalid();
 		}
@@ -309,8 +299,7 @@ public function getInvalid(): float|int|string|null
 	public function setInvalid(string|null $invalid): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Invalid value setter is allowed only for parent');
 		}
@@ -321,8 +310,7 @@ public function setInvalid(string|null $invalid): void
 	public function getNumberOfDecimals(): int|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getNumberOfDecimals();
 		}
@@ -336,20 +324,18 @@ public function getNumberOfDecimals(): int|null
 	public function setNumberOfDecimals(int|null $numberOfDecimals): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Number of decimals setter is allowed only for parent');
 		}
 
 		parent::setNumberOfDecimals($numberOfDecimals);
 	}
 
-	public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|null
+	public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|MetadataTypes\CoverPayload|null
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			return $this->getParent()->getDefault();
 		}
@@ -360,8 +346,7 @@ public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTy
 	public function setDefault(string|null $default): void
 	{
 		if (
-			$this->getParent() !== null && !$this->getType()
-				->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
+			$this->getParent() !== null && !$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_MAPPED)
 		) {
 			throw new Exceptions\InvalidState('Default value setter is allowed only for parent');
 		}

diff --git a/src/Entities/Devices/Properties/Variable.php b/src/Entities/Devices/Properties/Variable.php
@@ -30,8 +30,8 @@ public function getType(): MetadataTypes\PropertyType
 	{
 		return MetadataTypes\PropertyType::get(MetadataTypes\PropertyType::TYPE_VARIABLE);
 	}
-
-	public function getValue(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|null
+	// phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
+	public function getValue(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|MetadataTypes\CoverPayload|null
 	{
 		if ($this->getParent() !== null) {
 			return $this->getParent()->getValue();

diff --git a/src/Entities/Property.php b/src/Entities/Property.php
@@ -369,7 +369,7 @@ public function setNumberOfDecimals(int|null $numberOfDecimals): void
 	 * @throws MetadataExceptions\InvalidArgument
 	 * @throws MetadataExceptions\InvalidState
 	 */
-	public function getValue(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|null
+	public function getValue(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|MetadataTypes\CoverPayload|null
 	{
 		if (!$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_VARIABLE)) {
 			throw new Exceptions\InvalidState(
@@ -416,7 +416,7 @@ public function setValue(string|int|float|bool|null $value): void
 	 * @throws MetadataExceptions\InvalidArgument
 	 * @throws MetadataExceptions\InvalidState
 	 */
-	public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|null
+	public function getDefault(): bool|float|int|string|DateTimeInterface|MetadataTypes\ButtonPayload|MetadataTypes\SwitchPayload|MetadataTypes\CoverPayload|null
 	{
 		if (!$this->getType()->equalsValue(MetadataTypes\PropertyType::TYPE_VARIABLE)) {
 			throw new Exceptions\InvalidState(