Honeybee Query

Use This Skill When

• The user asks what exists in the model
• The user needs identifiers before editing
• The user needs geometry, topology, or area data
• The user needs Energy or Radiance inspection
• The user needs reusable Energy or Radiance resource inspection
• The user needs sensor grid or view inspection
• The user only needs counts

Preferred Tool

query

Description Unified query bus for Honeybee, Energy, and Radiance properties.

Args

• target_type: str

Allowed: model, room, face, aperture, door, subface, shade, schedule, schedule_day, schedule_type_limit, energy_resource, modifier, modifier_set, radiance_resource, sensor_grid, view

• identifiers: list | None = None

Optional identifier scope. Omit to query all objects of the target type.

• fields: list | None = None

Field names or nested attribute paths. Defaults to ["identifier", "display_name"].

• output_mode: str = "records"

Allowed: records, list, count

• resource_category: str | None = None

Used with aggregated resource targets such as energy_resource or radiance_resource.

Returns

• success: bool
• target_type: str
• count: int when relevant
• data: dict | list
• missing: list

Complete Field Reference

Model fields

Room fields

Face fields

Aperture fields

Door fields

Shade fields

Schedule fields

ScheduleDay fields

ScheduleTypeLimit fields

Modifier fields

ModifierSet fields

SensorGrid fields

View fields

Energy / Radiance nested path examples

Access deep properties using dot-separated paths:

• properties.energy.program_type.display_name
• properties.energy.program_type.identifier
• properties.energy.hvac.display_name
• properties.energy.construction.display_name
• properties.energy.construction.identifier
• properties.energy.construction_set.identifier
• properties.energy.is_conditioned
• properties.radiance.modifier_set.display_name
• properties.radiance.modifier_set.identifier
• properties.radiance.modifier.display_name
• properties.radiance.modifier.identifier

Examples

Model overview

query(
    target_type="model",
    fields=["identifier", "display_name", "rooms", "floor_area",
            "exterior_wall_area", "exterior_aperture_area"]
)

Count-only query

query(
    target_type="aperture",
    fields=["identifier"],
    output_mode="count"
)

Finding exterior walls by orientation

Use this pattern before adding apertures or assigning constructions:

query(
    target_type="face",
    fields=["identifier", "display_name", "type", "boundary_condition",
            "azimuth", "area", "aperture_ratio", "parent"],
    output_mode="list"
)

Then filter client-side for type == "Wall" and boundary_condition containing "Outdoors", and use azimuth to determine orientation (0=North, 90=East, 180=South, 270=West).

Face inspection before editing

query(
    target_type="face",
    identifiers=["Face_1", "Face_2"],
    fields=["identifier", "type", "boundary_condition", "area",
            "aperture_ratio", "has_sub_faces", "azimuth"]
)

Room Energy and Radiance inspection

query(
    target_type="room",
    identifiers=["Room_1"],
    fields=[
        "identifier",
        "properties.energy.program_type.display_name",
        "properties.energy.hvac.display_name",
        "properties.energy.construction_set.identifier",
        "properties.energy.is_conditioned",
        "properties.radiance.modifier_set.display_name"
    ]
)

Energy resource inspection

query(
    target_type="schedule",
    identifiers=["Office_Occ_Schedule"],
    fields=["identifier", "schedule_kind", "default_day_schedule",
            "schedule_type_limit", "holiday_schedule"],
    output_mode="list"
)

query(
    target_type="energy_resource",
    resource_category="constructions",
    fields=["identifier", "resource_category", "resource_source", "type"],
    output_mode="list"
)

ScheduleTypeLimit inspection

query(
    target_type="schedule_type_limit",
    identifiers=["Fractional"],
    fields=["identifier", "lower_limit", "upper_limit", "numeric_type", "unit_type"]
)

Radiance resource inspection

query(
    target_type="modifier",
    identifiers=["TestPlastic"],
    fields=["identifier", "modifier_type", "resource_source"],
    output_mode="list"
)

query(
    target_type="modifier_set",
    identifiers=["TestModSet"],
    fields=["identifier", "wall_set", "floor_set", "roof_ceiling_set",
            "aperture_set", "resource_source"]
)

SensorGrid and View inspection

query(
    target_type="sensor_grid",
    fields=["identifier", "sensor_count", "room_identifier"],
    output_mode="list"
)

query(
    target_type="view",
    fields=["identifier", "position", "direction", "up_vector", "view_type"],
    output_mode="list"
)

Aggregated Radiance resource overview

query(
    target_type="radiance_resource",
    fields=["identifier", "resource_category", "resource_source", "type"],
    output_mode="list"
)

Batch room reporting

query(
    target_type="room",
    fields=[
        "identifier",
        "display_name",
        "story",
        "floor_area",
        "volume",
        "properties.energy.program_type.display_name"
    ],
    output_mode="list"
)

Return Guidance

• For target_type="model", data is a single dict.
• For output_mode="records", data is identifier-keyed.
• For output_mode="list", data is a list of row dicts.
• For output_mode="count", use count directly.
• Inspect missing when identifiers are provided.
• For reusable resources, inspect resource_source to distinguish model_attached from session_store.

Workflow

1. Start broad with model summary fields.
2. Narrow scope using identifiers.
3. Use resource targets when the user is asking about schedules, constructions, modifiers, modifier sets, sensor grids, or views directly.
4. Add nested Energy or Radiance paths only when needed.
5. Query again after apply, add, or remove to confirm results.
6. Use azimuth/type/boundary_condition to help find specific faces when the user describes orientation or location rather than providing identifiers.