Get Areas and Current State

This query returns area names, light levels, and types for all exposed areas for a specified serial number. Exposed areas are those with a numerical Display Order provided in the PMMI config file spreadsheet. Areas will be returned in Display Order.

Developer info

API endpoint slug: pmmi_lighting.areas
Runtime method: performQuery("pmmi_lighting.areas")

Query fields

Serial number Dropdown list

Label: Serial number?
Slug: serialNumber
Required: true
Can have default value: false

Ingredients

NameThis field contains the Area name defined in PMMI configuration spreadsheet.

Slug: name
Filter code: PmmiLighting.areas.Name
Type: String
Example: https://www.pmmi-lighting.com

LevelThis field returns the current area light level between 0 and 100%.

Slug: level
Filter code: PmmiLighting.areas.Level
Type: String
Example: https://www.pmmi-lighting.com

TypeThis field returns the area type. Options are NORMAL for dimmable areas, TOGGLE ONLY for on/off areas, and DAYLIGHT HARVESTING for areas who's light level is automatically controlled.

Slug: type
Filter code: PmmiLighting.areas.Type
Type: String
Example: https://www.pmmi-lighting.com