matrix_lights:

Config file section

Valid in machine config files YES
Valid in mode config files NO

The matrix_lights: section of your config is where you...

Todo

Add description.

Required settings

The following sections are required in the matrix_lights: section of your config:

number:

Single value, type: string.

This is the number of the light which specifies which output the light is physically connected to. The exact format used here will depend on which control system you’re using and how the light is connected.

See the How to configure “number:” settings guide for details.

Optional settings

The following sections are optional in the matrix_lights: section of your config. (If you don’t include them, the default will be used).

debug:

Single value, type: boolean (Yes/No or True/False). Default: False

Todo

Add description.

fade_ms:

Single value, type: time string (ms) (Instructions for entering time strings) . Default: None

Todo

Add description.

label:

Single value, type: string. Default: %

Todo

Add description.

off_events:

One or more sub-entries, either as a list of events, or key/value pairs of event names and delay times. (See the Device Control Events documentation for details on how to enter settings here.

Default: None

Events in this list, when posted, turn this light off.

on_events:

One or more sub-entries, either as a list of events, or key/value pairs of event names and delay times. (See the Device Control Events documentation for details on how to enter settings here.

Default: None

Events in this list, when posted, turn this light on.

platform:

Single value, type: string. Default: None

Name of the platform this light is connected to. The default value of None means the default hardware platform will be used. You only need to change this if you have multiple different hardware platforms in use and this coil is not connected to the default platform.

See the Mixing-and-Matching hardware platforms guide for details.

tags:

List of one (or more) values, each is a type: string. Default: None

Todo

Add description.

x:

Single value, type: integer. Default: None

Todo

Add description.

y:

Single value, type: integer. Default: None

Todo

Add description.

z:

Single value, type: integer. Default: None

Todo

Add description.