\MiotApi\ApiApi

__construct()

__construct(null  $appId = null, null  $accessToken = null, string  $specNS = 'miot-spec-v2') 

Api constructor.

Parameters

setHost()

setHost(  $host) 

设置 请求的 host 默认为大陆host，如果要获取其他地区设备的时候，可以使用此方法设置host.

Parameters

devices()

devices(boolean  $compact = false) : array|mixed

读取抽象设备列表.

Parameters

Returns

get()

get(  $uri, array  $params = array()) : array|boolean|mixed

GET.

Parameters

Returns

deviceInformation()

deviceInformation(  $dids) : array|mixed

读取设备信息 读取一个设备 : GET /api/v1/device-information?dids=xxxx 读取多个设备： GET /api/v1/device-information?dids=xxxx,yyy,zzzzz.

Parameters

Returns

properties()

properties(  $pid, string  $voice = '') : array|mixed

读取属性 读取一个属性 : GET /api/v1/properties?pid=AAAD.1.1 读取多个属性：GET /api/v1/properties?pid=AAAD.1.1,AAAD.2.3 语音控制需要增加voice字段：GET /api/v1/properties?pid=AAAD.1.1,AAAD.2.3&voice={"recognition":"灯开了吗","semantics":"xxx"}.

Parameters

Returns

setProperties()

setProperties(  $data) : array|boolean|mixed

设置属性.

Parameters

Throws

\MiotApi\Exception\JsonException

Returns

put()

put(  $uri,   $data) : array|boolean|mixed

PUT.

Parameters

Returns

invokeActions()

invokeActions(  $data) : array|boolean|mixed

调用方法 一次请求只能调用一个设备的一个方法 PUT /api/v1/action.

Parameters

Throws

\MiotApi\Exception\JsonException

Returns

scenes()

scenes() : array|mixed

读取用户在米家设置好的场景列表.

Returns

triggerScene()

triggerScene(  $sceneId) : array|boolean|mixed

主动触发某个场景.

Parameters

Returns

post()

post(  $uri,   $data) : array|boolean|mixed

POST.

Parameters

Returns

homes()

homes() : array|mixed

读取家庭列表.

Returns

subscript()

subscript(  $properties,   $receiverUrl) : array|boolean|mixed

订阅属性变化 开始订阅: POST /api/v1/subscriptions Content-Type: application/json Content-Length: 134 ​ * { "topic": "properties-changed", "properties": [ "AAAB.1.1", "AAAC.1.1", "AAAD.1.1", "AAAD.1.2" ], "receiver-url": "xxx" }.

订阅成功，应答如下： HTTP/1.1 207 Multi-Status Content-Type: application/json Content-Length: 156 { "expired": 36000, // 超时时间，单位为秒。 "properties": [ { "pid": "AAAB.1.1", "status": 0 }, { "pid": "AAAC.1.1", "status": -704002023 }, { "pid": "AAAD.1.1", "status": 0 } { "pid": "AAAD.1.2", "status": 705202023 } ] }

Parameters

Returns

unSubscript()

unSubscript(  $properties) : array|boolean|mixed

退订属性变化 POST /api/v1/subscriptions Content-Type: application/json Content-Length: 134 ​ * { "topic": "properties-changed", "properties": [ "AAAB.1.1", "AAAC.1.1", "AAAD.1.1", "AAAD.1.2" ], "receiver-url": "xxx" }.

退订成功，应答如下： HTTP/1.1 207 Multi-Status Content-Type: application/json Content-Length: 156 { "expired": 36000, // 超时时间，单位为秒。 "properties": [ { "pid": "AAAB.1.1", "status": 0 }, { "pid": "AAAC.1.1", "status": -704002023 }, { "pid": "AAAD.1.1", "status": 0 } { "pid": "AAAD.1.2", "status": 705202023 } ] }

Parameters

Returns

delete()

delete(  $uri,   $data) : array|boolean|mixed

DELETE.

Parameters

Returns

devicesList()

devicesList() : array|mixed

一次性获取到包含了 serialNumber （原did）的设备列表.

Returns

getPropertyGraceful()

getPropertyGraceful(  $did,   $type,   $data) : array|boolean|mixed

按照名称获取属性.

Parameters

Throws

\MiotApi\Exception\ApiErrorException

\MiotApi\Exception\SpecificationErrorException

Returns

getPropertiesGraceful()

getPropertiesGraceful(  $data) : array|boolean|mixed

按照名称获取多个设备属性.

Parameters

Throws

\MiotApi\Exception\ApiErrorException

\MiotApi\Exception\SpecificationErrorException

Returns

setPropertyGraceful()

setPropertyGraceful(  $did,   $type,   $data) : array|boolean|mixed

按照名称设置属性.

Parameters

Throws

\MiotApi\Exception\ApiErrorException

\MiotApi\Exception\JsonException

\MiotApi\Exception\SpecificationErrorException

Returns

setPropertiesGraceful()

setPropertiesGraceful(  $data) : array|boolean|mixed

按照名称设置多个设备属性.

Parameters

Throws

\MiotApi\Exception\ApiErrorException

\MiotApi\Exception\JsonException

\MiotApi\Exception\SpecificationErrorException

Returns

subscriptByDevices()

subscriptByDevices(  $devices,   $receiverUrl) : array|boolean|mixed

根据 devicesList 方法获取到的设备列表信息 订阅设备属性变化.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

unSubscriptByDevices()

unSubscriptByDevices(  $devices) : array|boolean|mixed

根据 devicesList 方法获取到的设备列表信息 退订设备属性变化.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

getPropertiesByDevices()

getPropertiesByDevices(  $devices, array  $access = array()) : array|boolean

根据设备列表和 access列表 获取对于访问方式的属性.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

httpClient()

httpClient() : \MiotApi\Util\Request

获取http Client.

Returns