Skip to content

evanxd/air-quality-widget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Air Quality Widget

A Web widget to visually show real-time air quality data. It depends on two libraries, D3.js (Liquid Fill Gauge) to show data visually and Paho to get data from a MQTT server.

Go to the widget demonstration page to see the visualized real-world air quality data. If the value on the widget always keeps zero, it means no one uploads air quality data to the MQTT broker/topic. And you can follow the instruction to setup one and show the data visually with the widget.

How-to

This is a iframe-based widget. You can simply embed it into your web page with the below one line HTML code.

<iframe src="http://evanxd.io/air-quality-widget/widget.html?mqtt=broker.mqtt-dashboard.com&port=8000&topic=topic" frameborder="0" scrolling="no"></iframe>

This is its URL search parameters to receive air quality data from a specific MQTT server or topic.

  • Required
    • topic
      • A MQTT topic you receive the data from, the default value is topic.
  • Optional
    • mqtt
      • A MQTT server address, the default value is broker.mqtt-dashboard.com.
    • port
      • A MQTT server port, the default value is 8000.
    • mode
      • The widget mode you want to use, the default value is average.
        • average means show the one-minute average data.
        • real-time means show the real-time data at a moment.

The air quality data format/example on the MQTT broker topic is

{ "pm1_0": 26, "pm2_5": 36, "pm10_0": 38 }

Please make sure you have same format data to use the widget, or just flash the air-quality-monitoring-station firmware into your device to do so.