{"id":23639131,"url":"https://github.com/ericyoondotcom/mmm-particlestatus","last_synced_at":"2026-06-19T23:31:35.166Z","repository":{"id":105960595,"uuid":"141068119","full_name":"ericyoondotcom/MMM-ParticleStatus","owner":"ericyoondotcom","description":"MagicMirror module that shows you the status of your particle.io devices.","archived":false,"fork":false,"pushed_at":"2020-07-05T19:17:56.000Z","size":10,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-24T05:01:48.898Z","etag":null,"topics":["magic-mirror-modules","magicmirror"],"latest_commit_sha":null,"homepage":null,"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/ericyoondotcom.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}},"created_at":"2018-07-16T00:25:18.000Z","updated_at":"2020-07-05T19:17:58.000Z","dependencies_parsed_at":"2023-04-09T06:46:15.883Z","dependency_job_id":null,"html_url":"https://github.com/ericyoondotcom/MMM-ParticleStatus","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ericyoondotcom/MMM-ParticleStatus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericyoondotcom%2FMMM-ParticleStatus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericyoondotcom%2FMMM-ParticleStatus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericyoondotcom%2FMMM-ParticleStatus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericyoondotcom%2FMMM-ParticleStatus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ericyoondotcom","download_url":"https://codeload.github.com/ericyoondotcom/MMM-ParticleStatus/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericyoondotcom%2FMMM-ParticleStatus/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34552295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-19T02:00:06.005Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["magic-mirror-modules","magicmirror"],"created_at":"2024-12-28T08:12:40.900Z","updated_at":"2026-06-19T23:31:35.112Z","avatar_url":"https://github.com/ericyoondotcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MMM-ParticleStatus\n[MagicMirror](https://github.com/MichMich/MagicMirror) module that shows you the status of your [Particle](https://particle.io) devices.\n\n_**Note:** This project is not affiliated or endorsed by Particle Industries, Inc._\n\nMade by [Eric Yoon](http://yoonicode.com)\n\nLooking for a different UI? check [this fork](https://github.com/NickEngmann/MMM-ParticleStatus) by NickEngmann.\n\n## Installation and Setup\n### Set up Particle Side\nThis module listens for events. For each indicator you want to have on your Magic Mirror, make up a unique name for the event, such as \"LightStateChange\", \"Garage\", or \"Car\". Do not create separate events for the states (such as \"LightOn\" and \"LightOff\"); just an umbrella event.\n\nEach time you want to update the state of the indicator on the Magic Mirror, publish to that event by using `Particle.publish(\"Event Name\", \"New State\")` in the Particle firmware, such as the example shown below:\n```\nif(\u003cLight switch just turned on\u003e){\n    Particle.publish(\"Light\", \"On\");\n}\nif(\u003cLight switch just turned off\u003e){\n    Particle.publish(\"Light\", \"Off\");\n}\n```\nIt is important to not publish state every  `loop()` tick, just when the state has changed.\n\nYou can have multiple events per device and use multiple devices.\n\nFlash the new code to your device(s).\n\nYou can read the official Particle docs on `Particle.publish` [here](https://docs.particle.io/reference/firmware/photon/#particle-publish-).\n\n### Install the Module\nRun the following commands in your shell (or if using Windows, the equivalent):\n1. `cd ~/MagicMirror/modules` (replace the path with wherever your MagicMirror modules folder is)\n2. `git clone https://github.com/yummypasta/MMM-ParticleStatus.git`\n\n### Change Config\nAdd the following code to your config file. Edit the `config` value as specified in the next section.\n```\n{\n    module: \"MMM-ParticleStatus\",\n    position: \u003cPosition of module\u003e,\n    header: \"My Particle Devices\", //Change this as you see fit, or leave blank for a minimal look\n    config: {\n        //Edit this config as described in the next section.\n    }\n}\n```\n\n## Config Options\nThe `config` value in your config file needs to be changed.\n\nKey | Value(s) | Default Value\n--- | --- | --- \nparticleUsername | Your Particle account username. | _required_\nparticlePassword | Your particle account password. | _required_\nevents | An array of events (format is described below). | Empty array, resulting in nothing being shown\n\n### Event Objects\nThe `events` field in the config takes a special JS Object, as described below.\n\nKey | Value(s) | Default Value\n--- | --- | --- \ndeviceId | The id of the device that publishes the event. | _required_\nname | The name of the event to listen for (the **first** parameter of the `Particle.publish` function) | _required_\nicon | A [Font Awesome](https://fontawesome.com/icons?d=gallery) icon to represent the event. _Only icons in the \"solid\" category are available. Brands are not available._ | _required_\nstates | A JS Object, mapping possible states of the event to how the icon should be displayed (`off`, `on`, or `blink`). Example: `{ \"Opening\": \"blink\", \"Closing\": \"blink\", \"Open\": \"on\", \"Closed\": \"off\" }`. If the state is not defined in this object, the state of the icon will not change. | _required_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericyoondotcom%2Fmmm-particlestatus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fericyoondotcom%2Fmmm-particlestatus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericyoondotcom%2Fmmm-particlestatus/lists"}