SmartHomeShop Docs

Sensor Definitions

This page lists the planned entities of CeilSense Pro, grouped by function and radar configuration. Which entities you will see depends on the radar in your device and the firmware on it.

Names can change at release. The firmware for the final CeilSense Pro is not written yet. The names on this page come from an earlier prototype and can change at release. Entity IDs in Home Assistant start with your device name, so they can differ per installation.

The Category column shows where Home Assistant will list the entity on the device page: Regular for normal sensors and controls, Config for settings and Diagnostic for technical information. Where several numbered entities work the same way, the table uses N for the number.

Every CeilSense Pro

Light

Entity Type Category Description
Illuminance Sensor Regular Light level in lux from the Vishay VEML6030

Whether a separate corrected value follows, as on CeilSense V2, is decided with the firmware.

CO2, Temperature and Humidity (SCD41)

Entity Type Category Description
SCD41 CO2 Sensor Regular CO2 in ppm. New value every 30 seconds.
SCD41 Temperature Sensor Regular Temperature in °C. New value every 30 seconds.
SCD41 Humidity Sensor Regular Relative humidity in %. New value every 30 seconds.
SCD41 Extra Temperature Offset Number Config Correction in °C, -20 to +20, step 0.1. Added on top of the factory correction and kept after a restart.
SCD41 Humidity Offset Number Config Correction in %, -20 to +20, step 0.1, default 0. Kept after a restart.
SCD41 Calibrate Fresh Air Button Config Sets the CO2 reading to 426 ppm. Only press it in fresh air: see Calibration.

Temperature and Humidity (SHT45)

The prototype firmware has no SHT45 entities yet. Their names follow with release firmware.

VOC and NOx (SGP41)

These values are indices, not ppm.

Entity Type Category Description
SGP41 VOC Index Sensor Regular VOC index from 1 to 500
SGP41 NOx Index Sensor Regular NOx index from 1 to 500

Air Pressure

Entity Type Category Description
BMP388 Pressure Sensor Regular Air pressure from the Bosch BMP388
BMP388 Temperature Sensor Regular Temperature inside the device, not room temperature

LED Ring and Buzzer

Entity Type Category Description
LED Ring Light Regular Color, brightness and effect. Off by default. The list of effects follows with release firmware.
Buzzer Test Button Diagnostic Plays a short melody on the buzzer

Speaker and Microphone

Entity Type Category Description
Speaker Media player Regular Plays music, MP3 files and spoken announcements through Home Assistant

The prototype firmware has no microphone entities yet. They follow with release firmware.

Optical Smoke Sensing

Experimental, and not a safety function. See Optical Smoke Sensing. Entities marked disabled are disabled by default.

Entity Type Category Description
ADPD188BI Smoke Alert Binary sensor Regular On when four consecutive candidates were seen. Off only means this measurement has no alert.
ADPD188BI Smoke Index Sensor Regular Relative rise above the baseline in %. Not a concentration. Stays at 0 during the warm-up.
ADPD188BI Blue Sensor Regular Raw reading of the blue channel
ADPD188BI Infrared Sensor Regular Raw reading of the infrared channel
Smoke Siren Enabled Switch Config Allows the siren on the buzzer. Off by default, and it keeps your setting after a restart.
Remote Smoke Alarm Switch Regular Lets Home Assistant start the siren and strobe of this unit. Not restored after a restart.
Smoke Alarm Silence Button Regular Mutes an active siren for 10 minutes
Smoke Test Button Diagnostic Runs a self-test of the sensor
Smoke Self Test Result Text sensor Diagnostic PASS or FAIL from the last Smoke Test
ADPD188BI Sensor Problem Binary sensor Diagnostic On after a setup failure or failed reads
ADPD188BI Baseline Ready Binary sensor Diagnostic On when the warm-up is done
ADPD188BI Measurement Stable Binary sensor Diagnostic On when the measuring window is valid
ADPD188BI Alarm Candidate Binary sensor Diagnostic On while a window counts as a candidate
ADPD188BI eFuse Calibration Ready Binary sensor Diagnostic On when the factory calibration of the sensor has been read
ADPD188BI Blue Delta Sensor Diagnostic Rise of the blue channel above its baseline
ADPD188BI Infrared Delta Sensor Diagnostic Rise of the infrared channel above its baseline
ADPD188BI Blue Baseline Sensor Diagnostic Baseline of the blue channel, disabled
ADPD188BI Infrared Baseline Sensor Diagnostic Baseline of the infrared channel, disabled
ADPD188BI Blue IR Ratio Sensor Diagnostic Ratio between the blue and infrared channel, disabled
ADPD188BI Device ID Sensor Diagnostic Identification of the sensor, disabled
ADPD188BI eFuse Module ID Sensor Diagnostic Module number of the sensor, disabled
ADPD188BI Blue Calibration Gain Sensor Diagnostic Factory calibration of the blue channel, disabled
ADPD188BI Infrared Calibration Gain Sensor Diagnostic Factory calibration of the infrared channel, disabled

Device

Entity Type Category Description
Restart Device Button Config Restarts the device. The optical smoke sensing then starts its warm-up again.
Factory Reset Button Config Resets the device to factory settings. Disabled by default.
Software Version Text sensor Regular Firmware version
Hardware Version Text sensor Regular Hardware version
Network Variant Text sensor Regular WiFi or Ethernet build
CPU Temperature Sensor Diagnostic Temperature of the processor
Device Info Text sensor Diagnostic Technical information about the device
ESP Reset Reason Text sensor Diagnostic Reason for the last restart. Disabled by default.

Network

All of these are disabled by default.

Entity Type Category Description
WiFi IP Address Text sensor Diagnostic IP address of the device. WiFi firmware only.
WiFi MAC Text sensor Diagnostic Network address of the WiFi connection. WiFi firmware only.
WiFi Signal Sensor Diagnostic Strength of the WiFi signal. WiFi firmware only.
Ethernet IP Address Text sensor Diagnostic IP address of the device. Ethernet firmware only.
Ethernet MAC Text sensor Diagnostic Network address of the Ethernet connection. Ethernet firmware only.

With LD2412 + LD2450

Combined Presence

Entity Type Category Description
Presence Binary sensor Regular On when either radar sees someone. Use this one for most automations.

LD2412

Entity Type Category Description
LD2412 Presence Binary sensor Regular On when the LD2412 sees a moving or still target
LD2412 Moving Target Binary sensor Regular On when a moving target is detected
LD2412 Still Target Binary sensor Regular On when a still target is detected
LD2412 Moving Distance Sensor Regular Distance to the moving target
LD2412 Still Distance Sensor Regular Distance to the still target
LD2412 Moving Energy Sensor Regular Signal strength of the moving target
LD2412 Still Energy Sensor Regular Signal strength of the still target
LD2412 Detection Distance Sensor Regular Distance to the closest detected target
LD2412 Light Sensor Diagnostic Light value reported by the radar module
LD2412 Dynamic Background Correction Binary sensor Diagnostic On while the background correction runs
LD2412 Firmware Version Text sensor Diagnostic Firmware of the radar module. Empty means the module is not seen.
LD2412 MAC Text sensor Diagnostic Bluetooth address of the radar module
LD2412 Presence Timeout Number Config Seconds that presence stays on after the last detection
LD2412 Minimum Distance Gate Number Config Closest gate used for detection, 1 to 12
LD2412 Maximum Distance Gate Number Config Furthest gate used for detection, 2 to 13
LD2412 Distance Resolution Select Config Length of each gate: 0.2 m, 0.5 m or 0.75 m
LD2412 Light Threshold Number Config Threshold for the radar's own light function
LD2412 Light Function Select Config Light function of the radar: off, below or above
LD2412 Engineering Mode Switch Config Engineering mode of the radar. Not needed in normal use.
LD2412 Bluetooth Switch Config Bluetooth of the radar module, for the HLK Radar Tool app
LD2412 Start Dynamic Background Correction Button Diagnostic Starts the background correction. The room must be empty.
LD2412 Restart Button Diagnostic Restarts the radar module only
LD2412 Query Parameters Button Diagnostic Reads the settings from the radar again
LD2412 Factory Reset Button Diagnostic Resets the radar module to factory settings

LD2450

Entity Type Category Description
LD2450 Presence Binary sensor Regular On when the LD2450 sees a target
LD2450 Moving Target Binary sensor Regular On when a moving target is detected
LD2450 Still Target Binary sensor Regular On when a still target is detected
LD2450 Target Count Sensor Regular Number of targets
LD2450 Moving Target Count Sensor Regular Number of moving targets
LD2450 Still Target Count Sensor Regular Number of still targets
LD2450 Target N Distance Sensor Regular Distance to the target. N is 1 to 3.
LD2450 Zone N Target Count Sensor Regular Number of targets inside the zone. N is 1 to 3.
LD2450 Target N X Sensor Diagnostic X position in mm
LD2450 Target N Y Sensor Diagnostic Y position in mm
LD2450 Target N Speed Sensor Diagnostic Speed of the target
LD2450 Target N Angle Sensor Diagnostic Angle to the target
LD2450 Target N Direction Text sensor Diagnostic Direction of the target
LD2450 Target N Resolution Sensor Diagnostic Distance resolution of the target
LD2450 Firmware Version Text sensor Diagnostic Firmware of the radar module. Empty means the module is not seen.
LD2450 MAC Text sensor Diagnostic Bluetooth address of the radar module
LD2450 Presence Timeout Number Config Seconds that presence stays on after the last detection
LD2450 Zone Type Select Config How the zones work: Disabled, Detection or Filter
LD2450 Zone N X1, Y1, X2, Y2 Number Config Corners of the zone in mm. N is 1 to 3.
LD2450 Multi Target Tracking Switch Config Tracks several people instead of one
LD2450 Bluetooth Switch Config Bluetooth of the radar module, for the HLK Radar Tool app
LD2450 Baud Rate Select Config Speed of the connection to the radar. Leave this as it is.
LD2450 Restart Button Diagnostic Restarts the radar module only
LD2450 Factory Reset Button Diagnostic Resets the radar module to factory settings

With LD2460

Firmware for the LD2460 on CeilSense Pro is planned. The names below are those of the LD2460 component that SmartHomeShop maintains.

Presence and Targets

Entity Type Category Description
Presence Binary sensor Regular Follows Tracking Presence. Use this one for most automations.
Tracking Presence Binary sensor Regular On when the LD2460 sees someone
Tracking Target Count Sensor Regular Number of targets
Tracking Targets Text sensor Regular Text summary of the targets
Tracking Target N X Sensor Regular X position in meters. N is 1 to 5.
Tracking Target N Y Sensor Regular Y position in meters
Tracking Target N Distance Sensor Regular Distance to the target in meters
Tracking Target N Angle Sensor Regular Angle to the target in degrees

Radar Settings

Entity Type Category Description
Tracking Radar Installation Mode Select Config side or top. The firmware sets top for ceiling mounting.
Tracking Radar Detection Distance Number Config Distance of the detection sector in meters
Tracking Radar Detection Start Angle Number Config Start of the detection sector in degrees
Tracking Radar Detection End Angle Number Config End of the detection sector in degrees
Tracking Radar Installation Height Number Config For wall mounting. Not needed on the ceiling.
Tracking Radar Installation Angle Number Config For wall mounting. Not needed on the ceiling.
Tracking Radar Firmware Text sensor Diagnostic Firmware of the radar module. Empty means the module is not seen.
Tracking Radar Installation Mode Text sensor Diagnostic The mode the radar reports
Tracking Raw UART Text sensor Diagnostic Raw data for diagnosis. Disabled by default.
Tracking UART Bytes Sensor Diagnostic Byte counter for diagnosis. Disabled by default.

Room Designer Zones

These entities belong to the zones you draw in the Room Designer.

Entity Type Category Description
Polygon Zone N Presence Binary sensor Regular On when someone is inside the zone. N is 1 to 4.
Polygon Zone N Target Count Sensor Regular Number of targets inside the zone. N is 1 to 4.
People Count Sensor Regular Running count of people in the room, based on entry lines
Last Crossing Direction Text sensor Regular Direction of the last crossing of an entry line
Polygon Zones Enabled Switch Config Turns the zones on or off. On by default.
Polygon Zone N Text Config Shape of the zone. The Room Designer writes this. N is 1 to 4.
Polygon Exclusion N Text Config Area where targets are ignored. The Room Designer writes this. N is 1 or 2.
Entry Line N Text Config Line used for counting people. The Room Designer writes this. N is 1 or 2.
Reset People Count Button Config Sets the people count back to zero

The LD2460 build also has a set of diagnostic entities starting with Radar, such as Radar Model and Radar Mounting Mode. They tell the Room Designer how the radar is mounted, and you do not need to change them.

With LD6002B

Firmware for the LD6002B on CeilSense Pro is not finished, so its entity names are not final and are not listed here. Expect presence per target, detection areas, target and point counts, X, Y and Z per target in meters, and settings for installation mode, sensitivity and trigger speed.

Example Entity IDs

Entity Example entity ID
Presence binary_sensor.ceilsense_pro_presence
Illuminance sensor.ceilsense_pro_illuminance
SCD41 CO2 sensor.ceilsense_pro_scd41_co2
SGP41 VOC Index sensor.ceilsense_pro_sgp41_voc_index
BMP388 Pressure sensor.ceilsense_pro_bmp388_pressure
LED Ring light.ceilsense_pro_led_ring
Buzzer Test button.ceilsense_pro_buzzer_test
Speaker media_player.ceilsense_pro_speaker
ADPD188BI Smoke Alert binary_sensor.ceilsense_pro_adpd188bi_smoke_alert

Related