Skip to content

Commit 80dc56b

Browse files
committed
Readme updated with new example images
1 parent b484826 commit 80dc56b

10 files changed

+26
-2
lines changed

README.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
An unofficial <a href="https://www.seneye.com/">Seneye</a> aquarium monitor module for the <a href="https://github.com/MichMich/MagicMirror">MagicMirror</a> project
55

66
## Preview
7-
![](Screenshot1.png) ![](Screenshot2.png)
7+
![](readme_images/Screenshot1.png) ![](readme_images/Screenshot2.png)
88

99
## Installation
1010
Clone this respo into your `~/MagicMirror/modules` folder
@@ -14,6 +14,21 @@ git clone https://github.com/Si-Hill/MMM-Seneye
1414

1515
## Using the module
1616
Add `MMM-Seneye` module to the `modules` array in the `config/config.js` file:
17+
18+
###### Minimum config
19+
````javascript
20+
{
21+
"module": "MMM-Seneye",
22+
"position": "top_right",
23+
"config": {
24+
"deviceID": "12345",
25+
"email": "example@email.com",
26+
"password": "password",
27+
}
28+
}
29+
````
30+
31+
###### All options
1732
````javascript
1833
{
1934
"module": "MMM-Seneye",
@@ -22,6 +37,9 @@ Add `MMM-Seneye` module to the `modules` array in the `config/config.js` file:
2237
"deviceID": "12345",
2338
"email": "example@email.com",
2439
"password": "password",
40+
"temperatureSuffix": "C",
41+
"logo": "blue",
42+
"color": "#00aeef",
2543
"readings": {
2644
"temperature": true,
2745
"ph": true,
@@ -44,7 +62,13 @@ MMM-Seneye uses the official <a href='https://api.seneye.com/'>Seneye API</a>
4462
|`deviceID`| **Required**<br />You will need to find out your Seneye Device ID from the Seneye servers.<br /><br />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=***`<br /><br />**Type:** `String`
4563
|`email` | **Required**<br />Your email address registered with Seneye. The same one used to login to <a href='http://seneye.me/'>seneye.me</a><br /><br />**Type:** `String`
4664
|`password`| **Required**<br />The password associated with the email address above.<br /><br />**Type:** `String`
47-
|`readings`| **Required**<br />An array of readings options, at least one option is required:<br /><br />*Optional*<br />Temperature<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />ph<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />nh3<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />nh4<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />o2<br />**Type:** `Boolean`<br />Default *false*<br /><br />*Optional*<br />lux<br />**Type:** `Boolean`<br />Default *false*<br /><br />*Optional*<br />par<br />**Type:** `Boolean`<br />Default *false*<br /><br />*Optional*<br />kelvin<br />**Type:** `Boolean`<br />Default *false*
65+
66+
|`temperatureSuffix`| **Optional**<br />A text string to display 'C' or 'F' after the temperature reading.<br /><br />**Type:** `String`<br />Default *C*
67+
|`logo`| **Optional**<br />4 options available, `blue` (default), `white`, `grey`, or your choice of text<br /><br />![](readme_images/LogoBlue.png) ![](readme_images/Logowhite.png) ![](readme_images/LogoGrey.png) ![](readme_images/LogoText.png)<br /><br />**Type:** `String`<br />Default *blue*
68+
|`color`| **Optional**<br />Your choice of hex colour code, including the #<br />![](readme_images/blue.png) ![](readme_images/green.png) ![](readme_images/orange.png)<br /><br />**Type:** `String`<br />Default *#00aeef*
69+
70+
71+
|`readings`| **Optional**<br />An array of readings options, at least one option is required:<br /><br />*Optional*<br />Temperature<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />ph<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />nh3<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />nh4<br />**Type:** `Boolean`<br />Default *true*<br /><br />*Optional*<br />o2<br />**Type:** `Boolean`<br />Default *false*<br /><br />*Optional*<br />lux<br />**Type:** `Boolean`<br />Default *false*<br /><br />*Optional*<br />par<br />**Type:** `Boolean`<br />Default *false*<br /><br />*Optional*<br />kelvin<br />**Type:** `Boolean`<br />Default *false*
4872

4973
## To Do
5074
* Add `node_helper.js`

readme_images/LogoBlue.png

1.68 KB
Loading

readme_images/LogoGrey.png

2.44 KB
Loading

readme_images/LogoText.png

1.49 KB
Loading

readme_images/LogoWhite.png

1.61 KB
Loading
File renamed without changes.
File renamed without changes.

readme_images/blue.png

9.62 KB
Loading

readme_images/green.png

9.72 KB
Loading

readme_images/orange.png

10.6 KB
Loading

0 commit comments

Comments
 (0)