# 亮度
以下这些消息类型,以增加或减少百分比的形式设置灯的亮度属性。
- SetBrightnessRequest
- SetBrightnessConfirmation
- IncrementBrightnessRequest
- IncrementBrightnessConfirmation
- DecrementBrightnessRequest
- DecrementBrightnessConfirmation
# SetBrightnessRequest
示例语句:
“小微,设置{设备名}亮度到50%”
目的:请求以指定的百分比调整指定设备的亮度。 从Smart Home Skill API发送到技能适配器。
Header
属性 | 值 |
---|---|
name | SetBrightnessRequest |
namespace | SmartHome.Control |
Payload
属性 | 描述 | 是否必需 |
---|---|---|
accessToken | 与客户的设备云账户相关的访问令牌。 | 是 |
appliance object | 执行操作的设备。 | 是 |
appliance.applianceID | 设备标识符。 标识符在技术适配器的域内的最终用户拥有的所有设备上必须是唯一的。 此外,标识符需要在同一设备的多个发现请求之间保持一致。 标识符可以包含任何字母或数字和以下特殊字符:_ - = # ; : ? @ &。 该值不能超过256个字符。 | 是 |
appliance.additionalApplianceDetails | 提供关于技能适配器使用的设备的附加信息的字符串名称/值对。 该属性的内容不能超过5000字节。 而且,Smart Home Skill API即不理解也不使用这些数据。 | 是,但列表可以为空。 |
brightness | 设置的亮度百分比。 范围从0到100(含)。 | 否 |
SetBrightnessRequest示例:
{
"header": {
"messageId": "9422676d-2356-4aa7-aa88-c642f12bfcd6",
"name": "SetBrightnessRequest",
"namespace": "SmartHome.Control",
"payloadVersion": "2"
},
"payload": {
"accessToken": "[OAuth token here]",
"appliance": {
"additionalApplianceDetails": {},
"applianceId": "[Device ID]"
},
"brightness": {
"value": 50.0
}
}
}
# SetBrightnessConfirmation
小微响应示例:“好的”
目的:表示设备已成功调整了指定的亮度。 这是对SetBrightnessRequest的预期响应,并从技能适配器发送到Smart Home Skill API。
Header
属性 | 值 |
---|---|
name | SetBrightnessConfirmation |
namespace | SmartHome.Control |
Payload
属性 | 描述 | 是否必需 |
---|---|---|
status对象 | 调整了指定的亮度后设备的状态。 | 是 |
status.brightnessValue | 当前设备的亮度。 | 是 |
SetBrightnessConfirmation示例:
{
"header": {
"messageId": "9422676d-2356-4aa7-aa88-c642f12bfcd6",
"name": "SetBrightnessConfirmation",
"namespace": "SmartHome.Control",
"payloadVersion": "2"
},
"payload": {
"status": {
"brightnessValue": 50.0
}
}
}
# IncrementBrightnessRequest
示例语句:
“小微,{设备名}调高亮度20%”
目的:以指定增加的百分比调整指定设备的亮度设置。 从Smart Home Skill API发送到技能适配器。
Header
属性 | 值 |
---|---|
name | IncrementBrightnessRequest |
namespace | SmartHome.Control |
Payload
属性 | 描述 | 是否必需 |
---|---|---|
accessToken | 与客户的设备云账户相关的访问令牌。 | 是 |
appliance object | 执行操作的设备。 | 是 |
appliance.applianceID | 设备标识符。 标识符在技术适配器的域内的最终用户拥有的所有设备上必须是唯一的。 此外,标识符需要在同一设备的多个发现请求之间保持一致。 标识符可以包含任何字母或数字和以下特殊字符:_ - = # ; : ? @ &。 该值不能超过256个字符。 | 是 |
appliance.additionalApplianceDetails | 提供关于技能适配器使用的设备的附加信息的字符串名称/值对。 该属性的内容不能超过5000字节。 而且,Smart Home Skill API即不理解也不使用这些数据。 | 是,但列表可以为空。 |
deltaBrightness | 对于此指令,deltaBrightness将添加到当前百分比设置中。 例如,如果设备当前设置为40%,则deltaBrightness值为15表示设备在请求完成后将被设置为55%。是double类型,范围介于0.00和100.00之间(含)。如果deltaBrightness值在允许的范围内,但超出了目标设备允许的最大值,则返回ValueOutOfRangeError,并且不会更改设备设置。 | 是 |
IncrementBrightnessRequest示例:
{
"header": {
"messageId": "9422676d-2356-4aa7-aa88-c642f12bfcd6",
"name": "IncrementBrightnessRequest",
"namespace": "SmartHome.Control",
"payloadVersion":"2"
},
"payload": {
"accessToken": "[OAuth token here]",
"appliance": {
"additionalApplianceDetails": {},
"applianceId": "[Device ID]"
},
"deltaBrightness": {
"value": 10.0
}
}
}
# IncrementBrightnessConfirmation
小微响应示例:“好的”
目的:表示设备成功增加了亮度的百分比。 这是对IncrementBrightnessRequest的预期响应,并从技能适配器发送到Smart Home Skill API。
Header
属性 | 值 |
---|---|
name | IncrementBrightnessConfirmation |
namespace | SmartHome.Control |
Payload
属性 | 描述 | 是否必需 |
---|---|---|
status对象 | 调整了指定的亮度后设备的状态。 | 是 |
status.brightnessValue | 当前设备的亮度。 | 是 |
IncrementBrightnessConfirmation示例:
{
"header": {
"messageId": "9422676d-2356-4aa7-aa88-c642f12bfcd6",
"name": "IncrementBrightnessConfirmation",
"namespace": "SmartHome.Control",
"payloadVersion":"2"
},
"payload": {
"status": {
"brightnessValue": 50.0
}
}
}
# DecrementBrightnessRequest
示例语句:
“小微,{设备名}亮度调低20%”
目的:以指定减小的百分比调整指定设备的亮度设置。 从Smart Home Skill API发送到技能适配器。
Header
属性 | 值 |
---|---|
name | DecrementBrightnessRequest |
namespace | SmartHome.Control |
Payload
属性 | 描述 | 是否必需 |
---|---|---|
accessToken | 与客户的设备云账户相关的访问令牌。 | 是 |
appliance object | 执行操作的设备。 | 是 |
appliance.applianceID | 设备标识符。 标识符在技术适配器的域内的最终用户拥有的所有设备上必须是唯一的。 此外,标识符需要在同一设备的多个发现请求之间保持一致。 标识符可以包含任何字母或数字和以下特殊字符:_ - = # ; : ? @ &。 该值不能超过256个字符。 | 是 |
appliance.additionalApplianceDetails | 提供关于技能适配器使用的设备的附加信息的字符串名称/值对。 该属性的内容不能超过5000字节。 而且,Smart Home Skill API即不理解也不使用这些数据。 | 是,但列表可以为空。 |
deltaBrightness | 对于此指令,deltaBrightness将添加到当前百分比设置中。 例如,如果设备当前设置为40%,则deltaBrightness值为15表示设备在请求完成后将被设置为25%。是double类型,范围介于0.00和100.00之间(含)。如果deltaBrightness值在允许的范围内,但超出了目标设备允许的最小值,则返回ValueOutOfRangeError,并且不会更改设备设置。 | 是 |
DecrementBrightnessRequest示例:
{
"header": {
"messageId": "9422676d-2356-4aa7-aa88-c642f12bfcd6",
"name": "DecrementBrightnessRequest",
"namespace": "SmartHome.Control",
"payloadVersion":"2"
},
"payload": {
"accessToken": "[OAuth token here]",
"appliance": {
"additionalApplianceDetails": {},
"applianceId": "[Device ID]"
},
"deltaBrightness": {
"value": 15.0
}
}
}
# DecrementBrightnessConfirmation
小微响应示例:“好的”
目的:表示设备成功减少了亮度的百分比。 这是对DecrementBrightnessRequest的预期响应,并从技能适配器发送到Smart Home Skill API。
Header
属性 | 值 |
---|---|
name | DecrementBrightnessConfirmation |
namespace | SmartHome.Control |
Payload
属性 | 描述 | 是否必需 |
---|---|---|
status对象 | 调整了指定的亮度后设备的状态。 | 是 |
status.brightnessValue | 当前设备的亮度。 | 是 |
DecrementBrightnessConfirmation示例:
{
"header": {
"messageId": "9422676d-2356-4aa7-aa88-c642f12bfcd6",
"name": "DecrementBrightnessConfirmation",
"namespace": "SmartHome.Control",
"payloadVersion":"2"
},
"payload": {
"status": {
"brightnessValue": 50.0
}
}
}