Skip to content

Device Names

OpenGrowBox edited this page Jan 15, 2026 · 47 revisions

🧭 Device & Entity Mapping Guide

To map your Devices & Entities to the correct internal class, we use the device domain (e.g. switch, light, fan) and the name after the dot (e.g. light, exhaust, etc.) as matching criteria.

⚠️ Do not use any Space-Char " " on your Device Names, it will translate in Home Assistant to an under Slash "_" and break the Device Identification logic.

⚠️ That are only examples you can define your name how you like, but it needs to be in the Valid array Schema described below. See Mapping Function on the End.


🌿 Label Mapping Overview WORKING with version v1.4.1

This table defines how labels are mapped to specific device or sensor types.
It serves as the foundation for automatic detection and assignment within the OpenGrowBox logic.


⚙️ Device Type Labels

Label Name Mapped Type
Sensor Sensor
Light Light
Exhaust Exhaust
Intake Intake
Ventilation Ventilation
Climate Climate
Heater Heater
Cooler Cooler
Humidifer Humidifer
Dehumidifer Dehumidifer
Pump Pump
CO2 CO2

Special Type Labels

Label Name Description / Mapping
Water Marks the sensor as a Water Sensor
Medium_2 Maps to your second medium (e.g., Medium #2 in your configuration)
DLI Used for DLI/PPFD calculation
PPFD Used for DLI/PPFD calculation

Notes

  • Case-insensitive (light, Light, LIGHT → all recognized).
  • New medium labels follow the pattern medium_N, e.g., medium_3 for the third medium.
  • These mappings are the foundation for automatic device and sensor recognition logic.

Name Mapping

🌡️ Sensors

Device Name Format Entity ID Check
Sensor1Flower sensor.sensor1flower_humidity Correct ✅
FlowerSensor2 sensor.sensor2flower_temperature Correct ✅
Sensor1 Flower sensor.sensor1_flower_temperature Wrong ❌ But works ! Not Recommended
Entity ID Format
sensor.sensorSomeNameYouWant_humidity Humidity
sensor.sensorSomeNameYouWant_temperature Temp
Entity ID Format PPFD/DLI Sensors Mappings
sensor.sensorSomeNameYouWant_lumen Lumen Sensor
sensor.sensorSomeNameYouWant_lux Lux Sensor
sensor.sensorSomeNameYouWant_illuminance Illuminance Sensor
Entity ID Format Soil Moisture Sensor
sensor.sensorSomeNameYouWant_moisture Moisture
sensor.sensorSomeNameYouWant_conductivity Conductivity
Entity ID Format CO2 Sensors
sensor.sensorSomeNameYouWant_carbondioxide carbondioxide
sensor.sensorSomeNameYouWant_co2 carbondioxide
Entity ID Format Device Sensors Mappings
sensor.exhaust_duty Exhaust Duty Cycle
sensor.light_intensity Light Voltage
Entity ID Format Water Sensors Mappings
sensor.watertester_ph EC
sensor.watertester_ec PH
sensor.watertester_sal SAL
sensor.watertester_tds TDS
sensor.watertester_ph EC
Entity ID Format Tank Level Reservoir
sensor.tank_level Reservoir LEVEL
sensor.water_level Reservoir LEVEL
sensor.reservoir_level Reservoir LEVEL

💡 Lights

Device Name Format Entity ID Check
LightFlower switch.lightflower Correct ✅
Light Flower switch.light_flower Wrong ❌
Entity ID Format Type
switch.lightflower Non-Dimmable
light.lightflower Dimmable
select.lightflower + number.lightflower Dimmable

🌬️ Exhaust

Device Name Format Entity ID Check
ExhaustFlower switch.exhaustflower Correct ✅
Exhaust Flower switch.exhaust_flower Wrong ❌
Entity ID Format Type
switch.exhaustflower Non-Dimmable
fan.exhaustflower Dimmable
light.exhaustflower Dimmable
select.exhaustflower + number.exhaustflower Dimmable

🌪️ Inhaust (Not fully implemented yet)

Device Name Format Entity ID Check
IntakeFlower switch.intakeflower Correct ✅
Intake Flower switch.intake_flower Wrong ❌
Entity ID Format Type
switch.intakeflower Non-Dimmable
fan.intakeflower Dimmable
light.intakeflower Dimmable
select.intakeflower + number.intakeflower Dimmable

🌀 Ventilation

Device Name Format Entity ID Check
VentilationFlower switch.ventilationflower Correct ✅
Ventilation Flower switch.ventilation_flower Wrong ❌
Entity ID Format Type
switch.ventilationflower Non-Dimmable
fan.ventilationflower Dimmable
light.ventilationflower Dimmable
select.ventilationflower + number.ventilationflower Dimmable

💧 Humidifier

Device Name Format Entity ID Check
HumidifierFlower switch.humidifierflower Correct ✅
Humidifier Flower switch.humidifier_flower Wrong ❌
Entity ID Format Type / Mode Support
switch.humidifierflower Non-Dimmable
humidifier.humidifierflower Modes – Planned support
select.humidifierflower + number.humidifierflower Dimmable

🧼 Dehumidifier

Device Name Format Entity ID Check
DehumidifierFlower switch.dehumidifierflower Correct ✅
Dehumidifier Flower switch.dehumidifier_flower Wrong ❌
Entity ID Format Type / Mode Support
switch.dehumidifierflower Non-Dimmable
humidifier.dehumidifierflower Modes – Planned support
select.dehumidifierflower + number.dehumidifierflower Dimmable

❄️ Cooler

Device Name Format Entity ID Check
CoolerFlower switch.coolerflower Correct ✅
Cooler Flower switch.cooler_flower Wrong ❌
Entity ID Format Type
switch.coolerflower Non-Dimmable
select.coolerflower + number.coolerflower Dimmable

🔥 Heater

Device Name Format Entity ID Check
HeaterFlower switch.heaterflower Correct ✅
Heater Flower switch.heater_flower Wrong ❌
Entity ID Format Type
switch.heaterflower Non-Dimmable
select.heaterflower + number.heaterflower Dimmable

Co² Pump

Device Name Format Entity ID Check
CO2Flower switch.co2flower Correct ✅
CO2 Flower switch.co2_flower Wrong ❌
Entity ID Format Type / Mode Support
switch.co2flower Non-Dimmable

🚰 Water Pumps

Device Name Format Entity ID Check
FlowerPump switch.flowerpump Correct ✅
Flower Pump switch.flower_pump Wrong ❌
Entity ID Format Type / Mode Support
switch.pumpwater Non-Dimmable
switch.pumpmist Non-Dimmable
switch.pumprdwc Non-Dimmable
switch.pumpdwc Non-Dimmable
switch.pumpaero Non-Dimmable
switch.pumpcloner Non-Dimmable

🚰 Water Retrieve Pumps (Not implemented yet)

Entity ID Format Type / Mode Support
switch.pumpreturn Non-Dimmable
switch.pumpretrive Non-Dimmable

🚰 Feed Pumps (Not implemented yet)

Entity ID Format Type / Mode Description
switch.feedpump_a A
switch.feedpump_b B
switch.feedpump_c C
switch.feedpump_w Water
switch.feedpump_x Custom Free use – not automated
switch.feedpump_y Custom Free use – not automated
switch.feedpump_pp PH -
switch.feedpump_pm PH +

🌡️ Climate Device (Not implemented yet)

Device Name Format Entity ID Check
Climate Flower switch.climateflower Correct ✅
Climate Flower switch.climate_flower Wrong ❌
Entity ID Format Features
climate.climate Multi-mode – Planned

⚙️ Mapping Function

You can find the current mapping logic in the source code here:
📄 OGBDeviceManager.py – line 114