riwin/qivicon-api

PHP-API,用于访问Qivicon Homebase。

1.0.8 2022-01-03 16:06 UTC

This package is auto-updated.

Last update: 2024-09-04 22:47:11 UTC


README

Homebase 兼容性

QHB QHB2 SPS

状态

Packagist license GitHub issues GitHub repo size in bytes

安装

composer require riwin/qivicon-api

{
    "require": {
        "riwin/qivicon-api": "1.*"
    }
}

绑定API

<?php
require_once 'vendor/autoload.php';
header("Content-Type: application/json");
$api = new \riwin\QiviconAPI\QiviconAPI("hostname-Homebase", "Serien-Nummer", "email@mein.qivicon", "Passwort");
print_r($api->execute());

模块 - AlarmSystem

设置警报

/index.php?module=AlarmSystem&cmd=activateAlarmSystem

取消警报

/index.php?module=AlarmSystem&cmd=deactivateAlarmSystem

结束触发警报

/index.php?module=AlarmSystem&cmd=deactivateAlarm

显示警报系统属性

/index.php?module=AlarmSystem&cmd=getAlarmSystemProperties

模块 - Generic

仪表板信息

/index.php?module=Generic&cmd=getDashboardInfo

Homebase 属性

/index.php?module=Generic&cmd=getHomeboxProperties

房间与设备/频道

/index.php?module=Generic&cmd=listRooms

模块 - Situation

开启看护者

/index.php?module=Situation&cmd=activateVirtualResident

关闭看护者

/index.php?module=Situation&cmd=deactivateVirtualResident

看护者事件

/index.php?module=Situation&cmd=getVirtualResidentProperties

列出情况

/index.php?module=Situation&cmd=listSituations

显示情况

/index.php?module=Situation&cmd=getSituation&param_id={situationId}

启用/禁用情况

/index.php?module=Situation&cmd=setSituationState&param_id={situationId}&param_active={true|false}

删除情况

/index.php?module=Situation&cmd=removeSituation&param_id={situationId}

列出可用声音文件

/index.php?module=Situation&cmd=listAvailableSoundFiles

模块 - Notification

列出通知

/index.php?module=Notification&cmd=listNotifications

模块 - Device

设置在场

/index.php?module=Device&cmd=setHomeStatePresent

设置不在场

/index.php?module=Device&cmd=setHomeStateAway

设置亮度(0-100)

/index.php?module=Device&cmd=setDimmerCommand&param_uid={uid}&param_level={0-100}

setHueCommand

/index.php?module=Device&cmd=setHueCommand&param_uid={uid}&param_isCombinedBulb={true|false}&param_hue={0-360}&param_saturation={0-100}&param_brightness={0-100}

setJunkersHotWaterState

/index.php?module=Device&cmd=setJunkersHotWaterState&param_uid={uid}&param_state={0-1}

setMieleState

/index.php?module=Device&cmd=setMieleState&param_uid={uid}&param_active={true|false}

setPlugState

/index.php?module=Device&cmd=setPlugState&param_uid={uid}&param_state={0-1}

setShutterCommand

/index.php?module=Device&cmd=setShutterCommand&param_uid={uid}&param_level={0-100}

setSonosControlPlayer

/index.php?module=Device&cmd=setSonosControlPlayer&param_uid={uid}&param_control={PLAY,PAUSE,PREVIOUS,NEXT}

setSonosVolume

/index.php?module=Device&cmd=setSonosVolume&param_uid={uid}&param_volume={0-100}

setTunableWhiteValuesCommand

/index.php?module=Device&cmd=setTunableWhiteValuesCommand&param_uid={uid}&param_brightness={0-100}&param_colorTemperature={0-100}

setDeviceValue

Philips Hue White Ambiance:
/index.php?module=Device&cmd=setDeviceValue&param_uid={uid}&param_value={0-100@on|off}

模块 - Temperature

设置设备温度

/index.php?module=Temperature&cmd=setDeviceTemperature&param_uid={uid}&param_targetTemperature={0.0-35.0}

设置Junkers热水设备温度

/index.php?module=Temperature&cmd=setJunkersHotWaterDeviceTemperature&param_uid={uid}&param_targetTemperature={temperature}

设置房间温度

/index.php?module=Temperature&cmd=setRoomTemperature&param_room={room}&param_targetTemperature={temperature}

结束会话(注销)

/index.php?logout