magic-mirror/MMM-IntelliCenter
1
0
Fork 0
mirror of https://github.com/parnic/MMM-IntelliCenter.git synced 2025-06-16 05:10:14 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update readme
All checks were successful
Node.js CI / build (18.x) (push) Successful in 6s
Details
Node.js CI / build (20.x) (push) Successful in 5s
Details
Node.js CI / build (22.x) (push) Successful in 5s
Details

Browse Source
This commit is contained in:
Chris Pickett
2025-01-09 10:40:09 -06:00
parent 024dae54c5
commit 81f8cd63e7
1 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -11,27 +11,27 @@
## Config ## Config
| Option | Type | Description | Default | | Option | Type | Description | Default |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | | -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `coldTemp` | Integer | Show the temperature colored blue if it's at or below this level for pool/spa (requires option `colored`). This is in whatever scale your system is set to (Fahrenheit/Celsius). | `84` | | `coldTemp` | Integer | Show the temperature colored blue if it's at or below this level for pool/spa (requires option `colored`). This is in whatever scale your system is set to (Fahrenheit/Celsius). | `84` |
| `colored` | Boolean | Whether you'd like colored output or not. | `true` | | `colored` | Boolean | Whether you'd like colored output or not. | `true` |
| `columns` | Integer | How many columns to use to display the data before starting a new row. | `3` | | `columns` | Integer | How many columns to use to display the data before starting a new row. | `3` |
| `contentClass` | String | The CSS class used to display content values (beneath the header). | `"light"` | | `contentClass` | String | The CSS class used to display content values (beneath the header). | `"light"` |
| `controls` | Array | List of controls to show buttons for. Must also set `showControls` to `true`.<br><br>Each entry in this list is an object with a `type` string property and a `name` string to display.<br><br>Valid `type`s:<br>`"circuit"` - toggle a circuit on or off. Must also have an `id` object name property defining the circuit ID to set (see [node-intellicenter](https://github.com/parnic/node-intellicenter) documentation for object names). `name` is an optional string; if not specified, the name of the equipment in the IntelliCenter system will be used.<br>`"heatmode"` - enable or disable the heater for the pool or spa. Must also have a `body` name property that defines which body to toggle the heater for (`"pool"` is the pool, `"spa"` is the spa).<br>`"heatpoint"` - set the heat temperature for the pool or spa. Must also have a `body` name property that defines which body to set the heat point for (`"pool"` is the pool, `"spa"` is the spa). | `[]` | | `controls` | Array | List of controls to show buttons for. Must also set `showControls` to `true`.<br><br>Each entry in this list is an object with a `type` string property and a `name` string to display.<br><br>Valid `type`s:<br>`"circuit"` - toggle a circuit on or off. Must also have an `id` object name property defining the circuit ID to set (see [node-intellicenter](https://github.com/parnic/node-intellicenter) documentation for object names). `name` is an optional string; if not specified, the name of the equipment in the IntelliCenter system will be used.<br>`"heatmode"` - enable or disable the heater for the pool or spa. Must also have a `body` name property that defines which body to toggle the heater for (`"pool"` is the pool, `"spa"` is the spa) and a `"name"` property that contains the label to show for the button.<br>`"heatpoint"` - set the heat temperature for the pool or spa. Must also have a `body` name property that defines which body to set the heat point for (`"pool"` is the pool, `"spa"` is the spa) and a `"name"` property that contains the label to show for the button. | `[]` |
| `hotTemp` | Integer | Show the temperature colored red if it's at or above this level for pool/spa (requires option `colored`). This is in whatever scale your system is set to (Fahrenheit/Celsius). | `90` | | `hotTemp` | Integer | Show the temperature colored red if it's at or above this level for pool/spa (requires option `colored`). This is in whatever scale your system is set to (Fahrenheit/Celsius). | `90` |
| `multicastInterface` | String | The IPv4 address of a network interface to use for unit discovery. Chooses a system default if not specified. | | | `multicastInterface` | String | The IPv4 address of a network interface to use for unit discovery. Chooses a system default if not specified. | |
| `serverAddress` | String | The IPv4 address of a IntelliCenter unit to connect to. If not set, the system will search for a unit to connect to. If set, `serverPort` must also be set (the default is usually fine). | | | `serverAddress` | String | The IPv4 address of a IntelliCenter unit to connect to. If not set, the system will search for a unit to connect to. If set, `serverPort` must also be set (the default is usually fine). | |
| `serverPort` | Integer | The port of a IntelliCenter unit to connect to (usually 6680). If not set, the system will search for a unit to connect to. If set, `serverAddress` must also be set. | `6680` | | `serverPort` | Integer | The port of a IntelliCenter unit to connect to (usually 6680). If not set, the system will search for a unit to connect to. If set, `serverAddress` must also be set. | `6680` |
| `showControls` | Boolean | Whether you'd like to show buttons for controlling pool equipment. Must also setup the `controls` array. | `false` | | `showControls` | Boolean | Whether you'd like to show buttons for controlling pool equipment. Must also setup the `controls` array. | `false` |
| `showFreezeMode` | Boolean | Whether you'd like to show a banner when the pool is in freeze mode or not. | `true` | | `showFreezeMode` | Boolean | Whether you'd like to show a banner when the pool is in freeze mode or not. | `true` |
| `showOrp` | Boolean | Whether you'd like to show ORP level or not. | `true` | | `showOrp` | Boolean | Whether you'd like to show ORP level or not. | `true` |
| `showPH` | Boolean | Whether you'd like to show pH level or not. | `true` | | `showPH` | Boolean | Whether you'd like to show pH level or not. | `true` |
| `showPHTankLevel` | Boolean | Whether you'd like to show how much pH balancer is in the tank or not. Only functions if `showPH` is also on. | `true` | | `showPHTankLevel` | Boolean | Whether you'd like to show how much pH balancer is in the tank or not. Only functions if `showPH` is also on. | `true` |
| `pHTankLevelMax` | Boolean | If `showPHTankLevel` is enabled, this is the maximum value that the system returns for a full tank. My system has this always set to 7, but maybe it differs based on what type of pH balancer you're using. | `7` | | `pHTankLevelMax` | Boolean | If `showPHTankLevel` is enabled, this is the maximum value that the system returns for a full tank. My system has this always set to 7, but maybe it differs based on what type of pH balancer you're using. | `7` |
| `showPoolTemp` | Boolean | Whether you'd like to show pool temperature or not. | `true` | | `showPoolTemp` | Boolean | Whether you'd like to show pool temperature or not. | `true` |
| `showSaltLevel` | Boolean | Whether you'd like to show salt level (in PPM) or not. | `true` | | `showSaltLevel` | Boolean | Whether you'd like to show salt level (in PPM) or not. | `true` |
| `showSaturation` | Boolean | Whether you'd like to show saturation/balance or not. | `true` | | `showSaturation` | Boolean | Whether you'd like to show saturation/balance or not. | `true` |
| `showSpaTemp` | Boolean | Whether you'd like to show spa temperature or not. | `true` | | `showSpaTemp` | Boolean | Whether you'd like to show spa temperature or not. | `true` |
Here is an example of an entry in config.js Here is an example of an entry in config.js