Update BeagleBone configuration variables (#6608)

* Update BeagleBone config variables

* Fixed wrong type

* change type for pin_name
This commit is contained in:
Emeric 2018-10-08 20:28:00 +02:00 committed by Franck Nijhof
parent ee99916d09
commit 834ca3a007
2 changed files with 58 additions and 18 deletions

View File

@ -30,14 +30,36 @@ binary_sensor:
name: Window
```
Configuration variables:
- **pins** array (*Required*): Array of used pins.
- **pin_name** (*Required*): Pin numbers and corresponding names.
- **name** (*Required*): Friendly name to use for the frontend.
- **bouncetime** (*Optional*): Debounce time for reading input pin defined in milliseconds [ms]. Defaults to `50 ms`.
- **invert_logic** (*Optional*): If `true`, inverts the input logic to ACTIVE LOW. Default is `false` (ACTIVE HIGH).
- **pull_mode** (*Optional*): Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. Defaults to `UP`.
{% configuration %}
pins:
description: List of used pins.
required: true
type: map
keys:
pin_name:
description: Port numbers and corresponding names.
required: true
type: map
keys:
name:
description: Friendly name to use for the frontend.
required: true
type: string
bouncetime:
description: Debounce time for reading input pin defined in milliseconds [ms].
required: false
default: 50
type: integer
invert_logic:
description: If `true`, inverts the input logic to ACTIVE LOW
required: false
default: false
type: boolean
pull_mode:
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
required: false
default: UP
type: string
{% endconfiguration %}
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.

View File

@ -17,7 +17,7 @@ The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBo
## {% linkable_title Configuration %}
To use yourBeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -30,13 +30,31 @@ switch:
name: LED Green
```
Configuration variables:
- **pins** array (*Required*): Array of used ports.
- **pin_name** (*Required*): Port numbers and corresponding names.
- **name** (*Optional*): Friendly name to use for the frontend.
- **initial** (*Optional*): Initial state of the pin. Defaults to `False`.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is `false` (ACTIVE HIGH).
{% configuration %}
pins:
description: List of used pins.
required: true
type: map
keys:
pin_name:
description: Port numbers and corresponding names.
required: true
type: map
keys:
name:
description: Friendly name to use for the frontend.
required: false
type: string
initial:
description: Initial state of the pin.
required: false
default: false
type: boolean
invert_logic:
description: If `true`, inverts the input logic to ACTIVE LOW
required: false
default: false
type: boolean
{% endconfiguration %}
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.