# Chirp Platform

## Chirp Wireless Docs

- [Chirp — Home Automation Platform](https://docs.chirpwireless.io/readme.md): See home sensors and cameras together, build useful automations, and receive alerts with Chirp and Lens.
- [First Steps](https://docs.chirpwireless.io/first-steps.md): Get started with Chirp — what you need and the LoRaWAN setup flow that takes you from unboxing to live sensor data.
- [Finding Your Way Around](https://docs.chirpwireless.io/first-steps/finding-your-way-around.md): Tour the Chirp interface — left menu, profile options, notification bell, home screen — find where everything lives.
- [Connect Your First Sensor](https://docs.chirpwireless.io/first-steps/connect-your-first-sensor.md): Hands-on guide to pair a gateway, register a LoRaWAN sensor, build a room dashboard, and set your first home alarm.
- [Applications](https://docs.chirpwireless.io/applications.md): Bring a complete home setup together in Chirp Applications, and see how planned templates will let dealers prepare solutions for your household.
- [Creating an Application](https://docs.chirpwireless.io/applications/creating-an-application.md): Make a named home setup in Chirp and give it a description that your household can recognize.
- [Organizing Content](https://docs.chirpwireless.io/applications/organizing-content.md): Put household devices, views, rules, and alarm definitions into the right Chirp application.
- [Using Application Dashboards](https://docs.chirpwireless.io/applications/using-application-dashboards.md): Open your home application’s dashboards and make changes in the original dashboard editor.
- [Deleting an Application](https://docs.chirpwireless.io/applications/deleting-an-application.md): Keep the household resources you still need before removing a Chirp application.
- [Overview](https://docs.chirpwireless.io/overview.md): Read your home at a glance — device and gateway status cards, notifications, and self-refreshing live readings.
- [Dashboards](https://docs.chirpwireless.io/dashboards.md): See your whole smart home at a glance — overview, custom dashboards, widgets, maps, and live sensor data.
- [Building a Dashboard](https://docs.chirpwireless.io/dashboards/building-a-dashboard.md): Create, rename, and delete a personalized Chirp dashboard with its own name, icon, and folder.
- [Adding Widgets](https://docs.chirpwireless.io/dashboards/adding-widgets.md): Add Chirp dashboard widgets for live sensor data, charts, controls, maps, images, text, and embedded pages.
- [Last Data Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget.md): Show the latest value from one or more sensors as a number, gauge, or ring — is the door open, how warm is the room?
- [Value Display](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget/number.md): Show a sensor's latest reading as a number, text, or on/off with the Value display in the Chirp Last Data widget.
- [Doughnut Display](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget/doughnut.md): Show a reading as a filling ring with the number in the middle — perfect for a tank, battery, or humidity level.
- [Pie Display](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget/pie.md): Show a reading as a bold filled circle that fills as the value rises — a chunkier take on the ring gauge.
- [Tube Display](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget/tube.md): Show a level as a filling cylinder, like a real tank — watch the salt, fuel, or rain barrel run low or rise too high.
- [Gauge Display](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget/gauge.md): Put a reading on a horizontal track with a sliding marker and colored bands, so you spot the moment it crosses a limit.
- [Radial Gauge Display](https://docs.chirpwireless.io/dashboards/adding-widgets/last-data-widget/radial-gauge.md): Show a Chirp reading on a round dial with the Radial Gauge — a needle, a sweep angle you choose, and colored zones.
- [Control Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget.md): Add a Control widget to a Chirp dashboard — a switch, button, slider, or input that operates a device from one tap.
- [Switch](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget/switch.md): Add a Switch Control to a Chirp dashboard to flip a home device on or off — a lamp, plug, or relay — with one tap.
- [Button](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget/button.md): Add a Button Control to a Chirp dashboard to run a one-tap device action — restart, run a scene, open — with a press.
- [Simple Slider](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget/slider-simple.md): Add a Simple Slider to a Chirp dashboard — a horizontal slider that sets a value like brightness by sliding.
- [Circular Slider](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget/slider-circular.md): Add a Circular Slider to a Chirp dashboard — a round dial that sets a value like color temperature by turning it.
- [Vertical Slider](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget/slider-vertical.md): Add a Vertical Slider to a Chirp dashboard — an upright slider that sets a value like a level you raise or lower.
- [Input](https://docs.chirpwireless.io/dashboards/adding-widgets/control-widget/input.md): Add an Input Control to a Chirp dashboard to send an exact value, like a thermostat target or color temperature.
- [Chart Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/chart-widget.md): Graph a reading's history over the hour, day, week, or month with color bands and a live current value.
- [Line Chart](https://docs.chirpwireless.io/dashboards/adding-widgets/chart-widget/line-chart.md): Set up a Chirp Line chart to follow a sensor trend with a current reading, average, and colored ranges.
- [Bar Chart](https://docs.chirpwireless.io/dashboards/adding-widgets/chart-widget/bar-chart.md): Build a Chirp Bar chart and show the exact sensor value on every bar for easier report-by-report comparison.
- [Text Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/text-widget.md): Add a household note, sensor list, or automation list to a Chirp dashboard using the Text widget.
- [Image Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/image-widget.md): Pin live sensor readings onto your own photo or floor plan, each colored by its conditions, with multi-layer views.
- [Map Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/map-widget.md): Show a GPS device's live position on an outdoor map with one reading on the marker and route history by date.
- [iFrame Widget](https://docs.chirpwireless.io/dashboards/adding-widgets/iframe-widget.md): Drop a live web page — a weather map, live traffic, or your calendar — onto a Chirp dashboard with the iFrame Widget.
- [Digital Building Twin](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin.md): Build a 3D model of your home and watch it light up with live sensor colors and readings, right on your dashboard.
- [Editor Tour](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/editor-tour.md): A quick walk around the 3D home editor — the toolbar, Scene panel, settings, floor buttons, and saving.
- [Drawing Your Home](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/drawing-your-building.md): Draw walls, doors, windows, and fences for your 3D home model in a flat 2D or full 3D view.
- [Importing a Floor Plan](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/importing-a-dxf-plan.md): Turn a DXF floor plan into walls for your 3D home — set the source unit and preview before importing.
- [Tracing from the Map](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/tracing-from-the-map.md): Click your home's outline on a satellite map to turn it into walls and save its real-world location.
- [Floors and Levels](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/floors-and-levels.md): Add upstairs, downstairs, and basement levels to your 3D home and switch between stacked and solo floor views.
- [Placing Objects](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/placing-objects.md): Drop furniture and objects into your 3D home, turn them as you place, and adjust position, scale, and rotation.
- [Object Library](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/object-catalog.md): Browse the 60-plus 3D objects for your home model — furniture, kitchen, bathroom, appliances, and outdoor items.
- [Connecting Sensors and Colors](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/binding-sensors-and-colors.md): Link a sensor reading to objects in your 3D home and set color rules so the door, room, or basement reacts live.
- [Pins and Live Readings](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/drop-pins-and-live-values.md): Pin a sensor's exact value into your 3D home, colored by its status, and show or hide every pin at once.
- [GPS Anchoring](https://docs.chirpwireless.io/dashboards/adding-widgets/digital-building-twin/gps-anchoring.md): Tie your 3D home model to real latitude and longitude, automatically from a map trace or by hand.
- [Conditions](https://docs.chirpwireless.io/dashboards/adding-widgets/conditions.md): Set per-metric color rules so a reading turns green, yellow, or red — green for comfortable, red for check it now.
- [Organizing Your Views](https://docs.chirpwireless.io/dashboards/organizing-your-views.md): Group dashboards into folders and drag-and-drop them so the views you use most sit right at the top.
- [Maps and Device Placement](https://docs.chirpwireless.io/dashboards/maps-and-device-placement.md): See where each sensor sits in your home on an interactive map and assign a room to put it on the map.
- [Tracking What Matters](https://docs.chirpwireless.io/dashboards/tracking-what-matters.md): Follow your car's recorded locations on a Chirp dashboard and keep its history together when you replace the GPS tracker.
- [Live Home Data](https://docs.chirpwireless.io/dashboards/live-home-data.md): How live sensor updates reach your screen, what the Live Data indicators mean, and what to check if data is missing.
- [Sharing Your Dashboard](https://docs.chirpwireless.io/dashboards/sharing-your-dashboard.md): Share a Chirp dashboard with a password-protected link — choose View or Control, then copy, regenerate, or revoke it.
- [Connectors](https://docs.chirpwireless.io/connectors.md): See how connections link your home sensors to Chirp over LoRaWAN, MQTT or a vehicle tracker — or use pretend sensors before any hardware arrives.
- [Setting Up a Connection](https://docs.chirpwireless.io/connectors/setting-up-a-connection.md): Create an LNS connection for LoRaWAN sensors, a Tracker connection for your vehicle, or an Emulator connection to start with no hardware.
- [LNS Connector](https://docs.chirpwireless.io/connectors/lns-connector.md): The LNS connector links your LoRaWAN sensors to Chirp's built-in network server — nothing to install.
- [What is LoRaWAN?](https://docs.chirpwireless.io/connectors/lns-connector/what-is-lorawan.md): Learn why LoRaWAN reaches every corner of your home and runs sensors for years on a single battery.
- [LoRaWAN Frequencies](https://docs.chirpwireless.io/connectors/lns-connector/lorawan-frequencies.md): Find the right LoRaWAN frequency band for your country before registering a sensor in Chirp.
- [Built-in Network Server](https://docs.chirpwireless.io/connectors/lns-connector/built-in-lns.md): Chirp's built-in LoRaWAN network server handles sensor authentication and delivery for you automatically.
- [Tracker Connector](https://docs.chirpwireless.io/connectors/tracker-connector.md): Connect a cellular GPS vehicle tracker to Chirp — OBD2, CAN bus, and standalone trackers, 2,000+ preconfigured models.
- [MQTT Connector](https://docs.chirpwireless.io/connectors/mqtt-connector.md): Bring Zigbee sensors, smart plugs, and DIY hardware into your home with the MQTT connector.
- [What MQTT is](https://docs.chirpwireless.io/connectors/mqtt-connector/what-is-mqtt.md): A friendly intro to MQTT brokers, topics, and JSON payloads — the messaging behind the smart home.
- [Cloud MQTT](https://docs.chirpwireless.io/connectors/mqtt-connector/cloud-mqtt.md): The simplest MQTT path — Chirp hosts the broker, you paste the credentials into Zigbee2MQTT and go.
- [External MQTT](https://docs.chirpwireless.io/connectors/mqtt-connector/external-mqtt.md): Point Chirp at a broker you already run at home — set up Mosquitto, expose it safely, and verify it.
- [Topics and Device Routing](https://docs.chirpwireless.io/connectors/mqtt-connector/topics-and-device-routing.md): Configure Chirp MQTT topic segments, payload identifiers, topic-value extraction and measurement mapping, with examples and validation.
- [Setting up Zigbee2MQTT](https://docs.chirpwireless.io/connectors/mqtt-connector/zigbee2mqtt.md): Install Zigbee2MQTT to bridge your Zigbee bulbs and sensors into Chirp through the MQTT connector.
- [Troubleshooting](https://docs.chirpwireless.io/connectors/mqtt-connector/troubleshooting.md): Fix MQTT data that isn't reaching Chirp — empty Logs, topic mismatches, and devices that won't publish.
- [Emulator Connector](https://docs.chirpwireless.io/connectors/emulator-connector.md): Try Chirp before your sensors arrive — pretend sensors that make up their own readings, so your dashboards and alerts are ready on day one.
- [Devices](https://docs.chirpwireless.io/devices.md): Learn how Chirp digital twins keep your car or home device's readings together when you replace its tracker or sensor.
- [Adding Sensors](https://docs.chirpwireless.io/devices/adding-sensors.md): Register a LoRaWAN, tracker, MQTT or pretend sensor in Chirp and map its readings, step by step.
- [LoRaWAN Devices](https://docs.chirpwireless.io/devices/lorawan-devices.md): Connect LoRaWAN sensors to Chirp digital twins: device profiles, keys, decoding, measurement mapping, commands and replacement.
- [MQTT Devices](https://docs.chirpwireless.io/devices/mqtt-devices.md): Connect MQTT equipment to Chirp digital twins, configure device routing, map readings, check history and replace hardware.
- [Pretend Sensors](https://docs.chirpwireless.io/devices/pretend-sensors.md): Make a pretend sensor in Chirp that invents its own readings, so your dashboards and alerts are ready before the real one arrives.
- [Data Templates](https://docs.chirpwireless.io/devices/data-templates.md): Create and manage the metrics that give readings from different home sensors consistent names, units, and data types in Chirp.
- [What Your Device Is Sending](https://docs.chirpwireless.io/devices/what-your-device-is-sending.md): See exactly what your sensor is reporting and in what form, and why the name Chirp shows you isn't the name inside the device's own messages.
- [Sensor Details](https://docs.chirpwireless.io/devices/sensor-details.md): Replace a car tracker or home sensor while keeping its digital device, reconnect measurements, and review retained readings.
- [Connection Diagnostics](https://docs.chirpwireless.io/devices/connection-diagnostics.md): Added a sensor but no readings appear? Read the Connection tab and get your data flowing.
- [Rooms](https://docs.chirpwireless.io/devices/rooms.md): Make Chirp devices easy to recognize by room using clear names, photos, applications, and dashboards.
- [Favorite Devices](https://docs.chirpwireless.io/devices/favorite-devices.md): Star the devices and gateways you check most in Chirp — saved and shown right on their cards for quick access.
- [Controlling Your Devices](https://docs.chirpwireless.io/devices/commands.md): Control your devices from Chirp — turn things on or off, dim lights, or just ask the AI Assistant to do it for you.
- [Setting up a command](https://docs.chirpwireless.io/devices/commands/creating-commands.md): Set up a device command in Chirp — name it, pick the device, add inputs like brightness, and test before you save.
- [Making sure it worked](https://docs.chirpwireless.io/devices/commands/verification.md): Tell Chirp how to confirm a command really worked — skip the check, wait for the next reading, or ask the device.
- [Sending a command](https://docs.chirpwireless.io/devices/commands/executing-commands.md): Send a command from the States tab in Chirp, fill in any values, and see whether it worked in your activity history.
- [Example: Switching a Lamp](https://docs.chirpwireless.io/devices/commands/lamp-example.md): Set up on and off commands for a smart lamp from start to finish, and have Chirp confirm the lamp really switched.
- [Tested Device Guides](https://docs.chirpwireless.io/devices/tested-device-guides.md): Hands-on walkthroughs for specific sensors and bulbs we paired end-to-end with Chirp at home.
- [Zigbee Devices](https://docs.chirpwireless.io/devices/tested-device-guides/zigbee.md): Zigbee bulbs and sensors we paired through a Zigbee2MQTT hub — pairing quirks and payload details.
- [Paulmann 50064 Light Bulb](https://docs.chirpwireless.io/devices/tested-device-guides/zigbee/paulmann-50064-light-bulb.md): Pair, register, and map the Paulmann 50064 tunable-white Zigbee bulb in Chirp, with all the quirks.
- [Cameras](https://docs.chirpwireless.io/lens.md): Bring compatible home cameras into Chirp and use selected-area motion with your household automations.
- [Installing Twin](https://docs.chirpwireless.io/lens/installing-twin.md): Set up a local Twin Docker container for each home camera and keep its settings between restarts.
- [Connecting a Camera](https://docs.chirpwireless.io/lens/connecting-a-camera.md): Link your home camera to Twin, then pair that Twin with the correct Chirp organization.
- [Provider Camera Sources](https://docs.chirpwireless.io/lens/connecting-cloud-camera-sources.md): Bring a supported account-based home camera into Chirp Lens through Twin, including Wyze, Ring, Roborock, and HomeKit setup.
- [Managing Cameras](https://docs.chirpwireless.io/lens/managing-cameras.md): Find a home camera, change its name, restore its Twin connection, or remove it from Chirp Lens.
- [RTSP Camera URLs](https://docs.chirpwireless.io/lens/rtsp-camera-urls.md): Find your camera brand’s RTSP address, local login requirements, and stream options to bring home camera feeds into Chirp Lens.
- [Watching Live Video](https://docs.chirpwireless.io/lens/watching-live-video.md): Check home cameras together in Chirp Lens and use supported sound or camera movement controls.
- [Videowalls](https://docs.chirpwireless.io/lens/videowalls.md): Save a home camera videowall in Chirp Lens, choose its feeds, and arrange a convenient view of the places you check most often.
- [Motion Zones](https://docs.chirpwireless.io/lens/motion-zones.md): Focus home-camera motion detection on a doorway or gate instead of everything in the picture.
- [Camera Rules and Alerts](https://docs.chirpwireless.io/lens/camera-rules-and-alerts.md): Make a Chirp rule respond to camera motion and use an alarm definition for the household notification.
- [Local Recordings](https://docs.chirpwireless.io/lens/local-recordings.md): Save and review home-camera clips on the computer running Twin, with limits to manage disk use.
- [Access and Troubleshooting](https://docs.chirpwireless.io/lens/access-and-troubleshooting.md): Check household camera access, reconnect Twin, and fix common Lens setup or viewing problems.
- [Gateways](https://docs.chirpwireless.io/gateways.md): Gateways bring your sensors into Chirp — choose between a LoRaWAN gateway and a Zigbee2MQTT hub.
- [LoRaWAN Gateways](https://docs.chirpwireless.io/gateways/lorawan-gateways.md): One small LoRaWAN gateway covers a whole home — learn how it works and how coverage spreads.
- [Setting Up a LoRaWAN Gateway](https://docs.chirpwireless.io/gateways/lorawan-gateways/setting-up-a-lorawan-gateway.md): Register your home gateway in Chirp, download its security certificate, and get it online in minutes.
- [Checking LoRaWAN Gateway Health](https://docs.chirpwireless.io/gateways/lorawan-gateways/checking-lorawan-gateway-health.md): Check whether your home gateway is online, see its uptime, and know when a dip is worth a look.
- [Compatible LoRaWAN Gateways](https://docs.chirpwireless.io/gateways/lorawan-gateways/compatible-lorawan-gateways.md): What to look for when buying a LoRaWAN gateway for your home — Basics Station, band, and placement.
- [Zigbee2MQTT Hubs](https://docs.chirpwireless.io/gateways/zigbee2mqtt-hubs.md): A Zigbee2MQTT hub — a small computer plus a coordinator — brings your Zigbee devices into Chirp.
- [Sonoff ZBDongle-E Coordinator](https://docs.chirpwireless.io/gateways/zigbee2mqtt-hubs/sonoff-zbdongle-e-coordinator.md): Plug in the Sonoff ZBDongle-E, confirm Linux sees it, and get ready to run your Zigbee2MQTT hub.
- [Alarm](https://docs.chirpwireless.io/alarm.md): See how Chirp turns sensor readings into home alerts, with an Inbox, alarm rules, and contact settings.
- [Set Up a Home Alert](https://docs.chirpwireless.io/alarm/set-up-a-home-alert.md): Create an alarm definition that sets severity, channels, schedule, and message for a home alert.
- [Escalation Chains](https://docs.chirpwireless.io/alarm/escalation-chains.md): Build a step-by-step chain so an unresolved home alert reaches more people until someone responds.
- [Notification Severity](https://docs.chirpwireless.io/alarm/notification-severity.md): Set the five severity levels and choose how often each one re-sends a reminder while an alarm stays active.
- [Check and Clear Alerts](https://docs.chirpwireless.io/alarm/check-and-clear-alerts.md): Review what fired in your Inbox, filter by severity or status, and resolve home alerts to stop escalation.
- [Manage Contact Methods](https://docs.chirpwireless.io/alarm/manage-contact-methods.md): Add and verify email and SMS contacts, then choose which channels deliver your home alerts.
- [Chirp Alerts App](https://docs.chirpwireless.io/alarm/chirp-alerts-app.md): Get Chirp alerts on your phone with the IoT Alerts app — critical alarms ring until you respond.
- [Getting Started](https://docs.chirpwireless.io/alarm/chirp-alerts-app/getting-started.md): Install IoT Alerts, pick Home Use, sign in to Chirp, and get your phone ready for alerts.
- [Alert Behavior](https://docs.chirpwireless.io/alarm/chirp-alerts-app/alert-behavior.md): Which alerts ring through on silent and which arrive quietly — set by the severity you choose.
- [Managing Alerts](https://docs.chirpwireless.io/alarm/chirp-alerts-app/managing-alerts.md): View, resolve, and quiet your home alerts from the app's Inbox and Alert Definitions tabs.
- [Rules engine](https://docs.chirpwireless.io/rules-engine.md): Let your home act on its own — automations that watch your sensors and respond, from an alert to flipping a switch.
- [Triggers](https://docs.chirpwireless.io/rules-engine/triggers.md): Understand how a trigger watches your home sensors, detects a condition, and starts an automation that can alert you or operate a device.
- [Trigger Timing](https://docs.chirpwireless.io/rules-engine/triggers/trigger-timing.md): Choose when a Chirp trigger reacts, learn what interrupts its wait, and decide when an active condition returns to normal.
- [Use a Trigger with Multiple Devices](https://docs.chirpwireless.io/rules-engine/triggers/multiple-devices.md): Watch several home devices with one Chirp trigger, keep their waits separate, and use a shared reading when the condition needs it.
- [Your First Automation](https://docs.chirpwireless.io/rules-engine/your-first-automation.md): A ten-minute tutorial to build your first automation — a basement humidity alert, from blank canvas to working rule.
- [Create an Automation](https://docs.chirpwireless.io/rules-engine/your-first-automation/create-an-automation.md): Open the editor, name an automation, choose a Sensor reading or Trigger condition start, and save the first version.
- [Add Conditions and Branches](https://docs.chirpwireless.io/rules-engine/your-first-automation/add-conditions-and-branches.md): Add a Script Task and a gateway so your automation classifies a reading and sends it down the right path.
- [Send Alerts and Run Actions](https://docs.chirpwireless.io/rules-engine/your-first-automation/trigger-alarms-and-actions.md): Add a Set Alarm node and a motivation message so your automation notifies you when the basement gets too humid.
- [Going Deeper](https://docs.chirpwireless.io/rules-engine/going-deeper.md): Build Chirp automations with saved triggers, several devices, enriched readings, expressions, and controlled deployment.
- [Data Enrichment and Expressions](https://docs.chirpwireless.io/rules-engine/going-deeper/data-enrichment-and-expressions.md): Combine readings from several sensors, transform them with CEL, and handle offline sensors with a fallback path.
- [Publish and Run](https://docs.chirpwireless.io/rules-engine/going-deeper/publish-and-run-an-automation.md): Take an automation live — build it, deploy the artifact, stop it when needed, and read the Artifacts tab.
- [Managing Automations](https://docs.chirpwireless.io/rules-engine/managing-automations.md): Stay in control of your automations — version history, editing locks, trash, and easy recovery when you need it.
- [View, Edit, and Locks](https://docs.chirpwireless.io/rules-engine/managing-automations/view-edit-and-locks.md): See how view and edit modes work, how locks stop household members clashing, and how autosave protects you.
- [History, Restore, and Recovery](https://docs.chirpwireless.io/rules-engine/managing-automations/history-restore-and-recovery.md): Browse every saved version of an automation, name your milestones, and roll back to a known-good version anytime.
- [Trash and Restore](https://docs.chirpwireless.io/rules-engine/managing-automations/trash-and-restore.md): Deleted an automation by mistake? It waits in the Trash — find it, bring it back, and learn how long it's kept.
- [Examples](https://docs.chirpwireless.io/rules-engine/examples.md): Ready-to-adapt smart home automation ideas for comfort, energy, and safety — copy a pattern and make it your own.
- [Home Comfort and Energy](https://docs.chirpwireless.io/rules-engine/examples/home-comfort-and-energy.md): Build automations that keep rooms comfortable — temperature zones, garden moisture, and wine cellar climate alerts.
- [Safety and Alerting](https://docs.chirpwireless.io/rules-engine/examples/safety-and-alerting.md): Catch trouble fast with leak, door, garage, and freezer automations that alert the moment something looks wrong.
- [Reference](https://docs.chirpwireless.io/rules-engine/reference.md): Look up how nodes, CEL expressions, the visual editor, and build errors work when building home automations.
- [Rules Page and Tabs](https://docs.chirpwireless.io/rules-engine/reference/rules-page-and-tabs.md): A tour of the Rules page — Rules, Triggers, Artifacts, and Trash, plus the actions on each automation row.
- [Visual Editor](https://docs.chirpwireless.io/rules-engine/reference/visual-editor.md): Find your way around the automation editor — the header bar, canvas, node palette, and properties sidebar.
- [Debugging Automations](https://docs.chirpwireless.io/rules-engine/reference/debugging-automations.md): Step through an automation with debug mode — feed it a test reading, set breakpoints, and watch the values change.
- [Automation Node Guide](https://docs.chirpwireless.io/rules-engine/reference/automation-node-guide.md): Every automation node — Gateway, Script Task, Set Alarm, Execute Command, Enrichment — its fields and runtime behavior.
- [When an Automation Runs a Command](https://docs.chirpwireless.io/rules-engine/reference/automation-runs-a-command.md): Let a Chirp automation act on its own — the Execute Command step sends a device a command when conditions are met.
- [CEL for Home Automations](https://docs.chirpwireless.io/rules-engine/reference/cel-for-home-automations.md): A friendly CEL guide for home rules — sensor variables, comparisons, math, text, and building clear alarm messages.
- [Fixing Builds and Runtime Stops](https://docs.chirpwireless.io/rules-engine/reference/fixing-builds-and-runtime-stops.md): Decode build errors, understand deploy and stop, and recover an automation that the system force-stopped.
- [AI Assistant](https://docs.chirpwireless.io/ai-assistant.md): An experienced integrator by your side for your smart home. Let Chirp’s AI Assistant add sensors, build automations, and configure alerts.
- [Talking to Your Home](https://docs.chirpwireless.io/ai-assistant/talking-to-your-home.md): Ask the Chirp AI Assistant about your home — live readings, history, and charts — plus tips for the best answers.
- [Let the Assistant Set It Up](https://docs.chirpwireless.io/ai-assistant/let-ai-set-it-up.md): Tell Chirp’s AI Assistant what you want your home to do, and let it add sensors, build automations, and configure alerts with you.
- [What It Knows](https://docs.chirpwireless.io/ai-assistant/what-it-knows.md): How Chirp’s AI Assistant uses your home setup, device information, and guides to add sensors, build automations, and answer questions.
- [Your Chats and Your Own AI](https://docs.chirpwireless.io/ai-assistant/chats-and-your-own-ai.md): Start a new chat, find past conversations, see how many requests you have left, and connect your own AI key in Chirp.
- [Your Privacy](https://docs.chirpwireless.io/ai-assistant/your-privacy.md): Understand what Chirp saves in AI conversations, what reaches a model provider, and how to request deletion or account closure.
- [Records & Reports](https://docs.chirpwireless.io/reports.md): Track who has access to your Chirp home, and keep your sensors' join codes safe in an encrypted vault.
- [Activity Log](https://docs.chirpwireless.io/reports/audit-trail.md): See and filter every membership change in your Chirp home — invites, joins, permission updates, and removals.
- [Key Vault](https://docs.chirpwireless.io/reports/key-vault.md): Store your sensors' DevEUI and AppKey codes in an encrypted vault in your Chirp home — no more hunting for stickers.
- [API](https://docs.chirpwireless.io/api.md): Get programmatic access to your home's sensor data for scripts, spreadsheets, and smart-home integrations.
- [REST API](https://docs.chirpwireless.io/api/public-rest-api.md): Connect your scripts and tools to Chirp over HTTPS with a scoped API key — manage sensors, dashboards, and automations.
- [gRPC API](https://docs.chirpwireless.io/api/grpc-api.md): Learn when the advanced gRPC interface is worth it over REST for typed, on-premise Chirp integrations.
- [MCP Server](https://docs.chirpwireless.io/api/mcp-server.md): Connect your favorite AI app straight to your Chirp home with MCP — sign in, no API key needed.
- [Authentication & API Keys](https://docs.chirpwireless.io/api/authentication-and-api-keys.md): Authenticate Chirp API requests with an API key, its allowed scopes, and the required matching X-Organization-Id header.
- [Examples](https://docs.chirpwireless.io/api/examples.md): Make an authenticated Chirp REST request with curl, an API key, and its home identifier to list accessible devices.
- [Settings](https://docs.chirpwireless.io/settings.md): Manage your profile, sensor rooms and locations, and API keys from the Chirp Settings section.
- [Profile](https://docs.chirpwireless.io/settings/profile-settings.md): Update the name and photo other household members see, and review your account email in Chirp.
- [Rooms and Locations](https://docs.chirpwireless.io/settings/locations.md): Organize sensors by room and area to mirror your home, making dashboards and readings easier to find.
- [API Keys](https://docs.chirpwireless.io/settings/api-keys.md): Create scoped API keys to connect Chirp to your scripts and tools, and revoke or rotate them anytime.
- [Help](https://docs.chirpwireless.io/get-help.md): Reach the Chirp support team — fill out the built-in contact form with your subject, email, and details.
- [Account](https://docs.chirpwireless.io/account.md): Manage household members, your subscription, and home settings from the user menu in Chirp.
- [Subscription](https://docs.chirpwireless.io/account/subscription.md): Pick a Chirp plan, see what each tier includes, upgrade or manage billing, and top up SMS credits — all in one place.
- [Household Members](https://docs.chirpwireless.io/account/users-and-permissions.md): Set per-section access for every household member so each person sees only what matters to them.
- [Inviting Members](https://docs.chirpwireless.io/account/inviting-members.md): Invite people to your Chirp home and pick which sensors, dashboards, and automations they can use.
- [Accepting Invitations](https://docs.chirpwireless.io/account/accepting-invitations.md): Join someone's Chirp home from the email link, and learn how membership and ownership invitations differ.
- [Managing Access](https://docs.chirpwireless.io/account/managing-access.md): Update what each household member can see and do, or remove someone from your Chirp home.
- [Home Settings](https://docs.chirpwireless.io/account/organization-settings.md): Rename your Chirp home or hand ownership to someone else, available only to the home owner.
- [Switching Homes](https://docs.chirpwireless.io/account/switching-organizations.md): Move between multiple Chirp homes, like your house and a cabin, without signing out.
- [Changelog](https://docs.chirpwireless.io/changelog.md): Chirp changelog — Flight Log entries for every release, with feature highlights and links to the matching guides.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.chirpwireless.io/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.