boneIO Documentation | Naming the outputs

What are outputs?

Outputs are the executive parts of our controller. Depending on its type, you can control:

32 relays 10A,
24 relays 16A,
16 covers with the Cover module,
with the Covermix module – 8 covers and 16 relays 10A.

Why should you name them?

Naming your outputs will make working with the controller much easier. It's much easier to remember "Bedroom light" than "OUT_17", right?

In our examples, we focus on a part of the configuration, which you can then adjust to your entire configuration.

Let's get started!

32x10A

Below is a part of the default configuration in the file:

~/boneio/output32x10A.yaml

- id: OUT_01
  boneio_output: OUT_01
  output_type: light

- id: OUT_02
  boneio_output: OUT_02
  output_type: light

- id: OUT_03
  boneio_output: OUT_03
  output_type: light

Parameter	Description
`id`	This part of the configuration is the output name, and you can change it freely. There are many naming approaches. For example, you can change the name to `Bedroom` or `OUT_01_Bedroom`.
`boneio_output`	This is the relay number that your name refers to.
`output_type`	This is the output type; you can choose from `switch` (classic normal switch), `light`, or `valve` (water valve). This option defines how the output will be visible in the WebUI and in Home Assistant.

So our example will look like that:

- id: OUT_01_Bedroom
  boneio_output: OUT_01
  output_type: light

24x16A

Below is a part of the default configuration in the file:

~/boneio/output24x16A.yaml

- id: OUT_01
  boneio_output: OUT_01
  output_type: switch

- id: OUT_02
  boneio_output: OUT_02
  output_type: switch

- id: OUT_03
  boneio_output: OUT_03
  output_type: switch

Parameter	Description
`- id: OUT_01`	This part of the configuration is the output name, and you can change it freely. There are many naming approaches. For example, you can change the name to `Circulation_Pump` or `OUT_01_Circulation_Pump`.
`boneio_output: OUT_01`	This is the relay number that your name refers to.
`output_type: switch`	This is the output type, you can choose from `switch` - classic normal switch, `light`, or `valve` (water valve). This option defines how the output will be visible in the WebUI and in Home Assistant.

So our example will look like that:

- id: OUT_01_Circulation_pump
  boneio_output: OUT_01
  output_type: switch

Cover

Below is a part of the default configuration in the file:

~/boneio/cover.yaml

- id: Cover01
  open_relay: cover_01_up
  close_relay: cover_01_down
  time: 30s
  show_in_ha: yes
  restore_state: yes

Parameter	Description
`- id: Cover01`	This part of the configuration is the cover name, and you can change it freely. There are many naming approaches. For example, you can change the name to `Bedroom` or `Cover01_Bedroom`.
`open_relay: cover_01_up` and `close_relay: cover_01_down`	This are the relays responsible for your cover.

The rest of the section is for advanced cover configuration – if you want to learn more, see the documentation.

Our example looks like this:

- id: Cover01_Bedroom
  open_relay: cover_01_up
  close_relay: cover_01_down
  time: 30s
  show_in_ha: yes
  restore_state: yes

Covermix

For the Covermix controller version, there are some differences compared to other versions.

To change the name of a specific cover, you must edit the file:

~/boneio/cover.yaml

If you want to change the name of a classic output, you must edit the file:

~/boneio/outputCoverMix.yaml

Below is a part of the default configuration in the file:

~/boneio/cover.yaml

- id: Cover08
  open_relay: cover_08_up
  close_relay: cover_08_down
  time: 30s
  show_in_ha: yes
  restore_state: yes

Parameter	Description
`- id: Cover08`	This part of the configuration is the cover name, and you can change it freely. There are many naming approaches. For example, you can change the name to `Bathroom` or `Cover08_Bathroom`.
`open_relay: cover_08_up` and `close_relay: cover_08_down`	This are the relays responsible for your cover.

The rest of the section is for advanced cover configuration – if you want to learn more, see the documentation.

Our example looks like this:

- id: Cover08_Bathroom
  open_relay: cover_08_up
  close_relay: cover_08_down
  time: 30s
  show_in_ha: yes
  restore_state: yes

Below is a part of the default configuration in the file:

~/boneio/outputCoverMix.yaml

- id: cover_08_up
  boneio_output: cover_08_up
- id: cover_08_down
  boneio_output: cover_08_down
- id: OUT_17
  boneio_output: OUT_17
  output_type: light

Parameter	Description
`- id: OUT_17`	This part of the configuration is the output name, and you can change it freely. There are many naming approaches. For example, you can change the name to `Bedroom` or `OUT_17_Bathroom`.
`boneio_output: OUT_17`	This is the relay number that your name refers to.
`output_type: light`	This is the output type; you can choose from `switch`, `light`, or `valve` (water valve). This option defines how the output will be visible in the WebUI and in Home Assistant.

Our example looks like this:

- id: OUT_17_Bathroom
  boneio_output: OUT_17
  output_type: light

Naming the outputs

What are outputs?

Why should you name them?

32x10A

24x16A

Cover

Covermix

On this page