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

4
README.md
View File

@ -12,12 +12,12 @@
## Config
| 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` |
| `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` |
| `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` |
| `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). | |