Bluetooth mesh sensor types¶
All sensor types are collected in include/bluetooth/mesh/sensor_types.h
, and are divided into the categories listed in the page index.
To keep the total flash usage down, the sensor types are only instantiated if they’re referenced by the application.
This behavior can be overridden by enabling CONFIG_BT_MESH_SENSOR_ALL_TYPES
.
Note that if the Sensor Client is enabled, CONFIG_BT_MESH_SENSOR_ALL_TYPES
is enabled by default.
Sensor types can be forced into the build by the BT_MESH_SENSOR_TYPE_FORCE
macro.
Sensor types may only be declared in the bt_mesh_sensor_types
static linker section.
-
BT_MESH_SENSOR_TYPE_FORCE
(_type)¶ Force the given sensor type to be included in the build.
If CONFIG_BT_MESH_SENSOR_FORCE_ALL is disabled, only referenced sensor types will be included in the build, and the node will be unable to interpret the rest. Use this macro inside a function to force the type to be included in the build:
void some_function(void) { BT_MESH_SENSOR_TYPE_FORCE(bt_mesh_sensor_time_since_motion_sensed); BT_MESH_SENSOR_TYPE_FORCE(bt_mesh_sensor_motion_threshold); }
- Parameters
[in] _type
: Sensor type to force into the build.
Occupancy sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_motion_sensed
¶ Motion sensed
Channels:
Motion sensed
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_motion_threshold
¶ Motion threshold
This sensor type should be used as a sensor setting.
Channels:
Motion threshold
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_people_count
¶ People count
Channels:
People count
Unit: unitless
Encoding: 16 bit unsigned scalar (Resolution: 1)
Range: 0 to 65533
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_presence_detected
¶ Presence detected
Channels:
Presence detected
Unit: unitless
Encoding: boolean
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_time_since_motion_sensed
¶ Time since motion sensed
Channels:
Time since motion detected
Unit: Seconds
Encoding: 16 bit unsigned scalar (Resolution: 1 second)
Range: 0 to 65533
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_time_since_presence_detected
¶ Time since presence detected
Channels:
Time since presence detected
Unit: Seconds
Encoding: 16 bit unsigned scalar (Resolution: 1 second)
Range: 0 to 65533
Ambient temperature sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_avg_amb_temp_in_day
¶ Average ambient temperature in a period of day
This sensor type supports series access. The series X-axis is measured in Hours.
Channels:
Temperature
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Start time
Unit: Hours
Encoding: 8 bit unsigned scalar (Resolution: 0.1 hours)
Range: 0 to 24.0
End time
Unit: Hours
Encoding: 8 bit unsigned scalar (Resolution: 0.1 hours)
Range: 0 to 24.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_indoor_amb_temp_stat_values
¶ Indoor ambient temperature statistical values
Channels:
Average
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Standard deviation value
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Minimum value
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Maximum value
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_outdoor_stat_values
¶ Outdoor statistical values
Channels:
Average
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Standard deviation value
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Minimum value
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Maximum value
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_amb_temp
¶ Present ambient temperature
Channels:
Present ambient temperature
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_indoor_amb_temp
¶ Present indoor ambient temperature
Channels:
Present indoor ambient temperature
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_outdoor_amb_temp
¶ Present outdoor ambient temperature
Channels:
Present outdoor ambient temperature
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_desired_amb_temp
¶ Desired ambient temperature
Channels:
Desired ambient temperature
Unit: Celsius
Encoding: 8 bit signed scalar (Resolution: 0.5 C)
Range: -64.0 to 63.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_lumen_maintenance_factor
¶ Lumen maintenance factor
Channels:
Lumen Maintenance Factor
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_luminous_efficacy
¶ Luminous efficacy
Channels:
Luminous Efficacy
Unit: Lumen per Watt
Encoding: 16 bit unsigned scalar (Resolution: 0.1 lm/W)
Range: 0 to 6553.3
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_luminous_energy_since_turn_on
¶ Luminous energy since turn on
Channels:
Luminous Energy Since Turn On
Unit: Lumen hours
Encoding: 24 bit unsigned scalar (Resolution: 1000 lmh)
Range: 0 to 16777213000
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_luminous_exposure
¶ Luminous exposure
Channels:
Luminous Exposure
Unit: Lux hours
Encoding: 24 bit unsigned scalar (Resolution: 1000 lxh)
Range: 0 to 16777213000
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_luminous_flux_range
¶ Luminous flux range
Channels:
Minimum Luminous Flux
Unit: Lumen
Encoding: 16 bit unsigned scalar (Resolution: 1 lm)
Range: 0 to 65533
Maximum Luminous Flux
Unit: Lumen
Encoding: 16 bit unsigned scalar (Resolution: 1 lm)
Range: 0 to 65533
Environmental sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_amb_rel_humidity
¶ Present Ambient Relative Humidity
Channels:
Present Ambient Relative Humidity
Unit: Percent
Encoding: 16 bit unsigned scalar (Resolution: 0.01 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_amb_co2_concentration
¶ Present Ambient Carbon Dioxide Concentration
Channels:
Present Ambient Carbon Dioxide Concentration
Unit: Parts per million
Encoding: 16 bit unsigned scalar (Resolution: 1 ppm)
Range: 0 to 65533
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_amb_voc_concentration
¶ Present Ambient Volatile Organic Compounds Concentration
Channels:
Present Ambient Volatile Organic Compounds Concentration
Unit: Parts per billion
Encoding: 16 bit unsigned scalar (Resolution: 1 ppb)
Range: 0 to 65533
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_amb_noise
¶ Present Ambient Noise
Channels:
Present Ambient Noise
Unit: Decibel
Encoding: 8 bit unsigned scalar (Resolution: 1 dB)
Range: 0 to 253
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_apparent_wind_direction
¶ Apparent Wind Direction
The apparent wind direction is the relative clockwise direction of the wind in relation to the observer.
For example, the apparent wind direction aboard a boat is given in degrees relative to the heading of the boat.
Channels:
Apparent Wind Direction
Unit: Degrees
Encoding: 16 bit unsigned scalar (Resolution: 0.01 degrees)
Range: 0 to 359.99
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_apparent_wind_speed
¶ Apparent Wind Speed
Apparent Wind Speed is the relative speed of the wind in relation to the observer.
Channels:
Apparent Wind Speed
Unit: Metres per second
Encoding: 16 bit unsigned scalar (Resolution: 0.01 m/s)
Range: 0 to 655.35
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_dew_point
¶ Dew Point
Channels:
Dew Point
Unit: Degrees Celsius
Encoding: 8 bit signed scalar (Resolution: 1 C)
Range: -128 to 127
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_gust_factor
¶ Gust Factor
Channels:
Gust Factor
Unit: unitless
Encoding: 8 bit unsigned scalar (Resolution: 0.1)
Range: 0 to 25.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_heat_index
¶ Heat Index
Channels:
Heat Index
Unit: Degrees Celsius
Encoding: 8 bit signed scalar (Resolution: 1 C)
Range: -128 to 127
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_indoor_relative_humidity
¶ Present Indoor Relative Humidity
Channels:
Humidity
Unit: Percentage
Encoding: 16 bit unsigned scalar (Resolution: 0.01 %)
Range: 0 to 100
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_outdoor_relative_humidity
¶ Present Outdoor Relative Humidity
Channels:
Humidity
Unit: Percentage
Encoding: 16 bit unsigned scalar (Resolution: 0.01 %)
Range: 0 to 100
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_magnetic_declination
¶ Magnetic Declination
The magnetic declination is the angle on the horizontal plane between the direction of True North (geographic) and the direction of Magnetic North, measured clockwise from True North to Magnetic North.
Channels:
Magnetic Declination
Unit: Degrees
Encoding: 16 bit unsigned scalar (Resolution: 0.01 degrees)
Range: 0 to 359.99
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_magnetic_flux_density_2d
¶ Magnetic Flux Density - 2D
Channels:
X-axis
Unit: Microtesla
Encoding: 16 bit signed scalar (Resolution: 0.1 uT)
Range: -6553.6 to 6553.5
Y-axis
Unit: Microtesla
Encoding: 16 bit signed scalar (Resolution: 0.1 uT)
Range: -6553.6 to 6553.5
- Note
The Magnetic Flux Density unit is measured in tesla in the specification. In the API, it is measured in microtesla to accomodate the 6 digit format of the sensor values.
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_magnetic_flux_density_3d
¶ Magnetic Flux Density - 3D
Channels:
X-axis
Unit: Microtesla
Encoding: 16 bit signed scalar (Resolution: 0.1 uT)
Range: -6553.6 to 6553.5
Y-axis
Unit: Microtesla
Encoding: 16 bit signed scalar (Resolution: 0.1 uT)
Range: -6553.6 to 6553.5
Z-axis
Unit: Microtesla
Encoding: 16 bit signed scalar (Resolution: 0.1 uT)
Range: -6553.6 to 6553.5
- Note
The Magnetic Flux Density unit is measured in tesla in the specification. In the API, it is measured in microtesla to accomodate the 6 digit format of the sensor values.
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_pollen_concentration
¶ Pollen Concentration
Channels:
Pollen Concentration
Unit: Concentration
Encoding: 24 bit unsigned scalar (Resolution: 1 per m3)
Range: 0 to 16777215
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_air_pressure
¶ Air Pressure
Channels:
Pressure
Unit: Pascal
Encoding: 32 bit unsigned scalar (Resolution: 0.1 Pa)
Range: 0 to 429496729.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_pressure
¶ Pressure
A sensor reporting pressure other than air pressure.
Channels:
Pressure
Unit: Pascal
Encoding: 32 bit unsigned scalar (Resolution: 0.1 Pa)
Range: 0 to 429496729.5
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rainfall
¶ Rainfall
Channels:
Rainfall
Unit: Meter
Encoding: 16 bit unsigned scalar (Resolution: 0.001 m)
Range: 0 to 655.35
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_true_wind_direction
¶ True Wind Direction
Wind direction is reported by the direction from which it originates and is an angle measured clockwise relative to Geographic North.
Channels:
True Wind Direction
Unit: Degrees
Encoding: 16 bit unsigned scalar (Resolution: 0.01 degrees)
Range: 0 to 359.99
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_true_wind_speed
¶ True Wind Speed
Channels:
True Wind Speed
Unit: Metres per second
Encoding: 16 bit unsigned scalar (Resolution: 0.01 m/s)
Range: 0 to 655.35
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_uv_index
¶ UV Index
Channels:
UV Index
Unit: unitless
Encoding: 8 bit unsigned scalar (Resolution: 1)
Range: 0 to 255
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_wind_chill
¶ Wind Chill
Channels:
Wind Chill
Unit: Degrees Celsius
Encoding: 8 bit signed scalar (Resolution: 1 C)
Range: -128 to 127
Device operating temperature sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_dev_op_temp_range_spec
¶ Device operating temperature range specification
Channels:
Minimum Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Maximum Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_dev_op_temp_stat_values
¶ Device operating temperature statistical values
Channels:
Average Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Standard Deviation Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Minimum Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Maximum Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_dev_op_temp
¶ Present device operating temperature
Channels:
Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rel_runtime_in_a_dev_op_temp_range
¶ Relative runtime in a device operating temperature range
This sensor type supports series access. The series X-axis is measured in Celsius.
Channels:
Relative Value
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
Minimum Temperature Value
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Maximum Temperature Value
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
Electrical input sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_avg_input_current
¶ Average input current
Channels:
Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_avg_input_voltage
¶ Average input voltage
Channels:
Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_input_current_range_spec
¶ Input current range specification
Channels:
Minimum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Maximum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Typical Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_input_current_stat
¶ Input current statistics
Channels:
Average Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Standard Deviation Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Minimum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Maximum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Sensing Duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_input_voltage_range_spec
¶ Input voltage range specification
Channels:
Minimum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Maximum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Typical Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_input_voltage_stat
¶ Input voltage statistics
Channels:
Average Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Standard Deviation Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Minimum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Maximum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Sensing Duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_input_current
¶ Present input current
Channels:
Present Input Current
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_input_ripple_voltage
¶ Present input ripple voltage
Channels:
Present Input Ripple Voltage
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_input_voltage
¶ Present input voltage
Channels:
Present Input Voltage
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_precise_present_amb_temp
¶ Precise Present Ambient Temperature
Channels:
Precise Present Ambient Temperature
Unit: Celsius
Encoding: 16 bit signed scalar (Resolution: 0.01 C)
Range: -327.68 to 327.67
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rel_runtime_in_an_input_current_range
¶ Relative runtime in an input current range
This sensor type supports series access. The series X-axis is measured in Ampere.
Channels:
Relative Runtime Value
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
Minimum Current
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Maximum Current
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rel_runtime_in_an_input_voltage_range
¶ Relative runtime in an input voltage range
This sensor type supports series access. The series X-axis is measured in Volt.
Channels:
Relative Runtime Value
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
Minimum Voltage
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Maximum Voltage
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Energy management sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_dev_input_power
¶ Present device input power
Channels:
Present Device Input Power
Unit: Watt
Encoding: 24 bit unsigned scalar (Resolution: 0.1 W)
Range: 0 to 1677721.3
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_dev_op_efficiency
¶ Present device operating efficiency
Channels:
Present Device Operating Efficiency
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_tot_dev_energy_use
¶ Total device energy use
Channels:
Total Device Energy Use
Unit: Kwh
Encoding: 24 bit unsigned scalar (Resolution: 1 kWh)
Range: 0 to 16777213
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_dev_energy_use_since_turn_on
¶ Device energy use since turn on
Channels:
Device Energy Use Since Turn On
Unit: Kwh
Encoding: 24 bit unsigned scalar (Resolution: 1 kWh)
Range: 0 to 16777213
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_precise_tot_dev_energy_use
¶ Precise Total Device Energy Use
Channels:
Total Device Energy Use
Unit: Kwh
Encoding: 32 bit unsigned scalar (Resolution: 0.01 kWh)
Range: 0 to 4294967.293
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_power_factor
¶ Power Factor
This sensor type should be used as a sensor setting.
Channels:
Cosine Of the Angle
Unit: unitless
Encoding: 8 bit signed scalar (Resolution: 1)
Range: -256 to 100
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rel_dev_energy_use_in_a_period_of_day
¶ Relative device energy use in a period of day
This sensor type supports series access. The series X-axis is measured in Hours.
Channels:
Energy Value
Unit: Kwh
Encoding: 24 bit unsigned scalar (Resolution: 1 kWh)
Range: 0 to 16777213
Start Time
Unit: Hours
Encoding: 8 bit unsigned scalar (Resolution: 0.1 hours)
Range: 0 to 24.0
End Time
Unit: Hours
Encoding: 8 bit unsigned scalar (Resolution: 0.1 hours)
Range: 0 to 24.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rel_dev_runtime_in_a_generic_level_range
¶ Relative device runtime in a generic level range
This sensor type supports series access. The series X-axis is unitless.
Channels:
Relative Value
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
Minimum Generic Level
Unit: unitless
Encoding: 16 bit unsigned scalar (Resolution: 1)
Range: 0 to 65535
Maximum Generic Level
Unit: unitless
Encoding: 16 bit unsigned scalar (Resolution: 1)
Range: 0 to 65535
Photometry sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_amb_light_level
¶ Present ambient light level
Channels:
Present Ambient Light Level
Unit: Lux
Encoding: 24 bit unsigned scalar (Resolution: 0.01 lx)
Range: 0 to 167772.13
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_cie_1931_chromaticity_coords
¶ Present CIE-1931 chromaticity coordinates
Channels:
Chromaticity x-coordinate
Unit: unitless
Encoding: 16 bit unsigned scalar (Resolution: 1/65536)
Range: 0 to 0.99998
Chromaticity y-coordinate
Unit: unitless
Encoding: 16 bit unsigned scalar (Resolution: 1/65536)
Range: 0 to 0.99998
Present correlated color temperature
Channels:
Present Correlated Color Temperature
Unit: Kelvin
Encoding: 16 bit unsigned scalar (Resolution: 1 K)
Range: 0 to 65533
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_illuminance
¶ Present illuminance
Channels:
Present Illuminance
Unit: Lux
Encoding: 24 bit unsigned scalar (Resolution: 0.01 lx)
Range: 0 to 167772.13
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_luminous_flux
¶ Present luminous flux
Channels:
Present Luminous Flux
Unit: Lumen
Encoding: 16 bit unsigned scalar (Resolution: 1 lm)
Range: 0 to 65533
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_planckian_distance
¶ Present planckian distance
Channels:
Present Planckian Distance
Unit: unitless
Encoding: 16 bit signed scalar (Resolution: 1/100000)
Range: -0.05 to 0.05
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_rel_exposure_time_in_an_illuminance_range
¶ Relative exposure time in an illuminance range
This sensor type supports series access. The series X-axis is measured in Lux.
Channels:
Relative value
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
Minimum Illuminance
Unit: Lux
Encoding: 24 bit unsigned scalar (Resolution: 0.01 lx)
Range: 0 to 167772.13
Maximum Illuminance
Unit: Lux
Encoding: 24 bit unsigned scalar (Resolution: 0.01 lx)
Range: 0 to 167772.13
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_tot_light_exposure_time
¶ Total light exposure time
Channels:
Total Light Exposure Time
Unit: Hours
Encoding: 24 bit unsigned scalar (Resolution: 0.1 hours)
Range: 0 to 1677721.3
Power supply output sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_avg_output_current
¶ Average output current
Channels:
Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_avg_output_voltage
¶ Average output voltage
Channels:
Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Sensing duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_output_current_range
¶ Output current range
This sensor type should be used as a sensor setting.
Channels:
Minimum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Maximum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_output_current_stat
¶ Output current statistics
Channels:
Average Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Standard Deviation Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Minimum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Maximum Electric Current Value
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
Sensing Duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_output_ripple_voltage_spec
¶ Output ripple voltage specification
Channels:
Output Ripple Voltage
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_output_voltage_range
¶ Output voltage range
This sensor type should be used as a sensor setting.
Channels:
Minimum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Maximum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_output_voltage_stat
¶ Output voltage statistics
Channels:
Average Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Standard Deviation Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Minimum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Maximum Voltage Value
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
Sensing Duration
Unit: Seconds
Encoding: 8 bit unsigned exponential time (pow(1.1, N - 64) seconds)
Range: 0 to 73216705
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_output_current
¶ Present output current
Channels:
Present Output Current
Unit: Ampere
Encoding: 16 bit unsigned scalar (Resolution: 0.01 A)
Range: 0 to 655.33
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_output_voltage
¶ Present output voltage
Channels:
Present Output Voltage
Unit: Volt
Encoding: 16 bit unsigned scalar (Resolution: 1/64 V)
Range: 0 to 1023.95
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_present_rel_output_ripple_voltage
¶ Present relative output ripple voltage
Channels:
Output Ripple Voltage
Unit: Percent
Encoding: 8 bit unsigned scalar (Resolution: 0.5 %)
Range: 0 to 100.0
Warranty and Service sensor types¶
-
const struct bt_mesh_sensor_type
bt_mesh_sensor_gain
¶ Sensor Gain
This sensor type should be used as a sensor setting.
Channels:
Sensor Gain
Unit: unitless
Encoding: 32 bit float