Update README.md

Added front and rear image definition
This commit is contained in:
Daniel W. Anner 2023-03-24 16:55:30 -04:00 committed by GitHub
parent f78c90d38b
commit 8c4f87cde2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -55,6 +55,14 @@ The following fields may **optionally** be declared:
- `side-to-rear`
- `passive`
> :test_tube: **Example**: `airflow: side-to-rear`
- `front_image`: Indicates that this device has a front elevation image within the elevation-imgaes folder. (**Default: None**)
- NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.front.<acceptable_format>
- Type: Boolean
> :test_tube: **Example**: `front_image: True`
- `rear_image`: Indicates that this device has a rear elevation image within the elevation-imgaes folder. (**Default: None**)
- NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.rear.<acceptable_format>
- Type: Boolean
> :test_tube: **Example**: `rear_image: False`
- `subdevice_role`: Indicates that this is a `parent` or `child` device. (**Default: None**)
- Type: String
- Options: