Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update threshold branch #43

Merged
merged 15 commits into from
Mar 31, 2023
Merged

update threshold branch #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f7b28ef
bug: fixed bug inverted_entities non-fossil
flixlix Mar 27, 2023
cbc1a98
Added max_expected_flow_w configuration, to try and scale animations …
shadow7412 Mar 27, 2023
be32b06
info: change to "...-plus" domain
flixlix Mar 28, 2023
66a5e54
feat & bug: fixed bug with missing white space
flixlix Mar 28, 2023
63d7822
Merge pull request #37 from flixlix/quickfix-white-space
flixlix Mar 28, 2023
093da0f
Update power-flow-card-plus.ts
flixlix Mar 28, 2023
93c1e46
Update README.md
flixlix Mar 28, 2023
682b49a
feat: added state_of_charge_unit_white_space
flixlix Mar 28, 2023
932f236
Update power-flow-card-plus.ts
flixlix Mar 31, 2023
95bc69c
Small tweaks to readme
flixlix Mar 31, 2023
89dfb99
Merge pull request #34 from shadow7412/main
flixlix Mar 31, 2023
0049f5d
Update README.md
flixlix Mar 31, 2023
7f065d0
Merge pull request #42 from flixlix/feat/non-fossil-home-node
flixlix Mar 31, 2023
45c706d
Update README.md
flixlix Mar 31, 2023
b598438
Merge branch 'display-zero-threshold' into main
flixlix Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 29 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,24 +72,24 @@ Else, if you prefer the graphical editor, use the menu to add the resource:

> ⚠️ This card offers a **LOT** of configuration options. Don't worry, if you want your card's appearance to match the oficial Energy Flow Card, you will only need to setup the entities. The rest of the options only enable further customization. If this is your goal, please go to [Minimal Configuration](#minimal-configuration)


### Options

#### Card options

| Name | Type | Default | Description |
| ------------------ | --------- | :----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | `string` | **required** | `custom:power-flow-card-plus`. |
| entities | `object` | **required** | One or more sensor entities, see [entities object](#entities-object) for additional entity options. |
| title | `string` | | Shows a title at the top of the card. |
| dashboard_link | `string` | | Shows a link to an Energy Dashboard. Should be a url path to location of your choice. If you wanted to link to the built-in dashboard you would enter `/energy` for example. |
| inverted_entities | `string` | | Comma seperated list of entities that should be inverted (negative for consumption and positive for production). See [example usage](#inverted-entities-example). |
| kw_decimals | `number` | 1 | Number of decimals rounded to when kilowatts are displayed. |
| w_decimals | `number` | 1 | Number of decimals rounded to when watts are displayed. |
| min_flow_rate | `number` | .75 | Represents the fastest amount of time in seconds for a flow dot to travel from one end to the other, see [flow formula](#flow-formula). |
| max_flow_rate | `number` | 6 | Represents the slowest amount of time in seconds for a flow dot to travel from one end to the other, see [flow formula](#flow-formula). |
| watt_threshold | `number` | 0 | The number of watts to display before converting to and displaying kilowatts. Setting of 0 will always display in kilowatts. |
| clickable_entities | `boolean` | false | If true, clicking on the entity will open the entity's more info dialog. |
| Name | Type | Default | Description |
|---------------------| --------- |:------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | `string` | **required** | `custom:power-flow-card-plus`. |
| entities | `object` | **required** | One or more sensor entities, see [entities object](#entities-object) for additional entity options. |
| title | `string` | | Shows a title at the top of the card. |
| dashboard_link | `string` | | Shows a link to an Energy Dashboard. Should be a url path to location of your choice. If you wanted to link to the built-in dashboard you would enter `/energy` for example. |
| inverted_entities | `string` | | Comma seperated list of entities that should be inverted (negative for consumption and positive for production). |
| kw_decimals | `number` | 1 | Number of decimals rounded to when kilowatts are displayed. |
| w_decimals | `number` | 1 | Number of decimals rounded to when watts are displayed. |
| min_flow_rate | `number` | .75 | Represents the fastest amount of time in seconds for a flow dot to travel from one end to the other, see [flow formula](#flow-formula). |
| max_flow_rate | `number` | 6 | Represents the slowest amount of time in seconds for a flow dot to travel from one end to the other, see [flow formula](#flow-formula). |
| max_expected_flow_w | `number` | 5000 | Represents the maximum amount of power expected to flow through the system at a given moment, see [flow formula](#flow-formula). |
| watt_threshold | `number` | 0 | The number of watts to display before converting to and displaying kilowatts. Setting of 0 will always display in kilowatts. |
| clickable_entities | `boolean` | false | If true, clicking on the entity will open the entity's more info dialog. |

#### Entities object

Expand Down Expand Up @@ -137,6 +137,7 @@ At least one of _grid_, _battery_, or _solar_ is required. All entites (except _
| color | `object` | | Check [Color Objects](#color-object) for more information. |
| color_icon | `boolean` or "production" or "consumption" | `false` | If set to `true`, icon color will match the highest value. If set to `production`, icon color will match the production. If set to `consumption`, icon color will match the consumption. |
| display_state | "two_way" or "one_way" or "one_way_no_zero" | `two_way` | If set to `two_way` the production will always be shown simultaneously, no matter the state. If set to `one_way` only the direction that is active will be shown (since this card only shows instantaneous power, there will be no overlaps ✅). If set to `one_way_no_zero` the behavior will be the same as `one_way` but you will still the consumption direction when every state is `0`. |
| state_of_charge_unit_white_space | `boolean` | `true` | If set to `false`, there will be no white space between the state of charge and the unit of the state of charge. |

#### Individual Configuration

Expand All @@ -147,7 +148,7 @@ At least one of _grid_, _battery_, or _solar_ is required. All entites (except _
| icon | `string` | `mdi:car-electric` or `mdi:motorbike-electric` | Icon path for the icon inside the Individual Device Circle. |
| color | `string` | `#d0cc5b` or `#964cb5` | HEX value of the color for circles labels and lines of the individual device. |
| color_icon | `boolean` | `false` | If set to `true`, icon color will match the circle's color. If set to `false`, icon color will match the text's color. |
| display_zero | `boolean` | `true` | If set to `true`, the device will be displayed even if the entity state is `0` or not a number (eg: `unavailable`). Otherwise, the non-fossil section will be hidden. |
| display_zero | `boolean` | `false` | If set to `true`, the device will be displayed even if the entity state is `0` or not a number (eg: `unavailable`). Otherwise, the non-fossil section will be hidden. |
| unit_of_measurement | `string` | `W`or `kW` (dynamic) | Sets the unit of measurement to show in the corresponding circle |
| inverted_animation |`boolean` | `false` | If set to true, the small dots will flow in the opposite direction. |
| secondary_info | `object` | `undefined` | Check [Secondary Info Object](#secondary-info-configuration)
Expand Down Expand Up @@ -198,7 +199,8 @@ This Feature allows you to configure an additional small text for each Individua
| entity| `string` required | Entity ID providing a state value that is going to be displayed. |
| unit_of_measurement | `string` | A string to be used as the unit of measurement. (Important: don't forget surrounding string with quotes) |
| icon | `string` | An icon path to be displayed next to the state of the individual device. This is optional, meaning if you don't use this, no icon will be displayed. |
| display_zero | `boolean` | Default is `false`. If set to `true` info will still be displayed if state of the entity is `0` or `unavailable`.
| display_zero | `boolean` | Default is `false`. If set to `true` info will still be displayed if state of the entity is `0` or `unavailable`. |
| unit_white_space | `boolean` | Default is `true`. If set to `false` will not add any whitespace between unit and state. Otherwise, white space will be added. |

### Minimal Configuration

Expand Down Expand Up @@ -319,18 +321,25 @@ This should give you something like this:

### Flow Formula

This formula is based on the offical formula used by the Energy Distribution card.
This formula is based on the official formula used by the Energy Distribution card.

```js
max - (value / totalLines) * (max - min);
// max = max_flow_rate
// min = min_flow_rate
// value = line value, solar to grid for example
// totalLines = gridConsumption + solarConsumption + solarToBattery +
// solarToGrid + batteryConsumption + batteryFromGrid + batteryToGrid
// totalLines = Math.max(
// gridConsumption + solarConsumption + solarToBattery + solarToGrid + batteryConsumption + batteryFromGrid + batteryToGrid,
// config.max_expected_flow_w
// )
```

I'm not 100% happy with this. I'd prefer to see the dots travel slower when flow is low, but faster when flow is high. For example if the only flow is Grid to Home, I'd like to see the dot move faster if the flow is 15kW, but slower if it's only 2kW. Right now the speed would be the same. If you have a formula you'd like to propose please submit a PR.
The previous version of this lacked the max_expected_flow_w configuration, so when the power across the entire system
was low it would show animations as quickly as when the entire system running hot. This was because it was previously
only relative to the current behaviour.

The animation will not run any faster once this value has been exceeded, so you may wish to tweak max_expected_flow_w
if you expect your system to have a higher total power than 8kw.

#### Credits

Expand Down
4 changes: 3 additions & 1 deletion src/power-flow-card-plus-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { LovelaceCardConfig } from "custom-card-helpers";
import { ComboEntity, IndividualDeviceType } from "./type.js";

export interface PowerFlowCardConfig extends LovelaceCardConfig {
export interface PowerFlowCardPlusConfig extends LovelaceCardConfig {
entities: {
battery?: {
entity: string | ComboEntity;
Expand All @@ -11,6 +11,7 @@ export interface PowerFlowCardConfig extends LovelaceCardConfig {
color?: ComboEntity;
color_icon?: boolean | "production" | "consumption";
display_state?: "two_way" | "one_way" | "one_way_no_zero";
state_of_charge_unit_white_space?: boolean;
};
grid?: {
entity: string | ComboEntity;
Expand Down Expand Up @@ -51,6 +52,7 @@ export interface PowerFlowCardConfig extends LovelaceCardConfig {
kw_decimals: number;
min_flow_rate: number;
max_flow_rate: number;
max_expected_flow_w: number;
w_decimals: number;
watt_threshold: number;
clickable_entities: boolean;
Expand Down
Loading