AirVisual - Home Assistant

Using the AirVisual Cloud API TheairvisualsensorplatformqueriestheAirVisualcloudAPIforairqualitydata.Datacanbecollectedvialatitude/longitude,bycity/state/country,orfromanAirVisualNode/Prounit. UsingtheAirVisualCloudAPI AirVisualAPIkeyscanbeobtainedhere.Notethattheplatformwasdesignedusingthe“Community”package;the“Startup”and“Enterprise”packagekeysshouldcontinuetofunction,butactualresultsmayvary(ornotworkatall). TheCommunityAPIkeyisvalidfor12monthsafterwhichitwillexpire.YoumustthengobacktotheAirVisualwebsite,deleteyouroldkey,createanewonefollowingthesamestepsandupdateyourconfigurationwiththenewkey. The“Community”APIkeyislimitedto10,000callspermonth.InordertoaccommodateusingthesameAPIkeyformultiplegeographies,theairvisualintegrationwillautomatically“re-level”thetimebetweenAPIcallssoastonotoverrunthecalllimit. Forexample: Oneinstanceoftheintegration:APIcallsevery5minutes Twoinstancesoftheintegration:APIcallsevery10minutes etc. UsinganAirVisualNode/ProUnit TheintegrationcancommunicatetoNode/Prounitsoverthelocalnetwork.YouwillneedtheIPaddress/hostnameoftheunitanditsSambapassword(whichcanbefoundontheunit;instructionshere). Configuration AddingAirVisualtoyourHomeAssistantinstancecanbedoneviatheuser interface,byusingthisMybutton: Manualconfigurationsteps IftheaboveMybuttondoesn’twork,youcanalsoperformthefollowingsteps manually: BrowsetoyourHomeAssistantinstance. InthesidebarclickonConfiguration. Fromtheconfigurationmenuselect:Integrations. Inthebottomright,clickonthe AddIntegrationbutton. Fromthelist,searchandselect“AirVisual”. Followtheinstructiononscreentocompletethesetup. DeterminingtheCity/State/Country Inadditiontousinglatitudeandlongitude,theAirVisualintegrationmaybeconfiguredtouseacity/state/countrycombination.Toeasilydeterminethepropervaluesforaparticularlocation,usetheAirVisualregiondirectory.Onceyoubrowsetotheparticularcityyouwant,takenoteofthebreadcrumbtitle,whichisoftheformcountry>state/region>city. Forexample,SaoPaulo,BrazilshowsabreadcrumbtitleofBrazil>SaoPaulo>SaoPaulo.Thus,thevaluestouseintheUIwouldbe: City:SaoPaulo State:SaoPaulo Country:Brazil SensorTypes CloudAPI Whenconfigured,theplatformwillcreatethreesensorsforeachairqualitystandard: AirQualityIndex Description:Thissensordisplaysanumericairqualityindex(AQI),ametricfortheoverall“health”oftheair. ExampleSensorName:sensor.chinese_air_quality_index ExampleSensorValue:32 Explanation: AQI Status Description 0-50 Good Airqualityisconsideredsatisfactory,andairpollutionposeslittleornorisk 51-100 Moderate Airqualityisacceptable;however,forsomepollutantstheremaybeamoderatehealthconcernforaverysmallnumberofpeoplewhoareunusuallysensitivetoairpollution 101-150 UnhealthyforSensitiveGroups Membersofsensitivegroupsmayexperiencehealtheffects.Thegeneralpublicisnotlikelytobeaffected 151-200 Unhealthy Everyonemaybegintoexperiencehealtheffects;membersofsensitivegroupsmayexperiencemoreserioushealtheffects 201-300 Veryunhealthy Healthwarningsofemergencyconditions.Theentirepopulationismorelikelytobeaffected 301+ Hazardous Healthalert:everyonemayexperiencemoreserioushealtheffects AirPollutionLevel Description:ThissensordisplaystheassociatedStatus(fromtheabovetable)forthecurrentAQI. SampleSensorName:sensor.us_air_pollution_level ExampleSensorValue:Moderate MainPollutant Description:Thissensordisplaysthepollutantwhosevalueiscurrentlyhighest. SampleSensorName:sensor.us_main_pollutant ExampleSensorValue:PM2.5 Explanation: Pollutant Symbol MoreInfo Particulate(<=2.5μm) PM2.5 EPA:ParticulateMatter(PM)Pollution Particulate(<=10μm) PM10 EPA:ParticulateMatter(PM)Pollution Ozone O EPA:OzonePollution SulpherDioxide SO2 EPA:SulfurDioxide(SO2)Pollution CarbonMonoxide CO EPA:CarbonMonoxide(CO)PollutioninOutdoorAir Node/Pro Node/Prounitswillcreateavarietyofsensors: AirQualityIndex(AQI) BatteryLevel CarbonDioxide(CO2) Humidity Particulate(<=0.1μm)(PM0.1) Particulate(<=2.5μm)(PM2.5) Particulate(<=10μm)(PM10) Temperature VolatileOrganicCompounds(VOC) Helpustoimproveourdocumentation Suggestanedittothispage,orprovide/viewfeedbackforthispage. Edit Providefeedback Viewpendingfeedback TheAirVisualintegrationwasintroducedinHomeAssistant0.53, andit'susedby 806activeinstallations. ItsIoTclassisCloudPolling. YoucanfindthesourceforthisintegrationonGitHub. Categories Health Onthispage UsingtheAirVisualCloudAPI UsinganAirVisualNode/ProUnit Configuration DeterminingtheCity/State/Country SensorTypes CloudAPI Node/Pro