Jump to content

Welcome to Smart Home Forum by FIBARO

Dear Guest,


as you can notice parts of Smart Home Forum by FIBARO is not available for you. You have to register in order to view all content and post in our community. Don't worry! Registration is a simple free process that requires minimal information for you to sign up. Become a part of of Smart Home Forum by FIBARO by creating an account.


As a member you can:

  •     Start new topics and reply to others
  •     Follow topics and users to get email updates
  •     Get your own profile page and make new friends
  •     Send personal messages
  •     ... and learn a lot about our system!



Smart Home Forum by FIBARO Team

Airly Status - Air Quality Sensor based on Airly.eu (API 2.0) 1.0

   (0 reviews)

3 Screenshots

About This File

Device features

Periodimage.png.6904b342916fcd2711506a081cc1d234.pngic reports on air quality for a defined location.Screen01.png.458565505c5fe25f61fe9ae2788034a3.png
Be warned about the smog conditions at your place instantly.






Advantages for everyone

  • Automatic status update. Custom interval value for update queries. Manual update is also available (via button).
  • May use "interpolation mode" (enabled by default in Lua scene). Airly gives you an option to calculate estimated values for any location near their stations, to see more then just what is exactly measured by the station.
  • You may select the language used for Airly messages. Polish and English are supported.
  • Colors to visualize Smog description. This will work on PC only. The mobile app does not interpret HTML tags.
  • Icon color is changing according to air quality measured. The colors are in correspondence with Airly recommendations.
  • One of three different air quality indexes from Airly might be selected. Airly supports: "AIRLY_CAQI", "CAQI" and "PIJP". Each may have different levels, descriptions, and pieces of advice.
  • Customizable location for reports. The location might be read automatically from your Home Center box or it might be set as a fixed one.
  • Data retrieved from Airly are stored in a global variable. The variable might be used to trigger another scene.



Advantages for geeks

  • Using the newest API 2.0.
  • Missing pieces of data from Airly are properly detected and do not stop the device from working.
  • No label "flickering" ("50%" → "missing data" → "52%", e.g.) on data updates. Changes on any update are reported once.
  • Clear information about the license (MIT). Make any changes you want, distribute, sell or whatever. Just include my name and the copywrite information.
  • Easy to change labels content, data grouping within labels, etc. (data selectors within one config variable labelConfig).
  • Source code easy to maintain and develop: rich debug information; separation of acquisition, extraction and data presentation, etc.


  1. Import the virtual device and create a new Lua scene with the code provided in the file.
  2. Add device icons and update their IDs in the virtual device main loop.
  3. Replace 'xxx...x' with the key you can get from Airly free of charge.
  4. Start the Lua scene manually (just for the first time).
  5. (optional) Customize: update interval, display language, labels content and many more (see details below).


Read comments in Lua scene and VD main loop. 
Each configuration parameter is described there in details.

Zip file content

  • Virtual device: "Airly Status".
  • Lua scene for grabbing data from Airly: "Airly Status scraper".
  • Nine device icons to visualize air quality.
  • Screenshots.


How can I get Airly API key?

Get one from developer.airly.eu. When you register an account within that website you will get your free API key.

How to upload/add device icons?

  1. Open (any) virtual device configuration page.
  2. Press "Change icon".
  3. Press "Select file" (in the bottom), choose file, then confirm with "Add" button (even lower).

Please make sure to execute step 1 properly. Icons in Home Center are divided into several categories. If your icons are placed not in the "virtual device collection", they will not be visible for the device.

How can I get an icon ID?

  1. Open (any) virtual device configuration page.
  2. Press "Change icon".
  3. Right click on the icon you want to get an ID. Select "Open graphics in a new tab". The address should be like: "http://hc2/fibaro/n_vicons/User1003.png". 1003 is your ID in this case.

How can I change the language for all displayed information?

  1. Change config variable in Lua scene. Only "pl" and "en" messages are supported by Airly API.
  2. Update display name of each label.
  3. Update labels content (if needed) by editing labelConfig variable in VD main loop. There is the same string formatting as for the Lua print function.

What's New in Version 1.0   See changelog


No changelog available for this version.

  • Thanks 1

User Feedback

Recommended Comments

great stuff, thanks for that


would be great to have possibility to use these air data as a trigger for scenes. for examples: close roller shutter if air quality is poor.

maybe this could be done by additional variables.


thank you!

Link to comment
Share on other sites

W dniu 22.01.2020 o 22:41, maciek188 napisał:

would be great to have possibility to use these air data as a trigger for scenes. for examples: close roller shutter if air quality is poor.

maybe this could be done by additional variables.


Sure, it is possible right now. No more variables are needed. The device stores all retrieved data in a global variable already. You can create very simple Lua scene on any condition and action you like. For detecting high pollution you could do:

%% properties
%% events
%% globals AirlyStatus
local data = json.decode(fibaro:getGlobalValue("AirlyStatus")) 
if data.action == nil and data.indexes.AIRLY_CAQI.value > 75 then
  fibaro:debug("Very bad air") 
  -- close covers, send notify or anything you need... 
  -- ...


  • Thanks 1
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Add a comment...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Create New...