Skip to content

thecreativeone91/Control4-AirGradientLocalAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

AirGradient Air Quality Monitor (Local API)

Connects a Local API AirGradient monitor (ONE or Open Air) directly to Control4—no AirGradient cloud account required.

The driver polls the following endpoints on the monitor's built-in web server over your local network:

  • /measures/current
  • /config

Setup

  1. Add the driver to a room in Composer Pro.
  2. Open the driver's Properties tab and set Host or IP Address to either:
    • the monitor's mDNS hostname (airgradient_<serial>.local), or
    • its static IP address.
  3. Adjust Polling Interval and the alert thresholds if desired.
  4. Data should begin populating within one polling interval.
  5. If data does not appear, enable Debug Logging and check the Lua tab.

Navigator Display

The device uses Control4's thermostatV2 proxy in sensor-only mode. It does not control heating or cooling equipment.

The monitor appears under the Comfort experience.

Main Tile

Displays:

  • Current temperature
  • Current humidity

Extras Tab

Displays:

  • PM2.5
  • PM1.0
  • PM10
  • CO₂
  • TVOC Index
  • NOx Index

These are the calibrated/index readings rather than the raw sensor output.

Note

Fahrenheit/Celsius display follows Composer Pro's system-wide temperature unit setting, not a property on this driver.


Properties

Property Description
Host or IP Address Monitor's mDNS hostname or IP address.
Polling Interval (seconds) How often the driver polls the monitor. Minimum 3 seconds.
Use Compensated Values Whether the main temperature, humidity, and PM2.5 properties use AirGradient's correction algorithms or raw sensor output.
Temperature Display Unit Only affects the informational Temperature (Display) property. Navigator follows the system-wide unit setting.
Debug Logging Prints detailed request/response information to the Lua Debug tab.
PM2.5 / CO₂ / TVOC / NOx Alert & Clear Thresholds Levels used to trigger Programming events. Separate alert and clear thresholds provide hysteresis.
PM1.0 / PM2.5 / PM2.5 Compensated / PM10 (µg/m³) Live particulate readings.
CO₂ (ppm) Live CO₂ reading.
Temperature / Temperature Compensated (°C), Humidity / Humidity Compensated (%) Live climate readings, raw and corrected.
TVOC Index / Raw, NOx Index / Raw Live VOC and NOx sensor readings.
WiFi Signal, Firmware Version, Model, Serial Number, Boot Count, LED Mode Device identity and status reported by the monitor.
Config: Country / PM Standard / LED Bar Mode / Display Brightness / LED Bar Brightness Mirror of the monitor's /config settings.

Note

LED Mode and the LED-related Config fields remain blank on AirGradient Open Air (outdoor) units because they do not include an LED bar. This is expected behavior.


Programming Actions

Action Description
Refresh Sensor Data Now Poll the monitor immediately instead of waiting for the next scheduled interval.
Calibrate CO₂ Sensor Triggers a 400 ppm reference calibration.
Run LED Bar Test Sequence Runs the built-in LED test (ONE monitors only).
Set LED Bar Mode co2, pm, iaqs, or off
Set Display Brightness 0–100
Set LED Bar Brightness 0–100
Set Device Display Temperature Unit Sets the unit shown on the monitor's physical display (C or F). This is independent of Control4 Navigator.

Programming Events

Event Fires When
PM2.5 / CO₂ / TVOC / NOx Above Threshold Reading rises to or above its configured Alert Threshold.
PM2.5 / CO₂ / TVOC / NOx Back to Normal Reading falls to or below its configured Clear Threshold.
Monitor Came Online The first successful poll after being considered offline.
Monitor Went Offline Three consecutive polls fail.
Sensor Data Refreshed Every successful poll. Useful as a general-purpose trigger.

Example

Turn off a fresh-air intake fan when PM2.5 is high

When

AirGradient Air Quality Monitor
    → PM2.5 Above Threshold

Then

Your Fan/Damper Driver
    → Turn Off

Add a second automation using PM2.5 Back to Normal to restore normal operation.


Connections

Two output connections are available for wiring directly into other drivers or Programming.

Connection Class
Temperature TEMPERATURE_VALUE
Humidity HUMIDITY_VALUE

Note

You may notice an internal Thermostat connection under Audio/Video in Control4's Connections view. This is internal plumbing required by the thermostatV2 proxy and does not need to be connected.


Troubleshooting

No data

Verify:

  • Host or IP Address is correct.
  • The monitor is reachable from the Control4 controller.
  • Debug Logging is enabled.
  • Check the Lua Debug tab for errors.

PM2.5 reads 0

AirGradient's algorithm may round extremely low readings down to 0.


Version

Version 1

Built for the AirGradient Local Server API:

https://github.com/airgradienthq/arduino/blob/master/docs/local-server.md

Compatible with firmware 3.0.10 and later.

About

Connects a Local-API AirGradient monitor (ONE or Open Air) directly to Control4 - no AirGradient cloud account required. Polls /measures/current and /config on the monitor's built-in web server over your local network.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages