Get Keys of Remote Control

Last Updated on : 2023-06-20 14:54:04download

Get the information about the keys supported by the remote control based on the remote control ID.

API address

GET: /v2.0/infrareds/{infrared_id}/remotes/{remote_id}/keys

Request parameter

Parameter name Type IN Required Description
infrared_id String uri true The device ID.
remote_id String uri true The ID of a specified remote control.

Return parameter

Parameter name Type Description
result DeviceSupportKeyResultVO

Description of result

Parameter name Type Description
brand_id Integer The ID of a specified brand.
category_id Integer The ID of a specified category.
remote_index Integer The index of a specified remote control.
single_air Boolean Indicates whether it is a unitary air conditioner.
duplicate_power Boolean Indicates whether the power-on button is the same as the power-off button.
key_list List The list of keys.
key_range List The range of keys.

Description of key_list

Parameter name Type Description
key String The key.
key_id Integer The key ID.
key_name String The name of a specified key.
standard_key Boolean Indicates whether it is a standard key.

Description of key_range

Parameter name Type Description
mode Integer The working mode. Valid values:
  • 0: cooling.
  • 1: heating.
  • 2: automatic.
  • 3: air supply.
  • 4: dehumidification.
mode_name String The name of a working mode. Valid values:
  • Cooling mode.
  • Heating mode.
  • Automatic mode.
  • Air supply mode.
  • Dehumidification mode.
temp_list List

Description of temp_list

Parameter name Type Description
temp Integer The temperature.
temp_name String The temperature name.
fan_list Set The value range of the wind speed.

Description of fan_list

Parameter name Type Description
fan Integer The wind speed. Valid values:
  • 0: automatic.
  • 1: low speed.
  • 2: medium speed.
  • 3: high speed.
fan_name String The name of the wind speed. Valid values:
  • Automatic.
  • Low speed.
  • Medium speed.
  • High speed.

Request example

GET: /v2.0/infrareds/vdevo15345926009****/remotes/d5s65ca55/keys

Return example

{ "result": { "duplicate_power": false, "key_list": [ { "key_id": 0, "standard_key": true, "key_name": "Wind Speed", "key": "F" }, { "key_id": 0, "standard_key": true, "key_name": "Mode", "key": "M" }, { "key_id": 0, "standard_key": true, "key_name": "Power off", "key": "PowerOff" }, { "key_id": 0, "standard_key": true, "key_name": "Power on", "key": "PowerOn" }, { "key_id": 0, "standard_key": true, "key_name": "Temperature", "key": "T" } ], "remote_index": 102180055, "single_air": false, "key_range": [ { "temp_list": [ { "temp": 17, "temp_name": "Temperature 17", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 18, "temp_name": "Temperature 18", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 19, "temp_name": "Temperature 19", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 20, "temp_name": "Temperature 20", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 21, "temp_name": "Temperature 21", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 22, "temp_name": "Temperature 22", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 23, "temp_name": "Temperature 23", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 24, "temp_name": "Temperature 24", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 25, "temp_name": "Temperature 25", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 26, "temp_name": "Temperature 26", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 27, "temp_name": "Temperature 27", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 28, "temp_name": "Temperature 28", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 29, "temp_name": "Temperature 29", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] }, { "temp": 30, "temp_name": "Temperature 30", "fan_list": [ { "fan_name": "Low speed", "fan": 1 }, { "fan_name": "High speed", "fan": 3 }, { "fan_name": "Automatic speed", "fan": 0 } ] } ], "mode": 0, "mode_name": "Cooling mode" }, { "temp_list": [ { "temp": 25, "temp_name": "Temperature 25", "fan_list": [ { "fan_name": "Automatic speed", "fan": 0 } ] } ], "mode": 2, "mode_name": "Automatic mode" }, { "temp_list": [ { "temp": 25, "temp_name": "Temperature 25", "fan_list": [ { "fan_name": "Automatic speed", "fan": 0 } ] } ], "mode": 3, "mode_name": "Air supply mode" }, { "temp_list": [ { "temp": 25, "temp_name": "Temperature 25", "fan_list": [ { "fan_name": "Automatic speed", "fan": 0 } ] } ], "mode": 4, "mode_name": "Dehumidification mode" } ], "brand_id": 182, "category_id": 5 }, "t": 1633673833246, "success": true }

Error code

For more information, see error code.