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.

amperage

Displays the current amperage.

Specifications

Examples of use

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

Alert

The current amperage value must be greater than or equal to 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "amperage",
    "unit": "unit.ampere"
  }
  ...
}

Examples of devices with the amperage function

battery_level

Displays the battery level.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "battery_level",
    "unit": "unit.percent"
  }
  ...
}

Examples of devices with the battery_level function

co2_level

Displays the carbon dioxide level reading.

Specifications

Examples of use

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

Alert

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

parameters object

Parameter	Type	Description
instance	String	Function name for the property. Acceptable values: `co2_level`.
unit	String	Function value units. Acceptable values: `unit.ppm`, measured in parts per million (ppm).

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "co2_level",
    "unit": "unit.ppm"
  }
  ...
}

Examples of devices with the co2_level function

electricity_meter

Displays the current electricity meter reading.

Specifications

Examples of use

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

Alert

The current electricity meter reading must be greater than or equal to 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "electricity_meter",
    "unit": "unit.kilowatt_hour"
  }
  ...
}

Examples of devices with the electricity_meter function

devices.types.smart_meter.electricity

food_level

Displays the food level reading.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "food_level",
    "unit": "unit.percent"
  }
  ...
}

Examples of devices with the food_level function

devices.types.pet_feeder

gas_meter

Displays the current gas meter reading.

Specifications

Examples of use

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

Alert

The current gas meter reading must be greater than or equal to 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "gas_meter",
    "unit": "unit.cubic_meter"
  }
  ...
}

Examples of devices with the gas_meter function

devices.types.smart_meter.gas

heat_meter

Displays the current heat meter reading.

Specifications

Examples of use

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

Alert

The current heat meter reading must be greater than or equal to 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "heat_meter",
    "unit": "unit.gigacalorie"
  }
  ...
}

Examples of devices with the heat_meter function

devices.types.smart_meter.heat

humidity

Displays the humidity reading.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "humidity",
    "unit": "unit.percent"
  }
  ...
}

Examples of devices with the humidity function

illumination

Displays the illumination level.

Specifications

Examples of use

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

Alert

The illumination value must be greater than 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "illumination",
    "unit": "unit.illumination.lux"
  }
  ...
}

Examples of devices with the illumination function

devices.types.sensor.illumination

meter

Displays the current universal meter reading.

Specifications

Examples of use

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

Alert

The current universal meter reading must be greater than or equal to 0.

parameters object

Parameter	Type	Description
instance	String	Function name for the property. Acceptable values: `meter`.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "meter"
  }
  ...
}

Examples of devices with the meter function

devices.types.smart_meter

pm1_density

Displays the level of air pollution with PM1 particles.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "pm1_density",
    "unit": "unit.density.mcg_m3"
  }
  ...
}

Examples of devices with the pm1_density function

pm2.5_density

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

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "pm2.5_density",
    "unit": "unit.density.mcg_m3"
  }
  ...
}

Examples of devices with the pm2.5_density function

pm10_density

Displays the level of air pollution with PM10 particles.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "pm10_density",
    "unit": "unit.density.mcg_m3"
  }
  ...
}

Examples of devices with the pm10_density function

power

Displays the current power consumption.

Specifications

Examples of use

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

Alert

The current power consumption must be greater than 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "power",
    "unit": "unit.watt"
  }
  ...
}

Examples of devices with the power function

pressure

Pressure display.

Specifications

Examples of use

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

Alert

The pressure value must be greater than 0.

parameters object

Parameter	Type	Description
instance	String	Function name for the property. Acceptable values: `pressure`.
unit	String	Function value units. Acceptable values: - `unit.pressure.atm`, measured in atmosphere. - `unit.pressure.pascal`, measured in pascals. - `unit.pressure.bar`, measured in bars. - `unit.pressure.mmhg`, measured in millimeters of mercury.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "pressure",
    "unit": "unit.pressure.mmhg"
  }
  ...
}

Examples of devices with the pressure function

temperature

Displays the temperature reading.

Specifications

Examples of use

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

parameters object

Parameter	Type	Description
instance	String	Function name for the property. Accepted values: `temperature`.
unit	String	Function value units. Acceptable values: - `unit.temperature.celsius`, measured in degrees Celsius. - `unit.temperature.kelvin`, measured in Kelvin.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "temperature",
    "unit": "unit.temperature.celsius"
  }
  ...
}

Examples of devices with the temperature function

tvoc

Displays the level of organic compounds in the air.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "tvoc",
    "unit": "unit.density.mcg_m3"
  }
  ...
}

Examples of devices with the tvoc function

voltage

Displays the current voltage.

Specifications

Examples of use

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

Alert

The current voltage value must be greater than 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "voltage",
    "unit": "unit.volt"
  }
  ...
}

Examples of devices with the voltage function

water_level

Displays the water level reading.

Specifications

Examples of use

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

Alert

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

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "water_level",
    "unit": "unit.percent"
  }
  ...
}

Examples of devices with the water_level function

water_meter

Displays the current water meter reading.

Specifications

Examples of use

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

Alert

The current water meter reading must be greater than or equal to 0.

parameters object

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

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "water_meter",
    "unit": "unit.cubic_meter"
  }
  ...
}

Examples of devices with the water_meter function

An array of elements separated by a comma. As array items, you can use standard JSON elements: a string, number, true, false, object, or array. Arrays are enclosed in square brackets []:

"cities": ["Moscow", "Tokyo", "New York"]

Was the article helpful?

Float

Event