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 "Light 01", 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!

We prepared for you two types of the configuration file, what you should choose depends on what you will use as your outputs. Usually 32x10A controller its used for lights, so we prepared for you configuration with 32 light outputs! But if you want to use it as controling device for some sort of switches etc? No problem! We got also version with 32 switches! But what if you want to use 20 outputs as lights and 12 as switches? We dont have configuration for you... But we will explain how you can prepare one for yourself!

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

boneio-32x10_lights_v0_7.yaml

We are looking for part with header light:

light:
  - platform: binary
    name: 'Light 01'
    output: out_01
    id: light_01
  - platform: binary
    name: 'Light 02'
    output: out_02
    id: light_02
  - platform: binary
    name: 'Light 03'
    output: out_03
    id: light_03
  - platform: binary
    name: 'Light 04'
    output: out_04
    id: light_04
  - platform: binary
    name: 'Light 05'
    output: out_05
    id: light_05
  - platform: binary
    name: 'Light 06'
    output: out_06
    id: light_06

- platform: binary - Definition of output type - it could take two states.
name: 'Light 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 Bedroom or OUT_01_Bedroom.
output: out_01 – this is the relay number that your name refers to.
id: light_01 – this part its the definition

boneio-32x10_switches_0_7.yaml

We are looking for part with header switch:

switch:
  - platform: output
    name: 'Switch 01'
    output: out_01
    id: switch_01
  - platform: output
    name: 'Switch 02'
    output: out_02
    id: switch_02
  - platform: output
    name: 'Switch 03'
    output: out_03
    id: switch_03
  - platform: output
    name: 'Switch 04'
    output: out_04
    id: switch_04
  - platform: output
    name: 'Switch 05'
    output: out_05
    id: switch_05
  - platform: output
    name: 'Switch 06'
    output: out_06
    id: switch_06

- platform: output - Definition of output type - it could take two states.
name: 'Switch 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 Switch_01_Circulation_pump.
output: out_01 – this is the relay number that your name refers to.
id: switch_01 – this part its the definition of the

Id like to get 10 switches and 22 lights!

You need to adjust your configuration file a little bit. Its really simple, and really usefull. Lets make a assumption that we to change from our boneio-32x10_lights_v0_7.yaml 10 lights to switche's.

As you can learn from this tutorial, the header its what describes the oputput, we are useing switch and light here. If you look at the standard lights configuration, you will notice that its start with header lights:, then there are definitions of our relays. For our tutorial we gonna change last 10 lights to relays. Below the configuration:

light:
  - platform: binary
    name: 'Light 01'
    output: out_01
    id: light_01
  - platform: binary
    name: 'Light 02'
    output: out_02
    id: light_02
...
...
...
  - platform: binary
    name: 'Light 21'
    output: out_21
    id: light_21
  - platform: binary
    name: 'Light 22'
    output: out_22
    id: light_22

switch:

  - platform: binary
    name: 'Switch 01'
    output: out_23
    id: switch_01
  - platform: binary
    name: 'Switch 02'
    output: out_24
    id: switch_02
...
...
...
  - platform: binary
    name: 'Switch 09'
    output: out_31
    id: switch_0
  - platform: binary
    name: 'Switch 10`
    output: out_32
    id: switch_32

So what have we done? FIrst part its the same as in the default lights configuration, but before out_23 we wrote switch: header, and we adjusted names and id, so they match everything. In the end we got lights from relay 1 to 22, and switches from relays 23 to 32!

24x16A

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

boneio-24x16_switches_v0_7.yaml

switch:
  - platform: output
    name: 'Switch 01'
    output: out_01
    id: switch_01
  - platform: output
    name: 'Switch 02'
    output: out_02
    id: switch_02
  - platform: output
    name: 'Switch 03'
    output: out_03
    id: switch_03
  - platform: output
    name: 'Switch 04'
    output: out_04
    id: switch_04
  - platform: output
    name: 'Switch 05'
    output: out_05
    id: switch_05
  - platform: output
    name: 'Switch 06'
    output: out_06
    id: switch_06

- platform: output - Definition of output type - it could take two states.
name: 'Switch 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 Switch_01_Circulation_pump.
output: out_01 – this is the relay number that your name refers to.
id: switch_01 – this part its the definition of the

Cover

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

boneio-cover_v0_7.yaml

cover:
  - platform: time_based
    name: 'Cover 01'
    id: cover_01
    open_action:
      - switch.turn_on: cover_open_01_out01
    open_duration: 10s
    close_action:
      - switch.turn_on: cover_close_01_out02
    close_duration: 10s
    stop_action:
      - switch.turn_off: cover_open_01_out01
      - switch.turn_off: cover_close_01_out02

- platform: time_based –
name: 'Cover 01' - 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_action: - switch.turn_on: cover_open_01_out01 and close_action: - switch.turn_on: cover_close_01_out02 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:

cover:
  - platform: time_based
    name: 'Cover01_Bedroom'
    id: cover_01
    open_action:
      - switch.turn_on: cover_open_01_out01
    open_duration: 10s
    close_action:
      - switch.turn_on: cover_close_01_out02
    close_duration: 10s
    stop_action:
      - switch.turn_off: cover_open_01_out01
      - switch.turn_off: cover_close_01_out02

Covermix

For the Covermix controller version, we also prepared same as for 32x10A version - configuration witch 16 lights, or switches.

We begin with covermix with lights version.

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

boneio-cover_mix_lights_v0_7.yaml

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

cover:
  - platform: time_based
    name: 'Cover 01'
    id: cover_01
    open_action:
      - switch.turn_on: cover_open_01_out01
    open_duration: 10s
    close_action:
      - switch.turn_on: cover_close_01_out02
    close_duration: 10s
    stop_action:
      - switch.turn_off: cover_open_01_out01
      - switch.turn_off: cover_close_01_out02

light:
  - platform: binary
    name: 'Light 17'
    output: out_17
    id: light_17

Part responsible for cover:

- platform: time_based –
name: 'Cover 01' - 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_action: - switch.turn_on: cover_open_01_out01 and close_action: - switch.turn_on: cover_close_01_out02 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.

Part responsible for lights:

- platform: binary - Definition of output type - it could take two states.
name: 'Light 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 Light_17_Bedroom.
output: out_17 – this is the relay number that your name refers to.
id: light_17 – this part its the definition of the

Our example looks like this:

cover:
  - platform: time_based
    name: 'Cover01_Bedroom'
    id: cover_01
    open_action:
      - switch.turn_on: cover_open_01_out01
    open_duration: 10s
    close_action:
      - switch.turn_on: cover_close_01_out02
    close_duration: 10s
    stop_action:
      - switch.turn_off: cover_open_01_out01
      - switch.turn_off: cover_close_01_out02
light:
  - platform: binary
    name: 'Light_17_Bedroom'
    output: out_17
    id: light_17

here is the covermix with switches version.

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

boneio-cover_mix_lights_v0_7.yaml

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

cover:
  - platform: time_based
    name: 'Cover 01'
    id: cover_01
    open_action:
      - switch.turn_on: cover_open_01_out01
    open_duration: 10s
    close_action:
      - switch.turn_on: cover_close_01_out02
    close_duration: 10s
    stop_action:
      - switch.turn_off: cover_open_01_out01
      - switch.turn_off: cover_close_01_out02

switch:
  - platform: binary
    name: 'switch 17'
    output: out_17
    id: light_17

Part responsible for cover:

- platform: time_based –
name: 'Cover 01' - 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_action: - switch.turn_on: cover_open_01_out01 and close_action: - switch.turn_on: cover_close_01_out02 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.

Part responsible for lights:

- platform: binary - Definition of output type - it could take two states.
name: 'switch 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 Circulation_Pump or Switch_17_Circulation_pump.
output: out_17 – this is the relay number that your name refers to.
id: switch_17 – this part its the definition of the

Our example looks like this:

cover:
  - platform: time_based
    name: 'Cover01_Bedroom'
    id: cover_01
    open_action:
      - switch.turn_on: cover_open_01_out01
    open_duration: 10s
    close_action:
      - switch.turn_on: cover_close_01_out02
    close_duration: 10s
    stop_action:
      - switch.turn_off: cover_open_01_out01
      - switch.turn_off: cover_close_01_out02
switch:
  - platform: binary
    name: 'Switch_17_Circulation_pump'
    output: out_17
    id: light_17

Naming the outputs

What are outputs?

Why should you name them?

32x10A

Id like to get 10 switches and 22 lights!

24x16A

Cover

Covermix

On this page