https://github.com/ericyoondotcom/mmm-particlestatus
MagicMirror module that shows you the status of your particle.io devices.
https://github.com/ericyoondotcom/mmm-particlestatus
magic-mirror-modules magicmirror
Last synced: 8 months ago
JSON representation
MagicMirror module that shows you the status of your particle.io devices.
- Host: GitHub
- URL: https://github.com/ericyoondotcom/mmm-particlestatus
- Owner: ericyoondotcom
- License: mit
- Created: 2018-07-16T00:25:18.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-05T19:17:56.000Z (almost 6 years ago)
- Last Synced: 2025-05-28T02:04:46.362Z (about 1 year ago)
- Topics: magic-mirror-modules, magicmirror
- Language: JavaScript
- Size: 9.77 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MMM-ParticleStatus
[MagicMirror](https://github.com/MichMich/MagicMirror) module that shows you the status of your [Particle](https://particle.io) devices.
_**Note:** This project is not affiliated or endorsed by Particle Industries, Inc._
Made by [Eric Yoon](http://yoonicode.com)
Looking for a different UI? check [this fork](https://github.com/NickEngmann/MMM-ParticleStatus) by NickEngmann.
## Installation and Setup
### Set up Particle Side
This 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.
Each 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:
```
if(){
Particle.publish("Light", "On");
}
if(){
Particle.publish("Light", "Off");
}
```
It is important to not publish state every `loop()` tick, just when the state has changed.
You can have multiple events per device and use multiple devices.
Flash the new code to your device(s).
You can read the official Particle docs on `Particle.publish` [here](https://docs.particle.io/reference/firmware/photon/#particle-publish-).
### Install the Module
Run the following commands in your shell (or if using Windows, the equivalent):
1. `cd ~/MagicMirror/modules` (replace the path with wherever your MagicMirror modules folder is)
2. `git clone https://github.com/yummypasta/MMM-ParticleStatus.git`
### Change Config
Add the following code to your config file. Edit the `config` value as specified in the next section.
```
{
module: "MMM-ParticleStatus",
position: ,
header: "My Particle Devices", //Change this as you see fit, or leave blank for a minimal look
config: {
//Edit this config as described in the next section.
}
}
```
## Config Options
The `config` value in your config file needs to be changed.
Key | Value(s) | Default Value
--- | --- | ---
particleUsername | Your Particle account username. | _required_
particlePassword | Your particle account password. | _required_
events | An array of events (format is described below). | Empty array, resulting in nothing being shown
### Event Objects
The `events` field in the config takes a special JS Object, as described below.
Key | Value(s) | Default Value
--- | --- | ---
deviceId | The id of the device that publishes the event. | _required_
name | The name of the event to listen for (the **first** parameter of the `Particle.publish` function) | _required_
icon | 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_
states | 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_