List of functions

The float property has functions. Functions have parameters that let you describe the properties for the device.

Function Description
amperage

Displays the current amperage.

battery_level

Displays the battery level.

co2_level

Displays the carbon dioxide level readings.

electricity_meter

Displays the current electricity meter readings.

food_level

Displays the food level readings.

gas_meter

Displays the current gas meter readings.

heat_meter

Displays the current heat meter readings.

humidity

Displays the humidity readings.

illumination

Displays the illumination level.

meter

Displays the current universal meter readings.

pm1_density

Displays the level of air pollution with PM1 particles.

pm2.5_density

Displays the level of air pollution with PM2.5 particles.

pm10_density

Displays the level of air pollution with PM10 particles.

power

Displays the current power consumption.

pressure

Pressure display.

temperature

Displays the temperature readings.

tvoc

Displays the level of organic compounds in the air.

voltage

Displays the current voltage.

water_level

Displays the water level readings.

water_meter

Displays the current water meter readings.

Function Description
amperage

Displays the current amperage.

battery_level

Displays the battery level.

co2_level

Displays the carbon dioxide level readings.

electricity_meter

Displays the current electricity meter readings.

food_level

Displays the food level readings.

gas_meter

Displays the current gas meter readings.

heat_meter

Displays the current heat meter readings.

humidity

Displays the humidity readings.

illumination

Displays the illumination level.

meter

Displays the current universal meter readings.

pm1_density

Displays the level of air pollution with PM1 particles.

pm2.5_density

Displays the level of air pollution with PM2.5 particles.

pm10_density

Displays the level of air pollution with PM10 particles.

power

Displays the current power consumption.

pressure

Pressure display.

temperature

Displays the temperature readings.

tvoc

Displays the level of organic compounds in the air.

voltage

Displays the current voltage.

water_level

Displays the water level readings.

water_meter

Displays the current water meter readings.

amperage

Displays the current amperage.

Below is the description of the parameters object from the Property description section.

Attention.

The current amperage value must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: amperage.
unit String Function value units. Acceptable values: unit.ampere measured in amperes.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: amperage.
unit String Function value units. Acceptable values: unit.ampere measured in amperes.

battery_level

Displays the battery level.

Below is the description of the parameters object from the Property description section.

Attention.

The value of the current battery level must be in the range [0; 100].

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: battery_level.
unit String Function value units. Acceptable values: unit.percent (percentage).
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: battery_level.
unit String Function value units. Acceptable values: unit.percent (percentage).

co2_level

Displays the carbon dioxide level readings.

Below is the description of the parameters object from the Property description section.

Attention.

The value of the current carbon dioxide reading must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: co2_level.
unit String Function value units. Acceptable values: unit.ppm measured in ppm (ppm — parts per million).
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: co2_level.
unit String Function value units. Acceptable values: unit.ppm measured in ppm (ppm — parts per million).

electricity_meter

Displays the current electricity meter readings.

Below is the description of the parameters object from the Property description section.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: electricity_meter.
unit String Function value units. Acceptable values: unit.kilowatt_hour, measured in kilowatt-hours.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: electricity_meter.
unit String Function value units. Acceptable values: unit.kilowatt_hour, measured in kilowatt-hours.

food_level

Displays the food level readings.

Below is the description of the parameters object from the Property description section.

Attention.

The value of the food level reading must be in the range [0; 100].

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: food_level.
unit String Function value units. Acceptable values: unit.percent (percentage).
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: food_level.
unit String Function value units. Acceptable values: unit.percent (percentage).

gas_meter

Displays the current gas meter readings.

Below is the description of the parameters object from the Property description section.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: gas_meter.
unit String Function value units. Acceptable values: unit.cubic_meter, measured in cubic meters.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: gas_meter.
unit String Function value units. Acceptable values: unit.cubic_meter, measured in cubic meters.

heat_meter

Displays the current heat meter readings.

Below is the description of the parameters object from the Property description section.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: heat_meter.
unit String Function value units. Acceptable values: unit.gigacalorie, measured in gigacalories.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: heat_meter.
unit String Function value units. Acceptable values: unit.gigacalorie, measured in gigacalories.

humidity

Displays the humidity readings.

Below is the description of the parameters object from the Property description section.

Attention.

The value of the current humidity reading must be in the range [0; 100].

parameters object
Parameter Type Description
instance String Function name for a property. Accepted values: humidity.
unit String Function value units. Acceptable values: unit.percent (percentage).
parameters object
Parameter Type Description
instance String Function name for a property. Accepted values: humidity.
unit String Function value units. Acceptable values: unit.percent (percentage).

illumination

Displays the illumination level.

Below is the description of the parameters object from the Property description section.

Attention.

The illumination value must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: illumination.
unit String Function value units. Acceptable values: unit.illumination.lux measured in lux.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: illumination.
unit String Function value units. Acceptable values: unit.illumination.lux measured in lux.

meter

Displays the current universal meter readings.

Below is the description of the parameters object from the Property description section.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: meter.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: meter.

pm1_density

Displays the level of air pollution with PM1 particles.

Below is the description of the parameters object from the Property description section.

Attention.

The current reading of PM1 particle pollution must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pm1_density.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pm1_density.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.

pm2.5_density

Displays the level of air pollution with PM2.5 particles.

Below is the description of the parameters object from the Property description section.

Attention.

The current reading of PM2.5 particle pollution must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pm2.5_density.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pm2.5_density.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.

pm10_density

Displays the level of air pollution with PM10 particles.

Below is the description of the parameters object from the Property description section.

Attention.

The current reading of PM10 particle pollution must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pm10_density.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pm10_density.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.

power

Displays the current power consumption.

Below is the description of the parameters object from the Property description section.

Attention.

The current power consumption must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: power.
unit String Function value units. Acceptable values: unit.watt measured in watts.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: power.
unit String Function value units. Acceptable values: unit.watt measured in watts.

pressure

Pressure display.

Below is the description of the parameters object from the Property description section.

Attention.

The pressure value must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pressure.
unit String Function value units. Acceptable values:
  • unit.pressure.atm — Measured in atmospheres.
  • unit.pressure.pascal — Measured in pascals.
  • unit.pressure.bar — Measured in bars.
  • unit.pressure.mmhg — Measured in millimeters of mercury.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: pressure.
unit String Function value units. Acceptable values:
  • unit.pressure.atm — Measured in atmospheres.
  • unit.pressure.pascal — Measured in pascals.
  • unit.pressure.bar — Measured in bars.
  • unit.pressure.mmhg — Measured in millimeters of mercury.

temperature

Displays the temperature readings.

Below is the description of the parameters object from the Property description section.

parameters object
Parameter Type Description
instance String Function name for a property. Accepted values: temperature.
unit String Function value units. Acceptable values:
  • unit.temperature.celsius — Measured in degrees Celsius.
  • unit.temperature.kelvin — Measured in kelvins.
parameters object
Parameter Type Description
instance String Function name for a property. Accepted values: temperature.
unit String Function value units. Acceptable values:
  • unit.temperature.celsius — Measured in degrees Celsius.
  • unit.temperature.kelvin — Measured in kelvins.

tvoc

Displays the level of organic compounds in the air.

Below is the description of the parameters object from the Property description section.

Attention.

The current reading of organic compounds in the air must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: tvoc.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: tvoc.
unit String Function value units. Acceptable values: unit.density.mcg_m3 measured in mcg/m3.

voltage

Displays the current voltage.

Below is the description of the parameters object from the Property description section.

Attention.

The current voltage value must be greater than 0.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: voltage.
unit String Function value units. Acceptable values: unit.volt measured in volts.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: voltage.
unit String Function value units. Acceptable values: unit.volt measured in volts.

water_level

Displays the water level readings.

Below is the description of the parameters object from the Property description section.

Attention.

The value of the water level reading must be in the range [0; 100].

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: water_level.
unit String Function value units. Acceptable values: unit.percent (percentage).
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: water_level.
unit String Function value units. Acceptable values: unit.percent (percentage).

water_meter

Displays the current water meter readings.

Below is the description of the parameters object from the Property description section.

parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: water_meter.
unit String Function value units. Acceptable values: unit.cubic_meter, measured in cubic meters.
parameters object
Parameter Type Description
instance String Function name for a property. Acceptable values: water_meter.
unit String Function value units. Acceptable values: unit.cubic_meter, measured in cubic meters.

Support