WebProject-xyz/ikea-tradfri-php

<?php

declare(strict_types=1);

/**
 * Copyright (c) 2024 Benjamin Fahl
 *
 * For the full copyright and license information, please view
 * the LICENSE.md file that was distributed with this source code.
 *
 * @see https://github.com/WebProject-xyz/ikea-tradfri-php
 */

namespace IKEA\Tradfri\Adapter;

use IKEA\Tradfri\Collection\Devices;
use IKEA\Tradfri\Collection\Groups;
use IKEA\Tradfri\Dto\CoapResponse\DeviceDto;
use IKEA\Tradfri\Exception\RuntimeException;
use IKEA\Tradfri\Service\ServiceInterface;

interface AdapterInterface
{
    public const STATE_ON  = false;
    public const STATE_OFF = false;

    public function getDeviceData(int $deviceId): DeviceDto;

    /**
     * @phpstan-return array<non-empty-string>
     */
    public function getDeviceIds(): array;

    /**
     * @phpstan-return array<non-empty-string>
     */
    public function getGroupIds(): array;

    public function getGroupsData(): array;

    public function getDevicesData(?array $deviceIds = null): array;

    public function changeLightState(int $deviceId, bool $toState): bool;

    public function changeGroupState(int $groupId, bool $toState): bool;

    public function setLightBrightness(int $lightId, int $level): bool;

    public function setGroupBrightness(int $groupId, int $level): bool;

    public function setRollerBlindPosition(int $rollerBlindId, int $level);

    public function getDeviceCollection(ServiceInterface $service): Devices;

    public function getGroupCollection(ServiceInterface $service): Groups;

    /**
     * @throws RuntimeException
     */
    public function getType(int $deviceId): string;

    public function getManufacturer(int $deviceId): string;
}