Skip to content

ifnull/MMM-AwairLocal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MMM-AwairLocal

A MagicMirror² module that pulls air quality data from an Awair device using its Local API (no cloud dependency). This allows you to monitor air quality in real-time directly on your MagicMirror setup.

Features

✅ Pulls data from Awair's Local API (no cloud required)
✅ Displays air quality score, temperature, humidity, CO₂, VOC, and PM2.5
✅ Supports Celsius & Fahrenheit for temperature display
✅ Allows multiple Awair devices with configurable names
✅ Auto-refreshes at a configurable interval

Screenshot

Installation

Clone the repository:

cd ~/MagicMirror/modules
git clone https://github.com/YOUR_GITHUB/MMM-AwairLocal.git
cd MMM-AwairLocal

Install dependencies:

npm install

Enable the module in your MagicMirror config/config.js:

{
  module: "MMM-AwairLocal",
  position: "top_right", // Adjust as needed
  config: {
    awairIp: "192.168.1.2", // Local IP of your Awair device
    deviceName: "Living Room Awair", // Custom name for the device
    updateInterval: 60000, // Refresh data every 60 seconds
    showScore: true,  // Display air quality score
    showTemp: true,   // Display temperature
    showHumidity: true, // Display humidity
    showCO2: true,    // Display CO₂ levels
    showVOC: true,    // Display VOC levels
    showPM25: true,   // Display PM2.5 levels
    tempUnit: "F" // "C" for Celsius, "F" for Fahrenheit
  }
}

Multiple Devices Example

If you have multiple Awair devices, you can add multiple instances of the module:

{
  module: "MMM-AwairLocal",
  position: "top_right",
  config: {
    awairIp: "192.168.1.2",
    deviceName: "Living Room Awair",
    tempUnit: "F"
  }
},
{
  module: "MMM-AwairLocal",
  position: "bottom_right",
  config: {
    awairIp: "192.168.1.3",
    deviceName: "Bedroom Awair",
    tempUnit: "F"
  }
}

Notes

  • Make sure the Local API is enabled on your Awair device (Awair+ tab in the Awair app).
  • The device must be on the same network as your MagicMirror.
  • This module does not use the cloud and relies entirely on the local API.

About

A MagicMirror module for displaying Awair local air quality data

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors