MQTT
At a glance
Section titled “At a glance”Getting started
Section titled “Getting started”- Ensure OpenApp can reach your MQTT broker.
- In OpenApp, create an integration with provider type
mqttand set the config fields below. - For each OpenApp entity, set entity metadata describing how to publish commands (topics + payloads).
- Verify by triggering an OpenApp action and watching your broker logs.
Setup reference
Section titled “Setup reference”Config
Section titled “Config”| Field | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
| broker_host | string | required | Hostname or IP address of the MQTT broker. | — | mqtt.local |
| broker_port | number | optional | MQTT broker port. | 1883 | 1883 |
Entity metadata (per entity)
Section titled “Entity metadata (per entity)”| Field | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
| command_topic | string | required | MQTT topic OpenApp will publish commands to for this entity. | — | openapp/garage/command |
| open_payload | string | optional | Payload to publish for an open/on command. | ON | OPEN |
| close_payload | string | optional | Payload to publish for a close/off command. | OFF | CLOSE |
| toggle_payload | string | optional | Payload to publish for a toggle command. | TOGGLE | TOGGLE |
Policies
Policies restrict access on top of roles — they never grant it. The following apply to this integration:
Invitation curfew
Blocks invitation-based opens during a forbidden time window (for example nights).
Invitation curfew
Blocks invitation-based opens during a forbidden time window (for example nights).
Admins and residents are never curfewed; existing invitations are evaluated live, not modified.
- Type
- invitation_curfew
- Enforced at
- Access-time
- Tiers
- OrgIntegration
- Default
- Not configured — no hour restrictions on invitation-based access.
- Enforcement
- Enforce
User sharing control
Restricts whether non-admins may share access or create invitations out of band — block outright or require admin approval.
User sharing control
Restricts whether non-admins may share access or create invitations out of band — block outright or require admin approval.
- Type
- user_sharing
- Enforced at
- Authoring-time
- Tiers
- OrgIntegration
- Default
- Not configured — non-admins may share access freely.
- Enforcement
- EnforceRequire approval