Skip to content

Commit

Permalink
Merge pull request #21 from tomvanswam/dev
Browse files Browse the repository at this point in the history 
V0.2.1
  • Loading branch information
@tomvanswam
tomvanswam committed Aug 15, 2020
2 parents c421e42 + 3894e20 commit 5129b4b
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 41 deletions.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ compass:

## Options

| Name | Type | Requirement | Default | Supported | Visual Config | Description |
| ---------------- | --------------------------------- | ------------ | --------------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| type | string | **Required** | `custom:compass-card` | v0.0.1 | | |
| name | string | **Optional** | | v0.0.1 | ✓ | Card header |
| entity | sensor | **Required** | `none` | v0.0.1 | &#10003; | Entity that is used to draw the indicator in the compass. Valid entity states are:<br />number - (positive and/or negative, multiples of 360 are removed).<br />string - only Cardinal directions in English (e.g. E of WSW)<br/>string - any string with numbers in it will use the numbers as direction for both indicator and display value (e.g. `E (90.4)` parsed to `90.4`, note a string like `E (90) speed 80` parsed to `9080` and be recalculated to `80` (= `9080 % 360`))<br />Indicator direction is full range (not only the 16 cardinal directions) |
| secondary_entity | sensor | **Optional** | `none` | v0.0.1 | &#10003; | Entity to show under the direction in compass |
| direction_offset | number | **Optional** | `0` | v0.0.1 | &#10003; | Value to offset the indicator display with.<br />(E.g. to create a relative north) |
| compass | [compass object](#compass-object) | **Optional** | | v0.1.0 | &#8594; | Compass properties |
| Name | Type | Requirement | Default | Supported | Visual Config | Description |
| ---------------- | --------------------------------- | ------------ | --------------------- | --------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | string | **Required** | `custom:compass-card` | v0.0.1 | | |
| name | string | **Optional** | | v0.0.1 | &#10003; | Card header |
| entity | sensor | **Required** | `none` | v0.0.1 | &#10003; | Entity that is used to draw the indicator in the compass. Valid entity states are:<br />number - (positive and/or negative, multiples of 360 are removed).<br />string - only Cardinal directions in English (e.g. E of WSW)<br/>string - any string with numbers in it will use the numbers as direction for both indicator and display value (e.g. `E (90.4)` parsed to `90.4`)<br />Indicator direction is full range (not only the 16 cardinal directions) |
| secondary_entity | sensor | **Optional** | `none` | v0.0.1 | &#10003; | Entity to show under the direction in compass |
| direction_offset | number | **Optional** | `0` | v0.0.1 | &#10003; | Value to offset the indicator display with.<br />(E.g. to create a relative north) |
| compass | [compass object](#compass-object) | **Optional** | | v0.1.0 | &#8594; | Compass properties |

### Compass Object

Expand Down
Loading

0 comments on commit 5129b4b

Please sign in to comment.