Add configuration
This commit is contained in:
43
README.md
43
README.md
@ -15,6 +15,7 @@ developers will have use for, please open a PR to add it :)
|
||||
***
|
||||
README content if this was a published component:
|
||||
***
|
||||
|
||||
# blueprint
|
||||
|
||||
[![BuyMeCoffee][buymecoffeebedge]][buymecoffee]
|
||||
@ -28,6 +29,7 @@ Platform | Description
|
||||
-- | --
|
||||
`binary_sensor` | Show something `True` or `False`
|
||||
`sensor` | Show info from blueprint API.
|
||||
`switch`| Switchable device.
|
||||
|
||||
![example][exampleimg]
|
||||
|
||||
@ -47,14 +49,55 @@ custom_components/blueprint/__init__.py
|
||||
custom_components/blueprint/binary_sensor.py
|
||||
custom_components/blueprint/const.py
|
||||
custom_components/blueprint/sensor.py
|
||||
custom_components/blueprint/sensor.py
|
||||
```
|
||||
|
||||
## Example configuration.yaml
|
||||
|
||||
```yaml
|
||||
blueprint:
|
||||
binary_sensor:
|
||||
- enabled: true
|
||||
name: My custom name
|
||||
sensor:
|
||||
- enabled: true
|
||||
name: My custom name
|
||||
switch:
|
||||
- enabled: true
|
||||
name: My custom name
|
||||
```
|
||||
|
||||
## Configuration options
|
||||
|
||||
Key | Type | Required | Description
|
||||
-- | -- | -- | --
|
||||
`binary_sensor` | `list` | `False` | Configuration for the `binary_sensor` platform.
|
||||
`sensor` | `list` | `False` | Configuration for the `sensor` platform.
|
||||
`switch` | `list` | `False` | Configuration for the `switch` platform.
|
||||
|
||||
|
||||
### Configuration options for `binary_sensor` list
|
||||
|
||||
Key | Type | Required | Default | Description
|
||||
-- | -- | -- | -- | --
|
||||
`enabled` | `boolean` | `False` | `False` | Boolean to enable/disable the platform.
|
||||
`name` | `string` | `False` | `blueprint` | Custom name for the entity.
|
||||
|
||||
### Configuration options for `sensor` list
|
||||
|
||||
Key | Type | Required | Default | Description
|
||||
-- | -- | -- | -- | --
|
||||
`enabled` | `boolean` | `False` | `False` | Boolean to enable/disable the platform.
|
||||
`name` | `string` | `False` | `blueprint` | Custom name for the entity.
|
||||
|
||||
### Configuration options for `switch` list
|
||||
|
||||
Key | Type | Required | Default | Description
|
||||
-- | -- | -- | -- | --
|
||||
`enabled` | `boolean` | `False` | `False` | Boolean to enable/disable the platform.
|
||||
`name` | `string` | `False` | `blueprint` | Custom name for the entity.
|
||||
|
||||
|
||||
***
|
||||
|
||||
[exampleimg]: example.png
|
||||
|
Reference in New Issue
Block a user