Skip to content

Add Mega Joule as valid unit of energy #86055

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

Merged
epenet merged 11 commits into from
Jan 25, 2023
Merged

Add Mega Joule as valid unit of energy #86055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
85580e8
Add Mega joule
SgtBatten Jan 17, 2023
a2e581f
Reorder valid energy types
SgtBatten Jan 17, 2023
73eacea
Add Mega Joule
SgtBatten Jan 17, 2023
8e62b97
Add Mega Joule as valid energy unit
SgtBatten Jan 17, 2023
91d4e02
Add Mega Joule
SgtBatten Jan 17, 2023
13ea7fd
Add Mega Joule as a Unit of Measurement to Energy
Roving-Ronin Jan 17, 2023
0f9ffec
Merge pull request #1 from Roving-Ronin/patch-1
SgtBatten Jan 17, 2023
8026a0a
Update tests
emontnemery Jan 25, 2023
b744857
Merge branch 'dev' into patch-1
emontnemery Jan 25, 2023
ac19238
Update tests
emontnemery Jan 25, 2023
b7fcf48
Update number docstring
emontnemery Jan 25, 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
1 change: 1 addition & 0 deletions homeassistant/components/energy/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
VALID_ENERGY_UNITS: set[str] = {
UnitOfEnergy.GIGA_JOULE,
UnitOfEnergy.KILO_WATT_HOUR,
UnitOfEnergy.MEGA_JOULE,
UnitOfEnergy.MEGA_WATT_HOUR,
UnitOfEnergy.WATT_HOUR,
}
Expand Down
2 changes: 2 additions & 0 deletions homeassistant/components/energy/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
sensor.SensorDeviceClass.ENERGY: (
UnitOfEnergy.GIGA_JOULE,
UnitOfEnergy.KILO_WATT_HOUR,
UnitOfEnergy.MEGA_JOULE,
UnitOfEnergy.MEGA_WATT_HOUR,
UnitOfEnergy.WATT_HOUR,
)
Expand All @@ -40,6 +41,7 @@
sensor.SensorDeviceClass.ENERGY: (
UnitOfEnergy.GIGA_JOULE,
UnitOfEnergy.KILO_WATT_HOUR,
UnitOfEnergy.MEGA_JOULE,
UnitOfEnergy.MEGA_WATT_HOUR,
UnitOfEnergy.WATT_HOUR,
),
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/number/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ class NumberDeviceClass(StrEnum):
ENERGY = "energy"
"""Energy.

Unit of measurement: `Wh`, `kWh`, `MWh`, `GJ`
Unit of measurement: `Wh`, `kWh`, `MWh`, `MJ`, `GJ`
"""

FREQUENCY = "frequency"
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/sensor/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ class SensorDeviceClass(StrEnum):
ENERGY = "energy"
"""Energy.

Unit of measurement: `Wh`, `kWh`, `MWh`, `GJ`
Unit of measurement: `Wh`, `kWh`, `MWh`, `MJ`, `GJ`
Copy link
Copy Markdown
Contributor

@epenet epenet Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same change is needed in number platform.

"""

FREQUENCY = "frequency"
Expand Down
1 change: 1 addition & 0 deletions homeassistant/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,7 @@ class UnitOfEnergy(StrEnum):

GIGA_JOULE = "GJ"
KILO_WATT_HOUR = "kWh"
MEGA_JOULE = "MJ"
MEGA_WATT_HOUR = "MWh"
WATT_HOUR = "Wh"

Expand Down
2 changes: 2 additions & 0 deletions homeassistant/util/unit_conversion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,14 @@ class EnergyConverter(BaseUnitConverter):
UnitOfEnergy.WATT_HOUR: 1 * 1000,
UnitOfEnergy.KILO_WATT_HOUR: 1,
UnitOfEnergy.MEGA_WATT_HOUR: 1 / 1000,
UnitOfEnergy.MEGA_JOULE: 3.6,
UnitOfEnergy.GIGA_JOULE: 3.6 / 1000,
}
VALID_UNITS = {
UnitOfEnergy.WATT_HOUR,
UnitOfEnergy.KILO_WATT_HOUR,
UnitOfEnergy.MEGA_WATT_HOUR,
UnitOfEnergy.MEGA_JOULE,
UnitOfEnergy.GIGA_JOULE,
}

Expand Down
26 changes: 18 additions & 8 deletions tests/components/energy/test_validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,9 @@ async def test_validation_device_consumption_entity_unexpected_unit(
{
"type": "entity_unexpected_unit_energy",
"affected_entities": {("sensor.unexpected_unit", "beers")},
"translation_placeholders": {"energy_units": "GJ, kWh, MWh, Wh"},
"translation_placeholders": {
"energy_units": "GJ, kWh, MJ, MWh, Wh"
},
}
]
],
Expand Down Expand Up @@ -306,7 +308,9 @@ async def test_validation_solar(hass, mock_energy_manager, mock_get_metadata):
{
"type": "entity_unexpected_unit_energy",
"affected_entities": {("sensor.solar_production", "beers")},
"translation_placeholders": {"energy_units": "GJ, kWh, MWh, Wh"},
"translation_placeholders": {
"energy_units": "GJ, kWh, MJ, MWh, Wh"
},
}
]
],
Expand Down Expand Up @@ -355,7 +359,9 @@ async def test_validation_battery(hass, mock_energy_manager, mock_get_metadata):
("sensor.battery_import", "beers"),
("sensor.battery_export", "beers"),
},
"translation_placeholders": {"energy_units": "GJ, kWh, MWh, Wh"},
"translation_placeholders": {
"energy_units": "GJ, kWh, MJ, MWh, Wh"
},
},
]
],
Expand Down Expand Up @@ -424,7 +430,9 @@ async def test_validation_grid(
("sensor.grid_consumption_1", "beers"),
("sensor.grid_production_1", "beers"),
},
"translation_placeholders": {"energy_units": "GJ, kWh, MWh, Wh"},
"translation_placeholders": {
"energy_units": "GJ, kWh, MJ, MWh, Wh"
},
},
{
"type": "statistics_not_defined",
Expand Down Expand Up @@ -511,7 +519,9 @@ async def test_validation_grid_external_cost_compensation(
("sensor.grid_consumption_1", "beers"),
("sensor.grid_production_1", "beers"),
},
"translation_placeholders": {"energy_units": "GJ, kWh, MWh, Wh"},
"translation_placeholders": {
"energy_units": "GJ, kWh, MJ, MWh, Wh"
},
},
{
"type": "statistics_not_defined",
Expand Down Expand Up @@ -678,7 +688,7 @@ async def test_validation_grid_auto_cost_entity_errors(
"type": "entity_unexpected_unit_energy_price",
"affected_entities": {("sensor.grid_price_1", "$/Ws")},
"translation_placeholders": {
"price_units": "EUR/GJ, EUR/kWh, EUR/MWh, EUR/Wh"
"price_units": "EUR/GJ, EUR/kWh, EUR/MJ, EUR/MWh, EUR/Wh"
},
},
),
Expand Down Expand Up @@ -822,7 +832,7 @@ async def test_validation_gas(
"type": "entity_unexpected_unit_gas",
"affected_entities": {("sensor.gas_consumption_1", "beers")},
"translation_placeholders": {
"energy_units": "GJ, kWh, MWh, Wh",
"energy_units": "GJ, kWh, MJ, MWh, Wh",
"gas_units": "CCF, ft³, m³",
},
},
Expand Down Expand Up @@ -852,7 +862,7 @@ async def test_validation_gas(
"affected_entities": {("sensor.gas_price_2", "EUR/invalid")},
"translation_placeholders": {
"price_units": (
"EUR/GJ, EUR/kWh, EUR/MWh, EUR/Wh, EUR/CCF, EUR/ft³, EUR/m³"
"EUR/GJ, EUR/kWh, EUR/MJ, EUR/MWh, EUR/Wh, EUR/CCF, EUR/ft³, EUR/m³"
)
},
},
Expand Down
2 changes: 2 additions & 0 deletions tests/util/test_unit_conversion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,8 @@
(10, UnitOfEnergy.MEGA_WATT_HOUR, 10000, UnitOfEnergy.KILO_WATT_HOUR),
(10, UnitOfEnergy.GIGA_JOULE, 10000 / 3.6, UnitOfEnergy.KILO_WATT_HOUR),
(10, UnitOfEnergy.GIGA_JOULE, 10 / 3.6, UnitOfEnergy.MEGA_WATT_HOUR),
(10, UnitOfEnergy.MEGA_JOULE, 10 / 3.6, UnitOfEnergy.KILO_WATT_HOUR),
(10, UnitOfEnergy.MEGA_JOULE, 0.010 / 3.6, UnitOfEnergy.MEGA_WATT_HOUR),
],
InformationConverter: [
(8e3, UnitOfInformation.BITS, 8, UnitOfInformation.KILOBITS),
Expand Down