Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 1.66 KB

README.md

File metadata and controls

41 lines (34 loc) · 1.66 KB
Raw

MMM-Solar

A Solar Module for MagicMirror2 designed to integrate with an Enphase Solar System

Dependencies

Installation

  1. Clone repo into MagicMirror/modules directory
  2. Get an Enlighten API key and authorize your application (instructions below).
  3. Create an entry in 'config/config.js' with your API Key, UserId, SystemID, and any config options.

Example:

 {
    module: 'MMM-Solar',
	position: 'bottom_left',
	config: {
		apiKey: "################################", //Requires your own API Key
		userId: "4d7a45774e6a41320a", //Enphase example user
		systemId: "67", //Enphase example system
	}
 },

Note: Only enter your API Key in the config.js file. Your API Key is yours alone, do not post or use it elsewhere.

Sample

alt text

Optional Config

Option Description
basicHeader Set to true to substitute the 'Solar PV' text and graphic for the default MagicMirror header

API Key

Use of this module requires

  1. An API Key, which you can obtain at The Enphase Developer Portal
  2. The User Id of the User whose system you wish to integrate. This can be found in your Enlighten Manager Portal.
  3. The System ID of the solar system you wish to monitor, which can also be found in the Enlighten Manager.

Attribution

This module is powered by Enphase and the Enlighten API