My Flair HVac Unit

The Unofficial SmartThings Blog
Jump to navigation Jump to search


Portable AC 2000x1500-556.png Minisplit 1000 turned 2000x1500-556.png Window AC 2000x1500-556.png


Brand:Flair

Models:HVAC Units (MiniSplit/Window Units, Portable heaters/coolers

Type: Smart climate-control in every room for Mini Splits/Window Units and Portable heater/coolers.

Protocol: Wi-Fi to the puck gateway, IR to the devices

Link to Flair website [1]

Device Type Author:Yves Racine

ST Community handle http://community.smartthings.com/users/yvesracine/activity

Hubitat handle https://community.hubitat.com/u/yracine66/activity

Company Link: http://www.ecomatiqhomes.com#!home/mainPage



Contents

Contribution fee is required

The Flair devices have required hundreds of hours of development & testing efforts to build, so a mandatory contribution fee is required to get the code.


To download the code, go to

http://www.ecomatiqhomes.com/store

Technical support packages are also available.


If you want to contribute more, here is the paypal link below.

https://paypal.me/ecomatiqhomes

Prerequisites

  • Puck gateway operational & connected to Flair via wi-fi
  • The puck needs to be hardwired and close to the IR device to be controlled.
  • IR codeset downloaded for the HVAC unit to the Puck device
  • Flair Setup completed: basic information about your home & rooms entered via the Flair Mobile App or the Flair portal
    see setup video here: https://www.youtube.com/watch?v=Cg_rPqM8o8k
  • IR setup at the Puck fully operational (you can test it using the Flair Mobile app)
  • Manual mode enabled in the flair app (as you're letting SmartThings control the flair device(s) via APIs, not Flair)
  • Your automation hub fully operational
  • Flair HVAC Unit operational & connected to Flair via the Puck gateway

Article(s) in the media

  https://flair.co/blogs/news/flairs-open-culture-and-platform

Information

  • Functionality:Works with your central heating and cooling system to eliminate uneven room temperatures across your home by automatically controlling how much air goes to each room.
  • Support of US and metric scale systems (Celsius, Fahrenheit, etc)



Here is a list of Capabilities

   capability "airConditionerMode"
   capability "setFanSpeed"
   capability "ThermostatHeatingSetpoint"
   capability "ThermostatCoolingSetpoint"
   capability "ThermostatSetpoint"
   capability "ThermostatMode"
   capability "ThermostatFanMode"
   capability "ThermostatOperatingState"        
   capability "Temperature Measurement"
   capability "Switch"
   capability "Polling"
   capability "Refresh"
   capability "Sensor"
   capability "Actuator"
   capability "Health Check"


  • Here is the complete list of commands (see the signature in the DTH code, next to command's implementation for details about parameters):
   command "getHvacUnitInfo"
   command "getHvacUnitStates"
   command "setHvacUnit"
   command "levelUp"
   command "levelDown"
   command "heatLevelUp"
   command "heatLevelDown"
   command "coolLevelUp"
   command "coolLevelDown"
   command "setThermostatFanMode"
   command "setThermostatFanSpeed"
   command "fanLow"
   command "fanMedium"
   command "fanHigh"
   command "fanOff"
   command "fanAuto"
   command "fanOn"
   command "swingOn"
   command "swingOff"
   command "swingTop"
   command "setSwingMode"
   command "getRoom"
   command "setRoom"
   command "setRoomType"
   command "setRoomLevel"
   command "setRoomUserDesiredTemp"
   command "setRoomSetpoint"
   command "setRoomTempAwayMin"
   command "setRoomTempAwayMax"
   command "setRoomHumidityAwayMin"
   command "setRoomHumidityAwayMax"
   command "setRoomPreHeatPrecool"
   command "setRoomFrozenPipePetProtect"
   command "setRoomAirReturn"
   command "setRoomActive"        
   command "setRoomAwayMode"
   command "setRoomPucksInactive"        
   command "setAirConditionerMode"        
   command "setFanSpeed"        
   
   command "getZone"
   command "getZonesList"
       


List of Attributes available for subscription (in any rule engine like CoRE/WebCoRE/SmartRules)

   attribute "structureId"
   attribute "hvacUnitId"
   attribute "hvacUnitName"
   attribute "hvacUnitMake"
   attribute "type"
   attribute "power"
   attribute "capabilities"
   attribute "makeId"
   attribute "codesetId"
   attribute "buttonPresses"
   attribute "swingMode"
   attribute "temperatureDisplay"
   attribute "coolingSetpointDisplay"
   attribute "heatingSetpointDisplay"
   attribute "thermostatFanSpeed"
   attribute "verboseTrace"
   attribute "hvacUnitOperatingState"        
   attribute "createdAt"
   attribute "updatedAt"
   attribute "hvacUnitData"       
   attribute "hvacUnitList"       
   attribute "hvacUnitStatesData"       

List of Room's Attributes available in My Flair HVAC Unit

   attribute "roomId"
   attribute "roomName"
   attribute "rmSetpoint"
   attribute "rmCurrentTemperature"
   attribute "rmUserDesiredTemperature"
   attribute "rmPreheatPrecool"
   attribute "rmTempAwayMin"
   attribute "rmTempAwayMax"
   attribute "rmHumidityAwayMin"
   attribute "rmHumidityAwayMax"
   attribute "rmHoldReason"        
   attribute "rmHoldUntil"        
   attribute "rmActive"        
   attribute "rmPucksInactive"        
   attribute "rmWindows"        
   attribute "rmAwayMode"        
   attribute "rmAirReturn"
   attribute "rmType"        
   attribute "rmLevl"        
   attribute "rmFrozenPipePetProtect"
   attribute "roomData"

List of Zones's Attributes available in My Flair HVAC Unit

   attribute "zoneList"
   attribute "zoneData"

Look & Feel

Hubitat

HubitatMyHvacUnit.PNG

In the new Samsung connect app

MyHVACUnit.jpg MyHVACUnitP2.jpg MyHVACUnitP3.jpg



Instructions for My Flair Device installation (readme): http://github.com/yracine/device-type.myFlair/blob/master/README.md

Known issues

.................................................................................................................................

UI elements are partially compatible with new STSC (Samsung) new app

.................................................................................................................................

Use of the SmartThings classic mobile app is required: all custom DTHs & smartapps above are partially compatible with the new Samsung Connect mobile app as ST is working on the required migration steps and UI tiles. However, you can create the devices in the ST classic mobile app, and use them in the new Samsung connect app.

Some UI elements not totally compatible are the scale (appearing sometimes in Celsius unless you change the setpoints), thermostat icon, and status that seems to be checking constantly as it's a cloud-to-cloud integration, etc.



.................................................................................................................................

Not all Flair API fields are populated or properly set by Flair

.................................................................................................................................

Some Flair API values are null or populated with zero values. Those fields are not mandatory and should not affect the general devices' behavior.


Please contact the Flair support if you have some issues with some null fields or fields not set by Flair properly as I'm sending the right commands on my side (according to the thin documentation available).

.................................................................................................................................

It's sometimes difficult to choose & set the right codeset for the IR device(s)

.................................................................................................................................


You have to choose the right codeset for your IR device using the Flair Mobile app and download it to your puck device.

The puck needs to be hardwired and close to the IR device to be controlled.

Sometimes, the IR device partially responds to the IR commands.

The SmartThings code will not work properly if the right IR codeset is not downloaded to the nearest puck.

Make sure to test all your IR supported Commands (ex. on/off, fanOn, FanHigh, FanMedium, FanLow, SwingOn, SwingOff, SwingTop, cool/heat) before using the DTH. There is a setup video link under the prerequisites section.

Please contact Flair support if you have any IR issues.

https://forum.flair.co/t/puck-and-mini-split-ir-setup/600/2

.................................................................................................................................

Response times may vary

.................................................................................................................................

All commands must be treated by the APIs in the cloud (SmartThings->Flair-->SmartThings), so response times may vary from few seconds to up to few tens of seconds depending on the load on the servers and any network latency involved.


.................................................................................................................................

Manual commands may cause some state desynchronization with Flair

.................................................................................................................................

The IR protocol with your unit is one-way only (Flair-->Unit). So, if you make any manual changes to your unit, the new state will not be sent back to Flair. This will probably cause some state desynchronization between Flair and your unit.


.................................................................................................................................

Structure & Room Data are cached

.................................................................................................................................

In order to avoid querying the Flair APIs for the structure & room data and for better performances, some information is locally cached in the device.

If you make changes to any room or stucture and want to update the device immediately (by default, it's done once a day at midnight), please manually press the "refresh" tile.

Troubleshooting

Here are some typical troubleshooting cases explained below. For your specific use cases, you may want to contact the author (there may be some support fees to be applied).

.................................................................................................................................

Issue #1: I don't know how to create a custom device

.................................................................................................................................



Hubitat

Copy the code from the text files under apps in the Hubitat IDE, and then press "Save".

CaptureHubitatDriver.PNG


SmartThings

See the explanations of a fellow community member here:

http://community.smartthings.com/t/faq-an-overview-of-using-custom-code-in-smartthings/16772 http://thingsthataresmart.wiki/index.php?title=Using_Custom_Code


Please refer to the installation readme (prerequisites) to find out what is the right shard for the procedure.


.................................................................................................................................

Issue #2: I created My Flair HVAC Unit handler and MyFlairServiceMgr in the IDE, but I don't know where to execute it

.................................................................................................................................


For the initial setup, under the new Samsung connect app, click on '+' sign in the upper right corner of the main page, and then on Smartapp. The smartapp should be under the Custom section.

If you still do not see your smartapp, please make sure that you have published it in the IDE!


For any subsequent execution, under the Samsung connect app, click on the 'hamburger' menu in the upper left corner. The list of installed smartapps will then appear under Smartapps.


P.S. If you don't see your smartapp, it could be that you're not using the right shard for the installation. Refer to

https://community.smartthings.com/t/faq-how-to-find-out-what-shard-cloud-slice-ide-url-your-account-location-is-on/53923

Or the SmartThings documentation here:

http://docs.smartthings.com/en/latest/publishing/index.html#ensure-proper-location


.................................................................................................................................

Issue #3: I executed MyFlairServiceMgr smartapp, but the 3rd page (after doing the login, and pressing Next) is blank

.................................................................................................................................

If you get a blank screen after pressing 'Next or you get the following error: " Error - bad state. Unable to complete page configuration" or any other ST errors, please check that you've enabled oAuth as specified in step 2f) in the readme.

https://github.com/yracine/device-type.myFlair/blob/master/README.md

Also, make sure that you've followed all the prerequisites:

http://thingsthataresmart.wiki/index.php?title=My_Flair_HVac_Unit#Prerequisites

Refer to MyFlairServiceMgr smartapp's installation for more details:

http://thingsthataresmart.wiki/index.php?title=MyFlairServiceMgr#Issue_.231:_I_don.27t_know_how_to_create_a_custom_smartapp

.................................................................................................................................

Issue #4: My Flair HVAC Unit is off by 'x' units with the Flair mobile app

.................................................................................................................................

First try to refresh the UI by pressing the 'refresh' tile. The UI does not allow automatic refresh at the moment.


.................................................................................................................................

Issue #5: I want to disable any notifications from MyFlairServiceMgr

.................................................................................................................................

Go to the smartapp's last page, and answer 'no' to the following question:

Send a push notification?"''

Be aware that you won't be notified of any connection issues.

.................................................................................................................................

Issue #6: "An unexpected error has occurred" or 'deleteObserver onError: %s' messages in MyFlairServiceMgr when I press 'Remove'

.................................................................................................................................


'Like any connected device, you need first to unselect all your Flair Devices from all the smartapps & routines as MyFlairServiceMgr will not uninstall w/o doing this step.

MyFlairServiceMgr is the Service Manager for all Flair Devices, so uninstalling the smartapp means that all Flair devices will be deleted.

.................................................................................................................................

Issue #7: I want to get more tracing in the IDE

.................................................................................................................................

Hubitat

a) Click on the device that you just created

http://192.168.xx.xx/device/edit/"device number" (Device number can vary from one location to the next)

b) Edit the preferences in the middle section of the screen)

You only need to edit the following parameters

(a) <trace> when needed, set to true to get more tracing (no spaces)

(b) <logFilter:1..5> Values=[Level 1=ERROR only,2=<Level 1+WARNING>,3=<2+INFO>,4=<3+DEBUG>,5=<4+TRACE>]

c) Save the preferences by clicking on the corresponding button.

N.B. The logs are available under the IDE at:

http://192.168.xx.xx/logs (insert your own hub's IP address)

You can click at the top of the window on the device name to filter the logs.

SmartThings

a) Go to https://graph.api.smartthings.com/device/list (or whatever your shard is and click on My Devices in the IDE's top menu)

b) Click on the device that you just created

c) Click on Preferences (edit)

You only need to edit the following parameters

(a) <trace> when needed, set to true to get more tracing (no spaces) (b) <logFilter:1..5> Values=[Level 1=ERROR only,2=<Level 1+WARNING>,3=<2+INFO>,4=<3+DEBUG>,5=<4+TRACE>]


.................................................................................................................................

Issue #8: I want to upgrade the code but I don't know how.

.................................................................................................................................

Most of the time (unless specified otherwise), you just need to copy and paste the My HVACUnit device's code from the the related txt files, and save & publish.

The same approach should be used for the smartapps.

For more details, please follow the instructions provided at:

http://github.com/yracine/device-type.myFlair/blob/master/README.md


.................................................................................................................................

Issue #9: java.util.concurrent.TimeoutException: Execution time exceeded 'x' app execution seconds

.................................................................................................................................

ST has introduced some generic rate limiting rules for all smartapps and device handlers.

For cloud-to-cloud integration, these rate limiting constraints are sometimes too low (due to network latency, servers involved, etc.), and this exception can be raised from time to time. There are some threads about it in the ST community forum:

http://community.smartthings.com/t/rate-limiting-too-restrictive-max-execution-time-exceptions/17985

http://community.smartthings.com/t/execution-times-increasing/19979

http://community.smartthings.com/t/unschedule-api-execution-time-too-long/11232


................................................................................................................................

Issue #10: com.datastax.driver.core.exceptions.ReadTimeoutException

.................................................................................................................................

These exceptions are thrown by the ST backend from time to time. I've been told that ST is working on it. This is not a specific issue with my code.

https://community.smartthings.com/t/cassandra-timeout-during-read-query/46227/3

...............................................................................................................................

Issue #11: I want to change all scales to the metric system.

.................................................................................................................................


The temperature scale needs to be changed for your account, so that all your devices will be in the metric system.

Press the "hamburger" menu (upper left), and then the "gear" icon. You'll find the option to change the temperature scale there and press "save".

At the next "refresh", My Flair HVAC Unit will display the values in the metric system.

................................................................................................................................

Issue #12: I cannot create any objects under the new Samsung app

.................................................................................................................................


No custom DTHs can be created under the new Samsung app for the moment as indicated in the prerequisites. You'd need to use the ST classic app to execute MyFlairServiceMgr in order to initially create the Flair devices. After creating the devices, follow the steps indicated in the installation pdf file included in the zip to force a refresh of the cache in order to make them appear correctly in the new Samsung app.


...............................................................................................................................

Issue #13: Some of my devices under the new Samsung app are disconnected

.................................................................................................................................


If some of your Flair devices are disconnected under the new Samsung app, you may have created many of the same devices by executing MyFlairServiceMgr too many times... Under the new Samsung mobile app, you then need to clean them up by pressing the "edit" button next to your location and removing them.

For further execution of the MyFlairServiceMgr smartapp, refer to issue #2 http://thingsthataresmart.wiki/index.php?title=My_Flair_HVac_Unit#Issue_.233:_I_executed_MyFlairServiceMgr_smartapp.2C_but_the_3rd_page_.28after_doing_the_login.2C_and_pressing_Next.29_is_blank