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