# docs

## docs

- [Ruuvi Developer Documentation](https://docs.ruuvi.com/readme.md): Lifecycle: Beta. This documentation collects the most important resources for developers into one place
- [RuuviTag B](https://docs.ruuvi.com/ruuvi-hardware/ruuvitag-b.md): Lifecycle: In production
- [RuuviTag Pro](https://docs.ruuvi.com/ruuvi-hardware/ruuvitag-pro.md): Lifecycle: in Beta
- [Ruuvi Air](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-air.md)
- [Ruuvi Gateway](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-gateway.md): Lifecycle: In Production
- [Ruuvi DevShield](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-devshield.md): DevShield User Manual
- [TMP 117 External Sensor](https://docs.ruuvi.com/ruuvi-hardware/tmp-117-external-sensor.md)
- [Ruuvi Connector System](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-connector-system.md): Lifecycle: in production
- [Ruuvi Connector Kit](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-connector-system/ruuvi-connector-kit.md)
- [Expansion boards](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-connector-system/expansion-boards.md): Lifecycle: proposal
- [Cables](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-connector-system/cables.md): Lifecycle: proposal
- [Connectors](https://docs.ruuvi.com/ruuvi-hardware/ruuvi-connector-system/connectors.md): Lifecycle: Proposal
- [1.2.12](https://docs.ruuvi.com/ruuvi-firmware/1.2.12.md): Lifecycle: Obsolote
- [2.5.9](https://docs.ruuvi.com/ruuvi-firmware/2.5.9.md)
- [3.X](https://docs.ruuvi.com/ruuvi-firmware/3.x.md): Lifecycle: Alpha. Last updated 2020-09-10
- [3.x Sensors](https://docs.ruuvi.com/ruuvi-firmware/3.x/3.x-sensors.md): Lifecycle: in production
- [3.x Heartbeat](https://docs.ruuvi.com/ruuvi-firmware/3.x/3.x-heartbeat.md): Lifecycle: in production
- [Device Firmware Update (DFU)](https://docs.ruuvi.com/ruuvi-firmware/device-firmware-update-dfu.md): Lifecycle: In production
- [Air 1st Stage Bootloader](https://docs.ruuvi.com/ruuvi-air-firmware/air-1st-stage-bootloader.md)
- [Air 2nd Stage Bootloader](https://docs.ruuvi.com/ruuvi-air-firmware/air-2nd-stage-bootloader.md)
- [Air Firmware Loader](https://docs.ruuvi.com/ruuvi-air-firmware/air-firmware-loader.md)
- [Air Main Firmware](https://docs.ruuvi.com/ruuvi-air-firmware/air-main-firmware.md)
- [Ruuvi Indoor Air Quality Score (IAQS)](https://docs.ruuvi.com/ruuvi-air-firmware/ruuvi-indoor-air-quality-score-iaqs.md)
- [GW Getting Started](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-getting-started.md)
- [GW Web-UI](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages.md)
- [Greeting window](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/greeting-window.md)
- [Internet connection settings](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/internet-connection-settings.md)
- [Connection via Wi-Fi](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/internet-connection-settings/connection-via-wi-fi.md)
- [Connection via Ethernet](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/internet-connection-settings/connection-via-ethernet.md)
- [Software update](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/software-update.md)
- [Automatic configuration download](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/automatic-configuration-download.md)
- [Automatic updates](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/automatic-updates.md)
- [Access Settings from LAN](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/access-settings-from-lan.md)
- [Cloud Options](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/cloud-options.md)
- [Backend: HTTP(s)](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/cloud-options/backend-http-s.md)
- [Backend: MQTT(s)](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/cloud-options/backend-mqtt-s.md)
- [Backend: Statistics](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/cloud-options/backend-statistics.md)
- [Time Synchronisation Options](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/time-synchronisation-options.md)
- [Bluetooth Scanning Settings](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/bluetooth-scanning-settings.md)
- [Configuration completion](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/configuration-completion.md)
- [Authentication when accessing from LAN](https://docs.ruuvi.com/ruuvi-gateway-firmware/gateway-html-pages/auth.html.md)
- [GW nRF52811 Firmware](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-nrf52-firmware.md)
- [GW nRF52811 selftest](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-nrf52-firmware/gw-nrf52811-selftest.md): Lifecycle: Alpha. Last updated 2021-04-15
- [GW nRF52811 scanning](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-nrf52-firmware/gw-nrf52811-scanning.md)
- [GW nRF52811 repeating](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-nrf52-firmware/gw-nrf52811-repeating.md): Lifecycle: proposal. Last updated 2021-04-15
- [GW nRF52811 UART communication](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-nrf52-firmware/gw-nrf52811-uart-communication.md)
- [GW ESP32 Firmware](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-esp32-firmware.md): Lifecycle: Beta. Last updated 2021-04-15
- [GW ESP32 WiFi Hotspot](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-esp32-firmware/gw-esp32-wifi-hotspot.md)
- [GW ESP32 Button](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-esp32-firmware/gw-esp32-button.md)
- [GW ESP32 LED](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-esp32-firmware/gw-esp32-led.md): Lifecycle: proposal
- [GW ESP32 HTTP Client](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-esp32-firmware/gw-esp32-http-client.md): Lifecycle: Alpha. Last updated 2020-07-03
- [GW ESP32 MQTT client](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-esp32-firmware/gw-esp32-mqtt-client.md): Lifecycle: Alpha
- [GW Data formats](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats.md): This page contains descriptions of the data formats that are used when communicating with Ruuvi gateway.
- [HTTP: Time-stamped data from Bluetooth-sensors](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/http-time-stamped-data-from-bluetooth-sensors.md): Relaying of accumulated time-stamped data from Bluetooth-sensors to HTTP/HTTPS server.
- [HTTP: Data from Bluetooth-sensors without timestamps](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/http-data-from-bluetooth-sensors-without-timestamps.md): Relaying of accumulated Bluetooth data (without timestamps) to HTTP/HTTPS server.
- [MQTT: Time-stamped data from Bluetooth-sensors](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/mqtt-time-stamped-data-from-bluetooth-sensors.md): Immediate relaying of Bluetooth data (with timestamps) to MQTT server.
- [MQTT: Data from Bluetooth-sensors without timestamps](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/mqtt-data-from-bluetooth-sensors-without-timestamps.md): Immediate relaying of Bluetooth data (without timestamps) to MQTT server.
- [HTTP GET /history (with timestamps) and decoding](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/http-get-history-with-timestamps-and-decoding.md): Format of time-stamped data returned in response to HTTP request GET /history
- [HTTP: Gateway status](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/http-gateway-status.md): Data format describing Gateway operation status
- [Gateway configuration](https://docs.ruuvi.com/ruuvi-gateway-firmware/data-formats/gateway-configuration.md): This format is used both for storing the gateway configuration and for reading/writing it.
- [GW Examples](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples.md)
- [Polling mode](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/polling-mode.md)
- [Poll endpoint "/metrics"](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/poll-endpoint-metrics.md)
- [Configuration update via API](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/configuration-update-via-api.md)
- [Firmware update via API](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/firmware-update-via-api.md)
- [Configuration download from a remote server via API](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/configuration-download-from-a-remote-server-via-api.md)
- [MQTT examples](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/mqtt-examples.md)
- [Home Assistant](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/home-assistant.md)
- [MQTT+AWS IoT Core](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/mqtt+aws-iot-core.md)
- [GW open ports / services](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-open-ports-services.md): Lifecycle: in production
- [GW Install custom firmware](https://docs.ruuvi.com/ruuvi-gateway-firmware/gw-install-custom-firmware.md): If you want to install a custom firmware or a previous version of Ruuvi Gateway firmware, you can do this using Web-UI.
- [Bluetooth advertisements](https://docs.ruuvi.com/communication/bluetooth-advertisements.md): Lifecycle: In production
- [Data format 3 (RAWv1)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-3-rawv1.md): Lifecycle: Deprecated
- [Data format 4 (URL)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-4-url.md): Lifecycle: Obsolete
- [Data format 5 (RAWv2)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-5-rawv2.md): Lifecycle: In Production
- [Data format C5 (Cut-RAWv2)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-c5-rawv2.md): Lifecycle: Beta. Last updated 2024-01-30
- [Data format 6](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-6.md): Lifecycle: In Production
- [Data format 8 (Encrypted environmental)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-8-encrypted-environmental.md): Lifecycle: Proposal
- [Data format E1 (Extended v1)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-e1.md): Lifecycle: In Production
- [Bluetooth connection](https://docs.ruuvi.com/communication/bluetooth-connection.md): Lifecycle: Beta testing
- [DIS (Device Information Service)](https://docs.ruuvi.com/communication/bluetooth-connection/device-information-service-dis.md)
- [NUS (Nordic UART Service)](https://docs.ruuvi.com/communication/bluetooth-connection/nordic-uart-service-nus.md)
- [Heartbeat transmissions](https://docs.ruuvi.com/communication/bluetooth-connection/nordic-uart-service-nus/heartbeat-transmissions.md): Lifecycle: Alpha
- [Read logged history - RuuviTag](https://docs.ruuvi.com/communication/bluetooth-connection/nordic-uart-service-nus/log-read.md): Lifecycle: in production
- [Read logged history - Ruuvi Air](https://docs.ruuvi.com/communication/bluetooth-connection/nordic-uart-service-nus/read-logged-history-ruuvi-air.md)
- [Real Time Transfer (RTT)](https://docs.ruuvi.com/communication/development-real-time-transfer.md): Lifecycle: In production
- [Ruuvi Cloud](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud.md): Lifecycle: in Production
- [User API](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api.md): Ruuvi Cloud user facing API. Lifecycle: in production
- [Air Firmware](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/air-firmware.md)
- [Alerts](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/alerts.md)
- [Register User](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/register-user.md)
- [Sensor Settings](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/sensor-settings.md)
- [Sessions](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/sessions.md)
- [Push Notifications](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/push-notifications.md)
- [Sensors](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/sensors.md)
- [Share](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/share.md)
- [Subscription](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/subscription.md)
- [User Settings](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/user-settings.md)
- [Models](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/user-api/models.md)
- [Gateway API](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/gateway-api.md): API for the Ruuvi Gateway
- [Internal API](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/internal-api.md): Internal API for Network Management
- [Alerts](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/alerts.md): Ruuvi Cloud alerts
- [Cloud stored app settings](https://docs.ruuvi.com/communicate-with-ruuvi-cloud/cloud/cloud-stored-app-settings.md): List of supported settings
- [Integrations](https://docs.ruuvi.com/ruuvi-community-projects/integrations.md): Lifecycle: In production. Last updated 2021-04-13