Device Names - OpenGrow-Box/OpenGrowBox GitHub Wiki

๐Ÿงญ 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.

โš ๏ธ Temp And Humidity needs to be in the English language after the under slash _temperature _humidity. "Until we have a mapping function for all languages"


๐ŸŒก๏ธ Sensors

Device Name Format Entity ID Check
FlowerSensor1 sensor.flowersensor1__humidity Correct โœ…
FlowerSensor2 sensor.flowersensor2_temperature Correct โœ…
Flower Sensor1 sensor.flower_sensor1_temperature Wrong โŒ
Entity ID Format
sensor.sensorSome_humidity Humidity
sensor.sensorSome_temperature Temp
Entity ID Format Device Sensors Mappings
sensor.exhaust_duty Exhaust Duty Cycle
sensor.light_intensity Light Voltage
Coming Soon Sensors SOON Usable
sensor.sensorSome_dewpoint Dewpoint
sensor.sensorSome_moisture Moisture

๐Ÿ’ก Lights

Device Name Format Entity ID Check
FlowerLight switch.flowerlight Correct โœ…
Flower Light switch.flower_light Wrong โŒ
Entity ID Format Type
switch.light Non-Dimmable
light.light Dimmable

๐ŸŒฌ๏ธ Exhaust

Device Name Format Entity ID Check
FlowerExhaust switch.flowerexhaust Correct โœ…

| Flower Exhaust | switch.flower_exhaust | Wrong โŒ |

Entity ID Format Type
switch.exhaust Non-Dimmable
light.exhaust Dimmable
fan.exhaust Dimmable

๐ŸŒช๏ธ Inhaust (Not fully implemented yet)

Device Name Format Entity ID Check
FlowerInhaust switch.flowerinhaust Correct โœ…
Flower Inhaust switch.flower_inhaust Wrong โŒ
Entity ID Format Type
switch.inhaust Non-Dimmable
light.inhaust Dimmable
fan.inhaust Dimmable

๐ŸŒ€ Ventilation

Device Name Format Entity ID Check
FlowerVentilation switch.flowerventilation Correct โœ…
Flower Ventilation switch.flower_ventilation Wrong โŒ
Entity ID Format Type
switch.vents Non-Dimmable
light.vents Dimmable
fan.vents Dimmable

๐Ÿ’ง Humidifier

Device Name Format Entity ID Check
FlowerHumidifier switch.flowerhumidifier Correct โœ…
Flower Humidifier switch.flower_humidifier Wrong โŒ
Entity ID Format Type / Mode Support
switch.humidifier Non-Dimmable
humidifier.humidifier Modes โ€“ Planned support

๐Ÿงผ Dehumidifier

Device Name Format Entity ID Check
FlowerDehumidifier switch.flowerdehumidifier Correct โœ…
Flower Dehumidifier switch.flower_dehumidifier Wrong โŒ
Entity ID Format Type / Mode Support
switch.dehumidifier Non-Dimmable
humidifier.dehumidifier Modes โ€“ Planned support

โ„๏ธ Cooler

Device Name Format Entity ID Check
FlowerCooler switch.flowercooler Correct โœ…
Flower Cooler switch.flower_cooler Wrong โŒ
Entity ID Format Type
switch.cooler Non-Dimmable

๐Ÿ”ฅ Heater

Device Name Format Entity ID Check
FlowerHeater switch.flowerheater Correct โœ…
Flower Heater switch.flower_heater Wrong โŒ
Entity ID Format Type
switch.heater Non-Dimmable

Coยฒ Pump

Device Name Format Entity ID Check
FlowerCO2 switch.flowerco2 Correct โœ…
Flower CO2 switch.flower_co2 Wrong โŒ
Entity ID Format Type / Mode Support
switch.co2 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.waterpump Non-Dimmable
switch.mistpump Non-Dimmable
switch.rdwcpump Non-Dimmable
switch.dwcpump Non-Dimmable
switch.aeropump Non-Dimmable
switch.clonerpump Non-Dimmable

๐Ÿšฐ Water Retrieve Pumps (Not implemented yet)

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

๐Ÿšฐ Feed Pumps (Not implemented yet)

Entity ID Format Type / Mode Support
switch.feedpump_A Non-Dimmable
switch.feedpump_B Non-Dimmable
switch.feedpump_C Non-Dimmable
switch.feedpump_W Non-Dimmable
switch.feedpump_X Non-Dimmable
switch.feedpump_Y Non-Dimmable
switch.feedpump_Pp Non-Dimmable
switch.feedpump_Pm Non-Dimmable

๐ŸŒก๏ธ Climate Device (Not implemented yet)

Device Name Format Entity ID Check
FlowerClimate switch.flowerclimate Correct โœ…
Flower Climate switch.flower_climate 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