REST API for display/light on Samsung Windfree AC

[h0ckeysk8er (Bruce Pinsky)]

@phgsbr

Guys, sorry for resurrecting this topic. I’m learning how to code, and the solutions here have helped me make some progress.

By adapting @Krupal_Desai curl command to the Shell Command Integration in Home Assistant, I was able to create two buttons to turn my WindFree display on and off.

However, I would like to create a sensor using REST to retrieve the display status as well. I found a code snippet for this, but it is not working.

sensor:
     - platform: rest
      name: "OCF_Display_Status"
      resource: "https://api.smartthings.com/v1/devices/<DEVICE ID HERE>/components/main/capabilities/samsungce.airConditionerLighting/status"
      method: GET
      headers:
        Authorization: "Bearer <YOUR TOKEN HERE>"
        value_template: "{{ value_json.lighting.value }}"   

I got the error "message: “The request is malformed.”
I suspect that the resource address is incorrect. Could someone point me in the right direction?

Not sure where you got that API syntax from, but there are specific REST endpoints that will return the value(s) for a capability. For example, for a dimmer that supports these capabilities:

───────────────────
 #  Id             
───────────────────
 1  button         
 2  firmwareUpdate 
 3  refresh        
 4  switch         
 5  switchLevel    
───────────────────

You can get the value of switchLevel (as an example) by querying “https://api.smartthings.com/devices/{deviceId}/components/main/capabilities/switchLevel/status” which in turn returns:

───────────────────
 Attribute   Value 
 levelRange        
 level       1 %   
───────────────────

I am using the ST CLI in DEBUG mode to show the API calls the CLI makes to get data or execute commands. I would suggest using the CLI to determine the specific API call required to retrieve the value you are interested in. Also, no Body was required for this API call, only the Auth Header.

[phgsbr (Pedro Henrique Gonçalves)]

Thanks for the tip!

I tried to retrieve the value from https://api.smartthings.com/devices/{deviceId}/components/main/capabilities/switch/status, but unfortunately, the result was for the AC switch and not the AC display. I’m reading the documentation to discover the correct endpoint, but I haven’t had any success so far.

[h0ckeysk8er (Bruce Pinsky)]

@phgsbr

Thanks for the tip!

I tried to retrieve the value from https://api.smartthings.com/devices/{deviceId}/components/main/capabilities/switch/status, but unfortunately, the result was for the AC switch and not the AC display. I’m reading the documentation to discover the correct endpoint, but I haven’t had any success so far.

You can use the CLI a couple of different ways to see the list of capabilities/components. For example:

smartthings devices:component-status

will give you a list of devices and when you select one, you get a list of all the components:

 Capability      Attribute                Value                           
 button          button                   "up_2x"                         
 button          numberOfButtons          1                               
 button          supportedButtonValues    ["up_2x","down_2x","pushed_2x"] 
 switchLevel     levelRange                                               
 switchLevel     level                    1 %                             
 firmwareUpdate  lastUpdateStatusReason                                   
 firmwareUpdate  imageTransferProgress                                    
 firmwareUpdate  availableVersion                                         
 firmwareUpdate  updateRequired                                           
 firmwareUpdate  lastUpdateStatus                                         
 firmwareUpdate  supportedCommands                                        
 firmwareUpdate  state                                                    
 firmwareUpdate  estimatedTimeRemaining                                   
 firmwareUpdate  updateAvailable                                          
 firmwareUpdate  currentVersion           "5.29"                          
 firmwareUpdate  lastUpdateTime                                           
 firmwareUpdate  supportsProgressReports                                  
 switch          switch                   "off"                           

You can also “smartthings devices:capability-status” which will allow you to select a device and then give you a list of its capabilities similar to what is in my first post.

The other option if you aren’t comfortable with the CLI is to use the ST Advanced Web App which will give you a list of the capabilities in the Attributes section of the device info.

[phgsbr (Pedro Henrique Gonçalves)]

I’ve been testing for days, and unfortunately, none of the available capabilities seem to be responsible for the display. I’ve seen other cases where ‘samsungce.airConditionerLighting’ was the correct option, but this capability is not available in my case.

[Victor_Barreira]

In the same as you @phgsbr. any advance by your side?