Skip to content

Si-Hill/MMM-Seneye

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub GitHub package version GitHub code size in bytes GitHub repo size in bytes

MMM-Seneye

An unofficial Seneye aquarium monitor module for the MagicMirror project

Preview

Installation

Clone this respo into your ~/MagicMirror/modules folder

git clone https://github.com/Si-Hill/MMM-Seneye

Using the module

Add MMM-Seneye module to the modules array in the config/config.js file:

Minimum config
{
	"module": "MMM-Seneye",
	"position": "top_right",
	"config": {
		"deviceID": "12345",
		"email": "example@email.com",
		"password": "password",
	}
}
All options
{
	"module": "MMM-Seneye",
	"position": "top_right",
	"config": {
		"deviceID": "12345",
		"email": "example@email.com",
		"password": "password",
		"temperatureSuffix": "C",
		"logo": "blue",
		"color": "#00aeef",
		"readings": {
			"temperature": true,
			"ph": true,
			"nh3": true,
			"nh4": true,
			"o2": false,
			"lux": false,
			"par": false,
			"kelvin": false
		}
	}
}

Configuration Options

MMM-Seneye uses the official Seneye API

Option Description
deviceID Required
You will need to find out your Seneye Device ID from the Seneye servers.

The quickest way is to visit this url in any browser replacing the username and password with your own. You will get a response that includes your Device ID https://api.seneye.com/v1/devices?user=***&pwd=***

Type: String
email Required
Your email address registered with Seneye. The same one used to login to seneye.me

Type: String
password Required
The password associated with the email address above.

Type: String
temperatureSuffix Optional
A text string to display 'C' or 'F' after the temperature reading.

Type: String
Default C
logo Optional
4 options available, blue, white, grey, or your choice of text



Type: String
Default blue
color Optional
Your choice of hex colour code, including the #


Type: String
Default #00aeef
readings Optional
An array of readings to display

Optional
Temperature
Type: Boolean
Default true

Optional
ph
Type: Boolean
Default true

Optional
nh3
Type: Boolean
Default true

Optional
nh4
Type: Boolean
Default true

Optional
o2
Type: Boolean
Default false

Optional
lux
Type: Boolean
Default false

Optional
par
Type: Boolean
Default false

Optional
kelvin
Type: Boolean
Default false

To Do

  • Add node_helper.js
  • Add customisable temperature suffix
  • Add some alert functionality
  • Add logo/title customisation
  • Add custom colour for icons