{"id":13592561,"url":"https://github.com/CFenner/MMM-AirQuality","last_synced_at":"2025-04-08T23:33:22.508Z","repository":{"id":44895725,"uuid":"55102386","full_name":"CFenner/MMM-AirQuality","owner":"CFenner","description":"A module for the MagicMirror to display a location's air quality index.","archived":false,"fork":false,"pushed_at":"2024-09-16T18:54:16.000Z","size":232,"stargazers_count":35,"open_issues_count":5,"forks_count":15,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-09-16T23:48:56.634Z","etag":null,"topics":["air-quality","magic-mirror-modules","magicmirror"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CFenner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"cfenner","ko_fi":"hafenstrand"}},"created_at":"2016-03-30T22:33:36.000Z","updated_at":"2024-09-16T15:22:27.000Z","dependencies_parsed_at":"2024-01-13T06:58:05.237Z","dependency_job_id":"92f713e3-1799-4283-baed-fb448f68ae22","html_url":"https://github.com/CFenner/MMM-AirQuality","commit_stats":{"total_commits":61,"total_committers":6,"mean_commits":"10.166666666666666","dds":0.2622950819672131,"last_synced_commit":"149fed625a4bc57bcfb1159ed711f1f6ddc18ae6"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFenner%2FMMM-AirQuality","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFenner%2FMMM-AirQuality/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFenner%2FMMM-AirQuality/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFenner%2FMMM-AirQuality/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CFenner","download_url":"https://codeload.github.com/CFenner/MMM-AirQuality/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223346842,"owners_count":17130516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["air-quality","magic-mirror-modules","magicmirror"],"created_at":"2024-08-01T16:01:10.735Z","updated_at":"2024-11-06T13:31:42.482Z","avatar_url":"https://github.com/CFenner.png","language":"JavaScript","funding_links":["https://github.com/sponsors/cfenner","https://ko-fi.com/hafenstrand"],"categories":["JavaScript","Travel"],"sub_categories":[],"readme":"[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=CFenner_MMM-AirQuality\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=CFenner_MMM-AirQuality)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=CFenner_MMM-AirQuality\u0026metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=CFenner_MMM-AirQuality)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=CFenner_MMM-AirQuality\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=CFenner_MMM-AirQuality)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=CFenner_MMM-AirQuality\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=CFenner_MMM-AirQuality)\n[![All Contributors](https://img.shields.io/github/all-contributors/CFenner/MMM-AirQuality/main)](#contributors-)\n[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://choosealicense.com/licenses/mit/)\n\n# MMM-AirQuality\n\nA module for the [MagicMirror](https://github.com/MagicMirrorOrg/MagicMirror) to display a location's [*air quality index*](https://en.wikipedia.org/wiki/Air_quality_index) using data from [aqicn.org](http://aqicn.org/here/).\n\n## Preview\n\n![preview](.github/preview-unhealthy.png)\n\nwith header and location\n\n![preview](.github/preview-good.png)\n\nwithout any header\n\n![preview](.github/preview-very-unhealthy.png)\n\n## Usage\n\nYou need to install and configure the module for your MagicMirror.\n\n### Setup\n\nClone the module into your modules folder:\n\n```shell\ncd ~/MagicMirror/modules \u0026\u0026 git clone https://github.com/CFenner/MMM-AirQuality\n```\n\n### Configuration\n\nAdd the module configuration to your `config.js` file.\n\n```js\n{\n  module: 'MMM-AirQuality',\n  position: 'top_center',\n  config: {\n    token: 'ADD_YOUR_TOKEN_HERE',\n    location: 'germany/hamburg/sternschanze/' // the location to check the index for\n  }\n},\n```\n\n### Token\n\nTo use the WAQI API you need to [request a token](https://aqicn.org/data-platform/token/).\n\n### Location\n\nDetermine the station you want to display by selecting a station on the [map](https://aqicn.org/here/).\n\n#### Using Station Names\n\nIf the selected station is a named station, e.g. `http://aqicn.org/city/netherland/utrecht/griftpark/` use the name from the URL in your `location` variable. For the given example this would be `netherland/utrecht/griftpark/`.\n\n#### Third-Party Sensors\n\nIf your station is affiliated with a third-party air sensor network, such as the *uRad Monitor air quality sensor network*, you are required to specify the station identifier (e.g., A129586) in your `location` variable. For the station `https://aqicn.org/station/@63628/` this would be `A63628`, so just replace the `@` with an `A`.\nPlease verify data retrieval by visiting `https://api.waqi.info/feed/\u003cprovide station Id\u003e/?token=\u003cprovide your token\u003e`.\n\n#### Using GPS Coordinates\n\nYou may also get the data for specific longitude and latitude. Set the `location` to `geo:lat;lng/` and replace `lat` and `lng` with your values.\n\n### Further Options\n\nYou may want to set the following options in the config section as well:\n\n| Option |  Description | Default | Required |\n|---|---|---|---|\n| `location` | The location for that you you want to show the air quality.|| x |\n| `lang` | change the language | `en`||\n| `updateInterval` | change the update period in minutes  | `30` ||\n| `showLocation` | toggle location printing | `true` ||\n| `appendLocationNameToHeader` | If set to `true`, the returned location name will be appended to the header of the module. | `true` ||\n| `showIndex` | toggle index printing | `true` ||\n\n### Known Issues\n\n- Due to the AQI rendering script it is not possible to have multiple instances of this module running.\n- There is a bug in the skript that prevent some locations from being displayed (e.g. 'Mannheim').\n- Not all languages may be supported (see: \u003chttp://aqicn.org/faq/2015-07-28/air-quality-widget-new-improved-feed/\u003e).\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://www.justin-c.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1727656?v=4?s=100\" width=\"100px;\" alt=\"Justin Cherniak\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJustin Cherniak\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/CFenner/MMM-AirQuality/commits?author=jcherniak\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://bogminic.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10672395?v=4?s=100\" width=\"100px;\" alt=\"Bogdan Mihai Nicolae\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBogdan Mihai Nicolae\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/CFenner/MMM-AirQuality/commits?author=bogminic\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCFenner%2FMMM-AirQuality","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCFenner%2FMMM-AirQuality","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCFenner%2FMMM-AirQuality/lists"}