Skip to the content.

Basic Sensors

HomeKit and Zigbee2MQTT support a lot of โ€œbasicโ€ sensors, that expose one or more types of sensor measurements. Because the handling of these sensors is vary similar and most of them have the same optional characteristics in HomeKit (being Status Tampered and Status Low Battery), a large part of the code handling these sensors is shared.

For all the sensors on this page, the following mapping applies for the aforementioned characteristics.

Name Required access Characteristic Remarks
tamper published Status Tampered ย 
battery_low published Status Low Battery ย 

The following table shows the possible exposes entries and the services and characteristics created if they are present:

Name Required access Service Characteristic Remarks
humidity published Humidity Sensor Current Relative Humidity ย 
temperature published Temperature Sensor Current Temperature ย 
illuminance_lux published Light Sensor Current Ambient Light Level ย 
pressure published Air Pressure Sensor (custom)
E863F00A-079E-48FF-8F27-9C2605A29F52
Air Pressure (custom)
E863F10F-079E-48FF-8F27-9C2605A29F52
UUIDs are the same as the Elgato Eve Weather uses.
contact published Contact Sensor Contact Sensor State ย 
occupancy published Occupancy Sensor Occupancy Detected ย 
vibration published Motion Sensor Motion Detected ย 
smoke published Smoke Sensor Smoke Detected ย 
carbon_monoxide published Carbon Monoxide Sensor Carbon Monoxide Detected ย 
co2 published Carbon Dioxide Sensor Carbon Dioxide Detected / Carbon Dioxide Level Detection threshold is currently fixed at 1200 ppm
water_leak published Leak Sensor Leak Detected Same service as gas (see below). water is added to the name to distinguish between them.
gas published Leak Sensor Leak Detected Same service as water (see above). gas is added to the name to distinguish between them.

Converter specific configuration

Occupancy (occupancy)

{
  "converters": {
    "occupancy": {
      "type": "occupancy"
    }
  }
}