Areas¶
An area (server name: sublocation) is a physical sub-region inside a
Site. Areas contain Floorplans, placed
Anchors, and Zones.
Quick reference¶
| Method | What it does |
|---|---|
client.areas.list() |
All areas visible to the current scope. |
client.areas.get(uid) |
Fetch one area by uid; raises NotFound if absent. |
client.areas.create(name, *, site_uid, **fields) |
Create an area inside site_uid (the parent site). |
client.areas.update(uid, **fields) |
Update; free-form fields. |
client.areas.delete(uid) |
Delete; cascades server-side to floorplans, anchors, zones. |
Reading and writing¶
areas = client.areas.list()
area = client.areas.create(name="Bay 3", site_uid=site.uid)
client.areas.update(area.uid, description="freezer", offset_x=10)
client.areas.delete(area.uid)
update does not enforce an allowlist — the desktop site-plan client
sends arbitrary placement fields (offset_x, offset_y, offset_z)
freely, and the SDK passes them through.
Model — Area¶
| Field | Type | Notes |
|---|---|---|
uid |
str |
Server-assigned. |
name |
str |
Display name. |
site_uid |
str |
Parent site uid. |
description |
str \| None |
Free-form. |
offset_x / offset_y / offset_z |
int \| None |
Placement offset on the parent site. |
Related entities¶
- Parent: Sites.
client.areas.create(site_uid=site.uid). - Children: Floorplans, Anchors, Zones.
- Alarms:
client.alarms.list_for_area(uid=...).
See also¶
- Sites — the parent and the cascade contract.